From 1c7f908ce09f98fdcbf79ed2a8ae21be60eaa634 Mon Sep 17 00:00:00 2001 From: Zhineng Li Date: Sun, 12 Jul 2026 17:11:17 +0800 Subject: update APIs 20260712 --- .../en_us/dataworks-public/2020-05-18/api-docs.php | 90684 +++++++------------ 1 file changed, 33970 insertions(+), 56714 deletions(-) (limited to 'data/en_us/dataworks-public/2020-05-18/api-docs.php') diff --git a/data/en_us/dataworks-public/2020-05-18/api-docs.php b/data/en_us/dataworks-public/2020-05-18/api-docs.php index 62f9b7a..d734772 100644 --- a/data/en_us/dataworks-public/2020-05-18/api-docs.php +++ b/data/en_us/dataworks-public/2020-05-18/api-docs.php @@ -1,418 +1,83 @@ '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'dataworks-public', - 'version' => '2020-05-18', - ], + 'info' => ['style' => 'RPC', 'product' => 'dataworks-public', 'version' => '2020-05-18'], 'directories' => [ [ - 'id' => 120438, - 'title' => 'Tenant', + 'children' => ['AddProjectMemberToRole', 'RemoveProjectMemberFromRole', 'ListProjectIds', 'ChangeResourceManagerResourceGroup', 'ListMeasureData'], 'type' => 'directory', - 'children' => [ - 'ListCalcEngines', - 'CreateDataSource', - 'ListDataSources', - 'UpdateDataSource', - 'DeleteDataSource', - 'ListResourceGroups', - 'GetProject', - 'AddProjectMemberToRole', - 'CreateProjectMember', - 'DeleteProjectMember', - 'ListProjectRoles', - 'RemoveProjectMemberFromRole', - 'ListProjectMembers', - 'ListProjects', - 'ListProjectIds', - 'CreateProject', - 'ChangeResourceManagerResourceGroup', - 'ListMeasureData', - ], + 'title' => 'Tenant', ], [ - 'id' => 120453, - 'title' => 'Metadata', - 'type' => 'directory', 'children' => [ - 'ListTables', - 'GetMetaDBInfo', - 'GetMetaDBTableList', - 'CheckMetaTable', - 'CheckMetaPartition', - 'SearchMetaTables', - 'GetMetaTableBasicInfo', - 'GetMetaTableColumn', - 'GetMetaTablePartition', - 'GetMetaTableOutput', - 'GetMetaTableChangeLog', - 'GetMetaTableIntroWiki', - 'CreateMetaCategory', - 'DeleteMetaCategory', - 'UpdateMetaCategory', - 'GetMetaCategory', - 'GetMetaTableListByCategory', - 'AddToMetaCategory', - 'DeleteFromMetaCategory', - 'UpdateMetaTable', - 'UpdateMetaTableIntroWiki', - 'ListMetaDB', - 'UpdateTableModelInfo', - 'CreateTableTheme', - 'DeleteTableTheme', - 'UpdateTableTheme', - 'ListTableTheme', - 'GetMetaTableThemeLevel', - 'CreateTableLevel', - 'UpdateTableLevel', - 'DeleteTableLevel', - 'ListTableLevel', - 'UpdateMetaCollection', - 'ListMetaCollections', - 'ListMetaCollectionEntities', - 'DeleteMetaCollection', - 'GetMetaCollectionDetail', - 'DeleteMetaCollectionEntity', - 'AddMetaCollectionEntity', - 'CreateMetaCollection', - 'ListLineage', - 'DeleteLineageRelation', - 'RegisterLineageRelation', - 'GetMetaTableLineage', - 'GetMetaColumnLineage', + 'GetMetaDBInfo', 'GetMetaDBTableList', 'CheckMetaTable', 'CheckMetaPartition', 'SearchMetaTables', 'GetMetaTableBasicInfo', 'GetMetaTableColumn', 'GetMetaTablePartition', 'GetMetaTableOutput', 'GetMetaTableChangeLog', 'GetMetaTableIntroWiki', 'CreateMetaCategory', 'DeleteMetaCategory', 'UpdateMetaCategory', 'GetMetaCategory', 'GetMetaTableListByCategory', 'AddToMetaCategory', 'DeleteFromMetaCategory', 'UpdateMetaTable', 'UpdateMetaTableIntroWiki', + 'ListMetaDB', 'UpdateTableModelInfo', 'CreateTableTheme', 'DeleteTableTheme', 'UpdateTableTheme', 'ListTableTheme', 'GetMetaTableThemeLevel', 'CreateTableLevel', 'UpdateTableLevel', 'DeleteTableLevel', 'ListTableLevel', 'GetMetaCollectionDetail', 'RegisterLineageRelation', ], - ], - [ - 'id' => 120493, - 'title' => 'Data Development', 'type' => 'directory', - 'children' => [ - 'CreateFile', - 'CreateUdfFile', - 'CreateBusiness', - 'DeleteBusiness', - 'CreateFolder', - 'UpdateBusiness', - 'ListFiles', - 'EstablishRelationTableToBusiness', - 'SubmitFile', - 'ListBusiness', - 'GetFileVersion', - 'DeleteFolder', - 'DeleteFile', - 'GetDeployment', - 'UpdateFile', - 'GetFolder', - 'ListFileVersions', - 'GetFile', - 'ListFolders', - 'DeployFile', - 'UpdateUdfFile', - 'GetBusiness', - 'UpdateFolder', - 'ListDeployments', - 'UpdateIDEEventResult', - 'GetIDEEventDetail', - 'CreateResourceFile', - ], + 'title' => 'Metadata', ], [ - 'id' => 120518, - 'title' => 'Data Integration', + 'children' => ['CreateDISyncTask', 'DeleteDISyncTask', 'UpdateDISyncTask', 'TestNetworkConnection', 'GetDISyncTask', 'DeployDISyncTask', 'GetDISyncInstanceInfo', 'GenerateDISyncTaskConfigForUpdating', 'QueryDISyncTaskConfigProcessResult', 'GetDIAlarmRule'], 'type' => 'directory', - 'children' => [ - 'CreateDISyncTask', - 'DeleteDISyncTask', - 'UpdateDISyncTask', - 'TestNetworkConnection', - 'GetDataSourceMeta', - 'ListDIProjectConfig', - 'UpdateDIProjectConfig', - 'GetDISyncTask', - 'DeployDISyncTask', - 'GetDISyncInstanceInfo', - 'TerminateDISyncInstance', - 'GenerateDISyncTaskConfigForCreating', - 'GenerateDISyncTaskConfigForUpdating', - 'StartDISyncInstance', - 'StopDISyncInstance', - 'QueryDISyncTaskConfigProcessResult', - 'CreateDIJob', - 'DeleteDIJob', - 'GetDIJob', - 'ListDIJobs', - 'StartDIJob', - 'StopDIJob', - 'UpdateDIJob', - 'CreateDIAlarmRule', - 'DeleteDIAlarmRule', - 'GetDIAlarmRule', - 'ListDIAlarmRules', - 'UpdateDIAlarmRule', - ], + 'title' => 'Data integration', ], [ - 'id' => 191818, - 'title' => 'Data Modeling', + 'children' => ['QueryPublicModelEngine'], 'type' => 'directory', - 'children' => [ - 'QueryPublicModelEngine', - ], + 'title' => 'Data modeling', ], [ - 'id' => 120540, - 'title' => 'Operation Center', - 'type' => 'directory', 'children' => [ - 'GetAlertMessage', - 'ListAlertMessages', - 'GetBaselineConfig', - 'ListNodesByBaseline', - 'ListBaselineConfigs', - 'GetBaselineKeyPath', - 'GetBaselineStatus', - 'ListBaselineStatuses', - 'DeleteRemind', - 'UpdateRemind', - 'CreateRemind', - 'GetRemind', - 'ListReminds', - 'ListTopics', - 'GetTopic', - 'GetTopicInfluence', - 'GetNode', - 'ListNodeInputOrOutput', - 'ListNodes', - 'GetNodeCode', - 'GetInstance', - 'ListInstances', - 'GetInstanceLog', - 'StopInstance', - 'RestartInstance', - 'SetSuccessInstance', - 'SuspendInstance', - 'ResumeInstance', - 'RunCycleDagNodes', - 'RunSmokeTest', - 'ListSuccessInstanceAmount', - 'ListInstanceAmount', - 'TopTenElapsedTimeInstance', - 'TopTenErrorTimesInstance', - 'GetFileTypeStatistic', - 'GetInstanceStatusStatistic', - 'ListFileType', - 'RunManualDagNodes', - 'ListManualDagInstances', - 'GetDag', - 'ListDags', - 'ListNodesByOutput', - 'RunTriggerNode', - 'GetNodeParents', - 'GetNodeChildren', - 'UpdateNodeRunMode', - 'UpdateNodeOwner', - 'UpdateWorkbenchEventResult', - 'ListShiftPersonnels', - 'ListShiftSchedules', - 'ListInstanceHistory', - 'ListInnerNodes', - 'OfflineNode', - 'GetBaseline', - 'DeleteBaseline', - 'ListBaselines', - 'CreateBaseline', - 'UpdateBaseline', + 'GetAlertMessage', 'ListAlertMessages', 'GetBaselineConfig', 'ListNodesByBaseline', 'ListBaselineConfigs', 'GetBaselineKeyPath', 'GetBaselineStatus', 'ListBaselineStatuses', 'DeleteRemind', 'CreateRemind', 'GetRemind', 'ListReminds', 'GetTopicInfluence', 'ListNodeInputOrOutput', 'SuspendInstance', 'TopTenElapsedTimeInstance', 'TopTenErrorTimesInstance', 'GetInstanceStatusStatistic', 'RunManualDagNodes', 'GetDag', + 'ListDags', 'ListNodesByOutput', 'GetNodeParents', 'GetNodeChildren', 'UpdateWorkbenchEventResult', 'ListShiftPersonnels', 'ListShiftSchedules', 'ListInstanceHistory', 'ListInnerNodes', 'GetBaseline', 'ListBaselines', 'CreateBaseline', 'UpdateBaseline', ], - ], - [ - 'id' => 120587, - 'title' => 'Data Quality', 'type' => 'directory', - 'children' => [ - 'UpdateQualityFollower', - 'UpdateQualityRule', - 'GetQualityRule', - 'ListQualityRules', - 'CreateQualityRule', - 'DeleteQualityFollower', - 'DeleteQualityRule', - 'GetQualityFollower', - 'CreateQualityFollower', - 'DeleteQualityEntity', - 'GetQualityEntity', - 'CreateQualityEntity', - 'CreateQualityRelativeNode', - 'DeleteQualityRelativeNode', - 'ListQualityResultsByEntity', - 'ListQualityResultsByRule', - ], + 'title' => 'Operations center', ], [ - 'id' => 120604, - 'title' => 'DataService Studio', + 'children' => ['UpdateQualityFollower', 'UpdateQualityRule', 'DeleteQualityFollower', 'GetQualityFollower', 'CreateQualityFollower', 'DeleteQualityEntity', 'GetQualityEntity', 'CreateQualityEntity', 'CreateQualityRelativeNode', 'DeleteQualityRelativeNode', 'ListQualityResultsByEntity', 'ListQualityResultsByRule'], 'type' => 'directory', - 'children' => [ - 'CreateDataServiceApi', - 'PublishDataServiceApi', - 'DeleteDataServiceApi', - 'ListDataServiceApis', - 'GetDataServiceApi', - 'UpdateDataServiceApi', - 'GetDataServicePublishedApi', - 'ListDataServicePublishedApis', - 'ListDataServiceApiAuthorities', - 'ListDataServiceAuthorizedApis', - 'AbolishDataServiceApi', - 'GetDataServiceApplication', - 'ListDataServiceApplications', - 'CreateDataServiceFolder', - 'GetDataServiceFolder', - 'ListDataServiceFolders', - 'CreateDataServiceGroup', - 'GetDataServiceGroup', - 'ListDataServiceGroups', - 'CreateDataServiceApiAuthority', - 'DeleteDataServiceApiAuthority', - 'ListDataServiceApiTest', - 'TestDataServiceApi', - 'GetDataServiceApiTest', - 'SubmitDataServiceApi', - 'SaveDataServiceApiTestResult', - ], + 'title' => 'Data quality', ], [ - 'id' => 191820, - 'title' => 'Data Security Guard', + 'children' => ['GetDataServiceApi', 'UpdateDataServiceApi', 'GetDataServicePublishedApi', 'ListDataServiceApiAuthorities', 'ListDataServiceAuthorizedApis', 'GetDataServiceApplication', 'ListDataServiceApplications', 'ListDataServiceFolders', 'CreateDataServiceGroup', 'GetDataServiceGroup', 'ListDataServiceGroups'], 'type' => 'directory', - 'children' => [ - 'GetOpSensitiveData', - 'DesensitizeData', - 'GetOpRiskData', - 'GetSensitiveData', - 'ScanSensitiveData', - 'DsgQuerySensResult', - 'QueryDefaultTemplate', - 'DsgStopSensIdentify', - 'QuerySensClassification', - 'QuerySensLevel', - 'QueryRecognizeRulesType', - 'DsgRunSensIdentify', - 'DeleteRecognizeRule', - 'QuerySensNodeInfo', - 'AddRecognizeRule', - 'EditRecognizeRule', - 'QueryRecognizeDataByRuleType', - 'QueryRecognizeRuleDetail', - 'DsgUserGroupGetOdpsRoleGroups', - 'DsgDesensPlanAddOrUpdate', - 'DsgPlatformQueryProjectsAndSchemaFromMeta', - 'DsgUserGroupDelete', - 'DsgWhiteListDeleteList', - 'DsgScenedDeleteScene', - 'DsgDesensPlanDelete', - 'DsgDesensPlanUpdateStatus', - 'DsgWhiteListQueryList', - 'DsgSceneAddOrUpdateScene', - 'DsgSceneQuerySceneListByName', - 'DsgUserGroupAddOrUpdate', - 'DsgUserGroupQueryList', - 'DsgUserGroupQueryUserList', - 'DsgDesensPlanQueryList', - 'DsgWhiteListAddOrUpdate', - 'DsgQueryDefaultTemplates', - ], + 'title' => 'Data service', ], [ - 'id' => 166717, - 'title' => 'Migration Assistant', + 'children' => ['DsgUpdateDesensStatusList', 'DsgQueryDesensStatusList', 'GetSensitiveData', 'DsgQuerySensResult', 'QueryRecognizeRuleDetail', 'DsgDesensPlanAddOrUpdate', 'DsgSceneQuerySceneListByName', 'DsgUserGroupAddOrUpdate', 'DsgUserGroupQueryList', 'DsgDesensPlanQueryList', 'DsgQueryDefaultTemplates'], 'type' => 'directory', - 'children' => [ - 'CreateImportMigration', - 'GetMigrationProcess', - 'StartMigration', - 'CreateExportMigration', - 'GetMigrationSummary', - 'ListMigrations', - ], + 'title' => 'Data protection', ], [ - 'id' => 191821, - 'title' => 'Security Center', + 'children' => ['CreatePermissionApplyOrder', 'GetPermissionApplyOrderDetail', 'ListPermissionApplyOrders'], 'type' => 'directory', - 'children' => [ - 'CreatePermissionApplyOrder', - 'GetPermissionApplyOrderDetail', - 'ListPermissionApplyOrders', - 'ApprovePermissionApplyOrder', - 'RevokeTablePermission', - 'RevokeTablePermission', - ], + 'title' => 'Security center', ], [ - 'id' => 166724, - 'title' => 'Open platform', + 'children' => ['GetExtension'], 'type' => 'directory', - 'children' => [ - 'ListExtensions', - 'GetExtension', - 'GetOptionValueForProject', - 'ListEnabledExtensionsForProject', - 'CallbackExtension', - 'ListCheckProcesses', - 'ListCheckProcesses', - ], + 'title' => 'Open platform', ], [ - 'id' => 191836, - 'title' => 'Others', - 'type' => 'directory', 'children' => [ - 'UpdateTableAddColumn', - 'GetMetaTableFullInfo', - 'GetDDLJobStatus', - 'DeleteTable', - 'UpdateTable', - 'CreateTable', - 'CheckFileDeployment', - 'ListRefDISyncTasks', - 'ExportDataSources', - 'ImportDataSources', - 'UpdateClusterConfigs', - 'ListClusterConfigs', - 'ListClusters', + 'GetMetaTableFullInfo', 'DeleteTable', 'CreateTable', 'CheckFileDeployment', 'UpdateClusterConfigs', 'AbolishDataServiceApi', 'AddMetaCollectionEntity', 'AddRecognizeRule', 'ApprovePermissionApplyOrder', 'CallbackExtension', 'CreateBusiness', 'CreateConnection', 'CreateDIAlarmRule', 'CreateDIJob', 'CreateDataServiceApi', 'CreateDataServiceApiAuthority', 'CreateDataServiceFolder', 'CreateDataSource', 'CreateExportMigration', 'CreateFile', + 'CreateFolder', 'CreateImportMigration', 'CreateMetaCollection', 'CreateProject', 'CreateProjectMember', 'CreateQualityRule', 'CreateResourceFile', 'CreateUdfFile', 'DeleteBaseline', 'DeleteBusiness', 'DeleteConnection', 'DeleteDIAlarmRule', 'DeleteDIJob', 'DeleteDataServiceApi', 'DeleteDataServiceApiAuthority', 'DeleteDataSource', 'DeleteFile', 'DeleteFolder', 'DeleteLineageRelation', 'DeleteMetaCollection', + 'DeleteMetaCollectionEntity', 'DeleteProjectMember', 'DeleteQualityRule', 'DeleteRecognizeRule', 'DeployFile', 'DesensitizeData', 'DsgDesensPlanDelete', 'DsgDesensPlanUpdateStatus', 'DsgPlatformQueryProjectsAndSchemaFromMeta', 'DsgRunSensIdentify', 'DsgSceneAddOrUpdateScene', 'DsgScenedDeleteScene', 'DsgStopSensIdentify', 'DsgUserGroupDelete', 'DsgUserGroupGetOdpsRoleGroups', 'DsgUserGroupQueryUserList', 'DsgWhiteListAddOrUpdate', 'DsgWhiteListDeleteList', 'DsgWhiteListQueryList', 'EditRecognizeRule', + 'EstablishRelationTableToBusiness', 'ExportDataSources', 'GenerateDISyncTaskConfigForCreating', 'GetBusiness', 'GetDDLJobStatus', 'GetDIJob', 'GetDataServiceApiTest', 'GetDataServiceFolder', 'GetDataSourceMeta', 'GetDeployment', 'GetFile', 'GetFileTypeStatistic', 'GetFileVersion', 'GetFolder', 'GetIDEEventDetail', 'GetInstance', 'GetInstanceCountTrend', 'GetInstanceLog', 'GetInstanceStatusCount', 'GetManualDagInstances', + 'GetMetaColumnLineage', 'GetMetaTableLineage', 'GetMigrationProcess', 'GetMigrationSummary', 'GetNode', 'GetNodeCode', 'GetNodeTypeListInfo', 'GetOpRiskData', 'GetOpSensitiveData', 'GetOptionValueForProject', 'GetProject', 'GetProjectDetail', 'GetQualityRule', 'GetSuccessInstanceTrend', 'GetTopic', 'ImportDataSources', 'ListBusiness', 'ListCalcEngines', 'ListCheckProcesses', 'ListClusterConfigs', + 'ListClusters', 'ListConnections', 'ListDIAlarmRules', 'ListDIJobs', 'ListDIProjectConfig', 'ListDataServiceApiTest', 'ListDataServiceApis', 'ListDataServicePublishedApis', 'ListDataSources', 'ListDeployments', 'ListEnabledExtensionsForProject', 'ListEntitiesByTags', 'ListEntityTags', 'ListExtensions', 'ListFileType', 'ListFileVersions', 'ListFiles', 'ListFolders', 'ListInstanceAmount', 'ListInstances', + 'ListLineage', 'ListManualDagInstances', 'ListMetaCollectionEntities', 'ListMetaCollections', 'ListMigrations', 'ListNodeIO', 'ListNodes', 'ListProgramTypeCount', 'ListProjectMembers', 'ListProjectRoles', 'ListProjects', 'ListQualityRules', 'ListRefDISyncTasks', 'ListResourceGroups', 'ListSuccessInstanceAmount', 'ListTables', 'ListTopics', 'OfflineNode', 'PublishDataServiceApi', 'QueryDefaultTemplate', + 'QueryRecognizeDataByRuleType', 'QueryRecognizeRulesType', 'QuerySensClassification', 'QuerySensLevel', 'QuerySensNodeInfo', 'RemoveEntityTags', 'RestartInstance', 'ResumeInstance', 'RevokeTablePermission', 'RunCycleDagNodes', 'RunSmokeTest', 'RunTriggerNode', 'SaveDataServiceApiTestResult', 'ScanSensitiveData', 'SearchNodesByOutput', 'SetDataSourceShare', 'SetEntityTags', 'SetSuccessInstance', 'StartDIJob', 'StartDISyncInstance', + 'StartMigration', 'StopDIJob', 'StopDISyncInstance', 'StopInstance', 'SubmitDataServiceApi', 'SubmitFile', 'TerminateDISyncInstance', 'TestDataServiceApi', 'UpdateBusiness', 'UpdateConnection', 'UpdateDIAlarmRule', 'UpdateDIJob', 'UpdateDIProjectConfig', 'UpdateDataSource', 'UpdateFile', 'UpdateFolder', 'UpdateIDEEventResult', 'UpdateMetaCollection', 'UpdateNodeOwner', 'UpdateNodeRunMode', + 'UpdateRemind', 'UpdateTable', 'UpdateTableAddColumn', 'UpdateUdfFile', ], + 'type' => 'directory', + 'title' => 'Others', ], [ - 'id' => 120626, - 'title' => 'Abandoned API', + 'children' => ['CreateDagComplement', 'CreateDagTest', 'CreateManualDag', 'GetNodeOnBaseline', 'GetInstanceConsumeTimeRank', 'GetInstanceErrorRank'], 'type' => 'directory', - 'children' => [ - 'ListEntitiesByTags', - 'RemoveEntityTags', - 'SetEntityTags', - 'ListEntityTags', - 'SetDataSourceShare', - 'CreateConnection', - 'CreateDagComplement', - 'CreateDagTest', - 'CreateManualDag', - 'DeleteConnection', - 'UpdateConnection', - 'ListConnections', - 'GetProjectDetail', - 'ListNodeIO', - 'GetInstanceStatusCount', - 'ListProgramTypeCount', - 'GetManualDagInstances', - 'SearchNodesByOutput', - 'GetNodeTypeListInfo', - 'GetNodeOnBaseline', - 'GetSuccessInstanceTrend', - 'GetInstanceCountTrend', - 'GetInstanceConsumeTimeRank', - 'GetInstanceErrorRank', - ], + 'title' => 'Deprecated API', ], ], 'components' => [ @@ -423,25 +88,8 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'ClusterId' => [ - 'title' => 'Cluster ID Generated by DataWorks', - 'description' => 'The ID of the cluster associated with DataWorks.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234', - 'backendName' => 'id', - ], - 'ClusterBizId' => [ - 'title' => 'Cluster Business Identifier', - 'description' => 'The unique business identifier of the cluster.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => true, - 'example' => 'c-d8a7523****', - 'backendName' => 'clusterIdentifier', - ], + 'ClusterId' => ['title' => 'Cluster ID Generated by DataWorks', 'description' => 'The ID of the cluster associated with DataWorks.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234', 'backendName' => 'id'], + 'ClusterBizId' => ['title' => 'Cluster Business Identifier', 'description' => 'The unique business identifier of the cluster.'."\n", 'visibility' => 'Public', 'type' => 'string', 'required' => true, 'example' => 'c-d8a7523****', 'backendName' => 'clusterIdentifier'], ], ], 'ClusterConfig' => [ @@ -466,14 +114,7 @@ 'example' => 'ide', 'backendName' => 'module', ], - 'ConfigValue' => [ - 'title' => 'Config value', - 'description' => 'The configuration value.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{"spark.driver.memory":"1g"}', - 'backendName' => 'value', - ], + 'ConfigValue' => ['title' => 'Config value', 'description' => 'The configuration value.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '{"spark.driver.memory":"1g"}', 'backendName' => 'value'], 'EnableOverwrite' => [ 'title' => 'Whether to overwrite node config', 'description' => 'Specifies whether to overwrite the advanced settings of nodes in DataStudio. Valid values:'."\n" @@ -491,1782 +132,937 @@ 'Collection' => [ 'title' => 'Definition of Collection', 'description' => 'The collection definition.'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'QualifiedName' => [ - 'title' => 'Unique identifier of identity', - 'description' => 'The unique identifier of the collection.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'album.12334', - 'backendName' => 'qualifiedName', - ], - 'CollectionType' => [ - 'title' => 'Collection Type', - 'description' => 'The type of the collection. Valid values:'."\n" - ."\n" - .'* **ALBUM**: data album'."\n" - .'* **ALBUM_CATEGORY**: category in a data album'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'album', - 'backendName' => 'collectionType', - ], - 'Name' => [ - 'title' => 'The name of the collection', - 'description' => 'The name of the collection.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'collectionName', - 'backendName' => 'name', - ], - 'Comment' => [ - 'title' => 'The comment of the collection', - 'description' => 'The remarks.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'comment', - 'backendName' => 'comment', - ], - 'OwnerId' => [ - 'title' => 'The ownerId of the collection', - 'description' => 'The ID of the Alibaba Cloud account that is used by the collection owner.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '1234444', - 'backendName' => 'ownerId', - ], - 'OwnerName' => [ - 'title' => 'The name of the collection owner', - 'description' => 'The name of the collection owner.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'owner', - 'backendName' => 'ownerName', - ], - 'CreateTime' => [ - 'title' => 'The create timestamp of the collection', - 'description' => 'The creation time.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1668600147617', - 'backendName' => 'createTime', - ], - 'UpdateTime' => [ - 'title' => 'The update timestamp of the collection', - 'description' => 'The update time.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1668600148617', - 'backendName' => 'updateTime', - ], - 'Level' => [ - 'title' => 'The level of the collection', - 'description' => 'The level of the collection. This parameter takes effect only if the CollectionType parameter is set to ALBUM_CATEGORY. Maximum value: 4.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'backendName' => 'level', - ], + 'QualifiedName' => ['title' => 'Unique identifier of identity', 'description' => 'The unique identifier of the collection.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'album.12334', 'backendName' => 'qualifiedName'], + 'CollectionType' => ['title' => 'Collection Type', 'description' => 'The type of the collection. Valid values:'."\n" + ."\n" + .'* **ALBUM**: data album'."\n" + .'* **ALBUM_CATEGORY**: category in a data album'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'album', 'backendName' => 'collectionType'], + 'Name' => ['title' => 'The name of the collection', 'description' => 'The name of the collection.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'collectionName', 'backendName' => 'name'], + 'Comment' => ['title' => 'The comment of the collection', 'description' => 'The remarks.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'comment', 'backendName' => 'comment'], + 'OwnerId' => ['title' => 'The ownerId of the collection', 'description' => 'The ID of the Alibaba Cloud account that is used by the collection owner.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '1234444', 'backendName' => 'ownerId'], + 'OwnerName' => ['title' => 'The name of the collection owner', 'description' => 'The name of the collection owner.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'owner', 'backendName' => 'ownerName'], + 'CreateTime' => ['title' => 'The create timestamp of the collection', 'description' => 'The creation time.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1668600147617', 'backendName' => 'createTime'], + 'UpdateTime' => ['title' => 'The update timestamp of the collection', 'description' => 'The update time.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1668600148617', 'backendName' => 'updateTime'], + 'Level' => ['title' => 'The level of the collection', 'description' => 'The level of the collection. This parameter takes effect only if the CollectionType parameter is set to ALBUM_CATEGORY. Maximum value: 4.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'backendName' => 'level'], ], ], 'Entity' => [ 'title' => 'Definition of Entity', 'description' => 'The entity definition.'."\n", - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'QualifiedName' => [ - 'title' => 'Unique identifier of identity', - 'description' => 'The unique identifier of the entity. Example: maxcompute-table.projectA.tableB.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'maxcompute_table.563f0357118d05ef145d6bddf2966cc23e86ca8f2f013f915e565afdf09f7a23', - 'backendName' => 'qualifiedName', - ], - 'TenantId' => [ - 'title' => 'Identifier of tenant', - 'description' => 'The tenant ID.'."\n", - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12345', - 'backendName' => 'tenantId', - ], - 'EntityContent' => [ - 'title' => 'Attribute map', - 'description' => 'The properties of the entity, including:'."\n" - ."\n" - .'* **entityType**: The type of the entity. Examples: maxcompute-table and emr-table.'."\n" - .'* **name**: the name of the entity.'."\n" - .'* **projectName**: the name of the MaxCompute project.'."\n", - 'visibility' => 'public', - 'type' => 'object', - 'backendName' => 'entityContent', - ], + 'QualifiedName' => ['title' => 'Unique identifier of identity', 'description' => 'The unique identifier of the entity. Example: maxcompute-table.projectA.tableB.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'maxcompute_table.563f0357118d05ef145d6bddf2966cc23e86ca8f2f013f915e565afdf09f7a23', 'backendName' => 'qualifiedName'], + 'TenantId' => ['title' => 'Identifier of tenant', 'description' => 'The tenant ID.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '12345', 'backendName' => 'tenantId'], + 'EntityContent' => ['title' => 'Attribute map', 'description' => 'The properties of the entity, including:'."\n" + ."\n" + .'* **entityType**: The type of the entity. Examples: maxcompute-table and emr-table.'."\n" + .'* **name**: the name of the entity.'."\n" + .'* **projectName**: the name of the MaxCompute project.'."\n", 'visibility' => 'Public', 'type' => 'object', 'backendName' => 'entityContent'], ], ], 'LineageEntityVO' => [ 'title' => 'Definition of entity in lineage', - 'description' => '', - 'visibility' => 'public', + 'description' => 'An entity object for Lineage registration.', 'type' => 'object', 'properties' => [ - 'QualifiedName' => [ - 'title' => 'Unique identifier of entity', - 'description' => 'Unique identifier of entity', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'maxcompute-table.projectName.tablename', - 'backendName' => 'qualifiedName', - ], - 'Name' => [ - 'title' => 'Name of entity', - 'description' => 'Name of entity', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'tableName', - 'backendName' => 'name', - ], - 'ParentName' => [ - 'title' => 'Parent name of entity', - 'description' => 'Parent name of entity', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'dbName', - 'backendName' => 'parentName', - ], - 'DetailUrl' => [ - 'title' => 'Detail url of entity', - 'description' => 'Detail url of entity', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'http://domain.test.url/entity', - 'backendName' => 'detailUrl', + 'QualifiedName' => ['title' => 'Unique identifier of entity', 'description' => 'The unique, fully qualified name of the entity.', 'type' => 'string', 'example' => 'maxcompute-table.projectName.tablename', 'visibility' => 'Public', 'backendName' => 'qualifiedName'], + 'Name' => ['title' => 'Name of entity', 'description' => 'The human-readable name of the entity.', 'type' => 'string', 'example' => 'tableName', 'visibility' => 'Public', 'backendName' => 'name'], + 'ParentName' => ['title' => 'Parent name of entity', 'description' => 'The name of the entity\'s parent container, such as a database.', 'type' => 'string', 'example' => 'dbName', 'visibility' => 'Public', 'backendName' => 'parentName'], + 'DetailUrl' => ['title' => 'Detail url of entity', 'description' => 'A URL for more details about the entity.', 'type' => 'string', 'example' => 'http://domain.test.url/entity', 'visibility' => 'Public', 'backendName' => 'detailUrl'], + 'EntityType' => ['title' => 'Entity type', 'description' => 'The type of the entity.', 'type' => 'string', 'example' => 'maxcompute-table', 'visibility' => 'Public', 'backendName' => 'entityType'], + 'Owner' => ['title' => 'Owner', 'description' => 'The owner of the entity.', 'type' => 'string', 'example' => 'owner', 'visibility' => 'Public', 'backendName' => 'owner'], + 'Attributes' => [ + 'title' => 'Other attributes', + 'description' => 'A map of additional key-value attributes for the entity.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value of each additional attribute.', 'type' => 'string', 'title' => '', 'example' => '', 'visibility' => 'Public'], + 'example' => 'attribute map', + 'visibility' => 'Public', + 'backendName' => 'attributes', ], ], + 'example' => '', + 'visibility' => 'Public', ], 'LineageRelationRegisterVO' => [ 'title' => 'Lineage relation register struct', - 'description' => '', - 'visibility' => 'public', + 'description' => '血缘关系注册结构体', 'type' => 'object', 'properties' => [ - 'SrcEntity' => [ - 'title' => 'The source entity in lineage relation', - 'description' => 'The source entity in lineage relation', - 'visibility' => 'public', - 'backendName' => 'srcEntity', - '$ref' => '#/components/schemas/LineageEntityVO', - ], - 'DestEntity' => [ - 'title' => 'The destination entity in lineage relation', - 'description' => 'The destination entity in lineage relation', - 'visibility' => 'public', - 'backendName' => 'destEntity', - '$ref' => '#/components/schemas/LineageEntityVO', - ], - 'Relationship' => [ - 'title' => 'The relationship between entities', - 'description' => 'The relationship between entities', - 'visibility' => 'public', - 'backendName' => 'relationship', - '$ref' => '#/components/schemas/RelationshipVO', - ], - 'CreateTimestamp' => [ - 'title' => 'The time of lineage relation generation', - 'description' => 'The time of lineage relation generation', - 'visibility' => 'public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1684327487964', - 'backendName' => 'createTimestamp', - ], + 'SrcEntity' => ['title' => 'The source entity in lineage relation', 'description' => 'The source entity in lineage relation', '$ref' => '#/components/schemas/LineageEntityVO', 'example' => '', 'visibility' => 'Public', 'backendName' => 'srcEntity'], + 'DestEntity' => ['title' => 'The destination entity in lineage relation', 'description' => 'The destination entity in lineage relation', '$ref' => '#/components/schemas/LineageEntityVO', 'example' => '', 'visibility' => 'Public', 'backendName' => 'destEntity'], + 'Relationship' => ['title' => 'The relationship between entities', 'description' => 'The relationship between entities', '$ref' => '#/components/schemas/RelationshipVO', 'example' => '', 'visibility' => 'Public', 'backendName' => 'relationship'], + 'CreateTimestamp' => ['title' => 'The time of lineage relation generation', 'description' => 'The time of lineage relation generation', 'type' => 'integer', 'format' => 'int64', 'example' => '1684327487964', 'visibility' => 'Public', 'backendName' => 'createTimestamp'], ], + 'example' => '', + 'visibility' => 'Public', ], 'RelationshipVO' => [ 'title' => 'relationship info', - 'description' => '', - 'visibility' => 'public', + 'description' => 'The structure of an entity relationship.', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'title' => 'Type name of relationship', - 'description' => 'Type name of relationship', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'sql', - 'backendName' => 'type', + 'RelationshipType' => ['title' => 'Type name of relationship', 'description' => 'The type of the relationship.', 'type' => 'string', 'example' => 'sql', 'visibility' => 'Public', 'backendName' => 'relationshipType'], + 'RelationshipGuid' => ['title' => 'Relationship uniqId', 'description' => 'The unique identifier for the relationship.', 'type' => 'string', 'example' => '', 'visibility' => 'Public', 'backendName' => 'relationshipGuid'], + 'Attributes' => [ + 'title' => 'other attribute', + 'description' => 'Additional attributes.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value of an attribute.', 'type' => 'string', 'example' => 'key-value', 'visibility' => 'Public', 'title' => ''], + 'example' => '', + 'visibility' => 'Public', + 'backendName' => 'attributes', ], ], + 'example' => '', + 'visibility' => 'Public', ], 'UserEntityTag' => [ - 'title' => '', + 'title' => '标签', 'description' => 'The tags.', - 'visibility' => 'public', + 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'TagKey' => [ - 'title' => '', - 'description' => 'The tag key.', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'priority', - 'backendName' => 'tagKey', - ], - 'TagValue' => [ - 'title' => '', - 'description' => 'The tag value.', - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'p1', - 'backendName' => 'tagValue', - ], + 'TagKey' => ['title' => '标签 Key', 'description' => 'The tag key.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'priority', 'backendName' => 'tagKey'], + 'TagValue' => ['title' => '标签 Value', 'description' => 'The tag value.', 'visibility' => 'Public', 'type' => 'string', 'example' => 'p1', 'backendName' => 'tagValue'], ], ], ], ], 'apis' => [ - 'ListCalcEngines' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'AbolishDataServiceApi' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'delete', + 'abilityTreeCode' => '78165', + 'abilityTreeNodes' => ['FEATUREdide7T0EJX'], ], 'parameters' => [ + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10002'], + ], [ 'name' => 'ProjectId', - 'in' => 'query', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the workspace.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10001'], + ], + [ + 'name' => 'ApiId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the DataService Studio API.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10000'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The ID of the DataWorks workspace with which the compute engine is associated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '27', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Data' => ['description' => 'Indicates whether the API is unpublished.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The connection does not exist.'], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0000-ABCD-EFG****'], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists'], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true'], + ], + 'description' => '', ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n true\\n The connection does not exist.\\n 0000-ABCD-EFG****\\n Invalid.Tenant.ConnectionNotExists\\n true\\n","errorExample":""}]', + 'title' => 'AbolishDataServiceApi', + 'summary' => 'Unpublishes a DataService Studio API.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-10-10T02:04:51.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-12T08:47:03.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-08-12T08:47:03.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-08-12T08:47:03.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AbolishDataServiceApi'], + ], + ], + 'ramActions' => [], + ], + 'AddMetaCollectionEntity' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Name', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '163138', + 'abilityTreeNodes' => ['FEATUREdideE9XYA6'], + ], + 'parameters' => [ + [ + 'name' => 'CollectionQualifiedName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the compute engine, which must be exactly matched.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'abc', - ], + 'schema' => ['description' => 'The unique identifier of the collection.'."\n", 'type' => 'string', 'required' => true, 'example' => 'album.2222'], ], [ - 'name' => 'CalcEngineType', + 'name' => 'EntityQualifiedName', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the compute engine. The value of this parameter is not case-sensitive. Valid values:'."\n" - ."\n" - .'* **ODPS**'."\n" - .'* **EMR**'."\n" - .'* **BLINK**'."\n" - .'* **HOLO**'."\n" - .'* **MaxGraph**'."\n" - .'* **HYBRIDDB_FOR_POSTGRESQL**'."\n" - .'* **ADB_MYSQL**'."\n" - .'* **HADOOP_CDH**'."\n" - .'* **CLICKHOUSE**'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ODPS', - ], + 'schema' => ['description' => 'The unique identifier of the entity. Example: maxcompute-table.projectA.tableA.'."\n", 'type' => 'string', 'required' => true, 'example' => 'maxcompute-table.projectA.tableB'], ], [ - 'name' => 'EnvType', + 'name' => 'Remark', 'in' => 'query', + 'schema' => ['description' => 'The remarks of the entity. Example: latest product table.'."\n", 'type' => 'string', 'required' => false, 'example' => 'this is a remark', 'maxLength' => 50], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The environment in which the compute engine is used. Valid values:'."\n" - ."\n" - .'* **DEV**'."\n" - .'* **PRD**'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'PRD', + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID. You can use the request ID to query logs and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '0000-ABCD-E****'], + 'Status' => ['description' => 'The result of the operation. Valid values:'."\n" + ."\n" + .'* true: succeeded'."\n" + .'* false: failed'."\n", 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The specified product does not exist.'], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '9999'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'true false'."\n", 'type' => 'boolean', 'example' => 'true'], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Invalid.Entity.NotExist', 'errorMessage' => '%s', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0000-ABCD-E****\\",\\n \\"Status\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The specified product does not exist.\\",\\n \\"ErrorCode\\": \\"9999\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 0000-ABCD-E****\\n true\\n 200\\n The specified product does not exist.\\n 9999\\n true\\n","errorExample":""}]', + 'title' => 'AddMetaCollectionEntity', + 'summary' => 'Adds an entity to a collection.', + 'changeSet' => [ + ['createdAt' => '2023-08-09T06:47:42.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddMetaCollectionEntity'], + ], + ], + 'ramActions' => [], + ], + 'AddProjectMemberToRole' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'PageSize', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create'], + 'parameters' => [ + [ + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The DataWorks workspace ID. You can call the [ListProjects](~~2780068~~) operation to query the ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '10000000', 'minimum' => '0', 'example' => '27', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The Alibaba Cloud account ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and move the pointer over the profile picture in the upper-right corner to view the ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1234', 'title' => ''], + ], + [ + 'name' => 'RoleCode', + 'in' => 'query', + 'schema' => ['description' => 'The code of the role that you want to assign to a member of the DataWorks workspace. You can call the [ListProjectRoles](~~2780079~~) operation to query the codes of all roles in a DataWorks workspace.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'role_project_guest', 'title' => ''], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. We recommend that you set this parameter to a UUID. This parameter is used to uniquely identify the API operation call.', 'type' => 'string', 'required' => false, 'example' => '1AFAE64E-D1BE-432B-A9*****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0bc1ec92159376****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The query results for compute engines that are returned on multiple pages.'."\n", - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'TotalCount' => [ - 'description' => 'The total number of compute engine instances.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'CalcEngines' => [ - 'description' => 'The compute engines.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'BindingProjectName' => [ - 'description' => 'The name of the workspace with which the compute engine is associated.'."\n", - 'type' => 'string', - 'example' => 'abc', - ], - 'IsDefault' => [ - 'description' => 'Indicates whether the compute engine is the default engine of the current type.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'EngineId' => [ - 'description' => 'The compute engine ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '35', - ], - 'DwRegion' => [ - 'description' => 'The region where the DataWorks workspace with which the compute engine is associated resides.'."\n", - 'type' => 'string', - 'example' => 'cn-zhangjiakou', - ], - 'TaskAuthType' => [ - 'description' => 'The identity that is used to access the compute engine. Valid values:'."\n" - ."\n" - .'* **USER**: the current user'."\n" - .'* **PROJECT**: the workspace executor'."\n" - .'* **SUBACCOUNT**: a RAM user'."\n" - .'* **STS_ROLE**: the Security Token Service (STS) role'."\n", - 'type' => 'string', - 'example' => 'PROJECT', - ], - 'CalcEngineType' => [ - 'description' => 'The type of the compute engine.'."\n", - 'type' => 'string', - 'example' => 'ODPS', - ], - 'EngineInfo' => [ - 'description' => 'The details of the compute engine.'."\n" - ."\n" - .'* ODPS'."\n" - ."\n" - .' {'."\n" - .' "pubEndpoint": "service.cn.maxcompute.aliyun.com/api",'."\n" - .' "endpoint": "service.cn.maxcompute.aliyun-inc.com/api",'."\n" - .' "initProperties": " '."\n" - .' {\\"odpsTypeMode\\":\\"STANDARD\\",\\"openPai\\":false,\\"openPaiGpu\\":false}",'."\n" - .' "resourceGroupType": "ODPS",'."\n" - .' "resourceGroupId": "361826516****",'."\n" - .' "vpcEndpoint": "service.cn.maxcompute.aliyun-inc.com/api",'."\n" - .' "projectName": "onefall_test_zjk",'."\n" - .' "taskSameAsOwner": "true"'."\n" - .' }'."\n" - ."\n" - .'* EMR'."\n" - ."\n" - .' {'."\n" - .' "emrClusterId": "C-xxx",'."\n" - .' "specs": "{\\"emrClusterId\\":\\"C-xxx\\",\\"emrAccessMode\\":\\"simple\\",\\"emrResourceQueueName\\":\\"default\\",\\"emrProjectId\\":\\"FP-xxx\\"}",'."\n" - .' "endpoint": "emr.aliyuncs.com",'."\n" - .' "emrResourceQueueName": "default",'."\n" - .' "emrAccessMode": "simple",'."\n" - .' "resourceGroupType": "DW",'."\n" - .' "projectName": "xx-xxxx",'."\n" - .' "emrProjectId": "FP-xxxx",'."\n" - .' "taskSameAsOwner": "false"'."\n" - .' } '."\n" - ."\n" - .'* BLINK'."\n" - ."\n" - .' {'."\n" - .' "bayesProjectId": "xxxx",'."\n" - .' "bayesProjectName": "xc_blxxixxxnk_1",'."\n" - .' "cluster": "xxxssxsx",'."\n" - .' "endpoint": "https://stream.console.aliyun.com",'."\n" - .' "engineType": "BLINK",'."\n" - .' "name": "xsxsxxxxx",'."\n" - .' "projectName": "xc_blxxxsxink_1",'."\n" - .' "queue": "root.xc_blxsxxxxxxink_1",'."\n" - .' "resourceGroupType": "DW",'."\n" - .' "specs": "{\\"cluster\\":\\"xxxxxx\\",\\"bayesProjectName\\":\\"xc_blxxixxxnk_1\\",\\"bayesProjectId\\":\\"ssxxxsa\\",\\"name\\":\\"sxsxsxxx\\",\\"queue\\":\\"root.sxxsxxsx\\"}",'."\n" - .' "taskSameAsOwner": false'."\n" - .' }'."\n" - ."\n" - .'* HOLO'."\n" - ."\n" - .' {'."\n" - .' "endpoint": "hgprecn-cn-xsxssxsx-cn-shanghai-internal.hologres.aliyuncs.com:80",'."\n" - .' "engineType": "ODPS",'."\n" - .' "odpsEndpoint": "hgprecn-cn-xsxssxxs-cn-shanghai-internal.hologres.aliyuncs.com:80",'."\n" - .' "odpsProjectName": "xsxssxsxsx",'."\n" - .' "projectName": "xsxssxsxsx",'."\n" - .' "resourceGroupType": "DW",'."\n" - .' "specs": "{\\"pubEndpoint\\":\\"hgprecn-cn-xsxssxsxs-cn-shanghai.hologres.aliyuncs.com:80\\",\\"commonBuyInstanceId\\":\\"hgprecn-cn-xsxsxsxs\\",\\"project\\":\\"holo_upxsxgrade1\\",\\"common_buy_instance_id\\":\\"hgprecn-cn-xsxsxs\\",\\"endpoint\\":\\"hgprecn-cn-xsxxsxs-cn-shanghai-internal.hologres.aliyuncs.com:80\\",\\"port\\":\\"80\\",\\"host\\":\\"hgprecn-cn-xsxsxsxs-cn-shanghai-internal.hologres.aliyuncs.com\\",\\"vpcEndpoint\\":\\"hgprecn-cn-xsxsxsxs-cn-shanghai-vpc.hologres.aliyuncs.com:80\\",\\"authType\\":2,\\"region\\":\\"cn-shanghai\\"}",'."\n" - .' "taskSameAsOwner": false'."\n" - .' }'."\n" - ."\n" - .'* MaxGraph'."\n" - ."\n" - .' {'."\n" - .' "endpoint": "http://pre-graphcompute.aliyuncs.com",'."\n" - .' "engineType": "ODPS",'."\n" - .' "odpsEndpoint": "http://pre-graphcompute.aliyuncs.com",'."\n" - .' "odpsProjectName": "xsxsxsxs",'."\n" - .' "projectName": "xsxsxsxs",'."\n" - .' "resourceGroupType": "DW",'."\n" - .' "taskSameAsOwner": false'."\n" - .' }'."\n" - ."\n" - .'* HYBRIDDB_FOR_POSTGRESQL'."\n" - ."\n" - .' {'."\n" - .' "endpoint": "hybriddb_for_postgresql_mo12121ck_endpoint",'."\n" - .' "engineType": "ODPS",'."\n" - .' "odpsEndpoint": "hybriddb_for_postgresql_m121212ock_endpoint",'."\n" - .' "odpsProjectName": "sxasaxsaxaxas",'."\n" - .' "projectName": "sxasaxsaxaxas",'."\n" - .' "resourceGroupType": "DW",'."\n" - .' "specs": "{\\"connectionString\\":\\"gp-xsxsxsxxs.gpdb.rds.aliyuncs.com\\",\\"database\\":\\"xsxsxxsxs\\",\\"password\\":\\"xxxxxxx\\",\\"instanceId\\":\\"gp-cdcdacdacda\\",\\"port\\":\\"3432\\",\\"ownerId\\":\\"12121212\\",\\"username\\":\\"sdasaddsa\\"}",'."\n" - .' "taskSameAsOwner": false'."\n" - .' }'."\n" - ."\n" - .'* ADB_MYSQL'."\n" - ."\n" - .' {'."\n" - .' "endpoint": "adb_mysql_mock_endpoint",'."\n" - .' "engineType": "ODPS",'."\n" - .' "odpsEndpoint": "adb_mysql_mock_endpoint",'."\n" - .' "odpsProjectName": "am-xsaxaxa",'."\n" - .' "projectName": "am-xsxsaxa",'."\n" - .' "resourceGroupType": "DW",'."\n" - .' "specs": "{\\"connectionString\\":\\"am-xsaxsa.ads.aliyuncs.com:3306\\",\\"database\\":\\"xsaxsaxa\\",\\"password\\":\\"xsaxsaxassxsa\\",\\"instanceId\\":\\"am-xsaxsasx\\",\\"username\\":\\"xsaxsadsd\\"}",'."\n" - .' "taskSameAsOwner": false'."\n" - .' }'."\n" - ."\n" - .'* HADOOP_CDH'."\n" - ."\n" - .' {'."\n" - .' "bindingBaseId": "xsaxsaxs",'."\n" - .' "endpoint": "xsaaaaa",'."\n" - .' "engineType": "ODPS",'."\n" - .' "odpsEndpoint": "axsxaxssxs",'."\n" - .' "odpsProjectName": "ssxxax",'."\n" - .' "projectName": "xsaxsaxsa",'."\n" - .' "resourceGroupId": 45208xxxxxx,'."\n" - .' "resourceGroupType": "GATEWAY",'."\n" - .' "specs": "{\\"cluster\\":{\\"hive\\":{\\"hiveServer2Url\\":\\"jdbc:hive2://xxxxxxer-1-cn-shanghai-pre-kerberos-1:10000\\",\\"hiveMetastore\\":\\"thrift://xxxxxxxr-1-cn-shanghai-pre-kerberos-1:9083\\",\\"version\\":\\"2.1.1\\"},\\"configFiles\\":{\\"coreSite\\":\\"4534574xxxxxx\\",\\"hdfsSite\\":\\"453457919xxxxxxx\\",\\"mapredSite\\":\\"45345750xxxxxx\\",\\"yarnSite\\":\\"4534575xxxxx\\",\\"krb5Conf\\":\\"4534576xxxxx1\\",\\"hiveSite\\":\\"453457xxxxx20\\"},\\"spark\\":{\\"version\\":\\"2.4.0\\"},\\"cdh\\":{\\"version\\":\\"6.3.2\\"},\\"hdfs\\":{\\"version\\":\\"3.0.0\\"},\\"impala\\":{\\"impalaUrl\\":\\"jdbc:impala://cdh-xsxssxxsx-1-cn-shanghai-pre-kerberos-1:21050\\",\\"version\\":\\"3.2.0\\"},\\"yarn\\":{\\"YarnUrl\\":\\"http://cdh-xsxsxsxsxs-1-cn-shanghai-pre-kerberos-1:8032\\",\\"webUrl\\":\\"http://cdh-xsxsxssxxssx-1-cn-shanghai-pre-kerberos-1:8088\\",\\"version\\":\\"3.0.0\\"},\\"presto\\":{\\"prestoUrl\\":\\"jdbc:presto://cdh-xssxsxxsxsxs-1-cn-shanghai-pre-kerberos-1:8080/hive/default\\",\\"version\\":\\"0.244.1\\"}},\\"instanceId\\":161sdads733,\\"authDetail\\":{\\"principal\\":\\"hive@HADOOP.COM\\",\\"keytabFileId\\":\\"45345815xsxsxs3\\",\\"type\\":\\"kerberos\\",\\"username\\":\\"xsxsxsxsa@HADOOP.COM\\"},\\"resGroupStatus\\":\\"\\",\\"hadoopAuthType\\":\\"kerberos\\",\\"clusterIdentifier\\":\\"xssxsxsxsx\\",\\"clusterId\\":xsxsx,\\"resGroupId\\":4520870619xsxssxxs,\\"accessMode\\":\\"security\\",\\"authType\\":2}",'."\n" - .' "taskSameAsOwner": false'."\n" - .' }'."\n", - 'type' => 'object', - 'example' => '{"pubEndpoint":"http://service.cn.maxcompute.aliyun.com/api","endpoint":"http://service.cn.maxcompute.aliyun-inc.com/api","resourceGroupType":"ODPS","resourceGroupId":"361826516****","vpcEndpoint":"http://service.cn.maxcompute.aliyun-inc.com/api","projectName":"onefall_test_zjk","taskSameAsOwner":"true"}', - ], - 'EnvType' => [ - 'description' => 'The environment in which the compute engine is used. Valid values:'."\n" - ."\n" - .'* **DEV**'."\n" - .'* **PRD**'."\n", - 'type' => 'string', - 'example' => 'PRD', - ], - 'Region' => [ - 'description' => 'The region where the compute engine resides.'."\n", - 'type' => 'string', - 'example' => 'cn-zhangjiakou', - ], - 'GmtCreate' => [ - 'description' => 'The time when the compute engine was created.'."\n", - 'type' => 'string', - 'example' => 'Oct 10, 2019 3:42:44 PM', - ], - 'BindingProjectId' => [ - 'description' => 'The ID of the workspace with which the compute engine is associated.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '27', - ], - 'Name' => [ - 'description' => 'The display name of the compute engine.'."\n", - 'type' => 'string', - 'example' => 'abc', - ], - 'TenantId' => [ - 'description' => 'The tenant ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234567', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1AFAE64E-D1BE-432B-A9****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Invalid.Tenant.ConnectionNotExists', - 'errorMessage' => 'The connection does not exist.', - ], - [ - 'errorCode' => 'Invalid.Tenant.ProjectNotExists', - 'errorMessage' => 'The project does not exist.', - ], - [ - 'errorCode' => 'Invalid.Tenant.UserNotInProject', - 'errorMessage' => 'The user is not in the project.', - ], - [ - 'errorCode' => 'Invalid.CalcEngineEnvType', - 'errorMessage' => 'The specified envType %s is invalid.', - ], - [ - 'errorCode' => 'Invalid.CalcEngineType', - 'errorMessage' => 'The specified calcEngineType %s is invalid.', - ], + ['errorCode' => 'Invalid.Tenant.ConnectionNotExists', 'errorMessage' => 'The connection does not exist.', 'description' => 'The connection does not exist.'], + ['errorCode' => 'Invalid.Tenant.ProjectNotExists', 'errorMessage' => 'The project does not exist.', 'description' => 'The project does not exist.'], + ['errorCode' => 'Invalid.Tenant.UserNotInProject', 'errorMessage' => 'The user is not in the project.', 'description' => 'The user is not in the project.'], ], 403 => [ - [ - 'errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin', - 'errorMessage' => 'The user is not a project administrator or owner.', - ], - [ - 'errorCode' => 'Invalid.Tenant.UserNotInTenant', - 'errorMessage' => 'The user is not in tenant.', - ], + ['errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin', 'errorMessage' => 'The user is not a project administrator or owner.', 'description' => 'The user is not a project administrator or owner.'], + ['errorCode' => 'Invalid.Tenant.UserNotInTenant', 'errorMessage' => 'The user is not in tenant.', 'description' => 'The user is not in tenant.'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"1AFAE64E-D1BE-432B-A9****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 1,\\n \\"CalcEngines\\": [\\n {\\n \\"BindingProjectName\\": \\"test_project\\",\\n \\"IsDefault\\": true,\\n \\"EngineId\\": 35,\\n \\"DwRegion\\": \\"cn-zhangjiakou\\",\\n \\"TaskAuthType\\": \\"PROJECT\\",\\n \\"CalcEngineType\\": \\"ODPS\\",\\n \\"EngineInfo\\": {\\n \\"pubEndpoint\\": \\"service.cn.maxcompute.aliyun.com/api\\",\\n \\"endpoint\\": \\"service.cn.maxcompute.aliyun-inc.com/api\\",\\n \\"initProperties\\": \\" {\\\\\\"odpsTypeMode\\\\\\":\\\\\\"STANDARD\\\\\\",\\\\\\"openPai\\\\\\":false,\\\\\\"openPaiGpu\\\\\\":false}\\",\\n \\"resourceGroupType\\": \\"ODPS\\",\\n \\"resourceGroupId\\": \\"361826516****\\",\\n \\"vpcEndpoint\\": \\"service.cn.maxcompute.aliyun-inc.com/api\\",\\n \\"projectName\\": \\"onefall_test_zjk\\",\\n \\"taskSameAsOwner\\": \\"true\\"\\n },\\n \\"EnvType\\": \\"PRD\\",\\n \\"Region\\": \\"cn-zhangjiakou\\",\\n \\"GmtCreate\\": \\"Oct 10, 2019 3:42:44 PM\\",\\n \\"BindingProjectId\\": 466230,\\n \\"Name\\": \\"test_mc\\",\\n \\"TenantId\\": 1234567\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 0bc1ec92159376****\\n true\\n \\n 1\\n 20\\n 1\\n \\n abc\\n true\\n 35\\n cn-zhangjiakou\\n PROJECT\\n ODPS\\n PRD\\n cn-zhangjiakou\\n Oct 10, 2019 3:42:44 PM\\n 27\\n abc\\n 1234567\\n \\n \\n","errorExample":""}]', - 'title' => 'ListCalcEngines', - 'summary' => 'Queries a list of compute engines that are associated with a DataWorks workspace.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AFAE64E-D1BE-432B-A9****\\"\\n}","type":"json"}]', + 'title' => 'AddProjectMemberToRole', + 'summary' => 'Assigns a role to a member of a DataWorks workspace. Before you call this operation, you must add your account to a DataWorks workspace as a member.', + 'description' => '- Add the target account as a member of the DataWorks workspace. For more information, see [Add members to a DataWorks workspace](~~136941~~).'."\n" + ."\n" + .'- When you add a user to a preset role in a DataWorks workspace, the user is also added as a project role member in the MaxCompute project of the development environment of the workspace. For more information, see [Mappings between workspace-level preset roles and MaxCompute engine permissions](~~449397~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateDataSource' => [ - 'summary' => 'Adds a data source to DataWorks.', - 'methods' => [ - 'post', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataworks:AddProjectMemberToRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'AddRecognizeRule' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', - 'riskType' => 'high', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdide7FTVFZ', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '212268', + 'abilityTreeNodes' => ['FEATUREdideBVSRMP'], ], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the DataWorks workspace to which the data source belongs. You can call the [ListProjects](~~2780068~~) operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n", 'type' => 'string', 'required' => true, 'example' => '10241024'], ], [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the data source.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'abc', - ], + 'name' => 'AccountName', + 'in' => 'formData', + 'schema' => ['description' => 'The Alibaba Cloud account that is used to create a sensitive data identification rule. Enter the username of the Alibaba Cloud account.'."\n", 'type' => 'string', 'required' => true, 'example' => 'dsg-uat'], ], [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the data source.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], + 'name' => 'SensitiveName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the custom sensitive field. Enter a string that is less than 128 characters in length.'."\n", 'type' => 'string', 'required' => true, 'example' => 'name'], ], [ - 'name' => 'DataSourceType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the data source. Valid values:'."\n" - ."\n" - .'* odps'."\n" - .'* mysql'."\n" - .'* rds'."\n" - .'* oss'."\n" - .'* sqlserver'."\n" - .'* polardb'."\n" - .'* oracle'."\n" - .'* mongodb'."\n" - .'* emr'."\n" - .'* postgresql'."\n" - .'* analyticdb_for_mysql'."\n" - .'* hybriddb_for_postgresql'."\n" - .'* holo'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'rds', - ], + 'name' => 'TemplateId', + 'in' => 'formData', + 'schema' => ['description' => 'The template ID. You can call the [QueryDefaultTemplate](~~2743948~~) operation to obtain the template ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'e1970541-6cf5-4d23-b101-d5b66f6e1024'], ], [ - 'name' => 'SubType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The subtype of the data source.'."\n" - ."\n" - .'* This parameter takes effect only if you set the DataSourceType parameter to rds.'."\n" - .'* If the DataSourceType parameter is set to rds, this parameter can be set to mysql, sqlserver, or postgresql.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mysql', - ], + 'name' => 'NodeId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the data category. You can call the [QuerySensClassification](~~2746850~~) operation to query the ID of all data categories. Then, you can select a data category to create a sensitive field. Enter the ID of the selected data category.'."\n", 'type' => 'string', 'required' => true, 'example' => '0ce67949-0810-400f-a24a-cc5ffafe1024'], ], [ - 'name' => 'EnvType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The environment in which the data source is used. Valid values: 0 and 1. The value 0 indicates the development environment. The value 1 indicates the production environment.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'name' => 'NodeParent', + 'in' => 'formData', + 'schema' => ['description' => 'The information about the parent data category of the current data category. You can call the [QuerySensClassification](~~2746850~~) operation to obtain the ID of a data category.'."\n", 'type' => 'string', 'required' => true, 'example' => 'Customer/personal/personal_Natural _Information/personal basic_profile_information'], ], [ - 'name' => 'Content', - 'in' => 'query', - 'schema' => [ - 'description' => 'The details of the data source. Examples of details of some common data sources:'."\n" - ."\n" - .'* odps'."\n" - ."\n" - .' {'."\n" - .' "accessId": "*****",'."\n" - .' "accessKey": "*****",'."\n" - .' "authType": 2,'."\n" - .' "endpoint": "http://service.odps.aliyun.com/api",'."\n" - .' "project": "xsaxsax",'."\n" - .' "tag": "public"'."\n" - .' }'."\n" - ."\n" - .'* mysql'."\n" - ."\n" - .' {'."\n" - .' "database": "xsaxsa",'."\n" - .' "instanceName": "rm-xsaxsa",'."\n" - .' "password": "xsaxsa",'."\n" - .' "rdsOwnerId": "xasxsa",'."\n" - .' "regionId": "cn-shanghai",'."\n" - .' "tag": "rds",'."\n" - .' "username": "xsaxsa"'."\n" - .' }'."\n" - ."\n" - .'* rds'."\n" - ."\n" - .' {'."\n" - .' "configType": 1,'."\n" - .' "tag": "rds",'."\n" - .' "database": "xsaxsa",'."\n" - .' "username": "xsaxsa",'."\n" - .' "password": "xssaxsa$32050",'."\n" - .' "instanceName": "rm-xsaxs",'."\n" - .' "rdsOwnerId": "11111111"'."\n" - .' }'."\n" - ."\n" - .'* oss'."\n" - ."\n" - .' {'."\n" - .' "accessId": "*****",'."\n" - .' "accessKey": "*****",'."\n" - .' "bucket": "xsa-xs-xs",'."\n" - .' "endpoint": "http://oss-cn-shanghai.aliyuncs.com",'."\n" - .' "tag": "public"'."\n" - .' }'."\n" - ."\n" - .'* sqlserver'."\n" - ."\n" - .' {'."\n" - .' "jdbcUrl": "jdbc:sqlserver://xsaxsa-xsaxsa.database.xxx.cn:123;DatabaseName=xsxs-xsxs",'."\n" - .' "password": "sdasda$fs",'."\n" - .' "tag": "public",'."\n" - .' "username": "sxaxacdacdd"'."\n" - .' }'."\n" - ."\n" - .'* polardb'."\n" - ."\n" - .' {'."\n" - .' "clusterId": "pc-sdadsadsa",'."\n" - .' "database": "dsadsadsa",'."\n" - .' "ownerId": "121212122",'."\n" - .' "password": "sdasdafssa",'."\n" - .' "region": "cn-shanghai",'."\n" - .' "tag": "polardb",'."\n" - .' "username": "asdadsads"'."\n" - .' }'."\n" - ."\n" - .'* redis'."\n" - ."\n" - .' { '."\n" - .' "password": "xxxxxx", '."\n" - .' "address":"[{\\"host\\":\\"xxxxxxx.redis.rds.aliyuncs.com\\",\\"port\\":6379}]", '."\n" - .' "tag": "public"'."\n" - .' }'."\n" - ."\n" - .'* oracle'."\n" - ."\n" - .' {'."\n" - .' "jdbcUrl": "jdbc:oracle:saaa:@xxxxx:1521:PROD",'."\n" - .' "password": "sxasaxsa",'."\n" - .' "tag": "public",'."\n" - .' "username": "sasfadfa"'."\n" - .' }'."\n" - ."\n" - .'* mongodb'."\n" - ."\n" - .' {'."\n" - .' "address": "[\\"xsaxxsa.mongodb.rds.aliyuncs.com:3717\\"]",'."\n" - .' "database": "admin",'."\n" - .' "password": "sadsda@",'."\n" - .' "tag": "public",'."\n" - .' "username": "dsadsadas"'."\n" - .' }'."\n" - ."\n" - .'* emr'."\n" - ."\n" - .' {'."\n" - .' "accessId": "*****",'."\n" - .' "emrClusterId": "C-dsads",'."\n" - .' "emrResourceQueueName": "default",'."\n" - .' "emrEndpoint": "emr.aliyuncs.com",'."\n" - .' "accessKey": "*****",'."\n" - .' "emrUserId": "224833315798889783",'."\n" - .' "name": "sasdsadsa",'."\n" - .' "emrAccessMode": "simple",'."\n" - .' "region": "cn-shanghai",'."\n" - .' "authType": "2",'."\n" - .' "emrProjectId": "FP-sdadsad"'."\n" - .' }'."\n" - ."\n" - .'* postgresql'."\n" - ."\n" - .' {'."\n" - .' "jdbcUrl": "jdbc:postgresql://xxxx:1921/ssss",'."\n" - .' "password": "sdadsads",'."\n" - .' "tag": "public",'."\n" - .' "username": "sdsasda"'."\n" - .' }'."\n" - ."\n" - .'* analyticdb_for_mysql'."\n" - ."\n" - .' {'."\n" - .' "instanceId": "am-sadsada",'."\n" - .' "database": "xsxsx",'."\n" - .' "username": "xsxsa",'."\n" - .' "password": "asdadsa",'."\n" - .' "connectionString": "am-xssxsxs.ads.aliyuncs.com:3306"'."\n" - .' }'."\n" - ."\n" - .'* hybriddb_for_postgresql'."\n" - ."\n" - .' {'."\n" - .' "connectionString": "gp-xsaxsaxa-master.gpdbmaster.rds.aliyuncs.com",'."\n" - .' "database": "xsaxsaxas",'."\n" - .' "password": "xsaxsaxsa@11",'."\n" - .' "instanceId": "gp-xsaxsaxsa",'."\n" - .' "port": "541132",'."\n" - .' "ownerId": "xsaxsaxsas",'."\n" - .' "username": "sadsad"'."\n" - .' }'."\n" - ."\n" - .'* holo'."\n" - ."\n" - .' {'."\n" - .' "accessId": "*****",'."\n" - .' "accessKey": "*****",'."\n" - .' "database": "xsaxsaxsa",'."\n" - .' "instanceId": "xsaxa",'."\n" - .' "tag": "aliyun"'."\n" - .' }'."\n" - ."\n" - .'* kafka'."\n" - ."\n" - .' {'."\n" - .' "instanceId": "xsax-cn-xsaxsa",'."\n" - .' "regionId": "cn-shanghai",'."\n" - .' "tag": "aliyun",'."\n" - .' "ownerId": "1212121212112"'."\n" - .' }'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '{"database":"dbname","instanceName":"instancename","password":"password","rdsOwnerId":"123","username":"username"}', - ], + 'name' => 'Level', + 'in' => 'formData', + 'schema' => ['description' => 'The sensitivity level of the sensitive field. You can select one from all sensitivity levels that are defined in a template as the sensitivity level of the sensitive field, such as level 1 to level 10.'."\n", 'type' => 'string', 'required' => true, 'example' => '1'], + ], + [ + 'name' => 'LevelName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the sensitivity level. You can call the [QueryDefaultTemplate](~~2743948~~) operation to obtain the name of the sensitivity level in the related template.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Confidential'], + ], + [ + 'name' => 'SensitiveDescription', + 'in' => 'formData', + 'schema' => ['description' => 'The description of the sensitive field. Enter a string that is less than 128 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'This is a sensitive field that identifies the name.'], + ], + [ + 'name' => 'OperationType', + 'in' => 'formData', + 'schema' => ['description' => 'The type of the arithmetic operation. Valid values:'."\n" + ."\n" + .'* 0: OR'."\n" + .'* 1: AND'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0'], + ], + [ + 'name' => 'RecognizeRulesType', + 'in' => 'formData', + 'schema' => ['description' => 'The type of the sensitive data identification rule. Valid values:'."\n" + ."\n" + .'* 1: regular expression'."\n" + .'* 2: built-in rule'."\n" + .'* 3: sample library'."\n" + .'* 4: self-generated data identification model'."\n", 'type' => 'string', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'RecognizeRules', + 'in' => 'formData', + 'schema' => ['description' => 'The content of the sensitive data identification rule. You can call the [QuerySensNodeInfo](~~2747189~~) operation to query the value of the current parameter for a built-in sensitive field.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"contentRule":{"_clazz":"com.alipay.dsgclient.sdk.dsg.fastscan.engine.cond.GenderCond"},"_clazz":"com.alipay.dsg.dal.model.RuleContent"}'], + ], + [ + 'name' => 'ContentScan', + 'in' => 'formData', + 'schema' => ['description' => 'Identifies content. You can call the [QuerySensNodeInfo](~~2747189~~) operation to query the value of the current parameter for a built-in sensitive field.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"_clazz":"com.alipay.dsgclient.sdk.dsg.fastscan.engine.cond.NationalityCond"}'], + ], + [ + 'name' => 'HitThreshold', + 'in' => 'formData', + 'schema' => ['description' => 'The hit ratio threshold. If more than 60%, which is a sample hit ratio threshold, of all sample data records hit the Name Entity Recognition (NER) model, the sensitive field is hit. The value can be an integer from 0 to 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50'], + ], + [ + 'name' => 'ColScan', + 'in' => 'formData', + 'schema' => ['description' => 'Scans fields. The system identifies only fields that are assigned with values.'."\n" + ."\n" + .'* The value must be in the ${Project name}.${Table name}.${Field name} or ${Project name}.${Schema name}.${Table name}.${Field name} format.'."\n" + .'* *Wildcards are supported. For example, the asterisk (\\*) in default.table.column1\\* can be used to match any content following default.table.column1, such as default.table.column10.'."\n", 'type' => 'string', 'required' => false, 'example' => 'default.qujian.*'], + ], + [ + 'name' => 'ColExclude', + 'in' => 'formData', + 'schema' => ['description' => 'Excludes fields. The system does not identify fields that are assigned with values.'."\n" + ."\n" + .'* The value must be in the ${Project name}.${Table name}.${Field name} or ${Project name}.${Schema name}.${Table name}.${Field name} format.'."\n" + .'* *Wildcards are supported. For example, the asterisk (\\*) in default.table.column1\\* can be used to match any content following default.table.column1, such as default.table.column10.'."\n", 'type' => 'string', 'required' => false, 'example' => 'default.qujian.*6'], + ], + [ + 'name' => 'CommentScan', + 'in' => 'formData', + 'schema' => ['description' => 'Scans content. The value is the text of each field comment in your data asset. Fuzzy match is supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test'], + ], + [ + 'name' => 'Status', + 'in' => 'formData', + 'schema' => ['description' => 'The status of the sensitive field. Valid values:'."\n" + ."\n" + .'* 0: draft'."\n" + .'* 1: effective'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'OpenApiResultModel', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The data source ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0bc141151593763****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '9990030003'], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'Missing parameter'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Data' => ['description' => 'The returned result in the JSON format.'."\n", 'type' => 'any', 'example' => '{ "HttpStatusCode": 200, "Success": true }'], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '10000001'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Invalid.Tenant.ConnectionNotExists', - 'errorMessage' => 'The connection does not exist.', - ], - [ - 'errorCode' => 'Invalid.Tenant.ProjectNotExists', - 'errorMessage' => 'The project does not exist.', - ], - [ - 'errorCode' => 'Invalid.Tenant.UserNotInProject', - 'errorMessage' => 'The user is not in the project.', - ], - [ - 'errorCode' => 'ConnectionAlreadyExist', - 'errorMessage' => 'The connection with envType %s and name %s already exists.', - ], - [ - 'errorCode' => 'DataSource.CheckRamRoleFailure', - 'errorMessage' => 'Failed to check the RAM role. AccountId %s. roleArn %s.', - ], - [ - 'errorCode' => 'DataSource.ConnectionStrProperty.PatternNotMatch', - 'errorMessage' => 'The pattern value %s is invalid. The correct pattern is %s.', - ], - [ - 'errorCode' => 'Invalid.DataSource.DataSourceTypeNotSupport', - 'errorMessage' => 'The dataSourceType %s and subType %s are not supported.', - ], - [ - 'errorCode' => 'Invalid.Param.Odps.EngineIdOrConnectStrEmpty', - 'errorMessage' => 'Either the compute engine ID or the connection string must be specified when data source type is ODPS.', - ], - [ - 'errorCode' => 'MissingParam.ConnectionStr.Property', - 'errorMessage' => 'You must specify property %s required by the data source connection string.', - ], - [ - 'errorCode' => 'Invalid.DataSource.DataSourceTypeNotExist', - 'errorMessage' => 'The data source type %s does not exist.', - ], + ['errorCode' => 'BADPARAMETERS', 'errorMessage' => 'Parameters are missing or in the wrong format.', 'description' => ''], ], - 403 => [ - [ - 'errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin', - 'errorMessage' => 'The user is not a project administrator or owner.', - ], - [ - 'errorCode' => 'Invalid.Tenant.UserNotInTenant', - 'errorMessage' => 'The user is not in tenant.', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"9990030003\\",\\n \\"ErrorMessage\\": \\"Missing parameter\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"{ \\\\\\"HttpStatusCode\\\\\\": 200, \\\\\\"Success\\\\\\": true }\\",\\n \\"RequestId\\": \\"10000001\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 9990030003\\n 缺少参数\\n 200\\n { \\"HttpStatusCode\\": 200, \\"Success\\": true }\\n 10000001\\n","errorExample":""}]', + 'title' => 'AddRecognizeRule', + 'summary' => 'Adds a sensitive field that is defined based on the category and sensitivity level of data in Data Security Guard.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataworks:AddRecognizeRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": 123,\\n \\"RequestId\\": \\"0bc141151593763****\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 123\\n 0bc141151593763****\\n true\\n","errorExample":""}]', - 'title' => 'CreateDataSource', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'ListDataSources' => [ - 'summary' => 'Queries the data sources added to a DataWorks workspace.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'AddToMetaCategory' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'create', + 'abilityTreeCode' => '78167', + 'abilityTreeNodes' => ['FEATUREdideRZEBFC'], ], 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'CategoryId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the DataWorks workspace to which the data sources belong. You can call the [ListProjects](~~2780068~~) operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The ID of the category.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '5', 'title' => ''], ], [ - 'name' => 'Name', + 'name' => 'TableGuid', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the data source that you want to query.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'The GUID of the metatable.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'odps.engine_name.table_name', 'title' => ''], ], - [ - 'name' => 'DataSourceType', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The type of the data source. Valid values:'."\n" - ."\n" - .'* odps'."\n" - .'* mysql'."\n" - .'* rds'."\n" - .'* oss'."\n" - .'* sqlserver'."\n" - .'* polardb'."\n" - .'* oracle'."\n" - .'* mongodb'."\n" - .'* emr'."\n" - .'* postgresql'."\n" - .'* analyticdb_for_mysql'."\n" - .'* hybriddb_for_postgresql'."\n" - .'* holo'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rds', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the metatable was added to the specified category.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0bc1ec92159376', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The connection does not exist.', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'SubType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The subtype of the data source. This parameter takes effect only when the DataSourceType parameter is set to rds.'."\n" - ."\n" - .'If the value of the DataSourceType parameter is rds, the value of this parameter can be mysql, sqlserver, or postgresql.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mysql', - ], + ], + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], ], + ], + 'title' => 'AddToMetaCategory', + 'summary' => 'Adds a metatable to a specified category.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' AddToMetaCategory接口的使用示例Demo请参见[DataWorks OpenAPI示例](https://developer.aliyun.com/article/780879?groupCode=dataworks)。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'ApprovePermissionApplyOrder' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Status', - 'in' => 'query', - 'schema' => [ - 'description' => 'The status of the data source. Valid values:'."\n" - ."\n" - .'* ENABLED'."\n" - .'* DISABLED'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ENABLED', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'EnvType', + 'name' => 'FlowId', 'in' => 'query', - 'schema' => [ - 'description' => 'The environment in which the data source is used. Valid values: 0 and 1. The value 0 indicates development environment. The value 1 indicates production environment.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The ID of the permission request order to approve. You can call the [ListPermissionApplyOrders](~~211008~~) operation to obtain the ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '48f36729-05f9-4a40-9286-933fd940f30a', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'ApproveComment', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The remarks for the approval.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'agree', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'ApproveAction', 'in' => 'query', 'schema' => [ - 'description' => 'The page number. Pages start from page 1.'."\n", + 'description' => 'The approval action to perform. Valid values:'."\n" + .'- 1: Approve.'."\n" + .'- 2: Reject.', + 'enumValueTitles' => [], 'type' => 'integer', 'format' => 'int32', - 'required' => false, + 'required' => true, + 'docRequired' => true, + 'maximum' => '5', + 'minimum' => '0', + 'enum' => ['0', '1', '2', '3', '4', '5'], 'example' => '1', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0bc14115159376359****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The query result returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'TotalCount' => [ - 'description' => 'The total number of data sources.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '233', - ], - 'DataSources' => [ - 'description' => 'The data sources.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the data source.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status of the data source. Valid values:'."\n" - ."\n" - .'* 1: The data source is accessible.'."\n" - .'* 2: The data source is inaccessible.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ProjectId' => [ - 'description' => 'The ID of the workspace to which the data source belongs.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '123', - ], - 'SubType' => [ - 'description' => 'The subtype of the data source. This parameter takes effect only when the DataSourceType parameter is set to rds.'."\n", - 'type' => 'string', - 'example' => 'mysql', - ], - 'GmtModified' => [ - 'description' => 'The time when the data source was last modified. Example: Mar 17, 2021 4:09:32 PM.'."\n", - 'type' => 'string', - 'example' => 'Mar 17, 2021 4:09:32 PM', - ], - 'EnvType' => [ - 'description' => 'The environment in which the data source is used. Valid values:'."\n" - ."\n" - .'* 0: development environment'."\n" - .'* 1: production environment'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ConnectStatus' => [ - 'description' => 'The status of the data source. Valid values:'."\n" - ."\n" - .'* 1: The data source is accessible.'."\n" - .'* 2: The data source is inaccessible.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Sequence' => [ - 'description' => 'The sequence number of the data source. Data sources are sorted in descending order based on the value of this parameter.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '300', - ], - 'Description' => [ - 'description' => 'The description of the data source.'."\n", - 'type' => 'string', - 'example' => 'a connection', - ], - 'DataSourceType' => [ - 'description' => 'The type of the data source. Valid values:'."\n" - ."\n" - .'* odps'."\n" - .'* mysql'."\n" - .'* rds'."\n" - .'* oss'."\n" - .'* sqlserver'."\n" - .'* polardb'."\n" - .'* oracle'."\n" - .'* mongodb'."\n" - .'* emr'."\n" - .'* postgresql'."\n" - .'* analyticdb_for_mysql'."\n" - .'* hybriddb_for_postgresql'."\n" - .'* holo'."\n", - 'type' => 'string', - 'example' => 'rds', - ], - 'GmtCreate' => [ - 'description' => 'The time when the data source was created. Example: Mar 17, 2021 4:09:32 PM.'."\n", - 'type' => 'string', - 'example' => 'Mar 17, 2021 4:09:32 PM', - ], - 'DefaultEngine' => [ - 'description' => 'Indicates whether the compute engine that is associated with the data source is the default compute engine used by data sources of the same type.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'Shared' => [ - 'description' => 'Indicates whether the data source is a shared data source.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'Operator' => [ - 'description' => 'The ID of the Alibaba Cloud account that is used to last modify the data source.'."\n", - 'type' => 'string', - 'example' => '193543050****', - ], - 'Name' => [ - 'description' => 'The name of the data source.'."\n", - 'type' => 'string', - 'example' => 'abc', - ], - 'Content' => [ - 'description' => 'The data connection string. The value of this parameter is in the JSON format. Examples of connection strings of common data sources:'."\n" - ."\n" - .'* MaxCompute'."\n" - ."\n" - .' {'."\n" - .' "pubEndpoint": "http://service.cn.maxcompute.aliyun.com/api",'."\n" - .' "accessId": "xxxxxxx",'."\n" - .' "securityToken": null,'."\n" - .' "endpoint": "http://service.cn.maxcompute.aliyun-inc.com/api",'."\n" - .' "accessKey": "***",'."\n" - .' "name": "PRE_PROJECT_A_engine",'."\n" - .' "project": "PRE_PROJECT_A",'."\n" - .' "vpcEndpoint": "http://service.cn.maxcompute.aliyun-inc.com/api",'."\n" - .' "region": "cn-shanghai",'."\n" - .' "authType": "2"'."\n" - .' }'."\n" - ."\n" - .'* mysql'."\n" - ."\n" - .' {'."\n" - .' "configType": "1",'."\n" - .' "database": "mysql_d111b",'."\n" - .' "instanceName": "rm-xxxxxx",'."\n" - .' "password": "***",'."\n" - .' "rdsOwnerId": "12133xxxxxx",'."\n" - .' "tag": "rds",'."\n" - .' "username": "mysql_db111"'."\n" - .' }'."\n" - ."\n" - .'* sqlserver'."\n" - ."\n" - .' {'."\n" - .' "configType": "1",'."\n" - .' "jdbcUrl": "jdbc:sqlserver://rm-xxxxx.sqlserver.rds.aliyuncs.com:1433;DatabaseName=sqlserver_db1",'."\n" - .' "password": "***",'."\n" - .' "tag": "public",'."\n" - .' "username": "sqlserver_db111"'."\n" - .' }'."\n" - ."\n" - .'* oss'."\n" - ."\n" - .' {'."\n" - .' "accessId": "***********",'."\n" - .' "accessKey": "***********",'."\n" - .' "bucket": "bigxxx1223",'."\n" - .' "configType": "1",'."\n" - .' "endpoint": "http://oss-cn-hangzhou.aliyuncs.com",'."\n" - .' "tag": "public"'."\n" - .' }'."\n" - ."\n" - .'* postgresql'."\n" - ."\n" - .' {'."\n" - .' "configType": "1",'."\n" - .' "database": "cdp_xxx",'."\n" - .' "instanceName": "rm-xxxx",'."\n" - .' "password": "***",'."\n" - .' "rdsOwnerId": "121xxxxx",'."\n" - .' "tag": "rds",'."\n" - .' "username": "cdp_xxx"'."\n" - .' }'."\n" - ."\n" - .'* ads'."\n" - ."\n" - .' {'."\n" - .' "configType": "1",'."\n" - .' "password": "***",'."\n" - .' "schema": "ads_demo",'."\n" - .' "tag": "public",'."\n" - .' "url": "ads-xxx-xxxx.cn-hangzhou-1.ads.aliyuncs.com:3029",'."\n" - .' "username": "lslslsls"'."\n" - .' }'."\n", - 'type' => 'string', - 'example' => '{"pubEndpoint":"http://service.cn.maxcompute.aliyun.com/api","accessId":"TMP.3KecGjvzy3i8MYfn2BGHgF7EHGyBFZcHm7GgngrABVRyvvKQrfF5kskR36xP361C3dqwbGo7SGYptAeGyiTwHXqLaBUvYC","securityToken":null,"endpoint":"http://service.cn.maxcompute.aliyun-inc.com/api","accessKey":"***","name":"PRE_PROJECT_A_engine","project":"PRE_PROJECT_A","vpcEndpoint":"http://service.cn.maxcompute.aliyun-inc.com/api","region":"cn-shanghai","authType":"2"}', - ], - 'Id' => [ - 'description' => 'The data source ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'BindingCalcEngineId' => [ - 'description' => 'The ID of the compute engine with which the data source is associated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'TenantId' => [ - 'description' => 'The tenant ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234567', - ], - ], - ], - ], - ], - ], + 'ApproveSuccess' => ['description' => 'Indicates whether the approval is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0bc1ec92159376****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Invalid.Tenant.ConnectionNotExists', - 'errorMessage' => 'The connection does not exist.', - ], - [ - 'errorCode' => 'Invalid.Tenant.ProjectNotExists', - 'errorMessage' => 'The project does not exist.', - ], - [ - 'errorCode' => 'Invalid.Tenant.UserNotInProject', - 'errorMessage' => 'The user is not in the project.', - ], - ], - 403 => [ - [ - 'errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin', - 'errorMessage' => 'The user is not a project administrator or owner.', - ], - [ - 'errorCode' => 'Invalid.Tenant.UserNotInTenant', - 'errorMessage' => 'The user is not in tenant.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0bc14115159376359****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 233,\\n \\"DataSources\\": [\\n {\\n \\"Status\\": 1,\\n \\"ProjectId\\": 123,\\n \\"SubType\\": \\"mysql\\",\\n \\"GmtModified\\": \\"Mar 17, 2021 4:09:32 PM\\",\\n \\"EnvType\\": 1,\\n \\"ConnectStatus\\": 1,\\n \\"Sequence\\": 300,\\n \\"Description\\": \\"a connection\\",\\n \\"DataSourceType\\": \\"rds\\",\\n \\"GmtCreate\\": \\"Mar 17, 2021 4:09:32 PM\\",\\n \\"DefaultEngine\\": false,\\n \\"Shared\\": false,\\n \\"Operator\\": \\"193543050****\\",\\n \\"Name\\": \\"abc\\",\\n \\"Content\\": \\"{\\\\\\"pubEndpoint\\\\\\":\\\\\\"http://service.cn.maxcompute.aliyun.com/api\\\\\\",\\\\\\"accessId\\\\\\":\\\\\\"TMP.3KecGjvzy3i8MYfn2BGHgF7EHGyBFZcHm7GgngrABVRyvvKQrfF5kskR36xP361C3dqwbGo7SGYptAeGyiTwHXqLaBUvYC\\\\\\",\\\\\\"securityToken\\\\\\":null,\\\\\\"endpoint\\\\\\":\\\\\\"http://service.cn.maxcompute.aliyun-inc.com/api\\\\\\",\\\\\\"accessKey\\\\\\":\\\\\\"***\\\\\\",\\\\\\"name\\\\\\":\\\\\\"PRE_PROJECT_A_engine\\\\\\",\\\\\\"project\\\\\\":\\\\\\"PRE_PROJECT_A\\\\\\",\\\\\\"vpcEndpoint\\\\\\":\\\\\\"http://service.cn.maxcompute.aliyun-inc.com/api\\\\\\",\\\\\\"region\\\\\\":\\\\\\"cn-shanghai\\\\\\",\\\\\\"authType\\\\\\":\\\\\\"2\\\\\\"}\\",\\n \\"Id\\": 1,\\n \\"BindingCalcEngineId\\": 123,\\n \\"TenantId\\": 1234567\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"0bc14115159376359****\\n200\\n\\n 233\\n 20\\n 1\\n \\n 1\\n 193543050****\\n 1\\n mysql\\n a connection\\n 123\\n 123\\n Mar 17, 2021 4:09:32 PM\\n 300\\n false\\n 1\\n abc\\n false\\n 1234567\\n Mar 17, 2021 4:09:32 PM\\n {\\"pubEndpoint\\":\\"http://service.cn.maxcompute.aliyun.com/api\\",\\"accessId\\":\\"TMP.3KecGjvzy3i8MYfn2BGHgF7EHGyBFZcHm7GgngrABVRyvvKQrfF5kskR36xP361C3dqwbGo7SGYptAeGyiTwHXqLaBUvYC\\",\\"securityToken\\":null,\\"endpoint\\":\\"http://service.cn.maxcompute.aliyun-inc.com/api\\",\\"accessKey\\":\\"***\\",\\"name\\":\\"PRE_PROJECT_A_engine\\",\\"project\\":\\"PRE_PROJECT_A\\",\\"vpcEndpoint\\":\\"http://service.cn.maxcompute.aliyun-inc.com/api\\",\\"region\\":\\"cn-shanghai\\",\\"authType\\":\\"2\\"}\\n rds\\n 1\\n \\n\\ntrue","errorExample":""}]', - 'title' => 'ListDataSources', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ApproveSuccess\\": true,\\n \\"RequestId\\": \\"0bc1ec92159376****\\"\\n}","type":"json"}]', + 'title' => 'Approve a permission request order', + 'summary' => 'Approves a permission request order.'."\n" + ."\n" + .'Note: The 2020 edition of OpenAPI will be discontinued. Migrate to the 2024 edition OpenAPI ApproveProcessInstance as soon as possible.', + 'description' => '**Note: The 2020 edition of OpenAPI will be discontinued. Migrate to the 2024 edition OpenAPI [ApproveProcessInstance](https://www.alibabacloud.com/help/en/dataworks/developer-reference/api-dataworks-public-2024-05-18-approveprocessinstance) as soon as possible.**.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateDataSource' => [ - 'summary' => 'Updates a data source.', - 'methods' => [ - 'put', + 'changeSet' => [ + ['createdAt' => '2022-04-28T08:54:54.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CallbackExtension' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'high', + 'operationType' => 'none', + 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '78369', - 'abilityTreeNodes' => [ - 'FEATUREdideRWC5F7', - ], + 'abilityTreeCode' => '191317', + 'abilityTreeNodes' => ['FEATUREdideRWC5F7'], ], 'parameters' => [ [ - 'name' => 'Description', - 'in' => 'query', + 'name' => 'ExtensionCode', + 'in' => 'formData', + 'schema' => ['description' => 'The unique code of the extension.'."\n", 'type' => 'string', 'required' => true, 'example' => '8abcb91f-d266-4073-b907-2ed670378ed1'], + ], + [ + 'name' => 'MessageId', + 'in' => 'formData', + 'schema' => ['description' => 'The message ID in DataWorks OpenEvent. You can obtain the ID from a received message when an extension point event is triggered.'."\n", 'type' => 'string', 'required' => true, 'example' => '03400b03-b721-4c34-8727-2d6884077091'], + ], + [ + 'name' => 'CheckResult', + 'in' => 'formData', 'schema' => [ - 'description' => 'The description of the data source.'."\n", + 'description' => 'The check status of the extension point event. Valid values:'."\n" + ."\n" + .'* OK: The event passes the check.'."\n" + .'* FAIL: The event fails to pass the check. You must check and handle the reported error at the earliest opportunity to ensure that your program is run as expected.'."\n" + .'* WARN: The event passes the check, but an alert is reported.'."\n", 'type' => 'string', - 'required' => false, - 'example' => 'xxx', + 'required' => true, + 'example' => 'FAIL', + 'enum' => ['OK', 'FAIL', 'WARN'], ], ], [ - 'name' => 'EnvType', - 'in' => 'query', + 'name' => 'CheckMessage', + 'in' => 'formData', + 'schema' => ['description' => 'The check message of the extension point event. If CheckResult is set to FAIL, you must provide the failure cause.'."\n", 'type' => 'string', 'required' => false, 'example' => 'The xxx rule is hit. Modify it and try again.'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The environment in which the data source resides. Valid values:'."\n" - ."\n" - .'* 0: development environment'."\n" - .'* 1: production environment'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'example' => '1', + 'title' => 'Schema of Response', + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '7C352CB7-CD88-50CF-9D0D-E81BDF020E7F'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'true'."\n" + ."\n" + .'false'."\n", 'type' => 'string', 'example' => 'true'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7C352CB7-CD88-50CF-9D0D-E81BDF020E7F\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 7C352CB7-CD88-50CF-9D0D-E81BDF020E7F\\n true\\n","errorExample":""}]', + 'title' => 'CallbackExtension', + 'summary' => 'Sends the processing result of an extension point event by an extension to DataWorks.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'ChangeResourceManagerResourceGroup' => [ + 'summary' => 'Changes the resource group of a resource.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'Content', + 'name' => 'ResourceType', 'in' => 'query', - 'schema' => [ - 'description' => 'The details about the data source. You are not allowed to change the type of the data source. For example, you are not allowed to change the data source type from MaxCompute to MySQL. Examples of details of some common data sources:'."\n" - ."\n" - .'* odps'."\n" - ."\n" - .' {'."\n" - .' "accessId": "*****",'."\n" - .' "accessKey": "*****",'."\n" - .' "authType": 2,'."\n" - .' "endpoint": "http://service.odps.aliyun.com/api",'."\n" - .' "project": "xsaxsax",'."\n" - .' "tag": "public"'."\n" - .' }'."\n" - ."\n" - .'* mysql'."\n" - ."\n" - .' {'."\n" - .' "database": "xsaxsa",'."\n" - .' "instanceName": "rm-xsaxsa",'."\n" - .' "password": "xsaxsa",'."\n" - .' "rdsOwnerId": "xasxsa",'."\n" - .' "regionId": "cn-shanghai",'."\n" - .' "tag": "rds",'."\n" - .' "username": "xsaxsa"'."\n" - .' }'."\n" - ."\n" - .'* rds'."\n" - ."\n" - .' {'."\n" - .' "configType": 1,'."\n" - .' "tag": "rds",'."\n" - .' "database": "xsaxsa",'."\n" - .' "username": "xsaxsa",'."\n" - .' "password": "xssaxsa$32050",'."\n" - .' "instanceName": "rm-xsaxs",'."\n" - .' "rdsOwnerId": "11111111"'."\n" - .' }'."\n" - ."\n" - .'* oss'."\n" - ."\n" - .' {'."\n" - .' "accessId": "*****",'."\n" - .' "accessKey": "*****",'."\n" - .' "bucket": "xsa-xs-xs",'."\n" - .' "endpoint": "http://oss-cn-shanghai.aliyuncs.com",'."\n" - .' "tag": "public"'."\n" - .' }'."\n" - ."\n" - .'* sqlserver'."\n" - ."\n" - .' {'."\n" - .' "jdbcUrl": "jdbc:sqlserver://xsaxsa-xsaxsa.database.xxx.cn:123;DatabaseName=xsxs-xsxs",'."\n" - .' "password": "sdasda$fs",'."\n" - .' "tag": "public",'."\n" - .' "username": "sxaxacdacdd"'."\n" - .' }'."\n" - ."\n" - .'* polardb'."\n" - ."\n" - .' {'."\n" - .' "clusterId": "pc-sdadsadsa",'."\n" - .' "database": "dsadsadsa",'."\n" - .' "ownerId": "121212122",'."\n" - .' "password": "sdasdafssa",'."\n" - .' "region": "cn-shanghai",'."\n" - .' "tag": "polardb",'."\n" - .' "username": "asdadsads"'."\n" - .' }'."\n" - ."\n" - .'* oracle'."\n" - ."\n" - .' {'."\n" - .' "jdbcUrl": "jdbc:oracle:saaa:@xxxxx:1521:PROD",'."\n" - .' "password": "sxasaxsa",'."\n" - .' "tag": "public",'."\n" - .' "username": "sasfadfa"'."\n" - .' }'."\n" - ."\n" - .'* mongodb'."\n" - ."\n" - .' {'."\n" - .' "address": "[\\"xsaxxsa.mongodb.rds.aliyuncs.com:3717\\"]",'."\n" - .' "database": "admin",'."\n" - .' "password": "sadsda@",'."\n" - .' "tag": "public",'."\n" - .' "username": "dsadsadas"'."\n" - .' }'."\n" - ."\n" - .'* emr'."\n" - ."\n" - .' {'."\n" - .' "accessId": "*****",'."\n" - .' "emrClusterId": "C-dsads",'."\n" - .' "emrResourceQueueName": "default",'."\n" - .' "emrEndpoint": "emr.aliyuncs.com",'."\n" - .' "accessKey": "*****",'."\n" - .' "emrUserId": "224833315798889783",'."\n" - .' "name": "sasdsadsa",'."\n" - .' "emrAccessMode": "simple",'."\n" - .' "region": "cn-shanghai",'."\n" - .' "authType": "2",'."\n" - .' "emrProjectId": "FP-sdadsad"'."\n" - .' }'."\n" - ."\n" - .'* postgresql'."\n" - ."\n" - .' {'."\n" - .' "jdbcUrl": "jdbc:postgresql://xxxx:1921/ssss",'."\n" - .' "password": "sdadsads",'."\n" - .' "tag": "public",'."\n" - .' "username": "sdsasda"'."\n" - .' }'."\n" - ."\n" - .'* analyticdb_for_mysql'."\n" - ."\n" - .' {'."\n" - .' "instanceId": "am-sadsada",'."\n" - .' "database": "xsxsx",'."\n" - .' "username": "xsxsa",'."\n" - .' "password": "asdadsa",'."\n" - .' "connectionString": "am-xssxsxs.ads.aliyuncs.com:3306"'."\n" - .' }'."\n" - ."\n" - .'* hybriddb_for_postgresql'."\n" - ."\n" - .' {'."\n" - .' "connectionString": "gp-xsaxsaxa-master.gpdbmaster.rds.aliyuncs.com",'."\n" - .' "database": "xsaxsaxas",'."\n" - .' "password": "xsaxsaxsa@11",'."\n" - .' "instanceId": "gp-xsaxsaxsa",'."\n" - .' "port": "541132",'."\n" - .' "ownerId": "xsaxsaxsas",'."\n" - .' "username": "sadsad"'."\n" - .' }'."\n" - ."\n" - .'* holo'."\n" - ."\n" - .' {'."\n" - .' "accessId": "*****",'."\n" - .' "accessKey": "*****",'."\n" - .' "database": "xsaxsaxsa",'."\n" - .' "instanceId": "xsaxa",'."\n" - .' "tag": "aliyun"'."\n" - .' }'."\n" - ."\n" - .'* kafka'."\n" - ."\n" - .' {'."\n" - .' "instanceId": "xsax-cn-xsaxsa",'."\n" - .' "regionId": "cn-shanghai",'."\n" - .' "tag": "aliyun",'."\n" - .' "ownerId": "1212121212112"'."\n" - .' }'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '{"accessId":"xssssss","accessKey":"xsaxsaxsa","authType":2,"endpoint":"http://service.odps.aliyun.com/api","project":"xsaxsax","tag":"public"}', - ], + 'schema' => ['description' => 'The resource type. Valid values:'."\n" + ."\n" + .'- project: a workspace. Select this value to change the resource group for a DataWorks edition.'."\n" + ."\n" + .'- tenantresourcegroup: an exclusive resource group. Select this value to change the resource group for a DataWorks exclusive resource group.', 'type' => 'string', 'required' => true, 'example' => 'project', 'title' => ''], ], [ - 'name' => 'Status', + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the resource. The value of this parameter depends on the value of the ResourceType parameter:'."\n" + ."\n" + .'- If ResourceType is set to project, this parameter specifies the name of the workspace (ProjectIdentifier). You can call the [ListProjects](~~2780068~~) operation to obtain the workspace name.'."\n" + ."\n" + .'- If ResourceType is set to tenantresourcegroup, this parameter specifies the identifier of the exclusive resource group (Identifier). You can call the [ListResourceGroups](~~2780075~~) operation to obtain the identifier. This applies only to resource groups of type 7, 8, or 9.', 'type' => 'string', 'required' => true, 'example' => 'test_project', 'title' => ''], + ], + [ + 'name' => 'ResourceManagerResourceGroupId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the destination resource group.', 'type' => 'string', 'required' => true, 'example' => 'rg-bp67acfmxazb4p****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The status of the data source. This parameter is deprecated. Do not use this parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ENABLED', + 'description' => 'The returned results.', + 'type' => 'object', + 'properties' => [ + 'Data' => ['description' => 'Indicates whether the resource group was changed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1AFAE64E-D1BE-432B-A9****', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"1AFAE64E-D1BE-432B-A9****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'ChangeResourceManagerResourceGroup', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'DataSourceId', - 'in' => 'query', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dataworks:ChangeResourceManagerResourceGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'CheckFileDeployment' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '78171', + 'abilityTreeNodes' => ['FEATUREdide4AR6E0', 'FEATUREdide8FM783'], + ], + 'parameters' => [ + [ + 'name' => 'CheckerInstanceId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the instance to which the file checker belongs. You can obtain the ID from the CheckerInstanceId parameter in the check event logs returned by DataWorks.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '66_123455623_2', 'title' => ''], + ], + [ + 'name' => 'Status', + 'in' => 'formData', 'schema' => [ - 'description' => 'The ID of the data source. You can call the [ListDataSources](~~2780072~~) operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The check status of the file that you want to deploy. Valid values:'."\n" + ."\n" + .'- OK: The file passes the check.'."\n" + ."\n" + .'- WARN: The file passes the check, but an alert is reported.'."\n" + ."\n" + .'- FAIL: The file fails the check.', + 'type' => 'string', 'required' => true, 'docRequired' => true, - 'example' => '1', + 'enum' => ['OK', 'FAIL', 'WARN'], + 'example' => 'OK', + 'title' => '', ], ], + [ + 'name' => 'CheckDetailUrl', + 'in' => 'formData', + 'schema' => ['description' => 'This parameter is deprecated.', 'type' => 'string', 'required' => false, 'example' => 'https://result.aliyun.com/?checkerInstanceId=', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'Indicates whether the data source is updated.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0bc14115159376359****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => 'The request ID. You can use the ID to troubleshoot issues.', 'type' => 'string', 'example' => '86d5a5ac-0cc0-4c5f-a374-a15713b252ab', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Invalid.Tenant.ConnectionNotExists', - 'errorMessage' => 'The connection does not exist.', - ], - [ - 'errorCode' => 'Invalid.Tenant.ProjectNotExists', - 'errorMessage' => 'The project does not exist.', - ], - [ - 'errorCode' => 'Invalid.Tenant.UserNotInProject', - 'errorMessage' => 'The user is not in the project.', - ], - [ - 'errorCode' => 'MissingParam.ConnectionStr.Property', - 'errorMessage' => 'You must specify property %s required by the data source connection string.', - ], - [ - 'errorCode' => 'DataSource.CheckRamRoleFailure', - 'errorMessage' => 'Failed to check the RAM role. AccountId %s. roleArn %s.', - ], - [ - 'errorCode' => 'DataSource.ConnectionStrProperty.PatternNotMatch', - 'errorMessage' => 'The pattern value %s is invalid. The correct pattern is %s.', - ], - [ - 'errorCode' => 'DataSource.NotFound', - 'errorMessage' => 'The specified data source ID %s does not exist.', - ], - [ - 'errorCode' => 'Invalid.Connection.Empty', - 'errorMessage' => 'You must specify the connection parameter.', - ], - [ - 'errorCode' => 'Invalid.DataSource.DataSourceTypeNotExist', - 'errorMessage' => 'The data source type %s does not exist.', - ], - [ - 'errorCode' => 'Invalid.DataSource.DataSourceTypeNotSupport', - 'errorMessage' => 'The dataSourceType %s and subType %s are not supported.', - ], - [ - 'errorCode' => 'Invalid.Operation', - 'errorMessage' => 'You cannot delete the bindingCalcEngine that is bound to the data source.', - ], - [ - 'errorCode' => 'Invalid.Param.Odps.EngineIdOrConnectStrEmpty', - 'errorMessage' => 'Either the compute engine ID or the connection string must be specified when data source type is ODPS.', - ], - [ - 'errorCode' => 'Required.Parameter.Empty', - 'errorMessage' => 'You must specify the parameter %s.', - ], - ], 403 => [ - [ - 'errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin', - 'errorMessage' => 'The user is not a project administrator or owner.', - ], - [ - 'errorCode' => 'Invalid.Tenant.UserNotInTenant', - 'errorMessage' => 'The user is not in tenant.', - ], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": true,\\n \\"RequestId\\": \\"0bc14115159376359****\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n true\\n 0bc14115159376359****\\n true\\n","errorExample":""}]', - 'title' => 'UpdateDataSource', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"86d5a5ac-0cc0-4c5f-a374-a15713b252ab\\"\\n}","type":"json"}]', + 'title' => 'CheckFileDeployment', + 'summary' => 'Returns the check events for a file that is pending deployment in DataStudio. After a file is committed, DataWorks checks the file and generates events before deployment. Use the returned events to determine whether the file can proceed with deployment validation.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteDataSource' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'CheckMetaPartition' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '78172', + 'abilityTreeNodes' => ['FEATUREdideYZD64M'], + ], 'parameters' => [ [ - 'name' => 'DataSourceId', + 'name' => 'TableGuid', 'in' => 'query', - 'schema' => [ - 'description' => 'The data source ID. You can call the [ListDataSources](~~211431~~) operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The GUID of the MaxCompute metatable.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'odps.engine_name.table_name', 'title' => ''], + ], + [ + 'name' => 'Partition', + 'in' => 'query', + 'schema' => ['description' => 'The name of the partition in the MaxCompute metatable.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ds=202005', 'title' => ''], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is deprecated.'."\n", 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''], + ], + [ + 'name' => 'DatabaseName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the metadatabase.'."\n", 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the metatable.'."\n", 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''], + ], + [ + 'name' => 'DataSourceType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the data source. Set the value to odps.'."\n", 'type' => 'string', 'required' => false, 'example' => 'odps', 'title' => ''], ], ], 'responses' => [ @@ -2275,76 +1071,63 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'Indicates whether the data source was removed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0bc1411515937635****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the partition in the MaxCompute metatable exists. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0bc1ec92159376', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The connection does not exist.', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Invalid.Tenant.ConnectionNotExists', - 'errorMessage' => 'The connection does not exist.', - ], - [ - 'errorCode' => 'Invalid.Tenant.ProjectNotExists', - 'errorMessage' => 'The project does not exist.', - ], - [ - 'errorCode' => 'Invalid.Tenant.UserNotInProject', - 'errorMessage' => 'The user is not in the project.', - ], - [ - 'errorCode' => 'Invalid.Operation', - 'errorMessage' => 'You cannot delete the bindingCalcEngine that is bound to the data source.', - ], + ['errorCode' => 'Invalid.Meta.TableNotExist', 'errorMessage' => 'The table does not exist.', 'description' => 'The table does not exist.'], + ['errorCode' => 'InvalidParameter.Meta.CommonError', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The request parameter is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.Illegal', 'errorMessage' => 'The app guid parameter is invalid.', 'description' => 'The app guid parameter is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.NotExist', 'errorMessage' => 'The object does not exist.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.Meta.NoCalcEngine', 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.', 'description' => 'Incorrect project entered by user'], ], 403 => [ - [ - 'errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin', - 'errorMessage' => 'The user is not a project administrator or owner.', - ], - [ - 'errorCode' => 'Invalid.Tenant.UserNotInTenant', - 'errorMessage' => 'The user is not in tenant.', - ], + ['errorCode' => 'Forbidden.Meta.NoTenant', 'errorMessage' => 'The user is not the owner of any tenants.', 'description' => 'The user is not the owner of any tenants.'], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.Meta.TenantTimeOut', 'errorMessage' => 'Failed to connect to the interface network.', 'description' => 'Failed to connect to the interface network.'], + ['errorCode' => 'InternalError.Meta.Unknown', 'errorMessage' => 'An unknown error occurred while processing your request.', 'description' => 'An unknown error occurred while processing your request.'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": true,\\n \\"RequestId\\": \\"0bc1411515937635****\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"0bc1411515937635****\\n200\\ntrue\\ntrue","errorExample":""}]', - 'title' => 'DeleteDataSource', - 'summary' => 'Removes a data source.', + 'title' => 'CheckMetaPartition', + 'summary' => 'Checks whether a partition in a MaxCompute metatable exists.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListResourceGroups' => [ - 'summary' => 'Queries a list of resource groups of a specific type.', - 'methods' => [ - 'post', + 'extraInfo' => 'CheckMetaPartition接口的使用示例Demo请参见[DataWorks OpenAPI示例](https://developer.aliyun.com/article/780879?groupCode=dataworks)。', + 'changeSet' => [ + ['createdAt' => '2022-03-09T07:44:59.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'CheckMetaTable' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2354,635 +1137,201 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', + 'abilityTreeCode' => '78173', + 'abilityTreeNodes' => ['FEATUREdideYZD64M'], ], 'parameters' => [ [ - 'name' => 'ResourceGroupType', + 'name' => 'TableGuid', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the resource group that you want to query. Valid values:'."\n" - ."\n" - .'* 0: DataWorks'."\n" - .'* 1: scheduling'."\n" - .'* 2: MaxCompute'."\n" - .'* 3: Platform for AI (PAI)'."\n" - .'* 4: Data Integration'."\n" - .'* 7: exclusive resource group for scheduling (An ID is generated for the purchased resource when you purchase an exclusive resource group for scheduling.)'."\n" - .'* 9: DataService Studio'."\n" - .'* Default value: 1'."\n" - ."\n" - .'If the value indicates a compute engine, the resource groups to query are the ones that were created when you purchased the compute engine.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'example' => '3', - ], + 'schema' => ['description' => 'The GUID of the metatable.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'odps.engine_name.table_name', 'title' => ''], ], [ - 'name' => 'Keyword', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The keyword that is used for fuzzy match by resource group name and identifier.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], + 'schema' => ['description' => 'The E-MapReduce (EMR) cluster ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''], ], [ - 'name' => 'BizExtKey', + 'name' => 'DatabaseName', 'in' => 'query', - 'schema' => [ - 'description' => 'The category of the resource group. Valid values:'."\n" - ."\n" - .'* default (default): shared resource group'."\n" - .'* single: exclusive resource group'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], + 'schema' => ['description' => 'The name of the metadatabase of the EMR cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''], ], [ - 'name' => 'ResourceManagerResourceGroupId', + 'name' => 'TableName', 'in' => 'query', - 'schema' => [ - 'description' => 'The resource group ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfmzbn7pti3zfa', - ], + 'schema' => ['description' => 'The name of the EMR metatable.'."\n", 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''], ], [ - 'name' => 'Tags', + 'name' => 'DataSourceType', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The tags.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Env', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Test', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 20, - ], + 'schema' => ['description' => 'The type of the data source. Valid values: odps and emr.'."\n", 'type' => 'string', 'required' => false, 'example' => 'emr', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'description' => 'The returned results.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0bc1411515937635973****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The resource groups.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status of the resource group. Valid values:'."\n" - ."\n" - .'* 0: NORMAL, which indicates that the resource group is running or in service.'."\n" - .'* 1: STOP, which indicates that the resource group has expired and is frozen.'."\n" - .'* 2: DELETED, which indicates that the resource group is released or destroyed.'."\n" - .'* 3: CREATING, which indicates that the resource group is being created or started.'."\n" - .'* 4: CREATE_FAILED, which indicates that the resource group fails to be created or started.'."\n" - .'* 5: UPDATING, which indicates that the resource group is being scaled out or upgraded.'."\n" - .'* 6: UPDATE_FAILED, which indicates that the resource group fails to be scaled out or upgraded.'."\n" - .'* 7: DELETING, which indicates that the resource group is being released or destroyed.'."\n" - .'* 8: DELETE_FAILED, which indicates that the resource group fails to be released or destroyed.'."\n" - .'* 9: TIMEOUT, which indicates that the operation performed on the resource group times out. All operations may time out. This value is temporarily available only for DataService Studio.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'UpdateTime' => [ - 'description' => 'The time when the resource group was last updated.'."\n", - 'type' => 'string', - 'example' => 'Jul 9, 2018 2:43:37 PM', - ], - 'IsDefault' => [ - 'description' => 'Indicates whether the resource group is the default resource group. Valid values:'."\n" - ."\n" - .'* true: The resource group is the default resource group.'."\n" - .'* false: The resource group is not the default resource group.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Cluster' => [ - 'description' => 'The name of the cluster. This parameter is returned only if the type of the resource group is MaxCompute or PAI.'."\n", - 'type' => 'string', - 'example' => 'AY18G', - ], - 'EnableKp' => [ - 'description' => 'Indicates whether the UID of an Alibaba Cloud account is used for access. Valid values:'."\n" - ."\n" - .'* true: The MaxCompute compute engine uses the UID of the Alibaba Cloud account as the display name of the account for access.'."\n" - .'* false: The MaxCompute compute engine uses the name of the Alibaba Cloud account as the display name of the account for access. The remaining values are useless. This parameter is returned only if the type of the resource group is MaxCompute.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'ResourceGroupType' => [ - 'description' => 'The type of the resource group. Valid values:'."\n" - ."\n" - .'* 0: DataWorks'."\n" - .'* 2: MaxCompute'."\n" - .'* 3: PAI'."\n" - .'* 4: Data Integration'."\n" - .'* 7: scheduling'."\n" - .'* 9: DataService Studio'."\n", - 'type' => 'string', - 'example' => '3', - ], - 'CreateTime' => [ - 'description' => 'The time when the cluster was created. Example: Jul 9, 2018 2:43:37 PM.'."\n", - 'type' => 'string', - 'example' => 'Jul 9, 2018 2:43:37 PM', - ], - 'Identifier' => [ - 'description' => 'The identifier of the resource group.'."\n", - 'type' => 'string', - 'example' => 'e1815577-2f4e-4c5e-b29****', - ], - 'Mode' => [ - 'description' => 'The mode of the resource group. Valid values:'."\n" - ."\n" - .'* ISOLATE: exclusive resource group that adopts the subscription billing method'."\n" - .'* SHARE: shared resource group that adopts the pay-as-you-go billing method'."\n" - .'* DEVELOP: resource group for developers'."\n", - 'type' => 'string', - 'example' => 'SHARE', - ], - 'BizExtKey' => [ - 'description' => 'The category of the resource group. Valid values:'."\n" - ."\n" - .'* default: shared resource group'."\n" - .'* single: exclusive resource group'."\n", - 'type' => 'string', - 'example' => 'default', - ], - 'Sequence' => [ - 'description' => 'The sequence number of the resource group. Created resource groups are sorted in ascending order by sequence number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '300', - ], - 'Specs' => [ - 'description' => 'The details of the resource group. The content enclosed in braces {} is the details of the resource group.'."\n", - 'type' => 'object', - 'example' => '{}', - ], - 'Name' => [ - 'description' => 'The name of the resource group.'."\n", - 'type' => 'string', - 'example' => 'abc', - ], - 'Id' => [ - 'description' => 'The resource group ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234567', - ], - 'TenantId' => [ - 'description' => 'The tenant ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234567', - ], - 'ResourceManagerResourceGroupId' => [ - 'description' => 'The ID of your Alibaba Cloud resource group.'."\n", - 'type' => 'string', - 'example' => 'rg-acfmzbn7pti3zfa', - ], - 'Tags' => [ - 'description' => 'The tags.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'Env', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => 'Test', - ], - ], - ], - ], - ], - ], - ], + 'Data' => ['description' => 'Indicates whether the metatable exists.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0bc1ec92159376', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Invalid.Tenant.ConnectionNotExists', - 'errorMessage' => 'The connection does not exist.', - ], - [ - 'errorCode' => 'Invalid.Tenant.ProjectNotExists', - 'errorMessage' => 'The project does not exist.', - ], - [ - 'errorCode' => 'Invalid.Tenant.UserNotInProject', - 'errorMessage' => 'The user is not in the project.', - ], + ['errorCode' => 'Invalid.Meta.TableNotExist', 'errorMessage' => 'The table does not exist.', 'description' => 'The table does not exist.'], + ['errorCode' => 'InvalidParameter.Meta.Illegal', 'errorMessage' => 'The app guid parameter is invalid.', 'description' => 'The app guid parameter is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.NotExist', 'errorMessage' => 'The object does not exist.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.Meta.NoCalcEngine', 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.', 'description' => 'Incorrect project entered by user'], ], 403 => [ - [ - 'errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin', - 'errorMessage' => 'The user is not a project administrator or owner.', - ], - [ - 'errorCode' => 'Invalid.Tenant.UserNotInTenant', - 'errorMessage' => 'The user is not in tenant.', - ], + ['errorCode' => 'Forbidden.Meta.NoTenant', 'errorMessage' => 'The user is not the owner of any tenants.', 'description' => 'The user is not the owner of any tenants.'], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.Meta.TenantTimeOut', 'errorMessage' => 'Failed to connect to the interface network.', 'description' => 'Failed to connect to the interface network.'], + ['errorCode' => 'InternalError.Meta.Unknown', 'errorMessage' => 'An unknown error occurred while processing your request.', 'description' => 'An unknown error occurred while processing your request.'], ], ], - 'staticInfo' => [], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0bc1411515937635973****\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Status\\": 0,\\n \\"UpdateTime\\": \\"Jul 9, 2018 2:43:37 PM\\",\\n \\"IsDefault\\": true,\\n \\"Cluster\\": \\"AY18G\\",\\n \\"EnableKp\\": false,\\n \\"ResourceGroupType\\": \\"3\\",\\n \\"CreateTime\\": \\"Jul 9, 2018 2:43:37 PM\\",\\n \\"Identifier\\": \\"e1815577-2f4e-4c5e-b29****\\",\\n \\"Mode\\": \\"SHARE\\",\\n \\"BizExtKey\\": \\"default\\",\\n \\"Sequence\\": 300,\\n \\"Specs\\": {},\\n \\"Name\\": \\"abc\\",\\n \\"Id\\": 1234567,\\n \\"TenantId\\": 1234567,\\n \\"ResourceManagerResourceGroupId\\": \\"rg-acfmzbn7pti3zfa\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"Env\\",\\n \\"Value\\": \\"Test\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 0bc1411515937635973****\\n true\\n \\n 0\\n Jul 9, 2018 2:43:37 PM\\n true\\n AY18G\\n false\\n 3\\n Jul 9, 2018 2:43:37 PM\\n e1815577-2f4e-4c5e-b29****\\n SHARE\\n default\\n 300\\n abc\\n 1234567\\n 1234567\\n rg-acfmzbn7pti3zfa\\n \\n Env\\n Test\\n \\n \\n","errorExample":""}]', - 'title' => 'ListResourceGroups', + 'title' => 'CheckMetaTable', + 'summary' => 'Checks whether a metatable exists.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'GetProject' => [ - 'summary' => 'Queries the information about a DataWorks workspace.', - 'methods' => [ - 'post', + 'extraInfo' => ' CheckMetaTable接口的使用示例Demo请参见[DataWorks OpenAPI示例](https://developer.aliyun.com/article/780879?groupCode=dataworks)。', + 'changeSet' => [ + ['createdAt' => '2022-03-09T07:44:59.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"0bc1ec92159376\\"\\n}","type":"json"}]', + ], + 'CreateBaseline' => [ + 'summary' => 'Creates a baseline.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', + 'operationType' => 'create', + 'abilityTreeCode' => '158238', + 'abilityTreeNodes' => ['FEATUREdideSFSFU4'], ], 'parameters' => [ + [ + 'name' => 'BaselineName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the baseline.'."\n", 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'BaselineName'], + ], [ 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the DataWorks workspace. You can call the [ListProjects](~~2780068~~) operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'example' => '27', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '10000'], ], [ - 'name' => 'ProjectIdentifier', - 'in' => 'query', + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the Alibaba Cloud account used by the baseline owner.'."\n", 'type' => 'string', 'required' => true, 'title' => '', 'example' => '1000000000001'], + ], + [ + 'name' => 'Priority', + 'in' => 'formData', + 'schema' => ['description' => 'The priority of the baseline. Valid values: {1,3,5,7,8}.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'title' => '', 'example' => '1,3,5,7,8'], + ], + [ + 'name' => 'NodeIds', + 'in' => 'formData', + 'schema' => ['description' => 'The ancestor nodes of nodes in the baseline.'."\n", 'type' => 'string', 'required' => false, 'example' => '210001233239,210001236482', 'title' => ''], + ], + [ + 'name' => 'OvertimeSettings', + 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The name of the DataWorks workspace. You can call the [ListProjects](~~2780068~~) operation to query the name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_project', + 'title' => '', + 'description' => 'The settings of the committed completion time of the baseline.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The cycle.'."\n", + 'type' => 'object', + 'properties' => [ + 'Cycle' => ['description' => 'The cycle that corresponds to the committed completion time. For a day-level baseline, set this parameter to 1. For an hour-level baseline, set this parameter to a value that is no more than 24.'."\n", 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1'], + 'Time' => ['description' => 'The committed completion time in the hh:mm format. Valid values of hh: \\[0,47]. Valid values of mm: \\[0,59].'."\n", 'type' => 'string', 'title' => '', 'required' => false, 'example' => '00:00'], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'maxItems' => 144, + 'minItems' => 1, + 'example' => '', ], ], + [ + 'name' => 'AlertMarginThreshold', + 'in' => 'formData', + 'schema' => ['description' => 'The alert margin threshold of the baseline. Unit: minutes.'."\n", 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '30'], + ], + [ + 'name' => 'BaselineType', + 'in' => 'formData', + 'schema' => ['description' => 'The type of the baseline. Valid values: DAILY and HOURLY.'."\n", 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'DAILY'], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The returned result.'."\n", + 'title' => 'OpenApiResultModel', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0bc1411515937635973****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The information about the workspace.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status of the workspace. Valid values:'."\n" - ."\n" - .'* **0**: AVAILABLE, which indicates that the workspace runs as expected.'."\n" - .'* **1**: DELETED, which indicates that the workspace is deleted.'."\n" - .'* **2**: INITIALIZING, which indicates that the workspace is being initialized.'."\n" - .'* **3**: INIT_FAILED, which indicates that the workspace fails to be initialized.'."\n" - .'* **4**: FORBIDDEN, which indicates that the workspace is manually disabled.'."\n" - .'* **5**: DELETING, which indicates that the workspace is being deleted.'."\n" - .'* **6**: DEL_FAILED, which indicates that the workspace fails to be deleted.'."\n" - .'* **7**: FROZEN, which indicates that the workspace is frozen due to overdue payments.'."\n" - .'* **8**: UPDATING, which indicates that the workspace is being updated. The workspace enters this state after you associate a new compute engine with the workspace and the compute engine is initialized.'."\n" - .'* **9**: UPDATE_FAILED, which indicates that the workspace fails to be updated.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'MaxFlowNode' => [ - 'description' => 'This parameter is deprecated.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ProjectId' => [ - 'description' => 'The ID of the workspace.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '27', - ], - 'IsAllowDownload' => [ - 'description' => 'Indicates whether you are allowed to download the query result from DataStudio. Valid values:'."\n" - ."\n" - .'* **1**: You are allowed to download the query result from DataStudio.'."\n" - .'* **0**: You are not allowed to download the query result from DataStudio.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ProjectMode' => [ - 'description' => 'The mode of the workspace. Valid values:'."\n" - ."\n" - .'* **2**: The workspace is in basic mode.'."\n" - .'* **3**: The workspace is in standard mode.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'GmtModified' => [ - 'description' => 'The time when the workspace was last modified. Example: `Dec 3, 2019 9:12:20 PM`.'."\n", - 'type' => 'string', - 'example' => 'Dec 3, 2019 9:12:20 PM', - ], - 'ProdStorageQuota' => [ - 'description' => 'This parameter is deprecated.'."\n", - 'type' => 'string', - 'example' => ' 1', - ], - 'ProjectDescription' => [ - 'description' => 'The description of the workspace.'."\n", - 'type' => 'string', - 'example' => 'abc', - ], - 'DevelopmentType' => [ - 'description' => 'This parameter is deprecated.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'TablePrivacyMode' => [ - 'description' => 'Indicates whether the MaxCompute tables in the workspace are visible to the users within a tenant. Valid values:'."\n" - ."\n" - .'* **0**: invisible'."\n" - .'* **1**: visible'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'DefaultDiResourceGroupIdentifier' => [ - 'description' => 'The ID of the resource group that was allocated by default when you purchased an exclusive resource group for MaxCompute.'."\n", - 'type' => 'string', - 'example' => 'group_280749521****', - ], - 'SchedulerMaxRetryTimes' => [ - 'description' => 'The default maximum number of automatic reruns that are allowed after an error occurs.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'ProtectedMode' => [ - 'description' => 'Indicates whether the workspace protection feature is enabled. Valid values:'."\n" - ."\n" - .'* **1**: enabled'."\n" - .'* **0**: disabled'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'SchedulerRetryInterval' => [ - 'description' => 'The default interval between automatic reruns after an error occurs. Unit: milliseconds. The maximum interval is 30 minutes. You must pay attention to the conversion between units.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '120000', - ], - 'Appkey' => [ - 'description' => 'This parameter is deprecated.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'DevStorageQuota' => [ - 'description' => 'This parameter is deprecated.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'ResidentArea' => [ - 'description' => 'The type of the workspace. Valid values:'."\n" - ."\n" - .'* **private**'."\n" - .'* **swap**'."\n", - 'type' => 'string', - 'example' => 'private', - ], - 'IsDefault' => [ - 'description' => 'Indicates whether the workspace is a default workspace. Valid values:'."\n" - ."\n" - .'* **1**: The workspace is a default workspace.'."\n" - .'* **0**: The workspace is not a default workspace.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Destination' => [ - 'description' => 'This parameter is deprecated.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ProjectName' => [ - 'description' => 'The display name of the workspace.'."\n", - 'type' => 'string', - 'example' => 'abc', - ], - 'ProjectIdentifier' => [ - 'description' => 'The name of the workspace.'."\n", - 'type' => 'string', - 'example' => 'abc', - ], - 'DisableDevelopment' => [ - 'description' => 'Indicates whether the Develop role is disabled. Valid values:'."\n" - ."\n" - .'* **false** (default)'."\n" - .'* **true**'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ProjectOwnerBaseId' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the workspace owner.'."\n", - 'type' => 'string', - 'example' => '18229311****', - ], - 'BaseProject' => [ - 'description' => 'This parameter is deprecated.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'UseProxyOdpsAccount' => [ - 'description' => 'Indicates whether a proxy account is used to access the MaxCompute compute engine associated with the workspace.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'GmtCreate' => [ - 'description' => 'The time when the workspace was created. Example: `Dec 3, 2019 9:12:20 PM`.'."\n", - 'type' => 'string', - 'example' => 'Oct 10, 2019 3:42:53 PM', - ], - 'TenantId' => [ - 'description' => 'The tenant ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '280749521', - ], - 'EnvTypes' => [ - 'description' => 'The environment information of the workspace.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The environment of the workspace. Valid values: PROD and DEV.'."\n" - ."\n" - .'* The value **PROD** indicates the production environment. Workspaces in basic mode provide only the production environment.'."\n" - .'* The value **DEV** indicates the development environment. Workspaces in standard mode provide both the development environment and the production environment.'."\n", - 'type' => 'string', - 'example' => '["PROD"]', - ], - ], - 'ResourceManagerResourceGroupId' => [ - 'description' => 'The resource group ID.'."\n", - 'type' => 'string', - 'example' => 'rg-acfmzbn7pti3zfa', - ], - 'Tags' => [ - 'description' => 'The tags added to the workspace.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'Env', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => 'Test', - ], - ], - ], - ], - ], - ], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '401', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The specified parameters are invalid.', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The baseline ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100003', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F05080B0-CCE6-5D22-B284-34A51C5D4E28', 'title' => ''], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Invalid.Tenant.ProjectNotExists', - 'errorMessage' => 'The project does not exist.', - ], - [ - 'errorCode' => 'Invalid.Tenant.UserNotInProject', - 'errorMessage' => 'The user is not in the project.', - ], - ], - 403 => [ - [ - 'errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin', - 'errorMessage' => 'The user is not a project administrator or owner.', - ], - [ - 'errorCode' => 'Invalid.Tenant.UserNotInTenant', - 'errorMessage' => 'The user is not in tenant.', - ], - ], + 'title' => 'CreateBaseline', + 'changeSet' => [ + ['createdAt' => '2023-01-05T02:14:03.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-11-16T09:08:31.000Z', 'description' => 'OpenAPI offline'], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"1AFAE64E-D1BE-432B-A9****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Status\\": 0,\\n \\"MaxFlowNode\\": 1,\\n \\"ProjectId\\": 466230,\\n \\"IsAllowDownload\\": 1,\\n \\"ProjectMode\\": 2,\\n \\"GmtModified\\": \\"Dec 3, 2019 9:12:20 PM\\",\\n \\"ProdStorageQuota\\": \\" 1\\",\\n \\"ProjectDescription\\": \\"test_describe\\",\\n \\"DevelopmentType\\": 4,\\n \\"TablePrivacyMode\\": 1,\\n \\"DefaultDiResourceGroupIdentifier\\": \\"group_280749521****\\",\\n \\"SchedulerMaxRetryTimes\\": 3,\\n \\"ProtectedMode\\": 1,\\n \\"SchedulerRetryInterval\\": 120000,\\n \\"Appkey\\": \\"0\\",\\n \\"DevStorageQuota\\": \\"0\\",\\n \\"ResidentArea\\": \\"private\\",\\n \\"IsDefault\\": 1,\\n \\"Destination\\": 0,\\n \\"ProjectName\\": \\"test_project\\",\\n \\"ProjectIdentifier\\": \\"test_project\\",\\n \\"DisableDevelopment\\": true,\\n \\"ProjectOwnerBaseId\\": \\"18229311****\\",\\n \\"BaseProject\\": false,\\n \\"UseProxyOdpsAccount\\": true,\\n \\"GmtCreate\\": \\"Oct 10, 2019 3:42:53 PM\\",\\n \\"TenantId\\": 280749521,\\n \\"EnvTypes\\": [\\n \\"[\\\\\\"PROD\\\\\\"]\\"\\n ],\\n \\"ResourceManagerResourceGroupId\\": \\"rg-acfmzbn7****\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"key\\",\\n \\"Value\\": \\"value\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 0bc1411515937635973****\\n true\\n \\n 0\\n 1\\n 27\\n 1\\n 2\\n Dec 3, 2019 9:12:20 PM\\n 1\\n abc\\n 4\\n 1\\n group_280749521****\\n 3\\n 1\\n 120000\\n 0\\n 0\\n private\\n 1\\n 0\\n abc\\n abc\\n true\\n 18229311****\\n false\\n true\\n Oct 10, 2019 3:42:53 PM\\n 280749521\\n [\\"PROD\\"]\\n rg-acfmzbn7pti3zfa\\n \\n Env\\n Test\\n \\n \\n","errorExample":""}]', - 'title' => 'GetProject', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"401\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 100003,\\n \\"RequestId\\": \\"F05080B0-CCE6-5D22-B284-34A51C5D4E28\\"\\n}","type":"json"}]', ], - 'AddProjectMemberToRole' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateBusiness' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2992,234 +1341,409 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', + 'abilityTreeCode' => '78175', + 'abilityTreeNodes' => ['FEATUREdide8FM783'], ], 'parameters' => [ [ 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The DataWorks workspace ID. You can call the [ListProjects](~~2780068~~) operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '10000000', - 'minimum' => '0', - 'example' => '27', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10000', 'title' => ''], ], [ - 'name' => 'UserId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The Alibaba Cloud account ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and move the pointer over the profile picture in the upper-right corner to view the ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1234', - ], + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace Management page to obtain the workspace name. You must configure either this parameter or ProjectId parameter to determine the DataWorks workspace to which the operation is applied.', 'type' => 'string', 'required' => false, 'example' => 'dw_project', 'title' => ''], ], [ - 'name' => 'RoleCode', - 'in' => 'query', - 'schema' => [ - 'description' => 'The code of the role that you want to assign to a member of the DataWorks workspace. You can call the [ListProjectRoles](~~2780079~~) operation to query the codes of all roles in a DataWorks workspace.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'role_project_guest', - ], + 'name' => 'BusinessName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the business process. The name of the business process in the same project must be unique.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'My business process', 'title' => ''], ], [ - 'name' => 'ClientToken', - 'in' => 'query', + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['description' => 'The description of the business process.', 'type' => 'string', 'required' => false, 'example' => 'This is a business process created through an interface.', 'title' => ''], + ], + [ + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => ['description' => 'The Alibaba Cloud account ID of the owner of the business process. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and hover over the user avatar on the right side of the top menu bar to view the account ID. If this parameter is empty, the caller\'s Alibaba Cloud account ID is used by default.', 'type' => 'string', 'required' => false, 'example' => '1000000000001', 'title' => ''], + ], + [ + 'name' => 'UseType', + 'in' => 'formData', 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request. We recommend that you set this parameter to a UUID. This parameter is used to uniquely identify the API operation call.'."\n", + 'description' => 'The module to which the workflow belongs. Valid values:'."\n" + ."\n" + .'* NORMAL: The workflow belongs to auto triggered workflows.'."\n" + .'* MANUAL_BIZ: The workflow belongs to manually triggered workflows.'."\n", + 'enumValueTitles' => [], 'type' => 'string', 'required' => false, - 'example' => '1AFAE64E-D1BE-432B-A9*****', + 'docRequired' => false, + 'default' => 'NORMAL', + 'enum' => ['NORMAL', 'MANUAL_BIZ'], + 'example' => 'NORMAL', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AFAE64E-D1BE-432B-A9****', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0000-ABCD-EFG****', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The connection does not exist.', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], + 'BusinessId' => ['description' => 'The workflow ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100001', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Invalid.Tenant.ConnectionNotExists', - 'errorMessage' => 'The connection does not exist.', - ], - [ - 'errorCode' => 'Invalid.Tenant.ProjectNotExists', - 'errorMessage' => 'The project does not exist.', - ], - [ - 'errorCode' => 'Invalid.Tenant.UserNotInProject', - 'errorMessage' => 'The user is not in the project.', - ], - ], 403 => [ - [ - 'errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin', - 'errorMessage' => 'The user is not a project administrator or owner.', - ], - [ - 'errorCode' => 'Invalid.Tenant.UserNotInTenant', - 'errorMessage' => 'The user is not in tenant.', - ], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AFAE64E-D1BE-432B-A9****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1AFAE64E-D1BE-432B-A9****\\n","errorExample":""}]', - 'title' => 'AddProjectMemberToRole', - 'summary' => 'Assigns a role to a member of a DataWorks workspace. Before you call this operation, you must add your account to a DataWorks workspace as a member.', - 'description' => '* For information about how to add an account to a DataWorks workspace as a member, see [Add workspace members and assign roles to them](~~136941~~).'."\n" - .'* If you assign a built-in workspace-level role to a member of a DataWorks workspace, the member is automatically granted the permissions of the mapped role of the MaxCompute compute engine in the development environment. For more information, see [Appendix: Mappings between the built-in workspace-level roles of DataWorks and the roles of MaxCompute](~~449397~~).'."\n", + 'title' => 'CreateBusiness', + 'summary' => 'Creates a workflow in DataStudio.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateProjectMember' => [ - 'methods' => [ - 'post', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"BusinessId\\": 100001\\n}","type":"json"}]', + ], + 'CreateConnection' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'deprecated' => false, + 'deprecated' => true, 'systemTags' => [ 'operationType' => 'create', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdide7FTVFZ'], ], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '100000000', - 'minimum' => '0', - 'example' => '27', - ], + 'schema' => ['description' => 'The ID of the workspace with which the data source is associated. You can call the [ListProjects](~~178393~~) operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1'], ], [ - 'name' => 'UserId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the user to be added.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1234', - ], + 'schema' => ['description' => 'The name of the data source.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'abc'], ], [ - 'name' => 'ClientToken', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request. We recommend that you set this parameter to a UUID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1AFAE64E-D1BE-432B-A9****', - ], + 'schema' => ['description' => 'The description of the connection string.'."\n", 'type' => 'string', 'required' => false, 'example' => 'abc'], ], [ - 'name' => 'RoleCode', + 'name' => 'ConnectionType', 'in' => 'query', - 'schema' => [ - 'description' => 'The code of the role. This parameter is optional. If you configure the RoleCode parameter, the user is assigned the role.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'role_project_guest', - ], + 'schema' => ['description' => 'The type of the connection string. Valid values:'."\n" + ."\n" + .'* odps'."\n" + .'* mysql'."\n" + .'* rds'."\n" + .'* oss'."\n" + .'* sqlserver'."\n" + .'* polardb'."\n" + .'* oracle'."\n" + .'* mongodb'."\n" + .'* emr'."\n" + .'* postgresql'."\n" + .'* analyticdb_for_mysql'."\n" + .'* hybriddb_for_postgresql'."\n" + .'* holo'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rds'], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AFAE64E-D1BE-432B-A9****', - ], + [ + 'name' => 'SubType', + 'in' => 'query', + 'schema' => ['description' => 'The subtype of the connection string. This parameter is used for scenarios where a type includes subtypes. The following type and subtypes are supported:'."\n" + ."\n" + .'* Type: `rds`'."\n" + .'* Subtypes: `mysql`, `sqlserver`, and `postgresql`.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mysql'], + ], + [ + 'name' => 'EnvType', + 'in' => 'query', + 'schema' => ['description' => 'The environment in which the data source is used. Valid values: 0 and 1. The value 0 indicates the development environment. The value 1 indicates the production environment.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], + ], + [ + 'name' => 'Content', + 'in' => 'query', + 'schema' => ['description' => 'The details of the data source. Examples of details of some common data sources:'."\n" + ."\n" + .'* odps'."\n" + ."\n" + .''."\n" + ."\n" + .' {'."\n" + .' "accessId": "xssssss",'."\n" + .' "accessKey": "xsaxsaxsa",'."\n" + .' "authType": 2,'."\n" + .' "endpoint": "http://service.odps.aliyun.com/api",'."\n" + .' "project": "xsaxsax",'."\n" + .' "tag": "public"'."\n" + .' }'."\n" + ."\n" + .'* mysql'."\n" + ."\n" + .''."\n" + ."\n" + .' {'."\n" + .' "database": "xsaxsa",'."\n" + .' "instanceName": "rm-xsaxsa",'."\n" + .' "password": "xsaxsa",'."\n" + .' "rdsOwnerId": "xasxsa",'."\n" + .' "regionId": "cn-shanghai",'."\n" + .' "tag": "rds",'."\n" + .' "username": "xsaxsa"'."\n" + .' }'."\n" + ."\n" + .'* rds'."\n" + ."\n" + .''."\n" + ."\n" + .' {'."\n" + .' "configType": 1,'."\n" + .' "tag": "rds",'."\n" + .' "database": "xsaxsa",'."\n" + .' "username": "xsaxsa",'."\n" + .' "password": "xssaxsa$32050",'."\n" + .' "instanceName": "rm-xsaxs",'."\n" + .' "rdsOwnerId": "11111111"'."\n" + .' }'."\n" + ."\n" + .'* oss'."\n" + ."\n" + .''."\n" + ."\n" + .' {'."\n" + .' "accessId": "sssssxx",'."\n" + .' "accessKey": "xsaxaxsaxs",'."\n" + .' "bucket": "xsa-xs-xs",'."\n" + .' "endpoint": "http://oss-cn-shanghai.aliyuncs.com",'."\n" + .' "tag": "public"'."\n" + .' }'."\n" + ."\n" + .'* sqlserver'."\n" + ."\n" + .''."\n" + ."\n" + .' {'."\n" + .' "jdbcUrl": "jdbc:sqlserver://xsaxsa-xsaxsa.database.xxx.cn:123;DatabaseName=xsxs-xsxs",'."\n" + .' "password": "sdasda$fs",'."\n" + .' "tag": "public",'."\n" + .' "username": "sxaxacdacdd"'."\n" + .' }'."\n" + ."\n" + .'* polardb'."\n" + ."\n" + .''."\n" + ."\n" + .' {'."\n" + .' "clusterId": "pc-sdadsadsa",'."\n" + .' "database": "dsadsadsa",'."\n" + .' "ownerId": "121212122",'."\n" + .' "password": "sdasdafssa",'."\n" + .' "region": "cn-shanghai",'."\n" + .' "tag": "polardb",'."\n" + .' "username": "asdadsads"'."\n" + .' }'."\n" + ."\n" + .'* oracle'."\n" + ."\n" + .''."\n" + ."\n" + .' {'."\n" + .' "jdbcUrl": "jdbc:oracle:saaa:@xxxxx:1521:PROD",'."\n" + .' "password": "sxasaxsa",'."\n" + .' "tag": "public",'."\n" + .' "username": "sasfadfa"'."\n" + .' }'."\n" + ."\n" + .'* mongodb'."\n" + ."\n" + .''."\n" + ."\n" + .' {'."\n" + .' "address": "[\\"xsaxxsa.mongodb.rds.aliyuncs.com:3717\\"]",'."\n" + .' "database": "admin",'."\n" + .' "password": "sadsda@",'."\n" + .' "tag": "public",'."\n" + .' "username": "dsadsadas"'."\n" + .' }'."\n" + ."\n" + .'* emr'."\n" + ."\n" + .''."\n" + ."\n" + .' {'."\n" + .' "accessId": "xsaxsa",'."\n" + .' "emrClusterId": "C-dsads",'."\n" + .' "emrResourceQueueName": "default",'."\n" + .' "emrEndpoint": "emr.aliyuncs.com",'."\n" + .' "accessKey": "dsadsad",'."\n" + .' "emrUserId": "224833315798889783",'."\n" + .' "name": "sasdsadsa",'."\n" + .' "emrAccessMode": "simple",'."\n" + .' "region": "cn-shanghai",'."\n" + .' "authType": "2",'."\n" + .' "emrProjectId": "FP-sdadsad"'."\n" + .' }'."\n" + ."\n" + .'* postgresql'."\n" + ."\n" + .''."\n" + ."\n" + .' {'."\n" + .' "jdbcUrl": "jdbc:postgresql://xxxx:1921/ssss",'."\n" + .' "password": "sdadsads",'."\n" + .' "tag": "public",'."\n" + .' "username": "sdsasda"'."\n" + .' }'."\n" + ."\n" + .'* analyticdb_for_mysql'."\n" + ."\n" + .''."\n" + ."\n" + .' {'."\n" + .' "instanceId": "am-sadsada",'."\n" + .' "database": "xsxsx",'."\n" + .' "username": "xsxsa",'."\n" + .' "password": "asdadsa",'."\n" + .' "connectionString": "am-xssxsxs.ads.aliyuncs.com:3306"'."\n" + .' }'."\n" + ."\n" + .'* hybriddb_for_postgresql'."\n" + ."\n" + .''."\n" + ."\n" + .' {'."\n" + .' "connectionString": "gp-xsaxsaxa-master.gpdbmaster.rds.aliyuncs.com",'."\n" + .' "database": "xsaxsaxas",'."\n" + .' "password": "xsaxsaxsa@11",'."\n" + .' "instanceId": "gp-xsaxsaxsa",'."\n" + .' "port": "541132",'."\n" + .' "ownerId": "xsaxsaxsas",'."\n" + .' "username": "sadsad"'."\n" + .' }'."\n" + ."\n" + .'* holo'."\n" + ."\n" + .''."\n" + ."\n" + .' {'."\n" + .' "accessId": "xsaxsaxs",'."\n" + .' "accessKey": "xsaxsaxsa",'."\n" + .' "database": "xsaxsaxsa",'."\n" + .' "instanceId": "xsaxa",'."\n" + .' "tag": "aliyun"'."\n" + .' }'."\n" + ."\n" + .'* kafka'."\n" + ."\n" + .''."\n" + ."\n" + .' {'."\n" + .' "instanceId": "xsax-cn-xsaxsa",'."\n" + .' "regionId": "cn-shanghai",'."\n" + .' "tag": "aliyun",'."\n" + .' "ownerId": "1212121212112"'."\n" + .' }'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"database":"dbname","instanceName":"instancename","password":"password","rdsOwnerId":"123","username":"username"}'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'string', 'example' => '200'], + 'Data' => ['description' => 'The data source ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0bc141151593763****'], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Invalid.Tenant.ConnectionNotExists', - 'errorMessage' => 'The connection does not exist.', - ], - [ - 'errorCode' => 'Invalid.Tenant.ProjectNotExists', - 'errorMessage' => 'The project does not exist.', - ], - [ - 'errorCode' => 'Invalid.Tenant.UserNotInProject', - 'errorMessage' => 'The user is not in the project.', - ], - [ - 'errorCode' => 'Invalid.Tenant.UserAlreadyInProject', - 'errorMessage' => 'The user already exists in the project.', - ], - [ - 'errorCode' => 'Invalid.Tenant.UserNotInTenant', - 'errorMessage' => 'The user is not in the tenant.', - ], + ['errorCode' => 'Invalid.Tenant.ConnectionNotExists', 'errorMessage' => 'The connection does not exist.', 'description' => 'The connection does not exist.'], + ['errorCode' => 'Invalid.Tenant.ProjectNotExists', 'errorMessage' => 'The project does not exist.', 'description' => 'The project does not exist.'], + ['errorCode' => 'Invalid.Tenant.UserNotInProject', 'errorMessage' => 'The user is not in the project.', 'description' => 'The user is not in the project.'], + ['errorCode' => 'ConnectionAlreadyExist', 'errorMessage' => 'The connection with envType %s and name %s already exists.', 'description' => 'ConnectionAlreadyExist'], + ['errorCode' => 'DataSource.CheckRamRoleFailure', 'errorMessage' => 'Failed to check the RAM role. AccountId %s. roleArn %s.', 'description' => ''], + ['errorCode' => 'DataSource.ConnectionStrProperty.PatternNotMatch', 'errorMessage' => 'The pattern value %s is invalid. The correct pattern is %s.', 'description' => ''], + ['errorCode' => 'Invalid.DataSource.DataSourceTypeNotSupport', 'errorMessage' => 'The dataSourceType %s and subType %s are not supported.', 'description' => 'DataSource type not support yet.'], + ['errorCode' => 'Invalid.Param.Odps.EngineIdOrConnectStrEmpty', 'errorMessage' => 'Either the compute engine ID or the connection string must be specified when data source type is ODPS.', 'description' => ''], + ['errorCode' => 'MissingParam.ConnectionStr.Property', 'errorMessage' => 'You must specify property %s required by the data source connection string.', 'description' => 'The data source connection str required property missing. '], + ['errorCode' => 'Invalid.DataSource.DataSourceTypeNotExist', 'errorMessage' => 'The data source type %s does not exist.', 'description' => 'The dataSource type %s are not exist.'], ], 403 => [ - [ - 'errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin', - 'errorMessage' => 'The user is not a project administrator or owner.', - ], - [ - 'errorCode' => 'Invalid.Tenant.UserNotInTenant', - 'errorMessage' => 'The user is not in tenant.', - ], + ['errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin', 'errorMessage' => 'The user is not a project administrator or owner.', 'description' => 'The user is not a project administrator or owner.'], + ['errorCode' => 'Invalid.Tenant.UserNotInTenant', 'errorMessage' => 'The user is not in tenant.', 'description' => 'The user is not in tenant.'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AFAE64E-D1BE-432B-A9****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1AFAE64E-D1BE-432B-A9****\\n","errorExample":""}]', - 'title' => 'CreateProjectMember', - 'summary' => 'Adds a user to a DataWorks workspace.', + 'staticInfo' => [ + 'substitutions' => ['dataworks-public::2020-05-18::CreateDataSource'], + ], + 'title' => 'CreateConnection', + 'summary' => 'Adds a data source.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteProjectMember' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'CreateDIAlarmRule' => [ + 'summary' => 'Creates an alert rule for a synchronization task.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3228,2311 +1752,1728 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '78212', - 'abilityTreeNodes' => [ - 'FEATUREdideZ4P4R1', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '154822', + 'abilityTreeNodes' => ['FEATUREdideTG7EYI'], ], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '100000000', - 'minimum' => '0', - 'example' => '27', - ], + 'name' => 'DIJobId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the task with which the alert rule is associated.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11265', 'title' => ''], ], [ - 'name' => 'UserId', - 'in' => 'query', + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['description' => 'The description of the task.', 'type' => 'string', 'required' => false, 'example' => 'mysql synchronizes to hologres heartbeat alert', 'title' => ''], + ], + [ + 'name' => 'MetricType', + 'in' => 'formData', 'schema' => [ - 'description' => 'The user ID.'."\n", + 'description' => 'The metric type in the alert rule. Valid values:'."\n" + ."\n" + .'- Heartbeat'."\n" + ."\n" + .'- FailoverCount'."\n" + ."\n" + .'- Delay', + 'enumValueTitles' => [], 'type' => 'string', 'required' => true, - 'docRequired' => true, - 'example' => '1234', + 'example' => 'Heartbeat', + 'title' => '', ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'TriggerConditions', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AFAE64E-D1BE-432B-A9****', + 'description' => 'The conditions that are used to trigger the alert rule.', + 'type' => 'array', + 'items' => [ + 'description' => 'The condition that is used to trigger the alert rule.', + 'type' => 'object', + 'properties' => [ + 'Severity' => [ + 'description' => 'The severity level. Valid values:'."\n" + ."\n" + .'- Warning'."\n" + ."\n" + .'- Critical', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'example' => 'Warning', + 'title' => '', + ], + 'Duration' => ['description' => 'The time interval for alert calculation. Unit: minutes.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '15', 'title' => ''], + 'Threshold' => ['description' => 'The alert threshold.'."\n" + ."\n" + .'- If the alert rule is for task status, you do not need to specify a threshold.'."\n" + ."\n" + .'- If the alert rule is for failovers, specify the number of failovers.'."\n" + ."\n" + .'- If the alert rule is for latency, the threshold is the latency duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Invalid.Tenant.ConnectionNotExists', - 'errorMessage' => 'The connection does not exist.', - ], - [ - 'errorCode' => 'Invalid.Tenant.ProjectNotExists', - 'errorMessage' => 'The project does not exist.', - ], - [ - 'errorCode' => 'Invalid.Tenant.UserAlreadyInProject', - 'errorMessage' => 'The user already exists in the project.', - ], - [ - 'errorCode' => 'Invalid.Tenant.UserNotInTenant', - 'errorMessage' => 'The user is not in the tenant.', - ], - ], - 403 => [ - [ - 'errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin', - 'errorMessage' => 'The user is not a project administrator or owner.', - ], - [ - 'errorCode' => 'Invalid.Tenant.UserNotInTenant', - 'errorMessage' => 'The user is not in tenant.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AFAE64E-D1BE-432B-A9****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1AFAE64E-D1BE-432B-A9****\\n","errorExample":""}]', - 'title' => 'DeleteProjectMember', - 'summary' => 'Removes a user from a DataWorks workspace.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListProjectRoles' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '78327', - 'abilityTreeNodes' => [ - 'FEATUREdideL60QLN', - ], - ], - 'parameters' => [ - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the DataWorks workspace.'."\n", - 'type' => 'integer', - 'format' => 'int64', 'required' => true, - 'docRequired' => true, - 'maximum' => '1000000', - 'minimum' => '0', - 'example' => '27', + 'title' => '', + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'NotificationSettings', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'description' => 'The alert notification settings.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AFAE64E-D1BE-432B-A9****', - ], - 'ProjectRoleList' => [ - 'description' => 'The roles in the DataWorks workspace.'."\n", + 'NotificationChannels' => [ + 'description' => 'The alert notification methods.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The alert notification method.', 'type' => 'object', 'properties' => [ - 'ProjectRoleId' => [ - 'description' => 'The ID of the role in the DataWorks workspace.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ProjectRoleType' => [ - 'description' => 'The type of the role in the DataWorks workspace.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'ProjectRoleName' => [ - 'description' => 'The name of the role in the DataWorks workspace.'."\n", + 'Severity' => [ + 'description' => 'The severity level. Valid values:'."\n" + ."\n" + .'- Warning'."\n" + ."\n" + .'- Critical', + 'enumValueTitles' => [], 'type' => 'string', - 'example' => 'visitor', + 'required' => false, + 'example' => 'Warning', + 'title' => '', + ], + 'Channels' => [ + 'description' => 'The alert notification methods.', + 'type' => 'array', + 'items' => [ + 'description' => 'The alert notification method. Valid values:'."\n" + ."\n" + .'- Mail: email'."\n" + ."\n" + .'- Phone: phone call'."\n" + ."\n" + .'- Sms: text message'."\n" + ."\n" + .'- Ding: DingTalk chatbot token', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'example' => 'Ding', + 'title' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'ProjectRoleCode' => [ - 'description' => 'The code of the role in the DataWorks workspace.'."\n", + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'title' => '', + 'example' => '', + ], + 'NotificationReceivers' => [ + 'description' => 'The settings of alert notification recipients.', + 'type' => 'array', + 'items' => [ + 'description' => 'The setting of an alert notification recipient.', + 'type' => 'object', + 'properties' => [ + 'ReceiverType' => [ + 'description' => 'The recipient type. Valid values: AliyunUid and DingToken.'."\n" + ."\n" + .'- If the alert notification method is Mail, Phone, or Sms, set this parameter to **AliyunUid**, which specifies the Alibaba Cloud account ID.'."\n" + ."\n" + .'- If the alert notification method is Ding, set this parameter to **DingToken**, which indicates the DingTalk chatbot token.', + 'enumValueTitles' => [], 'type' => 'string', - 'example' => 'role_project_guest', + 'required' => false, + 'example' => 'DingToken', + 'title' => '', + ], + 'ReceiverValues' => [ + 'description' => 'The recipients.', + 'type' => 'array', + 'items' => ['description' => 'The recipient.'."\n" + ."\n" + .'- If the ReceiverType parameter is set to AliyunUid, set this parameter to the Alibaba Cloud account ID of a user.'."\n" + ."\n" + .'- If the ReceiverType parameter is set to DingToken, set this parameter to the token of a DingTalk chatbot.', 'type' => 'string', 'required' => false, 'example' => 'token1', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', ], ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => true, + 'title' => '', + 'example' => '', ], + 'InhibitionInterval' => ['description' => 'The duration of the alert suppression interval. Default value: 5. Unit: minutes.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', 'title' => ''], ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Invalid.Tenant.ConnectionNotExists', - 'errorMessage' => 'The connection does not exist.', - ], - [ - 'errorCode' => 'Invalid.Tenant.ProjectNotExists', - 'errorMessage' => 'The project does not exist.', - ], - [ - 'errorCode' => 'Invalid.Tenant.UserNotInProject', - 'errorMessage' => 'The user is not in the project.', - ], - ], - 403 => [ - [ - 'errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin', - 'errorMessage' => 'The user is not a project administrator or owner.', - ], - [ - 'errorCode' => 'Invalid.Tenant.UserNotInTenant', - 'errorMessage' => 'The user is not in tenant.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AFAE64E-D1BE-432B-A9****\\",\\n \\"ProjectRoleList\\": [\\n {\\n \\"ProjectRoleId\\": 1,\\n \\"ProjectRoleType\\": \\"0\\",\\n \\"ProjectRoleName\\": \\"访客\\",\\n \\"ProjectRoleCode\\": \\"role_project_guest\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 1AFAE64E-D1BE-432B-A9****\\n \\n 1\\n 0\\n 访客\\n role_project_guest\\n \\n","errorExample":""}]', - 'title' => 'ListProjectRoles', - 'summary' => 'Queries a list of roles in a DataWorks workspace.', - 'description' => '## Debugging'."\n" - ."\n" - .'[OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.](https://api.aliyun.com/#product=dataworks-public\\&api=ListProjectRoles\\&type=RPC\\&version=2020-05-18)'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'RemoveProjectMemberFromRole' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '10000000', - 'minimum' => '0', - 'example' => '27', - ], - ], - [ - 'name' => 'UserId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The user ID.'."\n", - 'type' => 'string', 'required' => true, - 'docRequired' => true, - 'example' => '1234', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'RoleCode', - 'in' => 'query', - 'schema' => [ - 'description' => 'The code of the role in the DataWorks workspace. You can call the ListProjectRoles operation to query the codes of all roles in a DataWorks workspace. Valid values:'."\n" - ."\n" - .'* role_project_owner: workspace owner'."\n" - .'* role_project_admin: workspace administrator'."\n" - .'* role_project_dev: developer'."\n" - .'* role_project_pe: O\\&M engineer'."\n" - .'* role_project_deploy: deployment expert'."\n" - .'* role_project_guest: visitor'."\n" - .'* role_project_security: security administrator'."\n" - .'* role_project_tester: experiencer'."\n" - .'* role_project_erd: model designer'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'role_project_guest', - ], + 'name' => 'Enabled', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to enable the alert rule. By default, the alert rule is disabled.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'title' => 'Schema of Response', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AFAE64E-D1BE-432B-A9****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'C636A747-7E4E-594D-94CD-2B4F8A9A9A63'], + 'DIAlarmRuleId' => ['description' => 'The alert rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '34988', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Invalid.Tenant.ConnectionNotExists', - 'errorMessage' => 'The connection does not exist.', - ], - [ - 'errorCode' => 'Invalid.Tenant.ProjectNotExists', - 'errorMessage' => 'The project does not exist.', - ], - [ - 'errorCode' => 'Invalid.Tenant.UserNotInProject', - 'errorMessage' => 'The user is not in the project.', - ], - ], 403 => [ - [ - 'errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin', - 'errorMessage' => 'The user is not a project administrator or owner.', - ], - [ - 'errorCode' => 'Invalid.Tenant.UserNotInTenant', - 'errorMessage' => 'The user is not in tenant.', - ], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AFAE64E-D1BE-432B-A9****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1AFAE64E-D1BE-432B-A9****\\n","errorExample":""}]', - 'title' => 'RemoveProjectMemberFromRole', - 'summary' => 'Removes a role from a user in a DataWorks workspace.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListProjectMembers' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C636A747-7E4E-594D-94CD-2B4F8A9A9A63\\",\\n \\"DIAlarmRuleId\\": 34988\\n}","type":"json"}]', + 'title' => 'CreateDIAlarmRule', + 'description' => 'Alert rules can be configured when your task includes real-time synchronization.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDIAlarmRule'], + ], ], + 'ramActions' => [], + ], + 'CreateDIJob' => [ + 'summary' => 'Creates a new-version synchronization task. The following types of synchronization tasks are supported: real-time synchronization of all data in a MySQL database to Hologres and batch synchronization of all data in a MySQL database to Hive.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '78326', - 'abilityTreeNodes' => [ - 'FEATUREdideL60QLN', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '155151', + 'abilityTreeNodes' => ['FEATUREdideQHGTK4'], ], 'parameters' => [ [ 'name' => 'ProjectId', - 'in' => 'query', + 'in' => 'formData', + 'schema' => ['description' => 'The DataWorks workspace ID. You can call the [ListProjects](~~178393~~) operation to obtain the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000', 'title' => ''], + ], + [ + 'name' => 'JobName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the synchronization task.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mysql_to_holo_sync_8772', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['description' => 'The description of the synchronization task.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Synchronize mysql to hologres', 'title' => ''], + ], + [ + 'name' => 'MigrationType', + 'in' => 'formData', 'schema' => [ - 'description' => 'The ID of the DataWorks workspace.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '10000000', - 'minimum' => '0', - 'example' => '27', + 'description' => 'The synchronization type. Valid values:'."\n" + ."\n" + .'* FullAndRealtimeIncremental (one-time full synchronization and real-time incremental synchronization)'."\n" + .'* RealtimeIncremental (real-time incremental synchronization)'."\n" + .'* Full (full synchronization)'."\n" + .'* OfflineIncremental (batch incremental synchronization)'."\n" + .'* FullAndOfflineIncremental (one-time full synchronization and batch incremental synchronization)'."\n", + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'example' => 'FullAndRealtimeIncremental', + 'title' => '', ], ], [ - 'name' => 'PageNumber', - 'in' => 'query', + 'name' => 'SourceDataSourceType', + 'in' => 'formData', 'schema' => [ - 'description' => 'The page number. Valid values: 1 to 30. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The source type. Set this parameter to MySQL.'."\n", + 'enumValueTitles' => [], + 'type' => 'string', 'required' => false, - 'maximum' => '10000', - 'minimum' => '1', - 'example' => '1', - 'default' => '1', + 'example' => 'MySQL', + 'title' => '', ], ], [ - 'name' => 'PageSize', - 'in' => 'query', + 'name' => 'DestinationDataSourceType', + 'in' => 'formData', 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The destination type. Valid values: Hologres and Hive.'."\n", + 'enumValueTitles' => [], + 'type' => 'string', 'required' => false, - 'maximum' => '20', - 'minimum' => '5', - 'example' => '10', - 'default' => '10', + 'example' => 'Hologres', + 'title' => '', ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'SourceDataSourceSettings', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AFAE64E-D1BE-432B-A9****', - ], - 'Data' => [ - 'description' => 'The returned results.'."\n", - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'ProjectMemberList' => [ - 'description' => 'The information about members in the DataWorks workspace.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status of the member. Valid values:'."\n" - ."\n" - .'* 0: NORMAL, which indicates that the member is in a normal state.'."\n" - .'* 1: FORBIDDEN, which indicates that the member is disabled.'."\n" - .'* 2: DELETED, which indicates that the member is deleted.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'ProjectMemberId' => [ - 'description' => 'The member ID.'."\n", - 'type' => 'string', - 'example' => '121', - ], - 'Nick' => [ - 'description' => 'The nickname of the member.'."\n", - 'type' => 'string', - 'example' => 'zhangsan', - ], - 'ProjectMemberName' => [ - 'description' => 'The name of the member.'."\n", - 'type' => 'string', - 'example' => 'zhangsan', - ], - 'ProjectMemberType' => [ - 'description' => 'The type of the member. Valid values:'."\n" - ."\n" - .'* 1: USER_ALIYUN, which indicates that the member is an Alibaba Cloud account.'."\n" - .'* 5: USER_UBACCOUNT, which indicates that the member is a RAM user.'."\n" - .'* 6: USER_STS_ROLE, which indicates that the member is a RAM role.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'ProjectRoleList' => [ - 'description' => 'The roles that are assigned to the member.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ProjectRoleId' => [ - 'description' => 'The role ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ProjectRoleType' => [ - 'description' => 'The type of the role. Valid values:'."\n" - ."\n" - .'* 0: SYSTEM, which indicates that the role is a built-in role.'."\n" - .'* 2: USER_CUSTOM, which indicates that the role is a custom role.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'ProjectRoleName' => [ - 'description' => 'The name of the role. DataWorks provides built-in roles and allows you to create custom roles based on your business requirements. For more information about roles, see [Overview of users, roles, and permissions](~~295463~~).'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'ProjectRoleCode' => [ - 'description' => 'The code of the role. DataWorks provides built-in roles and allows you to create custom roles based on your business requirements. For more information about roles, see [Overview of users, roles, and permissions](~~295463~~).'."\n", - 'type' => 'string', - 'example' => 'role_project_guest', - ], - ], - ], - ], - ], - ], - ], - ], + 'description' => 'The settings of the source. Only a single source is supported.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DataSourceName' => ['description' => 'The name of the data source.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mysql_datasource_1', 'title' => ''], + 'DataSourceProperties' => [ + 'description' => 'The properties of the data source.'."\n", + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['description' => 'The properties of the source. The properties of a MySQL data source include TimeZone and Encoding.'."\n", 'type' => 'string', 'example' => 'TimeZone', 'title' => ''], + 'title' => '', + 'example' => '', + ], ], + 'required' => false, + 'title' => '', + 'example' => '', ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Invalid.Tenant.ConnectionNotExists', - 'errorMessage' => 'The connection does not exist.', - ], - [ - 'errorCode' => 'Invalid.Tenant.ProjectNotExists', - 'errorMessage' => 'The project does not exist.', - ], - [ - 'errorCode' => 'Invalid.Tenant.UserNotInProject', - 'errorMessage' => 'The user is not in the project.', - ], - ], - 403 => [ - [ - 'errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin', - 'errorMessage' => 'The user is not a project administrator or owner.', - ], - [ - 'errorCode' => 'Invalid.Tenant.UserNotInTenant', - 'errorMessage' => 'The user is not in tenant.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1AFAE64E-D1BE-432B-A9****\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 3,\\n \\"ProjectMemberList\\": [\\n {\\n \\"Status\\": \\"0\\",\\n \\"ProjectMemberId\\": \\"121\\",\\n \\"Nick\\": \\"zhangsan\\",\\n \\"ProjectMemberName\\": \\"张三\\",\\n \\"ProjectMemberType\\": \\"1\\",\\n \\"ProjectRoleList\\": [\\n {\\n \\"ProjectRoleId\\": 1,\\n \\"ProjectRoleType\\": \\"0\\",\\n \\"ProjectRoleName\\": \\"访客\\",\\n \\"ProjectRoleCode\\": \\"role_project_guest\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 1AFAE64E-D1BE-432B-A9****\\n \\n 1\\n 10\\n 3\\n \\n 0\\n 121\\n zhangsan\\n 张三\\n 1\\n \\n 1\\n 0\\n 访客\\n role_project_guest\\n \\n \\n \\n","errorExample":""}]', - 'title' => 'ListProjectMembers', - 'summary' => 'Queries a list of existing members in a DataWorks workspace.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListProjects' => [ - 'summary' => 'Queries a list of DataWorks workspaces of the tenant to which a user belongs.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Valid values: 1 to 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', 'required' => false, - 'docRequired' => true, - 'maximum' => '10000000', - 'minimum' => '1', - 'example' => '1', - 'default' => '1', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'PageSize', - 'in' => 'query', + 'name' => 'DestinationDataSourceSettings', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The settings of the destination. Only a single destination is supported.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DataSourceName' => ['description' => 'The name of the data source.'."\n", 'type' => 'string', 'required' => false, 'example' => 'holo_datasource_1', 'title' => ''], + 'DataSourceProperties' => [ + 'description' => 'The properties of the data source.'."\n", + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['description' => 'The properties of the destination. No properties can be configured for a Hologres data source.'."\n", 'type' => 'string', 'example' => 'TimeZone', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'maximum' => '10000000', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ResourceManagerResourceGroupId', - 'in' => 'query', + 'name' => 'ResourceSettings', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The resource group ID.'."\n", - 'type' => 'string', + 'description' => 'The resource settings.'."\n", + 'type' => 'object', + 'properties' => [ + 'OfflineResourceSettings' => [ + 'description' => 'The resource used for batch synchronization.'."\n", + 'type' => 'object', + 'properties' => [ + 'ResourceGroupIdentifier' => ['description' => 'The identifier of the resource group for Data Integration used for batch synchronization.'."\n", 'type' => 'string', 'required' => false, 'example' => 'S_res_group_111_222', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'RealtimeResourceSettings' => [ + 'description' => 'The resource used for real-time synchronization.'."\n", + 'type' => 'object', + 'properties' => [ + 'ResourceGroupIdentifier' => ['description' => 'The identifier of the resource group for Data Integration used for real-time synchronization.'."\n", 'type' => 'string', 'required' => false, 'example' => 'S_res_group_111_222', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'RequestedCu' => ['description' => 'The number of compute units (CUs) in the resource group that are used for incremental and full synchronization.'."\n", 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '2.0', 'title' => ''], + ], 'required' => false, - 'example' => 'rg-acfmzbn7pti3zfa', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Tags', - 'in' => 'query', + 'name' => 'TransformationRules', + 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'The tags to add to the workspace.'."\n", + 'description' => 'The list of transformation rules that you want to apply to the synchronization objects selected from the source. Each entry in the list defines a transformation rule.'."\n", 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The transformation rule that you want to apply to the synchronization objects selected from the source.'."\n", 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'The key of tag N to add to the workspace.'."\n", + 'RuleName' => ['description' => 'The name of the rule. If the values of the RuleActionType parameter and the RuleTargetType parameter are the same for multiple transformation rules, you must make sure that the transformation rule names are unique.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rename_rule_1', 'title' => ''], + 'RuleActionType' => [ + 'description' => 'The action type. Valid values:'."\n" + ."\n" + .'* DefinePrimaryKey'."\n" + .'* Rename'."\n" + .'* AddColumn'."\n" + .'* HandleDml'."\n" + .'* DefineIncrementalCondition'."\n" + .'* DefineCycleScheduleSettings'."\n" + .'* DefineRuntimeSettings'."\n" + .'* DefinePartitionKey'."\n", + 'enumValueTitles' => [], 'type' => 'string', 'required' => false, - 'example' => 'Env', + 'example' => 'Rename', + 'title' => '', ], - 'Value' => [ - 'description' => 'The value of tag N to add to the workspace.'."\n", + 'RuleTargetType' => [ + 'description' => 'The type of the object on which you want to perform the action. Valid values:'."\n" + ."\n" + .'* Table'."\n" + .'* Schema'."\n", + 'enumValueTitles' => [], 'type' => 'string', 'required' => false, - 'example' => 'Test', + 'example' => 'Table', + 'title' => '', ], + 'RuleExpression' => ['description' => 'The expression of the rule. An expression must be a JSON string.'."\n" + ."\n" + .'Example of a renaming rule: {"expression":"${srcDatasourceName}\\_${srcDatabaseName}\\_0922","variables":\\[{"variableName":"srcDatabaseName","variableRules":\\[{"from":"fromdb","to":"todb"}]}]}'."\n" + ."\n" + .'* expression: the expression of the renaming rule. You can use the following variables in an expression: ${srcDatasourceName}, ${srcDatabaseName}, and ${srcTableName}. ${srcDatasourceName} indicates the name of the source. ${srcDatabaseName} indicates the name of a source database. ${srcTableName} indicates the name of a source table.'."\n" + .'* variables: the generation rule for a variable used in the expression of the renaming rule. The default value of the specified variable is the original value of the object indicated by the variable. You can define a group of string replacement rules to change the original values based on your business requirements. variableName: the name of the variable. Do not enclose the variable name in ${}. variableRules: the string replacement rules for variables. The system runs the string replacement rules in sequence for string replacement. from specifies the original string. to specifies the new string.'."\n" + ."\n" + .'Example of a rule used to add a specific field to the destination and assign a value to the field: {"columns":\\[{"columnName":"my_add_column","columnValueType":"Constant","columnValue":"123"}]}'."\n" + ."\n" + .'* If you do not configure such a rule, no fields are added to the destination and no values are assigned by default.'."\n" + .'* columnName: the name of the field that is added.'."\n" + .'* columnValueType: the type of the value of the field. Valid values: Constant and Variable.'."\n" + .'* columnValue: the value of the field that you want to add. If you set the valueType parameter to Constant, set the columnValue parameter to a custom constant of the STRING type. If you set the valueType parameter to Variable, set the columnValue to a built-in variable. The following built-in variables are supported: EXECUTE_TIME (LONG data type), DB_NAME_SRC (STRING data type), DATASOURCE_NAME_SRC (STRING data type), TABLE_NAME_SRC (STRING data type), DB_NAME_DEST (STRING data type), DATASOURCE_NAME_DEST (STRING data type), TABLE_NAME_DEST (STRING data type), and DB_NAME_SRC_TRANSED (STRING data type). EXECUTE_TIME specifies the execution time. DB_NAME_SRC specifies the name of a source database. DATASOURCE_NAME_SRC specifies the name of the source. TABLE_NAME_SRC specifies the name of a source table. DB_NAME_DEST specifies the name of a destination database. DATASOURCE_NAME_DEST specifies the name of the destination. TABLE_NAME_DEST specifies the name of a destination table. DB_NAME_SRC_TRANSED specifies the database name obtained after a transformation.'."\n" + ."\n" + .'Example of a rule used to specify primary key fields for a destination table: {"columns":\\["ukcolumn1","ukcolumn2"]}'."\n" + ."\n" + .'* If you do not configure such a rule, the primary key fields in the mapped source table are used for the destination table by default.'."\n" + .'* If the destination table is an existing table, Data Integration does not modify the schema of the destination table. If the specified primary key fields do not exist in the destination table, an error is reported when the synchronization task starts to run.'."\n" + .'* If the destination table is automatically created by the system, Data Integration automatically creates the schema of the destination table. The schema contains the primary key fields that you specify. If the specified primary key fields do not exist in the destination table, an error is reported when the synchronization task starts to run.'."\n" + ."\n" + .'Example of a rule used to process DML messages: {"dmlPolicies":\\[{"dmlType":"Delete","dmlAction":"Filter","filterCondition":"id > 1"}]}'."\n" + ."\n" + .'* If you do not configure such a rule, the default processing policy for messages generated for insert, update, and delete operations is Normal.'."\n" + .'* dmlType: the DML operation. Valid values: Insert, Update, and Delete.'."\n" + .'* dmlAction: the processing policy for DML messages. Valid values: Normal, Ignore, Filter, and LogicalDelete. Filter indicates conditional processing. You can set the dmlAction parameter to Filter only when the dmlType parameter is set to Update or Delete.'."\n" + .'* filterCondition: the condition used to filter DML messages. This parameter is required only when the dmlAction parameter is set to Filter.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"expression":"${srcDatasoureName}_${srcDatabaseName}"}', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, - 'maxItems' => 20, + 'title' => '', + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'TableMappings', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '20658801***', - ], - 'PageResult' => [ - 'description' => 'The results that are returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '123', - ], - 'ProjectList' => [ - 'description' => 'The DataWorks workspaces.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ProjectStatusCode' => [ - 'description' => 'The status code of the workspace. Valid values:'."\n" - ."\n" - .'* AVAILABLE: 0, which indicates that the workspace is running as expected.'."\n" - .'* DELETED: 1, which indicates that the workspace is deleted.'."\n" - .'* INITIALIZING: 2, which indicates that the workspace is being initialized.'."\n" - .'* INIT_FAILED: 3, which indicates that the workspace fails to be initialized.'."\n" - .'* FORBIDDEN: 4, which indicates that the workspace is manually disabled.'."\n" - .'* DELETING: 5, which indicates that the workspace is being deleted.'."\n" - .'* DEL_FAILED: 6, which indicates that the workspace fails to be deleted.'."\n" - .'* FROZEN: 7, which indicates that the workspace is frozen due to overdue payments.'."\n" - .'* UPDATING: 8, which indicates that the workspace is being updated. After you associate a compute engine with the workspace, the system initializes the compute engine and updates the workspace.'."\n" - .'* UPDATE_FAILED: 9, which indicates that the workspace fails to be updated.'."\n", - 'type' => 'string', - 'example' => 'AVAILABLE', - ], - 'ProjectStatus' => [ - 'description' => 'The status of the workspace. Valid values:'."\n" - ."\n" - .'* 0: AVAILABLE, which indicates that the workspace is running as expected.'."\n" - .'* 1: DELETED, which indicates that the workspace is deleted.'."\n" - .'* 2: INITIALIZING, which indicates that the workspace is being initialized.'."\n" - .'* 3: INIT_FAILED, which indicates that the workspace fails to be initialized.'."\n" - .'* 4: FORBIDDEN, which indicates that the workspace is manually disabled.'."\n" - .'* 5: DELETING, which indicates that the workspace is being deleted.'."\n" - .'* 6: DEL_FAILED, which indicates that the workspace fails to be deleted.'."\n" - .'* 7: FROZEN, which indicates that the workspace is frozen due to overdue payments.'."\n" - .'* 8: UPDATING, which indicates that the workspace is being updated. After you associate a compute engine with the workspace, the system initializes the compute engine and updates the workspace.'."\n" - .'* 9: UPDATE_FAILED, which indicates that the workspace fails to be updated.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ProjectName' => [ - 'description' => 'The display name of the workspace.'."\n", - 'type' => 'string', - 'example' => 'test_project', - ], - 'ProjectIdentifier' => [ - 'description' => 'The name of the workspace.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'ProjectId' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1212', - ], - 'ProjectDescription' => [ - 'description' => 'The description of the workspace.'."\n", - 'type' => 'string', - 'example' => 'test_describe', - ], - 'ProjectOwnerBaseId' => [ - 'description' => 'The ID of the user used by the workspace owner.'."\n", - 'type' => 'string', - 'example' => '122222', - ], - 'ResourceManagerResourceGroupId' => [ - 'description' => 'The resource group ID.'."\n", - 'type' => 'string', - 'example' => 'rg-acfmzbn7pti3zfa', - ], - 'Tags' => [ - 'description' => 'The tags added to the workspace.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of tag N added to the workspace.'."\n", - 'type' => 'string', - 'example' => 'Env', - ], - 'Value' => [ - 'description' => 'The value of tag N added to the workspace.'."\n", - 'type' => 'string', - 'example' => 'Test', - ], - ], - ], - ], - 'DisableDevelopment' => [ - 'description' => 'Indicates whether the Development role is disabled. Valid values:'."\n" - ."\n" - .'* **false**: enabled'."\n" - .'* **true**: disabled'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'UseProxyOdpsAccount' => [ - 'description' => 'Indicates whether a proxy account is used to access the MaxCompute compute engine associated with the workspace. Valid values:'."\n" - ."\n" - .'* **false**'."\n" - .'* **true**'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'TablePrivacyMode' => [ - 'description' => 'Indicates whether the MaxCompute tables in the workspace are visible to the users within a tenant. Valid values:'."\n" - ."\n" - .'* **0**: invisible'."\n" - .'* **1**: visible'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'IsDefault' => [ - 'description' => 'Indicates whether the workspace is a default workspace. Valid values:'."\n" - ."\n" - .'* **1**: The workspace is a default workspace.'."\n" - .'* **0**: The workspace is not a default workspace.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'description' => 'The list of mappings between rules used to select synchronization objects in the source and transformation rules applied to the selected synchronization objects. Each entry in the list displays a mapping between a rule used to select synchronization objects and a transformation rule applied to the selected synchronization objects.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The mapping between a rule used to select synchronization objects in the source and a transformation rule applied to the selected synchronization objects.'."\n", + 'type' => 'object', + 'properties' => [ + 'SourceObjectSelectionRules' => [ + 'description' => 'The rules used to select synchronization objects in the source.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The rule used to select synchronization objects in the source. The objects can be databases or tables.'."\n", + 'type' => 'object', + 'properties' => [ + 'ObjectType' => [ + 'description' => 'The object type. Valid values:'."\n" + ."\n" + .'* Table'."\n" + .'* Database'."\n", + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'example' => 'Table', + 'title' => '', ], + 'Expression' => ['description' => 'The expression.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mysql_table_1', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => false, + 'title' => '', + 'example' => '', ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Invalid.Tenant.ConnectionNotExists', - 'errorMessage' => 'The connection does not exist.', - ], - [ - 'errorCode' => 'Invalid.Tenant.ProjectNotExists', - 'errorMessage' => 'The project does not exist.', - ], - [ - 'errorCode' => 'Invalid.Tenant.UserAlreadyInProject', - 'errorMessage' => 'The user already exists in the project.', - ], - [ - 'errorCode' => 'Invalid.Tenant.UserNotInProject', - 'errorMessage' => 'The user is not in the project.', - ], - ], - 403 => [ - [ - 'errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin', - 'errorMessage' => 'The user is not a project administrator or owner.', - ], - [ - 'errorCode' => 'Invalid.Tenant.UserNotInTenant', - 'errorMessage' => 'The user is not in tenant.', + 'TransformationRules' => [ + 'description' => 'The list of transformation rules that you want to apply to the synchronization objects selected from the source.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The transformation rule that you want to apply to the synchronization objects selected from the source.'."\n", + 'type' => 'object', + 'properties' => [ + 'RuleName' => ['description' => 'The name of the rule. If the values of the RuleActionType parameter and the RuleTargetType parameter are the same for multiple transformation rules, you must make sure that the transformation rule names are unique.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rename_rule_1', 'title' => ''], + 'RuleActionType' => [ + 'description' => 'The action type. Valid values:'."\n" + ."\n" + .'* DefinePrimaryKey'."\n" + .'* Rename'."\n" + .'* AddColumn'."\n" + .'* HandleDml'."\n" + .'* DefineIncrementalCondition'."\n" + .'* DefineCycleScheduleSettings'."\n" + .'* DefineRuntimeSettings'."\n" + .'* DefinePartitionKey'."\n", + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'example' => 'Rename', + 'title' => '', + ], + 'RuleTargetType' => [ + 'description' => 'The type of the object on which you want to perform the action. Valid values:'."\n" + ."\n" + .'* Table'."\n" + .'* Schema'."\n", + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'example' => 'Table', + 'title' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"20658801****\\",\\n \\"PageResult\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 68,\\n \\"ProjectList\\": [\\n {\\n \\"ProjectStatusCode\\": \\"AVAILABLE\\",\\n \\"ProjectStatus\\": 0,\\n \\"ProjectName\\": \\"test_project\\",\\n \\"ProjectIdentifier\\": \\"test_project\\",\\n \\"ProjectId\\": 466230,\\n \\"ProjectDescription\\": \\"test_describe\\",\\n \\"ProjectOwnerBaseId\\": \\"13969939245****\\",\\n \\"ResourceManagerResourceGroupId\\": \\"rg-acfmzbn7****\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"key\\",\\n \\"Value\\": \\"value\\"\\n }\\n ],\\n \\"DisableDevelopment\\": true,\\n \\"UseProxyOdpsAccount\\": true,\\n \\"TablePrivacyMode\\": 1,\\n \\"IsDefault\\": 1\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 20658801***\\n \\n 1\\n 10\\n 123\\n \\n AVAILABLE\\n 0\\n 测试空间\\n test\\n 1212\\n 测试空间\\n 122222\\n rg-acfmzbn7pti3zfa\\n \\n Env\\n Test\\n \\n true\\n true\\n 1\\n 1\\n \\n \\n","errorExample":""}]', - 'title' => 'ListProjects', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListProjectIds' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'JobSettings', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The settings for the dimension of the synchronization task. The settings include processing policies for DDL messages, policies for data type mappings between source fields and destination fields, and runtime parameters of the synchronization task.'."\n", + 'type' => 'object', + 'properties' => [ + 'DdlHandlingSettings' => [ + 'description' => 'The processing settings for DDL messages.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The processing setting for a specific type of DDL message.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The type of the DDL operation. Valid values:'."\n" + ."\n" + .'* RenameColumn'."\n" + .'* ModifyColumn'."\n" + .'* CreateTable'."\n" + .'* TruncateTable'."\n" + .'* DropTable'."\n" + .'* DropColumn'."\n" + .'* AddColumn'."\n", + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'example' => 'AddColumn', + 'title' => '', + ], + 'Action' => [ + 'description' => 'The processing policy. Valid values:'."\n" + ."\n" + .'* Ignore: ignores a DDL message.'."\n" + .'* Critical: reports an error for a DDL message.'."\n" + .'* Normal: normally processes a DDL message.'."\n", + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'example' => 'Critical', + 'title' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'ColumnDataTypeSettings' => [ + 'description' => 'The settings for data type mappings between source fields and destination fields. The value of this parameter must be an array.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data type mapping between a source field and a destination field.'."\n", + 'type' => 'object', + 'properties' => [ + 'SourceDataType' => ['description' => 'The data type of the source field.'."\n", 'type' => 'string', 'required' => false, 'example' => 'bigint', 'title' => ''], + 'DestinationDataType' => ['description' => 'The data type of the destination field.'."\n", 'type' => 'string', 'required' => false, 'example' => 'text', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'RuntimeSettings' => [ + 'description' => 'The runtime settings. The value of this parameter must be an array.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The runtime setting.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the configuration item. Valid values:'."\n" + ."\n" + .'* runtime.offline.speed.limit.mb: specifies the maximum transmission rate that is allowed for a batch synchronization task. This configuration item takes effect only when runtime.offline.speed.limit.enable is set to true.'."\n" + .'* runtime.offline.speed.limit.enable: specifies whether throttling is enabled for a batch synchronization task.'."\n" + .'* dst.offline.connection.max: specifies the maximum number of connections that are allowed for writing data to the destination of a batch synchronization task.'."\n" + .'* runtime.offline.concurrent: specifies the maximum number of parallel threads that are allowed for a batch synchronization task.'."\n" + .'* dst.realtime.connection.max: specifies the maximum number of connections that are allowed for writing data to the destination of a real-time synchronization task.'."\n" + .'* runtime.enable.auto.create.schema: specifies whether schemas are automatically created in the destination of a synchronization task.'."\n" + .'* src.offline.datasource.max.connection: specifies the maximum number of connections that are allowed for reading data from the source of a batch synchronization task.'."\n" + .'* runtime.realtime.concurrent: specifies the maximum number of parallel threads that are allowed for a real-time synchronization task.'."\n", + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'example' => 'runtime.offline.concurrent', + 'title' => '', + ], + 'Value' => ['description' => 'The value of the configuration item.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'CycleScheduleSettings' => [ + 'description' => 'The settings for periodic scheduling.'."\n", + 'type' => 'object', + 'properties' => [ + 'CycleMigrationType' => ['description' => 'The synchronization type that requires periodic scheduling. Valid values:'."\n" + ."\n" + .'* Full: full synchronization'."\n" + .'* OfflineIncremental: batch incremental synchronization'."\n", 'type' => 'string', 'required' => false, 'example' => 'Full', 'title' => ''], + 'ScheduleParameters' => ['description' => 'The scheduling parameters.'."\n", 'type' => 'string', 'required' => false, 'example' => 'bizdate=$bizdate'."\n", 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'ChannelSettings' => ['description' => 'The channel control settings for the synchronization task. The value of this parameter must be a JSON string.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"structInfo":"MANAGED","storageType":"TEXTFILE","writeMode":"APPEND","partitionColumns":[{"columnName":"pt","columnType":"STRING","comment":""}],"fieldDelimiter":""}'."\n", 'title' => ''], + 'ImportRuleSettings' => [ + 'description' => 'The import settings for the synchronization task.'."\n", + 'type' => 'object', + 'properties' => [ + 'Source' => ['description' => 'The import source of the task. Set the value to Datastudio, which indicates synchronization tasks created in DataStudio.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Datastudio', 'title' => ''], + 'FileId' => ['description' => 'The ID of the task to be imported.'."\n", 'type' => 'string', 'required' => false, 'example' => '10000', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ [ - 'name' => 'UserId', + 'name' => 'SystemDebug', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the desired Alibaba Cloud account.'."\n" - ."\n" - .'You can log on to the [DataWorks](https://workbench.data.aliyun.com/console) console and move the pointer over the profile picture in the upper-right corner to view the ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '171111', - 'maxLength' => 10000000, - 'minLength' => 0, - ], + 'schema' => ['description' => 'Specifies whether to perform system debugging. Valid values: true and false. Default value: false.'."\n", 'type' => 'string', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0b57ff7216278945532771749d****', - ], - 'ProjectIds' => [ - 'description' => 'The IDs of the DataWorks workspaces. The IDs of the workspaces on which the desired Alibaba Cloud account has permissions were returned.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the DataWorks workspace.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '75777', - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID. You can use the request ID to query logs and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '4F6AB6B3-41FB-5EBB-AFB2-0C98D49DA2BB'], + 'DIJobId' => ['description' => 'The synchronization task ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '11792', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Invalid.Tenant.ConnectionNotExists', - 'errorMessage' => 'The connection does not exist.', - ], - [ - 'errorCode' => 'Invalid.Tenant.ProjectNotExists', - 'errorMessage' => 'The project does not exist.', - ], - [ - 'errorCode' => 'Invalid.Tenant.UserNotInProject', - 'errorMessage' => 'The user is not in the project.', - ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], - 403 => [ - [ - 'errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin', - 'errorMessage' => 'The user is not a project administrator or owner.', - ], - [ - 'errorCode' => 'Invalid.Tenant.UserNotInTenant', - 'errorMessage' => 'The user is not in tenant.', - ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0b57ff7216278945532771749d****\\",\\n \\"ProjectIds\\": [\\n 466230\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 0b57ff7216278945532771749d****\\n 466230\\n","errorExample":""}]', - 'title' => 'ListProjectIds', - 'summary' => 'Queries the IDs of the workspaces on which a specific Alibaba Cloud account or RAM user has permissions in a specific region.', - 'description' => 'An Alibaba Cloud account can assume a role such as the developer, O\\&M engineer, or workspace administrator role in a workspace. For more information, see [Manage members and roles](~~136941~~).'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'CreateProject' => [ - 'summary' => 'Creates a DataWorks workspace.', - 'methods' => [ - 'post', - 'get', + 'title' => 'CreateDIJob', + 'changeSet' => [ + ['createdAt' => '2024-06-04T02:51:15.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-02-28T06:44:45.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-01-18T10:25:13.000Z', 'description' => 'Error codes changed, Request parameters changed, Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDIJob'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4F6AB6B3-41FB-5EBB-AFB2-0C98D49DA2BB\\",\\n \\"DIJobId\\": 11792\\n}","type":"json"}]', + ], + 'CreateDISyncTask' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'APP' => [], + ], + [ + 'PrivateKey' => [], + ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '158574', - 'abilityTreeNodes' => [ - 'FEATUREdideYNK30F', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '93925', + 'abilityTreeNodes' => ['FEATUREdideBP0OJZ'], ], 'parameters' => [ [ - 'name' => 'ClientToken', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request. This parameter can be left empty.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ABFUOEUOTRTRJKE', - ], + 'schema' => ['description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to query the ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '10000000000', 'minimum' => '1', 'example' => '10000', 'title' => ''], ], [ - 'name' => 'ProjectName', + 'name' => 'TaskType', 'in' => 'query', - 'schema' => [ - 'description' => 'The display name of the workspace.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test_project', - ], + 'schema' => ['description' => 'The type of the data synchronization task. Valid values: DI\\_OFFLINE, DI\\_REALTIME, and DI\\_SOLUTION.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DI_OFFLINE', 'title' => ''], ], [ - 'name' => 'ProjectDescription', + 'name' => 'TaskContent', + 'in' => 'formData', + 'schema' => ['description' => 'The script content of the data synchronization task.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'default' => '', 'example' => '{"type":"job","version":"2.0","steps":[{"stepType":"mysql","parameter":{"envType":1,"datasource":"mysql_pub","column":["id","name","create_time","age","score","t_01"],"connection":[{"datasource":"mysql_pub","table":["u_pk"]}],"where":"","splitPk":"id","encoding":"UTF-8"},"name":"Reader","category":"reader"},{"stepType":"odps","parameter":{"partition":"pt=${bizdate}","truncate":true,"datasource":"odps_first","envType":1,"column":["id","name","create_time","age","score","t_01"],"emptyAsNull":false,"tableComment":"null","table":"u_pk"},"name":"Writer","category":"writer"}],"setting":{"executeMode":null,"errorLimit":{"record":""},"speed":{"concurrent":2,"throttle":false}},"order":{"hops":[{"from":"Reader","to":"Writer"}]}}', 'title' => ''], + ], + [ + 'name' => 'TaskParam', 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the workspace.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_describe', - ], + 'schema' => ['description' => 'The configuration parameters of the data synchronization task. The following parameters are supported:'."\n" + ."\n" + .'- FileFolderPath: the storage path of the data synchronization task.'."\n" + ."\n" + .'- ResourceGroup: the identifier of the resource group for Data Integration that is used by the data synchronization task. You can call the [ListResourceGroups](~~173913~~) operation to query the identifier of the resource group.'."\n" + ."\n" + .'- Cu: the specifications occupied by the data synchronization task in the serverless resource group. The value of this parameter must be a multiple of 0.5.', 'type' => 'string', 'example' => '{"FileFolderPath":"workflow/XXX/data integration","ResourceGroup":"Serverless_res_group_XXX_XXXX", "Cu":1.5}', 'required' => false, 'docRequired' => true, 'title' => ''], ], [ - 'name' => 'DisableDevelopment', + 'name' => 'TaskName', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to disable the Develop role. Valid values:'."\n" - ."\n" - .'* **false** (default)'."\n" - .'* **true**'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - [ - 'name' => 'IsAllowDownload', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to allow you to download the query result from DataStudio. Valid values:'."\n" - ."\n" - .'* **1** (default): allows you to download the query result from DataStudio.'."\n" - .'* **0**: does not allow you to download the query result from DataStudio.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'ProjectMode', - 'in' => 'query', - 'schema' => [ - 'description' => 'The mode of the workspace. For more information about the differences between the modes of workspaces, see [Differences between workspaces in basic mode and workspaces in standard mode](~~85772~~).'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* **2** (default): basic mode'."\n" - .'* **3**: standard mode'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], - ], - [ - 'name' => 'ProjectIdentifier', - 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The name of the workspace. The name can contain only letters, digits, and underscores (\\_) and must start with a letter or digit.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test_project', - ], - ], - [ - 'name' => 'ResourceManagerResourceGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The resource group ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfmzbn7pti3****', - ], + 'schema' => ['description' => 'The name of the data synchronization task.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'new_di_task', 'title' => ''], ], [ - 'name' => 'Tags', + 'name' => 'ClientToken', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The tags added to the workspace.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The tags.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'key', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'value', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 21, - ], + 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. This parameter can be left empty.', 'type' => 'string', 'required' => false, 'example' => '0000-ABCD-EFG****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AFAE64E-D1BE-432B-A9****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0bc1411515937635973****', 'title' => ''], 'Data' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '466230', + 'description' => 'The information that indicates whether the data synchronization task is created.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The creation status of the data synchronization task. Valid values:'."\n" + ."\n" + .'- success'."\n" + ."\n" + .'- fail', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Message' => ['description' => 'The error message that is returned if the data synchronization task fails to be created. If the data synchronization task is successfully created, this parameter is not returned. If the data synchronization task fails to be created, an error message in the "Invalid path: Workflow/xxxx/Data Integration" format is returned.', 'type' => 'string', 'example' => 'Invalid directory path: workflow/xxxx/data integration.', 'title' => ''], + 'FileId' => ['description' => 'The ID of the data synchronization task that is created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000001', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Invalid.Tenant.ConnectionNotExists', - 'errorMessage' => 'The connection does not exist.', - ], - [ - 'errorCode' => 'Invalid.Tenant.ProjectNotExists', - 'errorMessage' => 'The project does not exist.', - ], - [ - 'errorCode' => 'Invalid.Tenant.UserNotInProject', - 'errorMessage' => 'The user is not in the project.', - ], + ['errorCode' => 'Invalid.DI.Parameter', 'errorMessage' => 'The parameter is invalid.', 'description' => ''], + ['errorCode' => 'Invalid.DI.Parameter.File.Existed', 'errorMessage' => 'The file name already exists.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin', - 'errorMessage' => 'The user is not a project administrator or owner.', - ], - [ - 'errorCode' => 'Invalid.Tenant.UserNotInTenant', - 'errorMessage' => 'The user is not in tenant.', - ], + ['errorCode' => 'Forbidden.DI.NoPrivilege', 'errorMessage' => 'No access.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.DI.Parameter', 'errorMessage' => 'A DI internal error occurred.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"1AFAE64E-D1BE-432B-A9****\\",\\n \\"Success\\": true,\\n \\"Data\\": 466230\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 1AFAE64E-D1BE-432B-A9****\\n true\\n 25\\n","errorExample":""}]', - 'title' => 'CreateProject', - ], - 'ChangeResourceManagerResourceGroup' => [ - 'summary' => 'Changes the resource group to which a resource belongs.', - 'methods' => [ - 'post', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0bc1411515937635973****\\",\\n \\"Data\\": {\\n \\"Status\\": \\"success\\",\\n \\"Message\\": \\"Invalid directory path: workflow/xxxx/data integration.\\",\\n \\"FileId\\": 1000001\\n }\\n}","type":"json"}]', + 'title' => 'CreateDISyncTask', + 'summary' => 'Creates a data synchronization task.', + 'description' => 'You cannot configure scheduling properties for a task by calling this operation. If you want to configure scheduling properties for a task, you can call the UpdateFile operation.[](~~2780137~~)', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-09-23T01:45:17.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'translator' => 'manual', + ], + 'CreateDagComplement' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [], + 'deprecated' => true, + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'ResourceType', - 'in' => 'query', + 'name' => 'ProjectEnv', + 'in' => 'formData', 'schema' => [ - 'description' => 'The HTTP status code.'."\n", + 'description' => 'The environment of the workspace, including PROD and DEV.', 'type' => 'string', 'required' => true, - 'example' => 'project', + 'docRequired' => true, + 'enum' => ['PROD', 'DEV'], + 'example' => 'PROD', + 'title' => '', ], ], [ - 'name' => 'ResourceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test_project', - ], + 'name' => 'StartBizDate', + 'in' => 'formData', + 'schema' => ['description' => 'The start business date of data backfill.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-05-20 00:00:00', 'title' => ''], ], [ - 'name' => 'ResourceManagerResourceGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'ChangeResourceManagerResourceGroup', - 'type' => 'string', - 'required' => true, - 'example' => 'rg-bp67acfmxazb4p****', - ], + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the workflow.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'xm_test', 'title' => ''], + ], + [ + 'name' => 'RootNodeId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the start node for data backfill.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1234', 'title' => ''], + ], + [ + 'name' => 'IncludeNodeIds', + 'in' => 'formData', + 'schema' => ['description' => 'The list of node IDs to include. If you backfill data for only one node, that node must be included in includeNodeIds.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '74324,74325', 'title' => ''], + ], + [ + 'name' => 'ExcludeNodeIds', + 'in' => 'formData', + 'schema' => ['description' => 'An optional parameter. The list of node IDs to exclude from data backfill.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => ' 1234', 'title' => ''], + ], + [ + 'name' => 'BizBeginTime', + 'in' => 'formData', + 'schema' => ['description' => 'An optional parameter. The start time of the task. This parameter is required for hour-level scheduled tasks.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '00:00:00', 'title' => ''], + ], + [ + 'name' => 'BizEndTime', + 'in' => 'formData', + 'schema' => ['description' => 'An optional parameter. The end time of the task. This parameter is required for hour-level scheduled tasks.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '23:00:00', 'title' => ''], + ], + [ + 'name' => 'Parallelism', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether the task can be executed concurrently.', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'EndBizDate', + 'in' => 'formData', + 'schema' => ['description' => 'The end business date of data backfill.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-05-21 00:00:00', 'title' => ''], + ], + [ + 'name' => 'NodeParams', + 'in' => 'formData', + 'schema' => ['description' => 'A JSON string. The key is the node ID, and the value is the actual parameter value.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '{74324:"key1=val1 key2=val"}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', 'type' => 'object', 'properties' => [ + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. The ID is used to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => 'E6F0DBDD-5AD****', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The connection does not exist.', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], 'Data' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1AFAE64E-D1BE-432B-A9****', - ], - 'HttpStatusCode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', + 'description' => 'The list of workflow IDs.', + 'type' => 'array', + 'items' => ['description' => 'The list of workflow IDs.', 'type' => 'integer', 'format' => 'int64', 'example' => '111', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"1AFAE64E-D1BE-432B-A9****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 1AFAE64E-D1BE-432B-A9****\\n 200\\n true\\n true\\n","errorExample":""}]', - 'title' => 'ChangeResourceManagerResourceGroup', - ], - 'ListMeasureData' => [ - 'summary' => 'Queries the statistics on the number of phone call-based alerts or text message-based alerts reported within the tenant to which your account belongs during the previous 30 days.', - 'methods' => [ - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Data\\": [\\n 111\\n ]\\n}","type":"json"}]', + 'title' => 'Create a data backfill workflow', + 'summary' => 'Calls CreateDagComplement to create a data backfill workflow.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-01-13T07:25:29.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'CreateDagTest' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '215284', - 'abilityTreeNodes' => [ - 'FEATUREdideD3SWSQ', - ], - ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'DomainCode', - 'in' => 'query', - 'allowEmptyValue' => false, + 'name' => 'ProjectEnv', + 'in' => 'formData', 'schema' => [ - 'title' => '计量项，取值如下：'."\n" - .'- DideAlarmPhone：电话告警'."\n" - .'- DideAlarmSms：短信告警', - 'description' => 'The measurement item. Valid values:'."\n" - ."\n" - .'* DideAlarmPhone: phone call-based alerts'."\n" - .'* DideAlarmSms: text message-based alerts'."\n", + 'description' => 'The environment of the workspace. Valid values: PROD and DEV.', 'type' => 'string', 'required' => true, 'docRequired' => true, - 'example' => 'DideAlarmPhone', + 'enum' => ['PROD', 'DEV'], + 'example' => 'PROD', + 'title' => '', ], ], [ - 'name' => 'ComponentCode', - 'in' => 'query', - 'schema' => [ - 'title' => '计量组件,取值如下:'."\n" - .'- Count：DideAlarmPhone电话告警条数、DideAlarmSms短信告警条数。', - 'description' => 'The metering component. Valid values:'."\n" - ."\n" - .'* Count: The number of DideAlarmPhone (telephone/call) alerts, and the number of DideAlarmSms (SMS/text message) alerts.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Count', - ], + 'name' => 'Bizdate', + 'in' => 'formData', + 'schema' => ['description' => 'The business date.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-05-26 00:00:00', 'title' => ''], ], [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'title' => '计量周期开始时间戳(毫秒),计量周期是按照天统计，EndTime - StartTime仅能查询最近30天的数据。', - 'description' => 'The start timestamp of the metering cycle, in milliseconds. The metering data is aggregated by day. The time range between EndTime and StartTime cannot exceed 30 days.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1717344000000', - ], + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the workflow.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'xm_create_test', 'title' => ''], ], [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'title' => '计量周期截止时间戳(毫秒),计量周期是按照天统计，EndTime - StartTime仅能查询最近30天的数据。', - 'description' => 'The end timestamp of the metering cycle, in milliseconds. The metering data is aggregated by day. The time range between EndTime and StartTime cannot exceed 30 days.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1717430400000', - ], + 'name' => 'NodeId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the node.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1234', 'title' => ''], + ], + [ + 'name' => 'NodeParams', + 'in' => 'formData', + 'schema' => ['description' => 'The parameters of the node.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'bizdate=$bizdate tbods=$tbods', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => '返回结果。', - 'description' => 'The returned result.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID。', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AFAE64E-D1BE-432B-A9****', - ], - 'MeasureDatas' => [ - 'title' => '查询计量结果列表。', - 'description' => 'The metering results.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DomainCode' => [ - 'title' => '计量项。', - 'description' => 'The item that is measured.'."\n", - 'type' => 'string', - 'example' => 'DideAlarmPhone', - ], - 'ComponentCode' => [ - 'title' => '计量组件。', - 'description' => 'The measurement component.'."\n", - 'type' => 'string', - 'example' => 'Count', - ], - 'StartTime' => [ - 'title' => '计量周期开始时间戳(毫秒)。', - 'description' => 'The start timestamp of the metering cycle, in milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1717344000000', - ], - 'EndTime' => [ - 'title' => '计量周期结束时间戳(毫秒)。', - 'description' => 'The end timestamp of the metering cycle, in milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1717430400000', - ], - 'Usage' => [ - 'title' => '计量周期内使用总量。'."\n", - 'description' => 'The total quantity used within the measurement period.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - ], - 'description' => '', - ], - ], - 'Success' => [ - 'title' => '请求是否成功，取值如下：'."\n" - .'- true：请求成功。'."\n" - .'- false：请求失败。', - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'title' => '请求错误码。', - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '100001001', - ], - 'ErrorMessage' => [ - 'title' => '请求报错信息。', - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The user is not in tenant.', - ], - 'HttpStatusCode' => [ - 'title' => '请求返回码。', - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The ID of the workflow.', 'type' => 'integer', 'format' => 'int64', 'example' => '3333333', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The connection does not exist.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. You can use the ID to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => 'E6F0DBDD-5AD****', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Invalid.Tenant.UserNotInTenant', - 'errorMessage' => 'The user is not in tenant.', - ], - ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 3333333,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Create a smoke test workflow', + 'summary' => 'Creates a smoke test workflow by calling CreateDagTest.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-01-13T07:25:29.000Z', 'description' => 'Error codes changed'], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AFAE64E-D1BE-432B-A9****\\",\\n \\"MeasureDatas\\": [\\n {\\n \\"DomainCode\\": \\"DideAlarmPhone\\",\\n \\"ComponentCode\\": \\"Count\\",\\n \\"StartTime\\": 1717344000000,\\n \\"EndTime\\": 1717430400000,\\n \\"Usage\\": 10\\n }\\n ],\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"100001001\\",\\n \\"ErrorMessage\\": \\"The user is not in tenant.\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', - 'title' => 'ListMeasureData', + 'ramActions' => [], ], - 'ListTables' => [ - 'summary' => 'Obtains tables of different data source types within a tenant by page.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateDataServiceApi' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '234146', - 'abilityTreeNodes' => [ - 'FEATUREdideE9XYA6', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '78179', + 'abilityTreeNodes' => ['FEATUREdideZZ63WZ'], ], 'parameters' => [ [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries displayed on each page. The default value is 10 and the maximum value is 100.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['description' => 'The tenant ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10001', 'title' => ''], ], [ - 'name' => 'DataSourceType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the data source. Valid values: ODPS, emr, mysql, holo, analyticdb_for_mysql, oracle, postgresql, sqlserver, clickhouse, and starrocks.', - 'type' => 'string', - 'required' => true, - 'example' => 'odps'."\n" - .'emr'."\n" - .'mysql'."\n" - .'holo', - ], + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The workspace ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10000', 'title' => ''], ], [ - 'name' => 'NextToken', - 'in' => 'query', + 'name' => 'ApiName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the API. The name must be 4 to 50 characters in length. The name can contain letters, digits, and underscores (\\_) and must start with a letter.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Test API name'."\n", 'title' => ''], + ], + [ + 'name' => 'GroupId', + 'in' => 'formData', + 'schema' => ['description' => 'The business process ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Business process ID', 'title' => ''], + ], + [ + 'name' => 'ApiMode', + 'in' => 'formData', + 'schema' => ['description' => 'The type of the API. Valid values: 0, 1, and 2. The value 0 indicates that the API is generated in wizard mode. The value 1 indicates that the API is generated in script mode. The value 2 indicates that the API is generated by registration.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'RequestMethod', + 'in' => 'formData', + 'schema' => ['description' => 'The request method of the API. Valid values: 0, 1, 2, and 3. The value 0 indicates the GET method. The value 1 indicates the POST method. The value 2 indicates the PUT method. The value 3 indicates the DELETE method. APIs generated in wizard or script mode support the GET and POST methods. APIs generated by registration support the GET, POST, PUT, and DELETE methods.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'ResponseContentType', + 'in' => 'formData', + 'schema' => ['description' => 'The format in which the response of the API request is returned. Valid values: 0 and 1. The value 0 indicates the JSON format. The value 1 indicates the XML format. APIs generated in wizard or script mode support the JSON format. APIs generated by registration support the JSON and XML formats.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'Timeout', + 'in' => 'formData', + 'schema' => ['description' => 'The timeout period of the API request. Unit: milliseconds. Valid values: (0,30000].'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10000', 'title' => ''], + ], + [ + 'name' => 'VisibleRange', + 'in' => 'formData', + 'schema' => ['description' => 'The scope in which the API is visible. Valid values: 0 and 1. The value 0 indicates that the API is visible to all members in the workspace. The value 1 indicates that the API is visible only to its owner.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'Protocols', + 'in' => 'formData', + 'schema' => ['description' => 'The protocol used by the API. Valid values: 0 and 1. The value 0 indicates HTTP. The value 1 indicates HTTPS. You can specify multiple protocols. Separate them with commas (,).'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0,1', 'title' => ''], + ], + [ + 'name' => 'WizardDetails', + 'in' => 'formData', + 'schema' => ['description' => 'The details of the API generated in wizard mode. For more information, see the WizardDetails parameter returned by the [GetDataServiceApi](~~174013~~) operation.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"isPagedResponse":true,"wizardConnection":{"connectionId":122786,"tableName":"person"},"wizardRequestParameters":[{"columnName":"id","defaultValue":"","exampleValue":"1","isRequiredParameter":true,"parameterDataType":2,"parameterDescription":"","parameterName":"id","parameterOperator":0,"parameterPosition":0}],"wizardResponseParameters":[{"columnName":"id","exampleValue":"11","parameterDataType":2,"parameterDescription":"","parameterName":"id"}]}', 'title' => ''], + ], + [ + 'name' => 'ScriptDetails', + 'in' => 'formData', + 'schema' => ['description' => 'The details of the API generated in script mode. For more information, see the scriptDetails parameter returned by the [GetDataServiceApi](~~174013~~) operation.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"isPagedResponse":false,"script":"select id as id1, name as name1 from person where id=${inputid}","scriptConnection":{"connectionId":122786,"tableName":"person"},"scriptRequestParameters":[{"defaultValue":"","exampleValue":"","isRequiredParameter":true,"parameterDataType":0,"parameterDescription":"","parameterName":"inputid","parameterOperator":0,"parameterPosition":1}],"scriptResponseParameters":[{"exampleValue":"","parameterDataType":0,"parameterDescription":"","parameterName":"id1"},{"exampleValue":"","parameterDataType":0,"parameterDescription":"","parameterName":"name1"}]}', 'title' => ''], + ], + [ + 'name' => 'RegistrationDetails', + 'in' => 'formData', + 'schema' => ['description' => 'The details of the API generated by registration. For more information, see the registrationDetails parameter returned by the [GetDataServiceApi](~~174013~~) operation.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"failedResultSample":"fail","registrationErrorCodes":[{"errorCode":"e1","errorMessage":"msg1","errorSolution":"sol1"},{"errorCode":"e2","errorMessage":"msg2","errorSolution":"sol2"}],"registrationRequestParameters":[{"columnName":"","defaultValue":"","exampleValue":"","isRequiredParameter":true,"parameterDataType":0,"parameterDescription":"","parameterName":"id","parameterOperator":0,"parameterPosition":1},{"columnName":"","defaultValue":"xx","exampleValue":"","isRequiredParameter":true,"parameterDataType":0,"parameterDescription":"","parameterName":"cc","parameterOperator":2,"parameterPosition":2}],"serviceContentType":1,"serviceHost":"http://www.baidu.com","servicePath":"/[uid]","serviceRequestBodyDescription":"body","successfulResultSample":"success"}', 'title' => ''], + ], + [ + 'name' => 'ApiPath', + 'in' => 'formData', + 'schema' => ['description' => 'The path of the API. The path cannot exceed 200 characters in length. The path can contain letters, digits, underscores (\\_), and hyphens (-) and must start with a forward slash (/).'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '/test/1', 'title' => ''], + ], + [ + 'name' => 'ApiDescription', + 'in' => 'formData', + 'schema' => ['description' => 'The description of the API.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Test API description', 'title' => ''], + ], + [ + 'name' => 'FolderId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the folder used to store the API. The ID of the root folder in a business process is 0. The ID of the folder created by a user must be greater than 0.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'SqlMode', + 'in' => 'formData', + 'schema' => ['description' => '* The SQL mode. Valid values: 0: The basic mode is used.'."\n" + .'* 1: Mybatis is used.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the exclusive resource group.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3242432423', 'title' => ''], + ], + [ + 'name' => 'RequestContentType', + 'in' => 'formData', 'schema' => [ - 'description' => 'Pagination information, which specifies the starting point of this read.', - 'type' => 'string', + 'description' => 'The format of the data to be requested. Valid values:'."\n" + ."\n" + .'* 0: XML format'."\n" + .'* 1: JSON format'."\n" + .'* 2: form format'."\n", + 'enumValueTitles' => [], + 'type' => 'integer', + 'format' => 'int32', + 'enum' => ['0', '1', '2'], 'required' => false, - 'example' => '12222', + 'example' => '0', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'E25887B7-579C-54A5-9C4F-83A0DE367DD', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'Total' => [ - 'description' => 'The total number.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'TableEntityList' => [ - 'description' => 'An array of entities.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the table.'."\n", - 'type' => 'object', - 'properties' => [ - 'EntityQualifiedName' => [ - 'description' => 'The unique identifier of the table entity.', - 'type' => 'string', - 'example' => 'maxcompute-table.project.table', - ], - 'EntityContent' => [ - 'description' => 'The information about the table.'."\n", - 'type' => 'object', - 'properties' => [ - 'TableName' => [ - 'description' => 'The name of the table.', - 'type' => 'string', - 'example' => 'table', - ], - 'DataSourceQualifiedName' => [ - 'description' => 'The unique identifier of the data source.', - 'type' => 'string', - 'example' => 'accountId:cn-shanghai:odps:project', - ], - 'DataSourceUniqueId' => [ - 'description' => 'The unique ID of the data source identifier.', - 'type' => 'string', - 'example' => 'e70f92239d491057f6a2563b545bdaf8cc6b537d9dc55ec84c55f7cfefg', - ], - 'DatabaseName' => [ - 'description' => 'The name of the database.', - 'type' => 'string', - 'example' => 'database', - ], - 'ProjectName' => [ - 'description' => 'The name of the ODPS project.', - 'type' => 'string', - 'example' => 'project', - ], - 'InstanceId' => [ - 'description' => 'The ID of the data source instance.', - 'type' => 'string', - 'example' => 'rm-uf6rn0123', - ], - ], - ], - ], - ], - ], - 'NextToken' => [ - 'description' => 'Pagination information, which specifies the starting point of the next read.', - 'type' => 'string', - 'example' => 'AAAAAVY3rYiv9VoUJQSiCitgjgSwg+byk0FIjirFkm4zfM4G0xYwM/FQvOhgrTHsCPIZ5yqXYu2NG6qRCRC52HvwbOA=', - ], - ], - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The ID of the API.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100003', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The connection does not exist.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0000-ABCD-EFG****', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E25887B7-579C-54A5-9C4F-83A****\\",\\n \\"Data\\": {\\n \\"Total\\": 100,\\n \\"TableEntityList\\": [\\n {\\n \\"EntityQualifiedName\\": \\"maxcompute-table.project.table\\",\\n \\"EntityContent\\": {\\n \\"TableName\\": \\"table\\",\\n \\"DataSourceQualifiedName\\": \\"accountId:cn-shanghai:odps:project\\",\\n \\"DataSourceUniqueId\\": \\"e70f92239d491057f6a2563b545bdaf8cc6b537d9dc55ec84c55f7cfefg\\",\\n \\"DatabaseName\\": \\"database\\",\\n \\"ProjectName\\": \\"project\\",\\n \\"InstanceId\\": \\"rm-uf6rn0123\\"\\n }\\n }\\n ],\\n \\"NextToken\\": \\"AAAAAVY3rYiv9VoUJQSiCitgjgSwg+byk0FIjirFkm4zfM4G0xYwM/FQvOhgrTHsCPIZ5yqXYu2NG6qRCRC52HvwbOA=\\"\\n }\\n}","type":"json"}]', - 'title' => 'ListTables', - ], - 'GetMetaDBInfo' => [ - 'methods' => [ - 'get', + 'title' => 'CreateDataServiceApi', + 'summary' => 'Creates an API.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-10-10T02:04:50.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-03-31T09:26:18.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-03-02T08:13:10.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDataServiceApi'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 100003,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'CreateDataServiceApiAuthority' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '78259', - 'abilityTreeNodes' => [ - 'FEATUREdideE9XYA6', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '78180', + 'abilityTreeNodes' => ['FEATUREdideWDSR97'], ], 'parameters' => [ [ - 'name' => 'AppGuid', - 'in' => 'query', - 'schema' => [ - 'description' => 'The compute engine instance ID. Specify the ID in the `Engine type.Engine name` format.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'odps.some_engine_name', - ], + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['description' => 'The tenant ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '1004'], ], [ - 'name' => 'ClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The E-MapReduce (EMR) cluster ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the workspace.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '10003'], ], [ - 'name' => 'DatabaseName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the metadatabase of the EMR cluster.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], + 'name' => 'ApiId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the API.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '10001'], ], [ - 'name' => 'DataSourceType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the data source. Valid values: odps and emr.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'emr', - ], + 'name' => 'AuthorizedProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the workspace to which the access permissions on the API are granted.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '10002'], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => ['description' => 'The end time of the validity period of the access permissions. The time must be a UNIX timestamp. Unit: seconds. Example: 1600531564, which indicates 2020-09-20 00:06:04 (UTC+8).'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '1600531564'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0bc1411515937****', - ], - 'Data' => [ - 'description' => 'The basic metadata information.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the metadatabase.'."\n", - 'type' => 'string', - 'example' => 'hive', - ], - 'Comment' => [ - 'description' => 'The comment.'."\n", - 'type' => 'string', - 'example' => 'The ID of the compute engine instance. The ID is in the Engine type.Engine name format.'."\n", - ], - 'CreateTime' => [ - 'description' => 'The time when the compute engine instance was created.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1541576644000', - ], - 'ProjectId' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '22', - ], - 'ProjectName' => [ - 'description' => 'The name of the workspace.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'AppGuid' => [ - 'description' => 'The compute engine instance ID. Specify the ID in the `Engine type.Engine name` format.'."\n", - 'type' => 'string', - 'example' => 'odps.engine_name', - ], - 'OwnerName' => [ - 'description' => 'The name of the workspace owner.'."\n", - 'type' => 'string', - 'example' => '323', - ], - 'OwnerId' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the workspace owner.'."\n", - 'type' => 'string', - 'example' => '23', - ], - 'EnvType' => [ - 'description' => 'The type of the environment. Valid values: 0 and 1. The value 0 indicates the development environment. The value 1 indicates the production environment.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ProjectNameCn' => [ - 'description' => 'The display name of the workspace.'."\n", - 'type' => 'string', - 'example' => 'The storage path of the metadatabase of the EMR cluster.'."\n", - ], - 'Endpoint' => [ - 'description' => 'The endpoint of the service.'."\n", - 'type' => 'string', - 'example' => 'http://service.odpsstg.aliyun-inc.com/', - ], - 'ClusterBizId' => [ - 'description' => 'The EMR cluster ID.'."\n", - 'type' => 'string', - 'example' => 'abc', - ], - 'Name' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'example' => 'abc', - ], - 'Location' => [ - 'description' => 'The storage path of the metadatabase of the EMR cluster.'."\n", - 'type' => 'string', - 'example' => 'hdfs://', - ], - 'TenantId' => [ - 'description' => 'The tenant ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '233', - ], - 'ModifyTime' => [ - 'description' => 'The time when the compute engine instance was modified.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1541576644000', - ], - ], - ], + 'Success' => ['description' => 'Indicates whether the authorization was successful.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0000-ABCD-EF****'], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Invalid.Meta.AppNotExist', - 'errorMessage' => 'The MaxCompute project does not exist.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.CommonError', - 'errorMessage' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.Illegal', - 'errorMessage' => 'The app guid parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.IllegalDate', - 'errorMessage' => 'The date format is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.IllegalPageError', - 'errorMessage' => 'The parameter for paging is invalid.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.Meta.NoCalcEngine', - 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.NotExist', - 'errorMessage' => 'The data does not exist.', - ], - ], 403 => [ - [ - 'errorCode' => 'Forbidden.Meta.NoTenant', - 'errorMessage' => 'The user is not the owner of any tenants.', - ], - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], ], 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.Meta.TenantTimeOut', - 'errorMessage' => 'Failed to connect to the interface network.', - ], - [ - 'errorCode' => 'InternalError.Meta.Unknown', - 'errorMessage' => 'An unknown error occurred while processing your request.', - ], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0bc1411515937****\\",\\n \\"Data\\": {\\n \\"Type\\": \\"hive\\",\\n \\"Comment\\": \\"备注\\",\\n \\"CreateTime\\": 1541576644000,\\n \\"ProjectId\\": 22,\\n \\"ProjectName\\": \\"test\\",\\n \\"AppGuid\\": \\"odps.engine_name\\",\\n \\"OwnerName\\": \\"my_name\\",\\n \\"OwnerId\\": \\"userId\\",\\n \\"EnvType\\": 1,\\n \\"ProjectNameCn\\": \\"测试项目\\",\\n \\"Endpoint\\": \\"http://service.odpsstg.aliyun-inc.com/\\",\\n \\"ClusterBizId\\": \\"abc\\",\\n \\"Name\\": \\"abc\\",\\n \\"Location\\": \\"hdfs://\\",\\n \\"TenantId\\": 233,\\n \\"ModifyTime\\": 1541576644000\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 0bc1411515937****\\n \\n hive\\n 备注\\n 1541576644000\\n 22\\n test\\n odps.engine_name\\n 323\\n 23\\n 1\\n 测试项目\\n http://service.odpsstg.aliyun-inc.com/\\n abc\\n abc\\n hdfs://\\n 233\\n 1541576644000\\n \\n","errorExample":""}]', - 'title' => 'GetMetaDBInfo', - 'summary' => 'Queries the basic metadata information about a compute engine instance.', - 'description' => 'The ID of the EMR cluster. This parameter is required only if you set the DataSourceType parameter to emr.'."\n" - ."\n" - .'You can log on to the [EMR console](https://emr.console.aliyun.com/?spm=a2c4g.11186623.0.0.965cc5c2GeiHet#/cn-hangzhou) to obtain the ID of the EMR cluster.'."\n", + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0000-ABCD-EF****\\"\\n}","errorExample":""},{"type":"xml","example":"0000-ABCD-EFo****\\ntrue","errorExample":""}]', + 'title' => 'CreateDataServiceApiAuthority', + 'summary' => 'Grants the access permissions on an API in DataService Studio.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', - ], - 'GetMetaDBTableList' => [ - 'summary' => 'Queries metatables in a compute engine instance.', - 'methods' => [ - 'post', - 'get', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-10-10T02:04:50.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDataServiceApiAuthority'], + ], ], + 'ramActions' => [], + ], + 'CreateDataServiceFolder' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '78260', - 'abilityTreeNodes' => [ - 'FEATUREdideE9XYA6', - ], - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - 'maximum' => '1000', - 'minimum' => '1', - 'exclusiveMinimum' => false, - ], + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['description' => 'The tenant ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '10002'], ], [ - 'name' => 'AppGuid', - 'in' => 'query', - 'schema' => [ - 'description' => 'The GUID of the MaxCompute project. Specify the GUID in the `odps.{projectName}` format. You must configure this parameter only if you set the DataSourceType parameter to odps.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'odps.testProjectName', - ], + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the workspace.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '10001'], ], [ - 'name' => 'ClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The E-MapReduce (EMR) cluster ID. You must configure this parameter only if you set the DataSourceType parameter to emr.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], + 'name' => 'FolderName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the folder.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Test folder'."\n"], ], [ - 'name' => 'DatabaseName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the metadatabase.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], + 'name' => 'ParentId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the desired parent folder of the folder. The ID of the root folder in a workflow is 0. The ID of the folder created by users in a workflow is greater than 0.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '0'], ], [ - 'name' => 'DataSourceType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the data source. Valid values: odps and emr.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'odps', - ], + 'name' => 'GroupId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the desired workflow to which the folder belongs.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1000abcd'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0bc1ec92159376', - ], - 'Data' => [ - 'description' => 'The metatable information in a compute engine instance.'."\n", - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of compute engine instances returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'TableEntityList' => [ - 'description' => 'The list of metatables in the compute engine instance.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TableName' => [ - 'description' => 'The name of the metatable.'."\n", - 'type' => 'string', - 'example' => 'tname', - ], - 'TableGuid' => [ - 'description' => 'The GUID of the metatable.'."\n", - 'type' => 'string', - 'example' => 'odps.engine_name.tname', - ], - 'DatabaseName' => [ - 'description' => 'The name of the metadatabase.'."\n", - 'type' => 'string', - 'example' => 'abc', - ], - ], - ], - ], - ], - ], + 'FolderId' => ['description' => 'The ID of the created folder.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0000-ABCD-E****'], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Invalid.Meta.AppNotExist', - 'errorMessage' => 'The MaxCompute project does not exist.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.CommonError', - 'errorMessage' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.Illegal', - 'errorMessage' => 'The app guid parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.IllegalPageError', - 'errorMessage' => 'The parameter for paging is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.NotExist', - 'errorMessage' => 'The object does not exist.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.Meta.NoCalcEngine', - 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.', - ], - ], 403 => [ - [ - 'errorCode' => 'Forbidden.Meta.NoTenant', - 'errorMessage' => 'The user is not the owner of any tenants.', - ], - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], ], 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.Meta.TenantTimeOut', - 'errorMessage' => 'Failed to connect to the interface network.', - ], - [ - 'errorCode' => 'InternalError.Meta.Unknown', - 'errorMessage' => 'An unknown error occurred while processing your request.', - ], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 20,\\n \\"TableEntityList\\": [\\n {\\n \\"TableName\\": \\"tname\\",\\n \\"TableGuid\\": \\"odps.engine_name.tname\\",\\n \\"DatabaseName\\": \\"abc\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 0bc1ec92159376\\n \\n 1\\n 10\\n 20\\n \\n tname\\n odps.engine_name.tname\\n abc\\n \\n \\n","errorExample":""}]', - 'title' => 'GetMetaDBTableList', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"FolderId\\": 123,\\n \\"RequestId\\": \\"0000-ABCD-E****\\"\\n}","errorExample":""},{"type":"xml","example":"0000-ABCD-E****\\n123","errorExample":""}]', + 'title' => 'CreateDataServiceFolder', + 'summary' => 'Creates a folder in DataService Studio.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', - ], - 'CheckMetaTable' => [ - 'methods' => [ - 'post', - 'get', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-10-09T02:53:21.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-10-09T02:20:41.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDataServiceFolder'], + ], ], + 'ramActions' => [], + ], + 'CreateDataServiceGroup' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '78173', - 'abilityTreeNodes' => [ - 'FEATUREdideYZD64M', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '78182', + 'abilityTreeNodes' => ['FEATUREdide7T0EJX'], ], 'parameters' => [ [ - 'name' => 'TableGuid', - 'in' => 'query', - 'schema' => [ - 'description' => 'The GUID of the metatable.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'odps.engine_name.table_name', - ], + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['description' => 'The tenant ID. This parameter is deprecated.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '10002', 'title' => ''], ], [ - 'name' => 'ClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The E-MapReduce (EMR) cluster ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the workspace.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '10001', 'title' => ''], ], [ - 'name' => 'DatabaseName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the metadatabase of the EMR cluster.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], + 'name' => 'ApiGatewayGroupId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the API group that is associated with the business process in the API Gateway console. You can log on to the API Gateway console and go to the Group Details page to view the ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1000abcd', 'title' => ''], ], [ - 'name' => 'TableName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the EMR metatable.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], + 'name' => 'GroupName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the business process.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Workflow name', 'title' => ''], ], [ - 'name' => 'DataSourceType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the data source. Valid values: odps and emr.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'emr', - ], + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['description' => 'The description of the business process.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'Test workflow', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The returned results.'."\n", 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => 'Indicates whether the metatable exists.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0bc1ec92159376', - ], + 'GroupId' => ['description' => 'The business process ID.'."\n", 'type' => 'string', 'example' => 'ds_12345', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0000-ABCD-EF****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Invalid.Meta.TableNotExist', - 'errorMessage' => 'The table does not exist.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.Illegal', - 'errorMessage' => 'The app guid parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.NotExist', - 'errorMessage' => 'The object does not exist.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.Meta.NoCalcEngine', - 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.', - ], - ], 403 => [ - [ - 'errorCode' => 'Forbidden.Meta.NoTenant', - 'errorMessage' => 'The user is not the owner of any tenants.', - ], - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], ], 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.Meta.TenantTimeOut', - 'errorMessage' => 'Failed to connect to the interface network.', - ], - [ - 'errorCode' => 'InternalError.Meta.Unknown', - 'errorMessage' => 'An unknown error occurred while processing your request.', - ], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"0bc1ec92159376\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 0bc1ec92159376\\n","errorExample":""}]', - 'title' => 'CheckMetaTable', - 'summary' => 'Checks whether a metatable exists.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - ], - 'CheckMetaPartition' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"GroupId\\": \\"ds_12345\\",\\n \\"RequestId\\": \\"0000-ABCD-EF****\\"\\n}","type":"json"}]', + 'title' => 'CreateDataServiceGroup', + 'summary' => 'Creates a business process.', + 'changeSet' => [ + ['createdAt' => '2023-10-10T02:04:50.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDataServiceGroup'], + ], + ], + 'ramActions' => [], + ], + 'CreateDataSource' => [ + 'summary' => 'Adds a data source to DataWorks.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '78172', - 'abilityTreeNodes' => [ - 'FEATUREdideYZD64M', - ], + 'operationType' => 'create', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdide7FTVFZ'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'TableGuid', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => 'The GUID of the MaxCompute metatable.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'odps.engine_name.table_name', - ], + 'schema' => ['description' => 'The ID of the DataWorks workspace to which the data source belongs. You can call the [ListProjects](~~2780068~~) operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Partition', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the partition in the MaxCompute metatable.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ds=202005', - ], + 'schema' => ['description' => 'The name of the data source.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'abc', 'title' => ''], ], [ - 'name' => 'ClusterId', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter is deprecated.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], + 'schema' => ['description' => 'The description of the data source.'."\n", 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''], ], [ - 'name' => 'DatabaseName', + 'name' => 'DataSourceType', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the metadatabase.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], + 'schema' => ['description' => 'The type of the data source. Valid values:'."\n" + ."\n" + .'* odps'."\n" + .'* mysql'."\n" + .'* rds'."\n" + .'* oss'."\n" + .'* sqlserver'."\n" + .'* polardb'."\n" + .'* oracle'."\n" + .'* mongodb'."\n" + .'* emr'."\n" + .'* postgresql'."\n" + .'* analyticdb_for_mysql'."\n" + .'* hybriddb_for_postgresql'."\n" + .'* holo'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'rds', 'title' => ''], ], [ - 'name' => 'TableName', + 'name' => 'SubType', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the metatable.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], + 'schema' => ['description' => 'The subtype of the data source.'."\n" + ."\n" + .'* This parameter takes effect only if you set the DataSourceType parameter to rds.'."\n" + .'* If the DataSourceType parameter is set to rds, this parameter can be set to mysql, sqlserver, or postgresql.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mysql', 'title' => ''], ], [ - 'name' => 'DataSourceType', + 'name' => 'EnvType', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the data source. Set the value to odps.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'emr', - ], + 'schema' => ['description' => 'The environment in which the data source is used. Valid values: 0 and 1. The value 0 indicates the development environment. The value 1 indicates the production environment.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Content', + 'in' => 'query', + 'schema' => ['description' => 'The details of the data source. Examples of details of some common data sources:'."\n" + ."\n" + .'* odps'."\n" + ."\n" + .' {'."\n" + .' "accessId": "*****",'."\n" + .' "accessKey": "*****",'."\n" + .' "authType": 2,'."\n" + .' "endpoint": "http://service.odps.aliyun.com/api",'."\n" + .' "project": "xsaxsax",'."\n" + .' "tag": "public"'."\n" + .' }'."\n" + ."\n" + .'* mysql'."\n" + ."\n" + .' {'."\n" + .' "database": "xsaxsa",'."\n" + .' "instanceName": "rm-xsaxsa",'."\n" + .' "password": "xsaxsa",'."\n" + .' "rdsOwnerId": "xasxsa",'."\n" + .' "regionId": "cn-shanghai",'."\n" + .' "tag": "rds",'."\n" + .' "username": "xsaxsa"'."\n" + .' }'."\n" + ."\n" + .'* rds'."\n" + ."\n" + .' {'."\n" + .' "configType": 1,'."\n" + .' "tag": "rds",'."\n" + .' "database": "xsaxsa",'."\n" + .' "username": "xsaxsa",'."\n" + .' "password": "xssaxsa$32050",'."\n" + .' "instanceName": "rm-xsaxs",'."\n" + .' "rdsOwnerId": "11111111"'."\n" + .' }'."\n" + ."\n" + .'* oss'."\n" + ."\n" + .' {'."\n" + .' "accessId": "*****",'."\n" + .' "accessKey": "*****",'."\n" + .' "bucket": "xsa-xs-xs",'."\n" + .' "endpoint": "http://oss-cn-shanghai.aliyuncs.com",'."\n" + .' "tag": "public"'."\n" + .' }'."\n" + ."\n" + .'* sqlserver'."\n" + ."\n" + .' {'."\n" + .' "jdbcUrl": "jdbc:sqlserver://xsaxsa-xsaxsa.database.xxx.cn:123;DatabaseName=xsxs-xsxs",'."\n" + .' "password": "sdasda$fs",'."\n" + .' "tag": "public",'."\n" + .' "username": "sxaxacdacdd"'."\n" + .' }'."\n" + ."\n" + .'* polardb'."\n" + ."\n" + .' {'."\n" + .' "clusterId": "pc-sdadsadsa",'."\n" + .' "database": "dsadsadsa",'."\n" + .' "ownerId": "121212122",'."\n" + .' "password": "sdasdafssa",'."\n" + .' "region": "cn-shanghai",'."\n" + .' "tag": "polardb",'."\n" + .' "username": "asdadsads"'."\n" + .' }'."\n" + ."\n" + .'* redis'."\n" + ."\n" + .' { '."\n" + .' "password": "xxxxxx", '."\n" + .' "address":"[{\\"host\\":\\"xxxxxxx.redis.rds.aliyuncs.com\\",\\"port\\":6379}]", '."\n" + .' "tag": "public"'."\n" + .' }'."\n" + ."\n" + .'* oracle'."\n" + ."\n" + .' {'."\n" + .' "jdbcUrl": "jdbc:oracle:saaa:@xxxxx:1521:PROD",'."\n" + .' "password": "sxasaxsa",'."\n" + .' "tag": "public",'."\n" + .' "username": "sasfadfa"'."\n" + .' }'."\n" + ."\n" + .'* mongodb'."\n" + ."\n" + .' {'."\n" + .' "address": "[\\"xsaxxsa.mongodb.rds.aliyuncs.com:3717\\"]",'."\n" + .' "database": "admin",'."\n" + .' "password": "sadsda@",'."\n" + .' "tag": "public",'."\n" + .' "username": "dsadsadas"'."\n" + .' }'."\n" + ."\n" + .'* emr'."\n" + ."\n" + .' {'."\n" + .' "accessId": "*****",'."\n" + .' "emrClusterId": "C-dsads",'."\n" + .' "emrResourceQueueName": "default",'."\n" + .' "emrEndpoint": "emr.aliyuncs.com",'."\n" + .' "accessKey": "*****",'."\n" + .' "emrUserId": "224833315798889783",'."\n" + .' "name": "sasdsadsa",'."\n" + .' "emrAccessMode": "simple",'."\n" + .' "region": "cn-shanghai",'."\n" + .' "authType": "2",'."\n" + .' "emrProjectId": "FP-sdadsad"'."\n" + .' }'."\n" + ."\n" + .'* postgresql'."\n" + ."\n" + .' {'."\n" + .' "jdbcUrl": "jdbc:postgresql://xxxx:1921/ssss",'."\n" + .' "password": "sdadsads",'."\n" + .' "tag": "public",'."\n" + .' "username": "sdsasda"'."\n" + .' }'."\n" + ."\n" + .'* analyticdb_for_mysql'."\n" + ."\n" + .' {'."\n" + .' "instanceId": "am-sadsada",'."\n" + .' "database": "xsxsx",'."\n" + .' "username": "xsxsa",'."\n" + .' "password": "asdadsa",'."\n" + .' "connectionString": "am-xssxsxs.ads.aliyuncs.com:3306"'."\n" + .' }'."\n" + ."\n" + .'* hybriddb_for_postgresql'."\n" + ."\n" + .' {'."\n" + .' "connectionString": "gp-xsaxsaxa-master.gpdbmaster.rds.aliyuncs.com",'."\n" + .' "database": "xsaxsaxas",'."\n" + .' "password": "xsaxsaxsa@11",'."\n" + .' "instanceId": "gp-xsaxsaxsa",'."\n" + .' "port": "541132",'."\n" + .' "ownerId": "xsaxsaxsas",'."\n" + .' "username": "sadsad"'."\n" + .' }'."\n" + ."\n" + .'* holo'."\n" + ."\n" + .' {'."\n" + .' "accessId": "*****",'."\n" + .' "accessKey": "*****",'."\n" + .' "database": "xsaxsaxsa",'."\n" + .' "instanceId": "xsaxa",'."\n" + .' "tag": "aliyun"'."\n" + .' }'."\n" + ."\n" + .'* kafka'."\n" + ."\n" + .' {'."\n" + .' "instanceId": "xsax-cn-xsaxsa",'."\n" + .' "regionId": "cn-shanghai",'."\n" + .' "tag": "aliyun",'."\n" + .' "ownerId": "1212121212112"'."\n" + .' }'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"database":"dbname","instanceName":"instancename","password":"password","rdsOwnerId":"123","username":"username"}', 'title' => ''], ], ], 'responses' => [ @@ -5541,2070 +3482,1275 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'Indicates whether the partition in the MaxCompute metatable exists. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0bc1ec92159376', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The data source ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0bc141151593763****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Invalid.Meta.TableNotExist', - 'errorMessage' => 'The table does not exist.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.CommonError', - 'errorMessage' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.Illegal', - 'errorMessage' => 'The app guid parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.NotExist', - 'errorMessage' => 'The object does not exist.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.Meta.NoCalcEngine', - 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.', - ], + ['errorCode' => 'Invalid.Tenant.ConnectionNotExists', 'errorMessage' => 'The connection does not exist.', 'description' => 'The connection does not exist.'], + ['errorCode' => 'Invalid.Tenant.ProjectNotExists', 'errorMessage' => 'The project does not exist.', 'description' => 'The project does not exist.'], + ['errorCode' => 'Invalid.Tenant.UserNotInProject', 'errorMessage' => 'The user is not in the project.', 'description' => 'The user is not in the project.'], + ['errorCode' => 'ConnectionAlreadyExist', 'errorMessage' => 'The connection with envType %s and name %s already exists.', 'description' => 'ConnectionAlreadyExist'], + ['errorCode' => 'DataSource.CheckRamRoleFailure', 'errorMessage' => 'Failed to check the RAM role. AccountId %s. roleArn %s.', 'description' => ''], + ['errorCode' => 'DataSource.ConnectionStrProperty.PatternNotMatch', 'errorMessage' => 'The pattern value %s is invalid. The correct pattern is %s.', 'description' => ''], + ['errorCode' => 'Invalid.DataSource.DataSourceTypeNotSupport', 'errorMessage' => 'The dataSourceType %s and subType %s are not supported.', 'description' => 'DataSource type not support yet.'], + ['errorCode' => 'Invalid.Param.Odps.EngineIdOrConnectStrEmpty', 'errorMessage' => 'Either the compute engine ID or the connection string must be specified when data source type is ODPS.', 'description' => ''], + ['errorCode' => 'MissingParam.ConnectionStr.Property', 'errorMessage' => 'You must specify property %s required by the data source connection string.', 'description' => 'The data source connection str required property missing. '], + ['errorCode' => 'Invalid.DataSource.DataSourceTypeNotExist', 'errorMessage' => 'The data source type %s does not exist.', 'description' => 'The dataSource type %s are not exist.'], ], 403 => [ - [ - 'errorCode' => 'Forbidden.Meta.NoTenant', - 'errorMessage' => 'The user is not the owner of any tenants.', - ], - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.Meta.TenantTimeOut', - 'errorMessage' => 'Failed to connect to the interface network.', - ], - [ - 'errorCode' => 'InternalError.Meta.Unknown', - 'errorMessage' => 'An unknown error occurred while processing your request.', - ], + ['errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin', 'errorMessage' => 'The user is not a project administrator or owner.', 'description' => 'The user is not a project administrator or owner.'], + ['errorCode' => 'Invalid.Tenant.UserNotInTenant', 'errorMessage' => 'The user is not in tenant.', 'description' => 'The user is not in tenant.'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n true\\n 0bc1ec92159376\\n The connection does not exist.\\n Invalid.Tenant.ConnectionNotExists\\n true\\n","errorExample":""}]', - 'title' => 'CheckMetaPartition', - 'summary' => 'Checks whether a partition in a MaxCompute metatable exists.', + 'title' => 'CreateDataSource', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', - ], - 'SearchMetaTables' => [ - 'summary' => 'Queries metatables based on specific conditions.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": 123,\\n \\"RequestId\\": \\"0bc141151593763****\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'CreateExportMigration' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '78351', - 'abilityTreeNodes' => [ - 'FEATUREdideE9OA4H', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '86657', + 'abilityTreeNodes' => ['FEATUREdide8FM783'], ], 'parameters' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the workspace ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12345'], ], [ - 'name' => 'AppGuid', - 'in' => 'query', - 'schema' => [ - 'description' => 'The GUID of the workspace where the metatables reside.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'odps.engine_name', - ], + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the export task.'."\n" + ."\n" + .'The name of each export task must be unique. You must ensure that no duplicate export task exists in the current workspace.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test_export_01'], ], [ - 'name' => 'Keyword', - 'in' => 'query', + 'name' => 'ExportMode', + 'in' => 'formData', 'schema' => [ - 'description' => 'The keyword based on which metatables are queried. During the query, the system tokenizes the names of metatables and matches the names with the keyword. If no name is matched, the value null is returned. By default, the system uses underscores (\\_) to tokenize the names.'."\n", + 'description' => 'The export mode of the export task. Valid values:'."\n" + ."\n" + .'* FULL: The export task is used to export all data objects.'."\n" + .'* INCREMENTAL: The export task is used to export data objects that were modified since the specified point in time. If you set this parameter to INCREMENTAL, you must configure the IncrementalSince parameter.'."\n", 'type' => 'string', 'required' => true, - 'docRequired' => true, - 'example' => 'test', + 'example' => 'FULL', + 'enum' => ['FULL', 'INCREMENTAL'], ], ], [ - 'name' => 'EntityType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the metatables. Valid values: 0 and 1. The value 0 indicates that tables are queried. The value 1 indicates that views are queried. If you do not configure this parameter, all types of metatables are queried.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'name' => 'IncrementalSince', + 'in' => 'formData', + 'schema' => ['description' => 'The start time of the incremental export task.'."\n" + ."\n" + .'The IncrementalSince parameter takes effect only when the ExportMode parameter is set to INCREMENTAL.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1589904000000'], ], [ - 'name' => 'ClusterId', - 'in' => 'query', + 'name' => 'ExportObjectStatus', + 'in' => 'formData', 'schema' => [ - 'description' => 'The ID of the EMR cluster. This parameter is required only if you set the DataSourceType parameter to emr.'."\n" + 'description' => 'The status of the data objects that you want to export in the export task. The system exports data objects in the state that is specified by this parameter. Valid values:'."\n" ."\n" - .'You can log on to the [EMR console](https://emr.console.aliyun.com/?spm=a2c4g.11186623.0.0.965cc5c2GeiHet#/cn-hangzhou) to obtain the ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], - ], - [ - 'name' => 'DataSourceType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the data source. Valid values: odps and emr.'."\n", + .'* SAVED'."\n" + .'* SUBMITTED'."\n" + .'* DEPLOYED'."\n", 'type' => 'string', 'required' => false, - 'docRequired' => true, - 'example' => 'emr', + 'example' => 'SAVED', + 'default' => 'SAVED', + 'enum' => ['SAVED', 'SUBMITTED', 'DEPLOYED'], ], ], [ - 'name' => 'Schema', - 'in' => 'query', - 'schema' => [ - 'description' => 'The schema information of the table. You must configure this parameter if you enable the three-layer model of MaxCompute.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['description' => 'The description of the export task.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'description' => 'The returned result.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified parameters are invalid.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0bc1ec92159376****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '1031203110005', - ], - 'Data' => [ - 'description' => 'The search results.'."\n", - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of metatables.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'DataEntityList' => [ - 'description' => 'The list of metatables.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TableName' => [ - 'description' => 'The name of the metatable.'."\n", - 'type' => 'string', - 'example' => 'test_name', - ], - 'DatabaseName' => [ - 'description' => 'The name of the metadatabase.'."\n", - 'type' => 'string', - 'example' => 'abc', - ], - 'EntityType' => [ - 'description' => 'The type of the metatable. Valid values:'."\n" - ."\n" - .'* 0: table'."\n" - .'* 1: view'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ProjectName' => [ - 'description' => 'The name of the workspace.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'ProjectId' => [ - 'description' => 'The ID of the workspace.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '323', - ], - 'TableGuid' => [ - 'description' => 'The GUID of the metatable.'."\n", - 'type' => 'string', - 'example' => 'odps.engine_name.test_name', - ], - 'OwnerId' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the workspace owner.'."\n", - 'type' => 'string', - 'example' => '123', - ], - 'ClusterId' => [ - 'description' => 'The ID of the EMR cluster.'."\n", - 'type' => 'string', - 'example' => 'abc', - ], - 'EnvType' => [ - 'description' => 'The type of the environment. Valid values:'."\n" - ."\n" - .'* 1: production environment'."\n" - .'* 0: development environment'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TenantId' => [ - 'description' => 'The tenant ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12345', - ], - 'Schema' => [ - 'description' => 'The schema information of the table. You must configure this parameter if you enable the three-layer model of MaxCompute.'."\n", - 'type' => 'string', - 'example' => 'default', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", 'type' => 'string', 'example' => '34267E2E-0335-1A60-A1F0-ADA530890CBA'], + 'Data' => ['description' => 'The export task ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Invalid.Meta.TableNotExist', - 'errorMessage' => 'The table does not exist.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.CommonError', - 'errorMessage' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.Illegal', - 'errorMessage' => 'The app guid parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.IllegalDate', - 'errorMessage' => 'The date format is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.IllegalPageError', - 'errorMessage' => 'The parameter for paging is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.NotExist', - 'errorMessage' => 'The object does not exist.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.Meta.NoCalcEngine', - 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.', - ], - ], - 403 => [ - [ - 'errorCode' => 'ResourceNotAuthorized.Api', - 'errorMessage' => 'You are not authorized to access the resources.', - ], - [ - 'errorCode' => 'Forbidden.Meta.NoTenant', - 'errorMessage' => 'The user is not the owner of any tenants.', - ], - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.Meta.TenantTimeOut', - 'errorMessage' => 'Failed to connect to the interface network.', - ], - [ - 'errorCode' => 'InternalError.Meta.Unknown', - 'errorMessage' => 'An unknown error occurred while processing your request.', - ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"34267E2E-0335-1A60-A1F0-ADA530890CBA\\",\\n \\"Data\\": 1234,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 34267E2E-0335-1A60-A1F0-ADA530890CBA\\n 1234\\n true\\n","errorExample":""}]', + 'title' => 'CreateExportMigration', + 'summary' => 'Creates an export task. You can use this operation to create an export task but cannot use this operation to start the created export task.', + 'changeSet' => [ + ['createdAt' => '2021-11-16T06:51:50.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateExportMigration'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"RequestId\\": \\"0bc1ec92159376****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"DataEntityList\\": [\\n {\\n \\"TableName\\": \\"test_name\\",\\n \\"DatabaseName\\": \\"abc\\",\\n \\"EntityType\\": 0,\\n \\"ProjectName\\": \\"test\\",\\n \\"ProjectId\\": 323,\\n \\"TableGuid\\": \\"odps.engine_name.test_name\\",\\n \\"OwnerId\\": \\"123\\",\\n \\"ClusterId\\": \\"abc\\",\\n \\"EnvType\\": 1,\\n \\"TenantId\\": 12345,\\n \\"Schema\\": \\"default\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n The specified parameters are invalid.\\n 0bc1ec92159376****\\n true\\n 1031203110005\\n \\n 1\\n 10\\n 100\\n \\n test_name\\n abc\\n 0\\n test\\n 323\\n odps.engine_name.test_name\\n 123\\n abc\\n 1\\n 12345\\n default\\n \\n \\n","errorExample":""}]', - 'title' => 'SearchMetaTables', - 'description' => 'You can call this operation to query only metatables in a MaxCompute or E-MapReduce (EMR) compute engine.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', + 'ramActions' => [], ], - 'GetMetaTableBasicInfo' => [ - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateFile' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '78261', - 'abilityTreeNodes' => [ - 'FEATUREdideRZEBFC', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '78185', + 'abilityTreeNodes' => ['FEATUREdideHO4TQP', 'FEATUREdide8FM783'], ], 'parameters' => [ [ - 'name' => 'TableGuid', - 'in' => 'query', + 'name' => 'FileFolderPath', + 'in' => 'formData', + 'schema' => ['description' => 'The path of the file.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'Business_process/First_Business_Process/MaxCompute/Folder_1/Folder_2', 'title' => ''], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace Management page to obtain the workspace ID.'."\n" + ."\n" + .'You must configure this parameter or the ProjectIdentifier parameter to determine the DataWorks workspace to which the operation is applied.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '10000', 'title' => ''], + ], + [ + 'name' => 'FileName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the file.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'File name', 'title' => ''], + ], + [ + 'name' => 'FileDescription', + 'in' => 'formData', + 'schema' => ['description' => 'The description of the file.', 'type' => 'string', 'example' => 'This is a file description.', 'required' => false, 'docRequired' => false, 'maxLength' => 200, 'title' => ''], + ], + [ + 'name' => 'FileType', + 'in' => 'formData', + 'schema' => ['description' => 'The type of the code for the file. The code for files varies based on the file type. For more information, see [DataWorks nodes](~~600169~~).'."\n" + ."\n" + .'You can call the [ListFileType](~~212428~~) operation to query the type of the code for the file.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the Alibaba Cloud account used by the file owner. If this parameter is not configured, the ID of the Alibaba Cloud account of the user who calls the operation is used.', 'type' => 'string', 'required' => false, 'example' => '1000000000001', 'title' => ''], + ], + [ + 'name' => 'Content', + 'in' => 'formData', + 'schema' => ['description' => 'The code for the file. The code format varies based on the file type. To view the code format for a specific file type, go to Operation Center, right-click a node of the file type, and then select View Code.', 'type' => 'string', 'required' => false, 'example' => 'SHOW TABLES;', 'title' => ''], + ], + [ + 'name' => 'AutoRerunTimes', + 'in' => 'formData', + 'schema' => ['description' => 'The number of automatic reruns that are allowed after an error occurs. Maximum value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'AutoRerunIntervalMillis', + 'in' => 'formData', + 'schema' => ['description' => 'The interval between automatic reruns after an error occurs. Unit: milliseconds. Maximum value: 1800000 (30 minutes).'."\n" + ."\n" + .'This parameter corresponds to the Rerun Interval parameter that is displayed after the Auto Rerun upon Error check box is selected in the Schedule section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n" + ."\n" + .'The interval that you specify in the DataWorks console is measured in minutes. Pay attention to the conversion between the units of time when you call the operation.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '120000', 'title' => ''], + ], + [ + 'name' => 'RerunMode', + 'in' => 'formData', 'schema' => [ - 'description' => 'The GUID of the MaxCompute table. Specify the GUID in the odps.projectName.tableName format.'."\n" + 'description' => 'Specifies whether the node that corresponds to the file can be rerun. Valid values:'."\n" + ."\n" + .'- ALL\\_ALLOWED: The node can be rerun regardless of whether it is successfully run or fails to run.'."\n" + ."\n" + .'- FAILURE\\_ALLOWED: The node can be rerun only after it fails to run.'."\n" ."\n" - .'> This parameter is optional for E-MapReduce (EMR) tables.'."\n", + .'- ALL\\_DENIED: The node cannot be rerun regardless of whether it is successfully run or fails to run.'."\n" + ."\n" + .'This parameter corresponds to the Rerun parameter in the Schedule section of the Properties tab on the DataStudio page in the [DataWorks console](https://workbench.data.aliyun.com/console).', + 'enumValueTitles' => [], 'type' => 'string', 'required' => false, - 'docRequired' => true, - 'example' => 'odps.engine_name.table_name', + 'default' => 'ALL_ALLOWED', + 'enum' => ['ALL_ALLOWED', 'FAILURE_ALLOWED', 'ALL_DENIED'], + 'example' => 'ALL_ALLOWED', + 'title' => '', ], ], [ - 'name' => 'ClusterId', - 'in' => 'query', + 'name' => 'Stop', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to suspend the scheduling of the node. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false'."\n" + ."\n" + .'This parameter corresponds to the Recurrence parameter in the Schedule section of the Properties tab on the DataStudio page in the [DataWorks console](https://workbench.data.aliyun.com/console).', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'ParaValue', + 'in' => 'formData', + 'schema' => ['description' => 'The scheduling parameters of the node. Separate multiple parameters with spaces.'."\n" + ."\n" + .'This parameter corresponds to the Parameters section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console). For more information about the configurations of the scheduling parameters, see [Configure scheduling parameters](~~137548~~).', 'type' => 'string', 'required' => false, 'example' => 'a=x b=y', 'title' => ''], + ], + [ + 'name' => 'StartEffectDate', + 'in' => 'formData', + 'schema' => ['description' => 'The start time of automatic scheduling. Set the value to a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n" + ."\n" + .'Configuring this parameter is equivalent to specifying a start time for the Validity Period parameter in the Schedule section of the Properties tab on the DataStudio page in the [DataWorks console](https://workbench.data.aliyun.com/console).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'minimum' => '0', 'default' => '0', 'example' => '1671608450000', 'title' => ''], + ], + [ + 'name' => 'EndEffectDate', + 'in' => 'formData', + 'schema' => ['description' => 'The end time of automatic scheduling. Set the value to a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n" + ."\n" + .'This parameter corresponds to the Validity Period parameter in the Schedule section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'minimum' => '0', 'example' => '1671694850000', 'title' => ''], + ], + [ + 'name' => 'CronExpress', + 'in' => 'formData', + 'schema' => ['description' => 'The CRON expression that represents the periodic scheduling policy of the node. This parameter corresponds to the Cron Expression parameter in the Schedule section of the Properties tab on the DataStudio page in the [DataWorks console](https://workbench.data.aliyun.com/console). After you configure the Scheduling Cycle and Scheduled time parameters in the DataWorks console, DataWorks generates the value of the Cron Expression parameter.'."\n" + ."\n" + .'Examples:'."\n" + ."\n" + .'- CRON expression for a node that is scheduled to run at 05:30 every day: `00 30 05 * * ?`'."\n" + ."\n" + .'- CRON expression for a node that is scheduled to run at the fifteenth minute of each hour: `00 15 00-23/1 * * ?`'."\n" + ."\n" + .'- CRON expression for a node that is scheduled to run every 10 minutes: `00 00/10 * * * ?`'."\n" + ."\n" + .'- CRON expression for a node that is scheduled to run every 10 minutes from 08:00 to 17:00 every day: `00 00-59/10 8-17 * * * ?`'."\n" + ."\n" + .'- CRON expression for a node that is scheduled to run at 00:20 on the first day of each month: `00 20 00 1 * ?`'."\n" + ."\n" + .'- CRON expression for a node that is scheduled to run every three months from 00:10 on January 1: `00 10 00 1 1-12/3 ?`'."\n" + ."\n" + .'- CRON expression for a node that is scheduled to run at 00:05 every Tuesday and Friday: `00 05 00 * * 2,5`'."\n" + ."\n" + .'The scheduling system of DataWorks imposes the following limits on CRON expressions:'."\n" + ."\n" + .'- The minimum interval specified in a CRON expression to schedule a node is 5 minutes.'."\n" + ."\n" + .'- The earliest time specified in a CRON expression to schedule a node every day is 00:05.', 'type' => 'string', 'required' => false, 'default' => 'day', 'example' => '00 05 00 * * ?', 'title' => ''], + ], + [ + 'name' => 'CycleType', + 'in' => 'formData', 'schema' => [ - 'description' => 'The ID of the EMR cluster. This parameter is required only if you set the DataSourceType parameter to emr.'."\n" + 'description' => 'The type of the scheduling cycle of the node that corresponds to the file. Valid values: NOT\\_DAY and DAY. The value NOT\\_DAY indicates that the node is scheduled to run by minute or hour. The value DAY indicates that the node is scheduled to run by day, week, or month.'."\n" ."\n" - .'You can log on to the [EMR console](https://emr.console.aliyun.com/?spm=a2c4g.11186623.0.0.965cc5c2GeiHet#/cn-hangzhou) to query the ID.'."\n", + .'This parameter corresponds to the Scheduling Cycle parameter in the Schedule section of the Properties tab on the DataStudio page in the [DataWorks console](https://workbench.data.aliyun.com/console).', + 'enumValueTitles' => [], 'type' => 'string', 'required' => false, - 'example' => 'abc', + 'default' => 'DAY', + 'enum' => ['DAY', 'NOT_DAY'], + 'example' => 'DAY', + 'title' => '', ], ], [ - 'name' => 'DatabaseName', - 'in' => 'query', + 'name' => 'DependentType', + 'in' => 'formData', 'schema' => [ - 'description' => 'The name of the metadatabase. This parameter is required only if you set the DataSourceType parameter to emr.'."\n" + 'description' => 'The type of the cross-cycle scheduling dependency of the node. Valid values:'."\n" + ."\n" + .'- SELF: The instance generated for the node in the current cycle depends on the instance generated for the node in the previous cycle.'."\n" + ."\n" + .'- CHILD: The instance generated for the node in the current cycle depends on the instances generated for the descendant nodes at the nearest level of the node in the previous cycle.'."\n" + ."\n" + .'- USER\\_DEFINE: The instance generated for the node in the current cycle depends on the instances generated for one or more specified nodes in the previous cycle.'."\n" + ."\n" + .'- NONE: No cross-cycle scheduling dependency type is selected for the node.'."\n" + ."\n" + .'- USER\\_DEFINE\\_AND\\_SELF: The instance generated for the node in the current cycle depends on the instance generated for the node in the previous cycle and the instances generated for one or more specified nodes in the previous cycle.'."\n" ."\n" - .'You can call the [ListMetaDB](~~2780105~~) operation to query the name.'."\n", + .'- CHILD\\_AND\\_SELF: The instance generated for the node in the current cycle depends on the instances generated for the descendant nodes at the nearest level of the node in the previous cycle and the instance generated for the node in the previous cycle.', + 'enumValueTitles' => [], 'type' => 'string', 'required' => false, - 'example' => 'abc', + 'default' => 'NONE', + 'enum' => ['NONE', 'USER_DEFINE', 'CHILD', 'SELF', 'USER_DEFINE_AND_SELF', 'CHILD_AND_SELF'], + 'example' => 'NONE', + 'title' => '', ], ], [ - 'name' => 'TableName', - 'in' => 'query', + 'name' => 'DependentNodeIdList', + 'in' => 'formData', + 'schema' => ['description' => 'The IDs of the nodes that generate instances in the previous cycle on which the current node depends.', 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''], + ], + [ + 'name' => 'InputList', + 'in' => 'formData', + 'schema' => ['description' => 'The output name of the parent file on which the current file depends. If you specify multiple output names, separate them with commas (,).'."\n" + ."\n" + .'This parameter corresponds to the Output Name parameter under Parent Nodes in the Dependencies section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'project_root,project.file1,project.001_out', 'title' => ''], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace Management page to obtain the workspace name.'."\n" + ."\n" + .'You must configure this parameter or the ProjectId parameter to determine the DataWorks workspace to which the operation is applied.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'dw_project', 'title' => ''], + ], + [ + 'name' => 'ResourceGroupIdentifier', + 'in' => 'formData', + 'schema' => ['description' => 'The identifier of the resource group that is used to run the node. You can call the [ListResourceGroups](~~173913~~) operation to query the available resource groups in the workspace. The **Identifier** parameter in the response of the operation indicates the identifier of an available resource group.'."\n" + ."\n" + .'> You must make sure that the available resource groups in the response of the ListResourceGroups operation are associated with the workspace for which you want to create a file by calling the CreateFile operation.', 'type' => 'string', 'required' => false, 'example' => 'group_375827434852437', 'title' => ''], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => ['description' => 'This parameter is deprecated. Do not use this parameter.'."\n" + ."\n" + .'The identifier of the resource group that is used to run the node. This parameter corresponds to the Resource Group parameter in the Resource Group section of the Properties tab in the DataWorks console. You must configure one of the ResourceGroupId and ResourceGroupIdentifier parameters to determine the resource group that is used to run the node.'."\n" + ."\n" + .'You can call the [ListResourceGroups](~~173913~~) operation to query the available resource groups in the workspace. When you call the operation, set the ResourceGroupType parameter to 1. The response parameter Id indicates the ID of an available resource group.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '375827434852437', 'title' => ''], + ], + [ + 'name' => 'ConnectionName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the data source for which the node is run.'."\n" + ."\n" + .'You can call the [UpdateDataSource](~~211432~~) operation to query the available data sources in the workspace.', 'type' => 'string', 'required' => false, 'example' => 'odps_source', 'title' => ''], + ], + [ + 'name' => 'AutoParsing', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to enable the automatic parsing feature for the file. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false'."\n" + ."\n" + .'This parameter corresponds to the Analyze Code parameter that is displayed after Same Cycle is selected in the Dependencies section of the Properties tab on the DataStudio page in the [DataWorks console](https://workbench.data.aliyun.com/console).', 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'default' => 'true', 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'SchedulerType', + 'in' => 'formData', 'schema' => [ - 'description' => 'The name of the metatable in the EMR cluster. This parameter is required only if you set the DataSourceType parameter to emr.'."\n" + 'description' => 'The scheduling type of the node. Valid values:'."\n" + ."\n" + .'- NORMAL: The node is an auto triggered node.'."\n" + ."\n" + .'- MANUAL: The node is a manually triggered node. Manually triggered nodes cannot be automatically triggered. They correspond to the nodes in the Manually Triggered Workflows pane.'."\n" + ."\n" + .'- PAUSE: The node is a paused node.'."\n" ."\n" - .'You can call the [GetMetaDBTableList](~~2780086~~) operation to query the name.'."\n", + .'- SKIP: The node is a dry-run node. Dry-run nodes are started as scheduled, but the system sets the status of the nodes to successful when it starts to run them', + 'enumValueTitles' => [], 'type' => 'string', 'required' => false, - 'example' => 'abc', + 'docRequired' => false, + 'enum' => ['NORMAL', 'MANUAL', 'PAUSE', 'SKIP'], + 'example' => 'NORMAL', + 'title' => '', ], ], [ - 'name' => 'DataSourceType', - 'in' => 'query', + 'name' => 'AdvancedSettings', + 'in' => 'formData', + 'schema' => ['description' => 'The advanced configurations of the node.'."\n" + ."\n" + .'This parameter is valid only for an EMR Spark Streaming node or an EMR Streaming SQL node. This parameter corresponds to the Advanced Settings tab of the node in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n" + ."\n" + .'The value of this parameter must be in the JSON format.', 'type' => 'string', 'required' => false, 'example' => '{"queue":"default","SPARK_CONF":"--conf spark.driver.memory=2g"}', 'title' => ''], + ], + [ + 'name' => 'StartImmediately', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to immediately run a node after the node is deployed.'."\n" + ."\n" + .'This parameter is valid only for an EMR Spark Streaming node or an EMR Streaming SQL node. This parameter corresponds to the Start Method parameter in the Schedule section of the Configure tab in the [DataWorks console](https://workbench.data.aliyun.com/console).', 'type' => 'boolean', 'docRequired' => false, 'default' => 'false', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'InputParameters', + 'in' => 'formData', + 'schema' => ['description' => 'The input parameters of the node. The value of this parameter must be in the JSON format. For more information about the input parameters, see the InputContextParameterList parameter in the Response parameters section of the [GetFile](~~173954~~) operation.'."\n" + ."\n" + .'This parameter corresponds to the Input Parameters table in the Input and Output Parameters section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).', 'type' => 'string', 'required' => false, 'example' => '[{"ValueSource": "project_001.first_node:bizdate_param","ParameterName": "bizdate_input"}]', 'title' => ''], + ], + [ + 'name' => 'OutputParameters', + 'in' => 'formData', + 'schema' => ['description' => 'The output parameters of the node. The value of this parameter must be in the JSON format. For more information about the output parameters, see the OutputContextParameterList parameter in the Response parameters section of the [GetFile](~~173954~~) operation.'."\n" + ."\n" + .'This parameter corresponds to the Output Parameters table in the Input and Output Parameters section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).', 'type' => 'string', 'required' => false, 'example' => '[{"Type": 1,"Value": "${bizdate}","ParameterName": "bizdate_param"}]', 'title' => ''], + ], + [ + 'name' => 'IgnoreParentSkipRunningProperty', + 'in' => 'formData', + 'schema' => ['description' => 'Whether to use the last cycle empty run attribute. The values are as follows:'."\n" + ."\n" + .'- true: The empty run attribute of the previous cycle is used.'."\n" + ."\n" + .'- false: The empty run attribute of the previous cycle is not used.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'CreateFolderIfNotExists', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to automatically create the directory that is specified by the FileFolderPath parameter if the directory does not exist. Valid values:'."\n" + ."\n" + .'- true: The system automatically creates the directory if the directory does not exist.'."\n" + ."\n" + .'- false: The system does not automatically create the directory if the directory does not exist. In this case, the call fails.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'ApplyScheduleImmediately', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether scheduling configurations immediately take effect after the node is deployed.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'Timeout', + 'in' => 'formData', + 'schema' => ['description' => 'The timeout period.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'ImageId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the custom image.', 'type' => 'string', 'required' => false, 'example' => 'm-bp1h4b5a8ogkbll2f3tr', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The type of the data source. Valid values: odps and emr.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'emr', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The ID of the file that was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000001', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request. You can use the ID to troubleshoot issues.', 'type' => 'string', 'example' => '0000-ABCD-EFG', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned.', 'type' => 'string', 'example' => 'The connection does not exist.', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true: The request was successful.'."\n" + ."\n" + .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned.', 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 1000001,\\n \\"RequestId\\": \\"0000-ABCD-EFG\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\"\\n}","type":"json"}]', + 'title' => 'CreateFile', + 'summary' => 'Creates a file in DataStudio. You cannot call this operation to create files for Data Integration nodes.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-04-07T07:19:57.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-02-08T09:17:18.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-12-13T08:36:52.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-09-02T08:43:19.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-04-03T06:17:44.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-07-14T05:38:33.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-04-25T06:32:09.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'Extension', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to include extended fields in query results. The extended fields include ReadCount, FavoriteCount, and ViewCount. This parameter takes effect only if you set the DataSourceType parameter to odps.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], + 'translator' => 'manual', + ], + 'CreateFolder' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '78186', + 'abilityTreeNodes' => ['FEATUREdide8FM783'], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => '$.parameters[4].schema.enumValueTitles', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10000', 'title' => ''], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => ['description' => 'The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID. You must configure either this parameter or the **ProjectIdentifier** parameter to determine the DataWorks workspace to which the operation is applied.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dw_project', 'title' => ''], + ], + [ + 'name' => 'FolderPath', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace page to obtain the workspace name. You must configure either this parameter or the **ProjectId** parameter to determine the DataWorks workspace to which the operation is applied.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Business_process/System_Data/MaxCompute/import_layer', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0bc1411515937', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Data' => [ - 'description' => 'The business data.'."\n", - 'type' => 'object', - 'properties' => [ - 'TableName' => [ - 'description' => 'The name of the metatable.'."\n", - 'type' => 'string', - 'example' => 'table_name', - ], - 'FavoriteCount' => [ - 'description' => 'The number of times the metatable was added to a favorite list. This parameter is returned only if you set the Extension parameter to true and takes effect only if you set the DataSourceType parameter to odps.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '6', - ], - 'Comment' => [ - 'description' => 'The comment of the metatable.'."\n", - 'type' => 'string', - 'example' => 'test table', - ], - 'ColumnCount' => [ - 'description' => 'The number of fields.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'CreateTime' => [ - 'description' => 'The time when the metatable was created.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1589870294000', - ], - 'ProjectId' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '232', - ], - 'OwnerId' => [ - 'description' => 'The ID of the metatable owner.'."\n", - 'type' => 'string', - 'example' => '123', - ], - 'EnvType' => [ - 'description' => 'The type of the environment. Valid values:'."\n" - ."\n" - .'* 0: development environment'."\n" - .'* 1: production environment'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'DatabaseName' => [ - 'description' => 'The name of the metadatabase.'."\n", - 'type' => 'string', - 'example' => 'abc', - ], - 'IsVisible' => [ - 'description' => 'The scope in which the metatable is visible. Valid values:'."\n" - ."\n" - .'* 0: The metatable is visible to workspace members.'."\n" - .'* 1: The metatable is visible to users within the tenant.'."\n" - .'* 2: The metatable is visible to all tenants.'."\n" - .'* 3: The metatable is visible only to the metatable owner.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TableGuid' => [ - 'description' => 'The GUID of the metatable.'."\n", - 'type' => 'string', - 'example' => 'odps.engine_name.table_name', - ], - 'ReadCount' => [ - 'description' => 'The number of times the metatable was read. This parameter is returned only if you set the Extension parameter to true and takes effect only if you set the DataSourceType parameter to odps.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'ClusterId' => [ - 'description' => 'The ID of the EMR cluster.'."\n", - 'type' => 'string', - 'example' => 'abc', - ], - 'IsPartitionTable' => [ - 'description' => 'Indicates whether the metatable is a partitioned table. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'IsView' => [ - 'description' => 'Indicates whether the metatable is a view. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'LifeCycle' => [ - 'description' => 'The lifecycle of the table. Unit: day.'."\n" - ."\n" - .'> If the lifecycle is not set for a MaxCompute table, the return value is 0, indicating that the table is permanently valid.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'ProjectName' => [ - 'description' => 'The name of the workspace.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'ViewCount' => [ - 'description' => 'The number of times the metatable was viewed. This parameter is returned only if you set the Extension parameter to true and takes effect only if you set the DataSourceType parameter to odps.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'LastAccessTime' => [ - 'description' => 'The time when the metatable was last accessed.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1589870294000', - ], - 'DataSize' => [ - 'description' => 'The size of storage space that is occupied by the metatable. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'LastModifyTime' => [ - 'description' => 'The time when the metatable was last updated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1589870294000', - ], - 'LastDdlTime' => [ - 'description' => 'The time when the schema of the metatable was last changed.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1589870294000', - ], - 'PartitionKeys' => [ - 'description' => 'The partition key of the Hive metatable.'."\n", - 'type' => 'string', - 'example' => 'ab', - ], - 'Location' => [ - 'description' => 'The storage path of the Hive metadatabase.'."\n", - 'type' => 'string', - 'example' => 'hdfs://', - ], - 'Caption' => [ - 'description' => 'The display name of the metatable.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'TenantId' => [ - 'description' => 'The tenant ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12345', - ], - 'Schema' => [ - 'description' => 'The schema information of the metatable. This parameter is returned if the three-layer model of MaxCompute is enabled.'."\n", - 'type' => 'string', - 'example' => 'default', - ], - ], - ], + 'HttpStatusCode' => ['description' => 'The path of the folder.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The unique identifier of the folder.'."\n", 'type' => 'string', 'example' => 'bdfd68****', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request. You can use the ID to troubleshoot issues.'."\n", 'type' => 'string', 'example' => '0000-ABCD-EFG', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'The connection does not exist.', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned.'."\n", 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Invalid.Meta.TableNotExist', - 'errorMessage' => 'The table does not exist.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.CommonError', - 'errorMessage' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.Illegal', - 'errorMessage' => 'The app guid parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.IllegalDate', - 'errorMessage' => 'The date format is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.IllegalPageError', - 'errorMessage' => 'The parameter for paging is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.NotExist', - 'errorMessage' => 'The object does not exist.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.Meta.NoCalcEngine', - 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.', - ], - ], 403 => [ - [ - 'errorCode' => 'Forbidden.Meta.NoTenant', - 'errorMessage' => 'The user is not the owner of any tenants.', - ], - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], ], 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.Meta.TenantTimeOut', - 'errorMessage' => 'Failed to connect to the interface network.', - ], - [ - 'errorCode' => 'InternalError.Meta.Unknown', - 'errorMessage' => 'An unknown error occurred while processing your request.', - ], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0bc1411515937\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Data\\": {\\n \\"TableName\\": \\"table_name\\",\\n \\"FavoriteCount\\": 6,\\n \\"Comment\\": \\"test table\\",\\n \\"ColumnCount\\": 3,\\n \\"CreateTime\\": 1589870294000,\\n \\"ProjectId\\": 232,\\n \\"OwnerId\\": \\"123\\",\\n \\"EnvType\\": 1,\\n \\"DatabaseName\\": \\"abc\\",\\n \\"IsVisible\\": 1,\\n \\"TableGuid\\": \\"odps.engine_name.table_name\\",\\n \\"ReadCount\\": 3,\\n \\"ClusterId\\": \\"abc\\",\\n \\"IsPartitionTable\\": true,\\n \\"IsView\\": false,\\n \\"LifeCycle\\": 5,\\n \\"ProjectName\\": \\"test\\",\\n \\"ViewCount\\": 2,\\n \\"LastAccessTime\\": 1589870294000,\\n \\"DataSize\\": 10,\\n \\"LastModifyTime\\": 1589870294000,\\n \\"LastDdlTime\\": 1589870294000,\\n \\"PartitionKeys\\": \\"ab\\",\\n \\"Location\\": \\"hdfs://\\",\\n \\"Caption\\": \\"中文名\\",\\n \\"TenantId\\": 12345,\\n \\"Schema\\": \\"default\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n The connection does not exist.\\n 0bc1411515937\\n true\\n Invalid.Tenant.ConnectionNotExists\\n \\n table_name\\n 6\\n test table\\n 3\\n 1589870294000\\n 232\\n 123\\n 1\\n abc\\n 1\\n odps.engine_name.table_name\\n 3\\n abc\\n true\\n false\\n 5\\n test\\n 2\\n 1589870294000\\n 10\\n 1589870294000\\n 1589870294000\\n ab\\n hdfs://\\n 中文名\\n 12345\\n default\\n \\n","errorExample":""}]', - 'title' => 'GetMetaTableBasicInfo', - 'summary' => 'Queries the basic information about a metatable.', + 'title' => 'CreateFolder', + 'summary' => 'The operation that you want to perform. Set the value to \\\\*\\\\*CreateFolder\\\\*\\\\*.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', - ], - 'GetMetaTableColumn' => [ - 'methods' => [ - 'get', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"bdfd68****\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\"\\n}","type":"json"}]', + ], + 'CreateImportMigration' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '78263', - 'abilityTreeNodes' => [ - 'FEATUREdideE9XYA6', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '78187', + 'abilityTreeNodes' => ['FEATUREdide8FM783'], ], 'parameters' => [ [ - 'name' => 'TableGuid', - 'in' => 'query', + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to obtain the workspace ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '2', 'example' => '123456'], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the import task. The name must be unique within the workspace.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_import_001'], + ], + [ + 'name' => 'PackageType', + 'in' => 'formData', 'schema' => [ - 'description' => 'The GUID of the metatable. You can call the [GetMetaDBTableList](~~2780086~~) operation to query the GUID.'."\n", + 'description' => 'The type of the import package. Valid values:'."\n" + ."\n" + .'* DATAWORKS_MODEL (standard format)'."\n" + .'* DATAWORKS_V2 (Apsara Stack DataWorks V3.6.1 to V3.11)'."\n" + .'* DATAWORKS_V3 (Apsara Stack DataWorks V3.12 and later)'."\n", 'type' => 'string', - 'required' => false, + 'required' => true, 'docRequired' => true, - 'example' => 'odps.engine_name.table_name', + 'example' => 'DATAWORKS_MODEL', + 'enum' => ['DATAWORKS_MODEL', 'DATAWOKRS_V2', 'DATAWORKS_V3', 'SPEC'], ], ], [ - 'name' => 'PageNum', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'name' => 'PackageFile', + 'in' => 'formData', + 'schema' => ['description' => 'The path of the import package. **The import package must be uploaded. Example of the upload method:**'."\n" + ."\n" + .'```java'."\n" + .' Config config = new Config();'."\n" + .' config.setAccessKeyId(accessId);'."\n" + .' config.setAccessKeySecret(accessKey);'."\n" + .' config.setEndpoint(popEndpoint);'."\n" + .' config.setRegionId(regionId);'."\n" + ."\n" + .' Client client = new Client(config);'."\n" + ."\n" + .' CreateImportMigrationAdvanceRequest request = new CreateImportMigrationAdvanceRequest();'."\n" + .' request.setName("test_migration_api_" + System.currentTimeMillis());'."\n" + .' request.setProjectId(123456L); '."\n" + .' request.setPackageType("DATAWORKS_MODEL");'."\n" + .' request.setPackageFileObject(new FileInputStream("/home/admin/Downloads/test.zip"));'."\n" + ."\n" + .' RuntimeOptions runtime = new RuntimeOptions();'."\n" + .' CreateImportMigrationResponse response = client.createImportMigrationAdvance(request, runtime);'."\n" + .'```'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '/home/admin/xxx/import.zip', 'isFileTransferUrl' => true], ], [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'name' => 'ResourceGroupMap', + 'in' => 'formData', + 'schema' => ['description' => 'The mapping between the resource group for scheduling and the resource group for Data Integration. The keys and values in the mapping are the identifiers of the resource groups. Specify the mapping in the following format:'."\n" + ."\n" + .'```json'."\n" + .'{'."\n" + .' "SCHEDULER_RESOURCE_GROUP": {'."\n" + .' "xxx": "yyy"'."\n" + .' },'."\n" + .' "DI_RESOURCE_GROUP": {'."\n" + .' "ccc": "dfdd"'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '{"SCHEDULER_RESOURCE_GROUP": {"xxx":"yyy"},"DI_RESOURCE_GROUP":{"ccc":"ddd"}}'], ], [ - 'name' => 'ClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the E-MapReduce (EMR) cluster. You can log on to the EMR console to obtain the ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'C-010A704DA760****', - ], + 'name' => 'WorkspaceMap', + 'in' => 'formData', + 'schema' => ['description' => 'The mapping between the prefixes for the names of the source and destination workspaces. When the system performs the import operation, the prefix for the name of the source workspace in the import package is replaced based on the mapping.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '{"test_workspace_src": "test_workspace_target"}'], ], [ - 'name' => 'DatabaseName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the metadatabase of the EMR cluster. You can call the [ListMetaDB](~~2780105~~) operation to query the name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], + 'name' => 'CalculateEngineMap', + 'in' => 'formData', + 'schema' => ['description' => 'The mapping between the source compute engine instance and the destination compute engine instance. The following types of compute engine instances are supported: MaxCompute, E-MapReduce (EMR), Hadoop CDH, and Hologres.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '{ "ODPS": { "zxy_8221431_engine": "wzp_kaifazheban_engine" }, "EMR": { "aaaa": "bbb" } }'], ], [ - 'name' => 'TableName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the metatable in the EMR cluster. You can call the [GetMetaDBTableList](~~2780086~~) operation to query the name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], + 'name' => 'CommitRule', + 'in' => 'formData', + 'schema' => ['description' => 'The rule configured for automatically committing and deploying the import task. The rule contains the following parameters:'."\n" + ."\n" + .'* resourceAutoCommit: specifies whether resources are automatically committed. The value true indicates yes and the value false indicates no.'."\n" + .'* resourceAutoDeploy: specifies whether resources are automatically deployed. The value true indicates yes and the value false indicates no.'."\n" + .'* functionAutoCommit: specifies whether the function is automatically committed. The value true indicates yes and the value false indicates no.'."\n" + .'* functionAutoDeploy: specifies whether the function is automatically deployed. The value true indicates yes and the value false indicates no.'."\n" + .'* tableAutoCommitToDev: specifies whether the table is automatically committed to the development environment. The value true indicates yes and the value false indicates no.'."\n" + .'* tableAutoCommitToProd: specifies whether the table is automatically committed to the production environment. The value true indicates yes and the value false indicates no.'."\n" + .'* ignoreLock: specifies whether the lock is automatically ignored when an import task is locked. The value true indicates yes and the value false indicates no. If you set this parameter to true for an import task, you can forcefully update the task even if the task is locked.'."\n" + .'* fileAutoCommit: specifies whether the file is automatically committed. The value true indicates yes and the value false indicates no.'."\n" + .'* fileAutoDeploy: specifies whether the file is automatically deployed. The value true indicates yes and the value false indicates no.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '{ "resourceAutoCommit": false, "resourceAutoDeploy": false, "functionAutoCommit": false, "functionAutoDeploy": false, "tableAutoCommitToDev": false, "tableAutoCommitToProd": false, "ignoreLock": false, "fileAutoCommit": false, "fileAutoDeploy": false }'], ], [ - 'name' => 'DataSourceType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the data source. Set the value to emr.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'emr', - ], + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['description' => 'The description of the import package.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'test description'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => '0bc1ec92159376', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Data' => [ - 'description' => 'The business data.'."\n", - 'type' => 'object', - 'properties' => [ - 'PageNum' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of fields.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'ColumnList' => [ - 'description' => 'The information about fields.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ColumnGuid' => [ - 'description' => 'The GUID of the field.'."\n", - 'type' => 'string', - 'example' => 'odps.engine_name.table_name.name', - ], - 'ColumnName' => [ - 'description' => 'The name of the field.'."\n", - 'type' => 'string', - 'example' => 'name', - ], - 'IsPartitionColumn' => [ - 'description' => 'Indicates whether the field is a partition field. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'Comment' => [ - 'description' => 'The remarks of the field.'."\n", - 'type' => 'string', - 'example' => 'comment ', - ], - 'ColumnType' => [ - 'description' => 'The data type of the field.'."\n", - 'type' => 'string', - 'example' => 'string', - ], - 'IsPrimaryKey' => [ - 'description' => 'Indicates whether the field is a primary key. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'Position' => [ - 'description' => 'The sequence number of the field.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Caption' => [ - 'description' => 'The description of the field.'."\n", - 'type' => 'string', - 'example' => 'data column', - ], - 'IsForeignKey' => [ - 'description' => 'Indicates whether the field is a foreign key. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RelationCount' => [ - 'description' => 'The number of times the field is read.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - ], - ], - ], - ], - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Data' => ['description' => 'The import task ID. The ID is used as an input parameter if you want the system to run the import task or you want to obtain the running progress of the import task.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123456'], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'test error message'], + 'RequestId' => ['description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", 'type' => 'string', 'example' => 'ADFASDFASDFA-ADFASDF-ASDFADSDF-AFFADS'], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '110001123456'], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameter.Meta.CommonError', - 'errorMessage' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.GuidFormat', - 'errorMessage' => 'The GUID format is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.Illegal', - 'errorMessage' => 'The app guid parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.IllegalDate', - 'errorMessage' => 'The date format is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.IllegalPageError', - 'errorMessage' => 'The parameter for paging is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.NotExist', - 'errorMessage' => 'The object does not exist.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.Meta.NoCalcEngine', - 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.', - ], - ], - 403 => [ - [ - 'errorCode' => 'Forbidden.Meta.NoTenant', - 'errorMessage' => 'The user is not the owner of any tenants.', - ], - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.Meta.TenantTimeOut', - 'errorMessage' => 'Failed to connect to the interface network.', - ], - [ - 'errorCode' => 'InternalError.Meta.Unknown', - 'errorMessage' => 'An unknown error occurred while processing your request.', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 123456,\\n \\"ErrorMessage\\": \\"test error message\\",\\n \\"RequestId\\": \\"ADFASDFASDFA-ADFASDF-ASDFADSDF-AFFADS\\",\\n \\"ErrorCode\\": \\"110001123456\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 123456\\n test error message\\n ADFASDFASDFA-ADFASDF-ASDFADSDF-AFFADS\\n 110001123456\\n true\\n","errorExample":""}]', + 'title' => 'CreateImportMigration', + 'summary' => 'Creates an import task. The import task contains the import packages of data sources, nodes, and tables.', + 'description' => 'The import package must be uploaded. Example of the upload method:'."\n" + ."\n" + .' Config config = new Config();'."\n" + .' config.setAccessKeyId(accessId);'."\n" + .' config.setAccessKeySecret(accessKey);'."\n" + .' config.setEndpoint(popEndpoint);'."\n" + .' config.setRegionId(regionId);'."\n" + .' '."\n" + .' Client client = new Client(config);'."\n" + ."\n" + .' CreateImportMigrationAdvanceRequest request = new CreateImportMigrationAdvanceRequest();'."\n" + .' request.setName("test_migration_api_" + System.currentTimeMillis());'."\n" + .' request.setProjectId(123456L); '."\n" + .' request.setPackageType("DATAWORKS_MODEL");'."\n" + .' request.setPackageFileObject(new FileInputStream("/home/admin/Downloads/test.zip"));'."\n" + ."\n" + .' RuntimeOptions runtime = new RuntimeOptions();'."\n" + .' CreateImportMigrationResponse response = client.createImportMigrationAdvance(request, runtime);'."\n" + .' ...'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-10-10T11:13:36.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"ColumnList\\": [\\n {\\n \\"ColumnGuid\\": \\"odps.engine_name.table_name.name\\",\\n \\"ColumnName\\": \\"name\\",\\n \\"IsPartitionColumn\\": false,\\n \\"Comment\\": \\"comment \\",\\n \\"ColumnType\\": \\"string\\",\\n \\"IsPrimaryKey\\": false,\\n \\"Position\\": 1,\\n \\"Caption\\": \\"data column\\",\\n \\"IsForeignKey\\": true,\\n \\"RelationCount\\": 2\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n The connection does not exist.\\n 0bc1ec92159376\\n true\\n Invalid.Tenant.ConnectionNotExists\\n \\n 1\\n 10\\n 100\\n \\n odps.engine_name.table_name.name\\n name\\n false\\n comment \\n string\\n false\\n 1\\n data column\\n true\\n 2\\n \\n \\n","errorExample":""}]', - 'title' => 'GetMetaTableColumn', - 'summary' => 'Queries the field information of a metatable.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', ], - 'GetMetaTablePartition' => [ - 'summary' => 'Obtains a list of partitions in a metatable.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateManualDag' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '78269', - 'abilityTreeNodes' => [ - 'FEATUREdideE9XYA6', - ], - ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', + 'name' => 'ProjectEnv', + 'in' => 'formData', 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + 'description' => 'The environment identifier of the Scheduling Operation Center. PROD indicates the production environment, and DEV indicates the development environment.', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enum' => ['PROD', 'DEV'], + 'example' => 'PROD or DEV', + 'title' => '', ], ], [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => ['description' => 'The English name of the workspace to which the manual workflow belongs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_workspace', 'title' => ''], ], [ - 'name' => 'TableGuid', - 'in' => 'query', - 'schema' => [ - 'description' => 'The unique identifier of the metatable.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'odps.engine_name.table_name', - ], + 'name' => 'FlowName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the manual workflow.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_workflow', 'title' => ''], ], [ - 'name' => 'ClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the EMR cluster. This parameter is required only if you set the DataSourceType parameter to emr.'."\n" - ."\n" - .'You can log on to the [EMR console](https://emr.console.aliyun.com/?spm=a2c4g.11186623.0.0.965cc5c2GeiHet#/cn-hangzhou) to obtain the ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], + 'name' => 'BizDate', + 'in' => 'formData', + 'schema' => ['description' => 'The value of the business date must be less than or equal to the current date minus one day. For example, if today is November 11, 2020, the business date must be 2020-11-10 00:00:00 or an earlier date. The hour, minute, and second fields of the business date must all be set to 00.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-11-11 00:00:00', 'title' => ''], ], [ - 'name' => 'DatabaseName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database. This parameter is required only if you set the DataSourceType parameter to emr.'."\n" - ."\n" - .'You can call the [ListMetaDB](~~2780105~~) operation to query the name of the metadatabase.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], + 'name' => 'NodeParameters', + 'in' => 'formData', + 'schema' => ['description' => 'The node parameter information passed when the manual workflow is executed, in JSON format:'."\n" + .'`'."\n" + .'{'."\n" + .' "": "The scheduling parameter information of the node, consistent with the parameter format in the data development scheduling configuration", '."\n" + .' "": "The scheduling parameter information of the node, consistent with the parameter format in the data development scheduling configuration"'."\n" + .'}'."\n" + .'`', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '{"20000123121": "key1=val2 key2=val2", "20000123124": "kkkk=vvvvv aaaa=bbbb"}', 'title' => ''], ], [ - 'name' => 'TableName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the metatable in the EMR cluster. This parameter is required only if you set the DataSourceType parameter to emr.'."\n" - ."\n" - .'You can call the [GetMetaDBTableList](~~2780086~~) operation to query the name of the metatable.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], + 'name' => 'DagParameters', + 'in' => 'formData', + 'schema' => ['description' => 'The workflow parameters. These parameters are synchronized to all instances of the current DAG. If the scheduling parameters of an internal node reference the workflow parameters in DagParameters, the corresponding parameter values of the node are replaced with the workflow parameters in DagParameters.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '{"kaaaa": "vaaaaa", "kbbbb": "vbbbbb"}', 'title' => ''], ], [ - 'name' => 'DataSourceType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the data source. Valid values: odps and emr.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'emr', - ], + 'name' => 'IncludeNodeIds', + 'in' => 'formData', + 'schema' => ['description' => 'The list of IDs of the nodes to be run.', 'type' => 'string', 'required' => false, 'example' => '74324,74325', 'title' => ''], ], [ - 'name' => 'SortCriterion', - 'in' => 'query', - 'style' => 'json', + 'name' => 'ExcludeNodeIds', + 'in' => 'formData', + 'schema' => ['description' => 'The list of IDs of the nodes that do not need to be run.', 'type' => 'string', 'required' => false, 'example' => '123,456', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The logic for sorting partitions in the metatable.'."\n", + 'description' => 'The returned entity.', 'type' => 'object', 'properties' => [ - 'SortField' => [ - 'description' => 'The field that is used to sort partitions in the metatable. Valid values: name and modify_time. By default, partitions in the metatable are sorted based on their creation time.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'name', - ], - 'Order' => [ - 'description' => 'The order in which partitions in the metatable are sorted. Valid values: asc and desc. Default value: desc.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'desc', - ], + 'DagId' => ['description' => 'The instance ID of the DAG generated when the manual workflow runs. You can use this DagId together with the relevant API to query the details and status of the internal node instances of this manual workflow run.', 'type' => 'integer', 'format' => 'int64', 'example' => '700000123123141', 'title' => ''], + 'RequestId' => ['description' => 'The unique ID of the request.', 'type' => 'string', 'example' => 'AASFDFSDFG-DFSDF-DFSDFD-SDFSDF', 'title' => ''], ], - 'required' => false, + 'title' => '', + 'example' => '', ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DagId\\": 700000123123141,\\n \\"RequestId\\": \\"AASFDFSDFG-DFSDF-DFSDFD-SDFSDF\\"\\n}","type":"json"}]', + 'title' => 'Trigger the execution of a manual workflow', + 'summary' => 'The manual workflow must have already been submitted and deployed in the UI, and the Operation Center must be able to find the corresponding manual workflow. Only then can this API be used.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-01-13T07:25:28.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'CreateMetaCategory' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '78189', + 'abilityTreeNodes' => ['FEATUREdideE9XYA6'], + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the category.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'category_name', 'title' => ''], + ], + [ + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => ['description' => 'The remarks of the category.'."\n", 'type' => 'string', 'required' => false, 'example' => 'category 1', 'title' => ''], + ], + [ + 'name' => 'ParentId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the parent category.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0bc1ec92159376', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The connection does not exist.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0bc1ec92159376', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], 'Data' => [ - 'description' => 'The returned result.'."\n", + 'description' => 'The information about the category.'."\n", 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of partitions.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'DataEntityList' => [ - 'description' => 'The list of partitions.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'PartitionPath' => [ - 'description' => 'The path of the partition.'."\n", - 'type' => 'string', - 'example' => 'abc', - ], - 'DataSize' => [ - 'description' => 'The size of the partition. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '19', - ], - 'PartitionName' => [ - 'description' => 'The name of the partition.'."\n", - 'type' => 'string', - 'example' => 'pt=20170614', - ], - 'Comment' => [ - 'description' => 'The comment.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'ModifiedTime' => [ - 'description' => 'The time when the partition was modified. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1590032868000', - ], - 'CreateTime' => [ - 'description' => 'The time when the partition was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1590032868000', - ], - 'RecordCount' => [ - 'description' => 'The number of entries in the partition.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '233', - ], - 'PartitionType' => [ - 'description' => 'The type of the partition.'."\n", - 'type' => 'string', - 'example' => 'abc', - ], - 'PartitionGuid' => [ - 'description' => 'The GUID of the partition.'."\n", - 'type' => 'string', - 'example' => 'odps.engine_name.table_name.pt=20170614', - ], - 'PartitionLocation' => [ - 'description' => 'The location of the Hive partition.'."\n", - 'type' => 'string', - 'example' => 'abc', - ], - 'TableGuid' => [ - 'description' => 'The unique identifier of the metatable.'."\n", - 'type' => 'string', - 'example' => 'odps.engine_name.table_name', - ], - ], - ], - ], + 'CategoryId' => ['description' => 'The category ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '223', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter.Meta.CommonError', - 'errorMessage' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.Illegal', - 'errorMessage' => 'The app guid parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.IllegalDate', - 'errorMessage' => 'The date format is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.IllegalPageError', - 'errorMessage' => 'The parameter for paging is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.NotExist', - 'errorMessage' => 'The object does not exist.', - ], - [ - 'errorCode' => 'InternalError.Meta.NoCalcEngine', - 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.', - ], + ['errorCode' => 'Invalid.Meta.TableNotExist', 'errorMessage' => 'The table does not exist.', 'description' => 'The table does not exist.'], + ['errorCode' => 'InvalidParameter.Meta.CommonError', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The request parameter is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.Illegal', 'errorMessage' => 'The app guid parameter is invalid.', 'description' => 'The app guid parameter is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.IllegalDate', 'errorMessage' => 'The date format is invalid.', 'description' => 'The date format is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.IllegalPageError', 'errorMessage' => 'The parameter for paging is invalid.', 'description' => 'The parameter for paging is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.NotExist', 'errorMessage' => 'The object does not exist.', 'description' => ''], + ['errorCode' => 'Invalid.Meta.CategoryIllegalDepth', 'errorMessage' => 'A category can contain a maximum of 4 levels.', 'description' => 'A category can contain a maximum of 4 levels.'], + ['errorCode' => 'Invalid.Meta.CategoryNameDuplicate', 'errorMessage' => 'The category name is duplicated at this level.', 'description' => 'The category name is duplicated at this level.'], ], 403 => [ - [ - 'errorCode' => 'Forbidden.Meta.NoTenant', - 'errorMessage' => 'The user is not the owner of any tenants.', - ], - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + ['errorCode' => 'Forbidden.Meta.NoTenant', 'errorMessage' => 'The user is not the owner of any tenants.', 'description' => 'The user is not the owner of any tenants.'], + ['errorCode' => 'Invalid.Meta.CategoryForbidden', 'errorMessage' => 'Failed to delete the category. The current category is associated with a table and cannot be operated.', 'description' => 'Failed to delete the category because the table associated with the category does not exist.'], + ['errorCode' => 'Invalid.Meta.CategoryIllegalTenant', 'errorMessage' => 'The tenant ID is different in the parent and child categories.', 'description' => 'The tenant ID is different in the parent and child categories.'], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], ], 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.Meta.TenantTimeOut', - 'errorMessage' => 'Failed to connect to the interface network.', - ], - [ - 'errorCode' => 'InternalError.Meta.Unknown', - 'errorMessage' => 'An unknown error occurred while processing your request.', - ], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.Meta.NoCalcEngine', 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.', 'description' => ''], + ['errorCode' => 'InternalError.Meta.TenantTimeOut', 'errorMessage' => 'Failed to connect to the interface network.', 'description' => 'Failed to connect to the interface network.'], + ['errorCode' => 'InternalError.Meta.Unknown', 'errorMessage' => 'An unknown error occurred while processing your request.', 'description' => 'An unknown error occurred while processing your request.'], + ['errorCode' => 'Invalid.Meta.CategoryRelationDuplicate"', 'errorMessage' => 'The table is already bound to the category.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"DataEntityList\\": [\\n {\\n \\"PartitionPath\\": \\"abc\\",\\n \\"DataSize\\": 19,\\n \\"PartitionName\\": \\"pt=20170614\\",\\n \\"Comment\\": \\"备注\\",\\n \\"ModifiedTime\\": 1590032868000,\\n \\"CreateTime\\": 1590032868000,\\n \\"RecordCount\\": 233,\\n \\"PartitionType\\": \\"abc\\",\\n \\"PartitionGuid\\": \\"odps.engine_name.table_name.pt=20170614\\",\\n \\"PartitionLocation\\": \\"abc\\",\\n \\"TableGuid\\": \\"odps.engine_name.table_name\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n The connection does not exist.\\n 0bc1ec92159376\\n true\\n Invalid.Tenant.ConnectionNotExists\\n \\n 1\\n 10\\n 100\\n \\n abc\\n 19\\n pt=20170614\\n 备注\\n 1590032868000\\n 1590032868000\\n 233\\n abc\\n odps.engine_name.table_name.pt=20170614\\n abc\\n odps.engine_name.table_name\\n \\n \\n","errorExample":""}]', - 'title' => 'GetMetaTablePartition', - 'description' => 'You can call this operation to query only the partitions of a metatable in a MaxCompute or E-MapReduce (EMR) compute engine. If you query partitions of a metatable in an EMR compute engine, only DataLake clusters that use Data Lake Formation (DLF) to manage metadata and Hadoop clusters whose cluster version is earlier than 3.41.0 or 5.7.0 are supported.'."\n", + 'title' => 'CreateMetaCategory', + 'summary' => 'Creates a category.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', - ], - 'GetMetaTableOutput' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'extraInfo' => ' CreateMetaCategory接口的使用示例Demo请参见[DataWorks OpenAPI示例](https://developer.aliyun.com/article/780879?groupCode=dataworks)。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Data\\": {\\n \\"CategoryId\\": 223\\n }\\n}","type":"json"}]', + ], + 'CreateMetaCollection' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '78268', - 'abilityTreeNodes' => [ - 'FEATUREdideE9XYA6', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '163133', + 'abilityTreeNodes' => ['FEATUREdideE9XYA6'], ], 'parameters' => [ [ - 'name' => 'PageNumber', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Valid values: 1 to 30. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The name of the collection. The name must be 1 to 32 characters in length.'."\n", 'type' => 'string', 'required' => true, 'example' => 'collection_name'], ], [ - 'name' => 'PageSize', + 'name' => 'Comment', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The comment of the collection. The comment must be 1 to 64 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'this is a comment'], ], [ - 'name' => 'TableGuid', + 'name' => 'ParentQualifiedName', 'in' => 'query', - 'schema' => [ - 'description' => 'The GUID of the metatable.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'odps.sample_project.sample_table', - ], + 'schema' => ['description' => 'The unique identifier of the parent collection.'."\n", 'type' => 'string', 'required' => false, 'example' => 'album.333508'], ], [ - 'name' => 'StartDate', + 'name' => 'CollectionType', 'in' => 'query', - 'schema' => [ - 'description' => 'The start date.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2020-02-02', - ], - ], - [ - 'name' => 'EndDate', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end date.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2022-02-15', - ], - ], - [ - 'name' => 'TaskId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The task ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1048576', - ], + 'schema' => ['description' => 'The type of the collection.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ALBUM'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'SUCCESS', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0000-0000-0000-000', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'Data' => [ - 'description' => 'The business data.'."\n", - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number. Valid values: 1 to 30. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '128', - ], - 'DataEntityList' => [ - 'description' => 'The partitions.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'EndTime' => [ - 'description' => 'The end time.'."\n", - 'type' => 'string', - 'example' => '2022-02-12 0:32:12', - ], - 'TaskInstanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '987654321', - ], - 'StartTime' => [ - 'description' => 'The start time.'."\n", - 'type' => 'string', - 'example' => '2022-02-12 0:34:13', - ], - 'ProjectId' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '128', - ], - 'WaitTime' => [ - 'description' => 'The waiting time.'."\n", - 'type' => 'string', - 'example' => '3', - ], - 'TableGuid' => [ - 'description' => 'The GUID of the MaxCompute table.'."\n", - 'type' => 'string', - 'example' => 'odps.sample_project.sample_table', - ], - 'TaskId' => [ - 'description' => 'The task ID.'."\n", - 'type' => 'string', - 'example' => '1048576', - ], - ], - 'description' => '', - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'E6F0DBDD-5AD****'], + 'QualifiedName' => ['description' => 'The unique identifier of the collection.'."\n", 'type' => 'string', 'example' => 'album.11111'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'string', 'example' => 'true'], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'NoPermission'], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The specified parameters are invalid.'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'string', 'example' => '200'], ], - 'description' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameter.Meta.CommonError', - 'errorMessage' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.Illegal', - 'errorMessage' => 'The app guid parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.IllegalDate', - 'errorMessage' => 'The date format is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.IllegalPageError', - 'errorMessage' => 'The parameter for paging is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.NotExist', - 'errorMessage' => 'The object does not exist.', - ], - ], - 403 => [ - [ - 'errorCode' => 'Forbidden.Meta.NoTenant', - 'errorMessage' => 'The user is not the owner of any tenants.', - ], - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.Meta.NoCalcEngine', - 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.', - ], - [ - 'errorCode' => 'InternalError.Meta.TenantTimeOut', - 'errorMessage' => 'Failed to connect to the interface network.', - ], - [ - 'errorCode' => 'InternalError.Meta.Unknown', - 'errorMessage' => 'An unknown error occurred while processing your request.', - ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"QualifiedName\\": \\"album.11111\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrorCode\\": \\"NoPermission\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"\\n E6F0DBDD-5AD****\\n album.1111\\n true\\n 9999\\n The specified parameters are invalid.\\n 200\\n","errorExample":""}]', + 'title' => 'CreateMetaCollection', + 'summary' => 'Creates a collection.', + 'description' => 'Collections are classified into various types. The names of collections of the same type must be different.'."\n", + 'requestParamsDescription' => 'A category must belong to a data album. You can create a category in a data album only after you create the data album. You can set the parentQualifiedName parameter to the unique identifier of the data album to create the category.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMetaCollection'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"RequestId\\": \\"0bc1ec92159376****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"DataEntityList\\": [\\n {\\n \\"EndTime\\": \\"2020-01-01 00:01:00\\",\\n \\"TaskInstanceId\\": 3521,\\n \\"StartTime\\": \\"2020-01-01 00:00:00\\",\\n \\"ProjectId\\": 333,\\n \\"WaitTime\\": \\"323\\",\\n \\"TableGuid\\": \\"odps.engine_name.table_name\\",\\n \\"TaskId\\": \\"1048576\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n The specified parameters are invalid.\\n 0bc1ec92159376****\\n true\\n 1031203110005\\n \\n 1\\n 10\\n 100\\n \\n 1511107200000\\n 3521\\n 1511107200000\\n 333\\n 323\\n odps.engine_name.table_name\\n 1048576\\n \\n \\n","errorExample":""}]', - 'title' => 'GetMetaTableOutput', - 'summary' => 'Queries the output information of a metatable.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', + 'ramActions' => [], ], - 'GetMetaTableChangeLog' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreatePermissionApplyOrder' => [ + 'summary' => 'Creates a permission request order.'."\n" + ."\n" + .'Note: The 2020 edition of OpenAPI will be deprecated soon. Migrate to the 2024 edition of OpenAPI as soon as possible — ApplyResourceAccessPermission.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '78262', - 'abilityTreeNodes' => [ - 'FEATUREdideE9XYA6', - ], + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '78190', + 'abilityTreeNodes' => ['FEATUREdide0DCVNY'], ], 'parameters' => [ [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'name' => 'ApplyUserIds', + 'in' => 'query', + 'schema' => ['description' => 'The UIDs of the Alibaba Cloud accounts for which permissions are requested. Separate multiple account UIDs with commas (,).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '26784260040899****,26784260040899****', 'title' => ''], ], [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'name' => 'Deadline', + 'in' => 'query', + 'schema' => ['description' => 'The expiration time of the requested permissions. Specify a UNIX timestamp. If you do not specify this parameter, the default expiration time is January 1, 2065.'."\n" + .'If LabelSecurity is not enabled for the MaxCompute project, or the security level of the requested table field is 0 or less than or equal to the security level of the requesting account, you can request only permanent permissions.'."\n" + .'Go to the management page of the DataWorks workspace and check the advanced configuration page of the MaxCompute engine to verify whether column-level access control is enabled.'."\n" + .'Go to the DataWorks workspace to view the security level of fields in Data Map and the security level of accounts on the Member Management page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1617115071885', 'title' => ''], ], [ - 'name' => 'TableGuid', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The GUID of the table. Specify the GUID in the odps.projectName.tableName format. You can call the [GetMetaDBTableList](~~2780086~~) operation to query the GUID.'."\n" - ."\n" - .'> To query the change logs of a MaxCompute table, you must call the [GetMetaTableChangeLog](~~2780094~~) operation.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'odps.engine_name.table_name', - ], + 'name' => 'ApplyReason', + 'in' => 'query', + 'schema' => ['description' => 'The reason for the request. This is used by the administrator for evaluation and approval.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'I need to use this table', 'title' => ''], ], [ - 'name' => 'ChangeType', - 'in' => 'formData', + 'name' => 'MaxComputeProjectName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the MaxCompute project for which permissions are requested.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'aMaxcomputeProjectName', 'title' => ''], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the DataWorks workspace to which the MaxCompute project belongs. Go to the DataWorks workspace configuration page to obtain the workspace ID.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '999999', 'minimum' => '0', 'example' => '12345', 'title' => ''], + ], + [ + 'name' => 'OrderType', + 'in' => 'query', + 'allowEmptyValue' => true, 'schema' => [ - 'description' => 'The type of the change. Valid values: CREATE_TABLE, ALTER_TABLE, DROP_TABLE, ADD_PARTITION, and DROP_PARTITION.'."\n", - 'type' => 'string', + 'description' => 'This field is deprecated. Set it to empty.', + 'type' => 'integer', + 'format' => 'int32', + 'deprecated' => true, 'required' => false, - 'example' => 'ALTER_TABLE', + 'enum' => ['1'], + 'example' => '1', + 'title' => '', ], ], [ - 'name' => 'ObjectType', - 'in' => 'formData', + 'name' => 'EngineType', + 'in' => 'query', + 'allowEmptyValue' => true, 'schema' => [ - 'description' => 'The entity on which the change is made. Valid values: TABLE and PARTITION.'."\n", + 'description' => 'This field is deprecated. Set it to empty.', 'type' => 'string', + 'deprecated' => true, 'required' => false, - 'example' => 'TABLE', + 'enum' => ['odps'], + 'example' => 'odps', + 'title' => '', ], ], [ - 'name' => 'StartDate', - 'in' => 'formData', + 'name' => 'ApplyObject', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the yyyy-MM-dd HH:mm:ss format.'."\n" - ."\n" - .'* By default, the system uses the current time as the value of this parameter if the time that you specify is invalid.'."\n" - .'* If both the values of the StartDate and EndDate parameters are invalid, the system automatically queries the change logs that are generated within the last 30 days.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2020-06-01 00:00:00', + 'description' => 'The list of objects for which permissions are requested.', + 'type' => 'array', + 'items' => [ + 'description' => 'The response object.', + 'type' => 'object', + 'properties' => [ + 'Actions' => ['description' => 'The permission types to request. Separate multiple permission types with commas (,). Only Select, Describe, Drop, Alter, Update, and Download types are supported.', 'type' => 'string', 'required' => false, 'example' => 'Select,Describe', 'title' => ''], + 'ColumnMetaList' => [ + 'description' => 'The list of column objects.', + 'type' => 'array', + 'items' => [ + 'description' => 'The response object.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the column for which permissions are requested. To request permissions on the entire table, enter all column names of the table.'."\n" + .'You can request permissions on specific columns only if LabelSecurity is enabled for the MaxCompute project. If LabelSecurity is not enabled, you can request permissions only on the entire table.', 'type' => 'string', 'required' => false, 'example' => 'aColumnName', 'title' => ''], + 'Actions' => ['description' => 'The permission types to request. Separate multiple permission types with commas (,). Only Select, Describe, and Download types are supported.', 'type' => 'string', 'required' => false, 'example' => 'Select', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 200, + 'title' => '', + 'example' => '', + ], + 'Name' => ['description' => 'The object for which permissions are requested. Only MaxCompute table permissions are supported. Enter the name of the target table.', 'type' => 'string', 'required' => false, 'example' => 'aTableName', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'maxItems' => 50, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'EndDate', - 'in' => 'formData', + 'name' => 'ApplyType', + 'in' => 'query', 'schema' => [ - 'description' => 'The end of the time range to query. Specify the time in the yyyy-MM-dd HH:mm:ss format.'."\n" + 'description' => 'The type of the request order. Valid values:'."\n" ."\n" - .'* By default, the system uses the current time as the value of this parameter if the time that you specify is invalid.'."\n" - .'* If both the values of the StartDate and EndDate parameters are invalid, the system automatically queries the change logs that are generated within the last 30 days.'."\n", + .'- MaxComputeTable: MaxCompute table permission request order.'."\n" + .'- MaxComputeFunction: MaxCompute function permission request order.'."\n" + .'- MaxComputeResource: MaxCompute resource permission request order.'."\n" + .'- DLFSchema: Data Lake Formation (DLF) 1.0 schema permission request order.'."\n" + .'- DLFTable: DLF 1.0 table permission request order.'."\n" + .'- DLFColumn: DLF 1.0 column permission request order.'."\n" + .'- DsApiDeploy: Data service publication permission request order.', 'type' => 'string', + 'default' => 'MaxComputeTable', + 'enum' => ['MaxComputeTable', 'DLFSchema', 'DLFTable', 'DLFColumn', 'DsApiDeploy'], 'required' => false, - 'example' => '2020-06-02 00:00:00', + 'example' => 'MaxComputeTable', + 'title' => '', ], ], + [ + 'name' => 'CatalogName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the data catalog to query. Go to the [Data Lake Formation console](https://dlf.console.aliyun.com/ap-southeast-1/metadata/catalog?spm=a2c4g.11186623.0.0.5a225658pT4Dkr) to view the data catalog name.', 'type' => 'string', 'required' => false, 'example' => 'hive', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0bc1ec92159376', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Data' => [ - 'description' => 'The business data.'."\n", - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TotalCount' => [ - 'description' => 'The total number of metatables.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'DataEntityList' => [ - 'description' => 'The list of instances.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ObjectType' => [ - 'description' => 'The entity on which the change was made. Valid values: TABLE and PARTITION.'."\n", - 'type' => 'string', - 'example' => 'TABLE', - ], - 'ModifiedTime' => [ - 'description' => 'The time when the metatable was modified.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1590722845000', - ], - 'CreateTime' => [ - 'description' => 'The time when the metatable was created.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1590722845000', - ], - 'ChangeContent' => [ - 'description' => 'The content of the change.'."\n", - 'type' => 'string', - 'example' => '"[{\\"action\\":\\"ADD_COLUMN\\",\\"value\\":[{\\"originName\\":\\"\\",\\"originType\\":\\"\\",\\"originComment\\":\\"\\",\\"name\\":\\"id\\",\\"type\\":\\"struct\\",\\"comment\\":\\"\\"}]}]",', - ], - 'Operator' => [ - 'description' => 'The name of the operator.'."\n", - 'type' => 'string', - 'example' => 'abc', - ], - 'ChangeType' => [ - 'description' => 'The type of the change.'."\n", - 'type' => 'string', - 'example' => 'CREATE_TABLE', - ], - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0bc1ec92159376****', 'title' => ''], + 'FlowId' => [ + 'description' => 'The list of flow IDs.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the generated request order. If you request permissions on multiple objects that have different approvers, multiple request orders are generated based on different approvers, and an array is returned.', 'type' => 'string', 'example' => 'ee276e6e-5d34-46d8-b848-bca7879ed233', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameter.Meta.CommonError', - 'errorMessage' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.Illegal', - 'errorMessage' => 'The app guid parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.IllegalDate', - 'errorMessage' => 'The date format is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.IllegalPageError', - 'errorMessage' => 'The parameter for paging is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.NotExist', - 'errorMessage' => 'The object does not exist.', - ], - ], - 403 => [ - [ - 'errorCode' => 'Forbidden.Meta.NoTenant', - 'errorMessage' => 'The user is not the owner of any tenants.', - ], - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.Meta.NoCalcEngine', - 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.', - ], - [ - 'errorCode' => 'InternalError.Meta.TenantTimeOut', - 'errorMessage' => 'Failed to connect to the interface network.', - ], - [ - 'errorCode' => 'InternalError.Meta.Unknown', - 'errorMessage' => 'An unknown error occurred while processing your request.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc1ec92159376****\\",\\n \\"FlowId\\": [\\n \\"ee276e6e-5d34-46d8-b848-bca7879ed233\\"\\n ]\\n}","type":"json"}]', + 'title' => 'Create a permission request order', + 'description' => '**Note: The 2020 edition of OpenAPI will be deprecated soon. Migrate to the 2024 edition of OpenAPI as soon as possible — [ApplyResourceAccessPermission](https://www.alibabacloud.com/help/en/dataworks/developer-reference/api-dataworks-public-2024-05-18-applyresourceaccesspermission).**', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-03-27T11:02:04.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-06-28T02:00:14.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-04-28T08:54:54.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 10,\\n \\"PageSize\\": 1,\\n \\"TotalCount\\": 10,\\n \\"DataEntityList\\": [\\n {\\n \\"ObjectType\\": \\"TABLE\\",\\n \\"ModifiedTime\\": 1590722845000,\\n \\"CreateTime\\": 1590722845000,\\n \\"ChangeContent\\": \\"\\\\\\"[{\\\\\\\\\\\\\\"action\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ADD_COLUMN\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"originName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"originType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"originComment\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"id\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"struct\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"comment\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\"}]}]\\\\\\",\\",\\n \\"Operator\\": \\"abc\\",\\n \\"ChangeType\\": \\"CREATE_TABLE\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 0bc1ec92159376\\n 200\\n \\n 10\\n 1\\n 10\\n \\n abc\\n TABLE\\n [{\\"action\\":\\"ADD_COLUMN\\",\\"value\\":[{\\"originName\\":\\"\\",\\"originType\\":\\"\\",\\"originComment\\":\\"\\",\\"name\\":\\"id\\",\\"type\\":\\"struct<name:string>\\",\\"comment\\":\\"\\"}]}]\\n 1590722845000\\n CREATE_TABLE\\n 1590722845000\\n \\n \\n Invalid.Tenant.ConnectionNotExists\\n The connection does not exist.\\n true\\n","errorExample":""}]', - 'title' => 'GetMetaTableChangeLog', - 'summary' => 'Queries the change logs of a metatable.', - 'description' => '> This operation will be replaced soon. We recommend that you do not call this operation.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', ], - 'GetMetaTableIntroWiki' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateProject' => [ + 'summary' => 'Creates a DataWorks workspace.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -7613,1444 +4759,882 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '78265', - 'abilityTreeNodes' => [ - 'FEATUREdideE9XYA6', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '158574', + 'abilityTreeNodes' => ['FEATUREdideYNK30F'], ], 'parameters' => [ [ - 'name' => 'TableGuid', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The GUID of the metatable.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'odps.engine_name.table_name', - ], + 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. This parameter can be left empty.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ABFUOEUOTRTRJKE', 'title' => ''], ], [ - 'name' => 'WikiVersion', + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => ['description' => 'The display name of the workspace.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test_project', 'title' => ''], + ], + [ + 'name' => 'ProjectDescription', + 'in' => 'query', + 'schema' => ['description' => 'The description of the workspace.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test_describe', 'title' => ''], + ], + [ + 'name' => 'DisableDevelopment', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to disable the Develop role. Valid values:'."\n" + ."\n" + .'* **false** (default)'."\n" + .'* **true**'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'IsAllowDownload', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to allow you to download the query result from DataStudio. Valid values:'."\n" + ."\n" + .'* **1** (default): allows you to download the query result from DataStudio.'."\n" + .'* **0**: does not allow you to download the query result from DataStudio.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'ProjectMode', + 'in' => 'query', + 'schema' => ['description' => 'The mode of the workspace. For more information about the differences between the modes of workspaces, see [Differences between workspaces in basic mode and workspaces in standard mode](~~85772~~).'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* **2** (default): basic mode'."\n" + .'* **3**: standard mode'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The name of the workspace. The name can contain only letters, digits, and underscores (\\_) and must start with a letter or digit.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test_project', 'title' => ''], + ], + [ + 'name' => 'ResourceManagerResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmzbn7pti3****', 'title' => ''], + ], + [ + 'name' => 'Tags', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The version of the instructions.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The tags added to the workspace.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tags.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.'."\n", 'type' => 'string', 'required' => true, 'example' => 'key', 'title' => ''], + 'Value' => ['description' => 'The tag value.'."\n", 'type' => 'string', 'required' => true, 'example' => 'value', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => '1', + 'maxItems' => 21, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0bc1ec92159376', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Data' => [ - 'description' => 'The business data.'."\n", - 'type' => 'object', - 'properties' => [ - 'ModifiedTime' => [ - 'description' => 'The time when the metatable was last modified.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1584444247000', - ], - 'Version' => [ - 'description' => 'The version number.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'CreateTime' => [ - 'description' => 'The time when the metatable was created.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1584444247000', - ], - 'CreatorName' => [ - 'description' => 'The name of the user who creates the metatable.'."\n", - 'type' => 'string', - 'example' => 'abc', - ], - 'Content' => [ - 'description' => 'The description of the metatable.'."\n", - 'type' => 'string', - 'example' => '\\# Business requirements\\n\\n\\<a name=\\"xiw5n\\"'."\n", - ], - 'Creator' => [ - 'description' => 'The creator of the metatable.'."\n", - 'type' => 'string', - 'example' => 'abc', - ], - ], - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AFAE64E-D1BE-432B-A9****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => ['description' => 'The workspace ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '466230', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'InvalidParameter.Meta.CommonError', - 'errorMessage' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.Illegal', - 'errorMessage' => 'The app guid parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.IllegalDate', - 'errorMessage' => 'The date format is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.IllegalPageError', - 'errorMessage' => 'The parameter for paging is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.NotExist', - 'errorMessage' => 'The object does not exist.', - ], + ['errorCode' => 'Invalid.Tenant.ConnectionNotExists', 'errorMessage' => 'The connection does not exist.', 'description' => 'The connection does not exist.'], + ['errorCode' => 'Invalid.Tenant.ProjectNotExists', 'errorMessage' => 'The project does not exist.', 'description' => 'The project does not exist.'], + ['errorCode' => 'Invalid.Tenant.UserNotInProject', 'errorMessage' => 'The user is not in the project.', 'description' => 'The user is not in the project.'], ], 403 => [ - [ - 'errorCode' => 'Forbidden.Meta.NoTenant', - 'errorMessage' => 'The user is not the owner of any tenants.', - ], - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.Meta.NoCalcEngine', - 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.', - ], - [ - 'errorCode' => 'InternalError.Meta.TenantTimeOut', - 'errorMessage' => 'Failed to connect to the interface network.', - ], - [ - 'errorCode' => 'InternalError.Meta.Unknown', - 'errorMessage' => 'An unknown error occurred while processing your request.', - ], + ['errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin', 'errorMessage' => 'The user is not a project administrator or owner.', 'description' => 'The user is not a project administrator or owner.'], + ['errorCode' => 'Invalid.Tenant.UserNotInTenant', 'errorMessage' => 'The user is not in tenant.', 'description' => 'The user is not in tenant.'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Data\\": {\\n \\"ModifiedTime\\": 1584444247000,\\n \\"Version\\": 1,\\n \\"CreateTime\\": 1584444247000,\\n \\"CreatorName\\": \\"abc\\",\\n \\"Content\\": \\"# 业务需求\\\\\\\\n\\\\\\\\n<a name="xiw5n"\\",\\n \\"Creator\\": \\"abc\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"0bc1ec92159376****\\n200\\n\\n 1584444247000\\n 1\\n # 业务需求\\\\n\\\\n&lt;a name=&quot;xiw5n&quot;\\n 1584444247000\\n abc\\n abc\\n\\nInvalid.Tenant.ConnectionNotExists\\nThe connection does not exist.\\ntrue","errorExample":""}]', - 'title' => 'GetMetaTableIntroWiki', - 'summary' => 'Queries the instructions on how to use a table.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => 'For information about the example on how to use the GetMetaTableIntroWiki operation, see [Examples of DataWorks API operations](https://developer.aliyun.com/article/780879?groupCode=dataworks).'."\n", - ], - 'CreateMetaCategory' => [ - 'methods' => [ - 'post', + 'title' => 'CreateProject', + 'changeSet' => [ + ['createdAt' => '2024-03-29T08:33:28.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"1AFAE64E-D1BE-432B-A9****\\",\\n \\"Success\\": true,\\n \\"Data\\": 466230\\n}","type":"json"}]', + ], + 'CreateProjectMember' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '78189', - 'abilityTreeNodes' => [ - 'FEATUREdideE9XYA6', - ], - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'Name', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the category.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'category_name', - ], + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The DataWorks workspace ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '100000000', 'minimum' => '0', 'example' => '27', 'title' => ''], ], [ - 'name' => 'Comment', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The remarks of the category.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'category 1', - ], + 'name' => 'UserId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the user to be added.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1234', 'title' => ''], ], [ - 'name' => 'ParentId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the parent category.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', - ], + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. We recommend that you set this parameter to a UUID.'."\n", 'type' => 'string', 'required' => false, 'example' => '1AFAE64E-D1BE-432B-A9****', 'title' => ''], + ], + [ + 'name' => 'RoleCode', + 'in' => 'query', + 'schema' => ['description' => 'The code of the role. This parameter is optional. If you configure the RoleCode parameter, the user is assigned the role.'."\n", 'type' => 'string', 'required' => false, 'example' => 'role_project_guest', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0bc1ec92159376', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Data' => [ - 'description' => 'The information about the category.'."\n", - 'type' => 'object', - 'properties' => [ - 'CategoryId' => [ - 'description' => 'The category ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '223', - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AFAE64E-D1BE-432B-A9****', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Invalid.Meta.TableNotExist', - 'errorMessage' => 'The table does not exist.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.CommonError', - 'errorMessage' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.Illegal', - 'errorMessage' => 'The app guid parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.IllegalDate', - 'errorMessage' => 'The date format is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.IllegalPageError', - 'errorMessage' => 'The parameter for paging is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.NotExist', - 'errorMessage' => 'The object does not exist.', - ], - [ - 'errorCode' => 'Invalid.Meta.CategoryIllegalDepth', - 'errorMessage' => 'A category can contain a maximum of 4 levels.', - ], - [ - 'errorCode' => 'Invalid.Meta.CategoryNameDuplicate', - 'errorMessage' => 'The category name is duplicated at this level.', - ], + ['errorCode' => 'Invalid.Tenant.ConnectionNotExists', 'errorMessage' => 'The connection does not exist.', 'description' => 'The connection does not exist.'], + ['errorCode' => 'Invalid.Tenant.ProjectNotExists', 'errorMessage' => 'The project does not exist.', 'description' => 'The project does not exist.'], + ['errorCode' => 'Invalid.Tenant.UserNotInProject', 'errorMessage' => 'The user is not in the project.', 'description' => 'The user is not in the project.'], + ['errorCode' => 'Invalid.Tenant.UserAlreadyInProject', 'errorMessage' => 'The user already exists in the project.', 'description' => 'The user has already existed in project.'], + ['errorCode' => 'Invalid.Tenant.UserNotInTenant', 'errorMessage' => 'The user is not in the tenant.', 'description' => 'The user is not in the tenant.'], ], 403 => [ - [ - 'errorCode' => 'Forbidden.Meta.NoTenant', - 'errorMessage' => 'The user is not the owner of any tenants.', - ], - [ - 'errorCode' => 'Invalid.Meta.CategoryForbidden', - 'errorMessage' => 'Failed to delete the category. The current category is associated with a table and cannot be operated.', - ], - [ - 'errorCode' => 'Invalid.Meta.CategoryIllegalTenant', - 'errorMessage' => 'The tenant ID is different in the parent and child categories.', - ], - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.Meta.NoCalcEngine', - 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.', - ], - [ - 'errorCode' => 'InternalError.Meta.TenantTimeOut', - 'errorMessage' => 'Failed to connect to the interface network.', - ], - [ - 'errorCode' => 'InternalError.Meta.Unknown', - 'errorMessage' => 'An unknown error occurred while processing your request.', - ], - [ - 'errorCode' => 'Invalid.Meta.CategoryRelationDuplicate"', - 'errorMessage' => 'The table is already bound to the category.', - ], + ['errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin', 'errorMessage' => 'The user is not a project administrator or owner.', 'description' => 'The user is not a project administrator or owner.'], + ['errorCode' => 'Invalid.Tenant.UserNotInTenant', 'errorMessage' => 'The user is not in tenant.', 'description' => 'The user is not in tenant.'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Data\\": {\\n \\"CategoryId\\": 223\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n The connection does not exist.\\n 0bc1ec92159376\\n true\\n Invalid.Tenant.ConnectionNotExists\\n \\n 223\\n \\n","errorExample":""}]', - 'title' => 'CreateMetaCategory', - 'summary' => 'Creates a category.', + 'title' => 'CreateProjectMember', + 'summary' => 'Adds a user to a DataWorks workspace.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', - 'extraInfo' => 'For information about the example on how to use the CreateMetaCategory operation, see [Examples of DataWorks API operations](https://developer.aliyun.com/article/780879?groupCode=dataworks).'."\n", - ], - 'DeleteMetaCategory' => [ - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AFAE64E-D1BE-432B-A9****\\"\\n}","type":"json"}]', + ], + 'CreateQualityEntity' => [ + 'summary' => 'Creates a partition expression for data quality.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, + 'operationType' => 'write', + 'deprecated' => true, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '78211', - 'abilityTreeNodes' => [ - 'FEATUREdideRZEBFC', - ], + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '78192', + 'abilityTreeNodes' => ['FEATUREdide3WJOKE'], ], 'parameters' => [ [ - 'name' => 'CategoryId', - 'in' => 'query', + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the engine or data source.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'autotest', 'title' => ''], + ], + [ + 'name' => 'TableName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the table.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'maxLength' => 128, 'minLength' => 1, 'example' => 'dual', 'title' => ''], + ], + [ + 'name' => 'EnvType', + 'in' => 'formData', 'schema' => [ - 'description' => 'The ID of the category.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The type of the engine or data source. Valid values: ODPS, EMR, CDH, and HOLO.', + 'type' => 'string', 'required' => true, 'docRequired' => true, - 'example' => '23', - ], + 'maxLength' => 64, + 'minLength' => 1, + 'enum' => ['odps', 'emr', 'hadoop', 'cdh', 'analyticdb_for_mysql', 'hybriddb_for_postgresql', 'holodb'], + 'example' => 'ODPS', + 'title' => '', + ], + ], + [ + 'name' => 'MatchExpression', + 'in' => 'formData', + 'schema' => ['description' => 'The partition expression.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'maxLength' => 128, 'minLength' => 1, 'example' => 'dt=$[yyyymmdd]', 'title' => ''], + ], + [ + 'name' => 'EntityLevel', + 'in' => 'formData', + 'schema' => [ + 'description' => 'This parameter is deprecated.', + 'enumValueTitles' => ['0: The check is performed after the SQL statement completes.', '1'], + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'maximum' => '99', + 'minimum' => '0', + 'enum' => ['0', '1'], + 'example' => '0', + 'title' => '', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the DataWorks workspace. You can go to the DataWorks console to obtain the workspace ID.', 'type' => 'integer', 'format' => 'int64', 'docRequired' => true, 'required' => true, 'example' => '123', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The business data.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0bc1ec92159376', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The ID of the created partition expression.', 'type' => 'integer', 'format' => 'int32', 'example' => '12345', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Your project is not relative with your account.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '011e1231u3****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '401', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Invalid.Meta.CategoryIllegalDepth', - 'errorMessage' => 'A category can contain a maximum of 4 levels.', - ], - [ - 'errorCode' => 'Invalid.Meta.CategoryNameDuplicate', - 'errorMessage' => 'The category name is duplicated at this level.', - ], - [ - 'errorCode' => 'Invalid.Meta.TableNotExist', - 'errorMessage' => 'The table does not exist.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.CommonError', - 'errorMessage' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.Illegal', - 'errorMessage' => 'The app guid parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.IllegalDate', - 'errorMessage' => 'The date format is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.IllegalPageError', - 'errorMessage' => 'The parameter for paging is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.NotExist', - 'errorMessage' => 'The object does not exist.', - ], - ], - 403 => [ - [ - 'errorCode' => 'Forbidden.Meta.NoTenant', - 'errorMessage' => 'The user is not the owner of any tenants.', - ], - [ - 'errorCode' => 'Invalid.Meta.CategoryForbidden', - 'errorMessage' => 'Failed to delete the category. The current category is associated with a table and cannot be operated.', - ], - [ - 'errorCode' => 'Invalid.Meta.CategoryIllegalTenant', - 'errorMessage' => 'The tenant ID is different in the parent and child categories.', - ], - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.Meta.NoCalcEngine', - 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.', - ], - [ - 'errorCode' => 'InternalError.Meta.TenantTimeOut', - 'errorMessage' => 'Failed to connect to the interface network.', - ], - [ - 'errorCode' => 'InternalError.Meta.Unknown', - 'errorMessage' => 'An unknown error occurred while processing your request.', - ], - [ - 'errorCode' => 'Invalid.Meta.CategoryRelationDuplicate"', - 'errorMessage' => 'The table is already bound to the category.', - ], - ], + 'staticInfo' => [ + 'substitutions' => ['dataworks-public::2024-05-18::CreateDataQualityScan'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n true\\n 0bc1ec92159376\\n The connection does not exist.\\n Invalid.Tenant.ConnectionNotExists\\n true\\n","errorExample":""}]', - 'title' => 'DeleteMetaCategory', - 'summary' => 'Deletes a category.', + 'title' => 'CreateQualityEntity', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', - 'extraInfo' => 'For information about the example on how to use the DeleteMetaCategory operation, see [Examples of DataWorks API operations](https://developer.aliyun.com/article/780879?groupCode=dataworks).'."\n", - ], - 'UpdateMetaCategory' => [ - 'methods' => [ - 'post', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-05-10T06:31:11.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-01-22T02:34:47.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-03-08T07:46:01.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 12345,\\n \\"ErrorMessage\\": \\"Your project is not relative with your account.\\",\\n \\"RequestId\\": \\"011e1231u3****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"401\\"\\n}","type":"json"}]', + ], + 'CreateQualityFollower' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, + 'operationType' => 'write', + 'deprecated' => true, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '78374', - 'abilityTreeNodes' => [ - 'FEATUREdideRZEBFC', - ], + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '78193', + 'abilityTreeNodes' => ['FEATUREdideGJ7UNJ'], ], 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'ProjectName', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the category.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'category name ', - ], + 'schema' => ['description' => 'The name of the compute engine or data source.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'autotest', 'title' => ''], ], [ - 'name' => 'Comment', + 'name' => 'Follower', 'in' => 'formData', - 'schema' => [ - 'description' => 'The remarks of the category.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'category name', - ], + 'schema' => ['description' => 'The Alibaba Cloud account ID of the follower.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '123', 'title' => ''], ], [ - 'name' => 'CategoryId', + 'name' => 'AlarmMode', 'in' => 'formData', 'schema' => [ - 'description' => 'The ID of the category.'."\n", + 'description' => 'The alert method. Valid values: 1 (email), 2 (email and SMS), 4 (DingTalk Group Bot), 5 (DingTalk Group Bot with an @all message), 6 (Lark), 7 (WeCom), 8 (webhook), and 9 (Phone Alert).', 'type' => 'integer', - 'format' => 'int64', + 'format' => 'int32', 'required' => true, 'docRequired' => true, - 'example' => '2', + 'enum' => ['1', '2', '4', '5', '6', '7', '8', '9'], + 'example' => '1', + 'title' => '', ], ], + [ + 'name' => 'EntityId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the partition expression.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '12345', 'title' => ''], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the DataWorks workspace. To find the workspace ID, log in to the DataWorks console.', 'type' => 'integer', 'format' => 'int64', 'docRequired' => true, 'required' => true, 'example' => '123', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'Indicates whether the category is updated.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0bc1ec92159376', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The subscription ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '12345', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'You have no permission.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ecb967ec-c137-48****', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '401', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Invalid.Meta.CategoryIllegalDepth', - 'errorMessage' => 'A category can contain a maximum of 4 levels.', - ], - [ - 'errorCode' => 'Invalid.Meta.CategoryNameDuplicate', - 'errorMessage' => 'The category name is duplicated at this level.', - ], - [ - 'errorCode' => 'Invalid.Meta.TableNotExist', - 'errorMessage' => 'The table does not exist.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.CommonError', - 'errorMessage' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.Illegal', - 'errorMessage' => 'The app guid parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.IllegalDate', - 'errorMessage' => 'The date format is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.IllegalPageError', - 'errorMessage' => 'The parameter for paging is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.NotExist', - 'errorMessage' => 'The object does not exist.', - ], - ], - 403 => [ - [ - 'errorCode' => 'Forbidden.Meta.NoTenant', - 'errorMessage' => 'The user is not the owner of any tenants.', - ], - [ - 'errorCode' => 'Invalid.Meta.CategoryForbidden', - 'errorMessage' => 'Failed to delete the category. The current category is associated with a table and cannot be operated.', - ], - [ - 'errorCode' => 'Invalid.Meta.CategoryIllegalTenant', - 'errorMessage' => 'The tenant ID is different in the parent and child categories.', - ], - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.Meta.NoCalcEngine', - 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.', - ], - [ - 'errorCode' => 'InternalError.Meta.TenantTimeOut', - 'errorMessage' => 'Failed to connect to the interface network.', - ], - [ - 'errorCode' => 'InternalError.Meta.Unknown', - 'errorMessage' => 'An unknown error occurred while processing your request.', - ], - [ - 'errorCode' => 'Invalid.Meta.CategoryRelationDuplicate"', - 'errorMessage' => 'The table is already bound to the category.', - ], - ], + 'staticInfo' => [ + 'substitutions' => ['dataworks-public::2024-05-18::CreateDataQualityAlertRule'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"0bc1ec92159376\\n200\\ntrue\\ntrue","errorExample":""}]', - 'title' => 'UpdateMetaCategory', - 'summary' => 'Updates a category.', + 'title' => 'CreateQualityFollower', + 'summary' => 'Adds a follower to a partition expression to receive data quality alerts.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', - 'extraInfo' => 'For information about the example on how to use the UpdateMetaCategory operation, see [Examples of DataWorks API operations](https://developer.aliyun.com/article/780879?groupCode=dataworks).'."\n", - ], - 'GetMetaCategory' => [ - 'methods' => [ - 'post', - 'get', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-11-15T12:29:38.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-03-08T07:46:01.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2021-11-23T03:58:45.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 12345,\\n \\"ErrorMessage\\": \\"You have no permission.\\",\\n \\"RequestId\\": \\"ecb967ec-c137-48****\\",\\n \\"ErrorCode\\": \\"401\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'CreateQualityRelativeNode' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, + 'operationType' => 'write', + 'deprecated' => true, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '78257', - 'abilityTreeNodes' => [ - 'FEATUREdideE9XYA6', - ], + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '78194', + 'abilityTreeNodes' => ['FEATUREdide3WJOKE'], ], 'parameters' => [ [ - 'name' => 'ParentCategoryId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The category tree ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'example' => '333', - ], + 'name' => 'EnvType', + 'in' => 'formData', + 'schema' => ['description' => 'The type of the compute engine or data source.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'maxLength' => 40, 'minLength' => 1, 'example' => 'ODPS', 'title' => ''], ], [ - 'name' => 'PageNum', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'name' => 'MatchExpression', + 'in' => 'formData', + 'schema' => ['description' => 'The partition expression.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'maxLength' => 80, 'minLength' => 1, 'example' => 'dt=$[yyyymmdd]', 'title' => ''], ], [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'name' => 'NodeId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the scheduling node. You can call the [ListNodes](~~173979~~) API to obtain the node ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '12321', 'title' => ''], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '123', 'title' => ''], + ], + [ + 'name' => 'TargetNodeProjectName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the project to which the scheduling node belongs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'maxLength' => 128, 'minLength' => 1, 'example' => 'autotest', 'title' => ''], + ], + [ + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the compute engine instance or data source.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'maxLength' => 128, 'minLength' => 1, 'example' => 'autotest', 'title' => ''], + ], + [ + 'name' => 'TableName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the table.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'maxLength' => 128, 'minLength' => 1, 'example' => 'dual', 'title' => ''], + ], + [ + 'name' => 'TargetNodeProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the project to which the node belongs.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1234', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'description' => 'The data returned for the request.', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0bc1ec92159376', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Data' => [ - 'description' => 'The business data.'."\n", - 'type' => 'object', - 'properties' => [ - 'PageNum' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of categories returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'DataEntityList' => [ - 'description' => 'The information about the category tree.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Depth' => [ - 'description' => 'The number of category levels.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Comment' => [ - 'description' => 'The remarks of the category.'."\n", - 'type' => 'string', - 'example' => 'category 1', - ], - 'ModifiedTime' => [ - 'description' => 'The time when the category was last modified.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1541576644000', - ], - 'CreateTime' => [ - 'description' => 'The time when the category was created.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1541576644000', - ], - 'CategoryId' => [ - 'description' => 'The category ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '133', - ], - 'LastOperatorId' => [ - 'description' => 'The ID of the user that performed the last operation.'."\n", - 'type' => 'string', - 'example' => '12345', - ], - 'Name' => [ - 'description' => 'The name of the category.'."\n", - 'type' => 'string', - 'example' => 'category 1', - ], - 'ParentCategoryId' => [ - 'description' => 'The parent category ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'OwnerId' => [ - 'description' => 'The category owner ID.'."\n", - 'type' => 'string', - 'example' => '123', - ], - ], - ], - ], - ], - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the association was created successfully.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => 'You have no permission.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ecb967ec-c137-48****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => '401', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Invalid.Meta.CategoryIllegalDepth', - 'errorMessage' => 'A category can contain a maximum of 4 levels.', - ], - [ - 'errorCode' => 'Invalid.Meta.CategoryNameDuplicate', - 'errorMessage' => 'The category name is duplicated at this level.', - ], - [ - 'errorCode' => 'Invalid.Meta.TableNotExist', - 'errorMessage' => 'The table does not exist.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.CommonError', - 'errorMessage' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.Illegal', - 'errorMessage' => 'The app guid parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.IllegalDate', - 'errorMessage' => 'The date format is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.IllegalPageError', - 'errorMessage' => 'The parameter for paging is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.NotExist', - 'errorMessage' => 'The object does not exist.', - ], - ], - 403 => [ - [ - 'errorCode' => 'Forbidden.Meta.NoTenant', - 'errorMessage' => 'The user is not the owner of any tenants.', - ], - [ - 'errorCode' => 'Invalid.Meta.CategoryForbidden', - 'errorMessage' => 'Failed to delete the category. The current category is associated with a table and cannot be operated.', - ], - [ - 'errorCode' => 'Invalid.Meta.CategoryIllegalTenant', - 'errorMessage' => 'The tenant ID is different in the parent and child categories.', - ], - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.Meta.NoCalcEngine', - 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.', - ], - [ - 'errorCode' => 'InternalError.Meta.TenantTimeOut', - 'errorMessage' => 'Failed to connect to the interface network.', - ], - [ - 'errorCode' => 'InternalError.Meta.Unknown', - 'errorMessage' => 'An unknown error occurred while processing your request.', - ], - [ - 'errorCode' => 'Invalid.Meta.CategoryRelationDuplicate"', - 'errorMessage' => 'The table is already bound to the category.', - ], - ], + 'staticInfo' => [ + 'substitutions' => ['dataworks-public::2024-05-18::UpdateDataQualityScan'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10,\\n \\"DataEntityList\\": [\\n {\\n \\"Depth\\": 1,\\n \\"Comment\\": \\"category 1\\",\\n \\"ModifiedTime\\": 1541576644000,\\n \\"CreateTime\\": 1541576644000,\\n \\"CategoryId\\": 133,\\n \\"LastOperatorId\\": \\"12345\\",\\n \\"Name\\": \\"category 1\\",\\n \\"ParentCategoryId\\": 12,\\n \\"OwnerId\\": \\"123\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n The connection does not exist.\\n 0bc1ec92159376\\n true\\n Invalid.Tenant.ConnectionNotExists\\n \\n 1\\n 10\\n 10\\n \\n 1\\n category 1\\n 1541576644000\\n 1541576644000\\n 133\\n 12345\\n category 1\\n 12\\n 123\\n \\n \\n","errorExample":""}]', - 'title' => 'GetMetaCategory', - 'summary' => 'Queries the information about a category tree.', + 'title' => 'CreateQualityRelativeNode', + 'summary' => 'Creates a Partition Expression Association.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', - 'extraInfo' => 'For information about the example on how to use the GetMetaCategory operation, see [Examples of DataWorks API operations](https://developer.aliyun.com/article/780879?groupCode=dataworks).'."\n", - ], - 'GetMetaTableListByCategory' => [ - 'methods' => [ - 'get', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-05-10T06:31:11.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-03-08T07:46:01.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"You have no permission.\\",\\n \\"RequestId\\": \\"ecb967ec-c137-48****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"401\\"\\n}","type":"json"}]', + ], + 'CreateQualityRule' => [ + 'summary' => 'Call CreateQualityRule to create a Quality Rule.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, + 'operationType' => 'write', + 'deprecated' => true, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '78267', - 'abilityTreeNodes' => [ - 'FEATUREdideE9XYA6', - ], + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '78195', + 'abilityTreeNodes' => ['FEATUREdide3WJOKE'], ], 'parameters' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'name' => 'BlockType', + 'in' => 'formData', + 'schema' => ['description' => 'The strength of the rule. Valid values:'."\n" + ."\n" + .'- 0: weak rule'."\n" + ."\n" + .'- 1: strong rule', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '1', 'minimum' => '0', 'example' => '0', 'title' => ''], ], [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'name' => 'EntityId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the partition filter expression.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '15224', 'title' => ''], ], [ - 'name' => 'CategoryId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The category ID. You can call the [GetMetaCategory](~~2780099~~) operation to obtain the ID of the category. Categories allow you to efficiently organize and manage tables by category. You can search for the desired table by category.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'minimum' => '1', - 'example' => '23', - ], + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => ['description' => 'The comments of the rule.', 'type' => 'string', 'required' => false, 'maxLength' => 128, 'minLength' => 1, 'example' => 'Verification', 'title' => ''], + ], + [ + 'name' => 'Checker', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the checker. Valid values:'."\n" + ."\n" + .'- 2: 7-day average fluctuation'."\n" + ."\n" + .'- 3: 30-day average fluctuation'."\n" + ."\n" + .'- 4: day-over-day comparison'."\n" + ."\n" + .'- 5: week-over-week comparison'."\n" + ."\n" + .'- 6: month-over-month comparison'."\n" + ."\n" + .'- 7: 7-day variance fluctuation'."\n" + ."\n" + .'- 8: 30-day variance fluctuation'."\n" + ."\n" + .'- 9: comparison with a fixed value'."\n" + ."\n" + .'- 10: fluctuation detection over 1, 7, and 30 days'."\n" + ."\n" + .'- 11: comparison with the previous cycle', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'minimum' => '1', 'example' => '9', 'title' => ''], + ], + [ + 'name' => 'ExpectValue', + 'in' => 'formData', + 'schema' => ['description' => 'The expected value.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'Trend', + 'in' => 'formData', + 'schema' => ['description' => 'The trend of the check result. Valid values:'."\n" + ."\n" + .'- `up`: upward trend'."\n" + ."\n" + .'- `down`: downward trend'."\n" + ."\n" + .'- `abs`: absolute value', 'type' => 'string', 'required' => false, 'example' => 'abs', 'title' => ''], + ], + [ + 'name' => 'MethodName', + 'in' => 'formData', + 'schema' => ['description' => 'The check method. If you use a custom SQL statement, set this parameter to `user_defined`.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'count/table_count', 'title' => ''], + ], + [ + 'name' => 'Operator', + 'in' => 'formData', + 'schema' => ['description' => 'The comparison operator. Examples: `>`, `>=`, `=`, `<>`, `<`, and `<=`.'."\n" + ."\n" + .'> If you set the Checker parameter to 9, you must specify the Operator parameter.', 'type' => 'string', 'required' => false, 'example' => '>', 'title' => ''], + ], + [ + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the compute engine or data source.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'autotest', 'title' => ''], + ], + [ + 'name' => 'Property', + 'in' => 'formData', + 'schema' => ['description' => 'The field that is monitored by the rule. To perform a table-level check, set this parameter to `table_count` for the number of rows or `table_size` for the table size.', 'type' => 'string', 'required' => false, 'maxLength' => 128, 'example' => 'table_id', 'title' => ''], + ], + [ + 'name' => 'PropertyType', + 'in' => 'formData', + 'schema' => ['description' => 'The data type of the field. For a table-level check, set this parameter to `table`. For a field-level check, set this parameter to a specific data type, such as `bigint`.', 'type' => 'string', 'required' => false, 'example' => 'bigint', 'title' => ''], + ], + [ + 'name' => 'RuleType', + 'in' => 'formData', + 'schema' => ['description' => 'The type of the rule. Valid values:'."\n" + ."\n" + .'- 0: system template'."\n" + ."\n" + .'- 1: custom SQL'."\n" + ."\n" + .'- 2: custom template', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '99', 'minimum' => '0', 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'WhereCondition', + 'in' => 'formData', + 'schema' => ['description' => 'The filter condition or custom SQL statement.', 'type' => 'string', 'required' => false, 'example' => 'table_id>1', 'title' => ''], + ], + [ + 'name' => 'CriticalThreshold', + 'in' => 'formData', + 'schema' => ['description' => 'The critical threshold. It indicates the deviation of the check result from the expected value. You can customize this threshold based on your business requirements. If a strong rule is used and a critical alert is triggered, the scheduling task is blocked.', 'type' => 'string', 'required' => false, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'WarningThreshold', + 'in' => 'formData', + 'schema' => ['description' => 'The warning threshold. It indicates the deviation of the check result from the expected value. You can customize this threshold based on your business requirements.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'TemplateId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the template.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '7', 'title' => ''], + ], + [ + 'name' => 'RuleName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the rule.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'maxLength' => 128, 'example' => '1234', 'title' => ''], + ], + [ + 'name' => 'PredictType', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to use a dynamic threshold. Valid values:', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '99', 'minimum' => '0', 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace Management page to obtain the workspace ID.', 'type' => 'integer', 'format' => 'int64', 'docRequired' => true, 'required' => true, 'example' => '10000', 'title' => ''], + ], + [ + 'name' => 'TaskSetting', + 'in' => 'formData', + 'schema' => ['description' => 'The variable settings that are inserted before the custom rule. Format: x=a,y=b.', 'type' => 'string', 'required' => false, 'example' => 'x=a,y=b', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The returned result.'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '0bc1ec92159376', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Data' => [ - 'description' => 'The business data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of metatables.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'TableGuidList' => [ - 'description' => 'The returned result.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The list of metatables.'."\n", - 'type' => 'string', - 'example' => 'odps.engine_name.table_name', - ], - ], - ], - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The ID of the new rule.', 'type' => 'string', 'example' => '12345', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'You have no permission.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ecb967ec-c137-48****', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '401', 'title' => ''], + 'Success' => ['description' => 'Whether the request succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Invalid.Meta.CategoryIllegalDepth', - 'errorMessage' => 'A category can contain a maximum of 4 levels.', - ], - [ - 'errorCode' => 'Invalid.Meta.CategoryNameDuplicate', - 'errorMessage' => 'The category name is duplicated at this level.', - ], - [ - 'errorCode' => 'Invalid.Meta.TableNotExist', - 'errorMessage' => 'The table does not exist.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.CommonError', - 'errorMessage' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.Illegal', - 'errorMessage' => 'The app guid parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.IllegalDate', - 'errorMessage' => 'The date format is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.IllegalPageError', - 'errorMessage' => 'The parameter for paging is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.NotExist', - 'errorMessage' => 'The object does not exist.', - ], - ], - 403 => [ - [ - 'errorCode' => 'Forbidden.Meta.NoTenant', - 'errorMessage' => 'The user is not the owner of any tenants.', - ], - [ - 'errorCode' => 'Invalid.Meta.CategoryForbidden', - 'errorMessage' => 'Failed to delete the category. The current category is associated with a table and cannot be operated.', - ], - [ - 'errorCode' => 'Invalid.Meta.CategoryIllegalTenant', - 'errorMessage' => 'The tenant ID is different in the parent and child categories.', - ], - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.Meta.NoCalcEngine', - 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.', - ], - [ - 'errorCode' => 'InternalError.Meta.TenantTimeOut', - 'errorMessage' => 'Failed to connect to the interface network.', - ], - [ - 'errorCode' => 'InternalError.Meta.Unknown', - 'errorMessage' => 'An unknown error occurred while processing your request.', - ], - [ - 'errorCode' => 'Invalid.Meta.CategoryRelationDuplicate"', - 'errorMessage' => 'The table is already bound to the category.', - ], - ], + 'staticInfo' => [ + 'substitutions' => ['dataworks-public::2024-05-18::CreateDataQualityScan'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 20,\\n \\"TableGuidList\\": [\\n \\"odps.engine_name.table_name\\"\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n The connection does not exist.\\n 0bc1ec92159376\\n true\\n Invalid.Tenant.ConnectionNotExists\\n \\n 1\\n 10\\n 20\\n odps.engine_name.table_name\\n \\n","errorExample":""}]', - 'title' => 'GetMetaTableListByCategory', - 'summary' => 'Queries metatables in a specified category.', + 'title' => 'CreateQualityRule', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', - 'extraInfo' => 'For more information about the example on how to use the GetMetaTableListByCategory operation, see [Examples of DataWorks API operations](https://developer.aliyun.com/article/780879?groupCode=dataworks).'."\n", - ], - 'AddToMetaCategory' => [ - 'methods' => [ - 'post', - 'get', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-11-15T11:45:03.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-03-08T07:46:01.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"12345\\",\\n \\"ErrorMessage\\": \\"You have no permission.\\",\\n \\"RequestId\\": \\"ecb967ec-c137-48****\\",\\n \\"ErrorCode\\": \\"401\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'CreateRemind' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', - 'abilityTreeCode' => '78167', - 'abilityTreeNodes' => [ - 'FEATUREdideRZEBFC', - ], + 'abilityTreeCode' => '78196', + 'abilityTreeNodes' => ['FEATUREdideRJGWWC'], ], 'parameters' => [ [ - 'name' => 'CategoryId', - 'in' => 'query', + 'name' => 'RemindName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the custom alert rule. The name cannot exceed 128 characters in length.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_error_remind', 'title' => ''], + ], + [ + 'name' => 'DndEnd', + 'in' => 'formData', + 'schema' => ['description' => 'The end time of the quiet hours. Specify the time in the hh:mm format. Valid values of hh: \\[0,23]. Valid values of mm: \\[0,59].'."\n", 'type' => 'string', 'required' => false, 'example' => '08:00', 'title' => ''], + ], + [ + 'name' => 'RemindUnit', + 'in' => 'formData', 'schema' => [ - 'description' => 'The ID of the category.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The type of the object to which the custom alert rule is applied. Valid values: NODE, BASELINE, PROJECT, and BIZPROCESS. The value NODE indicates a node. The value BASELINE indicates a baseline. The value PROJECT indicates a workspace. The value BIZPROCESS indicates a workflow.'."\n", + 'type' => 'string', 'required' => true, 'docRequired' => true, - 'example' => '5', + 'enum' => ['NODE', 'BASELINE', 'PROJECT', 'BIZPROCESS'], + 'example' => 'NODE', + 'title' => '', ], ], [ - 'name' => 'TableGuid', - 'in' => 'query', + 'name' => 'NodeIds', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the node to which the custom alert rule is applied. This parameter takes effect when the RemindUnit parameter is set to NODE. You can specify multiple IDs. Separate multiple IDs with commas (,). A maximum of 50 nodes can be specified for a custom alert rule.'."\n", 'type' => 'string', 'required' => false, 'example' => '1,2,3', 'title' => ''], + ], + [ + 'name' => 'BaselineIds', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the baseline to which the custom alert rule is applied. This parameter takes effect when the RemindUnit parameter is set to BASELINE. You can specify multiple IDs. Separate multiple IDs with commas (,). A maximum of five baselines can be specified for a custom alert rule.'."\n", 'type' => 'string', 'required' => false, 'example' => '1,2,3', 'title' => ''], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the workspace to which the custom alert rule is applied. This parameter takes effect when the RemindUnit parameter is set to PROJECT. You can specify only one workspace for a custom alert rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '9527', 'title' => ''], + ], + [ + 'name' => 'BizProcessIds', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the workflow to which the custom alert rule is applied. This parameter takes effect when the RemindUnit parameter is set to BIZPROCESS. You can specify multiple IDs. Separate multiple IDs with commas (,). A maximum of five workflows can be specified for a custom alert rule.'."\n", 'type' => 'string', 'required' => false, 'example' => '1,2,3', 'title' => ''], + ], + [ + 'name' => 'RemindType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The conditions that trigger an alert. Valid values: FINISHED, UNFINISHED, ERROR, CYCLE_UNFINISHED, and TIMEOUT.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enum' => ['FINISHED', 'UNFINISHED', 'ERROR', 'CYCLE_UNFINISHED', 'TIMEOUT', 'EXHAUSTED_ERROR'], + 'example' => 'FINISHED', + 'title' => '', + ], + ], + [ + 'name' => 'MaxAlertTimes', + 'in' => 'formData', + 'schema' => ['description' => 'The maximum number of alerts. Valid values: 1 to 10. Default value: 3.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10', 'minimum' => '1', 'default' => '3', 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'AlertInterval', + 'in' => 'formData', + 'schema' => ['description' => 'The minimum interval at which alerts are reported. Unit: seconds. Minimum value: 1200. Default value: 1800.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1200', 'default' => '1800', 'example' => '1800', 'title' => ''], + ], + [ + 'name' => 'Detail', + 'in' => 'formData', + 'schema' => ['description' => 'The details of the conditions that trigger an alert.'."\n" + ."\n" + .'* If the RemindType parameter is set to FINISHED, leave this parameter empty.'."\n" + .'* If the RemindType parameter is set to UNFINISHED, configure this parameter as key-value pairs. Example: {"hour":23,"minu":59}. Valid values of hour: \\[0,47]. Valid values of minu: \\[0,59].'."\n" + .'* If the RemindType parameter is set to ERROR, leave this parameter empty.'."\n" + .'* If the RemindType parameter is set to CYCLE_UNFINISHED, configure this parameter as key-value pairs. Example: {"1":"05:50","2":"06:50","3":"07:50","4":"08:50","5":"09:50","6":"10:50","7":"11:50","8":"12:50","9":"13:50","10":"14:50","11":"15:50","12":"16:50","13":"17:50","14":"18:50","15":"19:50","16":"20:50","17":"21:50","18":"22:50","19":"23:50","20":"24:50","21":"25:50"}. The key indicates the ID of the cycle. Valid values: \\[1,288]. The value indicates the timeout period of the node that is running in the cycle. Specify the value in the hh:mm format. Valid values of hh: \\[0,47]. Valid values of mm: \\[0,59].'."\n" + .'* If the RemindType parameter is set to TIMEOUT, set this parameter to the timeout period. Unit: seconds. Example: 1800. This value indicates that an alert is reported if the node has run for more than 30 minutes.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"hour":"23","minu":"59"}', 'title' => ''], + ], + [ + 'name' => 'AlertUnit', + 'in' => 'formData', 'schema' => [ - 'description' => 'The GUID of the metatable.'."\n", + 'description' => 'The recipient of the alert. Valid values: OWNER and OTHER. The value OWNER indicates the node owner. The value OTHER indicates a specified user.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, - 'example' => 'odps.engine_name.table_name', + 'default' => '', + 'enum' => ['OTHER', 'OWNER'], + 'example' => 'OWNER', + 'title' => '', ], ], + [ + 'name' => 'AlertMethods', + 'in' => 'formData', + 'schema' => ['description' => 'The notification method. Valid values:'."\n" + ."\n" + .'* MAIL: Alert notifications are sent by email.'."\n" + .'* SMS: Alert notifications are sent by text message. Alert notifications can be sent by text message only in the Singapore, Malaysia (Kuala Lumpur), and Germany (Frankfurt) regions.'."\n" + .'* WEBHOOKS (WeCom or Lark chatbot): Alert notifications are sent by WeCom or Lark message. If you want to use this notification method, you must configure the Webhooks parameter.'."\n" + .'* DINGROBOTS: Alert notifications are sent by DingTalk chatbot.'."\n" + ."\n" + .'You can specify multiple notification methods. Separate them with commas (,).'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'SMS,MAIL', 'title' => ''], + ], + [ + 'name' => 'AlertTargets', + 'in' => 'formData', + 'schema' => ['description' => '* If the AlertUnit parameter is set to OWNER, leave this parameter empty.'."\n" + .'* If the AlertUnit parameter is set to OTHER, set this parameter to the ID of the Alibaba Cloud account used by the specified user. You can specify multiple IDs. Separate multiple IDs with commas (,). You can specify a maximum of 10 IDs.'."\n", 'type' => 'string', 'required' => false, 'example' => '9527952795279527', 'title' => ''], + ], + [ + 'name' => 'RobotUrls', + 'in' => 'formData', + 'schema' => ['description' => 'The webhook URL of the DingTalk chatbot. You can specify multiple webhook URLs. Separate multiple webhook URLs with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=******************************', 'title' => ''], + ], + [ + 'name' => 'Webhooks', + 'in' => 'formData', + 'schema' => ['description' => 'The webhook URL of the WeCom or Lark chatbot. You can specify multiple webhook URLs. Separate multiple webhook URLs with commas (,). You must specify WEBHOOKS for AlertMethods.'."\n" + ."\n" + .'Only DataWorks Enterprise Edition supports this parameter. The webhook URL-based alerting feature is supported in the following regions: China (Shanghai), China (Chengdu), China (Zhangjiakou), China (Beijing), China (Hangzhou), China (Shenzhen), China (Hong Kong), Germany (Frankfurt), and Singapore.'."\n", 'type' => 'string', 'required' => false, 'example' => 'https://open.feishu.cn/open-apis/bot/v2/hook/*******', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'Indicates whether the metatable was added to the specified category.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0bc1ec92159376', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The ID of the custom alert rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The specified parameters are invalid.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0000-ABCD-EFG****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '1031203110005', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], ], 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Resource', 'errorMessage' => 'You have reached the limit for the resource. Please contact us by submitting a ticket.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], + ['errorCode' => 'Forbidden.Not.Server', 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.', 'description' => ''], + ['errorCode' => 'Forbidden.Wkbench.BaselineNoPermission', 'errorMessage' => 'You are not authorized to access the baseline.', 'description' => ''], + ['errorCode' => 'Forbidden.Wkbench.ProjectNoPermission', 'errorMessage' => 'You are not authorized to access the workspace.', 'description' => ''], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'Forbidden.Wkbench.NoProject', 'errorMessage' => 'You have not joined any project.', 'description' => ''], + ['errorCode' => 'Invalid.Wkbench.NodeNotExist', 'errorMessage' => 'The node does not exist.', 'description' => ''], + ['errorCode' => 'Invalid.Wkbench.BaselineNotExist', 'errorMessage' => 'The baseline does not exist.', 'description' => ''], + ['errorCode' => 'Forbidden.Wkbench.RemindOverlimit', 'errorMessage' => 'The maximum number of reminders is exceeded.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"0bc1ec92159376\\n200\\ntrue\\ntrue","errorExample":""}]', - 'title' => 'AddToMetaCategory', - 'summary' => 'Adds a metatable to a specified category.', + 'title' => 'CreateRemind', + 'summary' => 'Creates a custom alert rule.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', - 'extraInfo' => 'For information about the example on how to use the AddToMetaCategory operation, see [Examples of DataWorks API operations](https://developer.aliyun.com/article/780879?groupCode=dataworks).'."\n", - ], - 'DeleteFromMetaCategory' => [ - 'methods' => [ - 'post', - 'get', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-11-16T09:08:09.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 1234,\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1031203110005\\"\\n}","type":"json"}]', + ], + 'CreateResourceFile' => [ + 'summary' => 'Creates or uploads a resource file in DataStudio. The feature that is implemented by calling this operation is the same as the resource creation feature provided in the integrated development environment (IDE).', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -9059,340 +5643,385 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '78210', - 'abilityTreeNodes' => [ - 'FEATUREdideRZEBFC', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '185133', + 'abilityTreeNodes' => ['FEATUREdide8FM783', 'FEATUREdideJ3TPTK'], ], 'parameters' => [ [ - 'name' => 'CategoryId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the category.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '5', - ], + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID. You must configure this parameter to specify the DataWorks workspace to which the operation is applied.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '0', 'example' => '10111', 'title' => ''], ], [ - 'name' => 'TableGuid', - 'in' => 'query', - 'schema' => [ - 'description' => 'The GUID of the metatable.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'odps.engine_name.table_name', - ], + 'name' => 'FileFolderPath', + 'in' => 'formData', + 'schema' => ['description' => 'The path of the file.'."\n", 'type' => 'string', 'required' => true, 'example' => 'Business_process/First_Business_Process/MaxCompute/Folder_1/Folder_2', 'title' => ''], + ], + [ + 'name' => 'FileName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the file.'."\n", 'type' => 'string', 'required' => true, 'example' => 'File name', 'title' => ''], + ], + [ + 'name' => 'FileType', + 'in' => 'formData', + 'schema' => ['description' => 'The type of the code for the file. The code for files varies based on the file type. For more information, see [DataWorks nodes](~~600169~~).'."\n" + ."\n" + .'You can call the [ListFileType](~~212428~~) operation to query the type of the code for the file.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'minimum' => '0', 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'FileDescription', + 'in' => 'formData', + 'schema' => ['description' => 'The description of the file.'."\n", 'type' => 'string', 'required' => false, 'example' => 'This is a description', 'title' => ''], + ], + [ + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => ['description' => 'The Alibaba Cloud User ID of the file owner. If this parameter is empty, the caller\'s Alibaba cloud user ID is used by default.', 'type' => 'string', 'required' => false, 'example' => '1000000000001', 'title' => ''], + ], + [ + 'name' => 'Content', + 'in' => 'formData', + 'schema' => ['description' => 'The code for the file. The code format varies based on the file type. To view the code format for a specific file type, go to Operation Center, right-click a node of the file type, and then select View Code.'."\n", 'type' => 'string', 'required' => false, 'example' => 'SHOW TABLES;', 'title' => ''], + ], + [ + 'name' => 'ResourceFile', + 'in' => 'formData', + 'schema' => ['description' => 'The OSS URL for uploading files provided by POP.', 'type' => 'string', 'isFileTransferUrl' => true, 'required' => false, 'example' => 'http://bucketname1.oss-cn-shanghai.aliyuncs.com/example', 'title' => ''], + ], + [ + 'name' => 'OriginResourceName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the original resource file.', 'type' => 'string', 'required' => true, 'example' => 'origin_file_name.sql', 'title' => ''], + ], + [ + 'name' => 'UploadMode', + 'in' => 'formData', + 'schema' => ['description' => 'File resource Upload mode. Currently, only files of the File type of MaxCompute are valid. The values are as follows:'."\n" + ."\n" + .'- true: The Resource mode that can be downloaded.'."\n" + .'- false: The text mode for online editing.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'RegisterToCalcEngine', + 'in' => 'formData', + 'schema' => ['description' => 'Whether to synchronously Upload resources to the computing engine.', 'type' => 'boolean', 'required' => true, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'StorageURL', + 'in' => 'formData', + 'schema' => ['description' => 'The storage path of the resource file on the computing engine. Currently, only EMR and CDH use this field. EMR format is [oss | hdfs]:// path/to/object. CDH must be/user/admin/lib by default.', 'type' => 'string', 'required' => false, 'example' => 'oss://oss-cn-shanghai.aliyuncs.com/emr-test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The returned results.'."\n", + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'Indicates whether the table was removed from the specified category.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0bc1ec92159376', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Data' => ['description' => 'The ID of the file after it is created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000001', 'title' => ''], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request. You can use the ID to locate logs and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '0000-ABCD-EFG'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], ], 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n true\\n 0bc1ec92159376\\n The connection does not exist.\\n Invalid.Tenant.ConnectionNotExists\\n true\\n","errorExample":""}]', - 'title' => 'DeleteFromMetaCategory', - 'summary' => 'Removes a table from a specified category.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => 'For information about the example on how to use the DeleteFromMetaCategory operation, see [Examples of DataWorks API operations](https://developer.aliyun.com/article/780879?groupCode=dataworks).'."\n", - ], - 'UpdateMetaTable' => [ - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateResourceFile', + 'changeSet' => [ + ['createdAt' => '2023-07-25T01:04:16.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": 1000001,\\n \\"RequestId\\": \\"0000-ABCD-EFG\\"\\n}","type":"json"}]', + ], + 'CreateTable' => [ + 'summary' => 'Creates a MaxCompute table.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'deprecated' => false, + 'deprecated' => true, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '78375', - 'abilityTreeNodes' => [ - 'FEATUREdideRZEBFC', - ], + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '78197', + 'abilityTreeNodes' => ['FEATUREdideRZEBFC'], ], 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'IsView', 'in' => 'query', - 'schema' => [ - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '101', - ], + 'schema' => ['description' => 'Specifies whether to create a view or table. Valid values:'."\n" + ."\n" + .'- 0: Create a table.'."\n" + ."\n" + .'- 1: Create a view.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ - 'name' => 'TableName', + 'name' => 'Visibility', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the table.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'table1', - ], + 'schema' => ['description' => 'Specifies whether the table or workspace is visible. Valid values:'."\n" + ."\n" + .'- 0: Both the table and workspace are invisible.'."\n" + ."\n" + .'- 1: Both the table and workspace are visible.'."\n" + ."\n" + .'- 2: Only the workspace is visible.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'EnvType', + 'name' => 'LifeCycle', 'in' => 'query', - 'schema' => [ - 'description' => 'The environment of the DataWorks workspace. Valid values: 0 and 1. The value 0 indicates the development environment. The value 1 indicates the production environment.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The lifecycle of the table. Unit: days. By default, this parameter is left empty, which indicates that the table is permanently stored.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'TableGuid', + 'name' => 'CategoryId', 'in' => 'query', - 'schema' => [ - 'description' => 'The GUID of the table. Specify the GUID in the format of odps.{projectName}.{tableName}.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'odps.test.table1', - ], + 'schema' => ['description' => 'The ID of the associated category. You can call the [GetMetaCategory](~~173932~~) operation to query the IDs of all categories that can be associated.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '101', 'title' => ''], ], [ - 'name' => 'NewOwnerId', + 'name' => 'LogicalLevelId', 'in' => 'query', - 'schema' => [ - 'description' => 'The new owner ID. If you leave this parameter empty, the owner ID is not updated.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '12345', - ], + 'schema' => ['description' => 'The ID of the logical level.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '101', 'title' => ''], ], [ - 'name' => 'AddedLabels', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The names of the labels that you want to add. Separate the labels with commas (,).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'a,b,c', - ], + 'name' => 'PhysicsLevelId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the physical level.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '101', 'title' => ''], ], [ - 'name' => 'RemovedLabels', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The names of labels that you want to remove. Separate the labels with commas (,).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'a,b,c', - ], + 'name' => 'ExternalTableType', + 'in' => 'query', + 'schema' => ['description' => 'The storage type of the external table. Valid values:'."\n" + ."\n" + .'- 0: Object Storage Service (OSS)'."\n" + ."\n" + .'- 1: Tablestore'."\n" + ."\n" + .'- 2: Volume'."\n" + ."\n" + .'- 3: MySQL', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], [ - 'name' => 'CategoryId', + 'name' => 'Location', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the category that you want to associate.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '101', - ], + 'schema' => ['description' => 'The storage location of the external table.', 'type' => 'string', 'required' => false, 'example' => 'location', 'title' => ''], ], [ - 'name' => 'Visibility', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => 'The scope in which the table is visible. Valid values: 0, 1, and 2. The value 0 indicates that the table is invisible to all members. The value 1 indicates that the table is visible to all members. The value 2 indicates that the table is visible to workspace members.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '0', - 'example' => '1', - ], + 'schema' => ['description' => 'The DataWorks workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '23', 'title' => ''], ], [ - 'name' => 'Caption', + 'name' => 'TableName', 'in' => 'query', - 'schema' => [ - 'description' => 'The display name of the table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'The name of the table.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'tableName1', 'title' => ''], + ], + [ + 'name' => 'Endpoint', + 'in' => 'formData', + 'schema' => ['description' => 'The endpoint of MaxCompute.', 'type' => 'string', 'required' => false, 'example' => 'odps://abc', 'title' => ''], + ], + [ + 'name' => 'EnvType', + 'in' => 'formData', + 'schema' => ['description' => 'The environment type of the DataWorks workspace. Valid values:'."\n" + ."\n" + .'- 0: development environment'."\n" + ."\n" + .'- 1: production environment', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'AppGuid', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the MaxCompute project. Specify the ID in the odps.{projectName} format.', 'type' => 'string', 'required' => false, 'example' => 'odps.test', 'title' => ''], + ], + [ + 'name' => 'Comment', + 'in' => 'query', + 'schema' => ['description' => 'The comment.', 'type' => 'string', 'example' => 'Remarks', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'HasPart', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to create a MaxCompute partitioned table. Valid values: 1 and 0. The value 1 indicates a partitioned table. The value 0 indicates a non-partitioned table. This parameter is deprecated. Do not use this parameter. The Column.N.isPartitionCol parameter is used to specify whether to create a MaxCompute partitioned table. If the Column.N.isPartitionCol parameter is set to true, a MaxCompute partitioned table is created.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => 'A reserved parameter.', 'type' => 'string', 'example' => 'Reserved field', 'required' => false, 'title' => ''], ], [ 'name' => 'Schema', 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The schema information of the table. You need to enter the schema information of the table if you enable the table schema in MaxCompute.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], + ], + [ + 'name' => 'Columns', + 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The schema information about the table. You must configure this parameter if you enable the three-layer model of MaxCompute.'."\n", - 'type' => 'string', + 'description' => 'The list of fields. A maximum of 1,000 fields are supported.', + 'type' => 'array', + 'items' => [ + 'description' => 'The field.', + 'type' => 'object', + 'properties' => [ + 'ColumnNameCn' => ['description' => 'The display name of the field.', 'type' => 'string', 'required' => false, 'example' => '中文名', 'title' => ''], + 'ColumnName' => ['description' => 'The name of the field. You can configure a maximum of 1,000 fields when you call the CreateTable operation to create a table.', 'type' => 'string', 'required' => true, 'example' => 'columnName1', 'title' => ''], + 'Comment' => ['description' => 'The comment of the field.', 'type' => 'string', 'required' => false, 'example' => '备注', 'title' => ''], + 'ColumnType' => ['description' => 'The data type of the field. For information about supported data types, see [Data type editions](~~27821~~) in MaxCompute documentation.', 'type' => 'string', 'required' => true, 'example' => 'string', 'title' => ''], + 'SeqNumber' => ['description' => 'The sequence number of the field. You can use this parameter to specify how fields are sorted in a table. By default, fields are sorted based on the order in which requests are created. If the field is a partition field, this parameter is not supported.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'Length' => ['description' => 'The length of the field. For more information, see [MaxCompute data type editions](~~159541~~).', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + 'IsPartitionCol' => ['description' => 'Specifies whether the field is a partition field.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'maxItems' => 1000, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'Themes', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The list of themes.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ThemeId' => ['description' => 'The theme ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '101', 'title' => ''], + 'ThemeLevel' => ['description' => 'The level that corresponds to the theme ID.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '101', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'default', + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'UpdateResult' => [ - 'description' => 'Indicates whether the metadata information about the table was updated.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'abcde', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'abcdef', 'title' => ''], + 'TaskInfo' => [ + 'description' => 'The information about the request task. After a request task is submitted, it is divided into multiple subtasks that are run in sequence. After the current subtask is complete, the next subtask starts to run. After all subtasks are complete, the request task is complete.'."\n" + ."\n" + .'If a request task is aborted due to one of the following issues, address the issue based on the error code and initiate the request task again:'."\n" + ."\n" + .'- The request task fails to be submitted.'."\n" + ."\n" + .'- After the request task is submitted, a subtask fails to run.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status of the current subtask. Valid values:'."\n" + ."\n" + .'- operating: The subtask is running.'."\n" + ."\n" + .'- success: The subtask succeeds.'."\n" + ."\n" + .'- failure: The subtask fails to run. For more information about the error details, see the Content parameter.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'NextTaskId' => ['description' => 'The ID of the subtask that you want to run. If this parameter is left empty, all subtasks are complete.', 'type' => 'string', 'example' => 'abc1', 'title' => ''], + 'TaskId' => ['description' => 'The ID of the current subtask.', 'type' => 'string', 'example' => 'abc', 'title' => ''], + 'Content' => ['description' => 'The details about the status of the current subtask.'."\n" + ."\n" + .'- If the current subtask is successful, success is returned.'."\n" + ."\n" + .'- If the current subtask fails, the error details are displayed.', 'type' => 'string', 'example' => 'success', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], ], 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"UpdateResult\\": true,\\n \\"RequestId\\": \\"abcde\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n abcde\\n","errorExample":""}]', - 'title' => 'UpdateMetaTable', - 'summary' => 'This operation updates the metadata of a table.', - 'description' => 'This operation supports MaxCompute tables only.'."\n", + 'staticInfo' => ['noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"abcdef\\",\\n \\"TaskInfo\\": {\\n \\"Status\\": \\"success\\",\\n \\"NextTaskId\\": \\"abc1\\",\\n \\"TaskId\\": \\"abc\\",\\n \\"Content\\": \\"success\\"\\n }\\n}","type":"json"}]', + 'title' => 'CreateTable', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateMetaTableIntroWiki' => [ - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2022-07-19T06:35:48.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-10-22T02:21:37.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'translator' => 'manual', + ], + 'CreateTableLevel' => [ + 'summary' => 'Creates a hierarchy level. This operation will be replaced soon. We recommend that you do not call this operation.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -9401,428 +6030,258 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '78376', - 'abilityTreeNodes' => [ - 'FEATUREdideRZEBFC', - ], + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '78198', + 'abilityTreeNodes' => ['FEATUREdideRZEBFC'], ], 'parameters' => [ [ - 'name' => 'TableGuid', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => 'The GUID of the table. Specify the GUID in the odps.{projectName}.{tableName} format.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'odps.test.table1', - ], + 'schema' => ['description' => 'The DataWorks workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '123', 'title' => ''], ], [ - 'name' => 'Content', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The details of the instructions on how to use the metatable.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'abc', - ], + 'name' => 'LevelType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the table level. Valid values: 1 and 2. The value 1 indicates the logical level. The value 2 indicates the physical level.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '10', 'minimum' => '1', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the table level.', 'type' => 'string', 'example' => 'Level 1', 'required' => true, 'docRequired' => true, 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The description of the table level.', 'type' => 'string', 'example' => 'Level description', 'required' => false, 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The returned result.'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'UpdateResult' => [ - 'description' => 'Indicates whether the instructions on how to use the table are updated.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => 'abcde', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'Request ID', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified parameters are invalid.', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '1031203110005', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'LevelId' => ['description' => 'The table level ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], ], 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"UpdateResult\\": true,\\n \\"RequestId\\": \\"abcde\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n abcde\\n","errorExample":""}]', - 'title' => 'UpdateMetaTableIntroWiki', - 'summary' => 'Updates the instructions on how to use a table. If no instruction on how to use the table is available, the instructions that are configured by calling this operation are added.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"Request ID\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Success\\": true,\\n \\"LevelId\\": 123\\n}","type":"json"}]', + 'title' => 'CreateTableLevel', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListMetaDB' => [ - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'translator' => 'manual', + ], + 'CreateTableTheme' => [ + 'summary' => 'Creates a table theme. This operation will be replaced soon. We recommend that you do not call this operation.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '78317', - 'abilityTreeNodes' => [ - 'FEATUREdideE9XYA6', - ], + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '78199', + 'abilityTreeNodes' => ['FEATUREdideRZEBFC'], ], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => 'The DataWorks workspace ID. You can call the [ListProjects](~~178393~~) operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '123', - ], - ], - [ - 'name' => 'DataSourceType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the data source. Set the value to emr.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'emr', - ], + 'schema' => ['description' => 'The DataWorks workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '123', 'title' => ''], ], [ - 'name' => 'PageNum', + 'name' => 'Level', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '10000', - 'minimum' => '1', - 'example' => '1', - ], + 'schema' => ['description' => 'The level of the table theme. Valid values: 1 and 2. The value 1 indicates the first level. The value 2 indicates the second level.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '10', 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - ], + 'schema' => ['description' => 'The name of the table theme.', 'type' => 'string', 'example' => 'Topic name', 'required' => true, 'docRequired' => true, 'title' => ''], ], [ - 'name' => 'ClusterId', + 'name' => 'ParentId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the E-MapReduce (EMR) cluster. You can log on to the [EMR console](https://emr.console.aliyun.com/?spm=a2c4g.11186623.0.0.965cc5c2GeiHet#/cn-hangzhou) to query the ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], + 'schema' => ['description' => 'The ID of the level of the parent table theme.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '122', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'abc', - ], - 'DatabaseInfo' => [ - 'description' => 'The information about the metadatabases.'."\n", - 'type' => 'object', - 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of the metadatabases returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'DbList' => [ - 'description' => 'The metadatabases.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the metadatabase.'."\n", - 'type' => 'string', - 'example' => 'HIVE', - ], - 'CreateTimeStamp' => [ - 'description' => 'The timestamp at which the metadatabase was created. You can convert the timestamp to the date based on the time zone that you use.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1388776825', - ], - 'UUID' => [ - 'description' => 'The UUID of the metadatabase.'."\n", - 'type' => 'string', - 'example' => '32342', - ], - 'ModifiedTimeStamp' => [ - 'description' => 'The timestamp at which the metadatabase was updated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1388776837', - ], - 'Name' => [ - 'description' => 'The name of the metadatabase.'."\n", - 'type' => 'string', - 'example' => 'name', - ], - 'OwnerId' => [ - 'description' => 'The owner ID.'."\n", - 'type' => 'string', - 'example' => '1232', - ], - 'Location' => [ - 'description' => 'The URL of the metadatabase.'."\n", - 'type' => 'string', - 'example' => 'hdfs://localhost:777/user/hadoop/test.txt', - ], - ], - ], - ], - ], - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ABCd', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ThemeId' => ['description' => 'The table theme ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Invalid.Meta.AppNotExist', - 'errorMessage' => 'The MaxCompute project does not exist.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.CommonError', - 'errorMessage' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.Illegal', - 'errorMessage' => 'The app guid parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.IllegalDate', - 'errorMessage' => 'The date format is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.IllegalPageError', - 'errorMessage' => 'The parameter for paging is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.NotExist', - 'errorMessage' => 'The object does not exist.', - ], - ], 403 => [ - [ - 'errorCode' => 'Forbidden.Meta.NoTenant', - 'errorMessage' => 'The user is not the owner of any tenants.', - ], - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], ], 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.Meta.NoCalcEngine', - 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.', - ], - [ - 'errorCode' => 'InternalError.Meta.TenantTimeOut', - 'errorMessage' => 'Failed to connect to the interface network.', - ], - [ - 'errorCode' => 'InternalError.Meta.Unknown', - 'errorMessage' => 'An unknown error occurred while processing your request.', - ], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"abc\\",\\n \\"DatabaseInfo\\": {\\n \\"TotalCount\\": 10,\\n \\"DbList\\": [\\n {\\n \\"Type\\": \\"HIVE\\",\\n \\"CreateTimeStamp\\": 1388776825,\\n \\"UUID\\": \\"32342\\",\\n \\"ModifiedTimeStamp\\": 1388776837,\\n \\"Name\\": \\"name\\",\\n \\"OwnerId\\": \\"1232\\",\\n \\"Location\\": \\"hdfs://localhost:777/user/hadoop/test.txt\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n abc\\n \\n 10\\n \\n HIVE\\n 1388776825\\n 32342\\n 1388776837\\n name\\n 1232\\n hdfs://localhost:777/user/hadoop/test.txt\\n \\n \\n","errorExample":""}]', - 'title' => 'ListMetaDB', - 'summary' => 'Queries a list of metadatabases.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"ABCd\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"ErrorCode\\": \\"0\\",\\n \\"Success\\": true,\\n \\"ThemeId\\": 123\\n}","type":"json"}]', + 'title' => 'CreateTableTheme', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', - ], - 'UpdateTableModelInfo' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'translator' => 'manual', + ], + 'CreateUdfFile' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '78385', - 'abilityTreeNodes' => [ - 'FEATUREdideRZEBFC', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '78200', + 'abilityTreeNodes' => ['FEATUREdide8FM783'], ], 'parameters' => [ [ - 'name' => 'FirstLevelThemeId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the first-level table folder.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '101', - ], + 'name' => 'FileFolderPath', + 'in' => 'formData', + 'schema' => ['description' => 'The path of the folder in which the file for the function is stored.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'Business_process/First_Business_Process/function/string_processing', 'title' => ''], ], [ - 'name' => 'SecondLevelThemeId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the second-level table folder.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '101', - ], + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the DataWorks workspace. You can click the Workspace Manage icon in the upper-right corner of the DataStudio page to go to the Workspace Management page and view the workspace ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10000', 'title' => ''], ], [ - 'name' => 'LevelId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The table level ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '101', - ], + 'name' => 'FileName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the file for the function.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'StringConcat', 'title' => ''], ], [ - 'name' => 'TableGuid', - 'in' => 'query', + 'name' => 'FunctionType', + 'in' => 'formData', 'schema' => [ - 'description' => 'The GUID of the table. Specify the GUID in the odps.{projectName}.{tableName} format.'."\n", + 'description' => 'The type of the function. Valid values: MATH, AGGREGATE, STRING, DATE, ANALYTIC, and OTHER. This parameter corresponds to the Function Type parameter in the Register Function section of the configuration tab of the function on the DataStudio page.'."\n", + 'enumValueTitles' => [], 'type' => 'string', 'required' => true, 'docRequired' => true, - 'example' => 'odps.test.table1', + 'enum' => ['MATH', 'AGGREGATE', 'STRING', 'DATE', 'ANALYTIC', 'OTHER'], + 'example' => 'STRING', + 'title' => '', ], ], [ - 'name' => 'LevelType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the table level. Valid values: 1 and 2. The value 1 indicates the logical level. The value 2 indicates the physical level.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2147483647', - 'minimum' => '0', - 'example' => '1', - ], + 'name' => 'ClassName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the class in which the function is defined. This parameter corresponds to the Class Name parameter in the Register Function section of the configuration tab of the function in the DataWorks console.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'com.alibaba.DataWorks.api.udf.StringConcat', 'title' => ''], + ], + [ + 'name' => 'Resources', + 'in' => 'formData', + 'schema' => ['description' => 'The names of the resources that are referenced by the function. This parameter corresponds to the Resources parameter in the Register Function section of the configuration tab of the function in the DataWorks console. Multiple resource names are separated by commas (,).'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'string-concat-1.0.0.jar,commons-lang-2.6.jar', 'title' => ''], + ], + [ + 'name' => 'UdfDescription', + 'in' => 'formData', + 'schema' => ['description' => 'The description of the function. This parameter corresponds to the Description parameter in the Register Function section of the configuration tab of the function on the DataStudio page.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'Concatenate several strings to generate a new string', 'title' => ''], + ], + [ + 'name' => 'CmdDescription', + 'in' => 'formData', + 'schema' => ['description' => 'The syntax used for calling the function. This parameter corresponds to the Expression Syntax parameter in the Register Function section of the configuration tab of the function in the DataWorks console.'."\n", 'type' => 'string', 'required' => false, 'example' => 'StringConcat(String... substrs)', 'title' => ''], + ], + [ + 'name' => 'ParameterDescription', + 'in' => 'formData', + 'schema' => ['description' => 'The description of the input parameters of the function. This parameter corresponds to the Parameter Description parameter in the Register Function section of the configuration tab of the function on the DataStudio page.'."\n", 'type' => 'string', 'required' => false, 'default' => '', 'example' => 'List of strings to be connected', 'title' => ''], + ], + [ + 'name' => 'ReturnValue', + 'in' => 'formData', + 'schema' => ['description' => 'The description of the return value of the function. This parameter corresponds to the Return Value parameter in the Register Function section of the configuration tab of the function on the DataStudio page.'."\n", 'type' => 'string', 'required' => false, 'default' => 'false', 'example' => 'New strings generated by concatenating all strings before and after the input order', 'title' => ''], + ], + [ + 'name' => 'Example', + 'in' => 'formData', + 'schema' => ['description' => 'The example for calling the function. This parameter corresponds to the Example parameter in the Register Function section of the configuration tab of the function in the DataWorks console.'."\n", 'type' => 'string', 'required' => false, 'example' => 'StringConcat(\'a\', \'b\', \'c\')', 'title' => ''], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => ['description' => 'The unique identifier of the DataWorks workspace. You can click the identifier in the upper-left corner of the DataStudio page to switch to another workspace.'."\n" + ."\n" + .'You must specify either this parameter or the projectId parameter to determine the DataWorks workspace to which the operation is called.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dw_project', 'title' => ''], + ], + [ + 'name' => 'CreateFolderIfNotExists', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to automatically create the directory that is specified by the FileFolderPath parameter if the directory does not exist. Valid values:'."\n" + ."\n" + .'* true: The system automatically creates the directory if the directory does not exist.'."\n" + .'* false: The system does not automatically create the directory if the directory does not exist. In this case, the call fails.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ @@ -9830,279 +6289,194 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'UpdateResult' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'abcde', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The ID of the file that was created.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100000002', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request. You can troubleshoot issues based on the ID.'."\n", 'type' => 'string', 'example' => '0000-ABCD-EFG****', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'The connection does not exist.', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned.'."\n", 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], ], 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"UpdateResult\\": true,\\n \\"RequestId\\": \\"abcde\\"\\n}","errorExample":""},{"type":"xml","example":"abcde\\ntrue","errorExample":""}]', - 'title' => 'UpdateTableModelInfo', - 'summary' => 'Modifies the information about a table, such as the table folder, level, and category.', + 'title' => 'CreateUdfFile', + 'summary' => 'Creates a file for a function in DataStudio.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateTableTheme' => [ - 'summary' => 'Creates a table theme. This operation will be replaced soon. We recommend that you do not call this operation.', - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2023-07-14T05:38:33.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 100000002,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\"\\n}","type":"json"}]', + ], + 'DeleteBaseline' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '78199', - 'abilityTreeNodes' => [ - 'FEATUREdideRZEBFC', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '158727', + 'abilityTreeNodes' => ['FEATUREdideSFSFU4'], ], 'parameters' => [ + [ + 'name' => 'BaselineId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The baseline ID. You can call the [ListBaselines](~~2261507~~) operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234'], + ], [ 'name' => 'ProjectId', - 'in' => 'query', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the workspace to which the baseline belongs. You can call the ListBaselines operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '123', + 'title' => 'OpenApiResultModel', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '1031203110000'], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'Baseline deletion failed with nodes dependent on baseline'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Data' => ['description' => 'Indicates whether the deletion was successful.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0000-ABCD-EF****'], + ], ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1031203110000\\",\\n \\"ErrorMessage\\": \\"Baseline deletion failed with nodes dependent on baseline\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"0000-ABCD-EF****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 1031203110000\\n Baseline deletion failed with nodes dependent on baseline\\n 200\\n true\\n 0000-ABCD-EF****\\n","errorExample":""}]', + 'title' => 'DeleteBaseline', + 'summary' => 'Deletes a baseline based on its ID. You can delete a baseline only if the nodes in the baseline does not have ancestor nodes. You can call the UpdateBaseline operation to delete the relationships between the nodes and their ancestor nodes.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'DeleteBusiness' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Level', - 'in' => 'query', - 'schema' => [ - 'description' => 'The level of the table theme. Valid values: 1 and 2. The value 1 indicates the first level. The value 2 indicates the second level.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '10', - 'minimum' => '1', - 'example' => '1', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '78202', + 'abilityTreeNodes' => ['FEATUREdide8FM783'], + ], + 'parameters' => [ [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the table theme.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test', - ], + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Management page to obtain the ID. You must specify either this parameter or ProjectIdentifier to determine the DataWorks workspace to which the operation is applied.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10000', 'title' => ''], ], [ - 'name' => 'ParentId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the level of the parent table theme.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '122', - ], + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Settings panel to obtain the name. You must specify either this parameter or ProjectId to determine the DataWorks workspace to which the operation is applied.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dw_project', 'title' => ''], + ], + [ + 'name' => 'BusinessId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the workflow. You can call the [ListBusiness](~~173945~~) operation to query the workflow ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1000001', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ABCd', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ThemeId' => [ - 'description' => 'The table theme ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'The connection does not exist.', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request. You can use the ID to troubleshoot issues.'."\n", 'type' => 'string', 'example' => '0000-ABCD-EFG****', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned.'."\n", 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], ], 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"ABCd\\",\\n \\"ErrorMessage\\": \\"success\\",\\n \\"ErrorCode\\": \\"0\\",\\n \\"Success\\": true,\\n \\"ThemeId\\": 123\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n ABCd\\n success\\n 0\\n true\\n 123\\n","errorExample":""}]', - 'title' => 'CreateTableTheme', + 'title' => 'DeleteBusiness', + 'summary' => 'Deletes a workflow.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteTableTheme' => [ - 'summary' => 'Deletes a table theme. This operation will be replaced soon. We recommend that you do not call this operation.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'DeleteConnection' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '78220', - 'abilityTreeNodes' => [ - 'FEATUREdideRZEBFC', - ], - ], + 'operationType' => 'write', + 'deprecated' => true, + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'ThemeId', + 'name' => 'ConnectionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the theme.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '123', - ], - ], - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the DataWorks workspace.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '123', - ], + 'schema' => ['description' => 'The data source ID. You can call the [ListConnection](~~173911~~) operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1'], ], ], 'responses' => [ @@ -10110,96 +6484,41 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'abcdef', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified parameters are invalid.', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '1031203110005', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'DeleteResult' => [ - 'description' => 'Indicates whether the theme was deleted.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'string', 'example' => '200'], + 'Data' => ['description' => 'Indicates whether the data source was removed.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0bc1411515937635****'], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true'], ], 'description' => '', ], ], ], 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + 400 => [ + ['errorCode' => 'Invalid.Tenant.ConnectionNotExists', 'errorMessage' => 'The connection does not exist.', 'description' => 'The connection does not exist.'], + ['errorCode' => 'Invalid.Tenant.ProjectNotExists', 'errorMessage' => 'The project does not exist.', 'description' => 'The project does not exist.'], + ['errorCode' => 'Invalid.Tenant.UserNotInProject', 'errorMessage' => 'The user is not in the project.', 'description' => 'The user is not in the project.'], ], - 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], + 403 => [ + ['errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin', 'errorMessage' => 'The user is not a project administrator or owner.', 'description' => 'The user is not a project administrator or owner.'], + ['errorCode' => 'Invalid.Tenant.UserNotInTenant', 'errorMessage' => 'The user is not in tenant.', 'description' => 'The user is not in tenant.'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"abcdef\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Success\\": true,\\n \\"DeleteResult\\": true\\n}","errorExample":""},{"type":"xml","example":"abcdef\\n200\\n0\\nsuccess\\ntrue\\ntrue","errorExample":""}]', - 'title' => 'DeleteTableTheme', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": true,\\n \\"RequestId\\": \\"0bc1411515937635****\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"0bc1411515937635****\\n200\\ntrue\\ntrue","errorExample":""}]', + 'title' => 'DeleteConnection', + 'summary' => 'Removes a data source.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateTableTheme' => [ - 'summary' => 'Updates a table theme. This operation will be replaced soon. We recommend that you do not call this operation.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'DeleteDIAlarmRule' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -10208,614 +6527,276 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '78386', - 'abilityTreeNodes' => [ - 'FEATUREdideRZEBFC', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '154894', + 'abilityTreeNodes' => ['FEATUREdide39WW3A'], ], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'query', + 'name' => 'DIAlarmRuleId', + 'in' => 'formData', + 'schema' => ['description' => 'The alert rule ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '34971'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '123', + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490'], + ], ], ], + ], + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490\\"\\n}","errorExample":""},{"type":"xml","example":"\\n C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490\\n","errorExample":""}]', + 'title' => 'DeleteDIAlarmRule', + 'summary' => 'Deletes an alert rule for a Data Integration task of a new version. Only the following type of task is supported: real-time data synchronization from a MySQL database to Hologres.', + 'description' => 'You can configure alert rules only for tasks whose MigrationType is set to RealtimeIncremental.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDIAlarmRule'], + ], + ], + 'ramActions' => [], + ], + 'DeleteDIJob' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the theme.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'table folder name', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '155161', + 'abilityTreeNodes' => ['FEATUREdideQHGTK4'], + ], + 'parameters' => [ [ - 'name' => 'ThemeId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the theme.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '123', - ], + 'name' => 'DIJobId', + 'in' => 'formData', + 'schema' => ['description' => 'The task ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11126'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'abcd', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified parameters are invalid.', - ], - 'UpdateResult' => [ - 'description' => 'Indicates whether the update result is returned. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '1031203110005', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D33D4A51-5845-579A-B4BA-FAADD0F83D53'], ], - 'description' => '', ], ], ], 'errorCodes' => [ 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], ], 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"abcd\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"UpdateResult\\": true,\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"abcd\\n200\\n1031203110005\\nThe specified parameters are invalid.\\ntrue\\ntrue","errorExample":""}]', - 'title' => 'UpdateTableTheme', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListTableTheme' => [ - 'summary' => 'Lists table themes. This operation will be replaced soon. We recommend that you do not call this operation.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D33D4A51-5845-579A-B4BA-FAADD0F83D53\\"\\n}","errorExample":""},{"type":"xml","example":"\\n D33D4A51-5845-579A-B4BA-FAADD0F83D53\\n","errorExample":""}]', + 'title' => 'DeleteDIJob', + 'summary' => 'Deletes a Data Integration task of a new version. Only the following type of task is supported: real-time data synchronization from a MySQL database to Hologres.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDIJob'], + ], ], + 'ramActions' => [], + ], + 'DeleteDISyncTask' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'PrivateKey' => [], + ], + [ + 'APP' => [], + ], ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '78337', - 'abilityTreeNodes' => [ - 'FEATUREdideRZEBFC', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '123', - ], - ], - [ - 'name' => 'ParentId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the parent table theme.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '121', - ], + 'schema' => ['description' => 'The ID of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the workspace ID.'."\n" + ."\n" + .'You must configure this parameter to specify the DataWorks workspace to which the operation is applied.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '10000000000', 'minimum' => '1', 'example' => '10000', 'title' => ''], ], [ - 'name' => 'PageNum', + 'name' => 'TaskType', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '1', - ], + 'schema' => ['description' => 'The type of the task. Set the value to DI\\_REALTIME, which indicates a real-time synchronization task.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DI_REALTIME', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'FileId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - ], + 'schema' => ['description' => 'The ID of the real-time synchronization task. You can call the [ListFiles](~~173942~~) operation to query the ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9999999999999999', 'minimum' => '1', 'example' => '100', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified parameters are invalid.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'abcde', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '1031203110005', - ], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.', 'type' => 'string', 'example' => '0bc1411515937635973****', 'title' => ''], 'Data' => [ - 'description' => 'The returned result.'."\n", + 'description' => 'The deletion result.', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'ThemeList' => [ - 'description' => 'The list of table levels.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'CreateTimeStamp' => [ - 'description' => 'The time when the table level was created.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123432343243', - ], - 'ParentId' => [ - 'description' => 'The ancestor node ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '122', - ], - 'ThemeId' => [ - 'description' => 'The table theme ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'ProjectId' => [ - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'Name' => [ - 'description' => 'The name of the table level.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'Level' => [ - 'description' => 'The level of the table folder. Valid values: 1 and 2. The value 1 indicates the first level. The value 2 indicates the second level.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Creator' => [ - 'description' => 'The creator of the table level.'."\n", - 'type' => 'string', - 'example' => '123455', - ], - ], - ], - ], + 'Status' => ['description' => 'Indicates whether the synchronization task is deleted. Valid values:'."\n" + ."\n" + .'- success: The synchronization task is deleted.'."\n" + ."\n" + .'- fail: The synchronization task fails to be deleted. You can troubleshoot the issue based on the failure reason.', 'type' => 'string', 'example' => 'fail', 'title' => ''], + 'Message' => ['description' => 'The reason why the synchronization task fails to be deleted. If the synchronization task is deleted, the value null is returned for this parameter.', 'type' => 'string', 'example' => 'fileId:[100] is invalid.', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + 400 => [ + ['errorCode' => 'Param.Invalid', 'errorMessage' => 'The parameter is invalid.', 'description' => 'Param invalid'], ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal error occurred.', 'description' => 'InternalError '], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"RequestId\\": \\"abcde\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 10,\\n \\"ThemeList\\": [\\n {\\n \\"CreateTimeStamp\\": 123432343243,\\n \\"ParentId\\": 122,\\n \\"ThemeId\\": 123,\\n \\"ProjectId\\": 123,\\n \\"Name\\": \\"层级名称\\",\\n \\"Level\\": 1,\\n \\"Creator\\": \\"123455\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n The specified parameters are invalid.\\n abcde\\n true\\n 1031203110005\\n \\n 10\\n \\n 123432343243\\n 122\\n 123\\n 123\\n 层级名称\\n 1\\n 123455\\n \\n \\n","errorExample":""}]', - 'title' => 'ListTableTheme', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'GetMetaTableThemeLevel' => [ - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0bc1411515937635973****\\",\\n \\"Data\\": {\\n \\"Status\\": \\"fail\\",\\n \\"Message\\": \\"fileId:[100] is invalid.\\"\\n }\\n}","type":"json"}]', + 'title' => 'DeleteDISyncTask', + 'summary' => 'Deletes a real-time synchronization task.', + 'description' => 'If you want to delete a batch synchronization task, call the DeleteFile operation. For more information, see [Delete a synchronization task](~~321443~~).', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'DeleteDataServiceApi' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '78270', - 'abilityTreeNodes' => [ - 'FEATUREdideRZEBFC', - ], - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'TableGuid', - 'in' => 'query', - 'schema' => [ - 'description' => 'The GUID of the metatable. Specify the GUID in the format of odps.${projectName}.${tableName}.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'odps.project1.name1', - ], + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10002'], ], [ - 'name' => 'DataSourceType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the data source. Set the value to odps.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'odps', - ], + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the workspace.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10001'], + ], + [ + 'name' => 'ApiId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the API in DataService Studio.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10000'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => '1324afdsfde', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'Entity' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'Theme' => [ - 'description' => 'The information about the themes of the metatable.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ParentId' => [ - 'description' => 'The ID of the parent theme.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'Name' => [ - 'description' => 'The name of the theme.'."\n", - 'type' => 'string', - 'example' => 'theme1', - ], - 'ThemeId' => [ - 'description' => 'The ID of the theme.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'Level' => [ - 'description' => 'The level of the theme. Valid values:'."\n" - ."\n" - .'* 1'."\n" - .'* 2'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - ], - ], - ], - 'Level' => [ - 'description' => 'The information about the levels of the metatable.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the level. Valid values:'."\n" - ."\n" - .'* 1: indicates the logical level.'."\n" - .'* 2: indicates the physical level.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Description' => [ - 'description' => 'The description of the level.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'Name' => [ - 'description' => 'The name of the level.'."\n", - 'type' => 'string', - 'example' => 'level1', - ], - 'LevelId' => [ - 'description' => 'The ID of the level.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], - ], - ], - ], - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Data' => ['description' => 'Indicates whether the API was deleted.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The connection does not exist.'], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0000-ABCD-EFG****'], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists'], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true'], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Invalid.Meta.TableNotExist', - 'errorMessage' => 'The table does not exist.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.CommonError', - 'errorMessage' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.Illegal', - 'errorMessage' => 'The app guid parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.IllegalDate', - 'errorMessage' => 'The date format is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.IllegalPageError', - 'errorMessage' => 'The parameter for paging is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.NotExist', - 'errorMessage' => 'The object does not exist.', - ], - ], 403 => [ - [ - 'errorCode' => 'Forbidden.Meta.NoTenant', - 'errorMessage' => 'The user is not the owner of any tenants.', - ], - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], ], 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.Meta.NoCalcEngine', - 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.', - ], - [ - 'errorCode' => 'InternalError.Meta.TenantTimeOut', - 'errorMessage' => 'Failed to connect to the interface network.', - ], - [ - 'errorCode' => 'InternalError.Meta.Unknown', - 'errorMessage' => 'An unknown error occurred while processing your request.', - ], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"success\\",\\n \\"RequestId\\": \\"1324afdsfde\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"0\\",\\n \\"Entity\\": {\\n \\"Theme\\": [\\n {\\n \\"ParentId\\": 0,\\n \\"Name\\": \\"theme1\\",\\n \\"ThemeId\\": 123,\\n \\"Level\\": 1\\n }\\n ],\\n \\"Level\\": [\\n {\\n \\"Type\\": 1,\\n \\"Description\\": \\"描述\\",\\n \\"Name\\": \\"level1\\",\\n \\"LevelId\\": 1\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n success\\n 1324afdsfde\\n true\\n 0\\n \\n \\n 0\\n theme1\\n 123\\n 1\\n \\n \\n 1\\n 描述\\n level1\\n 1\\n \\n \\n","errorExample":""}]', - 'title' => 'GetMetaTableThemeLevel', - 'summary' => 'Fetches topics and hierarchy metadata for tables', - ], - 'CreateTableLevel' => [ - 'summary' => 'Creates a hierarchy level. This operation will be replaced soon. We recommend that you do not call this operation.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n true\\n The connection does not exist.\\n 0000-ABCD-EFG****\\n Invalid.Tenant.ConnectionNotExists\\n true\\n","errorExample":""}]', + 'title' => 'DeleteDataServiceApi', + 'summary' => 'Deletes an API in DataService Studio.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'DeleteDataServiceApiAuthority' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -10824,158 +6805,72 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '78198', - 'abilityTreeNodes' => [ - 'FEATUREdideRZEBFC', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '78205', + 'abilityTreeNodes' => ['FEATUREdideWDSR97'], ], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '123', - ], + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['description' => 'The tenant ID. This parameter is deprecated.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '10004'], ], [ - 'name' => 'LevelType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the table level. Valid values: 1 and 2. The value 1 indicates the logical level. The value 2 indicates the physical level.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '10', - 'minimum' => '1', - 'example' => '1', - ], + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The workspace ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '10003'], ], [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the table level.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'The description of the table level.'."\n", - ], + 'name' => 'ApiId', + 'in' => 'formData', + 'schema' => ['description' => 'The API ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '10001'], ], [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the table level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'The HTTP status code returned.'."\n", - ], + 'name' => 'AuthorizedProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the workspace from which you want to revoke the access permissions on the API.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '10002'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'The error message returned.'."\n", - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified parameters are invalid.', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '1031203110005', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'LevelId' => [ - 'description' => 'The table level ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0000-ABCD-EF****'], ], + 'description' => '', ], ], ], 'errorCodes' => [ 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], ], 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"请求id\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Success\\": true,\\n \\"LevelId\\": 123\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 请求id\\n The specified parameters are invalid.\\n 1031203110005\\n true\\n 123\\n","errorExample":""}]', - 'title' => 'CreateTableLevel', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'UpdateTableLevel' => [ - 'summary' => 'Updates a hierarchy level. This operation will be replaced soon. We recommend that you do not call this operation.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0000-ABCD-EF****\\"\\n}","type":"json"}]', + 'title' => 'DeleteDataServiceApiAuthority', + 'summary' => 'Revokes the access permissions on an API.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDataServiceApiAuthority'], + ], ], + 'ramActions' => [], + ], + 'DeleteDataSource' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -10983,172 +6878,57 @@ ], 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '78384', - 'abilityTreeNodes' => [ - 'FEATUREdideRZEBFC', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the DataWorks workspace.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '123', - ], - ], - [ - 'name' => 'LevelType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The table level type. Valid values: 1 and 2. The value 1 indicates the logical level. The value 2 indicates the physical level.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'maximum' => '10', - 'minimum' => '0', - 'example' => '1', - ], - ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the table level.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'level name', - ], - ], - [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the table level.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'level description', - ], - ], - [ - 'name' => 'LevelId', + 'name' => 'DataSourceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the table level. You can call the ListTableLevel operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '123', - ], + 'schema' => ['description' => 'The data source ID. You can call the [ListDataSources](~~211431~~) operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The returned result.'."\n", + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'abcde', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified parameters are invalid.', - ], - 'UpdateResult' => [ - 'description' => 'Indicates whether the table level is updated.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '1031203110005', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the data source was removed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0bc1411515937635****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Invalid.Tenant.ConnectionNotExists', 'errorMessage' => 'The connection does not exist.', 'description' => 'The connection does not exist.'], + ['errorCode' => 'Invalid.Tenant.ProjectNotExists', 'errorMessage' => 'The project does not exist.', 'description' => 'The project does not exist.'], + ['errorCode' => 'Invalid.Tenant.UserNotInProject', 'errorMessage' => 'The user is not in the project.', 'description' => 'The user is not in the project.'], + ['errorCode' => 'Invalid.Operation', 'errorMessage' => 'You cannot delete the bindingCalcEngine that is bound to the data source.', 'description' => 'Can not delete datasource bindingCalcEngine.'], + ], 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], + ['errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin', 'errorMessage' => 'The user is not a project administrator or owner.', 'description' => 'The user is not a project administrator or owner.'], + ['errorCode' => 'Invalid.Tenant.UserNotInTenant', 'errorMessage' => 'The user is not in tenant.', 'description' => 'The user is not in tenant.'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"abcde\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"UpdateResult\\": true,\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n abcde\\n The specified parameters are invalid.\\n true\\n 1031203110005\\n true\\n","errorExample":""}]', - 'title' => 'UpdateTableLevel', + 'title' => 'DeleteDataSource', + 'summary' => 'Removes a data source.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteTableLevel' => [ - 'summary' => 'Deletes a hierarchy level. This operation will be replaced soon. We recommend that you do not call this operation.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": true,\\n \\"RequestId\\": \\"0bc1411515937635****\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'DeleteFile' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -11158,428 +6938,240 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '78219', - 'abilityTreeNodes' => [ - 'FEATUREdideRZEBFC', - ], + 'abilityTreeCode' => '78208', + 'abilityTreeNodes' => ['FEATUREdide8FM783'], ], 'parameters' => [ [ - 'name' => 'LevelId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the table level that you want to delete. You can call the ListTableLevel operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '123', - ], + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace Management page to view the workspace name.'."\n" + ."\n" + .'You must specify one of the ProjectId and ProjectIdentifier parameters to determine the DataWorks workspace to which the operation is applied.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10000', 'title' => ''], ], [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '123', - ], + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the file. You can call the [ListFiles](~~173942~~) operation to query the ID of the file.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dw_project', 'title' => ''], + ], + [ + 'name' => 'FileId', + 'in' => 'formData', + 'schema' => ['description' => 'The file ID. You can call the [ListFiles](~~173942~~) operation to query the file ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10000201', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'description' => '', 'type' => 'object', 'properties' => [ - 'DeleteResult' => [ - 'description' => 'Indicates whether the table level was deleted.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'abcde', - ], + 'HttpStatusCode' => ['description' => 'The ID of the deployment task that deploys the file. If the file has been committed, an asynchronous process is triggered to delete the file in the scheduling system. The value of this parameter is used to call the GetDeployment operation to poll the status of the asynchronous process.'."\n" + ."\n" + .'If this parameter is empty, the file is deleted and the polling is not required.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'DeploymentId' => ['description' => 'The ID of the request. You can troubleshoot errors based on the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1000000001', 'title' => ''], + 'RequestId' => ['description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => '0000-ABCD-EFG****', 'title' => ''], + 'ErrorMessage' => ['description' => 'Indicates whether the request is successful. Valid values:'."\n" + ."\n" + .'* true: The request is successful.'."\n" + .'* false: The request fails.'."\n", 'type' => 'string', 'example' => 'The connection does not exist.', 'title' => ''], + 'Success' => ['description' => 'The error code returned.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The ID of the file. You can use the ListFiles interface to query the ID of the corresponding file.', 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], ], 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"DeleteResult\\": true,\\n \\"RequestId\\": \\"abcde\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n abcde\\n","errorExample":""}]', - 'title' => 'DeleteTableLevel', + 'title' => 'DeleteFile', + 'summary' => 'Deletes a file from DataStudio. If the file has been committed, an asynchronous process is triggered to delete the file in the scheduling system. The value of the DeploymentId parameter returned is used to call the GetDeployment operation to poll the status of the asynchronous process.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListTableLevel' => [ - 'summary' => 'Lists hierarchy levels. This operation will be replaced soon. We recommend that you do not call this operation.', - 'methods' => [ - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"DeploymentId\\": 1000000001,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\"\\n}","type":"json"}]', + ], + 'DeleteFolder' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '78336', - 'abilityTreeNodes' => [ - 'FEATUREdideRZEBFC', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '78209', + 'abilityTreeNodes' => ['FEATUREdide8FM783'], ], 'parameters' => [ [ 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the DataWorks workspace. You can log on to the DataWorks console to obtain the workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '123', - ], - ], - [ - 'name' => 'LevelType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The table level type. Valid values: 1 and 2. The value 1 indicates the logical level. The value 2 indicates the physical level.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '10', - 'minimum' => '0', - 'example' => '1', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the DataWorks workspace. To obtain the workspace ID, log on to the DataWorks console and go to the Workspace Management page. You must set this parameter or ProjectIdentifier to specify the DataWorks workspace for the API call.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10000', 'title' => ''], ], [ - 'name' => 'PageNum', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the DataWorks workspace. To obtain the workspace name, log on to the DataWorks console and go to the Workspace Management page. You must set this parameter or ProjectId to specify the DataWorks workspace for the API call.', 'type' => 'string', 'required' => false, 'example' => 'dw_project', 'title' => ''], ], [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'name' => 'FolderId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the folder. For more information about how to obtain the folder ID, see [ListFolders](~~173955~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2eb6f9****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The returned result.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified parameters are invalid.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'abc', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '1031203110005 ', - ], - 'TableLevelInfo' => [ - 'description' => 'The information about the table levels.'."\n", - 'type' => 'object', - 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of table levels returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'LevelList' => [ - 'description' => 'The list of table levels.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'LevelType' => [ - 'description' => 'The table level type. Valid values: 1 and 2. The value 1 indicates the logical level. The value 2 indicates the physical level.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Description' => [ - 'description' => 'The description of the table level.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'Name' => [ - 'description' => 'The name of the table level.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'ProjectId' => [ - 'description' => 'The ID of the DataWorks workspace.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'LevelId' => [ - 'description' => 'The table level ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - ], - ], - ], - ], - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The connection does not exist.', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request. You can use the ID to troubleshoot issues.', 'type' => 'string', 'example' => '0000-ABCD-EFG****', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], ], 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"RequestId\\": \\"abc\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1031203110005\\\\t\\",\\n \\"TableLevelInfo\\": {\\n \\"TotalCount\\": 10,\\n \\"LevelList\\": [\\n {\\n \\"LevelType\\": 1,\\n \\"Description\\": \\"层级描述\\",\\n \\"Name\\": \\"层级1\\",\\n \\"ProjectId\\": 123,\\n \\"LevelId\\": 123\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n The specified parameters are invalid.\\n abc\\n true\\n 1031203110005\\t\\n \\n 10\\n \\n 1\\n 层级描述\\n 层级1\\n 123\\n 123\\n \\n \\n","errorExample":""}]', - 'title' => 'ListTableLevel', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'DeleteFolder', + 'summary' => 'Deletes a folder from the Data Development page.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateMetaCollection' => [ - 'summary' => 'Updates the name and comment of a collection.', - 'methods' => [ - 'put', - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'DeleteFromMetaCategory' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '163134', - 'abilityTreeNodes' => [ - 'FEATUREdideE9XYA6', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '78210', + 'abilityTreeNodes' => ['FEATUREdideRZEBFC'], ], 'parameters' => [ [ - 'name' => 'QualifiedName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The unique identifier of the collection.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'album.396397', - ], - ], - [ - 'name' => 'Name', + 'name' => 'CategoryId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the collection.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'myCollectionName', - ], + 'schema' => ['description' => 'The ID of the category.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '5', 'title' => ''], ], [ - 'name' => 'Comment', + 'name' => 'TableGuid', 'in' => 'query', - 'schema' => [ - 'description' => 'The comment of the collection. The comment must be 1 to 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'this is a comment', - ], + 'schema' => ['description' => 'The GUID of the metatable.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'odps.engine_name.table_name', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The returned results.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-E****', - ], - 'Status' => [ - 'description' => 'The result of the operation. Valid values: true false', - 'type' => 'boolean', - 'enumValueTitles' => [], - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'The specified product does not exist.', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '9999', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the table was removed from the specified category.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0bc1ec92159376', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'The connection does not exist.', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned.'."\n", 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0000-ABCD-E****\\",\\n \\"Status\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The specified product does not exist.\\",\\n \\"ErrorCode\\": \\"9999\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 0000-ABCD-E****\\n true\\n 200\\n The specified product does not exist.\\n 9999\\n true\\n","errorExample":""}]', - 'title' => 'UpdateMetaCollection', - 'description' => 'Only the name and comment of a collection can be updated.'."\n", - 'requestParamsDescription' => 'You must configure at least one of the Name and Comment parameters when you update a collection.'."\n", - ], - 'ListMetaCollections' => [ - 'summary' => 'Queries information about collections. Collections include data albums that are displayed on the Data Map page and categories that are created in the data albums. You can call this API operation to query collections by type.', - 'methods' => [ - 'get', - 'post', + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'DeleteFromMetaCategory', + 'summary' => 'Removes a table from a specified category.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' DeleteFromMetaCategory接口的使用示例Demo请参见[DataWorks OpenAPI示例](https://developer.aliyun.com/article/780879?groupCode=dataworks)。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'DeleteLineageRelation' => [ + 'summary' => 'Delete lineage, supports deleting user-defined lineage relationships', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -11588,372 +7180,162 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '162854', - 'abilityTreeNodes' => [ - 'FEATUREdideE9XYA6', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '178630', + 'abilityTreeNodes' => ['FEATUREdideSYOMAV'], ], 'parameters' => [ [ - 'name' => 'ParentQualifiedName', + 'name' => 'SrcEntityQualifiedName', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique identifier of the parent collection.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Album.1234', - ], + 'schema' => ['description' => 'Source entity unique identifier', 'type' => 'string', 'required' => true, 'example' => 'maxcompute-table.project.table', 'title' => ''], ], [ - 'name' => 'NextToken', + 'name' => 'DestEntityQualifiedName', 'in' => 'query', - 'schema' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '12345', - ], + 'schema' => ['description' => 'Destination entity unique identifier', 'type' => 'string', 'required' => true, 'example' => 'custom-report.report123', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'RelationshipGuid', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'Lineage relationship unique identifier', 'type' => 'string', 'required' => false, 'example' => 'dfazcdfdfccdedd', 'title' => ''], ], [ - 'name' => 'Keyword', + 'name' => 'RelationshipType', 'in' => 'query', - 'schema' => [ - 'description' => 'The keyword.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - ], - [ - 'name' => 'OrderBy', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the sorting field.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - ], - [ - 'name' => 'CollectionType', - 'in' => 'query', - 'schema' => [ - 'description' => '- ALBUM: data album '."\n" - .'- ALBUM_CATEGORY: category in a data album', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [], - 'example' => 'ALBUM', - ], - ], - [ - 'name' => 'Creator', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the collection creator.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1200759642363000', - ], - ], - [ - 'name' => 'Administrator', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the collection administrator.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1200759642363000', - ], - ], - [ - 'name' => 'Follower', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the collection follower.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1200759642363000', - ], + 'schema' => ['description' => 'Relationship type', 'type' => 'string', 'required' => false, 'example' => 'sql', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'OpenApiMetaResultModel'."\n" + ."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'E25887B7-579C-54A5-9C4F-83A0DE367DDE', - ], - 'Data' => [ - 'description' => 'The returned result.'."\n", - 'type' => 'object', - 'properties' => [ - 'NextToken' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.'."\n", - 'type' => 'string', - 'example' => '37ae2053d87d380f28ce0dc0853ca51e', - ], - 'CollectionList' => [ - 'description' => 'The collections.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The collection.'."\n", - '$ref' => '#/components/schemas/Collection', - ], - ], - ], - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Collection.NotExists', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified parameters are invalid.', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'HttpStatusCode' => ['description' => 'HTTP status code'."\n" + ."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'Error message'."\n" + ."\n", 'type' => 'string', 'example' => 'qualifiedName should be in format as entity-table.entity-guid', 'title' => ''], + 'RequestId' => ['description' => 'Request ID: used for locating logs and troubleshooting'."\n" + ."\n", 'type' => 'string', 'example' => '64B-587A-8CED-969E1973887FXXX-TT', 'title' => ''], + 'Success' => ['description' => 'Whether the call was successful. Values are as follows:'."\n" + ."\n" + .'true: success'."\n" + ."\n" + .'false: failed', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'Error code'."\n" + ."\n", 'type' => 'string', 'example' => '1010040007', 'title' => ''], + 'Status' => ['description' => 'Operation result:'."\n" + ."\n" + .'true: Success'."\n" + ."\n" + .'false: Failure'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Invalid.Collection.ParamError', - 'errorMessage' => 'msg: %s', - ], - [ - 'errorCode' => 'Invalid.User.NotExist', - 'errorMessage' => 'msg: %s', - ], - [ - 'errorCode' => 'Invalid.Collection.QualifiedNameError', - 'errorMessage' => 'msg: %s', - ], - [ - 'errorCode' => 'Invalid.Collection.CollectionNotCompatible', - 'errorMessage' => 'msg: %s', - ], - [ - 'errorCode' => 'Invalid.Collection.EntityOverflow', - 'errorMessage' => 'msg: %s', - ], - [ - 'errorCode' => 'Invalid.Collection.NotExist', - 'errorMessage' => 'msg: %s', - ], - [ - 'errorCode' => 'Invalid.Collection.AlreadyExist', - 'errorMessage' => 'msg: %s', - ], - [ - 'errorCode' => 'Invalid.Collection.UnsupportedOperation', - 'errorMessage' => 'msg: %s', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.Missing', - 'errorMessage' => 'msg: %s', - ], - [ - 'errorCode' => 'Forbidden.No.Permission', - 'errorMessage' => 'msg: %s', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.IllegalData', - 'errorMessage' => 'msg: %s', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E25887B7-579C-54A5-9C4F-83A0DE367DDE\\",\\n \\"Data\\": {\\n \\"NextToken\\": \\"37ae2053d87d380f28ce0dc0853ca51e\\",\\n \\"CollectionList\\": [\\n {\\n \\"QualifiedName\\": \\"album.12334\\",\\n \\"CollectionType\\": \\"album\\",\\n \\"Name\\": \\"collectionName\\",\\n \\"Comment\\": \\"comment\\",\\n \\"OwnerId\\": \\"1234444\\",\\n \\"OwnerName\\": \\"owner\\",\\n \\"CreateTime\\": 1668600147617,\\n \\"UpdateTime\\": 1668600148617,\\n \\"Level\\": 1\\n }\\n ]\\n },\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Collection.NotExists\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"HttpStatusCode\\": 200\\n}","errorExample":""},{"type":"xml","example":"\\n E25887B7-579C-54A5-9C4F-83A0DE367DDE\\n \\n 37ae2053d87d380f28ce0dc0853ca51e\\n \\n album.12334\\n album\\n collectionName\\n comment\\n 1234444\\n owner\\n 1668600147617\\n 1668600148617\\n 1\\n \\n \\n true\\n Invalid.Collection.NotExists\\n The specified parameters are invalid.\\n 200\\n","errorExample":""}]', - 'title' => 'ListMetaCollections', - 'description' => 'The type can be ALBUM or ALBUM_CATEGORY. ALBUM indicates data albums. ALBUM_CATEGORY indicates categories.'."\n", - 'requestParamsDescription' => 'You can configure only one of the Creator, Administrator, and Follower parameters.'."\n", - ], - 'ListMetaCollectionEntities' => [ - 'summary' => 'Queries the entities in a collection.', - 'methods' => [ - 'get', - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"qualifiedName should be in format as entity-table.entity-guid\\",\\n \\"RequestId\\": \\"64B-587A-8CED-969E1973887FXXX-TT\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1010040007\\",\\n \\"Status\\": true\\n}","type":"json"}]', + 'title' => 'DeleteLineageRelation', + 'description' => 'This API is currently in the trial phase. Users who wish to experience it can apply, and after the administrator adds them to the trial list, they can call this API.', + 'changeSet' => [ + ['createdAt' => '2024-08-14T02:36:40.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'DeleteMetaCategory' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '163137', - 'abilityTreeNodes' => [ - 'FEATUREdideE9XYA6', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '78211', + 'abilityTreeNodes' => ['FEATUREdideRZEBFC'], ], 'parameters' => [ [ - 'name' => 'CollectionQualifiedName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The unique identifier of the collection.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'album.12345', - ], - ], - [ - 'name' => 'EntityType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the entities.'."\n" - ."\n" - .'For example, if this parameter is set to maxcompute-table, the entity is a MaxCompute table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'maxcompute-table', - ], - ], - [ - 'name' => 'Keyword', - 'in' => 'query', - 'schema' => [ - 'description' => 'The search keyword.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - ], - [ - 'name' => 'NextToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '12222', - ], - ], - [ - 'name' => 'PageSize', + 'name' => 'CategoryId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The ID of the category.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '23', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'OpenApiMetaResultModel', - 'description' => 'OpenApiMetaResultModel'."\n", + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'NextToken' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.'."\n", - 'type' => 'string', - 'example' => '123344', - ], - 'EntityList' => [ - 'description' => 'The entities.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The entities.'."\n", - '$ref' => '#/components/schemas/Entity', - ], - ], - ], - ], - 'RequestId' => [ - 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => 'E25887B7-579C-54A5-9C4F-83A0DE367DD', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'true: The request was successful.'."\n" - ."\n" - .'false: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Collection.NotExists', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified parameters are invalid.', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The business data.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0bc1ec92159376', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The connection does not exist.', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": {\\n \\"NextToken\\": \\"123344\\",\\n \\"EntityList\\": [\\n {\\n \\"QualifiedName\\": \\"maxcompute_table.563f0357118d05ef145d6bddf2966cc23e86ca8f2f013f915e565afdf09f7a23\\",\\n \\"TenantId\\": 12345,\\n \\"EntityContent\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ]\\n },\\n \\"RequestId\\": \\"E25887B7-579C-54A5-9C4F-83A0DE367DD\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Collection.NotExists\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"HttpStatusCode\\": 200\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 12\\n \\n \\n maxcompute-table\\n table_name_for_example\\n maxcomputeProjectName\\n cui\\n 1691563804264\\n \\n maxcompute-table.maxcomputeProjectName.table_name_for_example\\n \\n \\n E25887B7-579C-54A5-9C4F-83A0DE367DD\\n true\\n Invalid.Collection.NotExists\\n The specified parameters are invalid.\\n 200\\n","errorExample":""}]', - 'title' => 'ListMetaCollectionEntities', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Invalid.Meta.CategoryIllegalDepth', 'errorMessage' => 'A category can contain a maximum of 4 levels.', 'description' => 'A category can contain a maximum of 4 levels.'], + ['errorCode' => 'Invalid.Meta.CategoryNameDuplicate', 'errorMessage' => 'The category name is duplicated at this level.', 'description' => 'The category name is duplicated at this level.'], + ['errorCode' => 'Invalid.Meta.TableNotExist', 'errorMessage' => 'The table does not exist.', 'description' => 'The table does not exist.'], + ['errorCode' => 'InvalidParameter.Meta.CommonError', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The request parameter is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.Illegal', 'errorMessage' => 'The app guid parameter is invalid.', 'description' => 'The app guid parameter is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.IllegalDate', 'errorMessage' => 'The date format is invalid.', 'description' => 'The date format is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.IllegalPageError', 'errorMessage' => 'The parameter for paging is invalid.', 'description' => 'The parameter for paging is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.NotExist', 'errorMessage' => 'The object does not exist.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'Forbidden.Meta.NoTenant', 'errorMessage' => 'The user is not the owner of any tenants.', 'description' => 'The user is not the owner of any tenants.'], + ['errorCode' => 'Invalid.Meta.CategoryForbidden', 'errorMessage' => 'Failed to delete the category. The current category is associated with a table and cannot be operated.', 'description' => 'Failed to delete the category because the table associated with the category does not exist.'], + ['errorCode' => 'Invalid.Meta.CategoryIllegalTenant', 'errorMessage' => 'The tenant ID is different in the parent and child categories.', 'description' => 'The tenant ID is different in the parent and child categories.'], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.Meta.NoCalcEngine', 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.', 'description' => ''], + ['errorCode' => 'InternalError.Meta.TenantTimeOut', 'errorMessage' => 'Failed to connect to the interface network.', 'description' => 'Failed to connect to the interface network.'], + ['errorCode' => 'InternalError.Meta.Unknown', 'errorMessage' => 'An unknown error occurred while processing your request.', 'description' => 'An unknown error occurred while processing your request.'], + ['errorCode' => 'Invalid.Meta.CategoryRelationDuplicate"', 'errorMessage' => 'The table is already bound to the category.', 'description' => ''], + ], + ], + 'title' => 'DeleteMetaCategory', + 'summary' => 'Deletes a category.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' DeleteMetaCategory接口的使用示例Demo请参见[DataWorks OpenAPI示例](https://developer.aliyun.com/article/780879?groupCode=dataworks)。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'DeleteMetaCollection' => [ 'summary' => 'Deletes a collection.', - 'methods' => [ - 'delete', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['delete', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -11964,20 +7346,13 @@ 'systemTags' => [ 'operationType' => 'delete', 'abilityTreeCode' => '163135', - 'abilityTreeNodes' => [ - 'FEATUREdideE9XYA6', - ], + 'abilityTreeNodes' => ['FEATUREdideE9XYA6'], ], 'parameters' => [ [ 'name' => 'QualifiedName', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique identifier of the collection.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'album.12333', - ], + 'schema' => ['description' => 'The unique identifier of the collection.'."\n", 'type' => 'string', 'required' => true, 'example' => 'album.12333', 'title' => ''], ], ], 'responses' => [ @@ -11987,148 +7362,107 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-E****', - ], - 'Status' => [ - 'description' => 'The result of the operation. Valid values:'."\n" - ."\n" - .'true: succeeded'."\n" - ."\n" - .'false: failed'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified product does not exist.', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '999999', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'true'."\n" - ."\n" - .'false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0000-ABCD-E****'], + 'Status' => ['description' => 'The result of the operation. Valid values:'."\n" + ."\n" + .'true: succeeded'."\n" + ."\n" + .'false: failed'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The specified product does not exist.', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '999999', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'true'."\n" + ."\n" + .'false'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0000-ABCD-E****\\",\\n \\"Status\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The specified product does not exist.\\",\\n \\"ErrorCode\\": \\"999999\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 0000-ABCD-E****\\n true\\n 200\\n The specified product does not exist.\\n 999999\\n true\\n","errorExample":""}]', 'title' => 'DeleteMetaCollection', - ], - 'GetMetaCollectionDetail' => [ - 'summary' => 'Queries the information about a collection.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMetaCollection'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0000-ABCD-E****\\",\\n \\"Status\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The specified product does not exist.\\",\\n \\"ErrorCode\\": \\"999999\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'DeleteMetaCollectionEntity' => [ + 'methods' => ['delete', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '163136', - 'abilityTreeNodes' => [ - 'FEATUREdideE9XYA6', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '163139', + 'abilityTreeNodes' => ['FEATUREdideE9XYA6'], ], 'parameters' => [ [ - 'name' => 'QualifiedName', + 'name' => 'CollectionQualifiedName', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique identifier of the collection.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'album.12345', - ], + 'schema' => ['description' => 'The unique identifier of the collection.'."\n", 'type' => 'string', 'required' => true, 'example' => 'album.12345'], + ], + [ + 'name' => 'EntityQualifiedName', + 'in' => 'query', + 'schema' => ['description' => 'The unique identifier of the entity.'."\n", 'type' => 'string', 'required' => true, 'example' => 'maxcompute.projectA.tableB'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The returned result.'."\n", + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-E****', - ], - 'Collection' => [ - 'description' => 'The information about the collection.'."\n", - '$ref' => '#/components/schemas/Collection', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'true'."\n" - ."\n" - .'false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '9999', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'album.xxxx does not exist.', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request'."\n", 'type' => 'string', 'example' => '0000-ABCD-E****'], + 'Status' => ['description' => 'The result of the operation. Valid values:'."\n" + ."\n" + .'true: succeeded'."\n" + ."\n" + .'false: failed'."\n", 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'entity not exist'], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '999999'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'true'."\n" + ."\n" + .'false'."\n", 'type' => 'boolean', 'example' => 'true'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0000-ABCD-E****\\",\\n \\"Collection\\": {\\n \\"QualifiedName\\": \\"album.12334\\",\\n \\"CollectionType\\": \\"album\\",\\n \\"Name\\": \\"collectionName\\",\\n \\"Comment\\": \\"comment\\",\\n \\"OwnerId\\": \\"1234444\\",\\n \\"OwnerName\\": \\"owner\\",\\n \\"CreateTime\\": 1668600147617,\\n \\"UpdateTime\\": 1668600148617,\\n \\"Level\\": 1\\n },\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"9999\\",\\n \\"ErrorMessage\\": \\"album.xxxx does not exist.\\",\\n \\"HttpStatusCode\\": 200\\n}","errorExample":""},{"type":"xml","example":"\\n 0000-ABCD-E****\\n \\n album.12334\\n album\\n collectionName\\n comment\\n 1234444\\n owner\\n 1668600147617\\n 1668600148617\\n 1\\n \\n true\\n 9999\\n album.xxxx does not exist.\\n","errorExample":""}]', - 'title' => 'GetMetaCollectionDetail', - ], - 'DeleteMetaCollectionEntity' => [ - 'summary' => 'Deletes an entity from a collection.', - 'methods' => [ - 'delete', - 'post', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Invalid.Entity.NotExist', 'errorMessage' => '%s', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0000-ABCD-E****\\",\\n \\"Status\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"entity not exist\\",\\n \\"ErrorCode\\": \\"999999\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 0000-ABCD-E****\\n true\\n 200\\n entity not exist\\n 999999\\n true\\n","errorExample":""}]', + 'title' => 'DeleteMetaCollectionEntity', + 'summary' => 'Deletes an entity from a collection.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMetaCollectionEntity'], + ], ], + 'ramActions' => [], + ], + 'DeleteProjectMember' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -12138,1171 +7472,750 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'delete', - 'abilityTreeCode' => '163139', - 'abilityTreeNodes' => [ - 'FEATUREdideE9XYA6', - ], + 'abilityTreeCode' => '78212', + 'abilityTreeNodes' => ['FEATUREdideZ4P4R1'], ], 'parameters' => [ [ - 'name' => 'CollectionQualifiedName', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique identifier of the collection.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'album.12345', - ], + 'schema' => ['description' => 'The ID of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the workspace ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '100000000', 'minimum' => '0', 'example' => '27', 'title' => ''], ], [ - 'name' => 'EntityQualifiedName', + 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique identifier of the entity.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'maxcompute.projectA.tableB', - ], + 'schema' => ['description' => 'The user ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1234', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-E****', - ], - 'Status' => [ - 'description' => 'The result of the operation. Valid values:'."\n" - ."\n" - .'true: succeeded'."\n" - ."\n" - .'false: failed'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'entity not exist', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '999999', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'true'."\n" - ."\n" - .'false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AFAE64E-D1BE-432B-A9****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Invalid.Entity.NotExist', - 'errorMessage' => '%s', - ], + ['errorCode' => 'Invalid.Tenant.ConnectionNotExists', 'errorMessage' => 'The connection does not exist.', 'description' => 'The connection does not exist.'], + ['errorCode' => 'Invalid.Tenant.ProjectNotExists', 'errorMessage' => 'The project does not exist.', 'description' => 'The project does not exist.'], + ['errorCode' => 'Invalid.Tenant.UserAlreadyInProject', 'errorMessage' => 'The user already exists in the project.', 'description' => 'The user has already existed in project.'], + ['errorCode' => 'Invalid.Tenant.UserNotInTenant', 'errorMessage' => 'The user is not in the tenant.', 'description' => 'The user is not in the tenant.'], + ], + 403 => [ + ['errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin', 'errorMessage' => 'The user is not a project administrator or owner.', 'description' => 'The user is not a project administrator or owner.'], + ['errorCode' => 'Invalid.Tenant.UserNotInTenant', 'errorMessage' => 'The user is not in tenant.', 'description' => 'The user is not in tenant.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0000-ABCD-E****\\",\\n \\"Status\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"entity not exist\\",\\n \\"ErrorCode\\": \\"999999\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 0000-ABCD-E****\\n true\\n 200\\n entity not exist\\n 999999\\n true\\n","errorExample":""}]', - 'title' => 'DeleteMetaCollectionEntity', - ], - 'AddMetaCollectionEntity' => [ - 'summary' => 'Adds an entity to a collection.', - 'methods' => [ - 'post', + 'title' => 'DeleteProjectMember', + 'summary' => 'Removes a user from a DataWorks workspace.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-03-28T02:18:25.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AFAE64E-D1BE-432B-A9****\\"\\n}","type":"json"}]', + ], + 'DeleteQualityEntity' => [ + 'summary' => 'Deletes a partition expression.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'deprecated' => false, + 'deprecated' => true, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '163138', - 'abilityTreeNodes' => [ - 'FEATUREdideE9XYA6', - ], + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '78213', + 'abilityTreeNodes' => ['FEATUREdide3WJOKE'], ], 'parameters' => [ [ - 'name' => 'CollectionQualifiedName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The unique identifier of the collection.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'album.2222', - ], + 'name' => 'EntityId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the partition expression.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1234', 'title' => ''], ], [ - 'name' => 'EntityQualifiedName', - 'in' => 'query', + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the engine or data source.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'autotest', 'title' => ''], + ], + [ + 'name' => 'EnvType', + 'in' => 'formData', 'schema' => [ - 'description' => 'The unique identifier of the entity. Example: maxcompute-table.projectA.tableA.'."\n", + 'description' => 'The type of the engine or data source. Valid values: E-MapReduce (EMR), Hologres, AnalyticDB for PostgreSQL, CDH, MaxCompute, Kafka, and DataHub.', 'type' => 'string', 'required' => true, - 'example' => 'maxcompute-table.projectA.tableB', + 'docRequired' => true, + 'enum' => ['odps', 'emr', 'hadoop', 'cdh', 'hybriddb_for_postgresql', 'holodb'], + 'example' => 'odps', + 'title' => '', ], ], [ - 'name' => 'Remark', - 'in' => 'query', - 'schema' => [ - 'description' => 'The remarks of the entity. Example: latest product table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'this is a remark', - 'maxLength' => 50, - ], + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the DataWorks workspace.', 'type' => 'integer', 'format' => 'int64', 'docRequired' => true, 'required' => true, 'example' => '12345', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response data structure.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID. You can use the request ID to query logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-E****', - ], - 'Status' => [ - 'description' => 'The result of the operation. Valid values:'."\n" - ."\n" - .'* true: succeeded'."\n" - .'* false: failed'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified product does not exist.', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '9999', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'true false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the partition expression was successfully deleted.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => 'You have no permission.', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'ecb967ec-c137-48****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => '401', 'title' => ''], ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Invalid.Entity.NotExist', - 'errorMessage' => '%s', + 'title' => '', + 'example' => '', ], ], ], 'staticInfo' => [ - 'returnType' => 'synchronous', + 'substitutions' => ['dataworks-public::2024-05-18::DeleteDataQualityScan'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0000-ABCD-E****\\",\\n \\"Status\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The specified product does not exist.\\",\\n \\"ErrorCode\\": \\"9999\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 0000-ABCD-E****\\n true\\n 200\\n The specified product does not exist.\\n 9999\\n true\\n","errorExample":""}]', - 'title' => 'AddMetaCollectionEntity', - ], - 'CreateMetaCollection' => [ - 'summary' => 'Creates a collection.', - 'methods' => [ - 'post', + 'title' => 'DeleteQualityEntity', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-05-10T06:31:11.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-01-22T02:34:47.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-03-08T07:46:01.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"You have no permission.\\",\\n \\"RequestId\\": \\"ecb967ec-c137-48****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"401\\"\\n}","type":"json"}]', + ], + 'DeleteQualityFollower' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'deprecated' => false, + 'deprecated' => true, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '163133', - 'abilityTreeNodes' => [ - 'FEATUREdideE9XYA6', - ], + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '78214', + 'abilityTreeNodes' => ['FEATUREdideGJ7UNJ'], ], 'parameters' => [ [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the collection. The name must be 1 to 32 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'collection_name', - ], - ], - [ - 'name' => 'Comment', - 'in' => 'query', - 'schema' => [ - 'description' => 'The comment of the collection. The comment must be 1 to 64 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'this is a comment', - ], + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the engine or data source where the partition expression is located. You can log in to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Data Quality page to obtain the name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'autotest', 'title' => ''], ], [ - 'name' => 'ParentQualifiedName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The unique identifier of the parent collection.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'album.333508', - ], + 'name' => 'FollowerId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the follower. You can call the [GetQualityFollower](~~174000~~) operation to obtain the ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1234', 'title' => ''], ], [ - 'name' => 'CollectionType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the collection.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ALBUM', - ], + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the DataWorks workspace. You can log in to the DataWorks console and go to the Workspace Management page to obtain the workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'E6F0DBDD-5AD****', - ], - 'QualifiedName' => [ - 'description' => 'The unique identifier of the collection.'."\n", - 'type' => 'string', - 'example' => 'album.11111', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'NoPermission', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified parameters are invalid.', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'string', - 'example' => '200', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the follower of the partition filter expression was deleted. Valid values:'."\n" + ."\n" + .'- `true`: The follower was deleted.'."\n" + ."\n" + .'- `false`: The follower failed to be deleted. You can troubleshoot the issue based on the error message.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the follower of the partition filter expression fails to be deleted.', 'type' => 'string', 'example' => 'You have no permission.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. This parameter is used to troubleshoot issues.', 'type' => 'string', 'example' => '6d739ef6-098a-47****', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '401', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"QualifiedName\\": \\"album.11111\\",\\n \\"Success\\": \\"true\\",\\n \\"ErrorCode\\": \\"NoPermission\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"HttpStatusCode\\": \\"200\\"\\n}","errorExample":""},{"type":"xml","example":"\\n E6F0DBDD-5AD****\\n album.1111\\n true\\n 9999\\n The specified parameters are invalid.\\n 200\\n","errorExample":""}]', - 'title' => 'CreateMetaCollection', - 'description' => 'Collections are classified into various types. The names of collections of the same type must be different.'."\n", - 'requestParamsDescription' => 'A category must belong to a data album. You can create a category in a data album only after you create the data album. You can set the parentQualifiedName parameter to the unique identifier of the data album to create the category.'."\n", - ], - 'ListLineage' => [ - 'summary' => 'Queries the ancestor or descendant lineage of an entity.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => [ + 'substitutions' => ['dataworks-public::2024-05-18::DeleteDataQualityAlertRule'], + ], + 'title' => 'DeleteQualityFollower', + 'summary' => 'Deletes a Follower from a partition expression.', + 'description' => 'Data Quality uses partition expressions to determine which monitoring rules to configure. These rules help you immediately detect changes in a data source and identify dirty data generated during ETL processes. These rules can automatically block tasks to prevent dirty data from propagating downstream. This practice prevents tasks from producing unexpected data that could affect normal operations. You can add Followers to a partition expression. When a monitoring rule for that partition expression is triggered, the specified Followers receive a notification, which helps them quickly identify and resolve the issue. For more information, see [Configure monitoring rules](~~73690~~).', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-08-29T02:36:21.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-03-08T07:46:00.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-03-15T06:07:16.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"You have no permission.\\",\\n \\"RequestId\\": \\"6d739ef6-098a-47****\\",\\n \\"ErrorCode\\": \\"401\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'DeleteQualityRelativeNode' => [ + 'summary' => 'DeleteQualityRelativeNode deletes a scheduling association.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, + 'operationType' => 'write', + 'deprecated' => true, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '178500', - 'abilityTreeNodes' => [ - 'FEATUREdideSYOMAV', - ], + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdide3WJOKE'], ], 'parameters' => [ [ - 'name' => 'EntityQualifiedName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The unique identifier of the entity.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'maxcompute-table.project.table', - ], + 'name' => 'EnvType', + 'in' => 'formData', + 'schema' => ['description' => 'The type of the engine or data source. Valid values:'."\n" + ."\n" + .'- cdh'."\n" + ."\n" + .'- analyticdb\\_for\\_mysql'."\n" + ."\n" + .'- odps'."\n" + ."\n" + .'- emr'."\n" + ."\n" + .'- hadoop'."\n" + ."\n" + .'- holodb'."\n" + ."\n" + .'- hybriddb\\_for\\_postgresql', 'type' => 'string', 'required' => true, 'docRequired' => true, 'maxLength' => 40, 'minLength' => 1, 'example' => 'ODPS', 'title' => ''], ], [ - 'name' => 'NextToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'next-token-from-previous-request', - ], + 'name' => 'MatchExpression', + 'in' => 'formData', + 'schema' => ['description' => 'The partition filter expression.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'maxLength' => 80, 'minLength' => 1, 'example' => 'dt=$[yyyymmdd]', 'title' => ''], ], [ - 'name' => 'Keyword', - 'in' => 'query', - 'schema' => [ - 'description' => 'The keyword of the entity name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'name-keyword', - ], + 'name' => 'NodeId', + 'in' => 'formData', + 'schema' => ['description' => 'The node ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '156234', 'title' => ''], ], [ - 'name' => 'Direction', - 'in' => 'query', - 'schema' => [ - 'description' => 'The lineage type. Valid values:'."\n" - ."\n" - .'* up: ancestor lineage'."\n" - .'* down: descendant lineage'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'up', - ], - ], + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '12345', 'title' => ''], + ], [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'name' => 'TargetNodeProjectName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the workspace that contains the associated scheduling node.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'maxLength' => 512, 'minLength' => 1, 'example' => 'autotest', 'title' => ''], + ], + [ + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the workspace.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'autotest', 'title' => ''], + ], + [ + 'name' => 'TableName', + 'in' => 'formData', + 'schema' => ['description' => 'The table name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'maxLength' => 128, 'minLength' => 1, 'example' => 'dual', 'title' => ''], + ], + [ + 'name' => 'TargetNodeProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the workspace that contains the associated scheduling node.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '12345', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'OpenApiMetaResultModel'."\n", + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'qualifiedName should be in format as entity-table.entity-guid', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '64B-587A-8CED-969E1973887FXXX-TT', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '1010040007', - ], - 'Data' => [ - 'description' => 'The structure returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'NextToken' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.'."\n", - 'type' => 'string', - 'example' => 'nextTokenFromRequest-xxxsd-ff', - ], - 'DataEntityList' => [ - 'description' => 'The array of the entity structure.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The entity structure.'."\n", - 'type' => 'object', - 'properties' => [ - 'Entity' => [ - 'description' => 'The information about the entity.'."\n", - '$ref' => '#/components/schemas/Entity', - ], - 'CreateTimestamp' => [ - 'description' => 'The time when the lineage was generated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1686215809269', - ], - 'RelationList' => [ - 'description' => 'The array of the relationship structure.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The relationship structure.'."\n", - 'type' => 'object', - 'properties' => [ - 'Guid' => [ - 'description' => 'The unique relationship ID.'."\n", - 'type' => 'string', - 'example' => 'aaabbccddguid', - ], - 'Datasource' => [ - 'description' => 'The data source.'."\n", - 'type' => 'string', - 'example' => 'mysql', - ], - 'Type' => [ - 'description' => 'The task type, which is used to describe the relationship between entities, such as SQL-based calculation, mapping based on report fields, or API operation definition.'."\n", - 'type' => 'string', - 'example' => 'sql', - ], - 'Channel' => [ - 'description' => 'The data channel. Valid values:'."\n" - ."\n" - .'* **FIRST_PARTY: DataWorks platform**'."\n" - .'* **THIRD_PARTY: user registration**'."\n", - 'type' => 'string', - 'example' => 'THIRD_PARTY', - ], - ], - ], - ], - ], - ], - ], - ], - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the scheduling association was successfully deleted.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'You have no permission.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6d739ef6-098a-47****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '401', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"qualifiedName should be in format as entity-table.entity-guid\\",\\n \\"RequestId\\": \\"64B-587A-8CED-969E1973887FXXX-TT\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1010040007\\",\\n \\"Data\\": {\\n \\"NextToken\\": \\"nextTokenFromRequest-xxxsd-ff\\",\\n \\"DataEntityList\\": [\\n {\\n \\"Entity\\": {\\n \\"QualifiedName\\": \\"maxcompute_table.563f0357118d05ef145d6bddf2966cc23e86ca8f2f013f915e565afdf09f7a23\\",\\n \\"TenantId\\": 12345,\\n \\"EntityContent\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"CreateTimestamp\\": 1686215809269,\\n \\"RelationList\\": [\\n {\\n \\"Guid\\": \\"aaabbccddguid\\",\\n \\"Datasource\\": \\"maxcompute,mysql\\",\\n \\"Type\\": \\"sql\\",\\n \\"Channel\\": \\"THIRD_PARTY\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n qualifiedName should be in format as entity-table.entity-guid\\n 64B-587A-8CED-969E1973887FXXX-TT\\n true\\n 1010040007\\n \\n nextTokenFromRequest-xxxsd-ff\\n \\n \\n maxcompute_table.563f0357118d05ef145d6bddf2966cc23e86ca8f2f013f915e565afdf09f7a23\\n 12345\\n \\n 1686215809269\\n \\n aaabbccddguid\\n mysql\\n sql\\n THIRD_PARTY\\n \\n \\n \\n","errorExample":""}]', - 'title' => 'ListLineage', - ], - 'DeleteLineageRelation' => [ - 'summary' => 'Delete lineage, supports deleting user-defined lineage relationships', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => [ + 'substitutions' => ['dataworks-public::2024-05-18::UpdateDataQualityScan'], + ], + 'title' => 'DeleteQualityRelativeNode', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-05-10T06:31:07.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-03-08T07:46:00.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"You have no permission.\\",\\n \\"RequestId\\": \\"6d739ef6-098a-47****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"401\\"\\n}","type":"json"}]', + ], + 'DeleteQualityRule' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, + 'operationType' => 'write', + 'deprecated' => true, 'systemTags' => [ 'operationType' => 'delete', - 'abilityTreeCode' => '178630', - 'abilityTreeNodes' => [ - 'FEATUREdideSYOMAV', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '78216', + 'abilityTreeNodes' => ['FEATUREdide3WJOKE'], ], 'parameters' => [ [ - 'name' => 'SrcEntityQualifiedName', - 'in' => 'query', - 'schema' => [ - 'description' => 'Source entity unique identifier', - 'type' => 'string', - 'required' => true, - 'example' => 'maxcompute-table.project.table', - ], - ], - [ - 'name' => 'DestEntityQualifiedName', - 'in' => 'query', - 'schema' => [ - 'description' => 'Destination entity unique identifier', - 'type' => 'string', - 'required' => true, - 'example' => 'custom-report.report123', - ], + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the compute engine or data source.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'autotest', 'title' => ''], ], [ - 'name' => 'RelationshipGuid', - 'in' => 'query', - 'schema' => [ - 'description' => 'Lineage relationship unique identifier', - 'type' => 'string', - 'required' => false, - 'example' => 'dfazcdfdfccdedd', - ], + 'name' => 'RuleId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the data quality rule.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1234', 'title' => ''], ], [ - 'name' => 'RelationshipType', - 'in' => 'query', - 'schema' => [ - 'description' => 'Relationship type', - 'type' => 'string', - 'required' => false, - 'example' => 'sql', - ], + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Management page to obtain the workspace ID.', 'type' => 'integer', 'format' => 'int64', 'docRequired' => true, 'required' => true, 'example' => '10000', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'OpenApiMetaResultModel'."\n" - ."\n", + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'HTTP status code'."\n" - ."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => 'Error message'."\n" - ."\n", - 'type' => 'string', - 'example' => 'qualifiedName should be in format as entity-table.entity-guid', - ], - 'RequestId' => [ - 'description' => 'Request ID: used for locating logs and troubleshooting'."\n" - ."\n", - 'type' => 'string', - 'example' => '64B-587A-8CED-969E1973887FXXX-TT', - ], - 'Success' => [ - 'description' => 'Whether the call was successful. Values are as follows:'."\n" - ."\n" - .'true: success'."\n" - ."\n" - .'false: failed', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'Error code'."\n" - ."\n", - 'type' => 'string', - 'example' => '1010040007', - ], - 'Status' => [ - 'description' => 'Operation result:'."\n" - ."\n" - .'true: Success'."\n" - ."\n" - .'false: Failure'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the data quality rule was successfully deleted.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => 'You have no permission.', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '6d739ef6-098a-47****', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => '401', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"qualifiedName should be in format as entity-table.entity-guid\\",\\n \\"RequestId\\": \\"64B-587A-8CED-969E1973887FXXX-TT\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1010040007\\",\\n \\"Status\\": true\\n}","type":"json"}]', - 'title' => 'DeleteLineageRelation', - 'description' => 'This API is currently in the trial phase. Users who wish to experience it can apply, and after the administrator adds them to the trial list, they can call this API.', - 'translator' => 'machine', - ], - 'RegisterLineageRelation' => [ - 'summary' => 'Registers the lineage between self-managed entities to DataWorks.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => [ + 'substitutions' => ['dataworks-public::2024-05-18::UpdateDataQualityScan'], + ], + 'title' => 'DeleteQualityRule', + 'summary' => 'Deletes a data quality rule.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-01-22T02:34:47.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-08-29T02:36:21.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-03-08T07:46:00.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-03-15T06:07:16.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"You have no permission.\\",\\n \\"RequestId\\": \\"6d739ef6-098a-47****\\",\\n \\"ErrorCode\\": \\"401\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'DeleteRecognizeRule' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '178589', - 'abilityTreeNodes' => [ - 'FEATUREdideSYOMAV', - ], + 'operationType' => 'delete', + 'abilityTreeCode' => '212271', + 'abilityTreeNodes' => ['FEATUREdideDCM5VK'], ], 'parameters' => [ [ - 'name' => 'LineageRelationRegisterVO', + 'name' => 'SensitiveId', 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The structure whose lineage you want to register to DataWorks.'."\n", - 'required' => true, - '$ref' => '#/components/schemas/LineageRelationRegisterVO', - ], + 'schema' => ['description' => 'The ID of the sensitive field. You can call the [QuerySensNodeInfo](~~2747189~~) operation to query the ID.'."\n", 'type' => 'string', 'required' => true, 'example' => '27f5f5e2-ec60-4567-b1e4-779ac3681024'], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n", 'type' => 'string', 'required' => true, 'example' => '10241024'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'OpenApiMetaResultModel'."\n", + 'title' => 'OpenApiResultModel', + 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The entity of lineage not exist, xxx', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => 'EE50E05E-028C-182B-9xxx', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '1010210001', - ], - 'LineageRelation' => [ - 'description' => 'The lineage.'."\n", - 'type' => 'object', - 'properties' => [ - 'SrcEntityQualifiedName' => [ - 'description' => 'The unique identifier of the source entity.'."\n", - 'type' => 'string', - 'example' => 'maxcompute-table.project.table', - ], - 'DestEntityQualifiedName' => [ - 'description' => 'The unique identifier of the destination entity.'."\n", - 'type' => 'string', - 'example' => 'custom-report.month_stat_user', - ], - 'RelationshipGuid' => [ - 'description' => 'The ID of the lineage between entities.'."\n", - 'type' => 'string', - 'example' => 'dfsldfdlsfdsaaaabbbb', - ], - ], - ], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '9990030003'], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'Missing parameter'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Data' => ['description' => 'The returned data about whether the deletion is successful.'."\n", 'type' => 'any', 'example' => '{ "HttpStatusCode": 200, "Success": true }'], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '10000001'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The entity of lineage not exist, xxx\\",\\n \\"RequestId\\": \\"EE50E05E-028C-182B-****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1010210001\\",\\n \\"LineageRelation\\": {\\n \\"SrcEntityQualifiedName\\": \\"maxcompute-table.project.table\\",\\n \\"DestEntityQualifiedName\\": \\"custom-report.month_stat_user\\",\\n \\"RelationshipGuid\\": \\"dfsldfdlsfdsaaaabbbb\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n The entity of lineage not exist, xxx\\n EE50E05E-028C-182B-9xxx\\n true\\n 1010210001\\n \\n maxcompute-table.project.table\\n custom-report.month_stat_user\\n dfsldfdlsfdsaaaabbbb\\n \\n","errorExample":""}]', - 'title' => 'RegisterLineageRelation', - 'description' => 'This operation is in the trial phase. Users who need to call this operation can apply for it. The users can call this operation after the administrator adds the users to the trial list.'."\n", - 'requestParamsDescription' => 'Format of the unique identifier of an entity: EntityType.EntityGuid'."\n" - ."\n" - .' 1. The EntityType parameter identifies the type of an entity.'."\n" - .' 1.1 Existing entity types in DataWorks'."\n" - .' (1) MaxCompute table: maxcompute-table'."\n" - .' (2) MySQL table: mysql-table'."\n" - .' (3) EMR table: emr-table'."\n" - .' (4) Hologres table: holodb-table'."\n" - ."\n" - .' 1.2 Custom entity types: custom-xxx'."\n" - .' The following entity types are recommended based on user requirements:'."\n" - .' (1) Table: custom-table'."\n" - .' (2) API: custom-api'."\n" - .' (3) Application: custom-app'."\n" - .' (4) Report: custom-report'."\n" - .' (5) Dataset: custom-dataset'."\n" - .' (6) Data source: custom-datasource'."\n" - ."\n" - .' 2. The EntityGuid parameter specifies the unique identifier of an entity among multiple entities of the same type.'."\n" - .' Users can define the unique ID for a custom entity based on their business requirements.'."\n" - ."\n" - .' 3. Sample entity:'."\n" - .' 3.1 The existing lineage between system entities in DataWorks can be viewed in lineage graphs on the Data Map page.'."\n" - .' (1) maxcompute-table.project.tableName specifies the unique ID of a MaxCompute table.'."\n" - .' (2) emr-table.kadfdfaccdd4ted specifies the unique ID of an E-MapReduce (EMR) table.'."\n" - .' 3.2 Users can define the unique ID for a custom entity based on their business requirements. The unique ID cannot exceed 50 bytes in length.'."\n" - .' (1) custom-api.listUser: specifies a custom API entity. The unique identifier of the entity is listUser.'."\n" - .' (2) custom-table.db1.table2: specifies a custom table entity. The unique identifier of the entity is db1.table2.'."\n", - ], - 'GetMetaTableLineage' => [ - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'BADPARAMETERS', 'errorMessage' => 'Parameters are missing or in the wrong format.', 'description' => ''], + ['errorCode' => 'SENSITIVEDELETEERROR', 'errorMessage' => 'The sensitive field is not allowed to delete. Check sensitive field status and binding desensitization rule.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"9990030003\\",\\n \\"ErrorMessage\\": \\"Missing parameter\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"{ \\\\\\"HttpStatusCode\\\\\\": 200, \\\\\\"Success\\\\\\": true }\\",\\n \\"RequestId\\": \\"10000001\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 9990030003\\n 缺少参数\\n 200\\n { \\"HttpStatusCode\\": 200, \\"Success\\": true }\\n 10000001\\n","errorExample":""}]', + 'title' => 'DeleteRecognizeRule', + 'summary' => 'Deletes sensitive field types.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dataworks:DeleteRecognizeRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DeleteRemind' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '78266', - 'abilityTreeNodes' => [ - 'FEATUREdideSYOMAV', - ], + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '78217', + 'abilityTreeNodes' => ['FEATUREdideRJGWWC'], ], 'parameters' => [ [ - 'name' => 'TableGuid', - 'in' => 'query', + 'name' => 'RemindId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the custom monitoring alert rule.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1234', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The unique identifier of the table.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'odps.engine_name.table_name', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the deletion was successful. Valid values: true (success) and false (failure).', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified parameters are invalid.', 'title' => ''], + 'RequestId' => ['description' => 'The unique request ID. Use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '0000-ABCD-EFG****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '1031203110005', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'Direction', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies the ancestor or descendant lineage that you want to query for a field. Valid values: up and down. The value up indicates the ancestor lineage. The value down indicates the descendant lineage.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'up', - ], + ], + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'Forbidden.Not.Server', 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.', 'description' => ''], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ], + ], + 'title' => 'DeleteRemind', + 'summary' => 'Deletes a custom monitoring alert rule.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '99', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRemind'], ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1031203110005\\"\\n}","type":"json"}]', + ], + 'DeleteTable' => [ + 'summary' => 'Deletes a MaxCompute table.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'NextPrimaryKey', - 'in' => 'query', - 'schema' => [ - 'description' => 'The logic of paging. Configure this parameter based on the value of the response parameter NextPrimaryKey when the value of the response parameter HasNext is true in the previous request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'odps.engine_name.table_name1', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '78218', + 'abilityTreeNodes' => ['FEATUREdideRZEBFC'], + ], + 'parameters' => [ [ - 'name' => 'PageSize', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The ID of the DataWorks workspace.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '101', 'title' => ''], ], [ - 'name' => 'ClusterId', + 'name' => 'TableName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the E-MapReduce (EMR) cluster. Configure this parameter only if you want to query the lineage of an EMR table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], + 'schema' => ['description' => 'The name of the MaxCompute table.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'table1', 'title' => ''], ], [ - 'name' => 'DatabaseName', + 'name' => 'EnvType', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], + 'schema' => ['description' => 'The type of the compute engine or data source. Valid values:'."\n" + ."\n" + .'* cdh'."\n" + .'* analyticdb_for_mysql'."\n" + .'* odps'."\n" + .'* emr'."\n" + .'* hadoop'."\n" + .'* holodb'."\n" + .'* hybriddb_for_postgresql'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '1', 'minimum' => '0', 'example' => '1', 'title' => ''], ], [ - 'name' => 'TableName', + 'name' => 'AppGuid', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], + 'schema' => ['description' => 'The globally unique identifier (GUID) of the MaxCompute project. Specify the GUID in the odps.{projectName} format.'."\n", 'type' => 'string', 'required' => false, 'example' => 'odps.test', 'title' => ''], ], [ - 'name' => 'DataSourceType', + 'name' => 'Schema', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the data source. Valid values: odps and emr.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'emr', - ], + 'schema' => ['description' => 'The schema information of the table. You need to enter the schema information of the table if you enable the table schema in MaxCompute.'."\n", 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'description' => 'The returned result.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0bc1ec92159376', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Data' => [ - 'description' => 'The business data.'."\n", + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'abcde', 'title' => ''], + 'TaskInfo' => [ + 'description' => 'The information about the task that is used to delete the table.'."\n", 'type' => 'object', 'properties' => [ - 'NextPrimaryKey' => [ - 'description' => 'The logic of paging. If the value true is returned for the HasNext parameter and a value is returned for the NextPrimaryKey parameter in the response of the previous request, you must use the value of the NextPrimaryKey parameter for the next request.'."\n", - 'type' => 'string', - 'example' => 'odps | retail_e_commerce_2 | retail_e_commerce_2 | dws_ec_trd__cate_commodity_gmv_kpy_fy', - ], - 'HasNext' => [ - 'description' => 'Indicates whether the next page exists.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'DataEntityList' => [ - 'description' => 'The information about the table.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TableName' => [ - 'description' => 'The name of the table.'."\n", - 'type' => 'string', - 'example' => 'name', - ], - 'TableGuid' => [ - 'description' => 'The unique identifier of the table.'."\n", - 'type' => 'string', - 'example' => 'odps.tt.name', - ], - 'CreateTimestamp' => [ - 'description' => 'The time when the table was created.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1638720736000', - ], - 'DatabaseName' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'example' => 'db1', - ], - ], - ], - ], + 'Status' => ['description' => 'The status of the task that is complete.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'NextTaskId' => ['description' => 'The ID of the task that is running.'."\n", 'type' => 'string', 'example' => 'abc1', 'title' => ''], + 'TaskId' => ['description' => 'The ID of the task that is complete.'."\n", 'type' => 'string', 'example' => 'abc', 'title' => ''], + 'Content' => ['description' => 'The content of the task.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Invalid.Meta.TableNotExist', - 'errorMessage' => 'The table does not exist.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.CommonError', - 'errorMessage' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.GuidFormat', - 'errorMessage' => 'The GUID format is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.Illegal', - 'errorMessage' => 'The app guid parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.IllegalDate', - 'errorMessage' => 'The date format is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.IllegalPageError', - 'errorMessage' => 'The parameter for paging is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.NotExist', - 'errorMessage' => 'The object does not exist.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.Meta.NoCalcEngine', - 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.', - ], - ], 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Activate DataWorks first.', - ], - [ - 'errorCode' => 'ResourceNotAuthorized.Api', - 'errorMessage' => 'You are not authorized to access the resources.', - ], - [ - 'errorCode' => 'Forbidden.Meta.NoTenant', - 'errorMessage' => 'The user is not the owner of any tenants.', - ], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], ], 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.Meta.TenantTimeOut', - 'errorMessage' => 'Failed to connect to the interface network.', - ], - [ - 'errorCode' => 'InternalError.Meta.Unknown', - 'errorMessage' => 'An unknown error occurred while processing your request.', - ], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Data\\": {\\n \\"NextPrimaryKey\\": \\"odps.tt.2\\",\\n \\"HasNext\\": true,\\n \\"DataEntityList\\": [\\n {\\n \\"TableName\\": \\"name\\",\\n \\"TableGuid\\": \\"odps.tt.name\\",\\n \\"CreateTimestamp\\": 1638720736000,\\n \\"DatabaseName\\": \\"db1\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n The connection does not exist.\\n 0bc1ec92159376\\n true\\n Invalid.Tenant.ConnectionNotExists\\n \\n odps.tt.2\\n true\\n \\n name\\n odps.tt.name\\n 1638720736000\\n db1\\n \\n \\n","errorExample":""}]', - 'title' => 'GetMetaTableLineage', - 'summary' => 'Queries the lineage of a metatable.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"abcde\\",\\n \\"TaskInfo\\": {\\n \\"Status\\": \\"success\\",\\n \\"NextTaskId\\": \\"abc1\\",\\n \\"TaskId\\": \\"abc\\",\\n \\"Content\\": \\"success\\"\\n }\\n}","type":"json"}]', + 'title' => 'DeleteTable', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', - ], - 'GetMetaColumnLineage' => [ - 'methods' => [ - 'post', - 'get', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-07-19T06:35:48.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'staticInfo' => ['noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。'], + ], + 'DeleteTableLevel' => [ + 'summary' => 'Deletes a hierarchy level. This operation will be replaced soon. We recommend that you do not call this operation.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '78258', - 'abilityTreeNodes' => [ - 'FEATUREdideSYOMAV', - ], + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '78219', + 'abilityTreeNodes' => ['FEATUREdideRZEBFC'], ], 'parameters' => [ [ - 'name' => 'ColumnGuid', + 'name' => 'LevelId', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique identifier of the field.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'odps.engine_name.table_name.column_name', - ], + 'schema' => ['description' => 'The ID of the table level that you want to delete. You can call the ListTableLevel operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '123', 'title' => ''], ], [ - 'name' => 'Direction', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to query the ancestor or descendant lineage of the field. The value up indicates the ancestor lineage. The value down indicates the descendant lineage.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'up', - ], + 'schema' => ['description' => 'The DataWorks workspace ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '123', 'title' => ''], ], - [ - 'name' => 'PageNum', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'DeleteResult' => ['description' => 'Indicates whether the table level was deleted.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'abcde', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + ], + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], ], - [ - 'name' => 'ClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the E-MapReduce (EMR) cluster. Configure this parameter only when you query data in an EMR compute engine instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], - [ - 'name' => 'DatabaseName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], ], + ], + 'title' => 'DeleteTableLevel', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DeleteResult\\": true,\\n \\"RequestId\\": \\"abcde\\"\\n}","type":"json"}]', + ], + 'DeleteTableTheme' => [ + 'summary' => 'Deletes a table theme. This operation will be replaced soon. We recommend that you do not call this operation.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'TableName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the metatable.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '78220', + 'abilityTreeNodes' => ['FEATUREdideRZEBFC'], + ], + 'parameters' => [ [ - 'name' => 'ColumnName', + 'name' => 'ThemeId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the field.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], + 'schema' => ['description' => 'The ID of the theme.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '123', 'title' => ''], ], [ - 'name' => 'DataSourceType', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the data source. Valid values: odps and emr.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'emr', - ], + 'schema' => ['description' => 'The ID of the DataWorks workspace.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '123', 'title' => ''], ], ], 'responses' => [ @@ -13310,2635 +8223,2486 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0bc1ec92159376', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Data' => [ - 'description' => 'The business data.'."\n", - 'type' => 'object', - 'properties' => [ - 'PageNum' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of fields.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'DataEntityList' => [ - 'description' => 'The returned result.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ColumnGuid' => [ - 'description' => 'The unique identifier of the field.'."\n", - 'type' => 'string', - 'example' => 'odps.engine_name.table_name.1', - ], - 'ColumnName' => [ - 'description' => 'The name of the field.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'TableName' => [ - 'description' => 'The name of the table.'."\n", - 'type' => 'string', - 'example' => 'abc', - ], - 'DatabaseName' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'example' => 'abc', - ], - 'ClusterId' => [ - 'description' => 'The EMR cluster ID.'."\n", - 'type' => 'string', - 'example' => 'abc', - ], - ], - ], - ], - ], - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'abcdef', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The specified parameters are invalid.', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '1031203110005', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'DeleteResult' => ['description' => 'Indicates whether the theme was deleted.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Invalid.Meta.TableNotExist', - 'errorMessage' => 'The table does not exist.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.CommonError', - 'errorMessage' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.Illegal', - 'errorMessage' => 'The app guid parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.IllegalDate', - 'errorMessage' => 'The date format is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.IllegalPageError', - 'errorMessage' => 'The parameter for paging is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.NotExist', - 'errorMessage' => 'The object does not exist.', - ], - ], 403 => [ - [ - 'errorCode' => 'Forbidden.Meta.NoTenant', - 'errorMessage' => 'The user is not the owner of any tenants.', - ], - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], ], 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.Meta.NoCalcEngine', - 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.', - ], - [ - 'errorCode' => 'InternalError.Meta.TenantTimeOut', - 'errorMessage' => 'Failed to connect to the interface network.', - ], - [ - 'errorCode' => 'InternalError.Meta.Unknown', - 'errorMessage' => 'An unknown error occurred while processing your request.', - ], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 20,\\n \\"DataEntityList\\": [\\n {\\n \\"ColumnGuid\\": \\"odps.engine_name.table_name.1\\",\\n \\"ColumnName\\": \\"1\\",\\n \\"TableName\\": \\"abc\\",\\n \\"DatabaseName\\": \\"abc\\",\\n \\"ClusterId\\": \\"abc\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"0bc1ec92159376\\n200\\n\\n 20\\n 1\\n 10\\n \\n 1\\n abc\\n odps.engine_name.table_name.1\\n abc\\n abc\\n \\n\\nInvalid.Tenant.ConnectionNotExists\\nThe connection does not exist.\\ntrue","errorExample":""}]', - 'title' => 'GetMetaColumnLineage', - 'summary' => 'Queries the lineage of a field in a metatable.', + 'title' => 'DeleteTableTheme', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', - 'extraInfo' => 'For information about the example on how to use the GetMetaColumnLineage operation, see [Examples of DataWorks API operations](https://developer.aliyun.com/article/780879?groupCode=dataworks).'."\n", - ], - 'CreateFile' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"abcdef\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Success\\": true,\\n \\"DeleteResult\\": true\\n}","type":"json"}]', + ], + 'DeployDISyncTask' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '78185', - 'abilityTreeNodes' => [ - 'FEATUREdideHO4TQP', - 'FEATUREdide8FM783', + [ + 'PrivateKey' => [], + ], + [ + 'APP' => [], ], ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'FileFolderPath', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The path of the file.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'Business_process/First_Business_Process/MaxCompute/Folder_1/Folder_2', - ], + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The type of the object that you want to deploy. Valid values:'."\n" + ."\n" + .'* DI_REALTIME: real-time synchronization node'."\n" + .'* DI_SOLUTION: data synchronization solution'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '10000000000', 'minimum' => '1', 'example' => '10000', 'title' => ''], ], [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace Management page to obtain the workspace ID.'."\n" - ."\n" - .'You must configure this parameter or the ProjectIdentifier parameter to determine the DataWorks workspace to which the operation is applied.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'example' => '10000', - ], + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the object that you want to deploy. Valid values:'."\n" + ."\n" + .'* DI_REALTIME: real-time synchronization task'."\n" + .'* DI_SOLUTION: synchronization task created in Data Integration'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DI_REALTIME', 'title' => ''], ], [ - 'name' => 'FileName', - 'in' => 'formData', + 'name' => 'FileId', + 'in' => 'query', + 'schema' => ['description' => '* If you set the TaskType parameter to DI_REALTIME, set the FileId parameter to the ID of the real-time synchronization task that you want to deploy.'."\n" + .'* If you set the TaskType parameter to DI_SOLUTION, set the FileId parameter to the ID of the synchronization task that you want to deploy.'."\n" + ."\n" + .'You can call the [ListFiles](~~173942~~) operation to query the ID of the real-time synchronization task or the synchronization task created in Data Integration.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9999999999999999', 'minimum' => '1', 'example' => '100', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The name of the file.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'File name', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'The ID of the request. You can query logs and troubleshoot issues based on the ID.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '0bc14115159376359******', 'title' => ''], + 'Data' => [ + 'description' => 'Indicates whether the real-time synchronization node or data synchronization solution is deployed. Valid values:'."\n" + ."\n" + .'* success: The real-time synchronization node or data synchronization solution is deployed.'."\n" + .'* fail: The real-time synchronization node or data synchronization solution fails to be deployed.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The cause of the failure to deploy the real-time synchronization node or data synchronization solution.'."\n" + ."\n" + .'If the real-time synchronization node or data synchronization solution is deployed, the value null is returned.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Message' => ['description' => 'The reason for the failure to publish a data integration synchronization task.'."\n" + ."\n" + .'If the data integration synchronization task is published successfully, the return value of this parameter is empty.', 'type' => 'string', 'example' => 'submit and deploy fail.', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Param.Invalid', 'errorMessage' => 'The parameter is invalid.', 'description' => 'Param invalid'], + ], + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal error occurred.', 'description' => 'InternalError '], + ], + ], + 'title' => 'DeployDISyncTask', + 'summary' => 'Deploys a real-time synchronization task.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0bc14115159376359******\\",\\n \\"Data\\": {\\n \\"Status\\": \\"success\\",\\n \\"Message\\": \\"submit and deploy fail.\\"\\n }\\n}","type":"json"}]', + ], + 'DeployFile' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'FileDescription', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The description of the file.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'Here is the file description', - 'maxLength' => 200, - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '78223', + 'abilityTreeNodes' => ['FEATUREdide8FM783'], + ], + 'parameters' => [ [ - 'name' => 'FileType', + 'name' => 'ProjectId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The type of the code for the file. The code for files varies based on the file type. For more information, see [DataWorks nodes](~~600169~~).'."\n" - ."\n" - .'You can call the [ListFileType](~~212428~~) operation to query the type of the code for the file.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], + 'schema' => ['description' => 'The ID of the DataWorks workspace. You can log in to the DataWorks console and go to the workspace configuration page to obtain the workspace ID. You must set either this parameter or the ProjectIdentifier parameter to specify the DataWorks workspace for the API call.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10000', 'title' => ''], ], [ - 'name' => 'Owner', + 'name' => 'ProjectIdentifier', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the file owner. If this parameter is not configured, the ID of the Alibaba Cloud account of the user who calls the operation is used.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1000000000001', - ], + 'schema' => ['description' => 'The name of the DataWorks workspace. You can log on to the DataWorks console and go to the workspace configuration page to obtain the workspace name. You must set either this parameter or the `ProjectId` parameter to specify the DataWorks workspace for this API call.', 'type' => 'string', 'required' => false, 'example' => 'dw_project', 'title' => ''], ], [ - 'name' => 'Content', + 'name' => 'FileId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The code for the file. The code format varies based on the file type. To view the code format for a specific file type, go to Operation Center, right-click a node of the file type, and then select View Code.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SHOW TABLES;', - ], + 'schema' => ['description' => 'The ID of the file. You can call the [ListFiles](~~173942~~) operation to obtain this ID. You only need to specify this parameter or the `NodeId` parameter.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '10000022', 'title' => ''], ], [ - 'name' => 'AutoRerunTimes', + 'name' => 'Comment', 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of automatic reruns that are allowed after an error occurs. Maximum value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '3', - ], + 'schema' => ['description' => 'Description of this deployment.', 'type' => 'string', 'required' => false, 'example' => 'First release task', 'title' => ''], ], [ - 'name' => 'AutoRerunIntervalMillis', + 'name' => 'NodeId', 'in' => 'formData', + 'schema' => ['description' => 'The ID of the task in the scheduling system for the file to be deployed. You only need to specify either this parameter or the `FileId` parameter.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2000001', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The interval between automatic reruns after an error occurs. Unit: milliseconds. Maximum value: 1800000 (30 minutes).'."\n" - ."\n" - .'This parameter corresponds to the Rerun Interval parameter that is displayed after the Auto Rerun upon Error check box is selected in the Schedule section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n" - ."\n" - .'The interval that you specify in the DataWorks console is measured in minutes. Pay attention to the conversion between the units of time when you call the operation.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '120000', + 'description' => 'Returned data structure.', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The ID of the deployment package. You can then use this ID as a parameter when calling the [GetDeployment](~~173950~~) API to obtain the details of the deployment.', 'type' => 'integer', 'format' => 'int64', 'example' => '30000001', 'title' => ''], + 'RequestId' => ['description' => 'The request ID is used to troubleshoot issues when an error occurs.', 'type' => 'string', 'example' => '0000-ABCD-EFG****', 'title' => ''], + 'ErrorMessage' => ['description' => 'Error message.', 'type' => 'string', 'example' => 'The connection does not exist.', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'Error code.', 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 30000001,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\"\\n}","type":"json"}]', + 'title' => 'DeployFile', + 'summary' => 'Deploys a file to the production environment.', + 'description' => 'This is an asynchronous operation. A successful call returns a deployment ID. Use this ID with the [GetDeployment](~~173950~~) operation to query the execution status and final result of the deployment task.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'RerunMode', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether the node that corresponds to the file can be rerun. Valid values:'."\n" - ."\n" - .'* ALL_ALLOWED: The node can be rerun regardless of whether it is successfully run or fails to run.'."\n" - .'* FAILURE_ALLOWED: The node can be rerun only after it fails to run.'."\n" - .'* ALL_DENIED: The node cannot be rerun regardless of whether it is successfully run or fails to run.'."\n" - ."\n" - .'This parameter corresponds to the Rerun parameter in the Schedule section of the Properties tab on the DataStudio page in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'ALL_ALLOWED', - 'default' => 'ALL_ALLOWED', - 'enum' => [ - 'ALL_ALLOWED', - 'FAILURE_ALLOWED', - 'ALL_DENIED', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], + ], + ], + 'DesensitizeData' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Stop', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether to suspend the scheduling of the node. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n" - ."\n" - .'This parameter corresponds to the Recurrence parameter in the Schedule section of the Properties tab on the DataStudio page in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'ParaValue', + 'name' => 'Data', 'in' => 'formData', - 'schema' => [ - 'description' => 'The scheduling parameters of the node. Separate multiple parameters with spaces.'."\n" - ."\n" - .'This parameter corresponds to the Parameters section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console). For more information about the configurations of the scheduling parameters, see [Configure scheduling parameters](~~137548~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'a=x b=y', - ], + 'schema' => ['description' => 'The data that you want to mask.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '15365291784'], ], [ - 'name' => 'StartEffectDate', + 'name' => 'SceneCode', 'in' => 'formData', - 'schema' => [ - 'description' => 'The start time of automatic scheduling. Set the value to a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n" - ."\n" - .'Configuring this parameter is equivalent to specifying a start time for the Validity Period parameter in the Schedule section of the Properties tab on the DataStudio page in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'minimum' => '0', - 'example' => '1671608450000', - 'default' => '0', - ], + 'schema' => ['description' => 'The code of the data masking scenario. You can view the code on the Data Masking Management page in Data Security Guard of the DataWorks console.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '_default_scene_code'], ], - [ - 'name' => 'EndEffectDate', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The end time of automatic scheduling. Set the value to a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n" - ."\n" - .'This parameter corresponds to the Validity Period parameter in the Schedule section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'minimum' => '0', - 'example' => '1671694850000', + 'type' => 'object', + 'properties' => [ + 'DesensitizeData' => ['description' => 'The data returned after masking.'."\n", 'type' => 'string', 'example' => '{ "desensData": "**198807120510**" }'], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'BCA321BA-46C5-40E9-8A08-6******'], + ], + 'description' => '', ], ], + ], + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.NoTenant', 'errorMessage' => 'The tenant information cannot be obtained using user ID.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.DQC.BizError', 'errorMessage' => 'An internal error occurred.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DesensitizeData\\": \\"{ \\\\\\"desensData\\\\\\": \\\\\\"**198807120510**\\\\\\" }\\",\\n \\"RequestId\\": \\"BCA321BA-46C5-40E9-8A08-6******\\"\\n}","errorExample":""},{"type":"xml","example":"BCA321BA-46C5-40E9-8A08-6******\\n{ \\"desensData\\": \\"**198807120510**\\" }","errorExample":""}]', + 'title' => 'DesensitizeData', + 'summary' => 'Masks data.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DesensitizeData'], + ], + ], + 'ramActions' => [], + ], + 'DsgDesensPlanAddOrUpdate' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'CronExpress', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The CRON expression that represents the periodic scheduling policy of the node. This parameter corresponds to the Cron Expression parameter in the Schedule section of the Properties tab on the DataStudio page in the [DataWorks console](https://workbench.data.aliyun.com/console). After you configure the Scheduling Cycle and Scheduled time parameters in the DataWorks console, DataWorks generates the value of the Cron Expression parameter.'."\n" - ."\n" - .'Examples:'."\n" - ."\n" - .'* CRON expression for a node that is scheduled to run at 05:30 every day: `00 30 05 * * ?`'."\n" - .'* CRON expression for a node that is scheduled to run at the fifteenth minute of each hour: `00 15 00-23/1 * * ?`'."\n" - .'* CRON expression for a node that is scheduled to run every 10 minutes: `00 00/10 * * * ?`'."\n" - .'* CRON expression for a node that is scheduled to run every 10 minutes from 08:00 to 17:00 every day: `00 00-59/10 8-17 * * * ?`'."\n" - .'* CRON expression for a node that is scheduled to run at 00:20 on the first day of each month: `00 20 00 1 * ?`'."\n" - .'* CRON expression for a node that is scheduled to run every three months from 00:10 on January 1: `00 10 00 1 1-12/3 ?`'."\n" - .'* CRON expression for a node that is scheduled to run at 00:05 every Tuesday and Friday: `00 05 00 * * 2,5`'."\n" - ."\n" - .'The scheduling system of DataWorks imposes the following limits on CRON expressions:'."\n" - ."\n" - .'* The minimum interval specified in a CRON expression to schedule a node is 5 minutes.'."\n" - .'* The earliest time specified in a CRON expression to schedule a node every day is 00:05.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '00 05 00 * * ?', - 'default' => 'day', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '219759', + 'abilityTreeNodes' => ['FEATUREdideRZM9W6'], + ], + 'parameters' => [ [ - 'name' => 'CycleType', - 'in' => 'formData', + 'name' => 'DesensRules', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The type of the scheduling cycle of the node that corresponds to the file. Valid values: NOT_DAY and DAY. The value NOT_DAY indicates that the node is scheduled to run by minute or hour. The value DAY indicates that the node is scheduled to run by day, week, or month.'."\n" - ."\n" - .'This parameter corresponds to the Scheduling Cycle parameter in the Schedule section of the Properties tab on the DataStudio page in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'DAY', - 'default' => 'DAY', - 'enum' => [ - 'DAY', - 'NOT_DAY', + 'description' => 'The collection of data masking rules to add or update.', + 'type' => 'array', + 'items' => [ + 'description' => 'The configuration of a data masking rule.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The data masking rule ID. You can call the [DsgDesensPlanQueryList](~~2786578~~) operation to obtain it.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', 'title' => ''], + 'DataType' => ['description' => 'The sensitive data type.', 'type' => 'string', 'required' => false, 'example' => 'phone', 'title' => ''], + 'RuleName' => ['description' => 'The name of the data masking rule.', 'type' => 'string', 'required' => true, 'example' => 'phone_hash', 'title' => ''], + 'Status' => ['description' => 'The status of the data masking rule. Valid values:'."\n" + ."\n" + .'- 0: Disabled'."\n" + ."\n" + .'- 1: Enabled', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'SceneIds' => [ + 'description' => 'The secondary data masking scenes.', + 'type' => 'array', + 'items' => ['description' => 'The ID of a secondary data masking scene. This scene cannot have an existing data masking rule for the sensitive data type specified by the DataType parameter. To find the scene ID, call the [DsgSceneQuerySceneListByName](~~2786322~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', 'title' => ''], + 'required' => true, + 'title' => '', + 'example' => '', + ], + 'Owner' => ['description' => 'The owner of the data masking rule.', 'type' => 'string', 'required' => true, 'example' => 'test_user', 'title' => ''], + 'CheckWatermark' => ['description' => 'Specifies whether to add a watermark. Valid values:'."\n" + ."\n" + .'- true: Adds a watermark.'."\n" + ."\n" + .'- false: Does not add a watermark.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'DesensPlan' => [ + 'description' => 'The configuration of the data masking method.', + 'type' => 'object', + 'properties' => [ + 'DesensPlanType' => ['description' => 'The data masking method. Valid values:'."\n" + ."\n" + .'- hash: hashing'."\n" + ."\n" + .'- mapping: pseudonymization'."\n" + ."\n" + .'- mask: masking'."\n" + ."\n" + .'- charreplacement: character replacement'."\n" + ."\n" + .'- intervalselect: interval transformation'."\n" + ."\n" + .'- decimalpoint: rounding'."\n" + ."\n" + .'- emptydesens: nullification', 'type' => 'string', 'required' => true, 'example' => 'hash', 'title' => ''], + 'ExtParam' => [ + 'description' => 'The parameters for the data masking method.', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['description' => 'The parameters for the selected data masking method. The required parameters depend on the value of the DesensPlanType parameter. See the request examples for details.', 'type' => 'any', 'example' => '{ "algo": "MD5", "salt":6 }', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'required' => true, + 'title' => '', + 'example' => '', + ], + 'emptyNotDesens' => ['type' => 'boolean', 'required' => false, 'default' => 'false', 'description' => '', 'title' => '', 'example' => ''], + 'columns' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'dbType' => ['description' => 'The data source type.', 'type' => 'string', 'required' => true, 'example' => 'ODPS.ODPS', 'title' => ''], + 'project' => ['description' => 'The name of the DataWorks workspace.', 'type' => 'string', 'required' => true, 'example' => 'test_dev', 'title' => ''], + 'table' => ['description' => 'The table name.', 'type' => 'string', 'required' => true, 'example' => 'test_table_dev', 'title' => ''], + 'column' => ['description' => 'The column name.', 'type' => 'string', 'required' => true, 'example' => 'test_col_dev', 'title' => ''], + ], + 'description' => 'The information about a column.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'description' => 'The associated columns for masking.', + 'title' => '', + 'example' => '', + 'required' => false, + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => true, + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'DependentType', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The type of the cross-cycle scheduling dependency of the node. Valid values:'."\n" - ."\n" - .'* SELF: The instance generated for the node in the current cycle depends on the instance generated for the node in the previous cycle.'."\n" - .'* CHILD: The instance generated for the node in the current cycle depends on the instances generated for the descendant nodes at the nearest level of the node in the previous cycle.'."\n" - .'* USER_DEFINE: The instance generated for the node in the current cycle depends on the instances generated for one or more specified nodes in the previous cycle.'."\n" - .'* NONE: No cross-cycle scheduling dependency type is selected for the node.'."\n" - .'* USER_DEFINE_AND_SELF: The instance generated for the node in the current cycle depends on the instance generated for the node in the previous cycle and the instances generated for one or more specified nodes in the previous cycle.'."\n" - .'* CHILD_AND_SELF: The instance generated for the node in the current cycle depends on the instances generated for the descendant nodes at the nearest level of the node in the previous cycle and the instance generated for the node in the previous cycle.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'NONE', - 'default' => 'NONE', - 'enum' => [ - 'NONE', - 'USER_DEFINE', - 'CHILD', - 'SELF', - 'USER_DEFINE_AND_SELF', - 'CHILD_AND_SELF', + 'title' => 'OpenApiResultModel', + 'description' => 'OpenApiResultModel', + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the request was successful. A value of `true` indicates that the request was successful. A value of `false` indicates that the request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '1029030003', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'param error', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '400', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the add or update operation was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. You can use the ID to trace logs and troubleshoot issues.', 'type' => 'string', 'example' => '102400001', 'title' => ''], ], + 'example' => '', ], ], - [ - 'name' => 'DependentNodeIdList', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The IDs of the nodes that generate instances in the previous cycle on which the current node depends.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'PARAMS.ERROR', 'errorMessage' => 'param error.', 'description' => ''], + ['errorCode' => 'DESENSPLAN.DATATYPE.ERROR', 'errorMessage' => 'Sensitive type already has a desensitization rule.', 'description' => 'Desensitization rules have been configured for sensitive types.'], + ['errorCode' => 'DESENSPLAN.DATATYPENOTEXIST.ERROR', 'errorMessage' => 'Sensitive type not exist.', 'description' => 'The sensitive type does not exist.'], + ['errorCode' => 'DESENSPLAN.ID.ERROR', 'errorMessage' => 'Desensitization rule ID does not exist.', 'description' => 'The desensitization rule ID does not exist.'], + ['errorCode' => 'DESENSPLAN.PAGESIZE.ERROR', 'errorMessage' => 'Page size is too large, maximum of 100.', 'description' => 'Page size limit, up to 100'], + ['errorCode' => 'DESENSPLAN.PARAM.ERROR', 'errorMessage' => 'Desensitization rule parameter error.', 'description' => 'The desensitization rule parameter is incorrect.'], + ['errorCode' => 'DESENSPLAN.SCENECODE.ERROR', 'errorMessage' => 'Scene code does not exist.', 'description' => 'Scene code does not exist'], + ['errorCode' => 'DESENSPLAN.SCENEID.ERROR', 'errorMessage' => 'Scene ID does not exist.', 'description' => 'Scene ID does not exist.'], + ['errorCode' => 'DESENSPLAN.SCENEIDLEVEL.ERROR', 'errorMessage' => 'The scene is not a secondary scene.', 'description' => 'The scene is not a secondary scene.'], + ['errorCode' => 'DESENSPLAN.SIZE.ERROR', 'errorMessage' => 'The number of desens plan exceeds the limit.', 'description' => 'The number of desensitization rules exceeded the limit.'], ], - [ - 'name' => 'InputList', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The output name of the parent file on which the current file depends. If you specify multiple output names, separate them with commas (,).'."\n" - ."\n" - .'This parameter corresponds to the Output Name parameter under Parent Nodes in the Dependencies section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'project_root,project.file1,project.001_out', - ], + 403 => [ + ['errorCode' => 'PERMISSION.DENIED.ERROR', 'errorMessage' => 'Permission denied', 'description' => 'Insufficient permissions.'], ], - [ - 'name' => 'ProjectIdentifier', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace Management page to obtain the workspace name.'."\n" - ."\n" - .'You must configure this parameter or the ProjectId parameter to determine the DataWorks workspace to which the operation is applied.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'dw_project', - ], + 500 => [ + ['errorCode' => 'UNKNOWN.ERROR', 'errorMessage' => 'unknown error.', 'description' => 'Unknown error.'], ], + ], + 'title' => 'DsgDesensPlanAddOrUpdate', + 'summary' => 'Call the `DsgDesensPlanAddOrUpdate` API to create or edit a data desensitization rule.', + 'requestParamsDescription' => '`ExtParam` is a dynamic parameter. Its configuration depends on the desensitization rule. See the following configuration examples:'."\n" + ."\n" + .'```'."\n" + .'Hash:'."\n" + .'{'."\n" + .' "algo": "MD5",'."\n" + .' "salt": 6'."\n" + .'}'."\n" + .'Pseudonymization:'."\n" + .'{'."\n" + .' "charset": "Aa",'."\n" + .' "salt": 6'."\n" + .'}'."\n" + .'Masking:'."\n" + .'{'."\n" + .' "before": 3,'."\n" + .' "after": 4'."\n" + .'}'."\n" + .'Custom mask:'."\n" + .'{'."\n" + .' "separatorList": ['."\n" + .' {'."\n" + .' "desens": true,'."\n" + .' "left": 3'."\n" + .' },'."\n" + .' {'."\n" + .' "desens": false,'."\n" + .' "left": 6'."\n" + .' },'."\n" + .' {'."\n" + .' "desens": true,'."\n" + .' "left": -99'."\n" + .' }'."\n" + .' ]'."\n" + .'}'."\n" + .'Sample character replacement:'."\n" + .'{'."\n" + .' "library": "test_library",'."\n" + .' "position": 3'."\n" + .'}'."\n" + .'Fixed character replacement:'."\n" + .'{'."\n" + .' "replace": "repData",'."\n" + .' "position": 3'."\n" + .'}'."\n" + .'Random character replacement:'."\n" + .'{'."\n" + .' "replace": "repData"'."\n" + .'}'."\n" + .'Custom character replacement:'."\n" + .'{'."\n" + .' "separatorList": ['."\n" + .' {'."\n" + .' "desensParam": {'."\n" + .' "replace": "repData"'."\n" + .' },'."\n" + .' "left": 3'."\n" + .' },'."\n" + .' {'."\n" + .' "desensParam": {'."\n" + .' "library": "test_library"'."\n" + .' },'."\n" + .' "left": 6'."\n" + .' },'."\n" + .' {'."\n" + .' "desensParam": {'."\n" + .' },'."\n" + .' "left": 99'."\n" + .' }'."\n" + .' ]'."\n" + .'}'."\n" + .'Interval transformation:'."\n" + .'{'."\n" + .' "intervalselects": ['."\n" + .' {'."\n" + .' "desens": "1",'."\n" + .' "interval": ['."\n" + .' "1",'."\n" + .' "100"'."\n" + .' ]'."\n" + .' }'."\n" + .' ]'."\n" + .'}'."\n" + .'Rounding:'."\n" + .'{'."\n" + .'"point":3'."\n" + .'}'."\n" + .'Nullification:'."\n" + .'{}'."\n" + .'```'."\n" + ."\n" + .'For details on supported desensitization methods and their rules, see the [DsgQueryDefaultTemplates](~~2786306~~) API.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1029030003\\",\\n \\"ErrorMessage\\": \\"param error\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"102400001\\"\\n}","type":"json"}]', + ], + 'DsgDesensPlanDelete' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'ResourceGroupIdentifier', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The identifier of the resource group that is used to run the node. You can call the [ListResourceGroups](~~173913~~) operation to query the available resource groups in the workspace. The **Identifier** parameter in the response of the operation indicates the identifier of an available resource group.'."\n" - ."\n" - .'> You must make sure that the available resource groups in the response of the ListResourceGroups operation are associated with the workspace for which you want to create a file by calling the CreateFile operation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'group_375827434852437', - ], + 'AK' => [], ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '219620', + 'abilityTreeNodes' => ['FEATUREdideRZM9W6'], + ], + 'parameters' => [ [ - 'name' => 'ResourceGroupId', - 'in' => 'formData', + 'name' => 'Ids', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'This parameter is deprecated. Do not use this parameter.'."\n" - ."\n" - .'The identifier of the resource group that is used to run the node. This parameter corresponds to the Resource Group parameter in the Resource Group section of the Properties tab in the DataWorks console. You must configure one of the ResourceGroupId and ResourceGroupIdentifier parameters to determine the resource group that is used to run the node.'."\n" - ."\n" - .'You can call the [ListResourceGroups](~~173913~~) operation to query the available resource groups in the workspace. When you call the operation, set the ResourceGroupType parameter to 1. The response parameter Id indicates the ID of an available resource group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '375827434852437', + 'description' => 'A collection of data masking rules.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The ID of the data masking rule. You can call the [DsgDesensPlanQueryList](~~2786578~~) operation to query the ID of the data masking rule.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '123'], + 'required' => true, ], ], [ - 'name' => 'ConnectionName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the data source for which the node is run.'."\n" - ."\n" - .'You can call the [UpdateDataSource](~~211432~~) operation to query the available data sources in the workspace.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'odps_first', - ], + 'name' => 'SceneCode', + 'in' => 'query', + 'schema' => ['description' => 'The code of the level-1 data masking scenario to which the rule belongs. Valid values:'."\n" + ."\n" + .'* dataworks_display_desense_code: masking of displayed data in DataStudio and Data Map'."\n" + .'* maxcompute_desense_code: data masking at the MaxCompute compute engine layer'."\n" + .'* maxcompute_new_desense_code: data masking at the MaxCompute compute engine layer (new)'."\n" + .'* hologres_display_desense_code: data masking at the Hologres compute engine layer'."\n" + .'* dataworks_data_integration_desense_code: static data masking in Data Integration'."\n" + .'* dataworks_analysis_desense_code: masking of displayed data in DataAnalysis'."\n", 'type' => 'string', 'required' => true, 'example' => 'dataworks_display_desense_code'], ], - [ - 'name' => 'AutoParsing', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Specifies whether to enable the automatic parsing feature for the file. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n" - ."\n" - .'This parameter corresponds to the Analyze Code parameter that is displayed after Same Cycle is selected in the Dependencies section of the Properties tab on the DataStudio page in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'boolean', - 'required' => false, - 'docRequired' => false, - 'example' => 'true', - 'default' => 'true', + 'title' => 'OpenApiResultModel', + 'description' => 'OpenApiResultModel'."\n", + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '1029030003'], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'param error'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '400'], + 'Data' => ['description' => 'The operation result. Valid values:'."\n" + ."\n" + .'* true: The operation is successful.'."\n" + .'* false: The operation fails.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'RequestId' => ['description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", 'type' => 'string', 'example' => '102400001'], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'PARAMS.ERROR', 'errorMessage' => 'param error.', 'description' => ''], + ['errorCode' => 'DESENSPLAN.DATATYPE.ERROR', 'errorMessage' => 'Sensitive type already has a desensitization rule.', 'description' => 'Desensitization rules have been configured for sensitive types.'], + ['errorCode' => 'DESENSPLAN.DATATYPENOTEXIST.ERROR', 'errorMessage' => 'Sensitive type not exist.', 'description' => 'The sensitive type does not exist.'], + ['errorCode' => 'DESENSPLAN.ID.ERROR', 'errorMessage' => 'Desensitization rule ID does not exist.', 'description' => 'The desensitization rule ID does not exist.'], + ['errorCode' => 'DESENSPLAN.PAGESIZE.ERROR', 'errorMessage' => 'Page size is too large, maximum of 100.', 'description' => 'Page size limit, up to 100'], + ['errorCode' => 'DESENSPLAN.PARAM.ERROR', 'errorMessage' => 'Desensitization rule parameter error.', 'description' => 'The desensitization rule parameter is incorrect.'], + ['errorCode' => 'DESENSPLAN.SCENECODE.ERROR', 'errorMessage' => 'Scene code does not exist.', 'description' => 'Scene code does not exist'], + ['errorCode' => 'DESENSPLAN.SCENEID.ERROR', 'errorMessage' => 'Scene ID does not exist.', 'description' => 'Scene ID does not exist.'], + ['errorCode' => 'DESENSPLAN.SCENEIDLEVEL.ERROR', 'errorMessage' => 'The scene is not a secondary scene.', 'description' => 'The scene is not a secondary scene.'], + ['errorCode' => 'DESENSPLAN.SIZE.ERROR', 'errorMessage' => 'The number of desens plan exceeds the limit.', 'description' => 'The number of desensitization rules exceeded the limit.'], + ], + 403 => [ + ['errorCode' => 'PERMISSION.DENIED.ERROR', 'errorMessage' => 'Permission denied', 'description' => 'Insufficient permissions.'], + ], + 500 => [ + ['errorCode' => 'UNKNOWN.ERROR', 'errorMessage' => 'unknown error.', 'description' => 'Unknown error.'], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1029030003\\",\\n \\"ErrorMessage\\": \\"param error\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"102400001\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 1029030003\\n param error\\n 400\\n true\\n 102400001\\n","errorExample":""}]', + 'title' => 'DsgDesensPlanDelete', + 'summary' => 'Deletes a data masking rule created in Data Security Guard.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'SchedulerType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The scheduling type of the node. Valid values:'."\n" - ."\n" - .'* NORMAL: The node is an auto triggered node.'."\n" - .'* MANUAL: The node is a manually triggered node. Manually triggered nodes cannot be automatically triggered. They correspond to the nodes in the Manually Triggered Workflows pane.'."\n" - .'* PAUSE: The node is a paused node.'."\n" - .'* SKIP: The node is a dry-run node. Dry-run nodes are started as scheduled, but the system sets the status of the nodes to successful when it starts to run them'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [], - 'example' => 'NORMAL', - 'enum' => [ - 'NORMAL', - 'MANUAL', - 'PAUSE', - 'SKIP', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dataworks:DsgDesensPlanDelete', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - [ - 'name' => 'AdvancedSettings', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The advanced configurations of the node.'."\n" - ."\n" - .'This parameter is valid only for an EMR Spark Streaming node or an EMR Streaming SQL node. This parameter corresponds to the Advanced Settings tab of the node in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n" - ."\n" - .'The value of this parameter must be in the JSON format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"queue":"default","SPARK_CONF":"--conf spark.driver.memory=2g"}', - ], + ], + ], + 'DsgDesensPlanQueryList' => [ + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '219758', + 'abilityTreeNodes' => ['FEATUREdideRZM9W6'], + ], + 'parameters' => [ [ - 'name' => 'StartImmediately', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether to immediately run a node after the node is deployed.'."\n" - ."\n" - .'This parameter is valid only for an EMR Spark Streaming node or an EMR Streaming SQL node. This parameter corresponds to the Start Method parameter in the Schedule section of the Configure tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'boolean', - 'required' => false, - 'docRequired' => false, - 'example' => 'true', - 'default' => 'false', - ], + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'InputParameters', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The input parameters of the node. The value of this parameter must be in the JSON format. For more information about the input parameters, see the InputContextParameterList parameter in the Response parameters section of the [GetFile](~~173954~~) operation.'."\n" - ."\n" - .'This parameter corresponds to the Input Parameters table in the Input and Output Parameters section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{"ValueSource": "project_001.first_node:bizdate_param","ParameterName": "bizdate_input"}]', - ], + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page. The maximum value is 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', 'title' => ''], ], [ - 'name' => 'OutputParameters', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The output parameters of the node. The value of this parameter must be in the JSON format. For more information about the output parameters, see the OutputContextParameterList parameter in the Response parameters section of the [GetFile](~~173954~~) operation.'."\n" - ."\n" - .'This parameter corresponds to the Output Parameters table in the Input and Output Parameters section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{"Type": 1,"Value": "${bizdate}","ParameterName": "bizdate_param"}]', - ], + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the Level-2 data desensitization scene. You can call the [DsgSceneQuerySceneListByName](~~2786322~~) operation to obtain this ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123', 'title' => ''], ], [ - 'name' => 'IgnoreParentSkipRunningProperty', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Whether to use the last cycle empty run attribute. The values are as follows:'."\n" - .'- true: The empty run attribute of the previous cycle is used.'."\n" - .'- false: The empty run attribute of the previous cycle is not used.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'name' => 'RuleName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the desensitization rule.', 'type' => 'string', 'required' => false, 'example' => 'phone', 'title' => ''], ], [ - 'name' => 'CreateFolderIfNotExists', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether to automatically create the directory that is specified by the FileFolderPath parameter if the directory does not exist. Valid values:'."\n" - ."\n" - .'* true: The system automatically creates the directory if the directory does not exist.'."\n" - .'* false: The system does not automatically create the directory if the directory does not exist. In this case, the call fails.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'name' => 'Owner', + 'in' => 'query', + 'schema' => ['description' => 'The owner of the desensitization rule.', 'type' => 'string', 'required' => false, 'example' => 'user1', 'title' => ''], ], [ - 'name' => 'ApplyScheduleImmediately', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether scheduling configurations immediately take effect after the node is deployed.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => 'The status of the desensitization rule. Valid values:'."\n" + ."\n" + .'- 0: Inactive'."\n" + ."\n" + .'- 1: Active', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Timeout', - 'in' => 'formData', + 'name' => 'columns', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The timeout period.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'dbType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'project' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'table' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'column' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ImageId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the custom image.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'm-bp1h4b5a8ogkbll2f3tr', - ], + 'name' => 'emptyNotDesesn', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + [ + 'name' => 'dataType', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', + 'title' => 'OpenApiResultModel>', + 'description' => 'OpenApiResultModel\\', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The ID of the file that was created.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000001', - ], - 'RequestId' => [ - 'description' => 'The ID of the request. You can use the ID to troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true: The request was successful.'."\n" - .'* false: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true: The request was successful.'."\n" + ."\n" + .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '1029030003', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'param error', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '400', 'title' => ''], + 'PageData' => [ + 'description' => 'The paginated data.', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of matching desensitization rules.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'Data' => [ + 'description' => 'The details of the desensitization rules.', + 'type' => 'array', + 'items' => [ + 'description' => 'A single desensitization rule object.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the desensitization rule.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '123'], + 'DataType' => ['description' => 'The sensitive data type.', 'type' => 'string', 'title' => '', 'example' => 'phone'], + 'RuleName' => ['description' => 'The name of the desensitization rule.', 'type' => 'string', 'title' => '', 'example' => 'phone_hash'], + 'DesensPlan' => [ + 'title' => '', + 'description' => 'The details of the desensitization plan.', + 'type' => 'object', + 'properties' => [ + 'DesensPlanType' => ['description' => 'The type of the desensitization plan.', 'type' => 'string', 'example' => 'hash', 'title' => ''], + 'ExtParam' => [ + 'description' => 'The parameters for the desensitization rule. For details, see the [DsgDesensPlanAddOrUpdate](~~2786295~~) operation.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The details of the desensitization rule parameters.', 'type' => 'any', 'example' => '"extParam": { "algo":"MD5", "salt":"5" }', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + 'Owner' => ['description' => 'The owner of the desensitization rule.', 'type' => 'string', 'title' => '', 'example' => 'user1'], + 'GmtCreate' => ['description' => 'The time when the rule was created.', 'type' => 'string', 'title' => '', 'example' => '2024-05-09 15:46:20'], + 'GmtModified' => ['description' => 'The time when the rule was last modified.', 'type' => 'string', 'title' => '', 'example' => '2024-05-09 15:46:20'], + 'Status' => ['description' => 'The status of the rule. Valid values:'."\n" + ."\n" + .'- 0: Inactive.'."\n" + ."\n" + .'- 1: Active.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'DesensWay' => ['description' => 'The desensitization method.', 'type' => 'string', 'title' => '', 'example' => 'HASH'], + 'DesenMode' => ['description' => 'The desensitization method.', 'type' => 'string', 'title' => '', 'example' => 'HASH'], + 'DesensRule' => ['description' => 'The desensitization rule.', 'type' => 'string', 'title' => '', 'example' => 'HASH'], + 'SceneCode' => ['description' => 'The level-1 desensitization scene code. Valid values:'."\n" + ."\n" + .'- Desensitization for display in Data Development and Data Map: dataworks\\_display\\_desense\\_code'."\n" + ."\n" + .'- Desensitization at the MaxCompute engine layer: maxcompute\\_desense\\_code'."\n" + ."\n" + .'- Desensitization at the MaxCompute engine layer (New): maxcompute\\_new\\_desense\\_code'."\n" + ."\n" + .'- Desensitization at the Hologres engine layer: hologres\\_display\\_desense\\_code'."\n" + ."\n" + .'- Static desensitization in Data Integration: dataworks\\_data\\_integration\\_desense\\_code'."\n" + ."\n" + .'- Desensitization for display in Data Analysis: dataworks\\_analysis\\_desense\\_code', 'type' => 'string', 'title' => '', 'example' => 'dataworks_display_desense_code'], + 'CheckWatermark' => ['description' => 'Indicates whether to add a watermark. Valid values:'."\n" + ."\n" + .'- true: A watermark is added.'."\n" + ."\n" + .'- false: No watermark is added.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'SceneName' => ['description' => 'The name of the level-2 desensitization scene.', 'type' => 'string', 'title' => '', 'example' => 'test_scene'], + 'emptyNotDesesn' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'columns' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'dbType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'project' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'table' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'column' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID. You can use this ID to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => '102400001', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + 400 => [ + ['errorCode' => 'DESENSPLAN.DATATYPE.ERROR', 'errorMessage' => 'Sensitive type already has a desensitization rule.', 'description' => 'Desensitization rules have been configured for sensitive types.'], + ['errorCode' => 'DESENSPLAN.DATATYPENOTEXIST.ERROR', 'errorMessage' => 'Sensitive type not exist.', 'description' => 'The sensitive type does not exist.'], + ['errorCode' => 'DESENSPLAN.ID.ERROR', 'errorMessage' => 'Desensitization rule ID does not exist.', 'description' => 'The desensitization rule ID does not exist.'], + ['errorCode' => 'DESENSPLAN.PAGESIZE.ERROR', 'errorMessage' => 'Page size is too large, maximum of 100.', 'description' => 'Page size limit, up to 100'], + ['errorCode' => 'DESENSPLAN.PARAM.ERROR', 'errorMessage' => 'Desensitization rule parameter error.', 'description' => 'The desensitization rule parameter is incorrect.'], + ['errorCode' => 'DESENSPLAN.SCENECODE.ERROR', 'errorMessage' => 'Scene code does not exist.', 'description' => 'Scene code does not exist'], + ['errorCode' => 'DESENSPLAN.SCENEID.ERROR', 'errorMessage' => 'Scene ID does not exist.', 'description' => 'Scene ID does not exist.'], + ['errorCode' => 'DESENSPLAN.SCENEIDLEVEL.ERROR', 'errorMessage' => 'The scene is not a secondary scene.', 'description' => 'The scene is not a secondary scene.'], + ['errorCode' => 'DESENSPLAN.SIZE.ERROR', 'errorMessage' => 'The number of desens plan exceeds the limit.', 'description' => 'The number of desensitization rules exceeded the limit.'], + ['errorCode' => 'PARAMS.ERROR', 'errorMessage' => 'param error.', 'description' => ''], ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + 403 => [ + ['errorCode' => 'PERMISSION.DENIED.ERROR', 'errorMessage' => 'Permission denied', 'description' => 'Insufficient permissions.'], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], + ['errorCode' => 'UNKNOWN.ERROR', 'errorMessage' => 'unknown error.', 'description' => 'Unknown error.'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 1000001,\\n \\"RequestId\\": \\"0000-ABCD-EFG\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 1000001\\n 0000-ABCD-EFG\\n The connection does not exist.\\n true\\n Invalid.Tenant.ConnectionNotExists\\n","errorExample":""}]', - 'title' => 'CreateFile', - 'summary' => 'Creates a file in DataStudio. You cannot call this operation to create files for Data Integration nodes.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'CreateUdfFile' => [ - 'methods' => [ - 'post', + 'title' => 'DsgDesensPlanQueryList', + 'summary' => 'Call the `DsgDesensPlanQueryList` API to query Data Security Guard\'s (DSG) data masking rules.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:DsgDesensPlanQueryList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1029030003\\",\\n \\"ErrorMessage\\": \\"param error\\",\\n \\"HttpStatusCode\\": 400,\\n \\"PageData\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Data\\": [\\n {\\n \\"Id\\": 123,\\n \\"DataType\\": \\"phone\\",\\n \\"RuleName\\": \\"phone_hash\\",\\n \\"DesensPlan\\": {\\n \\"DesensPlanType\\": \\"hash\\",\\n \\"ExtParam\\": {\\n \\"key\\": \\"\\\\\\"extParam\\\\\\": { \\\\\\"algo\\\\\\":\\\\\\"MD5\\\\\\", \\\\\\"salt\\\\\\":\\\\\\"5\\\\\\" }\\"\\n }\\n },\\n \\"Owner\\": \\"user1\\",\\n \\"GmtCreate\\": \\"2024-05-09 15:46:20\\",\\n \\"GmtModified\\": \\"2024-05-09 15:46:20\\",\\n \\"Status\\": 1,\\n \\"DesensWay\\": \\"HASH\\",\\n \\"DesenMode\\": \\"HASH\\",\\n \\"DesensRule\\": \\"HASH\\",\\n \\"SceneCode\\": \\"dataworks_display_desense_code\\",\\n \\"CheckWatermark\\": true,\\n \\"SceneName\\": \\"test_scene\\",\\n \\"emptyNotDesesn\\": false,\\n \\"columns\\": [\\n {\\n \\"dbType\\": \\"\\",\\n \\"project\\": \\"\\",\\n \\"table\\": \\"\\",\\n \\"column\\": \\"\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"RequestId\\": \\"102400001\\"\\n}","type":"json"}]', + ], + 'DsgDesensPlanUpdateStatus' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '78200', - 'abilityTreeNodes' => [ - 'FEATUREdide8FM783', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '219619', + 'abilityTreeNodes' => ['FEATUREdideRZM9W6'], ], 'parameters' => [ [ - 'name' => 'FileFolderPath', - 'in' => 'formData', + 'name' => 'Ids', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The path of the folder in which the file for the function is stored.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'Business_process/First_Business_Process/function/string_processing', + 'description' => 'A collection of IDs of the data masking rules of which the status you want to modify.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The ID of the data masking rule. You can call the [DsgDesensPlanQueryList](~~2786578~~) operation to query the ID of the data masking rule.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '123'], + 'required' => true, ], ], [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the DataWorks workspace. You can click the Workspace Manage icon in the upper-right corner of the DataStudio page to go to the Workspace Management page and view the workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '10000', - ], + 'name' => 'SceneCode', + 'in' => 'query', + 'schema' => ['description' => 'The code of the level-1 data masking scenario to which the rule belongs. Valid values:'."\n" + ."\n" + .'* dataworks_display_desense_code: masking of displayed data in DataStudio and Data Map'."\n" + .'* maxcompute_desense_code: data masking at the MaxCompute compute engine layer'."\n" + .'* maxcompute_new_desense_code: data masking at the MaxCompute compute engine layer (new)'."\n" + .'* hologres_display_desense_code: data masking at the Hologres compute engine layer'."\n" + .'* dataworks_data_integration_desense_code: static data masking in Data Integration'."\n" + .'* dataworks_analysis_desense_code: masking of displayed data in DataAnalysis'."\n", 'type' => 'string', 'required' => true, 'example' => 'dataworks_display_desense_code'], ], [ - 'name' => 'FileName', - 'in' => 'formData', + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => 'The status of the data masking rule. Valid values:'."\n" + ."\n" + .'* 0: expired'."\n" + .'* 1: effective'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The name of the file for the function.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'StringConcat', + 'title' => 'OpenApiResultModel', + 'description' => 'OpenApiResultModel'."\n", + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '1029030003'], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'param error'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '400'], + 'Data' => ['description' => 'The operation result. Valid values:'."\n" + ."\n" + .'* true: The operation is successful.'."\n" + .'* false: The operation fails.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'RequestId' => ['description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", 'type' => 'string', 'example' => '102400001'], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'PARAMS.ERROR', 'errorMessage' => 'param error.', 'description' => ''], + ['errorCode' => 'DESENSPLAN.DATATYPE.ERROR', 'errorMessage' => 'Sensitive type already has a desensitization rule.', 'description' => 'Desensitization rules have been configured for sensitive types.'], + ['errorCode' => 'DESENSPLAN.DATATYPENOTEXIST.ERROR', 'errorMessage' => 'Sensitive type not exist.', 'description' => 'The sensitive type does not exist.'], + ['errorCode' => 'DESENSPLAN.ID.ERROR', 'errorMessage' => 'Desensitization rule ID does not exist.', 'description' => 'The desensitization rule ID does not exist.'], + ['errorCode' => 'DESENSPLAN.PAGESIZE.ERROR', 'errorMessage' => 'Page size is too large, maximum of 100.', 'description' => 'Page size limit, up to 100'], + ['errorCode' => 'DESENSPLAN.PARAM.ERROR', 'errorMessage' => 'Desensitization rule parameter error.', 'description' => 'The desensitization rule parameter is incorrect.'], + ['errorCode' => 'DESENSPLAN.SCENECODE.ERROR', 'errorMessage' => 'Scene code does not exist.', 'description' => 'Scene code does not exist'], + ['errorCode' => 'DESENSPLAN.SCENEID.ERROR', 'errorMessage' => 'Scene ID does not exist.', 'description' => 'Scene ID does not exist.'], + ['errorCode' => 'DESENSPLAN.SCENEIDLEVEL.ERROR', 'errorMessage' => 'The scene is not a secondary scene.', 'description' => 'The scene is not a secondary scene.'], + ['errorCode' => 'DESENSPLAN.SIZE.ERROR', 'errorMessage' => 'The number of desens plan exceeds the limit.', 'description' => 'The number of desensitization rules exceeded the limit.'], + ], + 403 => [ + ['errorCode' => 'PERMISSION.DENIED.ERROR', 'errorMessage' => 'Permission denied', 'description' => 'Insufficient permissions.'], + ], + 500 => [ + ['errorCode' => 'UNKNOWN.ERROR', 'errorMessage' => 'unknown error.', 'description' => 'Unknown error.'], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1029030003\\",\\n \\"ErrorMessage\\": \\"param error\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"102400001\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 1029030003\\n param error\\n 400\\n true\\n 102400001\\n","errorExample":""}]', + 'title' => 'DsgDesensPlanUpdateStatus', + 'summary' => 'Modifies the status of a data masking rule.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'FunctionType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The type of the function. Valid values: MATH, AGGREGATE, STRING, DATE, ANALYTIC, and OTHER. This parameter corresponds to the Function Type parameter in the Register Function section of the configuration tab of the function on the DataStudio page.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [], - 'example' => 'STRING', - 'enum' => [ - 'MATH', - 'AGGREGATE', - 'STRING', - 'DATE', - 'ANALYTIC', - 'OTHER', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:DsgDesensPlanUpdateStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], + ], + ], + 'DsgPlatformQueryProjectsAndSchemaFromMeta' => [ + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'ClassName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the class in which the function is defined. This parameter corresponds to the Class Name parameter in the Register Function section of the configuration tab of the function in the DataWorks console.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'com.alibaba.DataWorks.api.udf.StringConcat', - ], - ], - [ - 'name' => 'Resources', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The names of the resources that are referenced by the function. This parameter corresponds to the Resources parameter in the Register Function section of the configuration tab of the function in the DataWorks console. Multiple resource names are separated by commas (,).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'string-concat-1.0.0.jar,commons-lang-2.6.jar', - ], + 'AK' => [], ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '219458', + 'abilityTreeNodes' => ['FEATUREdideRZM9W6'], + ], + 'parameters' => [ [ - 'name' => 'UdfDescription', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The description of the function. This parameter corresponds to the Description parameter in the Register Function section of the configuration tab of the function on the DataStudio page.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'Concatenate several strings to generate a new string', - ], + 'name' => 'EngineName', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The type of the compute engine. Valid values:'."\n" + ."\n" + .'* ODPS.ODPS'."\n" + .'* EMR'."\n" + .'* HOLO.POSTGRES'."\n", 'type' => 'string', 'required' => true, 'example' => 'EMR'], ], - [ - 'name' => 'CmdDescription', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The syntax used for calling the function. This parameter corresponds to the Expression Syntax parameter in the Register Function section of the configuration tab of the function in the DataWorks console.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'StringConcat(String... substrs)', + 'title' => 'OpenApiResultModel>', + 'description' => 'OpenApiResultModel\\'."\n", + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '1029030003'], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'param error'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '400'], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Project' => ['description' => 'The name of the compute engine.'."\n", 'type' => 'string', 'example' => 'emr_test_project'], + 'ClusterId' => ['description' => 'The ID of the EMR cluster. This parameter is generated only when the request parameter EngineName is set to EMR.'."\n", 'type' => 'string', 'example' => 'c-12345'], + ], + ], + ], + 'RequestId' => ['description' => 'The request ID. You can use the ID to locate logs and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '102400001'], + ], ], ], - [ - 'name' => 'ParameterDescription', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The description of the input parameters of the function. This parameter corresponds to the Parameter Description parameter in the Register Function section of the configuration tab of the function on the DataStudio page.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'List of strings to be connected', - 'default' => '', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'PARAMS.ERROR', 'errorMessage' => 'param error.', 'description' => ''], + ['errorCode' => 'ENGINE.NOT.ALLOW', 'errorMessage' => 'engine not allow.', 'description' => 'Engine type not allowed'], ], - [ - 'name' => 'ReturnValue', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The description of the return value of the function. This parameter corresponds to the Return Value parameter in the Register Function section of the configuration tab of the function on the DataStudio page.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'New strings generated by concatenating all strings before and after the input order', - 'default' => 'false', - ], + 403 => [ + ['errorCode' => 'PERMISSION.DENIED.ERROR', 'errorMessage' => 'Permission denied', 'description' => 'Insufficient permissions.'], + ], + 500 => [ + ['errorCode' => 'UNKNOWN.ERROR', 'errorMessage' => 'unknown error.', 'description' => 'Unknown error.'], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1029030003\\",\\n \\"ErrorMessage\\": \\"param error\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": [\\n {\\n \\"Project\\": \\"emr_test_project\\",\\n \\"ClusterId\\": \\"c-12345\\"\\n }\\n ],\\n \\"RequestId\\": \\"102400001\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 1029030003\\n param error\\n 400\\n \\n emr_test_project\\n c-12345\\n \\n 102400001\\n","errorExample":""}]', + 'title' => 'DsgPlatformQueryProjectsAndSchemaFromMeta', + 'summary' => 'Queries a list of compute engines of different types in the current tenant.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'Example', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The example for calling the function. This parameter corresponds to the Example parameter in the Register Function section of the configuration tab of the function in the DataWorks console.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'StringConcat(\'a\', \'b\', \'c\')', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:DsgPlatformQueryProjectsAndSchemaFromMeta', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'DsgQueryDefaultTemplates' => [ + 'summary' => 'Retrieves available Sensitive Data Type Templates and the Desensitization Rules they support. Use the response from this API to configure your Desensitization Rules.', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'ProjectIdentifier', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The unique identifier of the DataWorks workspace. You can click the identifier in the upper-left corner of the DataStudio page to switch to another workspace.'."\n" - ."\n" - .'You must specify either this parameter or the projectId parameter to determine the DataWorks workspace to which the operation is called.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dw_project', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '219249', + 'abilityTreeNodes' => ['FEATUREdideRZM9W6'], + ], + 'parameters' => [ [ - 'name' => 'CreateFolderIfNotExists', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether to automatically create the directory that is specified by the FileFolderPath parameter if the directory does not exist. Valid values:'."\n" - ."\n" - .'* true: The system automatically creates the directory if the directory does not exist.'."\n" - .'* false: The system does not automatically create the directory if the directory does not exist. In this case, the call fails.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the Level-2 Desensitization Scene. Call the [DsgSceneQuerySceneListByName](~~2786322~~) API to obtain this ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '123'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'OpenApiResultModel>', + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true: The request was successful.'."\n" + ."\n" + .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned if the request fails.', 'type' => 'string', 'example' => '1029030003', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the request fails.', 'type' => 'string', 'example' => 'param error', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '400', 'title' => ''], 'Data' => [ - 'description' => 'The ID of the file that was created.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100000002', - ], - 'RequestId' => [ - 'description' => 'The ID of the request. You can troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', + 'description' => 'The data returned.', + 'type' => 'array', + 'items' => [ + 'description' => 'An object representing a Sensitive Data Type Template.', + 'type' => 'object', + 'properties' => [ + 'DataType' => ['description' => 'The Sensitive Data Type.', 'type' => 'string', 'example' => 'phone', 'title' => ''], + 'DesensPlanTemplate' => [ + 'description' => 'A list of supported Desensitization Methods and their parameter descriptions.', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the Desensitization Method.', 'type' => 'string', 'example' => 'hash', 'title' => ''], + 'SupportWaterMark' => ['description' => 'Indicates whether watermarking is supported. Valid values:'."\n" + ."\n" + .'- true: Watermarking is supported.'."\n" + ."\n" + .'- false: Watermarking is not supported.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ExtParamTemplate' => [ + 'type' => 'array', + 'items' => ['description' => 'A JSON object that describes the supported Desensitization Rules and their parameter configurations. This object is for reference only and cannot be used as direct input to create or modify Desensitization Rules.', 'type' => 'any', 'example' => '{ "key": "algo", "valueEnum": [ "MD5", "SHA256", "SHA512", "SM3" ], "valueType": "string" }, { "key": "salt", "valueEnum": [ 1, 2, 3, 4, 5, 6, 7, 8, 9 ], "valueType": "int" }', 'title' => ''], + 'description' => 'A list of Desensitization Parameters and their descriptions.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The Desensitization Method and its parameters.', + 'title' => '', + 'example' => '', + ], + 'description' => 'The Desensitization Method and its parameters.', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'The Request ID. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '102400001', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + 400 => [ + ['errorCode' => 'DESENSTEMPLATE.SCENE.ERROR', 'errorMessage' => 'Scene ID does not exist.', 'description' => 'Scene ID does not exist.'], + ['errorCode' => 'DESENSTEMPLATE.SCENELEVEL.ERROR', 'errorMessage' => 'The scene is not a secondary scene.', 'description' => 'The scene is not a secondary scene.'], + ['errorCode' => 'PARAMS.ERROR', 'errorMessage' => 'param error.', 'description' => ''], ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + 403 => [ + ['errorCode' => 'PERMISSION.DENIED.ERROR', 'errorMessage' => 'Permission denied', 'description' => 'Insufficient permissions.'], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], + ['errorCode' => 'UNKNOWN.ERROR', 'errorMessage' => 'unknown error.', 'description' => 'Unknown error.'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 100000002,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 0000-ABCD-EFG****\\n 200\\n 100000002\\n true\\n","errorExample":""}]', - 'title' => 'CreateUdfFile', - 'summary' => 'Creates a file for a function in DataStudio.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'CreateBusiness' => [ - 'methods' => [ - 'post', + 'title' => 'DsgQueryDefaultTemplates', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:QueryDefaultTemplates', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1029030003\\",\\n \\"ErrorMessage\\": \\"param error\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": [\\n {\\n \\"DataType\\": \\"phone\\",\\n \\"DesensPlanTemplate\\": {\\n \\"key\\": [\\n {\\n \\"Name\\": \\"hash\\",\\n \\"SupportWaterMark\\": true,\\n \\"ExtParamTemplate\\": [\\n \\"{ \\\\\\"key\\\\\\": \\\\\\"algo\\\\\\", \\\\\\"valueEnum\\\\\\": [ \\\\\\"MD5\\\\\\", \\\\\\"SHA256\\\\\\", \\\\\\"SHA512\\\\\\", \\\\\\"SM3\\\\\\" ], \\\\\\"valueType\\\\\\": \\\\\\"string\\\\\\" }, { \\\\\\"key\\\\\\": \\\\\\"salt\\\\\\", \\\\\\"valueEnum\\\\\\": [ 1, 2, 3, 4, 5, 6, 7, 8, 9 ], \\\\\\"valueType\\\\\\": \\\\\\"int\\\\\\" }\\"\\n ]\\n }\\n ]\\n }\\n }\\n ],\\n \\"RequestId\\": \\"102400001\\"\\n}","type":"json"}]', + ], + 'DsgQueryDesensStatusList' => [ + 'summary' => 'Query data masking switch status', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '78175', - 'abilityTreeNodes' => [ - 'FEATUREdide8FM783', - ], + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '219463', + 'abilityTreeNodes' => ['FEATUREdideRZM9W6'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the workspace ID.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '10000', - ], - ], - [ - 'name' => 'ProjectIdentifier', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace Management page to obtain the workspace name. You must configure either this parameter or ProjectId parameter to determine the DataWorks workspace to which the operation is applied.', - 'type' => 'string', - 'required' => false, - 'example' => 'dw_project', - ], + 'name' => 'SceneCode', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Primary scene code', 'type' => 'string', 'required' => true, 'example' => 'dataworks_display_desense_code'], ], [ - 'name' => 'BusinessName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the business process. The name of the business process in the same project must be unique.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'My business process', - ], + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Query keyword', 'type' => 'string', 'required' => false, 'example' => 'my'], ], [ - 'name' => 'Description', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The description of the business process.', - 'type' => 'string', - 'required' => false, - 'example' => 'This is a business process created through an interface.', - ], + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Page number', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], ], [ - 'name' => 'Owner', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The Alibaba Cloud account ID of the owner of the business process. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and hover over the user avatar on the right side of the top menu bar to view the account ID. If this parameter is empty, the caller\'s Alibaba Cloud account ID is used by default.', - 'type' => 'string', - 'required' => false, - 'example' => '1000000000001', - ], + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Page size', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10'], ], [ - 'name' => 'UseType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The module to which the workflow belongs. Valid values:'."\n" - ."\n" - .'* NORMAL: The workflow belongs to auto triggered workflows.'."\n" - .'* MANUAL_BIZ: The workflow belongs to manually triggered workflows.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [], - 'example' => 'NORMAL', - 'default' => 'NORMAL', - 'enum' => [ - 'NORMAL', - 'MANUAL_BIZ', - ], - ], + 'name' => 'sceneId', + 'in' => 'query', + 'schema' => ['description' => 'Scene ID. Only required when querying project workspace switch data.', 'type' => 'string', 'required' => false, 'example' => '124', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'OpenApiResultModel>', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'BusinessId' => [ - 'description' => 'The workflow ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100001', + 'Success' => ['description' => 'Whether the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'Error code.'."\n" + ."\n", 'type' => 'string', 'example' => '400010', 'title' => ''], + 'ErrorMessage' => ['description' => 'Error message'."\n" + .'.', 'type' => 'string', 'example' => 'param error', 'title' => ''], + 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => [ + 'description' => 'Response data details.', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => 'Page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'Number of records displayed per page'."\n" + .'.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'TotalCount' => ['description' => 'Total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'PageData' => [ + 'description' => 'Data masking rule type.', + 'type' => 'array', + 'items' => [ + 'description' => 'Data item.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'Switch ID', 'type' => 'integer', 'format' => 'int64', 'example' => '56207'], + 'DesensStatus' => ['title' => '', 'description' => 'Switch status'."\n" + .'1: Enabled'."\n" + .'0: Disabled', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'HandleSpace' => ['title' => '', 'description' => 'Represents project space name or workspace ID depending on the scenario', 'type' => 'string', 'example' => '1'], + 'WorkspaceIdentifier' => ['title' => '', 'description' => 'Workspace unique identifier', 'type' => 'string', 'example' => 'test_space'], + 'WorkspaceName' => ['title' => '', 'description' => 'Workspace name', 'type' => 'string', 'example' => 'test_space'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'Request ID.', 'type' => 'string', 'example' => 'AASFDFSDFG-DFSDF-DFSDFD-SDFSDF', 'title' => ''], ], - 'description' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + 400 => [ + ['errorCode' => 'PARAMS.ERROR', 'errorMessage' => 'param error.', 'description' => ''], + ['errorCode' => 'DESENSSTATUS.ID.ERROR', 'errorMessage' => 'The desens status switch ID does not match or does not exist with the tenant.', 'description' => 'the desensitization switch id does not exist or does not belong to the tenant'], + ['errorCode' => 'DESENSSTATUS.PAGESIZE.ERROR', 'errorMessage' => 'Page size is too large, maximum of 100.', 'description' => 'Page size exceeded limit, up to 100.'], + ['errorCode' => 'DESENSSTATUS.SCENECODE.ERROR', 'errorMessage' => 'Scene code does not exist.', 'description' => 'Scene code does not exist.'], + ['errorCode' => 'DESENSSTATUS.SIZE.ERROR', 'errorMessage' => 'The number of desens status exceeds the limit.', 'description' => 'The number of desensitization switches exceeds the limit'], ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + 403 => [ + ['errorCode' => 'PERMISSION.DENIED.ERROR', 'errorMessage' => 'Permission denied', 'description' => 'Insufficient permissions.'], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], + ['errorCode' => 'UNKNOWN.ERROR', 'errorMessage' => 'unknown error.', 'description' => 'Unknown error.'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"BusinessId\\": 100001\\n}","errorExample":""},{"type":"xml","example":"0000-ABCD-EFG****\\n200\\nInvalid.Tenant.ConnectionNotExists\\nThe connection does not exist.\\n100001\\ntrue","errorExample":""}]', - 'title' => 'CreateBusiness', - 'summary' => 'Creates a workflow in DataStudio.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DeleteBusiness' => [ - 'methods' => [ - 'post', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'Query data masking switch', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:DsgQueryDesensStatusList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"400010\\",\\n \\"ErrorMessage\\": \\"param error\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 100,\\n \\"PageData\\": [\\n {\\n \\"Id\\": 56207,\\n \\"DesensStatus\\": 1,\\n \\"HandleSpace\\": \\"1\\",\\n \\"WorkspaceIdentifier\\": \\"test_space\\",\\n \\"WorkspaceName\\": \\"test_space\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"AASFDFSDFG-DFSDF-DFSDFD-SDFSDF\\"\\n}","type":"json"}]', + ], + 'DsgQuerySensResult' => [ + 'summary' => 'Retrieve sensitive data identification results from Data Security Guard.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '78202', - 'abilityTreeNodes' => [ - 'FEATUREdide8FM783', - ], + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '215091', + 'abilityTreeNodes' => ['FEATUREdide64ITEV'], ], 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['description' => 'To obtain the tenant ID, log on to the [DataWorks console](https://workbench.data.aliyun.com/console), go to the DataStudio page, click your username in the upper-right corner, and then choose Menu > User Info.', 'type' => 'string', 'required' => false, 'example' => '10241024', 'title' => ''], + ], + [ + 'name' => 'DbType', 'in' => 'formData', 'schema' => [ - 'description' => 'The ID of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Management page to obtain the ID. You must specify either this parameter or ProjectIdentifier to determine the DataWorks workspace to which the operation is applied.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The type of the data source. Valid values:'."\n" + ."\n" + .'- **ODPS.ODPS**'."\n" + ."\n" + .'- **HOLO.POSTGRES**'."\n" + ."\n" + .'- **EMR**', + 'enumValueTitles' => [], + 'type' => 'string', 'required' => false, - 'docRequired' => false, - 'example' => '10000', + 'example' => 'ODPS.ODPS', + 'title' => '', ], ], [ - 'name' => 'ProjectIdentifier', + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the DataWorks workspace. You can find this on the workspace configuration page in the [DataWorks console](https://workbench.data.aliyun.com/console).', 'type' => 'string', 'required' => false, 'example' => 'project', 'title' => ''], + ], + [ + 'name' => 'SchemaName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the schema.', 'type' => 'string', 'required' => false, 'example' => 'schema', 'title' => ''], + ], + [ + 'name' => 'Table', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the table.', 'type' => 'string', 'required' => false, 'example' => 'table', 'title' => ''], + ], + [ + 'name' => 'Col', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the column.', 'type' => 'string', 'required' => false, 'example' => 'col', 'title' => ''], + ], + [ + 'name' => 'NodeName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the classification node.', 'type' => 'string', 'required' => false, 'example' => 'Personal information', 'title' => ''], + ], + [ + 'name' => 'Level', + 'in' => 'formData', + 'schema' => ['description' => 'The sensitivity level of the column.', 'type' => 'string', 'required' => false, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'SensStatus', 'in' => 'formData', 'schema' => [ - 'description' => 'The name of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Settings panel to obtain the name. You must specify either this parameter or ProjectId to determine the DataWorks workspace to which the operation is applied.'."\n", + 'description' => 'The sensitivity status of the column.'."\n" + ."\n" + .'Valid values: `sensitive`, `noIdentify`, and `noResult`.', + 'enumValueTitles' => [], 'type' => 'string', 'required' => false, - 'example' => 'dw_project', + 'example' => '1', + 'title' => '', ], ], [ - 'name' => 'BusinessId', + 'name' => 'SensitiveId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the sensitive column.', 'type' => 'string', 'required' => false, 'example' => '10241024', 'title' => ''], + ], + [ + 'name' => 'SensitiveName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the sensitive column.', 'type' => 'string', 'required' => false, 'example' => 'name', 'title' => ''], + ], + [ + 'name' => 'Order', 'in' => 'formData', 'schema' => [ - 'description' => 'The ID of the workflow. You can call the [ListBusiness](~~173945~~) operation to query the workflow ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1000001', + 'description' => 'The sort order. Valid values:'."\n" + ."\n" + .'- `DESC`: descending order.'."\n" + ."\n" + .'- `ASC`: ascending order.', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'example' => 'DESC', + 'title' => '', ], ], + [ + 'name' => 'OrderField', + 'in' => 'formData', + 'schema' => ['description' => 'The column by which to sort the results. Valid values:'."\n" + ."\n" + .'- `gmt_create`'."\n" + ."\n" + .'- `gmt_modified`', 'type' => 'string', 'required' => false, 'example' => 'gmt_create', 'title' => ''], + ], + [ + 'name' => 'PageNo', + 'in' => 'formData', + 'schema' => ['description' => 'The page number. Minimum value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['description' => 'The page size. Default value: 10. Maximum value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'startDate', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => ''], + ], + [ + 'name' => 'endDate', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'RequestId' => [ - 'description' => 'The ID of the request. You can use the ID to troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'title' => 'OpenApiResultModel', + 'description' => 'The response data.', + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the request succeeded.'."\n" + ."\n" + .'- true: The request succeeded.'."\n" + ."\n" + .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '400', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Missing parameter', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '400', 'title' => ''], + 'Data' => ['description' => 'The returned data.', 'type' => 'any', 'example' => '1234', 'title' => ''], + 'RequestId' => ['description' => 'A unique identifier for this request.', 'type' => 'string', 'example' => '900000001', 'title' => ''], + 'DynamicErrorCode' => ['description' => 'This parameter has the same value as the `ErrorCode` parameter.', 'type' => 'string', 'example' => '400', 'title' => ''], + 'DynamicErrorMessage' => ['description' => 'This parameter has the same value as the `ErrorMessage` parameter.', 'type' => 'string', 'example' => 'Missing parameter', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], + 400 => [ + ['errorCode' => 'BADPARAMETERS', 'errorMessage' => 'Parameters are missing or in the wrong format.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"0000-ABCD-EFG****\\n200\\nInvalid.Tenant.ConnectionNotExists\\nThe connection does not exist.\\ntrue","errorExample":""}]', - 'title' => 'DeleteBusiness', - 'summary' => 'Deletes a workflow.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'CreateFolder' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'DsgQuerySensResult', + 'description' => 'This API retrieves sensitive data identification results for a specified tenant, mirroring the query functionality in the Data Security Guard console.'."\n" + ."\n" + .'- Filter results by dimensions such as data source type and workspace.'."\n" + ."\n" + .'- Sort results by a specific column in ascending or descending order.'."\n" + ."\n" + .'- Paginate the query results.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"400\\",\\n \\"ErrorMessage\\": \\"Missing parameter\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": \\"1234\\",\\n \\"RequestId\\": \\"900000001\\",\\n \\"DynamicErrorCode\\": \\"400\\",\\n \\"DynamicErrorMessage\\": \\"Missing parameter\\"\\n}","type":"json"}]', + ], + 'DsgRunSensIdentify' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '78186', - 'abilityTreeNodes' => [ - 'FEATUREdide8FM783', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '212734', + 'abilityTreeNodes' => ['FEATUREdide1B7LSC'], ], 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'TenantId', 'in' => 'formData', - 'schema' => [ - 'description' => '$.parameters[4].schema.enumValueTitles', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '10000', - ], + 'schema' => ['description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n", 'type' => 'string', 'required' => true, 'example' => '10241024'], ], [ - 'name' => 'ProjectIdentifier', + 'name' => 'EsMetaParams', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID. You must configure either this parameter or the **ProjectIdentifier** parameter to determine the DataWorks workspace to which the operation is applied.'."\n", - 'type' => 'string', + 'description' => 'The parameters that you need to configure to scan specified metadata.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The parameter that you need to configure to scan specified metadata.'."\n", + 'type' => 'object', + 'properties' => [ + 'DbType' => ['description' => 'The type of the data source. Valid values:'."\n" + ."\n" + .'* ODPS.ODPS'."\n" + .'* EMR'."\n" + .'* HOLO.POSTGRES'."\n", 'type' => 'string', 'required' => false, 'example' => 'ODPS.ODPS'], + 'ClusterId' => ['description' => 'The cluster ID. You can obtain the ID based on the data source you use.'."\n", 'type' => 'string', 'required' => false, 'example' => '101010'], + 'ProjectName' => ['description' => 'The name of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to query the name.'."\n", 'type' => 'string', 'required' => false, 'example' => '1666676756691024'], + 'SchemaName' => ['description' => 'The name of the schema.'."\n", 'type' => 'string', 'required' => false, 'example' => 'default'], + 'TableName' => ['description' => 'The name of the table.'."\n", 'type' => 'string', 'required' => false, 'example' => 'table1'], + 'TableNameList' => [ + 'description' => 'The names of the tables.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The name of the table.'."\n", 'type' => 'string', 'required' => false, 'example' => 'table1,table2'], + 'required' => false, + ], + 'User' => ['description' => 'The username of the operator. We recommend that you enter the username of your Alibaba Cloud account.'."\n", 'type' => 'string', 'required' => false, 'example' => 'xxx-uat'], + 'InstanceId' => ['description' => 'The instance ID. You can obtain the ID based on the data source you use.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => 'hgprecn-cn-9lb37k181024'], + ], + 'required' => false, + ], 'required' => false, - 'example' => 'dw_project', - ], - ], - [ - 'name' => 'FolderPath', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace page to obtain the workspace name. You must configure either this parameter or the **ProjectId** parameter to determine the DataWorks workspace to which the operation is applied.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Business_process/System_Data/MaxCompute/import_layer', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'DataWorksResult', + 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The path of the folder.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The unique identifier of the folder.'."\n", - 'type' => 'string', - 'example' => 'bdfd68****', - ], - 'RequestId' => [ - 'description' => 'The ID of the request. You can use the ID to troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '9990030003'], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'Missing parameter'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['description' => 'The ID of the generated sensitive data identification task. The value is of the INT 64 type.'."\n", 'type' => 'any', 'example' => '1000001'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '400'], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '10000001'], ], ], ], ], 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + 400 => [ + ['errorCode' => 'BADPARAMETERS', 'errorMessage' => 'Parameters are missing or in the wrong format.', 'description' => ''], ], - 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ErrorCode\\": \\"9990030003\\",\\n \\"ErrorMessage\\": \\"Missing parameter\\",\\n \\"Success\\": true,\\n \\"Data\\": \\"1000001\\",\\n \\"HttpStatusCode\\": 400,\\n \\"RequestId\\": \\"10000001\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 9990030003\\n 缺少参数\\n true\\n 1000001\\n 400\\n 10000001\\n","errorExample":""}]', + 'title' => 'DsgRunSensIdentify', + 'summary' => 'Starts a sensitive data identification task in Data Security Guard.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dataworks:RunIdentifyOpenapi', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"bdfd68****\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n bdfd68****\\n 0000-ABCD-EFG\\n The connection does not exist.\\n true\\n Invalid.Tenant.ConnectionNotExists\\n","errorExample":""}]', - 'title' => 'CreateFolder', - 'summary' => 'The operation that you want to perform. Set the value to \\\\*\\\\*CreateFolder\\\\*\\\\*.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'UpdateBusiness' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DsgSceneAddOrUpdateScene' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '78366', - 'abilityTreeNodes' => [ - 'FEATUREdide8FM783', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '219459', + 'abilityTreeNodes' => ['FEATUREdideRZM9W6'], ], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'formData', + 'name' => 'scenes', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The ID of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Management page to obtain the workspace ID. You must configure either this parameter or the ProjectIdentifier parameter to determine the DataWorks workspace to which the operation is applied.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '10000', + 'description' => 'The information about the level-2 data masking scenario.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the level-2 data masking scenario.'."\n", + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The ID of the level-2 data masking scenario.'."\n" + ."\n" + .'* If you do not configure this parameter, the current operation is to add a level-2 data masking scenario.'."\n" + .'* If you configure this parameter, the current operation is to modify a level-2 data masking scenario. You can call the [DsgSceneQuerySceneListByName](~~2786322~~) operation to query the ID of the level-2 data masking scenario.'."\n", 'type' => 'string', 'required' => false, 'example' => '123'], + 'sceneName' => ['description' => 'The name of the level-2 data masking scenario.'."\n", 'type' => 'string', 'required' => true, 'example' => 'dev_scene'], + 'sceneCode' => ['description' => 'The code of the level-1 data masking scenario to which the level-2 data masking scenario belongs. Valid values:'."\n" + ."\n" + .'* dataworks_display_desense_code: masking of displayed data in DataStudio and Data Map'."\n" + .'* maxcompute_desense_code: data masking at the MaxCompute compute engine layer'."\n" + .'* maxcompute_new_desense_code: data masking at the MaxCompute compute engine layer (new)'."\n" + .'* dataworks_analysis_desense_code: masking of displayed data in DataAnalysis'."\n", 'type' => 'string', 'required' => true, 'example' => 'dataworks_display_desense_code'], + 'projects' => [ + 'description' => 'The information about the compute engine for which the data masking scenario takes effect.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the compute engine for which the data masking scenario takes effect.'."\n", + 'type' => 'object', + 'properties' => [ + 'clusterId' => ['description' => 'If the data masking scenario takes effect for an E-MapReduce (EMR) compute engine, enter the ID of an EMR cluster. This parameter is required only when you use an EMR compute engine.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c-1234'], + 'projectName' => ['description' => 'The name of the compute engine instance for which the data masking scenario takes effect.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dev_project'], + 'dbType' => ['description' => 'The type of the compute engine for which the data masking scenario takes effect. Valid values:'."\n" + ."\n" + .'* ODPS: ODPS.ODPS'."\n" + .'* HOLO: HOLO.POSTGRES'."\n" + .'* EMR: EMR'."\n", 'type' => 'string', 'required' => false, 'example' => 'ODPS.ODPS'], + ], + 'required' => false, + ], + 'required' => false, + ], + 'desc' => ['description' => 'The description.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Test scenarios'], + 'userGroupIds' => [ + 'description' => 'The information about the user group for which the data masking scenario takes effect.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The ID of the user group for which the data masking scenario takes effect. You can call the [DsgUserGroupQueryList](~~2786441~~) operation to query the user group ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123'], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => true, ], ], - [ - 'name' => 'ProjectIdentifier', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The name of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Management page to obtain the workspace name. You must configure either this parameter or ProjectId parameter to determine the DataWorks workspace to which the operation is applied.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dw_project', + 'title' => 'OpenApiResultModel', + 'description' => 'OpenApiResultModel'."\n", + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '1029030003'], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'param error'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '400'], + 'Data' => ['description' => 'The operation result.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'RequestId' => ['description' => 'The request ID. You can use the ID to locate logs and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '102400001'], + ], ], ], - [ - 'name' => 'BusinessName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the workflow. You can call the [ListBusiness](~~173945~~) operation to obtain the workflow name.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'MyBusiness', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'DESENSSCENE.ID.ERROR', 'errorMessage' => 'The desensitization scenario ID does not match or does not exist with the tenant.', 'description' => 'The scenario ID does not exist or does not belong to the tenant.'], + ['errorCode' => 'DESENSSCENE.IDLEVEL.ERROR', 'errorMessage' => 'The desensitization scenario is not a secondary scenario.', 'description' => ''], + ['errorCode' => 'DESENSSCENE.PROJECT.ERROR', 'errorMessage' => 'The project space does not exist.', 'description' => ''], + ['errorCode' => 'DESENSSCENE.SIZE.ERROR', 'errorMessage' => 'The number of desens scene exceeds the limit.', 'description' => 'Number of desensitization scenarios chao xian'], + ['errorCode' => 'DESENSSCENE.UESRGROUP.ERROR', 'errorMessage' => 'The user group ID does not match the tenant or does not exist.', 'description' => 'The user group ID does not exist or does not belong to the tenant.'], + ['errorCode' => 'PARAMS.ERROR', 'errorMessage' => 'param error.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'PERMISSION.DENIED.ERROR', 'errorMessage' => 'Permission denied', 'description' => 'Insufficient permissions.'], + ], + 500 => [ + ['errorCode' => 'UNKNOWN.ERROR', 'errorMessage' => 'unknown error.', 'description' => 'Unknown error.'], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1029030003\\",\\n \\"ErrorMessage\\": \\"param error\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"102400001\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 1029030003\\n param error\\n 400\\n true\\n 102400001\\n","errorExample":""}]', + 'title' => 'DsgSceneAddOrUpdateScene', + 'summary' => 'Adds or modifies a level-2 data masking scenario.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'Description', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The description of the workflow.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'modified from my first business', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:DsgSceneAddOrUpdateScene', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'DsgSceneQuerySceneListByName' => [ + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'Owner', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The owner of the workflow. You can call the [ListBusiness](~~173945~~) operation to obtain the workflow owner.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '348428****', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '219224', + 'abilityTreeNodes' => ['FEATUREdideRZM9W6'], + ], + 'parameters' => [ [ - 'name' => 'BusinessId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the workflow. You can call the [ListBusiness](~~173945~~) operation to obtain the workflow ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '300000', - ], + 'name' => 'SceneName', + 'in' => 'query', + 'schema' => ['description' => 'The keyword for a fuzzy search of data masking scenario names.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'dev_'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'OpenApiResultModel>', + 'description' => 'OpenApiResultModel\\', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'RequestId' => [ - 'description' => 'The ID of the request. You can use the ID to troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '1029030003', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'param error', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '400', 'title' => ''], + 'Data' => [ + 'description' => 'The list of data masking scenarios.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of a data masking scenario.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the data masking scenario.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'SceneCode' => ['description' => 'The code for the level-1 scenario. Valid values:'."\n" + ."\n" + .'- Data masking in Data Map and DataStudio: `dataworks_display_desense_code`'."\n" + ."\n" + .'- Data masking at the MaxCompute engine layer: `maxcompute_desense_code`'."\n" + ."\n" + .'- Data masking at the MaxCompute engine layer (new): `maxcompute_new_desense_code`'."\n" + ."\n" + .'- Data masking at the Hologres engine layer: `hologres_display_desense_code`'."\n" + ."\n" + .'- Static data masking in Data Integration: `dataworks_data_integration_desense_code`'."\n" + ."\n" + .'- Data masking in Data Analysis: `dataworks_analysis_desense_code`', 'type' => 'string', 'example' => 'dataworks_display_desense_code', 'title' => ''], + 'Desc' => ['description' => 'The description of the data masking scenario.', 'type' => 'string', 'example' => 'Test scenarios', 'title' => ''], + 'SceneName' => ['description' => 'The name of the data masking scenario.', 'type' => 'string', 'example' => 'test_scene', 'title' => ''], + 'UserGroups' => ['description' => 'The user groups to which the data masking scenario applies. Multiple user group names are separated by a comma (,).', 'type' => 'string', 'example' => 'user1,user2', 'title' => ''], + 'SceneLevel' => ['description' => 'The level of the data masking scenario. Valid values:'."\n" + ."\n" + .'- `0`: level-1 scenario'."\n" + ."\n" + .'- `1`: level-2 scenario', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Projects' => [ + 'description' => 'The engine instances to which the data masking scenario applies.', + 'type' => 'array', + 'items' => [ + 'description' => 'An engine instance to which the data masking scenario applies.', + 'type' => 'object', + 'properties' => [ + 'DbType' => ['description' => 'The engine type. Valid values:'."\n" + ."\n" + .'- MaxCompute: `ODPS.ODPS`'."\n" + ."\n" + .'- Hologres: `HOLO.POSTGRES`'."\n" + ."\n" + .'- E-MapReduce (EMR): `EMR`', 'type' => 'string', 'example' => 'ODPS.ODPS', 'title' => ''], + 'ProjectName' => ['description' => 'The name of the engine instance.', 'type' => 'string', 'example' => 'dev_project', 'title' => ''], + 'ClusterId' => ['description' => 'The ID of the E-MapReduce (EMR) cluster. This parameter is returned only if the `DbType` is `EMR`.', 'type' => 'string', 'example' => 'c-123456', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Children' => [ + 'description' => 'The nested data masking scenarios.', + 'type' => 'array', + 'items' => ['description' => 'A nested (level-2) data masking scenario. The parameters for a nested scenario are the same as those for its parent.', 'type' => 'any', 'example' => '$ref', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'scenceDbType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'The ID of the request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '102400001', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + 400 => [ + ['errorCode' => 'DESENSSCENE.ID.ERROR', 'errorMessage' => 'The desensitization scenario ID does not match or does not exist with the tenant.', 'description' => 'The scenario ID does not exist or does not belong to the tenant.'], + ['errorCode' => 'DESENSSCENE.IDLEVEL.ERROR', 'errorMessage' => 'The desensitization scenario is not a secondary scenario.', 'description' => ''], + ['errorCode' => 'DESENSSCENE.PROJECT.ERROR', 'errorMessage' => 'The project space does not exist.', 'description' => ''], + ['errorCode' => 'DESENSSCENE.SIZE.ERROR', 'errorMessage' => 'The number of desens scene exceeds the limit.', 'description' => 'Number of desensitization scenarios chao xian'], + ['errorCode' => 'DESENSSCENE.UESRGROUP.ERROR', 'errorMessage' => 'The user group ID does not match the tenant or does not exist.', 'description' => 'The user group ID does not exist or does not belong to the tenant.'], + ['errorCode' => 'PARAMS.ERROR', 'errorMessage' => 'param error.', 'description' => ''], ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + 403 => [ + ['errorCode' => 'PERMISSION.DENIED.ERROR', 'errorMessage' => 'Permission denied', 'description' => 'Insufficient permissions.'], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], + ['errorCode' => 'UNKNOWN.ERROR', 'errorMessage' => 'unknown error.', 'description' => 'Unknown error.'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"0000-ABCD-EFG****\\n200\\nInvalid.Tenant.ConnectionNotExists\\nThe connection does not exist.\\ntrue","errorExample":""}]', - 'title' => 'UpdateBusiness', - 'summary' => 'Updates a workflow.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListFiles' => [ - 'methods' => [ - 'post', + 'title' => 'DsgSceneQuerySceneListByName', + 'summary' => 'Call the `DsgSceneQuerySceneListByName` API to retrieve a list of data masking scenarios.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:DsgSceneQuerySceneListByName', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1029030003\\",\\n \\"ErrorMessage\\": \\"param error\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": [\\n {\\n \\"Id\\": 123,\\n \\"SceneCode\\": \\"dataworks_display_desense_code\\",\\n \\"Desc\\": \\"Test scenarios\\",\\n \\"SceneName\\": \\"test_scene\\",\\n \\"UserGroups\\": \\"user1,user2\\",\\n \\"SceneLevel\\": 1,\\n \\"Projects\\": [\\n {\\n \\"DbType\\": \\"ODPS.ODPS\\",\\n \\"ProjectName\\": \\"dev_project\\",\\n \\"ClusterId\\": \\"c-123456\\"\\n }\\n ],\\n \\"Children\\": [\\n \\"$ref\\"\\n ],\\n \\"scenceDbType\\": \\"\\"\\n }\\n ],\\n \\"RequestId\\": \\"102400001\\"\\n}","type":"json"}]', + ], + 'DsgScenedDeleteScene' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '78310', - 'abilityTreeNodes' => [ - 'FEATUREdide8FM783', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '219460', + 'abilityTreeNodes' => ['FEATUREdideRZM9W6'], ], 'parameters' => [ [ - 'name' => 'FileFolderPath', - 'in' => 'formData', + 'name' => 'Ids', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The path of the folder to which files belong.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'Business_process/my_first_business_process/MaxCompute/ods_layer', + 'description' => 'The IDs of level-2 data masking scenarios.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The ID of the level-2 data masking scenario. You can call the [DsgSceneQuerySceneListByName](~~2786322~~) operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '123'], + 'required' => true, ], ], - [ - 'name' => 'ProjectId', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The ID of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace Management page to obtain the workspace ID.'."\n" - ."\n" - .'You must configure either the ProjectId or ProjectIdentifier parameter to determine the DataWorks workspace to which the operation is applied.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '10000', + 'title' => 'OpenApiResultModel', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '1029030003'], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'param error'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '400'], + 'Data' => ['description' => 'The operation result. Valid values:'."\n" + ."\n" + .'* true: The operation is successful.'."\n" + .'* false: The operation failed.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '102400001'], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'DESENSSCENE.ID.ERROR', 'errorMessage' => 'The desensitization scenario ID does not match or does not exist with the tenant.', 'description' => 'The scenario ID does not exist or does not belong to the tenant.'], + ['errorCode' => 'DESENSSCENE.IDLEVEL.ERROR', 'errorMessage' => 'The desensitization scenario is not a secondary scenario.', 'description' => ''], + ['errorCode' => 'DESENSSCENE.PROJECT.ERROR', 'errorMessage' => 'The project space does not exist.', 'description' => ''], + ['errorCode' => 'DESENSSCENE.SIZE.ERROR', 'errorMessage' => 'The number of desens scene exceeds the limit.', 'description' => 'Number of desensitization scenarios chao xian'], + ['errorCode' => 'DESENSSCENE.UESRGROUP.ERROR', 'errorMessage' => 'The user group ID does not match the tenant or does not exist.', 'description' => 'The user group ID does not exist or does not belong to the tenant.'], + ['errorCode' => 'PARAMS.ERROR', 'errorMessage' => 'param error.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'PERMISSION.DENIED.ERROR', 'errorMessage' => 'Permission denied', 'description' => 'Insufficient permissions.'], + ], + 500 => [ + ['errorCode' => 'UNKNOWN.ERROR', 'errorMessage' => 'unknown error.', 'description' => 'Unknown error.'], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1029030003\\",\\n \\"ErrorMessage\\": \\"param error\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"102400001\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 1029030003\\n param error\\n 400\\n true\\n 102400001\\n","errorExample":""}]', + 'title' => 'DsgScenedDeleteScene', + 'summary' => 'Deletes a level-2 data masking scenario created in Data Security Guard.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'Keyword', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The keyword in the file names. The keyword is used to perform a fuzzy match. You can specify a keyword to query all files whose names contain the keyword.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'ods', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:DsgScenedDeleteScene', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'DsgStopSensIdentify' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'ProjectIdentifier', + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '213660', + 'abilityTreeNodes' => ['FEATUREdide1B7LSC'], + ], + 'parameters' => [ + [ + 'name' => 'TenantId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace Management page to obtain the workspace name.'."\n" - ."\n" - .'You must configure either the ProjectId or ProjectIdentifier parameter to determine the DataWorks workspace to which the operation is applied.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dw_project', - ], + 'schema' => ['description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n", 'type' => 'string', 'required' => true, 'example' => '10241024'], ], [ - 'name' => 'PageNumber', + 'name' => 'JobId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'maximum' => '100', - 'minimum' => '0', - 'example' => '10', - 'default' => '10', - ], - ], - [ - 'name' => 'UseType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The module to which the files belong. Valid values:'."\n" - ."\n" - .'* NORMAL: The files are used for DataStudio.'."\n" - .'* MANUAL: The files are used for manually triggered nodes.'."\n" - .'* MANUAL_BIZ: The files are used for manually triggered workflows.'."\n" - .'* SKIP: The files are used for dry-run nodes in DataStudio.'."\n" - .'* ADHOCQUERY: The files are used for ad hoc queries.'."\n" - .'* COMPONENT: The files are used for snippets.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'NORMAL', - ], - ], - [ - 'name' => 'FileTypes', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The types of the code in the files.'."\n" - ."\n" - .'Valid values: 6 (Shell), 10 (ODPS SQL), 11 (ODPS MR), 23 (Data Integration), 24 (ODPS Script), 97 (PAI), 98 (node group), 99 (zero load), 221 (PyODPS 2), 225 (ODPS Spark), 227 (EMR Hive), 228 (EMR Spark), 229 (EMR Spark SQL), 230 (EMR MR), 239 (OSS object inspection), 257 (EMR Shell), 258 (EMR Spark Shell), 259 (EMR Presto), 260 (EMR Impala), 900 (real-time synchronization), 1002 (PAI inner node), 1089 (cross-tenant collaboration), 1091 (Hologres development), 1093 (Hologres SQL), 1100 (assignment), 1106 (for-each), and 1221 (PyODPS 3).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '10,23', - ], - ], - [ - 'name' => 'Owner', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The owner of the files.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '3726346****', - ], - ], - [ - 'name' => 'NodeId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the node that is scheduled. You can call the [ListNodes](~~173979~~) operation to query the ID of the node.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123541234', - ], - ], - [ - 'name' => 'NeedContent', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Whether the query results contain file content (for files with more content, there may be a long network transmission delay).', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - [ - 'name' => 'NeedAbsoluteFolderPath', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Whether the query result contains the path of the folder where the file is located.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - [ - 'name' => 'ExactFileName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The exact matching file name. The file name of the query result is exactly the same as this parameter.', - 'type' => 'string', - 'required' => false, - 'example' => 'ods_create.sql', - ], - ], - [ - 'name' => 'FileIdIn', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The file ID list. The File ID set of the query result can only be a subset of the list. You can specify up to 50 fileids at a time.', - 'type' => 'string', - 'required' => false, - 'example' => '78237,816123', - ], - ], - [ - 'name' => 'LastEditUser', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the Alibaba Cloud account that is used to last modify the file.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '38748246285727', - ], + 'schema' => ['description' => 'The ID of the sensitive data identification task. You can call the [DsgRunSensIdentify](~~2744039~~) operation to obtain the task ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1000001'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'OpenApiResultModel', 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful. Valid values:'."\n" - ."\n" - .'* true: The request is successful.'."\n" - .'* false: The request fails.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The files returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '13', - ], - 'Files' => [ - 'description' => 'The details of the files.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the file.'."\n", - 'type' => 'object', - 'properties' => [ - 'CommitStatus' => [ - 'description' => 'Indicates whether the latest code in the file is committed. Valid values: 0 and 1. The value 0 indicates that the latest code in the file is not committed. The value 1 indicates that the latest code in the file is committed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'AutoParsing' => [ - 'description' => 'Specifies whether the automatic parsing feature is enabled for the file. Valid values:'."\n" - ."\n" - .'* true: The automatic parsing feature is enabled for the file.'."\n" - .'* false: The automatic parsing feature is not enabled for the file.'."\n" - ."\n" - .'This parameter is equivalent to the Analyze Code parameter in the Dependencies section of the Properties panel in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Owner' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the file owner.'."\n", - 'type' => 'string', - 'example' => '3872572****', - ], - 'CreateTime' => [ - 'description' => 'The time when the file was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1593950832000', - ], - 'FileType' => [ - 'description' => 'The type of the code in the file. Valid values: 6 (Shell), 10 (ODPS SQL), 11 (ODPS MR), 23 (Data Integration), 24 (ODPS Script), 99 (zero load), 221 (PyODPS 2), 225 (ODPS Spark), 227 (EMR Hive), 228 (EMR Spark), 229 (EMR Spark SQL), 230 (EMR MR), 239 (OSS object inspection), 257 (EMR Shell), 258 (EMR Spark Shell), 259 (EMR Presto), 260 (EMR Impala), 900 (real-time synchronization), 1089 (cross-tenant collaboration), 1091 (Hologres development), 1093 (Hologres SQL), 1100 (assignment), and 1221 (PyODPS 3).'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'CurrentVersion' => [ - 'description' => 'The latest version number of the file.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'BizId' => [ - 'description' => 'The ID of the workflow to which the file belongs. This parameter is deprecated and replaced by the BusinessId parameter.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '300000', - ], - 'LastEditUser' => [ - 'description' => 'The ID of the Alibaba Cloud account that is used to last modify the file.'."\n", - 'type' => 'string', - 'example' => '38748246285727', - ], - 'FileName' => [ - 'description' => 'The name of the file.'."\n", - 'type' => 'string', - 'example' => 'ods_user_info_d', - ], - 'ConnectionName' => [ - 'description' => 'The ID of the compute engine instance that is used to run the node that corresponds to the file.'."\n", - 'type' => 'string', - 'example' => 'odps_first', - ], - 'UseType' => [ - 'description' => 'The module to which the file belongs. Valid values:'."\n" - ."\n" - .'* NORMAL: The file is used for DataStudio.'."\n" - .'* MANUAL: The file is used for a manually triggered node.'."\n" - .'* MANUAL_BIZ: The file is used for a manually triggered workflow.'."\n" - .'* SKIP: The files is used for a dry-run node in DataStudio.'."\n" - .'* ADHOCQUERY: The file is used for an ad hoc query.'."\n" - .'* COMPONENT: The file is used for a snippet.'."\n", - 'type' => 'string', - 'example' => 'NORMAL', - ], - 'FileFolderId' => [ - 'description' => 'The ID of the folder to which the file belongs.'."\n", - 'type' => 'string', - 'example' => '2735c2****', - ], - 'FileId' => [ - 'description' => 'The ID of the file.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000001', - ], - 'ParentId' => [ - 'description' => 'The ID of the node group file to which the current file belongs. This parameter is returned only if the current file is an inner file of the node group file.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '-1', - ], - 'CreateUser' => [ - 'description' => 'The ID of the Alibaba Cloud account that is used to create the file.'."\n", - 'type' => 'string', - 'example' => '382762****', - ], - 'IsMaxCompute' => [ - 'description' => 'Indicates whether the file needs to be uploaded to MaxCompute if the file is a MaxCompute resource file.'."\n" - ."\n" - .'This parameter is returned only if the file is a MaxCompute resource file.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'BusinessId' => [ - 'description' => 'The ID of the workflow to which the file belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '300000', - ], - 'FileDescription' => [ - 'description' => 'The description of the file.'."\n", - 'type' => 'string', - 'example' => 'my test datastudio file', - ], - 'LastEditTime' => [ - 'description' => 'The time when the file was last modified. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1593950832000', - ], - 'Content' => [ - 'description' => 'This parameter is deprecated. You can call the [GetFile](~~173954#doc-api-dataworks-public-GetFile~~) operation to query the details of the file.'."\n", - 'type' => 'string', - 'example' => 'SHOW TABLES;', - ], - 'NodeId' => [ - 'description' => 'The ID of the auto triggered node that is generated in the scheduling system after the file is committed.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '300001', - ], - 'AbsoluteFolderPath' => [ - 'description' => 'The path of the folder to which the file belongs.'."\n", - 'type' => 'string', - 'example' => 'Business_process/my_first_business_process/MaxCompute/ods_layer', - ], - ], - ], - ], - ], - ], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '9990030003'], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'Missing parameter'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Data' => ['description' => 'The returned data, which is of the Boolean type.'."\n", 'type' => 'any', 'example' => 'true'], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '10000001'], ], ], ], ], 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + 400 => [ + ['errorCode' => 'BADPARAMETERS', 'errorMessage' => 'Parameters are missing or in the wrong format.', 'description' => ''], ], - 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"9990030003\\",\\n \\"ErrorMessage\\": \\"Missing parameter\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"10000111\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 9990030003\\n 缺少参数\\n 200\\n true\\n 10000001\\n","errorExample":""}]', + 'title' => 'DsgStopSensIdentify', + 'summary' => 'Stops a sensitive data identification task.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dataworks:DsgStopSensIdentify', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 13,\\n \\"Files\\": [\\n {\\n \\"CommitStatus\\": 1,\\n \\"AutoParsing\\": true,\\n \\"Owner\\": \\"3872572****\\",\\n \\"CreateTime\\": 1593950832000,\\n \\"FileType\\": 10,\\n \\"CurrentVersion\\": 2,\\n \\"BizId\\": 300000,\\n \\"LastEditUser\\": \\"38748246285727\\",\\n \\"FileName\\": \\"ods_user_info_d\\",\\n \\"ConnectionName\\": \\"odps_source\\",\\n \\"UseType\\": \\"NORMAL\\",\\n \\"FileFolderId\\": \\"2735c2****\\",\\n \\"FileId\\": 10000001,\\n \\"ParentId\\": -1,\\n \\"CreateUser\\": \\"382762****\\",\\n \\"IsMaxCompute\\": false,\\n \\"BusinessId\\": 300000,\\n \\"FileDescription\\": \\"my test datastudio file\\",\\n \\"LastEditTime\\": 1593950832000,\\n \\"Content\\": \\"SHOW TABLES;\\",\\n \\"NodeId\\": 300001,\\n \\"AbsoluteFolderPath\\": \\"Business_process/my_first_business_process/MaxCompute/ods_layer\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n The connection does not exist.\\n 0000-ABCD-EFG\\n Invalid.Tenant.ConnectionNotExists\\n true\\n \\n 1\\n 10\\n 13\\n \\n 1\\n true\\n 3872572****\\n 1593950832000\\n 10\\n 2\\n 300000\\n 38748246285727\\n ods_user_info_d\\n odps_source\\n NORMAL\\n 2735c2****\\n 10000001\\n -1\\n 382762****\\n false\\n 300000\\n my test datastudio file\\n 1593950832000\\n SHOW TABLES;\\n 300001\\n \\n \\n","errorExample":""}]', - 'title' => 'ListFiles', - 'summary' => 'Queries a list of files.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'EstablishRelationTableToBusiness' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DsgUpdateDesensStatusList' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '78225', - 'abilityTreeNodes' => [ - 'FEATUREdideEPPSOE', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '219464', + 'abilityTreeNodes' => ['FEATUREdideRZM9W6'], + 'autoTest' => false, ], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the DataWorks workspace. You can click the Workspace Manage icon in the upper-right corner of the DataStudio page to go to the Workspace Management page and view the workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '10000', - ], - ], - [ - 'name' => 'ProjectIdentifier', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The unique identifier of the DataWorks workspace. You can click the identifier in the upper-left corner of the DataStudio page to switch to another workspace.'."\n" - ."\n" - .'You must specify either this parameter or ProjectId to determine the DataWorks workspace to which the operation is applied.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dw', - ], - ], - [ - 'name' => 'BusinessId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the workflow. You can call the [ListBusiness](~~173945~~) operation to query the ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1000001', - ], - ], - [ - 'name' => 'TableGuid', - 'in' => 'formData', + 'name' => 'Ids', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The universally unique identifier (UUID) of the table. You can call the [SearchMetaTables](~~173919~~) operation to query the UUID.'."\n", - 'type' => 'string', + 'description' => 'The list of switch IDs.', + 'type' => 'array', + 'items' => ['description' => 'The switch ID.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '[1026762360,1027140457,1028310138,1028334529,1028895658]', 'title' => ''], 'required' => true, - 'docRequired' => true, - 'example' => 'odps.dw_project.tb1', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'FolderId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the folder. You can call the [GetFolder](~~173952~~) or [ListFolders](~~173955~~) operation to query the ID.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '2eb6f9****', - ], + 'name' => 'DesensStatus', + 'in' => 'query', + 'schema' => ['description' => 'The switch status. Valid values:'."\n" + .'1: enabled'."\n" + .'0: disabled', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'OpenApiResultModel', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'RequestId' => [ - 'description' => 'The ID of the request. You can troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + .'- true: The call was successful.'."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code. Valid values:'."\n" + ."\n" + .'- If the request is successful, the **ErrorCode** field is not returned.'."\n" + .'- If the request fails, the **ErrorCode** field is returned. For more information, see the **Error codes** section of this topic.', 'type' => 'string', 'example' => '1010040007', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified parameters are invalid.', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The processing result.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'AFBB799F-8578-51C5-A766-E922EDB8XXXX', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + 400 => [ + ['errorCode' => 'PARAMS.ERROR', 'errorMessage' => 'param error.', 'description' => ''], + ['errorCode' => 'DESENSSTATUS.ID.ERROR', 'errorMessage' => 'The desens status switch ID does not match or does not exist with the tenant.', 'description' => 'the desensitization switch id does not exist or does not belong to the tenant'], + ['errorCode' => 'DESENSSTATUS.PAGESIZE.ERROR', 'errorMessage' => 'Page size is too large, maximum of 100.', 'description' => 'Page size exceeded limit, up to 100.'], + ['errorCode' => 'DESENSSTATUS.SCENECODE.ERROR', 'errorMessage' => 'Scene code does not exist.', 'description' => 'Scene code does not exist.'], + ['errorCode' => 'DESENSSTATUS.SIZE.ERROR', 'errorMessage' => 'The number of desens status exceeds the limit.', 'description' => 'The number of desensitization switches exceeds the limit'], ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + 403 => [ + ['errorCode' => 'PERMISSION.DENIED.ERROR', 'errorMessage' => 'Permission denied', 'description' => 'Insufficient permissions.'], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], + ['errorCode' => 'UNKNOWN.ERROR', 'errorMessage' => 'unknown error.', 'description' => 'Unknown error.'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"0000-ABCD-EFG\\n200\\nInvalid.Tenant.ConnectionNotExists\\nThe connection does not exist.\\ntrue","errorExample":""}]', - 'title' => 'EstablishRelationTableToBusiness', - 'summary' => 'Imports a table to a workflow. The call to this API operation is equivalent to performing the following operations: Go to the DataStudio page, find the desired workflow, and then click the workflow name. Right-click Table under the desired folder and select Import Table.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'SubmitFile' => [ - 'methods' => [ - 'post', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'Update the status of data masking switches', + 'summary' => 'Update the status of data masking switches', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:DsgUpdateDesensStatusList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1010040007\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"AFBB799F-8578-51C5-A766-E922EDB8XXXX\\"\\n}","type":"json"}]', + ], + 'DsgUserGroupAddOrUpdate' => [ + 'summary' => 'Creates or updates a user group in Data Security Guard.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '78360', - 'abilityTreeNodes' => [ - 'FEATUREdide8FM783', - ], + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '219456', + 'abilityTreeNodes' => ['FEATUREdideRZM9W6'], ], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'formData', + 'name' => 'UserGroups', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID. You must configure either this parameter or the ProjectIdentifier parameter to determine the DataWorks workspace to which the operation is applied.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '10000', + 'description' => 'The user groups.', + 'type' => 'array', + 'items' => [ + 'description' => 'The user group.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the user group.'."\n" + ."\n" + .'- If you do not specify this parameter, a new user group is created.'."\n" + ."\n" + .'- If you specify this parameter, the specified user group is modified. You can call the [DsgUserGroupQueryList](~~2786441~~) operation to query the ID of the user group.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', 'title' => ''], + 'Name' => ['description' => 'The name of the user group.', 'type' => 'string', 'required' => true, 'example' => 'yun_group', 'title' => ''], + 'Owner' => ['description' => 'The owner of the user group.', 'type' => 'string', 'required' => true, 'example' => 'user1', 'title' => ''], + 'Accounts' => [ + 'description' => 'The users in the user group.'."\n" + ."\n" + .'- For user groups created based on Alibaba Cloud accounts and Resource Access Management (RAM) roles, call the [DsgUserGroupQueryUserList](~~2786445~~) API to query the user list.'."\n" + ."\n" + .'- For user groups created based on MaxCompute roles, call the [DsgUserGroupGetOdpsRoleGroups](~~2785695~~) API to query the user list.', + 'type' => 'array', + 'items' => ['description' => 'Enter a username or a MaxCompute Role. This parameter is set based on the value of the `UserGroupType` parameter.', 'type' => 'string', 'required' => false, 'example' => 'user1', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'ProjectName' => ['description' => 'The name of the MaxCompute project. Set this parameter when you create a MaxCompute user group.', 'type' => 'string', 'required' => false, 'example' => 'dev_project', 'title' => ''], + 'UserGroupType' => ['description' => 'The type of the user group. The following values are valid:'."\n" + ."\n" + .'- 1: Alibaba Cloud user'."\n" + ."\n" + .'- 2: RAM Role'."\n" + ."\n" + .'- 3: MaxCompute Role', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], + 'projects' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + 'required' => true, + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'ProjectIdentifier', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The name of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace page to obtain the workspace name. You must configure either this parameter or the ProjectId parameter to determine the DataWorks workspace to which the operation is applied.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dw_project', + 'title' => 'OpenApiResultModel', + 'description' => 'OpenApiResultModel', + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the request succeeded. Valid values:'."\n" + ."\n" + .'- `true`: The request succeeded.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code that is returned if the request fails.', 'type' => 'string', 'example' => '1029030003', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message that is returned if the request fails.', 'type' => 'string', 'example' => 'param error', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '400', 'title' => ''], + 'Data' => ['description' => 'The result of the operation. Valid values:'."\n" + ."\n" + .'- `true`: The operation succeeded.'."\n" + ."\n" + .'- `false`: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request. This is a common parameter. We recommend that you save this ID. If an issue occurs, you can use the ID to locate logs for troubleshooting.', 'type' => 'string', 'example' => '102400001', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'USERGROUP.ACCOUNTLISTSIZE.ERROR', 'errorMessage' => 'The number of account exceeds the limit.', 'description' => 'The number of users exceeds the limit'], + ['errorCode' => 'USERGROUP.ID.ERROR', 'errorMessage' => 'The user group ID does not match the tenant or does not exist.', 'description' => 'The user group ID does not exist or does not belong to the tenant.'], + ['errorCode' => 'USERGROUP.LISTSIZE.ERROR', 'errorMessage' => 'The number of user groups exceeds the limit.', 'description' => 'The number of user groups exceeds the limit'], + ['errorCode' => 'USERGROUP.PAGESIZE.ERROR', 'errorMessage' => 'Page size is too large, maximum of 100.', 'description' => 'Page size limit, up to 100'], + ['errorCode' => 'USERACCOUNT.OWNER.ERROR', 'errorMessage' => 'User list or owner user does not exist.', 'description' => 'User list or responsible user does not exist'], + ['errorCode' => 'PARAMS.ERROR', 'errorMessage' => 'param error.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'PERMISSION.DENIED.ERROR', 'errorMessage' => 'Permission denied', 'description' => 'Insufficient permissions.'], + ], + 500 => [ + ['errorCode' => 'UNKNOWN.ERROR', 'errorMessage' => 'unknown error.', 'description' => 'Unknown error.'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1029030003\\",\\n \\"ErrorMessage\\": \\"param error\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"102400001\\"\\n}","type":"json"}]', + 'title' => 'DsgUserGroupAddOrUpdate', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'FileId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The file ID. You can call the [ListFiles](~~173942~~) operation to query the file ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1000000', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:DsgUserGroupAddOrUpdate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'DsgUserGroupDelete' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'Comment', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The description of the commit operation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Submit a task for the first time', - ], + 'AK' => [], ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '219457', + 'abilityTreeNodes' => ['FEATUREdideRZM9W6'], + ], + 'parameters' => [ [ - 'name' => 'SkipAllDeployFileExtensions', - 'in' => 'formData', + 'name' => 'Ids', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'Specifies whether to skip the pre-publish check after the file is committed. Valid values:'."\n" - ."\n" - .'* false: indicates that the pre-publish check is not skipped. After the file is committed, the pre-publish check is automatically triggered. The file can be deployed only after the file passes the check.'."\n" - .'* true: indicates that the pre-publish check is skipped. After the file is submitted, the pre-publish check process is not triggered. You can directly deploy the file.'."\n", - 'type' => 'boolean', + 'description' => 'The information about the user group.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The user group ID. You can call the [DsgUserGroupQueryList](~~2786441~~) operation to query the user group ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123'], 'required' => false, - 'example' => 'false', - 'default' => 'false', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'title' => 'OpenApiResultModel', + 'description' => 'OpenApiResultModel'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The deployment package ID. The ID is used as the value of a specific request parameter when you call the [GetDeployment](~~173950~~) operation to query the details of the deployment operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3000001', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '1029030003'], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'param error'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '400'], + 'Data' => ['description' => 'The operation result. Valid values:'."\n" + ."\n" + .'* true: The user group is deleted.'."\n" + .'* false: The user group fails to be deleted.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'RequestId' => ['description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", 'type' => 'string', 'example' => '102400001'], ], ], ], ], 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + 400 => [ + ['errorCode' => 'USERGROUP.ACCOUNTLISTSIZE.ERROR', 'errorMessage' => 'The number of account exceeds the limit.', 'description' => 'The number of users exceeds the limit'], + ['errorCode' => 'USERGROUP.ID.ERROR', 'errorMessage' => 'The user group ID does not match the tenant or does not exist.', 'description' => 'The user group ID does not exist or does not belong to the tenant.'], + ['errorCode' => 'USERGROUP.LISTSIZE.ERROR', 'errorMessage' => 'The number of user groups exceeds the limit.', 'description' => 'The number of user groups exceeds the limit'], + ['errorCode' => 'USERGROUP.PAGESIZE.ERROR', 'errorMessage' => 'Page size is too large, maximum of 100.', 'description' => 'Page size limit, up to 100'], + ['errorCode' => 'USERACCOUNT.OWNER.ERROR', 'errorMessage' => 'User list or owner user does not exist.', 'description' => 'User list or responsible user does not exist'], + ['errorCode' => 'PARAMS.ERROR', 'errorMessage' => 'param error.', 'description' => ''], ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + 403 => [ + ['errorCode' => 'PERMISSION.DENIED.ERROR', 'errorMessage' => 'Permission denied', 'description' => 'Insufficient permissions.'], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], + ['errorCode' => 'UNKNOWN.ERROR', 'errorMessage' => 'unknown error.', 'description' => 'Unknown error.'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 3000001,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 3000001\\n 0000-ABCD-EFG****\\n The connection does not exist.\\n true\\n Invalid.Tenant.ConnectionNotExists\\n","errorExample":""}]', - 'title' => 'SubmitFile', - 'summary' => 'Commits a file to the development environment of the scheduling system to generate a task.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListBusiness' => [ - 'methods' => [ - 'post', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1029030003\\",\\n \\"ErrorMessage\\": \\"param error\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"102400001\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 1029030003\\n param error\\n 400\\n true\\n 102400001\\n","errorExample":""}]', + 'title' => 'DsgUserGroupDelete', + 'summary' => 'Deletes a user group configured in Data Security Guard.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:DsgUserGroupDelete', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DsgUserGroupGetOdpsRoleGroups' => [ + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '78297', - 'abilityTreeNodes' => [ - 'FEATUREdide8FM783', - ], + 'abilityTreeCode' => '220985', + 'abilityTreeNodes' => ['FEATUREdideRZM9W6'], ], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Management page to obtain the workspace ID. You must configure either this parameter or the ProjectIdentifier parameter to determine the DataWorks workspace to which the operation is applied.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '10000', - ], - ], - [ - 'name' => 'ProjectIdentifier', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Management page to obtain the workspace name. You must configure either this parameter or ProjectId parameter to determine the DataWorks workspace to which the operation is applied.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dw_project', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'minimum' => '1', - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '100', - 'minimum' => '0', - 'example' => '10', - ], - ], - [ - 'name' => 'Keyword', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The keyword that is used to perform a fuzzy match.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'my', - ], + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the MaxCompute project. You can call the [DsgPlatformQueryProjectsAndSchemaFromMeta](~~2786303~~) operation to query a list of MaxCompute projects.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test_project'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', + 'title' => 'OpenApiResultModel>', + 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'RequestId' => [ - 'description' => 'The ID of the request. You can use the ID to troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '1029030003'], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'param error'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '400'], 'Data' => [ - 'description' => 'The information about the workflows returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '13', - ], - 'Business' => [ - 'description' => 'The details of the workflow.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Owner' => [ - 'description' => 'The owner of the workflow.'."\n", - 'type' => 'string', - 'example' => '34824327****', - ], - 'Description' => [ - 'description' => 'The description of the workflow.'."\n", - 'type' => 'string', - 'example' => 'My first workflow'."\n", - ], - 'ProjectId' => [ - 'description' => 'The ID of the workspace to which the workflow belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000', - ], - 'BusinessId' => [ - 'description' => 'The ID of the workflow.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3000001', - ], - 'BusinessName' => [ - 'description' => 'The name of the workflow.'."\n", - 'type' => 'string', - 'example' => 'My first workflow'."\n", - ], - 'UseType' => [ - 'description' => 'The module to which the workflow belongs. Valid values: NORMAL and MANUAL_BIZ. The value NORMAL indicates that the workflow belongs to auto triggered workflows. The value MANUAL_BIZ indicates that the workflow belongs to manually triggered workflows.'."\n", - 'type' => 'string', - 'example' => 'NORMAL', - ], - ], - ], - ], - ], + 'description' => 'The data returned.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The name of the MaxCompute role.'."\n", 'type' => 'string', 'example' => 'test_role'], ], + 'RequestId' => ['description' => 'The request ID. You can use the ID to locate logs and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '102400001'], ], ], ], ], 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + 400 => [ + ['errorCode' => 'USERGROUP.ACCOUNTLISTSIZE.ERROR', 'errorMessage' => 'The number of account exceeds the limit.', 'description' => 'The number of users exceeds the limit'], + ['errorCode' => 'USERGROUP.ID.ERROR', 'errorMessage' => 'The user group ID does not match the tenant or does not exist.', 'description' => 'The user group ID does not exist or does not belong to the tenant.'], + ['errorCode' => 'USERGROUP.LISTSIZE.ERROR', 'errorMessage' => 'The number of user groups exceeds the limit.', 'description' => 'The number of user groups exceeds the limit'], + ['errorCode' => 'USERGROUP.PAGESIZE.ERROR', 'errorMessage' => 'Page size is too large, maximum of 100.', 'description' => 'Page size limit, up to 100'], + ['errorCode' => 'USERACCOUNT.OWNER.ERROR', 'errorMessage' => 'User list or owner user does not exist.', 'description' => 'User list or responsible user does not exist'], + ['errorCode' => 'PARAMS.ERROR', 'errorMessage' => 'param error.', 'description' => ''], ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + 403 => [ + ['errorCode' => 'PERMISSION.DENIED.ERROR', 'errorMessage' => 'Permission denied', 'description' => 'Insufficient permissions.'], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', + ['errorCode' => 'UNKNOWN.ERROR', 'errorMessage' => 'unknown error.', 'description' => 'Unknown error.'], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1029030003\\",\\n \\"ErrorMessage\\": \\"param error\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": [\\n \\"test_role\\"\\n ],\\n \\"RequestId\\": \\"102400001\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 1029030003\\n param error\\n 400\\n test_role\\n 102400001\\n","errorExample":""}]', + 'title' => 'DsgUserGroupGetOdpsRoleGroups', + 'summary' => 'Queries a list of MaxCompute roles that can be selected by the members of a user group when the user group is created or modified by the tenant in Data Security Guard.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:DsgUserGroupGetOdpsRoleGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 13,\\n \\"Business\\": [\\n {\\n \\"Owner\\": \\"34824327****\\",\\n \\"Description\\": \\"我的第一个业务流程\\",\\n \\"ProjectId\\": 10000,\\n \\"BusinessId\\": 3000001,\\n \\"BusinessName\\": \\"我的第一个业务流程\\",\\n \\"UseType\\": \\"NORMAL\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n The connection does not exist.\\n 0000-ABCD-EFG****\\n Invalid.Tenant.ConnectionNotExists\\n true\\n \\n 1\\n 10\\n 13\\n \\n 34824327****\\n 我的第一个业务流程\\n 10000\\n 3000001\\n 我的第一个业务流程\\n NORMAL\\n \\n \\n","errorExample":""}]', - 'title' => 'ListBusiness', - 'summary' => 'Queries a list of workflows.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'GetFileVersion' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DsgUserGroupQueryList' => [ + 'summary' => 'Call `DsgUserGroupQueryList` to query user groups in Data Security Guard (DSG).', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -15948,1401 +10712,1243 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '78247', - 'abilityTreeNodes' => [ - 'FEATUREdide8FM783', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '219454', + 'abilityTreeNodes' => ['FEATUREdideRZM9W6'], ], 'parameters' => [ [ - 'name' => 'FileId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the file. You can call the [ListFiles](~~173942~~) operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1000001', - ], + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The number of the page to return.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'title' => '', 'example' => '1'], ], [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The DataWorks workspace ID. You can click the Workspace Manage icon in the upper-right corner of the DataStudio page to go to the Workspace page and view the workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '10000', - ], + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'title' => '', 'example' => '10'], ], [ - 'name' => 'ProjectIdentifier', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The unique identifier of the DataWorks workspace. You can click the identifier in the upper-left corner of the DataStudio page to switch to another workspace.'."\n" - ."\n" - .'You must specify either this parameter or ProjectId to determine the DataWorks workspace to which the operation is applied.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dw_project', - ], + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'A keyword for the user group name. The service performs a fuzzy search to find matching user groups.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'yun_group'], ], [ - 'name' => 'FileVersion', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The file version whose details you want to query.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '2', - ], + 'name' => 'Owner', + 'in' => 'query', + 'schema' => ['description' => 'The owner of the user group.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'user1'], + ], + [ + 'name' => 'ProjectName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the MaxCompute project to query for user groups.', 'type' => 'string', 'required' => false, 'example' => 'dev_project', 'title' => ''], + ], + [ + 'name' => 'userGroupType', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The returned data.'."\n", + 'title' => 'OpenApiResultModel>', + 'description' => 'OpenApiResultModel\\', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'RequestId' => [ - 'description' => 'The ID of the request. You can troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The details of the file version.'."\n", + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '1029030003', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'param error', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '400', 'title' => ''], + 'PageData' => [ + 'description' => 'The paginated query results.', 'type' => 'object', 'properties' => [ - 'FileContent' => [ - 'description' => 'The file code.'."\n", - 'type' => 'string', - 'example' => 'SHOW TABLES;', - ], - 'IsCurrentProd' => [ - 'description' => 'Indicates whether the version is the latest version in the production environment.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Status' => [ - 'description' => 'The status of the file version. Valid values: COMMITTING, COMMITTED, CHECK_OK, PACKAGED, DEPLOYING, DEPLOYED, and CANCELLED. The value CHECK_OK is equivalent to the value COMMITTED.'."\n", - 'type' => 'string', - 'example' => 'COMMITTED', - ], - 'NodeContent' => [ - 'description' => 'The scheduling configurations of the node that corresponds to the file version.'."\n", - 'type' => 'string', - 'example' => '{"cycleType":0,"cronExpress":"00 05 00 * * ?"}', - ], - 'CommitUser' => [ - 'description' => 'The ID of the Alibaba Cloud account that is used to create the file version.'."\n", - 'type' => 'string', - 'example' => '7384234****', - ], - 'Comment' => [ - 'description' => 'The description of the file version.'."\n", - 'type' => 'string', - 'example' => 'Second version submission', - ], - 'FilePropertyContent' => [ - 'description' => 'The basic information about the file.'."\n", - 'type' => 'string', - 'example' => '{"fileName":"ods_user_info_d","fileType":10}', - ], - 'FileName' => [ - 'description' => 'The file name.'."\n", - 'type' => 'string', - 'example' => 'ods_user_info_d', - ], - 'UseType' => [ - 'description' => 'The functional module to which the file belongs. Valid values: NORMAL, MANUAL, MANUAL_BIZ, SKIP, ADHOCQUERY, and COMPONENT. The value NORMAL indicates DataStudio. The value MANUAL indicates a manually triggered node. The value MANUAL_BIZ indicates a manually triggered workflow. The value SKIP indicates a dry-run DataStudio node. The value ADHOCQUERY indicates an ad hoc query. The value COMPONENT indicates snippets.'."\n", - 'type' => 'string', - 'example' => 'NORMAL', - ], - 'ChangeType' => [ - 'description' => 'The change type of the file version. Valid values: CREATE, UPDATE, and DELETE.'."\n", - 'type' => 'string', - 'example' => 'UPDATE', - ], - 'FileVersion' => [ - 'description' => 'The file version.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'CommitTime' => [ - 'description' => 'The time when the version was generated. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1593881265000', - ], - 'NodeId' => [ - 'description' => 'The ID of the node that corresponds to the file version.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3000001', + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of user groups.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'Data' => [ + 'description' => 'A list of user groups.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of a user group.', + 'type' => 'object', + 'properties' => [ + 'Accounts' => [ + 'description' => 'A list of usernames in the user group.', + 'type' => 'array', + 'items' => ['description' => 'A username.', 'type' => 'string', 'example' => 'user1', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Id' => ['description' => 'The ID of the user group.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'GmtCreate' => ['description' => 'The time when the user group was created.', 'type' => 'string', 'example' => '2024-05-10 17:14:44', 'title' => ''], + 'GmtModified' => ['description' => 'The time when the user group was last modified.', 'type' => 'string', 'example' => '2024-05-10 17:14:44', 'title' => ''], + 'Name' => ['description' => 'The name of the user group.', 'type' => 'string', 'example' => 'test_group', 'title' => ''], + 'Owner' => ['description' => 'The owner of the user group.', 'type' => 'string', 'example' => 'user1', 'title' => ''], + 'mcAggregationInfo' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '{     "accounts": [         "role_project_scheduler"     ],     "gmtCreate": "2024-05-10 15:22:18",     "gmtModified": "2024-05-10 15:22:18",     "id": 1955,     "name": "dsg_fin_test-copy",     "owner": "UAT" }', + 'title' => '', ], ], + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '102400001', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + 400 => [ + ['errorCode' => 'PARAMS.ERROR', 'errorMessage' => 'param error.', 'description' => ''], + ['errorCode' => 'USERGROUP.ACCOUNTLISTSIZE.ERROR', 'errorMessage' => 'The number of account exceeds the limit.', 'description' => 'The number of users exceeds the limit'], + ['errorCode' => 'USERGROUP.ID.ERROR', 'errorMessage' => 'The user group ID does not match the tenant or does not exist.', 'description' => 'The user group ID does not exist or does not belong to the tenant.'], + ['errorCode' => 'USERGROUP.LISTSIZE.ERROR', 'errorMessage' => 'The number of user groups exceeds the limit.', 'description' => 'The number of user groups exceeds the limit'], + ['errorCode' => 'USERGROUP.PAGESIZE.ERROR', 'errorMessage' => 'Page size is too large, maximum of 100.', 'description' => 'Page size limit, up to 100'], + ['errorCode' => 'USERACCOUNT.OWNER.ERROR', 'errorMessage' => 'User list or owner user does not exist.', 'description' => 'User list or responsible user does not exist'], ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + 403 => [ + ['errorCode' => 'PERMISSION.DENIED.ERROR', 'errorMessage' => 'Permission denied', 'description' => 'Insufficient permissions.'], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], + ['errorCode' => 'UNKNOWN.ERROR', 'errorMessage' => 'unknown error.', 'description' => 'Unknown error.'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"FileContent\\": \\"SHOW TABLES;\\",\\n \\"IsCurrentProd\\": true,\\n \\"Status\\": \\"COMMITTED\\",\\n \\"NodeContent\\": \\"{\\\\\\"cycleType\\\\\\":0,\\\\\\"cronExpress\\\\\\":\\\\\\"00 05 00 * * ?\\\\\\"}\\",\\n \\"CommitUser\\": \\"7384234****\\",\\n \\"Comment\\": \\"Second version submission\\",\\n \\"FilePropertyContent\\": \\"{\\\\\\"fileName\\\\\\":\\\\\\"ods_user_info_d\\\\\\",\\\\\\"fileType\\\\\\":10}\\",\\n \\"FileName\\": \\"ods_user_info_d\\",\\n \\"UseType\\": \\"0\\",\\n \\"ChangeType\\": \\"UPDATE\\",\\n \\"FileVersion\\": 2,\\n \\"CommitTime\\": 1593881265000,\\n \\"NodeId\\": 3000001\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n The connection does not exist.\\n 0000-ABCD-EFG****\\n Invalid.Tenant.ConnectionNotExists\\n true\\n \\n SHOW TABLES;\\n true\\n COMMITTED\\n {\\"cycleType\\":0,\\"cronExpress\\":\\"00 05 00 * * ?\\"}\\n 7384234****\\n 第二次版本提交\\n {\\"fileName\\":\\"ods_user_info_d\\",\\"fileType\\":10}\\n ods_user_info_d\\n 0\\n UPDATE\\n 2\\n 1593881265000\\n 3000001\\n \\n","errorExample":""}]', - 'title' => 'GetFileVersion', - 'summary' => 'Queries the information about a file version.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DeleteFolder' => [ - 'methods' => [ - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1029030003\\",\\n \\"ErrorMessage\\": \\"param error\\",\\n \\"HttpStatusCode\\": 400,\\n \\"PageData\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Data\\": [\\n {\\n \\"Accounts\\": [\\n \\"user1\\"\\n ],\\n \\"Id\\": 123,\\n \\"GmtCreate\\": \\"2024-05-10 17:14:44\\",\\n \\"GmtModified\\": \\"2024-05-10 17:14:44\\",\\n \\"Name\\": \\"test_group\\",\\n \\"Owner\\": \\"user1\\",\\n \\"mcAggregationInfo\\": \\"\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"102400001\\"\\n}","type":"json"}]', + 'title' => 'DsgUserGroupQueryList', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:DsgUserGroupQueryList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'DsgUserGroupQueryUserList' => [ + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '78209', - 'abilityTreeNodes' => [ - 'FEATUREdide8FM783', - ], + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '219455', + 'abilityTreeNodes' => ['FEATUREdideRZM9W6'], ], - 'parameters' => [ - [ - 'name' => 'ProjectId', - 'in' => 'formData', + 'parameters' => [], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '10000', + 'title' => 'OpenApiResultModel>', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '1029030003', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'param error', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '400', 'title' => ''], + 'Data' => [ + 'description' => 'The returned result.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'AccountName' => ['description' => 'The name of the user.'."\n", 'type' => 'string', 'example' => 'user1', 'title' => ''], + 'YunAccount' => ['description' => 'The name of the Alibaba Cloud account or RAM role. The return value of this parameter must be used if the user group is created by using an Alibaba Cloud account or a RAM role.'."\n", 'type' => 'string', 'example' => 'user:user1', 'title' => ''], + 'AccountType' => ['description' => 'The type of the user. Valid values:'."\n" + ."\n" + .'* 1 to 5: Alibaba Cloud account'."\n" + .'* 6: RAM role'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'BaseId' => ['description' => 'The user ID or role ID.'."\n", 'type' => 'string', 'example' => '234', 'title' => ''], + 'ParentAccountId' => ['description' => 'The parent user ID. This parameter is required if a RAM user is used.'."\n", 'type' => 'string', 'example' => '123', 'title' => ''], + ], + 'title' => '', + ], + 'title' => '', + ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '102400001', 'title' => ''], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'USERGROUP.ACCOUNTLISTSIZE.ERROR', 'errorMessage' => 'The number of account exceeds the limit.', 'description' => 'The number of users exceeds the limit'], + ['errorCode' => 'USERGROUP.ID.ERROR', 'errorMessage' => 'The user group ID does not match the tenant or does not exist.', 'description' => 'The user group ID does not exist or does not belong to the tenant.'], + ['errorCode' => 'USERGROUP.LISTSIZE.ERROR', 'errorMessage' => 'The number of user groups exceeds the limit.', 'description' => 'The number of user groups exceeds the limit'], + ['errorCode' => 'USERGROUP.PAGESIZE.ERROR', 'errorMessage' => 'Page size is too large, maximum of 100.', 'description' => 'Page size limit, up to 100'], + ['errorCode' => 'USERACCOUNT.OWNER.ERROR', 'errorMessage' => 'User list or owner user does not exist.', 'description' => 'User list or responsible user does not exist'], + ['errorCode' => 'PARAMS.ERROR', 'errorMessage' => 'param error.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'PERMISSION.DENIED.ERROR', 'errorMessage' => 'Permission denied', 'description' => 'Insufficient permissions.'], + ], + 500 => [ + ['errorCode' => 'UNKNOWN.ERROR', 'errorMessage' => 'unknown error.', 'description' => 'Unknown error.'], + ], + ], + 'title' => 'DsgUserGroupQueryUserList', + 'summary' => 'Queries a list of users or roles of the current tenant.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'ProjectIdentifier', - 'in' => 'formData', - 'schema' => [ - 'description' => 'http://100.67.165.184/business/api/folders/delete', - 'type' => 'string', - 'required' => false, - 'example' => 'dw_project', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:DsgUserGroupQueryUserList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1029030003\\",\\n \\"ErrorMessage\\": \\"param error\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": [\\n {\\n \\"AccountName\\": \\"user1\\",\\n \\"YunAccount\\": \\"user:user1\\",\\n \\"AccountType\\": 2,\\n \\"BaseId\\": \\"234\\",\\n \\"ParentAccountId\\": \\"123\\"\\n }\\n ],\\n \\"RequestId\\": \\"102400001\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 1029030003\\n param error\\n 400\\n \\n user1\\n user:user1\\n 2\\n 234\\n 123\\n \\n 102400001\\n","errorExample":""}]', + ], + 'DsgWhiteListAddOrUpdate' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'FolderId', - 'in' => 'formData', + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '219461', + 'abilityTreeNodes' => ['FEATUREdideRZM9W6'], + ], + 'parameters' => [ + [ + 'name' => 'WhiteLists', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'DeleteFolder', - 'type' => 'string', + 'description' => 'A collection of whitelists.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RuleId' => ['description' => 'The ID of the data masking rule. You can call the [DsgDesensPlanQueryList](~~2786578~~) operation to query the ID of the data masking rule.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '123'], + 'Id' => ['description' => 'The ID of the data masking whitelist.'."\n" + ."\n" + .'* If you do not configure this parameter, the current operation is to add a data masking whitelist.'."\n" + .'* If you configure this parameter, the current operation is to modify a data masking whitelist. You can call the [DsgWhiteListQueryList](~~2786508~~) operation to query the whitelist ID.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '123'], + 'StartTime' => ['description' => 'The beginning of the time range to query.'."\n", 'type' => 'string', 'required' => true, 'example' => '2024-04-10 00:00:00'], + 'EndTime' => ['description' => 'The end of the time range to query. If you enter null, the whitelist is valid permanently.'."\n", 'type' => 'string', 'required' => false, 'example' => 'null'], + 'UserGroupIds' => [ + 'description' => 'A collection of user group IDs.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The user group ID. You can call the [DsgUserGroupQueryList](~~2786441~~) operation to query the user group ID.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '123'], + 'required' => true, + ], + ], + 'required' => false, + ], 'required' => true, - 'docRequired' => true, - 'example' => '2eb6f9****', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'OpenApiResultModel', + 'description' => 'The returned results.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'ErrorCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '1029030003'], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'param error'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '400'], + 'Data' => ['description' => 'The operation result. Valid values:'."\n" + ."\n" + .'* true: The operation is successful.'."\n" + .'* false: The operation fails.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'RequestId' => ['description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", 'type' => 'string', 'example' => '102400001'], ], ], ], ], 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + 400 => [ + ['errorCode' => 'WHITELIST.DESENSID.ERROR', 'errorMessage' => 'The desensitization rule ID does not match or does not exist with the tenant.', 'description' => 'The scenario ID does not exist or does not belong to the tenant.'], + ['errorCode' => 'WHITELIST.ENDTIME.ERROR', 'errorMessage' => 'end time cannot be earlier than start time.', 'description' => 'The end time cannot be earlier than the start time.'], + ['errorCode' => 'WHITELIST.ID.ERROR', 'errorMessage' => 'The whitelist ID does not match or does not exist with the tenant.', 'description' => 'The whitelist ID does not exist or does not belong to the tenant.'], + ['errorCode' => 'WHITELIST.MCPROJECT.ERROR', 'errorMessage' => 'The projectName on the bottom layer desensitization whitelist of MC cannot be empty.', 'description' => 'ProjectName cannot be empty when creating MC desensitization whitelist'], + ['errorCode' => 'WHITELIST.PAGESIZE.ERROR', 'errorMessage' => 'Page size is too large, maximum of 100.', 'description' => 'Page size exceeded, cannot exceed 100'], + ['errorCode' => 'WHITELIST.SIZE.ERROR', 'errorMessage' => 'The number of white list exceeds the limit.', 'description' => 'Whitelist quantity exceeded'], + ['errorCode' => 'WHITELIST.STARTTIME.ERROR', 'errorMessage' => 'start time cannot be earlier than today.', 'description' => 'Start time cannot be earlier than today'], + ['errorCode' => 'WHITELIST.TIMEFORMAT.ERROR', 'errorMessage' => 'The time format is incorrect, please use yyyy MM dd HH: mm: ss format.', 'description' => 'The time parameter is formatted incorrectly. You need to use yyyy MM dd HH: mm: ss.'], + ['errorCode' => 'WHITELIST.USERGROUP.ERROR', 'errorMessage' => 'The user group ID does not match or does not exist with the tenant.', 'description' => 'The user group ID does not exist or does not belong to the tenant.'], + ['errorCode' => 'WHITELIST.USERGROUPEMPTY.ERROR', 'errorMessage' => 'User group ID cannot be empty.', 'description' => 'User group ID cannot be empty'], + ['errorCode' => 'WHITELIST.USERGROUPLISTSIZE.ERROR', 'errorMessage' => 'The number of user group exceeds the limit.', 'description' => 'The number of user groups exceeds the limit.'], + ['errorCode' => 'PARAMS.ERROR', 'errorMessage' => 'param error.', 'description' => ''], ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + 403 => [ + ['errorCode' => 'PERMISSION.DENIED.ERROR', 'errorMessage' => 'Permission denied', 'description' => 'Insufficient permissions.'], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], + ['errorCode' => 'UNKNOWN.ERROR', 'errorMessage' => 'unknown error.', 'description' => 'Unknown error.'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"0000-ABCD-EFG****\\n200\\nInvalid.Tenant.ConnectionNotExists\\nThe connection does not exist.\\ntrue","errorExample":""}]', - 'title' => 'DeleteFolder', - 'summary' => 'Deletes a folder from DataStudio.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DeleteFile' => [ - 'methods' => [ - 'post', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1029030003\\",\\n \\"ErrorMessage\\": \\"param error\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"102400001\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 1029030003\\n param error\\n 400\\n true\\n 102400001\\n","errorExample":""}]', + 'title' => 'DsgWhiteListAddOrUpdate', + 'summary' => 'Adds or modifies a data masking whitelist.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:DsgWhiteListAddOrUpdate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DsgWhiteListDeleteList' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '78208', - 'abilityTreeNodes' => [ - 'FEATUREdide8FM783', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '219462', + 'abilityTreeNodes' => ['FEATUREdideRZM9W6'], ], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace Management page to view the workspace name.'."\n" - ."\n" - .'You must specify one of the ProjectId and ProjectIdentifier parameters to determine the DataWorks workspace to which the operation is applied.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '10000', - ], - ], - [ - 'name' => 'ProjectIdentifier', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the file. You can call the [ListFiles](~~173942~~) operation to query the ID of the file.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dw_project', - ], - ], - [ - 'name' => 'FileId', - 'in' => 'formData', + 'name' => 'Ids', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The file ID. You can call the [ListFiles](~~173942~~) operation to query the file ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The IDs of the whitelists.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The whitelist ID. You can call the [DsgWhiteListQueryList](~~2786508~~) operation to obtain the whitelist ID.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '123'], 'required' => true, - 'docRequired' => true, - 'example' => '10000001', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', + 'title' => 'OpenApiResultModel', + 'description' => 'OpenApiResultModel'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The ID of the deployment task that deploys the file. If the file has been committed, an asynchronous process is triggered to delete the file in the scheduling system. The value of this parameter is used to call the GetDeployment operation to poll the status of the asynchronous process.'."\n" - ."\n" - .'If this parameter is empty, the file is deleted and the polling is not required.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'DeploymentId' => [ - 'description' => 'The ID of the request. You can troubleshoot errors based on the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000000001', - ], - 'RequestId' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'ErrorMessage' => [ - 'description' => 'Indicates whether the request is successful. Valid values:'."\n" - ."\n" - .'* true: The request is successful.'."\n" - .'* false: The request fails.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'Success' => [ - 'description' => 'The error code returned.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The ID of the file. You can use the ListFiles interface to query the ID of the corresponding file.', - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '1029030003'], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'param error'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '400'], + 'Data' => ['description' => 'The operation result. Valid values:'."\n" + ."\n" + .'* true: The operation is successful.'."\n" + .'* false: The operation failed.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'RequestId' => ['description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", 'type' => 'string', 'example' => '102400001'], ], ], ], ], 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + 400 => [ + ['errorCode' => 'WHITELIST.DESENSID.ERROR', 'errorMessage' => 'The desensitization rule ID does not match or does not exist with the tenant.', 'description' => 'The scenario ID does not exist or does not belong to the tenant.'], + ['errorCode' => 'WHITELIST.ENDTIME.ERROR', 'errorMessage' => 'end time cannot be earlier than start time.', 'description' => 'The end time cannot be earlier than the start time.'], + ['errorCode' => 'WHITELIST.ID.ERROR', 'errorMessage' => 'The whitelist ID does not match or does not exist with the tenant.', 'description' => 'The whitelist ID does not exist or does not belong to the tenant.'], + ['errorCode' => 'WHITELIST.MCPROJECT.ERROR', 'errorMessage' => 'The projectName on the bottom layer desensitization whitelist of MC cannot be empty.', 'description' => 'ProjectName cannot be empty when creating MC desensitization whitelist'], + ['errorCode' => 'WHITELIST.PAGESIZE.ERROR', 'errorMessage' => 'Page size is too large, maximum of 100.', 'description' => 'Page size exceeded, cannot exceed 100'], + ['errorCode' => 'WHITELIST.SIZE.ERROR', 'errorMessage' => 'The number of white list exceeds the limit.', 'description' => 'Whitelist quantity exceeded'], + ['errorCode' => 'WHITELIST.STARTTIME.ERROR', 'errorMessage' => 'start time cannot be earlier than today.', 'description' => 'Start time cannot be earlier than today'], + ['errorCode' => 'WHITELIST.TIMEFORMAT.ERROR', 'errorMessage' => 'The time format is incorrect, please use yyyy MM dd HH: mm: ss format.', 'description' => 'The time parameter is formatted incorrectly. You need to use yyyy MM dd HH: mm: ss.'], + ['errorCode' => 'WHITELIST.USERGROUP.ERROR', 'errorMessage' => 'The user group ID does not match or does not exist with the tenant.', 'description' => 'The user group ID does not exist or does not belong to the tenant.'], + ['errorCode' => 'WHITELIST.USERGROUPEMPTY.ERROR', 'errorMessage' => 'User group ID cannot be empty.', 'description' => 'User group ID cannot be empty'], + ['errorCode' => 'WHITELIST.USERGROUPLISTSIZE.ERROR', 'errorMessage' => 'The number of user group exceeds the limit.', 'description' => 'The number of user groups exceeds the limit.'], + ['errorCode' => 'PARAMS.ERROR', 'errorMessage' => 'param error.', 'description' => ''], ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + 403 => [ + ['errorCode' => 'PERMISSION.DENIED.ERROR', 'errorMessage' => 'Permission denied', 'description' => 'Insufficient permissions.'], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], + ['errorCode' => 'UNKNOWN.ERROR', 'errorMessage' => 'unknown error.', 'description' => 'Unknown error.'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"DeploymentId\\": 1000000001,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 1000000001\\n 0000-ABCD-EFG****\\n The connection does not exist.\\n true\\n Invalid.Tenant.ConnectionNotExists\\n","errorExample":""}]', - 'title' => 'DeleteFile', - 'summary' => 'Deletes a file from DataStudio. If the file has been committed, an asynchronous process is triggered to delete the file in the scheduling system. The value of the DeploymentId parameter returned is used to call the GetDeployment operation to poll the status of the asynchronous process.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'GetDeployment' => [ - 'methods' => [ - 'post', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1029030003\\",\\n \\"ErrorMessage\\": \\"param error\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"102400001\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 1029030003\\n param error\\n 400\\n true\\n 102400001\\n","errorExample":""}]', + 'title' => 'DsgWhiteListDeleteList', + 'summary' => 'Deletes a data masking whitelist configured in Data Security Guard.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:DsgWhiteListDeleteList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'DsgWhiteListQueryList' => [ + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '78242', - 'abilityTreeNodes' => [ - 'FEATUREdide8FM783', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '219250', + 'abilityTreeNodes' => ['FEATUREdideRZM9W6'], ], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the DataWorks workspace. You can click the Workspace Manage icon in the upper-right corner of the DataStudio page to go to the Workspace Management page and view the workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '10000', - ], + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1'], ], [ - 'name' => 'ProjectIdentifier', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The GUID of the DataWorks workspace. You can view the GUID in the upper part of the DataStudio page. You can also select another GUID to switch to another workspace.'."\n" - ."\n" - .'You must specify either this parameter or the ProjectId parameter to determine the DataWorks workspace to which the operation is applied.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dw_project', - ], + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The number of entries per page. Maximum value: 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10'], ], [ - 'name' => 'DeploymentId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the deployment task. A deployment task ID is generated when you call the [SubmitFile](~~173944~~) or [DeployFile](~~173956~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '3000001', - ], + 'name' => 'SceneId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the level-2 data masking scenario. You can call the [DsgSceneQuerySceneListByName](~~2786322~~) operation to query the list of IDs.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123'], + ], + [ + 'name' => 'DataType', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The keyword of the sensitive field type.'."\n", 'type' => 'string', 'required' => false, 'example' => 'phone'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The returned data.'."\n", + 'title' => 'OpenApiResultModel>', + 'description' => 'OpenApiResultModel\\'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'RequestId' => [ - 'description' => 'The ID of the request. You can troubleshoot errors based on the ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned.', - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The details of the deployment package.'."\n", + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '1029030003'], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'param error'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '400'], + 'PageData' => [ + 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ - 'Deployment' => [ - 'description' => 'The details of the deployment package.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status of the deployment task. Valid values: 0, 1, and 2. A value of 0 indicates that the task is ready. A value of 1 indicates that the task was successful. A value of 2 indicates that the task failed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ErrorMessage' => [ - 'description' => 'The error message that was returned when the deployment package failed. In this case, the value of the Status parameter is 2.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'FromEnvironment' => [ - 'description' => 'The environment in which the deployment task was run. Valid values: 0 and 1. A value of 0 indicates the on-premises environment. A value of 1 indicates the development environment.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ToEnvironment' => [ - 'description' => 'The environment to which the file was deployed. Valid values: 1 and 2. A value of 1 indicates the development environment. A value of 2 indicates the production environment.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'CheckingStatus' => [ - 'description' => 'The check status of one or more files in the deployment task. If the value of the ToEnvironment parameter is 1, the files can be deployed to the production environment only when the value of the Status parameter is 1 and the CheckingStatus parameter is empty. Valid values:'."\n" - ."\n" - .'* 7: The file failed the check.'."\n" - .'* 8: The file is being checked.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - ], - 'CreateTime' => [ - 'description' => 'The time when the deployment task was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1593877765000', - ], - 'HandlerId' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the user who ran the deployment task.'."\n", - 'type' => 'string', - 'example' => '2003****', - ], - 'CreatorId' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the user who created the deployment task.'."\n", - 'type' => 'string', - 'example' => '20030****', - ], - 'ExecuteTime' => [ - 'description' => 'The time when the deployment task was run. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1593877765000', - ], - 'Name' => [ - 'description' => 'The name of the deployment task. The value is the same as the name of the specific deployment task that is displayed on the Release Package page in the Deploy module.'."\n", - 'type' => 'string', - 'example' => 'ods_user_info_d-2020-07-04_20030****', - ], - ], - ], - 'DeployedItems' => [ - 'description' => 'The deployed items.'."\n", + 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['description' => 'The total number of data masking whitelists.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'Data' => [ + 'description' => 'A collection of whitelists.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'The details of the deployed item.'."\n", + 'description' => '', 'type' => 'object', 'properties' => [ - 'FileId' => [ - 'description' => 'The file ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '507642378', - ], - 'FileVersion' => [ - 'description' => 'The version of the file.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '7', - ], - 'Status' => [ - 'description' => '- UNPUBLISHED(0): not published'."\n" - .'- SUCCESS(1): Published'."\n" - .'- ERROR(2): Publishing failed'."\n" - .'- CLONED(3): successfully CLONED'."\n" - .'- DEPLOY_ERROR(4): Publishing failed'."\n" - .'- CLONING(5): CLONING'."\n" - .'- REJECT(6): release rejected', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + 'Id' => ['description' => 'The ID of the data masking whitelist.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'Type' => ['description' => 'The sensitive field type.'."\n", 'type' => 'string', 'example' => 'phone'], + 'UserGroups' => [ + 'description' => 'A collection of user group names.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The name of the user group.'."\n", 'type' => 'string', 'example' => 'test_group'], ], + 'GmtCreate' => ['description' => 'The time when the whitelist was created.'."\n", 'type' => 'string', 'example' => '2024-05-09 15:46:20'], + 'GmtModified' => ['description' => 'The time when the whitelist was modified.'."\n", 'type' => 'string', 'example' => '2024-05-09 15:46:20'], + 'RuleId' => ['description' => 'The ID of the data masking rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'SceneId' => ['description' => 'The ID of the level-2 data masking scenario.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'StartTime' => ['description' => 'The time when the data masking whitelist takes effect cannot be earlier than the current time. Unit: days.'."\n", 'type' => 'string', 'example' => '2024-05-09 15:46:20'], + 'EndTime' => ['description' => 'The expiration time of the data masking whitelist cannot be earlier than the time when the data masking whitelist takes effect. Unit: days.'."\n", 'type' => 'string', 'example' => '2024-05-10 15:46:20'], ], ], ], ], ], + 'RequestId' => ['description' => 'The request ID. You can use the ID to locate logs and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '102400001'], ], ], ], ], 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + 400 => [ + ['errorCode' => 'WHITELIST.DESENSID.ERROR', 'errorMessage' => 'The desensitization rule ID does not match or does not exist with the tenant.', 'description' => 'The scenario ID does not exist or does not belong to the tenant.'], + ['errorCode' => 'WHITELIST.ENDTIME.ERROR', 'errorMessage' => 'end time cannot be earlier than start time.', 'description' => 'The end time cannot be earlier than the start time.'], + ['errorCode' => 'WHITELIST.ID.ERROR', 'errorMessage' => 'The whitelist ID does not match or does not exist with the tenant.', 'description' => 'The whitelist ID does not exist or does not belong to the tenant.'], + ['errorCode' => 'WHITELIST.MCPROJECT.ERROR', 'errorMessage' => 'The projectName on the bottom layer desensitization whitelist of MC cannot be empty.', 'description' => 'ProjectName cannot be empty when creating MC desensitization whitelist'], + ['errorCode' => 'WHITELIST.PAGESIZE.ERROR', 'errorMessage' => 'Page size is too large, maximum of 100.', 'description' => 'Page size exceeded, cannot exceed 100'], + ['errorCode' => 'WHITELIST.SIZE.ERROR', 'errorMessage' => 'The number of white list exceeds the limit.', 'description' => 'Whitelist quantity exceeded'], + ['errorCode' => 'WHITELIST.STARTTIME.ERROR', 'errorMessage' => 'start time cannot be earlier than today.', 'description' => 'Start time cannot be earlier than today'], + ['errorCode' => 'WHITELIST.TIMEFORMAT.ERROR', 'errorMessage' => 'The time format is incorrect, please use yyyy MM dd HH: mm: ss format.', 'description' => 'The time parameter is formatted incorrectly. You need to use yyyy MM dd HH: mm: ss.'], + ['errorCode' => 'WHITELIST.USERGROUP.ERROR', 'errorMessage' => 'The user group ID does not match or does not exist with the tenant.', 'description' => 'The user group ID does not exist or does not belong to the tenant.'], + ['errorCode' => 'WHITELIST.USERGROUPEMPTY.ERROR', 'errorMessage' => 'User group ID cannot be empty.', 'description' => 'User group ID cannot be empty'], + ['errorCode' => 'WHITELIST.USERGROUPLISTSIZE.ERROR', 'errorMessage' => 'The number of user group exceeds the limit.', 'description' => 'The number of user groups exceeds the limit.'], + ['errorCode' => 'PARAMS.ERROR', 'errorMessage' => 'param error.', 'description' => ''], ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + 403 => [ + ['errorCode' => 'PERMISSION.DENIED.ERROR', 'errorMessage' => 'Permission denied', 'description' => 'Insufficient permissions.'], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], + ['errorCode' => 'UNKNOWN.ERROR', 'errorMessage' => 'unknown error.', 'description' => 'Unknown error.'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Deployment\\": {\\n \\"Status\\": 1,\\n \\"ErrorMessage\\": \\"Success\\",\\n \\"FromEnvironment\\": 0,\\n \\"ToEnvironment\\": 1,\\n \\"CheckingStatus\\": 7,\\n \\"CreateTime\\": 1593877765000,\\n \\"HandlerId\\": \\"2003****\\",\\n \\"CreatorId\\": \\"20030****\\",\\n \\"ExecuteTime\\": 1593877765000,\\n \\"Name\\": \\"ods_user_info_d-2020-07-04_20030****\\"\\n },\\n \\"DeployedItems\\": [\\n {\\n \\"FileId\\": 0,\\n \\"FileVersion\\": 7,\\n \\"Status\\": 1\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n The connection does not exist.\\n 0000-ABCD-EFG****\\n Invalid.Tenant.ConnectionNotExists\\n true\\n \\n \\n 1\\n 成功\\n 0\\n 1\\n 7\\n 1593877765000\\n 2003****\\n 20030****\\n 1593877765000\\n ods_user_info_d-2020-07-04_20030****\\n \\n \\n 507642378\\n 7\\n 1\\n \\n \\n","errorExample":""}]', - 'title' => 'GetDeployment', - 'summary' => 'Queries the information about a deployment package.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'UpdateFile' => [ - 'methods' => [ - 'post', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1029030003\\",\\n \\"ErrorMessage\\": \\"param error\\",\\n \\"HttpStatusCode\\": 400,\\n \\"PageData\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Data\\": [\\n {\\n \\"Id\\": 123,\\n \\"Type\\": \\"phone\\",\\n \\"UserGroups\\": [\\n \\"test_group\\"\\n ],\\n \\"GmtCreate\\": \\"2024-05-09 15:46:20\\",\\n \\"GmtModified\\": \\"2024-05-09 15:46:20\\",\\n \\"RuleId\\": 123,\\n \\"SceneId\\": 123,\\n \\"StartTime\\": \\"2024-05-09 15:46:20\\",\\n \\"EndTime\\": \\"2024-05-10 15:46:20\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"102400001\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 1029030003\\n param error\\n 400\\n \\n 1\\n 10\\n 100\\n \\n 123\\n phone\\n test_group\\n 2024-05-09 15:46:20\\n 2024-05-09 15:46:20\\n 123\\n 123\\n 2024-05-09 15:46:20\\n 2024-05-10 15:46:20\\n \\n \\n 102400001\\n","errorExample":""}]', + 'title' => 'DsgWhiteListQueryList', + 'summary' => 'Queries a data masking whitelist.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:DsgWhiteListQueryList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'EditRecognizeRule' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'abilityTreeCode' => '78372', - 'abilityTreeNodes' => [ - 'FEATUREdide8FM783', - ], + 'abilityTreeCode' => '212267', + 'abilityTreeNodes' => ['FEATUREdideDCM5VK'], ], 'parameters' => [ [ - 'name' => 'FileFolderPath', + 'name' => 'TenantId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The path of the file.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'Business_process/First_Business_Process/data_integration/Folder_1/Folder_2', - ], + 'schema' => ['description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n", 'type' => 'string', 'required' => true, 'example' => '10241024'], ], [ - 'name' => 'ProjectId', + 'name' => 'AccountName', 'in' => 'formData', - 'schema' => [ - 'description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '10000', - ], + 'schema' => ['description' => 'The Alibaba Cloud account that is used to create the sensitive data identification rule. Enter the username of the Alibaba Cloud account.'."\n", 'type' => 'string', 'required' => true, 'example' => 'dsg-uat'], ], [ - 'name' => 'FileName', + 'name' => 'SensitiveId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the file. You can set the FileName parameter to a new value to change the file name.'."\n" - ."\n" - .'You can call the [ListFiles](~~173942~~) operation to query the ID of the file whose name you want to change. Then, you can set the FileId parameter to the ID and set the FileName parameter to a new value when you call the [UpdateFile](~~173951~~) operation.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'ods_user_info_d', - ], + 'schema' => ['description' => 'The sensitive field ID. You can call the [QuerySensNodeInfo](~~2747189~~) operation to query the IDs of all sensitive fields. You can also call the [QueryRecognizeRuleDetail](~~2766023~~) operation to query the IDs of specific sensitive fields.'."\n", 'type' => 'string', 'required' => true, 'example' => '1a928de7-3962-4e07-93ac-e1973baa1024'], ], [ - 'name' => 'FileDescription', + 'name' => 'SensitiveName', 'in' => 'formData', - 'schema' => [ - 'description' => 'The description of the file.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'Here is the file description', - 'maxLength' => 200, - ], + 'schema' => ['description' => 'The name of the custom sensitive field. Enter a string that is less than 128 characters in length.'."\n", 'type' => 'string', 'required' => true, 'example' => 'name'."\n"], ], [ - 'name' => 'Content', + 'name' => 'NodeId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The code of the file. The code format varies based on the file type. To view the code format for a specific file type, go to Operation Center, right-click a node of the file type, and then select View Code.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SELECT "1";', - ], + 'schema' => ['description' => 'The ID of the data category. You can call the [QuerySensClassification](~~2746850~~) operation to query the ID of all data categories. Then, you can select a data category to create a sensitive field. Enter the ID of the selected data category.'."\n", 'type' => 'string', 'required' => true, 'example' => '0ce67949-0810-400f-a24a-cc5ffafe1024'], ], [ - 'name' => 'AutoRerunTimes', + 'name' => 'NodeParent', 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of automatic reruns that are allowed after an error occurs.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'example' => '3', - ], + 'schema' => ['description' => 'The information about the parent data category of the current data category. You can call the [QuerySensClassification](~~2746850~~) operation to obtain the ID of a data category.'."\n", 'type' => 'string', 'required' => true, 'example' => 'Customer/personal/personal_Natural_Information/personal_basic_profile_information'], ], [ - 'name' => 'AutoRerunIntervalMillis', + 'name' => 'TemplateId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The interval between two consecutive automatic reruns after an error occurs. Unit: milliseconds. Maximum value: 1800000 (30 minutes).'."\n" - ."\n" - .'This parameter corresponds to the Rerun Interval parameter that is displayed after the Auto Rerun upon Error check box is selected in the Schedule section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n" - ."\n" - .'The interval that you specify in the DataWorks console is measured in minutes. Pay attention to the conversion between the units of time when you call the operation.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '120000', - ], + 'schema' => ['description' => 'The template ID. You can call the [QueryDefaultTemplate](~~2743948~~) operation to obtain the template ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'e1970541-6cf5-4d23-b101-d5b66f6e1024'], ], [ - 'name' => 'RerunMode', + 'name' => 'level', 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether the node that corresponds to the file can be rerun. Valid values:'."\n" - ."\n" - .'* ALL_ALLOWED: The node can be rerun regardless of whether it is successfully run or fails to run.'."\n" - .'* FAILURE_ALLOWED: The node can be rerun only after it fails to run.'."\n" - .'* ALL_DENIED: The node cannot be rerun regardless of whether it is successfully run or fails to run.'."\n" - ."\n" - .'This parameter corresponds to the Rerun parameter in the Schedule section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* ALL_ALLOWD'."\n" - .'* FAILURE_ALLOWED'."\n" - .'* ALL_DENIED'."\n" - .'* ALL_ALLOWED'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ALL_ALLOWED', - 'enum' => [ - 'ALL_ALLOWD', - 'FAILURE_ALLOWED', - 'ALL_DENIED', - 'ALL_ALLOWED', - ], - ], + 'schema' => ['description' => 'The sensitivity level of the sensitive field. You can select one from all sensitivity levels that are defined in a template as the sensitivity level of the sensitive field, such as level 1 to level 10.'."\n", 'type' => 'string', 'required' => true, 'example' => '1'], ], [ - 'name' => 'Stop', + 'name' => 'LevelName', 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether to suspend the scheduling of the node. Valid values:'."\n" - ."\n" - .'* true: suspends the scheduling of the node.'."\n" - .'* false: does not suspend the scheduling of the node.'."\n" - ."\n" - .'This parameter corresponds to the Recurrence parameter in the Schedule section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The name of the sensitivity level. You can call the [QueryDefaultTemplate](~~2743948~~) operation to obtain the name of the sensitivity level in the related template.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Confidential'], ], [ - 'name' => 'ParaValue', + 'name' => 'SensitiveDescription', 'in' => 'formData', - 'schema' => [ - 'description' => 'The scheduling parameters of the node.'."\n" - ."\n" - .'This parameter corresponds to the Parameters section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console). For more information, see [Configure scheduling parameters](~~137548~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'x=a y=b z=c', - ], + 'schema' => ['description' => 'The description of the sensitive field. Enter a string that is less than 128 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'This is a sensitive field that identifies the name.'], ], [ - 'name' => 'StartEffectDate', + 'name' => 'Status', 'in' => 'formData', - 'schema' => [ - 'description' => 'The start time of automatic scheduling. Set this parameter to a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n" - ."\n" - .'This parameter corresponds to the Validity Period parameter in the Schedule section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'minimum' => '0', - 'example' => '936923400000', - ], + 'schema' => ['description' => 'The status of the sensitive field. Valid values:'."\n" + ."\n" + .'* 0: draft'."\n" + .'* 1: effective'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], [ - 'name' => 'EndEffectDate', + 'name' => 'OperationType', 'in' => 'formData', - 'schema' => [ - 'description' => 'The end time of automatic scheduling. Set this parameter to a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n" - ."\n" - .'This parameter corresponds to the end time specified for the Validity Period parameter in the Schedule section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'minimum' => '0', - 'example' => '4155787800000', - ], + 'schema' => ['description' => 'The type of the arithmetic operation. Valid values:'."\n" + ."\n" + .'* 0: OR'."\n" + .'* 1: AND'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0'], ], [ - 'name' => 'CronExpress', + 'name' => 'RecognizeRulesType', 'in' => 'formData', - 'schema' => [ - 'description' => 'The CRON expression that represents the periodic scheduling policy of the node. This parameter corresponds to the Cron Expression parameter in the Schedule section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console). After you configure the Scheduling Cycle and Run At parameters in the DataWorks console, DataWorks automatically generates a value for the Cron Expression parameter.'."\n" - ."\n" - .'Examples:'."\n" - ."\n" - .'* CRON expression for a node that is scheduled to run at 05:30 every day: `00 30 05 * * ?`'."\n" - .'* CRON expression for a node that is scheduled to run at the fifteenth minute of each hour: `00 15 * * * ?`'."\n" - .'* CRON expression for a node that is scheduled to run every 10 minutes: `00 00/10 * * * ?`'."\n" - .'* CRON expression for a node that is scheduled to run every 10 minutes from 08:00 to 17:00 every day: `00 00-59/10 8-23 * * * ?`'."\n" - .'* CRON expression for a node that is scheduled to run at 00:20 on the first day of each month: `00 20 00 1 * ?`'."\n" - .'* CRON expression for a node that is scheduled to run every three months starting from 00:10 on January 1: `00 10 00 1 1-12/3 ?`'."\n" - .'* CRON expression for a node that is scheduled to run at 00:05 every Tuesday and Friday: `00 05 00 * * 2,5`'."\n" - ."\n" - .'The scheduling system of DataWorks imposes the following limits on CRON expressions:'."\n" - ."\n" - .'* A node can be scheduled to run at a minimum interval of 5 minutes.'."\n" - .'* A node can be scheduled to run at 00:05 every day at the earliest.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '00 00-59/5 1-23 * * ?', - ], + 'schema' => ['description' => 'The type of the sensitive data identification rule. Valid values:'."\n" + ."\n" + .'* 1: regular expression'."\n" + .'* 2: built-in rule'."\n" + .'* 3: sample library'."\n" + .'* 4: self-generated data identification model'."\n", 'type' => 'string', 'required' => false, 'example' => '1'], ], [ - 'name' => 'CycleType', + 'name' => 'RecognizeRules', 'in' => 'formData', - 'schema' => [ - 'description' => 'The type of the scheduling cycle of the node that corresponds to the file. Valid values: NOT_DAY and DAY. The value NOT_DAY indicates that the node is scheduled to run by minute or hour. The value DAY indicates that the node is scheduled to run by day, week, or month.'."\n" - ."\n" - .'This parameter corresponds to the Scheduling Cycle parameter in the Schedule section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'NOT_DAY', - 'default' => 'DAY', - 'enum' => [ - 'DAY', - 'NOT_DAY', - ], - ], + 'schema' => ['description' => 'The content of the sensitive data identification rule. You can call the [QuerySensNodeInfo](~~2747189~~) operation to query the value of the current parameter for a built-in sensitive field.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"contentRule":{"_clazz":"com.alipay.dsgclient.sdk.dsg.fastscan.engine.cond.GenderCond"},"_clazz":"com.alipay.dsg.dal.model.RuleContent"}'], ], [ - 'name' => 'DependentType', + 'name' => 'ContentScan', 'in' => 'formData', - 'schema' => [ - 'description' => 'The type of the cross-cycle scheduling dependency of the node. Valid values:'."\n" - ."\n" - .'* SELF: The instance generated for the node in the current cycle depends on the instance generated for the node in the previous cycle.'."\n" - .'* CHILD: The instance generated for the node in the current cycle depends on the instances generated for the descendant nodes at the nearest level of the node in the previous cycle.'."\n" - .'* USER_DEFINE: The instance generated for the node in the current cycle depends on the instances generated for one or more specified nodes in the previous cycle.'."\n" - .'* NONE: No cross-cycle scheduling dependency type is selected for the node.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'USER_DEFINE', - 'enum' => [ - 'NONE', - 'USER_DEFINE', - 'CHILD', - 'SELF', - 'USER_DEFINE_AND_SELF', - 'CHILD_AND_SELF', - ], - ], + 'schema' => ['description' => 'Identifies content. You can call the [QuerySensNodeInfo](~~2747189~~) operation to query the value of the current parameter for a built-in sensitive field.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"_clazz":"com.alipay.dsgclient.sdk.dsg.fastscan.engine.cond.NationalityCond"}'], ], [ - 'name' => 'DependentNodeIdList', + 'name' => 'ColScan', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the node on which the node corresponding to the file depends when the DependentType parameter is set to USER_DEFINE. Multiple IDs are separated by commas (,).'."\n" - ."\n" - .'The value of this parameter corresponds to the ID of the node that you specified after you select Previous Cycle and set Depend On to Other Nodes in the Dependencies section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5,10,15,20', - ], + 'schema' => ['description' => 'Scans fields. The system identifies only fields that are assigned with values.'."\n" + ."\n" + .'* The value must be in the ${Project name}.${Table name}.${Field name} or ${Project name}.${Schema name}.${Table name}.${Field name} format.'."\n" + .'* *Wildcards are supported. For example, the asterisk (\\*) in default.table.column1\\* can be used to match any content following default.table.column1, such as default.table.column10.'."\n", 'type' => 'string', 'required' => false, 'example' => 'default.qujian.*'], ], [ - 'name' => 'InputList', + 'name' => 'ColExclude', 'in' => 'formData', - 'schema' => [ - 'description' => 'The output name of the parent file on which the current file depends. If you specify multiple output names, separate them with commas (,).'."\n" - ."\n" - .'This parameter corresponds to the Parent Nodes parameter that is displayed after you select Same Cycle in the Dependencies section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n" - ."\n" - .'> You must configure this parameter when you call the CreateDISyncTask or UpdateFile operation to create a batch synchronization task.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'project_root,project.file1,project.001_out', - ], + 'schema' => ['description' => 'Excludes fields. The system does not identify fields that are assigned with values.'."\n" + ."\n" + .'* The value must be in the ${Project name}.${Table name}.${Field name} or ${Project name}.${Schema name}.${Table name}.${Field name} format.'."\n" + .'* *Wildcards are supported. For example, the asterisk (\\*) in default.table.column1\\* can be used to match any content following default.table.column1, such as default.table.column10.'."\n", 'type' => 'string', 'required' => false, 'example' => 'default.qujian.*6'], ], [ - 'name' => 'ProjectIdentifier', + 'name' => 'CommentScan', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace Management page to obtain the workspace name.'."\n" - ."\n" - .'You must configure this parameter or the ProjectId parameter to determine the DataWorks workspace to which the operation is applied.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dw_project', - ], + 'schema' => ['description' => 'Scans content. The value is the text of each field comment in your data asset. Fuzzy match is supported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test'], ], [ - 'name' => 'FileId', + 'name' => 'HitThreshold', 'in' => 'formData', + 'schema' => ['description' => 'The hit ratio threshold. If more than 60%, which is a sample hit ratio threshold, of all sample data records hit the Name Entity Recognition (NER) model, the sensitive field is hit. The value can be an integer from 0 to 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The ID of the file. You can call the [ListFiles](~~173942~~) operation to obtain the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '100000001', + 'title' => 'OpenApiResultModel', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '9990030003'], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'Missing parameter'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Data' => ['description' => 'The returned result in the JSON format.'."\n", 'type' => 'any', 'example' => '{ "HttpStatusCode": 200, "Success": true }'], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '10000001'], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'BADPARAMETERS', 'errorMessage' => 'Parameters are missing or in the wrong format.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"9990030003\\",\\n \\"ErrorMessage\\": \\"Missing parameter\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"{ \\\\\\"HttpStatusCode\\\\\\": 200, \\\\\\"Success\\\\\\": true }\\",\\n \\"RequestId\\": \\"10000001\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 9990030003\\n 缺少参数\\n 200\\n { \\"HttpStatusCode\\": 200, \\"Success\\": true }\\n 10000001\\n","errorExample":""}]', + 'title' => 'EditRecognizeRule', + 'summary' => 'Edits a sensitive field that is defined based on the category and sensitivity level of data in Data Security Guard.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'OutputList', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The output name of the current file.'."\n" - ."\n" - .'This parameter corresponds to the Output Name parameter in the Dependencies section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dw_project.ods_user_info_d', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:EditRecognizeRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'EstablishRelationTableToBusiness' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '78225', + 'abilityTreeNodes' => ['FEATUREdideEPPSOE'], + ], + 'parameters' => [ [ - 'name' => 'ResourceGroupIdentifier', + 'name' => 'ProjectId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The identifier of the resource group that is used to run the node. You can call the [ListResourceGroups](~~173913~~) operation to query the available resource groups in the workspace.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'default_group', - ], + 'schema' => ['description' => 'The ID of the DataWorks workspace. You can click the Workspace Manage icon in the upper-right corner of the DataStudio page to go to the Workspace Management page and view the workspace ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10000', 'title' => ''], ], [ - 'name' => 'ConnectionName', + 'name' => 'ProjectIdentifier', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the connected data source that is used to run the node. You can call the [ListDataSources](~~211431~~) operation to query the available data sources of the workspace.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'odps_first', - ], + 'schema' => ['description' => 'The unique identifier of the DataWorks workspace. You can click the identifier in the upper-left corner of the DataStudio page to switch to another workspace.'."\n" + ."\n" + .'You must specify either this parameter or ProjectId to determine the DataWorks workspace to which the operation is applied.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dw', 'title' => ''], ], [ - 'name' => 'Owner', + 'name' => 'BusinessId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the file owner.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '18023848927592', - ], + 'schema' => ['description' => 'The ID of the workflow. You can call the [ListBusiness](~~173945~~) operation to query the ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1000001', 'title' => ''], ], [ - 'name' => 'AutoParsing', + 'name' => 'TableGuid', 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether the automatic parsing feature is enabled for the file. Valid values:'."\n" - ."\n" - .'* true: The automatic parsing feature is enabled for the file.'."\n" - .'* false: The automatic parsing feature is not enabled for the file.'."\n" - ."\n" - .'This parameter corresponds to the Analyze Code parameter that is displayed after Same Cycle is selected in the Dependencies section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The universally unique identifier (UUID) of the table. You can call the [SearchMetaTables](~~173919~~) operation to query the UUID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'odps.dw_project.tb1', 'title' => ''], ], [ - 'name' => 'SchedulerType', + 'name' => 'FolderId', 'in' => 'formData', + 'schema' => ['description' => 'The ID of the folder. You can call the [GetFolder](~~173952~~) or [ListFolders](~~173955~~) operation to query the ID.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2eb6f9****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The scheduling type of the node. Valid values:'."\n" - ."\n" - .'* NORMAL: The node is an auto triggered node.'."\n" - .'* MANUAL: The node is a manually triggered node. Manually triggered nodes cannot be automatically triggered. They correspond to the nodes in the Manually Triggered Workflows pane.'."\n" - .'* PAUSE: The node is a paused node.'."\n" - .'* SKIP: The node is a dry-run node. Dry-run nodes are started as scheduled, but the system sets the status of the nodes to successful when it starts to run them.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'NORMAL', - 'enum' => [ - 'NORMAL', - 'SKIP', - 'PAUSE', - 'MANUAL', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'The connection does not exist.', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request. You can troubleshoot issues based on the ID.'."\n", 'type' => 'string', 'example' => '0000-ABCD-EFG', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned.'."\n", 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ], + ], + 'title' => 'EstablishRelationTableToBusiness', + 'summary' => 'Imports a table to a workflow. The call to this API operation is equivalent to performing the following operations: Go to the DataStudio page, find the desired workflow, and then click the workflow name. Right-click Table under the desired folder and select Import Table.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'ExportDataSources' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'AdvancedSettings', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The advanced configurations of the node.'."\n" - ."\n" - .'This parameter is valid only for an EMR Spark Streaming node or an EMR Streaming SQL node. This parameter corresponds to the Advanced Settings tab of the node in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n" - ."\n" - .'This parameter is configured in the JSON format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"queue":"default","SPARK_CONF":"--conf spark.driver.memory=2g"}', - ], + 'AK' => [], ], [ - 'name' => 'StartImmediately', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether to immediately run a node after the node is deployed to the production environment. Valid values:'."\n" - ."\n" - .'* true: A node is immediately run after the node is deployed to the production environment.'."\n" - .'* false: A node is not immediately run after the node is deployed to the production environment.'."\n" - ."\n" - .'This parameter is valid only for an EMR Spark Streaming node or an EMR Streaming SQL node. This parameter corresponds to the Start Method parameter in the Schedule section of the Configure tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'APP' => [], ], [ - 'name' => 'InputParameters', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The input parameters of the node. This parameter is configured in the JSON format. For more information about the input parameters, refer to the InputContextParameterList parameter in the Response parameters section of the [GetFile](~~173954~~) operation.'."\n" - ."\n" - .'This parameter corresponds to the Input Parameters table in the Input and Output Parameters section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{"ValueSource": "project_001.first_node:bizdate_param","ParameterName": "bizdate_input"}]', - ], + 'PrivateKey' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'OutputParameters', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The output parameters of the node. This parameter is configured in the JSON format. For more information about the output parameters, refer to the OutputContextParameterList parameter in the Response parameters section of the [GetFile](~~173954~~) operation.'."\n" - ."\n" - .'This parameter corresponds to the Output Parameters table in the Input and Output Parameters section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{"Type": 1,"Value": "${bizdate}","ParameterName": "bizdate_param"}]', - ], + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the DataWorks workspace to which the data sources belong. You can call the [ListProjects](~~178393~~) operation to query the ID of the workspace.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '10000000000', 'minimum' => '1', 'example' => '10000'], ], [ - 'name' => 'IgnoreParentSkipRunningProperty', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether to skip the dry-run property of the ancestor nodes of the node. This parameter corresponds to the Skip the dry-run property of the ancestor node parameter that is displayed after you configure the Depend On parameter in the Dependencies section of the Properties tab in the DataWorks console.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The keyword contained in the names of the data sources that you want to export. You can specify only one keyword. For example, if you set this parameter to test, you can call the ExportDataSources operation to export all data sources whose names contain test in the workspace.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'test'], ], [ - 'name' => 'ApplyScheduleImmediately', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether scheduling configurations immediately take effect after the node is deployed.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'name' => 'DataSourceType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the data source. Valid values:'."\n" + ."\n" + .'* odps'."\n" + .'* mysql'."\n" + .'* rds'."\n" + .'* oss'."\n" + .'* sqlserver'."\n" + .'* polardb'."\n" + .'* oracle'."\n" + .'* mongodb'."\n" + .'* emr'."\n" + .'* postgresql'."\n" + .'* analyticdb_for_mysql'."\n" + .'* hybriddb_for_postgresql'."\n" + .'* holo'."\n", 'type' => 'string', 'required' => false, 'example' => 'rds'], ], [ - 'name' => 'Timeout', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The timeout period.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'name' => 'SubType', + 'in' => 'query', + 'schema' => ['description' => 'The subtype of the data source. This parameter takes effect only when the DataSourceType parameter is set to rds.'."\n" + ."\n" + .'If the value of the DataSourceType parameter is rds, the value of this parameter can be mysql, sqlserver, or postgresql.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mysql'], ], [ - 'name' => 'ImageId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the custom image.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'm-uf6d7npxk1hhek8ng0cb', - ], + 'name' => 'EnvType', + 'in' => 'query', + 'schema' => ['description' => 'The environment in which the data source resides. Valid values:'."\n" + ."\n" + .'* 0: development environment'."\n" + .'* 1: production environment'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'example' => '10', 'default' => '10'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Pages start from page 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '1', 'default' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'RequestId' => [ - 'description' => 'The ID of the request. You can use the ID to troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFGH-IJKLMNOPQ', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful. Valid values:'."\n" - ."\n" - .'* true: The request is successful.'."\n" - .'* false: The request fails.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'HttpStatusCode' => ['description' => 'The HTTP status code returned. Valid values:'."\n" + ."\n" + .'* 200: The request was successful.'."\n" + .'* Other values: The request failed. You can troubleshoot issues based on the HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", 'type' => 'string', 'example' => '0bc14115159376359****'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], + 'Data' => [ + 'description' => 'The information about the exported data sources.'."\n", + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => 'The page number. Pages start from page 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'DataSources' => [ + 'description' => 'The details of the exported data sources. The value is an array. The following parameters are the elements in the array. The sample values of these parameters show the details of a sample data source.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'Indicates whether the data source is available. Valid values:'."\n" + ."\n" + .'* 1: The data source is available.'."\n" + .'* 0: The data source is unavailable.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ProjectId' => ['description' => 'The ID of the DataWorks workspace to which the data source belongs.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '123'], + 'SubType' => ['description' => 'The subtype of the data source. This parameter takes effect only when the DataSourceType parameter is set to rds.'."\n" + ."\n" + .'If the value of the DataSourceType parameter is rds, the value of this parameter can be mysql, sqlserver, or postgresql.'."\n", 'type' => 'string', 'example' => 'mysql'], + 'GmtModified' => ['description' => 'The time when the data source was last modified. Example: Mar 17, 2021 4:09:32 PM.'."\n", 'type' => 'string', 'example' => 'Mar 17, 2021 4:09:32 PM'], + 'EnvType' => ['description' => 'The environment in which the data source resides. Valid values:'."\n" + ."\n" + .'* 0: development environment'."\n" + .'* 1: production environment'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ConnectStatus' => ['description' => 'Indicates whether the data source is connected to an exclusive resource group. Valid values:'."\n" + ."\n" + .'* 1: The data source is connected to at least one exclusive resource group.'."\n" + .'* 0: The data source is not connected to any exclusive resource group.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Sequence' => ['description' => 'The sequence number of the data source.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '300'], + 'Description' => ['description' => 'The description of the data source.'."\n", 'type' => 'string', 'example' => 'a connection'], + 'DataSourceType' => ['description' => 'The type of the data source. Valid values:'."\n" + ."\n" + .'* odps'."\n" + .'* mysql'."\n" + .'* rds'."\n" + .'* oss'."\n" + .'* sqlserver'."\n" + .'* polardb'."\n" + .'* oracle'."\n" + .'* mongodb'."\n" + .'* emr'."\n" + .'* postgresql'."\n" + .'* analyticdb_for_mysql'."\n" + .'* hybriddb_for_postgresql'."\n" + .'* holo'."\n", 'type' => 'string', 'example' => 'rds'], + 'GmtCreate' => ['description' => 'The time when the data source was created. Example: Mar 17, 2021 4:09:32 PM.'."\n", 'type' => 'string', 'example' => 'Mar 17, 2021 4:09:32 PM'], + 'DefaultEngine' => ['description' => 'Indicates whether the compute engine that is added as the data source is the default compute engine. Valid values:'."\n" + ."\n" + .'* true: The compute engine is the default compute engine.'."\n" + .'* false: The compute engine is not the default compute engine.'."\n", 'type' => 'boolean', 'example' => 'false'], + 'Shared' => ['description' => 'Indicates whether the data source can be shared. Valid values:'."\n" + ."\n" + .'* true: The data source can be shared.'."\n" + .'* false: The data source cannot be shared.'."\n", 'type' => 'boolean', 'example' => 'false'], + 'Operator' => ['description' => 'The ID of the user who exported the data source.'."\n", 'type' => 'string', 'example' => '193543050****'], + 'Name' => ['description' => 'The name of the data source.'."\n", 'type' => 'string', 'example' => 'abc'], + 'Content' => ['description' => 'The configuration of the data source.'."\n", 'type' => 'string', 'example' => '{"pubEndpoint":"http://service.cn.maxcompute.aliyun.com/api","accessId":"TMP.3KecGjvzy3i8MYfn2BGHgF7EHGyBFZcHm7GgngrABVRyvvKQrfF5kskR36xP361C3dqwbGo7SGYptAeGyiTwHXqLaBUvYC","securityToken":null,"endpoint":"http://service.cn.maxcompute.aliyun-inc.com/api","accessKey":"***","name":"PRE_PROJECT_A_engine","project":"PRE_PROJECT_A","vpcEndpoint":"http://service.cn.maxcompute.aliyun-inc.com/api","region":"cn-shanghai","authType":"2"}'], + 'Id' => ['description' => 'The data source ID.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'BindingCalcEngineId' => ['description' => 'The ID of the compute engine that is added as the data source.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '123'], + 'TenantId' => ['description' => 'The ID of the Alibaba Cloud account to which the data source belongs.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234567'], + ], + ], + ], + ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + 400 => [ + ['errorCode' => 'Invalid.DI.Parameter', 'errorMessage' => 'The parameter is invalid.', 'description' => ''], ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + 403 => [ + ['errorCode' => 'Forbidden.DI.NoPrivilege', 'errorMessage' => 'No access.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], + ['errorCode' => 'InternalError.DI.Parameter', 'errorMessage' => 'A DI internal error occurred.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFGH-IJKLMNOPQ\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n The connection does not exist.\\n 0000-ABCD-EFGH-IJKLMNOPQ\\n Invalid.Tenant.ConnectionNotExists\\n true\\n","errorExample":""}]', - 'title' => 'UpdateFile', - 'summary' => 'Updates a file.', - 'description' => 'When you debug or call this operation, you must specify new values for the specified parameters to ensure that the values are different from the original configurations of the file. For example, if the original value of a parameter is A, you must change the value of this parameter to B before you commit the node. If you set the parameter to A, an exception that indicates invalid data occurs.'."\n", + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0bc14115159376359****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 10,\\n \\"PageSize\\": 1,\\n \\"TotalCount\\": 100,\\n \\"DataSources\\": [\\n {\\n \\"Status\\": 1,\\n \\"ProjectId\\": 123,\\n \\"SubType\\": \\"mysql\\",\\n \\"GmtModified\\": \\"Mar 17, 2021 4:09:32 PM\\",\\n \\"EnvType\\": 1,\\n \\"ConnectStatus\\": 1,\\n \\"Sequence\\": 300,\\n \\"Description\\": \\"a connection\\",\\n \\"DataSourceType\\": \\"rds\\",\\n \\"GmtCreate\\": \\"Mar 17, 2021 4:09:32 PM\\",\\n \\"DefaultEngine\\": false,\\n \\"Shared\\": false,\\n \\"Operator\\": \\"193543050****\\",\\n \\"Name\\": \\"abc\\",\\n \\"Content\\": \\"{\\\\\\"pubEndpoint\\\\\\":\\\\\\"http://service.cn.maxcompute.aliyun.com/api\\\\\\",\\\\\\"accessId\\\\\\":\\\\\\"TMP.3KecGjvzy3i8MYfn2BGHgF7EHGyBFZcHm7GgngrABVRyvvKQrfF5kskR36xP361C3dqwbGo7SGYptAeGyiTwHXqLaBUvYC\\\\\\",\\\\\\"securityToken\\\\\\":null,\\\\\\"endpoint\\\\\\":\\\\\\"http://service.cn.maxcompute.aliyun-inc.com/api\\\\\\",\\\\\\"accessKey\\\\\\":\\\\\\"***\\\\\\",\\\\\\"name\\\\\\":\\\\\\"PRE_PROJECT_A_engine\\\\\\",\\\\\\"project\\\\\\":\\\\\\"PRE_PROJECT_A\\\\\\",\\\\\\"vpcEndpoint\\\\\\":\\\\\\"http://service.cn.maxcompute.aliyun-inc.com/api\\\\\\",\\\\\\"region\\\\\\":\\\\\\"cn-shanghai\\\\\\",\\\\\\"authType\\\\\\":\\\\\\"2\\\\\\"}\\",\\n \\"Id\\": 1,\\n \\"BindingCalcEngineId\\": 123,\\n \\"TenantId\\": 1234567\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"0bc14115159376359****\\n200\\n\\n 100\\n 1\\n 10\\n \\n 1\\n 193543050****\\n 1\\n mysql\\n a connection\\n 123\\n 123\\n Mar 17, 2021 4:09:32 PM\\n 300\\n false\\n 1\\n abc\\n false\\n 1234567\\n Mar 17, 2021 4:09:32 PM\\n {\\"pubEndpoint\\":\\"http://service.cn.maxcompute.aliyun.com/api\\",\\"accessId\\":\\"TMP.3KecGjvzy3i8MYfn2BGHgF7EHGyBFZcHm7GgngrABVRyvvKQrfF5kskR36xP361C3dqwbGo7SGYptAeGyiTwHXqLaBUvYC\\",\\"securityToken\\":null,\\"endpoint\\":\\"http://service.cn.maxcompute.aliyun-inc.com/api\\",\\"accessKey\\":\\"***\\",\\"name\\":\\"PRE_PROJECT_A_engine\\",\\"project\\":\\"PRE_PROJECT_A\\",\\"vpcEndpoint\\":\\"http://service.cn.maxcompute.aliyun-inc.com/api\\",\\"region\\":\\"cn-shanghai\\",\\"authType\\":\\"2\\"}\\n rds\\n 1\\n \\n\\ntrue","errorExample":""}]', + 'title' => 'ExportDataSources', + 'summary' => 'Exports a list of data sources.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'GetFolder' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'GenerateDISyncTaskConfigForCreating' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '78248', - 'abilityTreeNodes' => [ - 'FEATUREdide8FM783', + [ + 'APP' => [], + ], + [ + 'PrivateKey' => [], ], ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '1000011', - ], + 'in' => 'query', + 'schema' => ['description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the ID.'."\n" + ."\n" + .'You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '10000000000', 'minimum' => '1', 'example' => '10000'], ], [ - 'name' => 'ProjectIdentifier', - 'in' => 'formData', + 'name' => 'TaskType', + 'in' => 'query', 'schema' => [ - 'description' => 'The error code.'."\n", + 'description' => 'The type of task that you want to create in Data Integration in asynchronous mode. Valid values:'."\n" + ."\n" + .'* DI_REALTIME: real-time synchronization task'."\n" + .'* DI_SOLUTION: another type of synchronization task'."\n" + ."\n" + .'DataWorks allows you to create real-time synchronization tasks and other types of synchronization tasks in Data Integration only in asynchronous mode.'."\n" + ."\n" + .'* DI_OFFLINE'."\n" + .'* DI_REALTIME'."\n" + .'* DI_SOLUTION'."\n", 'type' => 'string', - 'required' => false, - 'example' => 'dw_project', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [], + 'example' => 'DI_REALTIME', + 'enum' => ['DI_OFFLINE', 'DI_REALTIME', 'DI_SOLUTION'], ], ], [ - 'name' => 'FolderId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '273****', - ], + 'name' => 'TaskParam', + 'in' => 'query', + 'schema' => ['description' => 'The script for the synchronization task. DataWorks allows you to create the following types of synchronization tasks:'."\n" + ."\n" + .'* Synchronization task that is used to synchronize data from MySQL to MaxCompute'."\n" + .'* Synchronization task that is used to synchronize data from MySQL data to Kafka'."\n" + .'* Synchronization task that is used to synchronize data from MySQL to Hologres'."\n" + ."\n" + .'The SelectedTables parameter is used to specify tables that you want to synchronize from multiple databases. The Tables parameter is used to specify tables that you want to synchronize from a single database.'."\n" + ."\n" + .'* If the script contains the SelectedTables parameter, the system synchronizes data from the tables that you specify in the SelectedTables parameter.'."\n" + .'* If the script contains the Tables parameter, the system synchronizes data from the tables that you specify in the Tables parameter.'."\n" + ."\n" + .'The following sample code provides a script for data synchronization from MySQL to MaxCompute:'."\n" + ."\n" + .' {'."\n" + .' "type": "realtime",'."\n" + .' "version": "1.0",'."\n" + .' "setting": {'."\n" + .' "resourceGroup": "S_res_group_280749521950784_1623033752022",'."\n" + .' "taskType": "oneclick_to_odps"'."\n" + .' },'."\n" + .' "steps": ['."\n" + .' {'."\n" + .' "stepType": "mysql",'."\n" + .' "parameter": {'."\n" + .' "connection": ['."\n" + .' {'."\n" + .' "datasourceType": "mysql",'."\n" + .' "datasource": "mysql_pub1",'."\n" + .' "selectedTables": ['."\n" + .' {'."\n" + .' "dbName": "mysql_db",'."\n" + .' "schema": ['."\n" + .' {'."\n" + .' "tableInfos": ['."\n" + .' {'."\n" + .' "table": "molin_di_test_in_pk_v4"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' ]'."\n" + .' },'."\n" + .' "name": "Reader",'."\n" + .' "category": "reader"'."\n" + .' },'."\n" + .' {'."\n" + .' "stepType": "odps",'."\n" + .' "parameter": {'."\n" + .' "datasource": "odps_source"'."\n" + .' },'."\n" + .' "name": "Writer",'."\n" + .' "category": "writer"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + ."\n" + .'The following sample code provides a script for data synchronization from MySQL to Kafka:'."\n" + ."\n" + .' {'."\n" + .' "type": "realtime",'."\n" + .' "version": "1.0",'."\n" + .' "setting": {'."\n" + .' "resourceGroup": "S_res_group_280749521950784_1623033752022",'."\n" + .' "taskType": "oneclick_to_kafka"'."\n" + .' },'."\n" + .' "steps": ['."\n" + .' {'."\n" + .' "stepType": "mysql",'."\n" + .' "parameter": {'."\n" + .' "connection": ['."\n" + .' {'."\n" + .' "datasourceType": "mysql",'."\n" + .' "datasource": "pkset_test",'."\n" + .' "selectedTables": ['."\n" + .' {'."\n" + .' "dbName": "mysql_db",'."\n" + .' "schema": ['."\n" + .' {'."\n" + .' "tableInfos": ['."\n" + .' {'."\n" + .' "table": "molin_di_test_in_pk_v4"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' ]'."\n" + .' },'."\n" + .' "name": "Reader",'."\n" + .' "category": "reader"'."\n" + .' },'."\n" + .' {'."\n" + .' "stepType": "kafka",'."\n" + .' "parameter": {'."\n" + .' "datasource": "azn_kafka"'."\n" + .' },'."\n" + .' "name": "Writer",'."\n" + .' "category": "writer"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + ."\n" + .'The following sample code provides a script for data synchronization from MySQL to Hologres:'."\n" + ."\n" + .' {'."\n" + .' "type": "realtime",'."\n" + .' "version": "1.0",'."\n" + .' "setting": {'."\n" + .' "resourceGroup": "S_res_group_280749521950784_1623033752022",'."\n" + .' "taskType": "oneclick_to_holo"'."\n" + .' },'."\n" + .' "steps": ['."\n" + .' {'."\n" + .' "stepType": "mysql",'."\n" + .' "parameter": {'."\n" + .' "connection": ['."\n" + .' {'."\n" + .' "datasourceType": "mysql",'."\n" + .' "datasource": "mysql_pub",'."\n" + .' "selectedTables": ['."\n" + .' {'."\n" + .' "dbName": "mysql_db",'."\n" + .' "schema": ['."\n" + .' {'."\n" + .' "tableInfos": ['."\n" + .' {'."\n" + .' "table": "molin_di_test_in2_pk_v3"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' ]'."\n" + .' },'."\n" + .' "name": "Reader",'."\n" + .' "category": "reader"'."\n" + .' },'."\n" + .' {'."\n" + .' "stepType": "holo",'."\n" + .' "parameter": {'."\n" + .' "datasource": "holo"'."\n" + .' },'."\n" + .' "name": "Writer",'."\n" + .' "category": "writer"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{ "type": "realtime", "version": "1.0", "setting": { "resourceGroup": "S_res_group_280749521950784_1623033752022", "scheduleResgroupId": 30003913, "name": "openapi_realtime_solution_0813_1739", "taskType": "oneclick_to_odps" }, "steps": [ { "stepType": "mysql", "parameter": { "connection": [ { "datasourceType": "mysql", "datasource": "mysql_pub", "table": [ "xyx" ] } ] }, "name": "Reader", "category": "reader" }, { "stepType": "odps", "parameter": { "datasource": "odps_first" }, "name": "Writer", "category": "writer" } ] }'], ], [ - 'name' => 'FolderPath', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The details of the folder.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'Business_process/my_first_business_process/MaxCompute/ods_layer', - 'minLength' => 1, - ], + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. This parameter is used to prevent repeated operations that are caused by multiple calls.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ABFUOEUOTRTRJKE'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The path of the folder.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => 'The folder ID.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'RequestId' => [ - 'description' => 'http://100.67.165.184/business/api/folders/detail', - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'ErrorCode' => [ - 'description' => 'GetFolder', - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0bc1411515937635973****'], 'Data' => [ - 'description' => '', + 'description' => 'The information returned for the ID of the asynchronous thread.'."\n", 'type' => 'object', 'properties' => [ - 'FolderPath' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Business_process/my_first_business_process/MaxCompute/ods_layer', - ], - 'FolderId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2735****', - ], + 'Status' => ['description' => 'Indicates whether the ID of the asynchronous thread is generated. Valid values: Valid values:'."\n" + ."\n" + .'* success: indicates that the ID of the asynchronous thread is generated.'."\n" + .'* fail: indicates that the ID of the asynchronous thread fails to be generated. You can view the reason for the failure and troubleshoot the issue based on the reason.'."\n", 'type' => 'string', 'example' => 'true'], + 'ProcessId' => ['description' => 'The ID of the asynchronous thread. You can call the [QueryDISyncTaskConfigProcessResult](~~383465~~) operation to obtain the asynchronously generated parameters based on the ID. The parameters are used to create a synchronization task in Data Integration.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'Message' => ['description' => 'The reason why the ID of the asynchronous thread fails to be generated. If the ID is successfully generated, no value is returned for this parameter.'."\n", 'type' => 'string', 'example' => 'XXX is invalid.'], ], ], ], @@ -17350,317 +11956,168 @@ ], ], 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + 400 => [ + ['errorCode' => 'Invalid.DI.Parameter', 'errorMessage' => 'The parameter is invalid.', 'description' => ''], + ['errorCode' => 'Invalid.DI.Parameter.File.Existed', 'errorMessage' => 'The file name already exists.', 'description' => ''], ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + 403 => [ + ['errorCode' => 'Forbidden.DI.NoPrivilege', 'errorMessage' => 'No access.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], + ['errorCode' => 'InternalError.DI.Parameter', 'errorMessage' => 'A DI internal error occurred.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"FolderPath\\": \\"Business_process/my_first_business_process/MaxCompute/ods_layer\\",\\n \\"FolderId\\": \\"2735****\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"0000-ABCD-EFG****\\n200\\n\\n 业务流程/我的第一个业务流程/MaxCompute/ods层\\n 2735****\\n\\nInvalid.Tenant.ConnectionNotExists\\nThe connection does not exist.\\ntrue","errorExample":""}]', - 'title' => 'GetFolder', - 'summary' => 'Queries the information about a folder.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListFileVersions' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0bc1411515937635973****\\",\\n \\"Data\\": {\\n \\"Status\\": \\"true\\",\\n \\"ProcessId\\": 10,\\n \\"Message\\": \\"XXX is invalid.\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 0bc1411515937635973****\\n \\n true\\n 10\\n XXX is invalid.\\n \\n","errorExample":""}]', + 'title' => 'GenerateDISyncTaskConfigForCreating', + 'summary' => 'Generates an ID for an asynchronous thread that is used to create a synchronization task in Data Integration.', + 'description' => 'DataWorks allows you to use the [CreateDISyncTask](~~278725~~) operation to directly create a batch synchronization task in Data Integration. To create a real-time synchronization task or another type of synchronization task, you must first call the [GenerateDISyncTaskConfigForCreating](~~383463~~) operation to generate the ID of an asynchronous thread and call the [QueryDISyncTaskConfigProcessResult](~~383465~~) operation to obtain the asynchronously generated parameters based on the ID. Then, you can use the parameters as request parameters of [CreateDISyncTask](~~278725~~) and call the [CreateDISyncTask](~~278725~~) operation to create a real-time synchronization task or another type of synchronization task. DataWorks allows you to create real-time synchronization tasks and other types of synchronization tasks in Data Integration only in asynchronous mode.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'GenerateDISyncTaskConfigForUpdating' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '78312', - 'abilityTreeNodes' => [ - 'FEATUREdide8FM783', + [ + 'APP' => [], ], - ], - 'parameters' => [ [ - 'name' => 'FileId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the file. You can call the [ListFiles](~~173942~~) operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '100000001', - ], + 'PrivateKey' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The DataWorks workspace ID. You can click the Workspace Manage icon in the upper-right corner of the DataStudio page to go to the Workspace page and view the workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '10000', - ], + 'in' => 'query', + 'schema' => ['description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the workspace ID.'."\n" + ."\n" + .'You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '10000000000', 'minimum' => '1', 'example' => '10000', 'title' => ''], ], [ - 'name' => 'ProjectIdentifier', - 'in' => 'formData', + 'name' => 'TaskType', + 'in' => 'query', 'schema' => [ - 'description' => 'The unique identifier of the DataWorks workspace. You can click the identifier in the upper-left corner of the DataStudio page to switch to another workspace.'."\n" + 'description' => 'The type of the object that you want to update in Data Integration in asynchronous mode. Valid values:'."\n" + ."\n" + .'- DI\\_REALTIME: real-time synchronization task'."\n" + ."\n" + .'- DI\\_SOLUTION: synchronization solution DataWorks allows you to create or update real-time synchronization tasks in Data Integration only in asynchronous mode.'."\n" ."\n" - .'You must specify either this parameter or ProjectId to determine the DataWorks workspace to which the operation is applied.'."\n", + .'Valid values:'."\n" + ."\n" + .'- DI\\_OFFLINE'."\n" + ."\n" + .'- DI\\_REALTIME'."\n" + ."\n" + .'- DI\\_SOLUTION', 'type' => 'string', - 'required' => false, - 'example' => 'dw_project', + 'required' => true, + 'docRequired' => true, + 'enum' => ['DI_OFFLINE', 'DI_REALTIME', 'DI_SOLUTION'], + 'example' => 'DI_REALTIME', + 'title' => '', ], ], [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'name' => 'TaskParam', + 'in' => 'query', + 'schema' => ['description' => 'The script for updating the real-time synchronization task in Data Integration. DataWorks allows you to add or remove tables for a real-time synchronization task in Data Integration only in asynchronous mode. The following types of real-time synchronization tasks are supported:'."\n" + ."\n" + .'- Synchronization task that is used to synchronize data from MySQL to MaxCompute'."\n" + ."\n" + .'- Synchronization task that is used to synchronize data from MySQL data to Kafka'."\n" + ."\n" + .'- Synchronization task that is used to synchronize data from MySQL to Hologres'."\n" + ."\n" + .'The SelectedTables parameter is used to specify tables that you want to synchronize from multiple databases. The Tables parameter is used to specify tables that you want to synchronize from a single database.'."\n" + ."\n" + .'- If the script contains the SelectedTables parameter, the system synchronizes data from the tables that you specify in the SelectedTables parameter.'."\n" + ."\n" + .'- If the script contains the Tables parameter, the system synchronizes data from the tables that you specify in the Tables parameter.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"steps":[{"parameter":{"connection":[{"table":["xyx"]}]},"name":"Reader","category":"reader"}]}', 'title' => ''], ], [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'maximum' => '100', - 'minimum' => '0', - 'example' => '10', - 'default' => '10', - ], + 'name' => 'ClientToken', + 'in' => 'query', + 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request. This parameter is used to prevent repeated operations that are caused by multiple calls.', 'type' => 'string', 'required' => false, 'example' => 'ABFUOEUOTRTRJKE', 'title' => ''], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['description' => 'The task ID.'."\n" + ."\n" + .'- If you set the TaskType parameter to DI\\_REALTIME, set the TaskId parameter to the value of the FileId parameter for the real-time synchronization task.'."\n" + ."\n" + .'- If you set the TaskType parameter to DI\\_SOLUTION, set the TaskId parameter to the value of the FileId parameter for the synchronization solution.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9999999999999999', 'minimum' => '0', 'example' => '100', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The returned results.', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.', 'type' => 'string', 'example' => '0bc1411515937635973****', 'title' => ''], 'Data' => [ - 'description' => 'The file versions.'."\n", + 'description' => 'The information returned for the ID of the asynchronous thread.', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '13', - ], - 'FileVersions' => [ - 'description' => 'The details of file versions.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'FileContent' => [ - 'description' => 'The code in the file of the current version.'."\n", - 'type' => 'string', - 'example' => 'SHOW TABLES;', - ], - 'Status' => [ - 'description' => 'The status of the file of the current version. Valid values: COMMITTING, COMMITTED, CHECK_OK, PACKAGED, DEPLOYING, DEPLOYED, and CANCELLED.'."\n", - 'type' => 'string', - 'example' => 'COMMITTED', - ], - 'IsCurrentProd' => [ - 'description' => 'Indicates whether the file version is the same as the latest file version in the production environment.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'CommitUser' => [ - 'description' => 'The ID of the Alibaba Cloud account used to create the file of the current version.'."\n", - 'type' => 'string', - 'example' => '73842342****', - ], - 'NodeContent' => [ - 'description' => 'The scheduling configurations for the node that corresponds to the file of the current version.'."\n", - 'type' => 'string', - 'example' => '{"cycleType":0,"cronExpress":"00 05 00 * * ?"}', - ], - 'Comment' => [ - 'description' => 'The description of the file version.'."\n", - 'type' => 'string', - 'example' => 'Second version submission', - ], - 'FilePropertyContent' => [ - 'description' => 'The basic information about the file of the current version.'."\n", - 'type' => 'string', - 'example' => '{"fileName":"ods_user_info_d","fileType":10}', - ], - 'FileName' => [ - 'description' => 'The name of the file of the current version.'."\n", - 'type' => 'string', - 'example' => 'ods_user_info_d', - ], - 'UseType' => [ - 'description' => 'The functional module to which the file belongs. Valid values: NORMAL, MANUAL, MANUAL_BIZ, SKIP, ADHOCQUERY, and COMPONENT. The value SKIP indicates that the node corresponding to the file is run in dry-run mode.'."\n", - 'type' => 'string', - 'example' => 'NORMAL', - ], - 'ChangeType' => [ - 'description' => 'The type of the change to the file of the current version. Valid values: CREATE, UPDATE, and DELETE.'."\n", - 'type' => 'string', - 'example' => 'UPDATE', - ], - 'FileVersion' => [ - 'description' => 'The version of the file.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'CommitTime' => [ - 'description' => 'The time when the file version was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1593881265000', - ], - 'NodeId' => [ - 'description' => 'The ID of the auto triggered node that corresponds to the file of the current version.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - ], - 'description' => '', - ], - ], + 'Status' => ['description' => 'Indicates whether the ID of the asynchronous thread is generated. Valid values:'."\n" + ."\n" + .'- success: indicates that the ID of the asynchronous thread is generated.'."\n" + ."\n" + .'- fail: indicates that the ID of the asynchronous thread fails to be generated. You can view the reason for the failure and troubleshoot the issue based on the reason.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'ProcessId' => ['description' => 'The ID of the asynchronous thread. You can call the [QueryDISyncTaskConfigProcessResult](~~383465~~) operation to obtain the asynchronously generated parameters based on the ID. The parameters are used to update a real-time synchronization task in Data Integration.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'Message' => ['description' => 'The reason why the ID of the asynchronous thread fails to be generated. If the ID is successfully generated, no value is returned for this parameter.', 'type' => 'string', 'example' => 'XXX is invalid.', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + 400 => [ + ['errorCode' => 'Invalid.DI.Parameter', 'errorMessage' => 'The parameter is invalid.', 'description' => ''], + ['errorCode' => 'Invalid.DI.Parameter.File.Existed', 'errorMessage' => 'The file name already exists.', 'description' => ''], ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + 403 => [ + ['errorCode' => 'Forbidden.DI.NoPrivilege', 'errorMessage' => 'No access.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], + ['errorCode' => 'InternalError.DI.Parameter', 'errorMessage' => 'A DI internal error occurred.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 13,\\n \\"FileVersions\\": [\\n {\\n \\"FileContent\\": \\"SHOW TABLES;\\",\\n \\"Status\\": \\"COMMITTED\\",\\n \\"IsCurrentProd\\": false,\\n \\"CommitUser\\": \\"73842342****\\",\\n \\"NodeContent\\": \\"{\\\\\\"cycleType\\\\\\":0,\\\\\\"cronExpress\\\\\\":\\\\\\"00 05 00 * * ?\\\\\\"}\\",\\n \\"Comment\\": \\"Second version submission\\",\\n \\"FilePropertyContent\\": \\"{\\\\\\"fileName\\\\\\":\\\\\\"ods_user_info_d\\\\\\",\\\\\\"fileType\\\\\\":10}\\",\\n \\"FileName\\": \\"ods_user_info_d\\",\\n \\"UseType\\": \\"NORMAL\\",\\n \\"ChangeType\\": \\"UPDATE\\",\\n \\"FileVersion\\": 2,\\n \\"CommitTime\\": 1593881265000,\\n \\"NodeId\\": 1234\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"0000-ABCD-EFG****Q\\n200\\n\\n 13\\n \\n COMMITTED\\n 73842342****\\n 第二次版本提交\\n 1593881265000\\n ods_user_info_d\\n {\\"fileName\\":\\"ods_user_info_d\\",\\"fileType\\":10}\\n NORMAL\\n false\\n SHOW TABLES;\\n UPDATE\\n 2\\n 3000001\\n {\\"cycleType\\":0,\\"cronExpress\\":\\"00 05 00 * * ?\\"}\\n \\n 10\\n 1\\n\\ntrue","errorExample":""}]', - 'title' => 'ListFileVersions', - 'summary' => 'Queries a list of file versions.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'GetFile' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0bc1411515937635973****\\",\\n \\"Data\\": {\\n \\"Status\\": \\"true\\",\\n \\"ProcessId\\": 10,\\n \\"Message\\": \\"XXX is invalid.\\"\\n }\\n}","type":"json"}]', + 'title' => 'GenerateDISyncTaskConfigForUpdating', + 'summary' => 'Generates the configuration for updating a real-time synchronization task in Data Integration.', + 'description' => 'DataWorks allows you to directly call the [UpdateDISyncTask](~~289109~~) operation to update batch synchronization tasks in Data Integration. To update a real-time synchronization task, you must first call the GenerateDISyncTaskConfigForUpdating and [QueryDISyncTaskConfigProcessResult](~~383465~~) operations to asynchronously generate the required parameters, and then pass the parameters to the UpdateDISyncTask operation. Only asynchronous updates are supported for real-time synchronization tasks in Data Integration.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'GetAlertMessage' => [ + 'summary' => 'Queries alert information based on the alert ID that is specified by the AlertId parameter.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -17670,577 +12127,458 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '78245', - 'abilityTreeNodes' => [ - 'FEATUREdide8FM783', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '201154', + 'abilityTreeNodes' => ['FEATUREdideRJGWWC'], ], 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'AlertId', 'in' => 'formData', + 'schema' => ['description' => 'The alert ID. You can all the [ListAlertMessages](~~173961~~) operation to obtain the alert ID.'."\n", 'type' => 'string', 'required' => true, 'example' => '1421', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The ID of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace Management page to obtain the workspace ID.'."\n" - ."\n" - .'You must configure this parameter or the ProjectIdentifier parameter to determine the DataWorks workspace to which the operation is applied.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '10000', + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0000-ABCD-EFG****'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The specified parameters are invalid.', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The information about returned alerts.'."\n", + 'type' => 'object', + 'properties' => [ + 'RemindId' => ['description' => 'The ID of the custom alert rule that was triggered. This parameter is returned if the value of the Source parameter is REMIND_ALERT.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'AlertMessageStatus' => ['description' => 'The sending status of the notification. Valid values:'."\n" + ."\n" + .'* READY_TO_SEND: The notification is waiting to be sent.'."\n" + .'* SEND_FAIL: The notification fails to be sent.'."\n" + .'* SEND_SUCCESS: The notification is sent.'."\n" + .'* SEND_OVERLIMIT: The number of notifications that are sent exceeds the upper limit.'."\n", 'type' => 'string', 'example' => 'READY_TO_SEND', 'title' => ''], + 'AlertUser' => ['description' => 'The ID of the Alibaba Cloud account used by the alert recipient.'."\n", 'type' => 'string', 'example' => '9527952795****', 'title' => ''], + 'AlertTime' => ['description' => 'The time when the alert was reported.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1553524393000', 'title' => ''], + 'AlertMethod' => ['description' => 'The notification method. Valid values:'."\n" + ."\n" + .'* MAIL.'."\n" + .'* SMS.'."\n" + .'* PHONE. Only DataWorks Professional Edition and more advanced editions support the PHONE notification method.'."\n", 'type' => 'string', 'example' => 'SMS', 'title' => ''], + 'Source' => ['description' => 'The type of the alert. Valid values:'."\n" + ."\n" + .'* REMIND_ALERT: The alert is a custom alert.'."\n" + .'* TOPIC_ALERT: The alert is an event alert.'."\n" + .'* SLA_ALERT: The alert is a baseline alert.'."\n" + .'* NODE_CYCLE_ALERT: The alert is reported for a node dependency loop.'."\n" + .'* NODE_LONELY_ALERT: The alert is reported for isolated nodes.'."\n", 'type' => 'string', 'example' => 'REMIND_ALERT', 'title' => ''], + 'Content' => ['description' => 'The content of the alert.'."\n", 'type' => 'string', 'example' => 'Node error', 'title' => ''], + 'RemindName' => ['description' => 'The name of the custom alert rule that was triggered. This parameter is returned if the value of the Source parameter is REMIND_ALERT.'."\n", 'type' => 'string', 'example' => 'Custom monitoring rule name', 'title' => ''], + 'AlertId' => ['description' => 'The alert ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'Instances' => [ + 'description' => 'The instances that triggered the custom alert rule. This parameter is returned if the value of the Source parameter is REMIND_ALERT. This parameter is left empty if the value of the Source parameter is not REMIND_ALERT.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the instance.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status of the instance. Valid values:'."\n" + ."\n" + .'* NOT_RUN'."\n" + .'* WAIT_TIME'."\n" + .'* WAIT_RESOURCE'."\n" + .'* RUNNING'."\n" + .'* CHECKING'."\n" + .'* CHECKING_CONDITION'."\n" + .'* FAILURE'."\n" + .'* SUCCESS'."\n", 'type' => 'string', 'example' => 'NOT_RUN', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '12312****', 'title' => ''], + 'NodeName' => ['description' => 'The name of the node.'."\n", 'type' => 'string', 'example' => 'Node name', 'title' => ''], + 'NodeId' => ['description' => 'The node ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'ProjectId' => ['description' => 'The ID of the workspace to which the node belongs.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Topics' => [ + 'description' => 'The events that triggered alerts. This parameter is returned if the value of the Source parameter is TOPIC_ALERT. This parameter is left empty if the value of the Source parameter is not TOPIC_ALERT.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the event.'."\n", + 'type' => 'object', + 'properties' => [ + 'TopicName' => ['description' => 'The name of the event.'."\n", 'type' => 'string', 'example' => 'error', 'title' => ''], + 'InstanceId' => ['description' => 'The ID of the instance that triggered the event.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '12345', 'title' => ''], + 'TopicId' => ['description' => 'The event ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '412431', 'title' => ''], + 'TopicOwner' => ['description' => 'The ID of the Alibaba Cloud account used by the event owner.'."\n", 'type' => 'string', 'example' => '9527952795****', 'title' => ''], + 'NodeId' => ['description' => 'The ID of the node that triggered the event.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'TopicStatus' => ['description' => 'The status of the event. Valid values:'."\n" + ."\n" + .'* IGNORE'."\n" + .'* NEW'."\n" + .'* FIXING'."\n" + .'* RECOVER'."\n", 'type' => 'string', 'example' => 'FIXING', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Nodes' => [ + 'description' => 'The nodes returned for different alert sources. The nodes that form a loop are returned if the value of the Source parameter is NODE_CYCLE_ALERT. The nodes that are isolated are returned if the value of the Source parameter is NODE_LONELY_ALERT.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the node.'."\n", + 'type' => 'object', + 'properties' => [ + 'Owner' => ['description' => 'The ID of the Alibaba Cloud account used by the node owner.'."\n", 'type' => 'string', 'example' => '95279527952****', 'title' => ''], + 'NodeName' => ['description' => 'The name of the node.'."\n", 'type' => 'string', 'example' => 'Node name', 'title' => ''], + 'NodeId' => ['description' => 'The node ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'ProjectId' => ['description' => 'The ID of the workspace to which the node belongs.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'SlaAlert' => [ + 'description' => 'The basic information about the baseline instance that triggered an alert. This parameter is returned if the value of the Source parameter is SLA_ALERT. This parameter is left empty if the value of the Source parameter is not SLA_ALERT.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status of the baseline. Valid values:'."\n" + ."\n" + .'* ERROR'."\n" + .'* SAFE'."\n" + .'* DANGEROUS'."\n" + .'* OVER'."\n", 'type' => 'string', 'example' => 'SAFE', 'title' => ''], + 'BaselineOwner' => ['description' => 'The ID of the Alibaba Cloud account used by the baseline owner. Multiple IDs are separated by commas (,).'."\n", 'type' => 'string', 'example' => '952795279****', 'title' => ''], + 'BaselineId' => ['description' => 'The baseline ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '15142123', 'title' => ''], + 'BaselineName' => ['description' => 'The name of the baseline.'."\n", 'type' => 'string', 'example' => 'Baseline name', 'title' => ''], + 'Bizdate' => ['description' => 'The data timestamp of the baseline instance.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1553443200000', 'title' => ''], + 'ProjectId' => ['description' => 'The ID of the workspace to which the baseline belongs.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'InGroupId' => ['description' => 'The ID of the cycle of the baseline instance. Valid values of the ID of an hour-level cycle: \\[1,24]. The ID of a day-level cycle is 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetAlertMessage', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"RemindId\\": 1234,\\n \\"AlertMessageStatus\\": \\"READY_TO_SEND\\",\\n \\"AlertUser\\": \\"9527952795****\\",\\n \\"AlertTime\\": 1553524393000,\\n \\"AlertMethod\\": \\"SMS\\",\\n \\"Source\\": \\"REMIND_ALERT\\",\\n \\"Content\\": \\"Node error\\",\\n \\"RemindName\\": \\"Custom monitoring rule name\\",\\n \\"AlertId\\": 123,\\n \\"Instances\\": [\\n {\\n \\"Status\\": \\"NOT_RUN\\",\\n \\"InstanceId\\": 0,\\n \\"NodeName\\": \\"Node name\\",\\n \\"NodeId\\": 1234,\\n \\"ProjectId\\": 1234\\n }\\n ],\\n \\"Topics\\": [\\n {\\n \\"TopicName\\": \\"error\\",\\n \\"InstanceId\\": 12345,\\n \\"TopicId\\": 412431,\\n \\"TopicOwner\\": \\"9527952795****\\",\\n \\"NodeId\\": 1234,\\n \\"TopicStatus\\": \\"FIXING\\"\\n }\\n ],\\n \\"Nodes\\": [\\n {\\n \\"Owner\\": \\"95279527952****\\",\\n \\"NodeName\\": \\"Node name\\",\\n \\"NodeId\\": 1234,\\n \\"ProjectId\\": 1234\\n }\\n ],\\n \\"SlaAlert\\": {\\n \\"Status\\": \\"SAFE\\",\\n \\"BaselineOwner\\": \\"952795279****\\",\\n \\"BaselineId\\": 15142123,\\n \\"BaselineName\\": \\"Baseline name\\",\\n \\"Bizdate\\": 1553443200000,\\n \\"ProjectId\\": 1234,\\n \\"InGroupId\\": 1\\n }\\n }\\n}","type":"json"}]', + ], + 'GetBaseline' => [ + 'summary' => 'Queries the information about a baseline based on its ID.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ProjectIdentifier', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace Management page to obtain the workspace name.'."\n" - ."\n" - .'You must configure this parameter or the ProjectId parameter to determine the DataWorks workspace to which the operation is applied.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dw_project', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '158223', + 'abilityTreeNodes' => ['FEATUREdideSFSFU4'], + ], + 'parameters' => [ [ - 'name' => 'FileId', + 'name' => 'BaselineId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the file. You can call the [ListFiles](~~173942~~) operation to obtain the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '100000001', - ], + 'schema' => ['description' => 'The baseline ID. You can call the [ListBaselines](~~2261507~~) operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456', 'title' => ''], ], [ - 'name' => 'NodeId', + 'name' => 'ProjectId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the node that is scheduled. You can call the [ListFiles](~~173942~~) operation to obtain the node ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '200000001', - ], + 'schema' => ['description' => 'The ID of the workspace to which the baseline belongs. You can call the [ListBaselines](~~2261507~~) operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'title' => 'OpenApiResultModel', + 'description' => 'OpenApiResultModel'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'RequestId' => [ - 'description' => 'The ID of the request. You can use the ID to troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful. Valid values:'."\n" - ."\n" - .'* true: The request is successful.'."\n" - .'* false: The request fails.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '1031203110005', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The specified parameters are invalid', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Data' => [ - 'description' => 'The details of the file.'."\n", + 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ - 'File' => [ - 'description' => 'The basic information about the file.'."\n", - 'type' => 'object', - 'properties' => [ - 'CommitStatus' => [ - 'description' => 'Indicates whether the latest code in the file is committed. Valid values: 0 and 1. The value 0 indicates that the latest code in the file is not committed. The value 1 indicates that the latest code in the file is committed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', + 'BaselineId' => ['description' => 'The baseline ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1001'], + 'BaselineName' => ['description' => 'The name of the baseline.'."\n", 'type' => 'string', 'title' => '', 'example' => 'Test baseline'], + 'ProjectId' => ['description' => 'The workspace ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10000'], + 'Owner' => ['description' => 'The owner.'."\n", 'type' => 'string', 'title' => '', 'example' => '9527952****'], + 'Priority' => ['description' => 'The priority of the baseline. Valid values: 1, 3, 5, 7, and 8.'."\n", 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'BaselineType' => ['description' => 'The type of the baseline. Valid values:'."\n" + ."\n" + .'* DAILY'."\n" + .'* HOURLY'."\n", 'type' => 'string', 'title' => '', 'example' => 'DAILY'], + 'OverTimeSettings' => [ + 'title' => '', + 'description' => 'The settings of the committed completion time of the baseline.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Cycle' => ['description' => 'The period corresponding to the commitment time. The space-based line is 1, and the hourly baseline can be configured for up to 24 cycles.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'Time' => ['description' => 'Commitment time, hh:mm format, hh value range is [0,47],mm value range is [0,59].', 'type' => 'string', 'title' => '', 'example' => '00:00'], ], - 'AutoParsing' => [ - 'description' => 'Indicates whether the automatic parsing feature is enabled for the file. Valid values:'."\n" + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'Enabled' => ['description' => 'Indicates whether the baseline is enabled.'."\n", 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'NodeIds' => [ + 'title' => '', + 'description' => 'The node IDs.'."\n", + 'type' => 'array', + 'items' => ['description' => 'Node ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '700003****', 'title' => ''], + 'example' => '', + ], + 'AlertEnabled' => ['description' => 'Indicates whether the alerting feature is enabled. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'AlertMarginThreshold' => ['description' => 'The alert margin threshold. Unit: minutes.'."\n", 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '60'], + 'AlertSettings' => [ + 'title' => '', + 'description' => 'The alert settings.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Baseline alert configuration', + 'type' => 'object', + 'properties' => [ + 'AlertType' => ['description' => 'Alert type'."\n" ."\n" - .'* true: The automatic parsing feature is enabled for the file.'."\n" - .'* false: The automatic parsing feature is not enabled for the file.'."\n" + .'- BASELINE: baseline'."\n" + .'- TOPIC: event', 'type' => 'string', 'title' => '', 'example' => 'BASELINE'], + 'AlertMethods' => [ + 'title' => '', + 'description' => 'Alert method list', + 'type' => 'array', + 'items' => ['description' => 'The alert method. The values are as follows:'."\n" + ."\n" + .'- MAIL: MAIL'."\n" + .'- SMS: SMS'."\n" + .'- PHONE: voice'."\n" + .'- DINGROBOTS: DingTalk robot'."\n" + .'- WEBHOOKS: Webhook', 'type' => 'string', 'example' => 'MAIL', 'title' => ''], + 'example' => '', + ], + 'SilenceStartTime' => ['description' => 'The start time of the silence. Format: HH:mm:ss', 'type' => 'string', 'title' => '', 'example' => '00:00:00'], + 'SilenceEndTime' => ['description' => 'The end time of the silence. The format is HH:mm:ss.', 'type' => 'string', 'title' => '', 'example' => '00:00:00'], + 'AlertInterval' => ['description' => 'The event alert interval, in seconds.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '900'], + 'AlertMaximum' => ['description' => 'The maximum number of event alerts.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'DingRobots' => [ + 'title' => '', + 'description' => 'DingTalk robot list.', + 'type' => 'array', + 'items' => [ + 'description' => 'DingTalk robot configuration.', + 'type' => 'object', + 'properties' => [ + 'WebUrl' => ['description' => 'DingTalk robot address', 'type' => 'string', 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=xxx', 'title' => ''], + 'AtAll' => ['description' => 'Whether @ everyone.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'Webhooks' => [ + 'title' => '', + 'description' => 'webhook list.', + 'type' => 'array', + 'items' => ['description' => 'The webhook addresses of the Enterprise WeChat or flying book Robot. Separate multiple webhook addresses with commas (,). alertMethods must include WEBHOOKS alert methods. Only DataWorks Enterprise Edition is supported.'."\n" + ."\n" + .'Available regions: China(Shanghai), China(Chengdu), China(Zhangjiakou), China(Beijing), China(Hangzhou), China(Shenzhen), China (Hong Kong), Central Europe 1 (Frankfurt), and Southeast Asia Pacific 1 (Singapore).', 'type' => 'string', 'example' => 'https://open.feishu.cn/open-apis/bot/v2/hook/xxx', 'title' => ''], + 'example' => '', + ], + 'TopicTypes' => [ + 'title' => '', + 'description' => 'The list of Event Alert types.', + 'type' => 'array', + 'items' => ['description' => 'The type of the event alert.'."\n" + ."\n" + .'- SLOW'."\n" + .'- ERROR', 'type' => 'string', 'example' => 'SLOW', 'title' => ''], + 'example' => '', + ], + 'BaselineAlertEnabled' => ['description' => 'The baseline alarm switch.'."\n" ."\n" - .'This parameter corresponds to the Analyze Code parameter that is displayed after Same Cycle is selected in the Dependencies section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Owner' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the file owner.'."\n", - 'type' => 'string', - 'example' => '7775674356****', - ], - 'CreateTime' => [ - 'description' => 'The time when the file was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1593879116000', - ], - 'FileType' => [ - 'description' => 'The type of the code for the file. The code for files varies based on the file type. For more information, see [DataWorks nodes](~~600169~~).'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'CurrentVersion' => [ - 'description' => 'The latest version number of the file.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'BizId' => [ - 'description' => 'The ID of the workflow to which the file belongs. This parameter is deprecated and replaced by the BusinessId parameter.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000001', - ], - 'LastEditUser' => [ - 'description' => 'The ID of the Alibaba Cloud account used to last modify the file.'."\n", - 'type' => 'string', - 'example' => '62465892****', - ], - 'FileName' => [ - 'description' => 'The name of the file.'."\n", - 'type' => 'string', - 'example' => 'ods_user_info_d', - ], - 'ConnectionName' => [ - 'description' => 'The ID of the compute engine instance that is used to run the node that corresponds to the file.'."\n", - 'type' => 'string', - 'example' => 'odps_first', - ], - 'UseType' => [ - 'description' => 'The module to which the file belongs. Valid values:'."\n" - ."\n" - .'* NORMAL: The file is used for DataStudio.'."\n" - .'* MANUAL: The file is used for a manually triggered node.'."\n" - .'* MANUAL_BIZ: The file is used for a manually triggered workflow.'."\n" - .'* SKIP: The file is used for a dry-run DataStudio node.'."\n" - .'* ADHOCQUERY: The file is used for an ad hoc query.'."\n" - .'* COMPONENT: The file is used for a snippet.'."\n", - 'type' => 'string', - 'example' => 'NORMAL', - ], - 'FileFolderId' => [ - 'description' => 'The ID of the folder to which the file belongs.'."\n", - 'type' => 'string', - 'example' => '2735c2****', - ], - 'ParentId' => [ - 'description' => 'The ID of the node group file to which the current file belongs. This parameter is returned only if the current file is an inner file of the node group file.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '-1', - ], - 'CreateUser' => [ - 'description' => 'The ID of the Alibaba Cloud account used to create the file.'."\n", - 'type' => 'string', - 'example' => '424732****', - ], - 'IsMaxCompute' => [ - 'description' => 'Indicates whether the file needs to be uploaded to MaxCompute.'."\n" - ."\n" - .'This parameter is returned only if the file is a MaxCompute resource file.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'BusinessId' => [ - 'description' => 'The ID of the workflow to which the file belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000001', - ], - 'FileDescription' => [ - 'description' => 'The description of the file.'."\n", - 'type' => 'string', - 'example' => 'My first DataWorks file', - ], - 'DeletedStatus' => [ - 'description' => 'The status of the file. Valid values:'."\n" - ."\n" - .'* NORMAL: The file is not deleted.'."\n" - .'* RECYCLE_BIN: The file is stored in the recycle bin.'."\n" - .'* DELETED: The file is deleted.'."\n", - 'type' => 'string', - 'example' => 'RECYCLE', - ], - 'LastEditTime' => [ - 'description' => 'The time when the file was last modified. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1593879116000', - ], - 'Content' => [ - 'description' => 'The code in the file.'."\n", - 'type' => 'string', - 'example' => 'SHOW TABLES;', - ], - 'NodeId' => [ - 'description' => 'The ID of the auto triggered node that is generated in the scheduling system after the file is committed.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '300001', - ], - 'AdvancedSettings' => [ - 'description' => 'The advanced configurations of the node.'."\n" - ."\n" - .'This parameter is valid for an EMR node. This parameter corresponds to the Advanced Settings tab in the right-side navigation pane on the configuration tab of the node in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n" - ."\n" - .'> You cannot configure advanced parameters for EMR Shell nodes.'."\n" - ."\n" - .'For information about the advanced parameters of each type of EMR node, see [Develop EMR tasks](~~473077~~).'."\n", - 'type' => 'string', - 'example' => '{"queue":"default","SPARK_CONF":"--conf spark.driver.memory=2g"}', - ], - 'FileId' => [ - 'description' => 'The ID of the file.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100000001', - ], - ], - ], - 'NodeConfiguration' => [ - 'description' => 'The scheduling configurations of the file.'."\n", - 'type' => 'object', - 'properties' => [ - 'RerunMode' => [ - 'description' => 'Indicates whether the node that corresponds to the file can be rerun. Valid values:'."\n" - ."\n" - .'* ALL_ALLOWED: The node can be rerun regardless of whether it is successfully run or fails to run.'."\n" - .'* FAILURE_ALLOWED: The node can be rerun only after it fails to run.'."\n" - .'* ALL_DENIED: The node cannot be rerun regardless of whether it is successfully run or fails to run.'."\n" - ."\n" - .'This parameter corresponds to the Rerun parameter in the Schedule section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'string', - 'example' => 'ALL_ALLOWED', - ], - 'SchedulerType' => [ - 'description' => 'The scheduling type of the node. Valid values:'."\n" - ."\n" - .'* NORMAL: The node is an auto triggered node.'."\n" - .'* MANUAL: The node is a manually triggered node. Manually triggered nodes cannot be automatically triggered. They correspond to the nodes in the Manually Triggered Workflows pane.'."\n" - .'* PAUSE: The node is a paused node.'."\n" - .'* SKIP: The node is a dry-run node. Dry-run nodes are started as scheduled but the system sets the status of the nodes to successful when it starts to run them.'."\n", - 'type' => 'string', - 'example' => 'NORMAL', - ], - 'Stop' => [ - 'description' => 'Indicates whether the scheduling for the node is suspended Valid values:'."\n" - ."\n" - .'* true: The scheduling for the node is suspended.'."\n" - .'* false: The scheduling for the node is not suspended.'."\n" - ."\n" - .'This parameter corresponds to the Recurrence parameter in the Schedule section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'ParaValue' => [ - 'description' => 'The scheduling parameters of the node.'."\n" - ."\n" - .'This parameter corresponds to the Parameters section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console). For more information about the configurations of the scheduling parameters, see [Configure scheduling parameters](~~137548~~).'."\n", - 'type' => 'string', - 'example' => 'a=x b=y', - ], - 'StartEffectDate' => [ - 'description' => 'The start time of automatic scheduling. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n" - ."\n" - .'This parameter corresponds to the Validity Period parameter in the Schedule section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '936923400000', - ], - 'EndEffectDate' => [ - 'description' => 'The end time of automatic scheduling. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n" - ."\n" - .'This parameter corresponds to the Validity Period parameter in the Schedule section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4155787800000', - ], - 'CycleType' => [ - 'description' => 'The type of the scheduling cycle. Valid values: NOT_DAY and DAY. The value NOT_DAY indicates that the node is scheduled to run by minute or hour. The value DAY indicates that the node is scheduled to run by day, week, or month.'."\n" - ."\n" - .'This parameter corresponds to the Scheduling Cycle parameter in the Schedule section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'string', - 'example' => 'DAY', - ], - 'DependentNodeIdList' => [ - 'description' => 'The ID of the node on which the node corresponding to the file depends when the DependentType parameter is set to USER_DEFINE. Multiple IDs are separated by commas (,).'."\n" - ."\n" - .'The value of this parameter is equivalent to the ID of the node that you specified after you select Previous Cycle and set Depend On to Other Nodes in the Dependencies section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'string', - 'example' => '5,10,15,20', - ], - 'ResourceGroupId' => [ - 'description' => 'The ID of the resource group that is used to run the node. You can call the [ListResourceGroups](~~173913~~) operation to query the available resource groups in the workspace.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '375827434852437', - ], - 'DependentType' => [ - 'description' => 'The type of the cross-cycle scheduling dependency of the node. Valid values:'."\n" - ."\n" - .'* SELF: The instance generated for the node in the current cycle depends on the instance generated for the node in the previous cycle.'."\n" - .'* CHILD: The instance generated for the node in the current cycle depends on the instances generated for the descendant nodes at the nearest level of the node in the previous cycle.'."\n" - .'* USER_DEFINE: The instance generated for the node in the current cycle depends on the instances generated for one or more specified nodes in the previous cycle.'."\n" - .'* NONE: No cross-cycle scheduling dependency type is selected for the node.'."\n", - 'type' => 'string', - 'example' => 'USER_DEFINE', - ], - 'AutoRerunTimes' => [ - 'description' => 'The number of automatic reruns that are allowed after an error occurs.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'AutoRerunIntervalMillis' => [ - 'description' => 'The interval between automatic reruns after an error occurs. Unit: milliseconds.'."\n" - ."\n" - .'This parameter corresponds to the Rerun Interval parameter that is displayed after the Auto Rerun upon Error check box is selected in the Schedule section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n" - ."\n" - .'The interval that you specify in the DataWorks console is measured in minutes. Pay attention to the conversion between the units of time when you call the operation.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '120000', - ], - 'CronExpress' => [ - 'description' => 'The CRON expression that represents the periodic scheduling policy of the node.'."\n", - 'type' => 'string', - 'example' => '00 05 00 * * ?', - ], - 'InputList' => [ - 'description' => 'The output names of the parent files on which the current file depends.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Input' => [ - 'description' => 'The output name of the parent file on which the current file depends.'."\n" - ."\n" - .'This parameter corresponds to the Output Name of Ancestor Node parameter under Parent Nodes after Same Cycle is selected in the Dependencies section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'string', - 'example' => 'project.001_out', - ], - 'ParseType' => [ - 'description' => 'The mode of the configuration file dependency. Valid values:'."\n" - ."\n" - .'* MANUAL: Scheduling dependencies are manually configured.'."\n" - .'* AUTO: Scheduling dependencies are automatically parsed.'."\n", - 'type' => 'string', - 'example' => 'MANUAL', - ], - ], - ], - ], - 'OutputList' => [ - 'description' => 'The output names of the current file.'."\n" - ."\n" - .'This parameter corresponds to the Output Name parameter under Output after Same Cycle is selected in the Dependencies section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RefTableName' => [ - 'description' => 'The output table name of the current file.'."\n" - ."\n" - .'This parameter corresponds to the Output Table Name parameter under Output after Same Cycle is selected in the Dependencies section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'string', - 'example' => 'ods_user_info_d', - ], - 'Output' => [ - 'description' => 'The output name of the current file.'."\n" - ."\n" - .'This parameter corresponds to the Output Name parameter under Output after Same Cycle is selected in the Dependencies section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'string', - 'example' => 'dw_project.002_out', - ], - ], - ], - ], - 'StartImmediately' => [ - 'description' => 'Indicates whether a node is immediately run after the node is deployed to the production environment.'."\n" - ."\n" - .'This parameter is valid only for an EMR Spark Streaming node or an EMR Streaming SQL node. This parameter corresponds to the Start Method parameter in the Schedule section of the Configure tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'InputParameters' => [ - 'description' => 'Input parameters of the node.'."\n" - ."\n" - .'This parameter corresponds to the Input Parameters table in the Input and Output Parameters section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ParameterName' => [ - 'description' => 'The name of the input parameter of the node. In the code, you can use the ${...} method to reference the input parameter of the node.'."\n" - ."\n" - .'This parameter corresponds to the Parameter Name parameter in the Input Parameters table in the Input and Output Parameters section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'string', - 'example' => 'input', - ], - 'ValueSource' => [ - 'description' => 'The value source of the input parameter of the node.'."\n" - ."\n" - .'This parameter corresponds to the Value Source parameter in the Input Parameters table in the Input and Output Parameters section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'string', - 'example' => 'project_001.parent_node:outputs', - ], - ], - ], - ], - 'OutputParameters' => [ - 'description' => 'Output parameters of the node.'."\n" - ."\n" - .'This parameter corresponds to the Output Parameters table in the Input and Output Parameters section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ParameterName' => [ - 'description' => 'The name of the output parameter of the node.'."\n" - ."\n" - .'This parameter corresponds to the Parameter Name parameter in the Output Parameters table in the Input and Output Parameters section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'string', - 'example' => 'output', - ], - 'Value' => [ - 'description' => 'The value of the output parameter of the node.'."\n" - ."\n" - .'This parameter corresponds to the Value parameter in the Output Parameters table in the Input and Output Parameters section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'string', - 'example' => '${bizdate}', - ], - 'Type' => [ - 'description' => 'The type of the output parameter of the node. Valid values:'."\n" - ."\n" - .'* 1: indicates a constant.'."\n" - .'* 2: indicates a variable.'."\n" - .'* 3: indicates a pass-through variable.'."\n" - ."\n" - .'This parameter corresponds to the Type parameter in the Output Parameters table in the Input and Output Parameters section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'Description' => [ - 'description' => 'The description of the output parameter of the node.'."\n", - 'type' => 'string', - 'example' => 'It\'s a context output parameter.', - ], - ], - ], - ], - 'ApplyScheduleImmediately' => [ - 'description' => 'Indicates whether scheduling configurations immediately take effect after the deployment.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'IgnoreParentSkipRunningProperty' => [ - 'description' => 'Indicates whether to skip the dry-run property of the ancestor nodes of the node that corresponds to the file. This parameter corresponds to the Skip the dry-run property of the ancestor node parameter that is displayed after you configure the Depend On parameter in the Dependencies section of the Properties tab in the DataWorks console.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Timeout' => [ - 'description' => 'The timeout period.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ImageId' => [ - 'description' => 'The ID of the custom image.'."\n", - 'type' => 'string', - 'example' => 'm-bp1h4b5a8ogkbll2f3tr', - ], - ], - ], - 'ResourceDownloadLink' => [ - 'description' => 'The download URL of the resource.'."\n", - 'type' => 'object', - 'properties' => [ - 'downloadLink' => [ - 'description' => 'The download URL of the resource.'."\n", - 'type' => 'string', - 'example' => 'http://xx', + .'- true'."\n" + .'- false', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'AlertRecipientType' => ['description' => 'The type of alert recipient.'."\n" + ."\n" + .'- OWNER: task owner'."\n" + .'- OTHER: designated person'."\n" + .'- SHIFT: SCHEDULE-duty table', 'type' => 'string', 'title' => '', 'example' => 'OWNER'], + 'AlertRecipient' => ['description' => 'Alert recipient details.'."\n" + ."\n" + .'AlertRecipientType is OWNER: empty'."\n" + .'AlertRecipientType is SHIFT_SCHEDULE: duty table uid'."\n" + .'AlertRecipientType is OTHER: uid list, multiple UIDs are in English, split', 'type' => 'string', 'title' => '', 'example' => '123123'], ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'title' => '', + 'example' => '', + ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ecb967ec-c137-48a5-860****', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'title' => 'GetBaseline', + 'changeSet' => [ + ['createdAt' => '2022-11-16T09:08:31.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"BaselineId\\": 1001,\\n \\"BaselineName\\": \\"Test baseline\\",\\n \\"ProjectId\\": 10000,\\n \\"Owner\\": \\"9527952****\\",\\n \\"Priority\\": 1,\\n \\"BaselineType\\": \\"DAILY\\",\\n \\"OverTimeSettings\\": [\\n {\\n \\"Cycle\\": 1,\\n \\"Time\\": \\"00:00\\"\\n }\\n ],\\n \\"Enabled\\": true,\\n \\"NodeIds\\": [\\n 0\\n ],\\n \\"AlertEnabled\\": true,\\n \\"AlertMarginThreshold\\": 60,\\n \\"AlertSettings\\": [\\n {\\n \\"AlertType\\": \\"BASELINE\\",\\n \\"AlertMethods\\": [\\n \\"MAIL\\"\\n ],\\n \\"SilenceStartTime\\": \\"00:00:00\\",\\n \\"SilenceEndTime\\": \\"00:00:00\\",\\n \\"AlertInterval\\": 900,\\n \\"AlertMaximum\\": 1,\\n \\"DingRobots\\": [\\n {\\n \\"WebUrl\\": \\"https://oapi.dingtalk.com/robot/send?access_token=xxx\\",\\n \\"AtAll\\": true\\n }\\n ],\\n \\"Webhooks\\": [\\n \\"https://open.feishu.cn/open-apis/bot/v2/hook/xxx\\"\\n ],\\n \\"TopicTypes\\": [\\n \\"SLOW\\"\\n ],\\n \\"BaselineAlertEnabled\\": false,\\n \\"AlertRecipientType\\": \\"OWNER\\",\\n \\"AlertRecipient\\": \\"123123\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"ecb967ec-c137-48a5-860****\\"\\n}","type":"json"}]', + ], + 'GetBaselineConfig' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '78229', + 'abilityTreeNodes' => ['FEATUREdideSFSFU4'], + ], + 'parameters' => [ + [ + 'name' => 'BaselineId', + 'in' => 'formData', + 'schema' => ['description' => 'The baseline ID. You can call the [GetNode](~~173977~~) operation to query the baseline ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1234', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '401', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'ecb967ec-c137-48a5-860****', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The specified parameters are invalid.', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '1031203110005', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The details of the baseline.'."\n", + 'type' => 'object', + 'properties' => [ + 'HourSlaDetail' => ['description' => 'The committed completion time of the hour-level baseline. This parameter is presented as key-value pairs in the JSON format. The key indicates the ID of the cycle, and the value is presented in the hh:mm format. Valid values of hh: \\[0,47]. Valid values of mm: \\[0,59].'."\n", 'type' => 'string', 'example' => '{"1":"03:58","2":"04:58","3":"05:58","4":"06:58","5":"07:58","6":"08:58","7":"09:58","8":"10:58","9":"11:58","10":"12:58","11":"13:58","12":"14:58","13":"15:58","14":"16:58","15":"17:58","16":"18:58","17":"19:58","18":"20:58","19":"21:58","20":"22:58","21":"23:58","22":"24:58","23":"25:58","24":"26:58"}', 'title' => ''], + 'IsDefault' => ['description' => 'Indicates whether the baseline is a default baseline of the workspace. Valid values: true and false.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Owner' => ['description' => 'The ID of the Alibaba Cloud account used by the baseline owner. Multiple IDs can be specified. The IDs are separated by commas (,).'."\n", 'type' => 'string', 'example' => '9527952****', 'title' => ''], + 'ProjectId' => ['description' => 'The ID of the workspace.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123456', 'title' => ''], + 'Priority' => ['description' => 'The priority of the baseline. Valid values: {1,3,5,7,8}.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'SlaMinu' => ['description' => 'The minute in the committed completion time of the day-level baseline. Valid values: \\[0, 59].'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'SlaHour' => ['description' => 'The hour in the committed completion time of the day-level baseline. Valid values: \\[0, 47].'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '9', 'title' => ''], + 'BaselineId' => ['description' => 'The baseline ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'BaselineName' => ['description' => 'The name of the baseline.'."\n", 'type' => 'string', 'example' => 'Baseline name'."\n", 'title' => ''], + 'HourExpDetail' => ['description' => 'The alerting time of the hour-level baseline. This parameter is presented as key-value pairs in the JSON format. The key indicates the ID of the cycle, and the value is presented in the hh:mm format. Valid values of hh: \\[0,47]. Valid values of mm: \\[0,59].'."\n", 'type' => 'string', 'example' => '{"1":"03:28","2":"04:28","3":"05:28","4":"06:28","5":"07:28","6":"08:28","7":"09:28","8":"10:28","9":"11:28","10":"12:28","11":"13:28","12":"14:28","13":"15:28","14":"16:28","15":"17:28","16":"18:28","17":"19:28","18":"20:28","19":"21:28","20":"22:28","21":"23:28","22":"24:28","23":"25:28","24":"26:28"}', 'title' => ''], + 'UseFlag' => ['description' => 'Indicates whether the baseline is enabled. Valid values: true and false.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ExpHour' => ['description' => 'The hour in the alerting time of the day-level baseline. Valid values: \\[0, 47].'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '7', 'title' => ''], + 'BaselineType' => ['description' => 'The type of the baseline. Valid values: DAILY and HOURLY.'."\n", 'type' => 'string', 'example' => 'DAILY', 'title' => ''], + 'ExpMinu' => ['description' => 'The minute in the alerting time of the day-level baseline. Valid values: \\[0, 59].'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], ], 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], + ['errorCode' => 'Forbidden.Not.Server', 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.', 'description' => ''], + ['errorCode' => 'Forbidden.Wkbench.BaselineNoPermission', 'errorMessage' => 'You are not authorized to access the baseline.', 'description' => ''], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.Wkbench.ServiceError', 'errorMessage' => 'An internal error occurred.', 'description' => 'An internal error occurred.'], + ['errorCode' => 'Invalid.Wkbench.Parameter', 'errorMessage' => 'The specified parameters are invalid.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"File\\": {\\n \\"CommitStatus\\": 0,\\n \\"AutoParsing\\": true,\\n \\"Owner\\": \\"7775674356****\\",\\n \\"CreateTime\\": 1593879116000,\\n \\"FileType\\": 10,\\n \\"CurrentVersion\\": 3,\\n \\"BizId\\": 1000001,\\n \\"LastEditUser\\": \\"62465892****\\",\\n \\"FileName\\": \\"ods_user_info_d\\",\\n \\"ConnectionName\\": \\"odps_source\\",\\n \\"UseType\\": \\"NORMAL\\",\\n \\"FileFolderId\\": \\"2735c2****\\",\\n \\"ParentId\\": -1,\\n \\"CreateUser\\": \\"424732****\\",\\n \\"IsMaxCompute\\": true,\\n \\"BusinessId\\": 1000001,\\n \\"FileDescription\\": \\"My first DataWorks file\\",\\n \\"DeletedStatus\\": \\"RECYCLE\\",\\n \\"LastEditTime\\": 1593879116000,\\n \\"Content\\": \\"SHOW TABLES;\\",\\n \\"NodeId\\": 300001,\\n \\"AdvancedSettings\\": \\"{\\\\\\\\\\\\\\"priority\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ENABLE_SPARKSQL_JDBC\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"FLOW_SKIP_SQL_ANALYZE\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"queue\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"default\\\\\\\\\\\\\\"}\\",\\n \\"FileId\\": 100000001\\n },\\n \\"NodeConfiguration\\": {\\n \\"RerunMode\\": \\"ALL_ALLOWED\\",\\n \\"SchedulerType\\": \\"NORMAL\\",\\n \\"Stop\\": false,\\n \\"ParaValue\\": \\"a=x b=y\\",\\n \\"StartEffectDate\\": 936923400000,\\n \\"EndEffectDate\\": 4155787800000,\\n \\"CycleType\\": \\"DAY\\",\\n \\"DependentNodeIdList\\": \\"5,10,15,20\\",\\n \\"ResourceGroupId\\": 375827434852437,\\n \\"DependentType\\": \\"USER_DEFINE\\",\\n \\"AutoRerunTimes\\": 3,\\n \\"AutoRerunIntervalMillis\\": 120000,\\n \\"CronExpress\\": \\"00 05 00 * * ?\\",\\n \\"InputList\\": [\\n {\\n \\"Input\\": \\"project.001_out\\",\\n \\"ParseType\\": \\"MANUAL\\"\\n }\\n ],\\n \\"OutputList\\": [\\n {\\n \\"RefTableName\\": \\"ods_user_info_d\\",\\n \\"Output\\": \\"dw_project.002_out\\"\\n }\\n ],\\n \\"StartImmediately\\": true,\\n \\"InputParameters\\": [\\n {\\n \\"ParameterName\\": \\"input\\",\\n \\"ValueSource\\": \\"project_001.parent_node:outputs\\"\\n }\\n ],\\n \\"OutputParameters\\": [\\n {\\n \\"ParameterName\\": \\"output\\",\\n \\"Value\\": \\"${bizdate}\\",\\n \\"Type\\": \\"1\\",\\n \\"Description\\": \\"It\'s a context output parameter.\\"\\n }\\n ],\\n \\"ApplyScheduleImmediately\\": \\"true\\",\\n \\"IgnoreParentSkipRunningProperty\\": \\"true\\",\\n \\"Timeout\\": 1,\\n \\"ImageId\\": \\"m-bp1h4b5a8ogkbll2f3tr\\"\\n },\\n \\"ResourceDownloadLink\\": {\\n \\"downloadLink\\": \\"http://xx\\"\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n The connection does not exist.\\n 0000-ABCD-EFG****\\n Invalid.Tenant.ConnectionNotExists\\n true\\n \\n \\n 0\\n true\\n 7775674356****\\n 1593879116000\\n 10\\n 3\\n 1000001\\n 62465892****\\n ods_user_info_d\\n odps_source\\n NORMAL\\n 2735c2****\\n -1\\n 424732****\\n true\\n 1000001\\n 我的第一个Dataworks文件\\n RECYCLE\\n 1593879116000\\n SHOW TABLES;\\n 300001\\n {\\"queue\\":\\"default\\",\\"SPARK_CONF\\":\\"--conf spark.driver.memory=2g\\"}\\n 100000001\\n \\n \\n ALL_ALLOWED\\n NORMAL\\n false\\n a=x b=y\\n 936923400000\\n 4155787800000\\n DAY\\n 5,10,15,20\\n 375827434852437\\n USER_DEFINE\\n 3\\n 120000\\n 00 05 00 * * ?\\n \\n project.001_out\\n MANUAL\\n \\n \\n ods_user_info_d\\n dw_project.002_out\\n \\n true\\n \\n input\\n project_001.parent_node:outputs\\n \\n \\n output\\n ${bizdate}\\n 1\\n It\'s a context output parameter.\\n \\n \\n \\n","errorExample":""}]', - 'title' => 'GetFile', - 'summary' => 'Queries the information about a file.', + 'title' => 'GetBaselineConfig', + 'summary' => 'Queries the configurations of a baseline.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListFolders' => [ - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2023-01-10T12:27:18.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '399', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetBaselineConfig'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 401,\\n \\"RequestId\\": \\"ecb967ec-c137-48a5-860****\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"HourSlaDetail\\": \\"{\\\\\\"1\\\\\\":\\\\\\"03:58\\\\\\",\\\\\\"2\\\\\\":\\\\\\"04:58\\\\\\",\\\\\\"3\\\\\\":\\\\\\"05:58\\\\\\",\\\\\\"4\\\\\\":\\\\\\"06:58\\\\\\",\\\\\\"5\\\\\\":\\\\\\"07:58\\\\\\",\\\\\\"6\\\\\\":\\\\\\"08:58\\\\\\",\\\\\\"7\\\\\\":\\\\\\"09:58\\\\\\",\\\\\\"8\\\\\\":\\\\\\"10:58\\\\\\",\\\\\\"9\\\\\\":\\\\\\"11:58\\\\\\",\\\\\\"10\\\\\\":\\\\\\"12:58\\\\\\",\\\\\\"11\\\\\\":\\\\\\"13:58\\\\\\",\\\\\\"12\\\\\\":\\\\\\"14:58\\\\\\",\\\\\\"13\\\\\\":\\\\\\"15:58\\\\\\",\\\\\\"14\\\\\\":\\\\\\"16:58\\\\\\",\\\\\\"15\\\\\\":\\\\\\"17:58\\\\\\",\\\\\\"16\\\\\\":\\\\\\"18:58\\\\\\",\\\\\\"17\\\\\\":\\\\\\"19:58\\\\\\",\\\\\\"18\\\\\\":\\\\\\"20:58\\\\\\",\\\\\\"19\\\\\\":\\\\\\"21:58\\\\\\",\\\\\\"20\\\\\\":\\\\\\"22:58\\\\\\",\\\\\\"21\\\\\\":\\\\\\"23:58\\\\\\",\\\\\\"22\\\\\\":\\\\\\"24:58\\\\\\",\\\\\\"23\\\\\\":\\\\\\"25:58\\\\\\",\\\\\\"24\\\\\\":\\\\\\"26:58\\\\\\"}\\",\\n \\"IsDefault\\": true,\\n \\"Owner\\": \\"9527952****\\",\\n \\"ProjectId\\": 123456,\\n \\"Priority\\": 1,\\n \\"SlaMinu\\": 30,\\n \\"SlaHour\\": 9,\\n \\"BaselineId\\": 1234,\\n \\"BaselineName\\": \\"Baseline name\\\\n\\",\\n \\"HourExpDetail\\": \\"{\\\\\\"1\\\\\\":\\\\\\"03:28\\\\\\",\\\\\\"2\\\\\\":\\\\\\"04:28\\\\\\",\\\\\\"3\\\\\\":\\\\\\"05:28\\\\\\",\\\\\\"4\\\\\\":\\\\\\"06:28\\\\\\",\\\\\\"5\\\\\\":\\\\\\"07:28\\\\\\",\\\\\\"6\\\\\\":\\\\\\"08:28\\\\\\",\\\\\\"7\\\\\\":\\\\\\"09:28\\\\\\",\\\\\\"8\\\\\\":\\\\\\"10:28\\\\\\",\\\\\\"9\\\\\\":\\\\\\"11:28\\\\\\",\\\\\\"10\\\\\\":\\\\\\"12:28\\\\\\",\\\\\\"11\\\\\\":\\\\\\"13:28\\\\\\",\\\\\\"12\\\\\\":\\\\\\"14:28\\\\\\",\\\\\\"13\\\\\\":\\\\\\"15:28\\\\\\",\\\\\\"14\\\\\\":\\\\\\"16:28\\\\\\",\\\\\\"15\\\\\\":\\\\\\"17:28\\\\\\",\\\\\\"16\\\\\\":\\\\\\"18:28\\\\\\",\\\\\\"17\\\\\\":\\\\\\"19:28\\\\\\",\\\\\\"18\\\\\\":\\\\\\"20:28\\\\\\",\\\\\\"19\\\\\\":\\\\\\"21:28\\\\\\",\\\\\\"20\\\\\\":\\\\\\"22:28\\\\\\",\\\\\\"21\\\\\\":\\\\\\"23:28\\\\\\",\\\\\\"22\\\\\\":\\\\\\"24:28\\\\\\",\\\\\\"23\\\\\\":\\\\\\"25:28\\\\\\",\\\\\\"24\\\\\\":\\\\\\"26:28\\\\\\"}\\",\\n \\"UseFlag\\": true,\\n \\"ExpHour\\": 7,\\n \\"BaselineType\\": \\"DAILY\\",\\n \\"ExpMinu\\": 30\\n }\\n}","type":"json"}]', + ], + 'GetBaselineKeyPath' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -18250,71 +12588,24 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '78313', - 'abilityTreeNodes' => [ - 'FEATUREdide8FM783', - ], + 'abilityTreeCode' => '78230', + 'abilityTreeNodes' => ['FEATUREdideSFSFU4'], ], 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'BaselineId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The error message.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '10000', - ], + 'schema' => ['description' => 'The name of the event.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1234', 'title' => ''], ], [ - 'name' => 'ProjectIdentifier', + 'name' => 'Bizdate', 'in' => 'formData', - 'schema' => [ - 'description' => 'The request ID. You can troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dw_project', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-07-07T00:00:00+0800', 'title' => ''], ], [ - 'name' => 'ParentFolderPath', + 'name' => 'InGroupId', 'in' => 'formData', - 'schema' => [ - 'description' => '0000-ABCD-EFG****', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Business_process/my_first_business_process/MaxCompute', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The error code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'minimum' => '1', - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '100', - 'minimum' => '0', - 'example' => '10', - ], + 'schema' => ['description' => 'The ID of the event.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -18322,453 +12613,363 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The information about the folders.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => 'The page number.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'RequestId' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-****', - ], - 'ErrorCode' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Success' => [ - 'description' => 'The list of folders.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'The timestamp when the event was found.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The unique ID of the call. After an error occurs, you can troubleshoot the problem based on the ID.', 'type' => 'string', 'example' => '0000-ABCD-EFG****', 'title' => ''], + 'ErrorMessage' => ['description' => 'Error message', 'type' => 'string', 'example' => 'The specified parameters are invalid.', 'title' => ''], + 'ErrorCode' => ['description' => 'Error code', 'type' => 'string', 'example' => '1031203110005', 'title' => ''], + 'Success' => ['description' => 'Whether the call is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'The path of the folder.'."\n", - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => 'The folder ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'http://100.67.165.184/business/api/folders/list', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'ListFolders', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '13', - ], - 'Folders' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'FolderPath' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Business_process/my_first_business_process/MaxCompute/ods_layer', + 'description' => 'The information about the key path.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Owner' => ['description' => 'The ID of the Alibaba Cloud account used by the node owner.'."\n", 'type' => 'string', 'example' => '9527952****', 'title' => ''], + 'NodeName' => ['description' => 'The name of the node.'."\n", 'type' => 'string', 'example' => 'Node name', 'title' => ''], + 'Bizdate' => ['description' => 'The data timestamp of the instance.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1553443200000', 'title' => ''], + 'ProjectId' => ['description' => 'The ID of the workspace to which the node belongs.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'InstanceId' => ['description' => 'The ID of the instance.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123456', 'title' => ''], + 'PrgType' => ['description' => 'The type of the node. Valid values: 23, 10, 6, and 99. The value 23 indicates that the node is a Data Integration node. The value 10 indicates that the node is a MaxCompute SQL node. The value 6 indicates that the node is a Shell node. The value 99 indicates that the node is a zero load node.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'NodeId' => ['description' => 'The node ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'InGroupId' => ['description' => 'The ID of the scheduling cycle of the instance. Valid values: 1 to 288.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Runs' => [ + 'description' => 'The running records of the instance.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status of the instance. Valid values: NOT_RUN, WAIT_TIME, WAIT_RESOURCE, RUNNING, CHECKING, CHECKING_CONDITION, FAILURE, and SUCCESS. The value NOT_RUN indicates that the instance is not run. The value WAIT_TIME indicates that the instance is waiting to be run. The value WAIT_RESOURCE indicates that the instance is waiting for resources. The value RUNNING indicates that the instance is running. The value CHECKING indicates that data quality is being checked for the instance. The value CHECKING_CONDITION indicates that branch conditions are being checked for the instance. The value FAILURE indicates that the instance fails to run. The value SUCCESS indicates that the instance is run.'."\n", 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'AbsTime' => ['description' => 'The timestamp obtained by adding the predicted time when the instance started to run to the historical average running duration of the instance.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1553531402000', 'title' => ''], + 'BeginRunningTime' => ['description' => 'The timestamp of the actual time when the instance started to run.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1553531401000', 'title' => ''], + 'FinishTime' => ['description' => 'The timestamp of the actual time when the instance finished running.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1553531401000', 'title' => ''], + 'BeginCast' => ['description' => 'The timestamp of the predicted time when the instance started to run.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1553531686000', 'title' => ''], + 'EndCast' => ['description' => 'The timestamp of the predicted time when the instance finished running.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1553531687000', 'title' => ''], + 'BeginWaitResTime' => ['description' => 'The timestamp when the instance started to wait for resources.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1553531401000', 'title' => ''], + 'BeginWaitTimeTime' => ['description' => 'The timestamp when the instance started to wait for the scheduling time.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1553531400000', 'title' => ''], ], - 'FolderId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '2735c2****', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Topics' => [ + 'description' => 'The information about the events that are associated with the instance.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TopicName' => ['description' => 'The name of the event.'."\n", 'type' => 'string', 'example' => '1234', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'TopicId' => ['description' => 'The event ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'AddTime' => ['description' => 'The timestamp when the event was found.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1553531401000', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], ], 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], + ['errorCode' => 'Forbidden.Wkbench.BaselineNoPermission', 'errorMessage' => 'You are not authorized to access the baseline.', 'description' => ''], + ['errorCode' => 'Forbidden.Wkbench.ProjectNoPermission', 'errorMessage' => 'You are not authorized to access the workspace.', 'description' => ''], + ['errorCode' => 'Forbidden.Not.Server', 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.', 'description' => ''], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'Invalid.Wkbench.BaselineStatusNotExist', 'errorMessage' => 'The BaselineStatus does not exist.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 13,\\n \\"Folders\\": [\\n {\\n \\"FolderPath\\": \\"Business_process/my_first_business_process/MaxCompute/ods_layer\\",\\n \\"FolderId\\": \\"2735c2****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"0000-ABCD-EFG****\\n200\\n\\n 13\\n 10\\n 1\\n \\n 业务流程/我的第一个业务流程/MaxCompute/ods层\\n 2735c2****\\n \\n\\nInvalid.Tenant.ConnectionNotExists\\nThe connection does not exist.\\ntrue","errorExample":""}]', - 'title' => 'ListFolders', - 'summary' => 'Queries a list of folders.', + 'title' => 'GetBaselineKeyPath', + 'summary' => 'The information about the events that are associated with the instance.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeployFile' => [ - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2023-03-16T11:19:02.000Z', 'description' => 'Response parameters changed, Response parameters changed'], + ['createdAt' => '2023-01-10T12:27:18.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '299', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetBaselineKeyPath'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Owner\\": \\"9527952****\\",\\n \\"NodeName\\": \\"Node name\\",\\n \\"Bizdate\\": 1553443200000,\\n \\"ProjectId\\": 1234,\\n \\"InstanceId\\": 123456,\\n \\"PrgType\\": 10,\\n \\"NodeId\\": 1234,\\n \\"InGroupId\\": 1,\\n \\"Runs\\": [\\n {\\n \\"Status\\": \\"SUCCESS\\",\\n \\"AbsTime\\": 1553531402000,\\n \\"BeginRunningTime\\": 1553531401000,\\n \\"FinishTime\\": 1553531401000,\\n \\"BeginCast\\": 1553531686000,\\n \\"EndCast\\": 1553531687000,\\n \\"BeginWaitResTime\\": 1553531401000,\\n \\"BeginWaitTimeTime\\": 1553531400000\\n }\\n ],\\n \\"Topics\\": [\\n {\\n \\"TopicName\\": \\"1234\\",\\n \\"InstanceId\\": 1234,\\n \\"TopicId\\": 1234,\\n \\"AddTime\\": 1553531401000\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'GetBaselineStatus' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '78223', - 'abilityTreeNodes' => [ - 'FEATUREdide8FM783', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '78231', + 'abilityTreeNodes' => ['FEATUREdideSFSFU4'], ], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Management page to obtain the workspace ID. You must configure either this parameter or the ProjectIdentifier parameter to determine the DataWorks workspace to which the operation is applied.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '10000', - ], - ], - [ - 'name' => 'ProjectIdentifier', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Management page to obtain the workspace name. You must configure either this parameter or the ProjectId parameter to determine the DataWorks workspace to which the operation is applied.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dw_project', - ], - ], - [ - 'name' => 'FileId', + 'name' => 'BaselineId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The file ID. You can call the [ListFiles](~~173942~~) operation to query the file ID. You must configure either this parameter or the NodeId parameter.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'example' => '10000001', - ], + 'schema' => ['description' => 'The ID of the baseline.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1234', 'title' => ''], ], [ - 'name' => 'Comment', + 'name' => 'Bizdate', 'in' => 'formData', - 'schema' => [ - 'description' => 'The description of the deployment operation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'First release task', - ], + 'schema' => ['description' => 'The data timestamp of the baseline instance. Specify the time in the ISO 8601 standard in the yyyy-MM-dd\'T\'HH:mm:ssZ format. The time must be in UTC.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-07-07T00:00:00+0800', 'title' => ''], ], [ - 'name' => 'NodeId', + 'name' => 'InGroupId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the node in the scheduling system that corresponds to the file that you want to deploy. You must configure either the NodeId parameter or the FileId parameter.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '2000001', - ], + 'schema' => ['description' => 'The ID of the scheduling cycle of the baseline instance. For a baseline instance that is scheduled by day, the value of this parameter is 1. For a baseline instance that is scheduled by hour, the value of this parameter ranges from 1 to 24.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request. You can use the ID to troubleshoot issues.', 'type' => 'string', 'example' => '0000-ABCD-EFG****', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned.', 'type' => 'string', 'example' => 'The specified parameters are invalid.', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned.', 'type' => 'string', 'example' => '1031203110005', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'The ID of the deployment task. The ID is used as the value of a specific request parameter when you call the [GetDeployment](~~173950~~) operation to query the details of the deployment task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30000001', - ], - 'RequestId' => [ - 'description' => 'The ID of the request. You can troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', + 'description' => 'The details of the baseline instance.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status of the baseline. Valid values: ERROR, SAFE, DANGEROUS, and OVER. The value ERROR indicates that no nodes are associated with the baseline, or all nodes associated with the baseline are suspended. The value SAFE indicates that nodes finish running before the alerting time. The value DANGEROUS indicates that nodes are still running after the alerting time but before the committed completion time. The value OVER indicates that nodes are still running after the committed completion time.', 'type' => 'string', 'example' => 'SAFE', 'title' => ''], + 'Owner' => ['description' => 'The ID of the Alibaba Cloud account used by the baseline owner. Multiple IDs are separated by commas (,).', 'type' => 'string', 'example' => '9527952795****', 'title' => ''], + 'FinishTime' => ['description' => 'The timestamp of the actual time when the baseline instance finished running. This parameter is returned if the value of the FinishStatus parameter is FINISH.', 'type' => 'integer', 'format' => 'int64', 'example' => '1553443200000', 'title' => ''], + 'ProjectId' => ['description' => 'The ID of the workspace to which the baseline belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'Priority' => ['description' => 'The priority of the baseline. Valid values: 1, 2, 5, 7, and 8.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'EndCast' => ['description' => 'The timestamp of the predicted time when the baseline instance finished running.', 'type' => 'integer', 'format' => 'int64', 'example' => '1553443200000', 'title' => ''], + 'InGroupId' => ['description' => 'The ID of the scheduling cycle of the baseline instance. For a baseline instance that is scheduled by day, the value of this parameter is 1. For a baseline instance that is scheduled by hour, the value of this parameter ranges from 1 to 24.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'BaselineName' => ['description' => 'The name of the baseline.', 'type' => 'string', 'example' => 'Baseline name', 'title' => ''], + 'BaselineId' => ['description' => 'The ID of the baseline.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'FinishStatus' => ['description' => 'The status of the baseline instance. Valid values: UNFINISH and FINISH. The value UNFINISH indicates that the baseline instance is still running. The value FINISH indicates that the baseline instance finishes running.', 'type' => 'string', 'example' => 'UNFINISH', 'title' => ''], + 'Bizdate' => ['description' => 'The data timestamp of the baseline instance.', 'type' => 'integer', 'format' => 'int64', 'example' => '1553443200000', 'title' => ''], + 'Buffer' => ['description' => 'The margin of the baseline instance. Unit: seconds.', 'type' => 'number', 'format' => 'float', 'example' => '1200', 'title' => ''], + 'SlaTime' => ['description' => 'The timestamp of the committed completion time of the baseline instance.', 'type' => 'integer', 'format' => 'int64', 'example' => '1553443200000', 'title' => ''], + 'ExpTime' => ['description' => 'The timestamp of the alerting time of the baseline instance.', 'type' => 'integer', 'format' => 'int64', 'example' => '1553443200000', 'title' => ''], + 'LastInstance' => [ + 'description' => 'The information about the last generated instance.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status of the instance. Valid values: NOT\\_RUN, WAIT\\_TIME, WAIT\\_RESOURCE, RUNNING, CHECKING, CHECKING\\_CONDITION, FAILURE, and SUCCESS. The value NOT\\_RUN indicates that the instance is not run. The value WAIT\\_TIME indicates that the instance is waiting to be run. The value WAIT\\_RESOURCE indicates that the instance is waiting for resources. The value RUNNING indicates that the instance is running. The value CHECKING indicates that data quality is being checked for the instance. The value CHECKING\\_CONDITION indicates that branch conditions are being checked for the instance. The value FAILURE indicates that the instance fails to run. The value SUCCESS indicates that the instance is run.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'Owner' => ['description' => 'The ID of the Alibaba Cloud account used by the node owner.', 'type' => 'string', 'example' => '9527952795****', 'title' => ''], + 'FinishTime' => ['description' => 'The timestamp of the actual time when the instance finished running.', 'type' => 'integer', 'format' => 'int64', 'example' => '1553443200000', 'title' => ''], + 'NodeName' => ['description' => 'The name of the node.', 'type' => 'string', 'example' => 'Node name', 'title' => ''], + 'ProjectId' => ['description' => 'The ID of the workspace to which the node belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'InstanceId' => ['description' => 'The ID of the instance.', 'type' => 'integer', 'format' => 'int64', 'example' => '12345', 'title' => ''], + 'EndCast' => ['description' => 'The timestamp of the predicted time when the instance finished running.', 'type' => 'integer', 'format' => 'int64', 'example' => '1553443200000', 'title' => ''], + 'NodeId' => ['description' => 'The ID of the node.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'BlockInstance' => [ + 'description' => 'The information about the key instance.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status of the instance. Valid values: NOT\\_RUN, WAIT\\_TIME, WAIT\\_RESOURCE, RUNNING, CHECKING, CHECKING\\_CONDITION, FAILURE, and SUCCESS. The value NOT\\_RUN indicates that the instance is not run. The value WAIT\\_TIME indicates that the instance is waiting to be run. The value WAIT\\_RESOURCE indicates that the instance is waiting for resources. The value RUNNING indicates that the instance is running. The value CHECKING indicates that data quality is being checked for the instance. The value CHECKING\\_CONDITION indicates that branch conditions are being checked for the instance. The value FAILURE indicates that the instance fails to run. The value SUCCESS indicates that the instance is run.', 'type' => 'string', 'example' => 'SUCCESS', 'title' => ''], + 'Owner' => ['description' => 'The ID of the Alibaba Cloud account used by the node owner.', 'type' => 'string', 'example' => '9527952795****', 'title' => ''], + 'FinishTime' => ['description' => 'The timestamp of the actual time when the instance finished running.', 'type' => 'integer', 'format' => 'int64', 'example' => '1553443200000', 'title' => ''], + 'NodeName' => ['description' => 'The name of the node.', 'type' => 'string', 'example' => '节点名称', 'title' => ''], + 'ProjectId' => ['description' => 'The ID of the workspace to which the node belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'InstanceId' => ['description' => 'The ID of the instance.', 'type' => 'integer', 'format' => 'int64', 'example' => '12345', 'title' => ''], + 'EndCast' => ['description' => 'The timestamp of the predicted time when the instance finished running.', 'type' => 'integer', 'format' => 'int64', 'example' => '1553443200000', 'title' => ''], + 'NodeId' => ['description' => 'The ID of the node.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], ], 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], + ['errorCode' => 'Forbidden.Not.Server', 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.', 'description' => ''], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 30000001,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 30000001\\n 0000-ABCD-EFG****\\n The connection does not exist.\\n true\\n Invalid.Tenant.ConnectionNotExists\\n","errorExample":""}]', - 'title' => 'DeployFile', - 'summary' => 'Deploys a file to the production environment.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Status\\": \\"SAFE\\",\\n \\"Owner\\": \\"9527952795****\\",\\n \\"FinishTime\\": 1553443200000,\\n \\"ProjectId\\": 1234,\\n \\"Priority\\": 1,\\n \\"EndCast\\": 1553443200000,\\n \\"InGroupId\\": 1,\\n \\"BaselineName\\": \\"Baseline name\\",\\n \\"BaselineId\\": 1234,\\n \\"FinishStatus\\": \\"UNFINISH\\",\\n \\"Bizdate\\": 1553443200000,\\n \\"Buffer\\": 1200,\\n \\"SlaTime\\": 1553443200000,\\n \\"ExpTime\\": 1553443200000,\\n \\"LastInstance\\": {\\n \\"Status\\": \\"SUCCESS\\",\\n \\"Owner\\": \\"9527952795****\\",\\n \\"FinishTime\\": 1553443200000,\\n \\"NodeName\\": \\"Node name\\",\\n \\"ProjectId\\": 1234,\\n \\"InstanceId\\": 12345,\\n \\"EndCast\\": 1553443200000,\\n \\"NodeId\\": 1234\\n },\\n \\"BlockInstance\\": {\\n \\"Status\\": \\"SUCCESS\\",\\n \\"Owner\\": \\"9527952795****\\",\\n \\"FinishTime\\": 1553443200000,\\n \\"NodeName\\": \\"节点名称\\",\\n \\"ProjectId\\": 1234,\\n \\"InstanceId\\": 12345,\\n \\"EndCast\\": 1553443200000,\\n \\"NodeId\\": 1234\\n }\\n }\\n}","type":"json"}]', + 'title' => 'GetBaselineStatus', + 'summary' => 'Retrieves the status of a baseline instance.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateUdfFile' => [ - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2023-01-10T12:27:18.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '299', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetBaselineStatus'], + ], ], + 'ramActions' => [], + 'translator' => 'manual', + ], + 'GetBusiness' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '78387', - 'abilityTreeNodes' => [ - 'FEATUREdide8FM783', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '78232', + 'abilityTreeNodes' => ['FEATUREdide8FM783'], ], 'parameters' => [ - [ - 'name' => 'FileFolderPath', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The path of the folder in which the function file is stored.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'Business_process/First_Business_Process/function/string_processing_function', - ], - ], [ 'name' => 'ProjectId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the DataWorks workspace. You can click the Workspace Manage icon in the upper-right corner of the DataStudio page to go to the Workspace Management page and view the workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '10000', - ], + 'schema' => ['description' => 'The ID of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Management page to obtain the ID. You must specify either this parameter or ProjectIdentifier to determine the DataWorks workspace to which the operation is applied.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10000', 'title' => ''], ], [ - 'name' => 'FunctionType', + 'name' => 'ProjectIdentifier', 'in' => 'formData', - 'schema' => [ - 'description' => 'The type of the function. Valid values: MATH, AGGREGATE, STRING, DATE, ANALYTIC, and OTHER. This parameter corresponds to the Function Type parameter in the Register Function section of the configuration tab of the function on the DataStudio page.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [], - 'example' => 'STRING', - 'enum' => [ - 'MATH', - 'AGGREGATE', - 'STRING', - 'DATE', - 'ANALYTIC', - 'OTHER', - ], - ], + 'schema' => ['description' => 'The name of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Settings panel to obtain the name. You must specify either this parameter or ProjectId to determine the DataWorks workspace to which the operation is applied.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dw_project', 'title' => ''], ], [ - 'name' => 'ClassName', + 'name' => 'BusinessId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the class in which the function is defined. This parameter corresponds to the Class Name parameter in the Register Function section of the configuration tab of the function in the DataWorks console.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'com.alibaba.DataWorks.api.udf.StringConcat', - ], + 'schema' => ['description' => 'The workflow ID. You can call the [ListBusiness](~~173945~~) operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1000000111', 'title' => ''], ], - [ - 'name' => 'Resources', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The names of the resources that are referenced by the function. This parameter corresponds to the Resources parameter in the Register Function section of the configuration tab of the function in the DataWorks console. Separate multiple resource names with commas (,).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'string-concat-1.0.0.jar,commons-lang-2.6.jar', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'The connection does not exist.', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request. You can use the ID to troubleshoot issues.'."\n", 'type' => 'string', 'example' => '0000-ABCD-EFG****', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned.'."\n", 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The details of the workflow.'."\n", + 'type' => 'object', + 'properties' => [ + 'Owner' => ['description' => 'The Alibaba Cloud account ID of the workflow owner.'."\n", 'type' => 'string', 'example' => '20000****', 'title' => ''], + 'Description' => ['description' => 'The description of the workflow.'."\n", 'type' => 'string', 'example' => 'This is my first business process.', 'title' => ''], + 'ProjectId' => ['description' => 'The ID of the workspace to which the workflow belongs.'."\n", 'type' => 'string', 'example' => '10000', 'title' => ''], + 'BusinessId' => ['description' => 'The ID of the workflow.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1000001', 'title' => ''], + 'BusinessName' => ['description' => 'The name of the workflow.'."\n", 'type' => 'string', 'example' => 'The first business process', 'title' => ''], + 'UseType' => ['description' => 'The module to which the workflow belongs. Valid values: NORMAL and MANUAL_BIZ.'."\n", 'type' => 'string', 'example' => 'NORMAL', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'UdfDescription', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The description of the function. This parameter corresponds to the Description parameter in the Register Function section of the configuration tab of the function on the DataStudio page.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'Concatenate several strings to generate a new string', - ], + ], + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], ], - [ - 'name' => 'CmdDescription', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The syntax used for calling the function. This parameter corresponds to the Expression Syntax parameter in the Register Function section of the configuration tab of the function in the DataWorks console.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'StringConcat(String... substrs)', - ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], - [ - 'name' => 'ParameterDescription', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The description of the input parameters of the function. This parameter corresponds to the Parameter Description parameter in the Register Function section of the configuration tab of the function on the DataStudio page.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* ALL_ALLOWD'."\n" - .'* FAILURE_ALLOWED'."\n" - .'* ALL_DENIED'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'List of strings to be connected', - 'default' => 'ALL_ALLOWED', - 'enum' => [ - 'ALL_ALLOWD', - 'FAILURE_ALLOWED', - 'ALL_DENIED', - ], - ], - ], - [ - 'name' => 'ReturnValue', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The description of the return value of the function. This parameter corresponds to the Return Value parameter in the Register Function section of the configuration tab of the function on the DataStudio page.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'New strings generated by concatenating all strings before and after the input order', - 'default' => 'false', - ], - ], - [ - 'name' => 'Example', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The example for calling the function. This parameter corresponds to the Example parameter in the Register Function section of the configuration tab of the function in the DataWorks console.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'StringConcat(\'a\', \'b\', \'c\')', - ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], ], + ], + 'title' => 'GetBusiness', + 'summary' => 'Queries the information about a workflow.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Owner\\": \\"20000****\\",\\n \\"Description\\": \\"This is my first business process.\\",\\n \\"ProjectId\\": \\"10000\\",\\n \\"BusinessId\\": 1000001,\\n \\"BusinessName\\": \\"The first business process\\",\\n \\"UseType\\": \\"NORMAL\\"\\n }\\n}","type":"json"}]', + ], + 'GetDDLJobStatus' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ProjectIdentifier', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The unique identifier of the DataWorks workspace. You can click the identifier in the upper-left corner of the DataStudio page to switch to another workspace.'."\n" - ."\n" - .'You must specify either this parameter or ProjectId to determine the DataWorks workspace to which the operation is applied.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dw_project', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdideX3KVYR'], + ], + 'parameters' => [ [ - 'name' => 'FileId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The file ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '10000001', - ], + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the DDL task.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'abc', 'title' => ''], ], ], 'responses' => [ @@ -18776,83 +12977,58 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'RequestId' => [ - 'description' => 'The ID of the request. You can troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'abc', 'title' => ''], + 'Data' => [ + 'description' => 'The details of the task.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status of the task.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'NextTaskId' => ['description' => 'The ID of the ongoing task. If no value is returned for this parameter, all subtasks are complete.'."\n", 'type' => 'string', 'example' => 'abc1', 'title' => ''], + 'TaskId' => ['description' => 'The task ID.'."\n", 'type' => 'string', 'example' => 'abc', 'title' => ''], + 'Content' => ['description' => 'The content of the task.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], ], 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"0000-ABCD-EFG****\\n200\\ntrue","errorExample":""}]', - 'title' => 'UpdateUdfFile', - 'summary' => 'Updates the file information about a function.', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"abc\\",\\n \\"Data\\": {\\n \\"Status\\": \\"success\\",\\n \\"NextTaskId\\": \\"abc1\\",\\n \\"TaskId\\": \\"abc\\",\\n \\"Content\\": \\"success\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"abc\\n\\n success\\n abc\\n success\\n abc1\\n","errorExample":""}]', + 'title' => 'GetDDLJobStatus', + 'summary' => 'Queries the status of a table creation, update, or deletion task.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'GetBusiness' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'staticInfo' => ['noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。'], + ], + 'GetDIAlarmRule' => [ + 'summary' => 'Retrieves the details of an alert rule configured for a synchronization task.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -18862,1456 +13038,848 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '78232', - 'abilityTreeNodes' => [ - 'FEATUREdide8FM783', - ], + 'abilityTreeCode' => '154881', + 'abilityTreeNodes' => ['FEATUREdide39WW3A'], ], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Management page to obtain the ID. You must specify either this parameter or ProjectIdentifier to determine the DataWorks workspace to which the operation is applied.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '10000', - ], - ], - [ - 'name' => 'ProjectIdentifier', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Settings panel to obtain the name. You must specify either this parameter or ProjectId to determine the DataWorks workspace to which the operation is applied.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dw_project', - ], - ], - [ - 'name' => 'BusinessId', + 'name' => 'DIAlarmRuleId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The workflow ID. You can call the [ListBusiness](~~173945~~) operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1000000001', - ], + 'schema' => ['description' => 'The alert rule ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '34994', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'RequestId' => [ - 'description' => 'The ID of the request. You can use the ID to troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The details of the workflow.'."\n", + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '4A807D85-AC9F-55F7-A58F-998D5249CAD9'], + 'DIAlarmRule' => [ + 'description' => 'The details of the alert rule.', 'type' => 'object', 'properties' => [ - 'Owner' => [ - 'description' => 'The Alibaba Cloud account ID of the workflow owner.'."\n", - 'type' => 'string', - 'example' => '20000****', - ], - 'Description' => [ - 'description' => 'The description of the workflow.'."\n", - 'type' => 'string', - 'example' => 'This is my first business process.', - ], - 'ProjectId' => [ - 'description' => 'The ID of the workspace to which the workflow belongs.'."\n", + 'DIAlarmRuleId' => ['description' => 'The alert rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '34988', 'title' => ''], + 'DIJobId' => ['description' => 'The ID of the task with which the alert rule is associated.', 'type' => 'integer', 'format' => 'int64', 'example' => '11170', 'title' => ''], + 'Description' => ['description' => 'The description of the alert rule.', 'type' => 'string', 'example' => 'mysql synchronizes to hologres heartbeat alert', 'title' => ''], + 'MetricType' => [ + 'description' => 'The metric type in the alert rule. Valid values:'."\n" + ."\n" + .'- Heartbeat'."\n" + ."\n" + .'- FailoverCount'."\n" + ."\n" + .'- Delay', + 'enumValueTitles' => [], 'type' => 'string', - 'example' => '10000', - ], - 'BusinessId' => [ - 'description' => 'The ID of the workflow.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000001', + 'example' => 'Heartbeat', + 'title' => '', ], - 'BusinessName' => [ - 'description' => 'The name of the workflow.'."\n", - 'type' => 'string', - 'example' => 'The first business process', + 'Enabled' => ['description' => 'Indicates whether the alert rule is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'TriggerConditions' => [ + 'description' => 'The conditions that are used to trigger the alert rule.', + 'type' => 'array', + 'items' => [ + 'description' => 'The condition that is used to trigger the alert rule.', + 'type' => 'object', + 'properties' => [ + 'Severity' => [ + 'description' => 'The severity level. Valid values:'."\n" + ."\n" + .'- Warning'."\n" + ."\n" + .'- Critical', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'Warning', + 'title' => '', + ], + 'Duration' => ['description' => 'The time interval for alert calculation. Unit: minutes.', 'type' => 'integer', 'format' => 'int64', 'example' => '15', 'title' => ''], + 'Threshold' => ['description' => 'The alert threshold.'."\n" + ."\n" + .'- If the alert rule is for task status, no threshold is used.'."\n" + ."\n" + .'- If the alert rule is for failovers, specify the number of failovers.'."\n" + ."\n" + .'- If the alert rule is for latency, the threshold is the latency duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'UseType' => [ - 'description' => 'The module to which the workflow belongs. Valid values: NORMAL and MANUAL_BIZ.'."\n", - 'type' => 'string', - 'example' => 'NORMAL', + 'NotificationSettings' => [ + 'description' => 'The alert notification settings.', + 'type' => 'object', + 'properties' => [ + 'NotificationChannels' => [ + 'description' => 'The alert notification methods.', + 'type' => 'array', + 'items' => [ + 'description' => 'The alert notification method.', + 'type' => 'object', + 'properties' => [ + 'Severity' => [ + 'description' => 'The severity level. Valid values:'."\n" + ."\n" + .'- Warning'."\n" + ."\n" + .'- Critical', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'Warning', + 'title' => '', + ], + 'Channels' => [ + 'description' => 'The alert notification methods.', + 'type' => 'array', + 'items' => [ + 'description' => 'The alert notification method. Valid values:'."\n" + ."\n" + .'- Mail: email'."\n" + ."\n" + .'- Phone: phone call'."\n" + ."\n" + .'- Sms: text message'."\n" + ."\n" + .'- Ding: DingTalk chatbot token', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'Ding', + 'title' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'NotificationReceivers' => [ + 'description' => 'The alert notification recipients.', + 'type' => 'array', + 'items' => [ + 'description' => 'The alert notification recipient.', + 'type' => 'object', + 'properties' => [ + 'ReceiverType' => [ + 'description' => 'The recipient type. Valid values: AliyunUid and DingToken.'."\n" + ."\n" + .'- If the alert notification method is Mail, Phone, or Sms, the value of this parameter is **AliyunUid**, which indicates the Alibaba Cloud account ID.'."\n" + ."\n" + .'- If the alert notification method is Ding, the value of this parameter is **DingToken**, which indicates the DingTalk chatbot token.', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'DingToken', + 'title' => '', + ], + 'ReceiverValues' => [ + 'description' => 'The recipients.', + 'type' => 'array', + 'items' => ['description' => 'The recipient.'."\n" + ."\n" + .'- If the recipient type is Alibaba Cloud account ID, set this parameter to the Alibaba Cloud account ID of a user.'."\n" + ."\n" + .'- If the recipient type is DingTalk chatbot token, set this parameter to the token of a DingTalk chatbot.', 'type' => 'string', 'example' => 'token1', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'InhibitionInterval' => ['description' => 'The duration of the alert suppression interval. Unit: minutes.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'CreatedUid' => ['description' => 'The ID of the user who creates the alert rule.', 'type' => 'string', 'example' => '10000001', 'title' => ''], + 'CreatedTime' => ['description' => 'The timestamp when the alert rule was created. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1663573162', 'title' => ''], + 'UpdatedUid' => ['description' => 'The ID of the user who last updates the alert rule.', 'type' => 'string', 'example' => '10000001', 'title' => ''], + 'UpdatedTime' => ['description' => 'The timestamp when the alert rule was last updated. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1663573163', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], ], 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Owner\\": \\"20000****\\",\\n \\"Description\\": \\"This is my first business process.\\",\\n \\"ProjectId\\": \\"10000\\",\\n \\"BusinessId\\": 1000001,\\n \\"BusinessName\\": \\"The first business process\\",\\n \\"UseType\\": \\"NORMAL\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"0000-ABCD-EFG****\\n200\\n\\n 20000****\\n 这是我的第一个业务流程\\n 第一个业务流程\\n NORMAL\\n 10000\\n 1000001\\n\\nInvalid.Tenant.ConnectionNotExists\\nThe connection does not exist.\\ntrue","errorExample":""}]', - 'title' => 'GetBusiness', - 'summary' => 'Queries the information about a workflow.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'UpdateFolder' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4A807D85-AC9F-55F7-A58F-998D5249CAD9\\",\\n \\"DIAlarmRule\\": {\\n \\"DIAlarmRuleId\\": 34988,\\n \\"DIJobId\\": 11170,\\n \\"Description\\": \\"mysql synchronizes to hologres heartbeat alert\\",\\n \\"MetricType\\": \\"Heartbeat\\",\\n \\"Enabled\\": true,\\n \\"TriggerConditions\\": [\\n {\\n \\"Severity\\": \\"Warning\\",\\n \\"Duration\\": 15,\\n \\"Threshold\\": 5\\n }\\n ],\\n \\"NotificationSettings\\": {\\n \\"NotificationChannels\\": [\\n {\\n \\"Severity\\": \\"Warning\\",\\n \\"Channels\\": [\\n \\"Ding\\"\\n ]\\n }\\n ],\\n \\"NotificationReceivers\\": [\\n {\\n \\"ReceiverType\\": \\"DingToken\\",\\n \\"ReceiverValues\\": [\\n \\"token1\\"\\n ]\\n }\\n ],\\n \\"InhibitionInterval\\": 5\\n },\\n \\"CreatedUid\\": \\"10000001\\",\\n \\"CreatedTime\\": 1663573162,\\n \\"UpdatedUid\\": \\"10000001\\",\\n \\"UpdatedTime\\": 1663573163\\n }\\n}","type":"json"}]', + 'title' => 'GetDIAlarmRule', + 'description' => 'Alert rules can be configured when your task includes real-time synchronization.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDIAlarmRule'], + ], ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '78373', - 'abilityTreeNodes' => [ - 'FEATUREdide8FM783', - ], - ], - 'parameters' => [ - [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Management page to obtain the ID. You must specify either this parameter or ProjectIdentifier to determine the DataWorks workspace to which the operation is applied.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '10000', - ], - ], - [ - 'name' => 'ProjectIdentifier', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Settings panel to obtain the name. You must specify either this parameter or ProjectId to determine the DataWorks workspace to which the operation is applied.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dw_project', - ], - ], - [ - 'name' => 'FolderId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the folder. You can call the [ListFolders](~~173955~~) operation to query the ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2735c2c19d58', - ], - ], - [ - 'name' => 'FolderName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the folder.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'MySecondFolder', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'RequestId' => [ - 'description' => 'The ID of the request. You can use the ID to troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n The connection does not exist.\\n 0000-ABCD-EFG****\\n Invalid.Tenant.ConnectionNotExists\\n true\\n","errorExample":""}]', - 'title' => 'UpdateFolder', - 'summary' => 'Updates a folder.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'ramActions' => [], ], - 'ListDeployments' => [ - 'summary' => 'Queries a list of deployment packages. This operation is equivalent to viewing a list of deployment packages on the Deployment Packages page of the DataWorks console.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetDIJob' => [ + 'summary' => 'Queries the information about a new-version synchronization task created in Data Integration. The following types of synchronization tasks are supported: real-time synchronization of all data in a MySQL database to Hologres.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '100712', - 'abilityTreeNodes' => [ - 'FEATUREdide8FM783', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '154572', + 'abilityTreeNodes' => ['FEATUREdideQHGTK4'], ], 'parameters' => [ [ - 'name' => 'ProjectIdentifier', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the workspace name.'."\n" - ."\n" - .'You must configure either this parameter or the ProjectId parameter to determine the DataWorks workspace to which the operation is applied.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dw_project', - ], - ], - [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the workspace ID.'."\n" - ."\n" - .'You must configure either this parameter or the ProjectIdentifier parameter to determine the DataWorks workspace to which the operation is applied.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10000', - ], - ], - [ - 'name' => 'Creator', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the user who creates the deployment packages.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '20030****', - ], - ], - [ - 'name' => 'EndCreateTime', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The time when the deployment packages to be queried are created. This value must be a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1593877765000', - ], - ], - [ - 'name' => 'Executor', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the user who runs the deployment packages.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2003****', - ], - ], - [ - 'name' => 'EndExecuteTime', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The time when the deployment packages are run. This value must be a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1593877765000', - ], - ], - [ - 'name' => 'Status', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The status of the deployment packages. Valid values:'."\n" - ."\n" - .'* 0: The deployment packages are ready.'."\n" - .'* 1: The deployment packages are deployed.'."\n" - .'* 2: The deployment packages fail to be deployed.'."\n" - .'* 6: The deployment packages are rejected.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'Keyword', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The keyword that is contained in the names of the deployment packages. A fuzzy search is supported. After you enter a keyword, all deployment packages whose names contain the keyword are displayed.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'hello', - ], - ], - [ - 'name' => 'PageNumber', + 'name' => 'DIJobId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The ID of the synchronization task.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11588', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'WithDetails', 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'example' => '20', - ], + 'schema' => ['description' => 'Specifies whether to return detailed configuration information, including TransformationRules, TableMappings, and JobSettings. Valid values: true and false. Default value: true.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The returned result.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG', - ], 'Data' => [ - 'description' => 'The data returned.'."\n", + 'description' => 'The information about the synchronization task.'."\n", 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', + 'ProjectId' => ['description' => 'The workspace ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '22', 'title' => ''], + 'DIJobId' => ['description' => 'The ID of the synchronization task.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '11588', 'title' => ''], + 'JobName' => ['description' => 'The name of the synchronization task.'."\n", 'type' => 'string', 'example' => 'mysql_to_holo_sync_445', 'title' => ''], + 'Description' => ['description' => 'The description of the synchronization task.'."\n", 'type' => 'string', 'example' => 'Synchronize mysql to hologres'."\n", 'title' => ''], + 'MigrationType' => [ + 'description' => 'The synchronization type. Valid values:'."\n" + ."\n" + .'* FullAndRealtimeIncremental: one-time full synchronization and real-time incremental synchronization'."\n" + .'* RealtimeIncremental: real-time incremental synchronization'."\n" + .'* Full: full synchronization'."\n" + .'* OfflineIncremental: batch incremental synchronization'."\n" + .'* FullAndOfflineIncremental: one-time full synchronization and batch incremental synchronization'."\n", + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'FullAndRealtimeIncremental', + 'title' => '', ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', + 'SourceDataSourceType' => [ + 'description' => 'The source type. The value MySQL is returned.'."\n", + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'MySQL', + 'title' => '', ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '13', + 'DestinationDataSourceType' => [ + 'description' => 'The destination type. Valid values: Hologres and Hive.'."\n", + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'Hologres', + 'title' => '', ], - 'Deployments' => [ - 'description' => 'The deployment packages.'."\n", + 'SourceDataSourceSettings' => [ + 'description' => 'The settings of the source. Only a single source is supported.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The status of the deployment package. Valid values:'."\n" - ."\n" - .'* 0: The deployment package is ready.'."\n" - .'* 1: The deployment package is deployed.'."\n" - .'* 2: The deployment package fails to be deployed.'."\n" - .'* 6: The deployment package is rejected.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned when the deployment package failed.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'CreateTime' => [ - 'description' => 'The time when the deployment package was created.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1593877765000', - ], - 'Executor' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the user who ran the deployment package.'."\n", - 'type' => 'string', - 'example' => '2003****', - ], - 'Creator' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the user who created the deployment package.'."\n", - 'type' => 'string', - 'example' => '2003****', - ], - 'ExecuteTime' => [ - 'description' => 'The time when the deployment package was run. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1593877765000', - ], - 'Name' => [ - 'description' => 'The name of the deployment package.'."\n", - 'type' => 'string', - 'example' => 'auto_created', + 'DataSourceName' => ['description' => 'The name of the data source.'."\n", 'type' => 'string', 'example' => 'mysql_datasource_1', 'title' => ''], + 'DataSourceProperties' => [ + 'description' => 'The properties of the data source.'."\n", + 'type' => 'object', + 'additionalProperties' => ['description' => 'The properties of the source. The properties of a MySQL data source include TimeZone and Encoding.'."\n", 'type' => 'string', 'example' => 'TimeZone', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'Id' => [ - 'description' => 'The deployment package ID. You can call the [GetDeployment](~~173950~~) operation to obtain the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '11111', + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'DestinationDataSourceSettings' => [ + 'description' => 'The settings of the destination. Only a single destination is supported.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DataSourceName' => ['description' => 'The name of the data source.'."\n", 'type' => 'string', 'example' => 'holo_datasource_1', 'title' => ''], + 'DataSourceProperties' => [ + 'description' => 'The properties of the data source.'."\n", + 'type' => 'object', + 'additionalProperties' => ['description' => 'The properties of the destination. No properties are returned because DataWorks does not allow you to configure properties for a Hologres data source.'."\n", 'type' => 'string', 'example' => 'TimeZone', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 13,\\n \\"Deployments\\": [\\n {\\n \\"Status\\": 1,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"CreateTime\\": 1593877765000,\\n \\"Executor\\": \\"2003****\\",\\n \\"Creator\\": \\"2003****\\",\\n \\"ExecuteTime\\": 1593877765000,\\n \\"Name\\": \\"auto_created\\",\\n \\"Id\\": 11111\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 0000-ABCD-EFG\\n \\n 1\\n 10\\n 13\\n \\n 1\\n OK\\n 1593877765000\\n 2003****\\n 2003****\\n 1593877765000\\n auto_created\\n 11111\\n \\n \\n","errorExample":""}]', - 'title' => 'ListDeployments', - ], - 'UpdateIDEEventResult' => [ - 'summary' => 'Returns the check result of an extension point event to DataStudio after the extension point event is triggered during data development and checked by an extension.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '101717', - 'abilityTreeNodes' => [ - 'FEATUREdide6ZPSGN', - ], - ], - 'parameters' => [ - [ - 'name' => 'MessageId', - 'in' => 'formData', - 'schema' => [ - 'title' => '消息UUID', - 'description' => 'The message ID. You can obtain the ID from a received message when an extension point event is triggered.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '8abcb91f-d266-4073-b907-2ed670378ed1', - ], - ], - [ - 'name' => 'ExtensionCode', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The unique identifier of the extension. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Extensions tab of the Open Platform page to view the identifier.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '8abcb91f-d266-4073-b907-2ed670378ed1', - ], - ], - [ - 'name' => 'CheckResult', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The check status of the extension point event. Valid values:'."\n" - ."\n" - .'* OK: The event passes the check.'."\n" - .'* FAIL: The event fails to pass the check. You must check and handle the reported error at the earliest opportunity to ensure that your program is run as expected.'."\n" - .'* WARN: The event passes the check, but an alert is reported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'OK', - ], - ], - [ - 'name' => 'CheckResultTip', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The summary information of the check result. The information is displayed in DataStudio. If an alert is reported or the event fails the check, you can troubleshoot errors based on the information.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Succeeded', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '8abcb91f-d266-4073-b907-2ed670378ed1', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - ], - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8abcb91f-d266-4073-b907-2ed670378ed1\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 8abcb91f-d266-4073-b907-2ed670378ed1\\n","errorExample":""}]', - 'title' => 'UpdateIDEEventResult', - 'description' => "\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'GetIDEEventDetail' => [ - 'summary' => 'Queries the data snapshot of an extension point based on the ID of a message in DataWorks OpenEvent when the related extension point event is triggered.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '101710', - 'abilityTreeNodes' => [ - 'FEATUREdide8FM783', - ], - ], - 'parameters' => [ - [ - 'name' => 'MessageId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The message ID in DataWorks OpenEvent. You can obtain the ID from a received message when an extension point event is triggered.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '8abcb91f-d266-4073-b907-2ed670378ed1', - ], - ], - [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The DataWorks workspace ID. You can obtain the ID from the message.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10000', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '8abcb91f-d266-4073-b907-2ed670378ed1', - ], - 'EventDetail' => [ - 'description' => 'The data snapshot that is generated when an extension point event is triggered.'."\n" - ."\n" - .'The fields contained in data snapshots vary based on the types of the triggered extension point events. For more information, see the description of the fields.'."\n", - 'type' => 'object', - 'properties' => [ - 'FileExecutionCommand' => [ - 'description' => 'The data snapshot when the code in the file is run. This parameter is valid only if the message type is IDE_FILE_EXECUTE_BEFORE.'."\n", + 'ResourceSettings' => [ + 'description' => 'The resource settings.'."\n", 'type' => 'object', 'properties' => [ - 'FileId' => [ - 'description' => 'The file ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234123', - ], - 'DataSourceName' => [ - 'description' => 'The name of the data source with which the file is associated.'."\n", - 'type' => 'string', - 'example' => 'odps_first', - ], - 'Content' => [ - 'description' => 'The code in the file of the current version.'."\n", - 'type' => 'string', - 'example' => 'SHOW TABLES;', + 'OfflineResourceSettings' => [ + 'description' => 'The resource used for batch synchronization.'."\n", + 'type' => 'object', + 'properties' => [ + 'ResourceGroupIdentifier' => ['description' => 'The identifier of the resource group for Data Integration used for batch synchronization.'."\n", 'type' => 'string', 'example' => 'S_res_group_111_222', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'FileType' => [ - 'description' => 'The type of the code for the file. The code for files varies based on the file type. For more information, see [DataWorks nodes](~~600169~~).'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', + 'RealtimeResourceSettings' => [ + 'description' => 'The resource used for real-time synchronization.'."\n", + 'type' => 'object', + 'properties' => [ + 'ResourceGroupIdentifier' => ['description' => 'The identifier of the resource group for Data Integration used for real-time synchronization.'."\n", 'type' => 'string', 'example' => 'S_res_group_111_222', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'RequestedCu' => ['description' => 'The number of compute units (CUs) in the resource group that are used for incremental and full synchronization.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '2.0', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'DeletedFile' => [ - 'description' => 'The data snapshot when the file is deleted. This parameter is valid only if the message type is IDE_FILE_DELETE_BEFORE.'."\n", - 'type' => 'object', - 'properties' => [ - 'Owner' => [ - 'description' => 'The file owner.'."\n", - 'type' => 'string', - 'example' => '7384234****', - ], - 'FileType' => [ - 'description' => 'The type of the code for the file. The code of files varies based on the file type. For more information, see [DataWorks nodes](~~600169~~).'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'CurrentVersion' => [ - 'description' => 'The latest version number of the file.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'BusinessId' => [ - 'description' => 'The ID of the workflow to which the file belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '74328', - ], - 'FileName' => [ - 'description' => 'The name of the file.'."\n", - 'type' => 'string', - 'example' => 'hello_dataworks.sql', - ], - 'DataSourceName' => [ - 'description' => 'The name of the data source with which the file is associated.'."\n", - 'type' => 'string', - 'example' => 'odps_first', - ], - 'UseType' => [ - 'description' => 'The module to which the file belongs. Valid values:'."\n" + 'TransformationRules' => [ + 'description' => 'The list of transformation rules that are applied to the synchronization objects selected from the source. Each entry in the list defines a transformation rule.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The transformation rule that is applied to the synchronization objects selected from the source.'."\n", + 'type' => 'object', + 'properties' => [ + 'RuleActionType' => [ + 'description' => 'The action type. Valid values:'."\n" + ."\n" + .'* DefinePrimaryKey'."\n" + .'* Rename'."\n" + .'* AddColumn'."\n" + .'* HandleDml'."\n" + .'* DefineIncrementalCondition'."\n" + .'* DefineCycleScheduleSettings'."\n" + .'* DefineRuntimeSettings'."\n" + .'* DefinePartitionKey'."\n", + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'Rename', + 'title' => '', + ], + 'RuleExpression' => ['description' => 'The expression of the rule. The expression is a JSON string.'."\n" ."\n" - .'* NORMAL: The file is used for DataStudio.'."\n" - .'* MANUAL: The file is used for a manually triggered node.'."\n" - .'* MANUAL_BIZ: The file is used for a manually triggered workflow.'."\n" - .'* SKIP: The file is used for a dry-run DataStudio node.'."\n" - .'* ADHOCQUERY: The file is used for an ad hoc query.'."\n" - .'* COMPONENT: The file is used for a snippet.'."\n", - 'type' => 'string', - 'example' => 'NORMAL', - ], - 'FolderId' => [ - 'description' => 'The ID of the folder to which the file belongs. You can call the [GetFolder](~~173952~~) operation to query the details of the file based on the folder ID.'."\n", - 'type' => 'string', - 'example' => 'aldurie78l2falure', - ], - 'ParentFileId' => [ - 'description' => 'The ID of the do-while node or for-each node that corresponds to the file.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234122', - ], - 'Content' => [ - 'description' => 'The code in the file of the current version.'."\n", - 'type' => 'string', - 'example' => 'SHOW TABLES;', - ], - 'NodeId' => [ - 'description' => 'The ID of the node that is scheduled.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '421429', - ], - 'FileId' => [ - 'description' => 'The file ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234123', + .'* Example of a renaming rule: `{"expression":"${srcDatasourceName}_${srcDatabaseName}_0922","variables":\\[{"variableName":"srcDatabaseName","variableRules":\\[{"from":"fromdb","to":"todb"}\\]}\\]}`.'."\n" + ."\n" + .' * expression: the expression of the renaming rule. The expression may contain the following variables:'."\n" + ."\n" + .' * ${srcDatasourceName}'."\n" + .' * ${srcDatabaseName}'."\n" + .' * ${srcTableName}'."\n" + ."\n" + .' * variables: the generation rule for a variable used in the expression of the renaming rule. The default value of the specified variable is the original value of the object indicated by the variable. A group of string replacement rules used to change the original values may be returned.'."\n" + ."\n" + .' * variableName: the name of the variable. The variable name is not enclosed in ${}.'."\n" + .' * variableRules: the string replacement rules for variables. The system runs the string replacement rules in sequence. from indicates the original string. to indicates the new string.'."\n" + ."\n" + .'* Example of a rule used to add a specific field to the destination and assign a value to the field: `{"columns":\\[{"columnName":"my_add_column","columnValueType":"Constant","columnValue":"123"}\\]}`.'."\n" + ."\n" + .' If no rule of this type is configured, no fields are added to the destination and no values are assigned by default.'."\n" + ."\n" + .' * columnName: the name of the field that is added.'."\n" + ."\n" + .' * columnValueType: the value type of the field. Valid values: Constant and Variable.'."\n" + ."\n" + .' * columnValue: the value of the field.'."\n" + ."\n" + .' * If the value of the columnValueType parameter is Constant, the value of the columnValue parameter is a constant of the STRING data type.'."\n" + .' * If the value of the columnValueType parameter is Variable, the value of the columnValue parameter is a built-in variable. The following built-in variables are supported: EXECUTE_TIME (LONG data type), DB_NAME_SRC (STRING data type), DATASOURCE_NAME_SRC (STRING data type), TABLE_NAME_SRC (STRING data type), DB_NAME_DEST (STRING data type), DATASOURCE_NAME_DEST (STRING data type), TABLE_NAME_DEST (STRING data type), and DB_NAME_SRC_TRANSED (STRING data type). EXECUTE_TIME indicates the execution time. DB_NAME_SRC indicates the name of a source database. DATASOURCE_NAME_SRC indicates the name of the source. TABLE_NAME_SRC indicates the name of a source table. DB_NAME_DEST indicates the name of a destination database. DATASOURCE_NAME_DEST indicates the name of the destination. TABLE_NAME_DEST indicates the name of a destination table. DB_NAME_SRC_TRANSED indicates the database name obtained after a transformation.'."\n" + ."\n" + .'* Example of a rule used to specify primary key fields for a destination table: `{"columns":\\["ukcolumn1","ukcolumn2"\\]}`.'."\n" + ."\n" + .' If no rule of this type is configured, the primary key fields in the mapped source table are used for the destination table by default.'."\n" + ."\n" + .' * If the destination table is an existing table, Data Integration does not modify the schema of the destination table. If the specified primary key fields do not exist in the destination table, an error is reported when the synchronization task starts to run.'."\n" + .' * If the destination table is automatically created by the system, Data Integration automatically creates the schema of the destination table. The schema contains the primary key fields that you specify. If the specified primary key fields do not exist in the destination table, an error is reported when the synchronization task starts to run.'."\n" + ."\n" + .'* Example of a rule used to process DML messages: `{"dmlPolicies":\\[{"dmlType":"Delete","dmlAction":"Filter","filterCondition":"id > 1"}\\]}`.'."\n" + ."\n" + .' If no rule of this type is configured, the default processing policy for messages generated for insert, update, and delete operations is Normal.'."\n" + ."\n" + .' * dmlType: the DML operation. Valid values: Insert, Update, and Delete.'."\n" + .' * dmlAction: the processing policy for DML messages. Valid values: Normal, Ignore, Filter, and LogicalDelete. Filter indicates conditional processing. The value Filter is returned for the dmlAction parameter only when the value of the dmlType parameter is Update or Delete.'."\n" + .' * filterCondition: the condition used to filter DML messages. This parameter is returned only when the value of the dmlAction parameter is Filter.'."\n", 'type' => 'string', 'example' => '{"expression":"${srcDatasoureName}_${srcDatabaseName}"}', 'title' => ''], + 'RuleName' => ['description' => 'The name of the rule. If the values of the RuleActionType parameter and the RuleTargetType parameter are the same for multiple transformation rules, you must make sure that the transformation rule names are unique.'."\n", 'type' => 'string', 'example' => 'rename_rule_1', 'title' => ''], + 'RuleTargetType' => [ + 'description' => 'The type of the object on which the action is performed. Valid values:'."\n" + ."\n" + .'* Table'."\n" + .'* Schema'."\n", + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'Table', + 'title' => '', + ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'CommittedFile' => [ - 'description' => 'The data snapshot when the file is committed and deployed.'."\n" - ."\n" - .'This parameter is valid only if the message type is IDE_FILE_SUBMIT_BEFORE or IDE_FILE_DEPLOY_BEFORE.'."\n", - 'type' => 'object', - 'properties' => [ - 'FileId' => [ - 'description' => 'The file ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234123', - ], - 'Content' => [ - 'description' => 'The code in the file of the current version.'."\n", - 'type' => 'string', - 'example' => 'SHOW TABLES;', - ], - 'Committor' => [ - 'description' => 'The ID of the Alibaba Cloud account that is used to generate the file of the current version.'."\n", - 'type' => 'string', - 'example' => '7384234****', - ], - 'FileType' => [ - 'description' => 'The type of the code for the file. The code of files varies based on the file type. For more information, see [DataWorks nodes](~~600169~~).'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'ChangeType' => [ - 'description' => 'The type of the change to the file of the current version. Valid values: CREATE, UPDATE, and DELETE.'."\n", - 'type' => 'string', - 'example' => 'UPDATE', - ], - 'FileName' => [ - 'description' => 'The name of the file.'."\n", - 'type' => 'string', - 'example' => 'hello_dataworks.sql', - ], - 'NodeId' => [ - 'description' => 'The ID of the node that is scheduled.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '421429', - ], - 'Comment' => [ - 'description' => 'The description of the file version.'."\n", - 'type' => 'string', - 'example' => 'Second version submission', - ], - 'UseType' => [ - 'description' => 'The module to which the file belongs. Valid values:'."\n" - ."\n" - .'* NORMAL: The file is used for DataStudio.'."\n" - .'* MANUAL: The file is used for a manually triggered node.'."\n" - .'* MANUAL_BIZ: The file is used for a manually triggered workflow.'."\n" - .'* SKIP: The file is used for a dry-run DataStudio node.'."\n" - .'* ADHOCQUERY: The file is used for an ad hoc query.'."\n" - .'* COMPONENT: The file is used for a snippet.'."\n", - 'type' => 'string', - 'example' => 'NORMAL', - ], - 'FilePropertyContent' => [ - 'description' => 'The details of the file.'."\n", - 'type' => 'object', - 'properties' => [ - 'DataSourceName' => [ - 'description' => 'The name of the data source with which the file is associated.'."\n", - 'type' => 'string', - 'example' => 'odps_first', - ], - 'ParentFileId' => [ - 'description' => 'The ID of the do-while node or for-each node that corresponds to the file.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234122', - ], - 'BusinessId' => [ - 'description' => 'The ID of the workflow to which the file belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '74328', - ], - 'CurrentVersion' => [ - 'description' => 'The latest version number of the file.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Owner' => [ - 'description' => 'The file owner.'."\n", - 'type' => 'string', - 'example' => '7384234****', - ], - 'FolderId' => [ - 'description' => 'The ID of the folder to which the file belongs. You can call the [GetFolder](~~173952~~) operation to query the details of the file based on the folder ID.'."\n", - 'type' => 'string', - 'example' => 'aldurie78l2falure', - ], - ], - ], - 'NodeConfiguration' => [ - 'description' => 'The scheduling properties of the node that corresponds to the file.'."\n", - 'type' => 'object', - 'properties' => [ - 'RerunMode' => [ - 'description' => 'Indicates whether the node that corresponds to the file can be rerun. Valid values:'."\n" - ."\n" - .'* ALL_ALLOWED: The node can be rerun regardless of whether it is successfully run or fails to run.'."\n" - .'* FAILURE_ALLOWED: The node can be rerun only after it fails to run.'."\n" - .'* ALL_DENIED: The node cannot be rerun regardless of whether it is successfully run or fails to run.'."\n" - ."\n" - .'This parameter corresponds to the Rerun parameter in the Schedule section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'string', - 'example' => 'ALL_ALLOWED', - ], - 'SchedulerType' => [ - 'description' => 'The scheduling type of the node. Valid values:'."\n" - ."\n" - .'* NORMAL: The node is an auto triggered node.'."\n" - .'* MANUAL: The node is a manually triggered node. Manually triggered nodes cannot be automatically triggered. They correspond to the nodes in the Manually Triggered Workflows pane.'."\n" - .'* PAUSE: The node is a paused node.'."\n" - .'* SKIP: The node is a dry-run node. Dry-run nodes are started as scheduled, but the system sets the status of the nodes to successful when it starts to run them.'."\n", - 'type' => 'string', - 'example' => 'NORMAL', - ], - 'ParaValue' => [ - 'description' => 'The scheduling parameters of the node.'."\n" - ."\n" - .'This parameter corresponds to the Scheduling Parameter section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console). For more information about the configurations of the scheduling parameters, see [Configure scheduling parameters](~~137548~~).'."\n", - 'type' => 'string', - 'example' => 'a=x b=y', - ], - 'CycleType' => [ - 'description' => 'The type of the scheduling cycle of the node that corresponds to the file. Valid values: NOT_DAY and DAY. The value NOT_DAY indicates that the node is scheduled to run by minute or hour. The value DAY indicates that the node is scheduled to run by day, week, or month.'."\n" - ."\n" - .'This parameter corresponds to the Scheduling Cycle parameter in the Schedule section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'string', - 'example' => 'DAY', - ], - 'DependentNodeIdList' => [ - 'description' => 'The ID of the node on which the node that corresponds to the file depends when the DependentType parameter is set to USER_DEFINE. Multiple IDs are separated by commas (,).'."\n" - ."\n" - .'The value of this parameter is equivalent to the ID of the node that you specified after you select Other Nodes for Cross-Cycle Dependency (Original Previous-Cycle Dependency) in the Dependencies section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'string', - 'example' => '5,10,15,20', - ], - 'ResourceGroupId' => [ - 'description' => 'The ID of the resource group that is used to run the node that corresponds to the file. You can call the [ListResourceGroups](~~173913~~) operation to query the available resource groups in the workspace.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '375827434852437', - ], - 'AutoRerunTimes' => [ - 'description' => 'The number of times that the node corresponding to the file can be rerun.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'AutoRerunIntervalMillis' => [ - 'description' => 'The interval at which the node corresponding to the file is rerun. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '120000', - ], - 'CronExpress' => [ - 'description' => 'The CRON expression that is used to schedule the node corresponding to the file.'."\n", - 'type' => 'string', - 'example' => '00 05 00 * * ?', - ], - 'InputList' => [ - 'description' => 'The output names of the parent files on which the current file depends.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The output information about the parent files on which the current file depends.'."\n", - 'type' => 'object', - 'properties' => [ - 'Input' => [ - 'description' => 'The output name of the parent file on which the current file depends.'."\n" - ."\n" - .'This parameter corresponds to the Output Name of Ancestor Node parameter under Parent Nodes in the Dependencies section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'string', - 'example' => 'dw_project_root', - ], - 'ParseType' => [ - 'description' => 'The mode of the configuration file dependency. Valid values:'."\n" - ."\n" - .'* MANUAL: Scheduling dependencies are manually configured.'."\n" - .'* AUTO: Scheduling dependencies are automatically parsed.'."\n", - 'type' => 'string', - 'example' => 'MANUAL', - ], + 'TableMappings' => [ + 'description' => 'The list of mappings between rules used to select synchronization objects in the source and transformation rules applied to the selected synchronization objects. Each entry in the list displays a mapping between a rule used to select synchronization objects and a transformation rule applied to the selected synchronization objects.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The mapping between a rule used to select synchronization objects in the source and a transformation rule applied to the selected synchronization objects.'."\n", + 'type' => 'object', + 'properties' => [ + 'SourceObjectSelectionRules' => [ + 'description' => 'The list of rules used to select synchronization objects in the source.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The rule used to select synchronization objects in the source. The objects can be databases or tables.'."\n", + 'type' => 'object', + 'properties' => [ + 'Expression' => ['description' => 'The expression.'."\n", 'type' => 'string', 'example' => 'mysql_table_1', 'title' => ''], + 'ObjectType' => [ + 'description' => 'The object type. Valid values:'."\n" + ."\n" + .'* Table'."\n" + .'* Database'."\n", + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'Table', + 'title' => '', ], ], + 'title' => '', + 'example' => '', ], - 'OutputList' => [ - 'description' => 'The output names of the current file.'."\n" - ."\n" - .'This parameter corresponds to the Output Name of Current Node parameter in the Dependencies section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The output information about the current file.'."\n", - 'type' => 'object', - 'properties' => [ - 'RefTableName' => [ - 'description' => 'The output table name of the current file.'."\n" - ."\n" - .'This parameter corresponds to the Output Table Name parameter under Output Name of Current Node in the Dependencies section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'string', - 'example' => 'ods_user_info_d', - ], - 'Output' => [ - 'description' => 'The output name of the current file.'."\n" - ."\n" - .'This parameter corresponds to the Output Name parameter under Output Name of Current Node in the Dependencies section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'string', - 'example' => 'dw_project.002_out', - ], + 'title' => '', + 'example' => '', + ], + 'TransformationRules' => [ + 'description' => 'The list of transformation rules that are applied to the synchronization objects selected from the source.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The transformation rule that is applied to the synchronization objects selected from the source.'."\n", + 'type' => 'object', + 'properties' => [ + 'RuleActionType' => [ + 'description' => 'The action type. Valid values:'."\n" + ."\n" + .'* DefinePrimaryKey'."\n" + .'* Rename'."\n" + .'* AddColumn'."\n" + .'* HandleDml'."\n" + .'* DefineIncrementalCondition'."\n" + .'* DefineCycleScheduleSettings'."\n" + .'* DefineRuntimeSettings'."\n" + .'* DefinePartitionKey'."\n", + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'Rename', + 'title' => '', + ], + 'RuleName' => ['description' => 'The name of the rule. If the values of the RuleActionType parameter and the RuleTargetType parameter are the same for multiple transformation rules, you must make sure that the transformation rule names are unique.'."\n", 'type' => 'string', 'example' => 'rename_rule_1', 'title' => ''], + 'RuleTargetType' => [ + 'description' => 'The type of the object on which the action is performed. Valid values:'."\n" + ."\n" + .'* Table'."\n" + .'* Schema'."\n", + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'Table', + 'title' => '', ], ], + 'title' => '', + 'example' => '', ], - 'DependentType' => [ - 'description' => 'The type of the cross-cycle scheduling dependency of the node. Valid values:'."\n" - ."\n" - .'* SELF: The instance generated for the node in the current cycle depends on the instance generated for the node in the previous cycle.'."\n" - .'* CHILD: The instance generated for the node in the current cycle depends on the instances generated for the descendant nodes at the nearest level of the node in the previous cycle.'."\n" - .'* USER_DEFINE: The instance generated for the node in the current cycle depends on the instances generated for one or more specified nodes in the previous cycle.'."\n" - .'* NONE: No cross-cycle scheduling dependency type is selected for the node.'."\n", - 'type' => 'string', - 'example' => 'USER_DEFINE', - ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'TableModel' => [ - 'description' => 'The data snapshot when the table is committed and deployed. This parameter is valid only if the message type is IDE_TABLE_SUBMIT_BEFORE or IDE_TABLE_DEPLOY_BEFORE.'."\n", + 'JobSettings' => [ + 'description' => 'The settings for the dimension of the synchronization task. The settings include processing policies for DDL messages, policies for data type mappings between source fields and destination fields, and runtime parameters of the synchronization task.'."\n", 'type' => 'object', 'properties' => [ - 'Env' => [ - 'description' => 'The environment in which the table is used. Valid values:'."\n" - ."\n" - .'* DEV'."\n" - .'* PROD'."\n", - 'type' => 'string', - 'example' => 'DEV', - ], - 'LifeCycle' => [ - 'description' => 'The lifecycle of the metatable. Unit: day.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '7', - ], - 'TableName' => [ - 'description' => 'The name of the table.'."\n", - 'type' => 'string', - 'example' => 'tb_hello', - ], - 'DataSourceName' => [ - 'description' => 'The name of the data source to which the table belongs.'."\n", - 'type' => 'string', - 'example' => 'odps_first', + 'ColumnDataTypeSettings' => [ + 'description' => 'The settings for data type mappings between source fields and destination fields. The value of this parameter is an array.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SourceDataType' => ['description' => 'The data type of a source field.'."\n", 'type' => 'string', 'example' => 'bigint', 'title' => ''], + 'DestinationDataType' => ['description' => 'The data type of a destination field.'."\n", 'type' => 'string', 'example' => 'text', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'Columns' => [ - 'description' => 'The columns in the table.'."\n", + 'DdlHandlingSettings' => [ + 'description' => 'The settings for processing DDL messages. The value of this parameter is an array.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'The column in the table.'."\n", + 'description' => 'The processing setting for a specific type of DDL message.'."\n", 'type' => 'object', 'properties' => [ - 'ColumnName' => [ - 'description' => 'The name of the column.'."\n", + 'Action' => [ + 'description' => 'The processing policy. Valid values:'."\n" + ."\n" + .'* Ignore: ignores a DDL message.'."\n" + .'* Critical: reports an error for a DDL message.'."\n" + .'* Normal: normally processes a DDL message.'."\n", + 'enumValueTitles' => [], 'type' => 'string', - 'example' => 'ID', + 'example' => 'Critical', + 'title' => '', ], - 'ColumnType' => [ - 'description' => 'The data type of the column.'."\n", + 'Type' => [ + 'description' => 'The type of the DDL operation. Valid values:'."\n" + ."\n" + .'* RenameColumn'."\n" + .'* ModifyColumn'."\n" + .'* CreateTable'."\n" + .'* TruncateTable'."\n" + .'* DropTable'."\n" + .'* DropColumn'."\n" + .'* AddColumn'."\n", + 'enumValueTitles' => [], 'type' => 'string', - 'example' => 'BIGINT', + 'example' => 'AddColumn', + 'title' => '', ], - 'IsPartitionColumn' => [ - 'description' => 'Indicates whether the column is a partition key column. Valid values:'."\n" + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'RuntimeSettings' => [ + 'description' => 'The runtime settings. The value of this parameter is an array.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The runtime setting.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the configuration item. Valid values:'."\n" ."\n" - .'* true: The column is a partition key column.'."\n" - .'* false: The column is not a partition key column.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'Comment' => [ - 'description' => 'The remarks of the column.'."\n", + .'* runtime.offline.speed.limit.mb: indicates the maximum transmission rate that is allowed for a batch synchronization task. This configuration item takes effect only when runtime.offline.speed.limit.enable is set to true.'."\n" + .'* runtime.offline.speed.limit.enable: indicates whether throttling is enabled for a batch synchronization task.'."\n" + .'* dst.offline.connection.max: indicates the maximum number of connections that are allowed for writing data to the destination of a batch synchronization task.'."\n" + .'* runtime.offline.concurrent: indicates the maximum number of parallel threads that are allowed for a batch synchronization task.'."\n" + .'* dst.realtime.connection.max: indicates the maximum number of connections that are allowed for writing data to the destination of a real-time synchronization task.'."\n" + .'* runtime.enable.auto.create.schema: indicates whether schemas are automatically created in the destination of a synchronization task.'."\n" + .'* src.offline.datasource.max.connection: indicates the maximum number of connections that are allowed for reading data from the source of a batch synchronization task.'."\n" + .'* runtime.realtime.concurrent: indicates the maximum number of parallel threads that are allowed for a real-time synchronization task.'."\n", + 'enumValueTitles' => [], 'type' => 'string', - 'example' => 'ID', + 'example' => 'runtime.offline.concurrent', + 'title' => '', ], + 'Value' => ['description' => 'The value of the configuration item.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'Comment' => [ - 'description' => 'The remarks of the table.'."\n", - 'type' => 'string', - 'example' => 'A new table', - ], - 'Location' => [ - 'description' => 'The path of the table.'."\n", - 'type' => 'string', - 'example' => 'hdfs://path/to/object', + 'CycleScheduleSettings' => [ + 'description' => 'The settings for periodic scheduling.'."\n", + 'type' => 'object', + 'properties' => [ + 'CycleMigrationType' => ['description' => 'The synchronization type that requires periodic scheduling. Valid values:'."\n" + ."\n" + .'* Full: full synchronization'."\n" + .'* OfflineIncremental: batch incremental synchronization'."\n", 'type' => 'string', 'example' => 'Full', 'title' => ''], + 'ScheduleParameters' => ['description' => 'The scheduling parameters.'."\n", 'type' => 'string', 'example' => 'bizdate=$bizdate', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'ChannelSettings' => ['description' => 'The channel control settings for the synchronization task. The value of this parameter is a JSON string.'."\n", 'type' => 'string', 'example' => '{"structInfo":"MANAGED","storageType":"TEXTFILE","writeMode":"APPEND","partitionColumns":[{"columnName":"pt","columnType":"STRING","comment":""}],"fieldDelimiter":""}'."\n", 'title' => ''], ], + 'title' => '', + 'example' => '', + ], + 'CreatedTime' => ['description' => 'The timestamp when the synchronization task was created. The timestamp is accurate to the second.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1671516776', 'title' => ''], + 'CreatedUid' => ['description' => 'The ID of the user who creates the synchronization task.'."\n", 'type' => 'string', 'example' => '100000001', 'title' => ''], + 'UpdatedTime' => ['description' => 'The timestamp when the synchronization task was last modified. The timestamp is accurate to the second.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1673859985', 'title' => ''], + 'UpdatedUid' => ['description' => 'The ID of the user who last modifies the synchronization task.'."\n", 'type' => 'string', 'example' => '100000001', 'title' => ''], + 'StartedTime' => ['description' => 'The timestamp when the synchronization task was last started. The timestamp is accurate to the second.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1673859999', 'title' => ''], + 'StartedUid' => ['description' => 'The ID of the user who last starts the synchronization task.'."\n", 'type' => 'string', 'example' => '100000001', 'title' => ''], + 'JobStatus' => [ + 'description' => 'The status of the synchronization task. Valid values:'."\n" + ."\n" + .'* Finished'."\n" + .'* Initialized'."\n" + .'* Stopped'."\n" + .'* Failed'."\n" + .'* Running'."\n" + .'* Stopping'."\n", + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'Finished', + 'title' => '', + ], + 'ErrorMessage' => ['description' => 'The error message returned if the value of the JobStatus parameter is Failed.'."\n", 'type' => 'string', 'example' => 'error details xxx', 'title' => ''], + 'RunStats' => [ + 'description' => 'The information about the running of the synchronization task.'."\n", + 'type' => 'object', + 'additionalProperties' => ['description' => 'The detailed statistics on the running of the synchronization task.'."\n" + ."\n" + .'* StructureMigrationTotalTables: the total number of tables whose schemas need to be migrated.'."\n" + .'* StructureMigrationSuccessTables: the number of tables whose schemas are successfully migrated.'."\n" + .'* StructureMigrationFailedTables: the number of tables whose schemas fail to be migrated.'."\n" + .'* StructureMigrationStatus: the status of schema migration. Valid values: Waiting, Running, Finished, Failed, and Stopped.'."\n" + .'* StructureMigrationErrorMessage: the error message returned for schema migration.'."\n" + .'* FullMigrationTotalTables: the total number of tables whose full data needs to be synchronized.'."\n" + .'* FullMigrationSuccessTables: the number of tables whose full data is successfully synchronized.'."\n" + .'* FullMigrationFailedTables: the number of tables whose full data fails to be synchronized.'."\n" + .'* FullMigrationStatus: the status of full synchronization.'."\n" + .'* FullMigrationErrorMessage: the error message returned for full synchronization.'."\n" + .'* RealtimeMigrationMaxDelay: the latency of real-time synchronization. Unit: milliseconds.'."\n" + .'* RealtimeMigrationStatus: the status of real-time synchronization.'."\n" + .'* RealtimeMigrationErrorMessage: the error message returned for real-time synchronization.'."\n", 'type' => 'string', 'example' => 'StructureMigrationTotalTables', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0000-ABCD-EFG****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - ], - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8abcb91f-d266-4073-b907-2ed670378ed1\\",\\n \\"EventDetail\\": {\\n \\"FileExecutionCommand\\": {\\n \\"FileId\\": 1234123,\\n \\"DataSourceName\\": \\"odps_source\\",\\n \\"Content\\": \\"SHOW TABLES;\\",\\n \\"FileType\\": 10\\n },\\n \\"DeletedFile\\": {\\n \\"Owner\\": \\"7384234****\\",\\n \\"FileType\\": 10,\\n \\"CurrentVersion\\": 1,\\n \\"BusinessId\\": 74328,\\n \\"FileName\\": \\"hello_dataworks.sql\\",\\n \\"DataSourceName\\": \\"odps_source\\",\\n \\"UseType\\": \\"NORMAL\\",\\n \\"FolderId\\": \\"aldurie78l2falure\\",\\n \\"ParentFileId\\": 1234122,\\n \\"Content\\": \\"SHOW TABLES;\\",\\n \\"NodeId\\": 421429,\\n \\"FileId\\": 1234123\\n },\\n \\"CommittedFile\\": {\\n \\"FileId\\": 1234123,\\n \\"Content\\": \\"SHOW TABLES;\\",\\n \\"Committor\\": \\"7384234****\\",\\n \\"FileType\\": 10,\\n \\"ChangeType\\": \\"UPDATE\\",\\n \\"FileName\\": \\"hello_dataworks.sql\\",\\n \\"NodeId\\": 421429,\\n \\"Comment\\": \\"Second version submission\\",\\n \\"UseType\\": \\"NORMAL\\",\\n \\"FilePropertyContent\\": {\\n \\"DataSourceName\\": \\"odps_source\\",\\n \\"ParentFileId\\": 1234122,\\n \\"BusinessId\\": 74328,\\n \\"CurrentVersion\\": 1,\\n \\"Owner\\": \\"7384234****\\",\\n \\"FolderId\\": \\"aldurie78l2falure\\"\\n },\\n \\"NodeConfiguration\\": {\\n \\"RerunMode\\": \\"ALL_ALLOWED\\",\\n \\"SchedulerType\\": \\"NORMAL\\",\\n \\"ParaValue\\": \\"a=x b=y\\",\\n \\"CycleType\\": \\"DAY\\",\\n \\"DependentNodeIdList\\": \\"5,10,15,20\\",\\n \\"ResourceGroupId\\": 375827434852437,\\n \\"AutoRerunTimes\\": 3,\\n \\"AutoRerunIntervalMillis\\": 120000,\\n \\"CronExpress\\": \\"00 05 00 * * ?\\",\\n \\"InputList\\": [\\n {\\n \\"Input\\": \\"dw_project_root\\",\\n \\"ParseType\\": \\"MANUAL\\"\\n }\\n ],\\n \\"OutputList\\": [\\n {\\n \\"RefTableName\\": \\"ods_user_info_d\\",\\n \\"Output\\": \\"dw_project.002_out\\"\\n }\\n ],\\n \\"DependentType\\": \\"USER_DEFINE\\"\\n }\\n },\\n \\"TableModel\\": {\\n \\"Env\\": \\"DEV\\",\\n \\"LifeCycle\\": 7,\\n \\"TableName\\": \\"tb_hello\\",\\n \\"DataSourceName\\": \\"odps_source\\",\\n \\"Columns\\": [\\n {\\n \\"ColumnName\\": \\"ID\\",\\n \\"ColumnType\\": \\"BIGINT\\",\\n \\"IsPartitionColumn\\": false,\\n \\"Comment\\": \\"ID\\"\\n }\\n ],\\n \\"Comment\\": \\"A new table\\",\\n \\"Location\\": \\"hdfs://path/to/object\\"\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 8abcb91f-d266-4073-b907-2ed670378ed1\\n \\n \\n 1234123\\n odps_source\\n SHOW TABLES;\\n 10\\n \\n \\n 7384234****\\n 10\\n 1\\n 74328\\n hello_dataworks.sql\\n odps_source\\n NORMAL\\n aldurie78l2falure\\n 1234122\\n SHOW TABLES;\\n 421429\\n 1234123\\n \\n \\n 1234123\\n SHOW TABLES;\\n 7384234****\\n 10\\n UPDATE\\n hello_dataworks.sql\\n 421429\\n 第二次版本提交\\n NORMAL\\n \\n odps_source\\n 1234122\\n 74328\\n 1\\n 7384234****\\n aldurie78l2falure\\n \\n \\n ALL_ALLOWED\\n NORMAL\\n a=x b=y\\n DAY\\n 5,10,15,20\\n 375827434852437\\n 3\\n 120000\\n 00 05 00 * * ?\\n \\n dw_project_root\\n MANUAL\\n \\n \\n ods_user_info_d\\n dw_project.002_out\\n \\n USER_DEFINE\\n \\n \\n \\n DEV\\n 7\\n tb_hello\\n odps_source\\n \\n ID\\n BIGINT\\n false\\n ID\\n \\n 新建的一张表。\\n hdfs://path/to/object\\n \\n \\n","errorExample":""}]', - 'title' => 'GetIDEEventDetail', - 'description' => "\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'CreateResourceFile' => [ - 'summary' => 'Creates or uploads a resource file in DataStudio. The feature that is implemented by calling this operation is the same as the resource creation feature provided in the integrated development environment (IDE).', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], + 'title' => 'GetDIJob', + 'changeSet' => [ + ['createdAt' => '2024-06-04T02:51:15.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-01-18T10:25:13.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '185133', - 'abilityTreeNodes' => [ - 'FEATUREdide8FM783', - 'FEATUREdideJ3TPTK', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDIJob'], ], ], - 'parameters' => [ - [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID. You must configure this parameter to specify the DataWorks workspace to which the operation is applied.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'minimum' => '0', - 'example' => '10000', - ], - ], - [ - 'name' => 'FileFolderPath', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The path of the file.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Business_process/First_Business_Process/MaxCompute/Folder_1/Folder_2', - ], - ], - [ - 'name' => 'FileName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the file.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'File name', - ], - ], - [ - 'name' => 'FileType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The type of the code for the file. The code for files varies based on the file type. For more information, see [DataWorks nodes](~~600169~~).'."\n" - ."\n" - .'You can call the [ListFileType](~~212428~~) operation to query the type of the code for the file.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'minimum' => '0', - 'example' => '10', - ], - ], - [ - 'name' => 'FileDescription', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The description of the file.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'This is a description', - ], - ], + 'ramActions' => [ [ - 'name' => 'Owner', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The Alibaba Cloud User ID of the file owner. If this parameter is empty, the caller\'s Alibaba cloud user ID is used by default.', - 'type' => 'string', - 'required' => false, - 'example' => '1000000000001', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"ProjectId\\": 22,\\n \\"DIJobId\\": 11588,\\n \\"JobName\\": \\"mysql_to_holo_sync_445\\",\\n \\"Description\\": \\"Synchronize mysql to hologres\\\\n\\",\\n \\"MigrationType\\": \\"FullAndRealtimeIncremental\\",\\n \\"SourceDataSourceType\\": \\"MySQL\\",\\n \\"DestinationDataSourceType\\": \\"Hologres\\",\\n \\"SourceDataSourceSettings\\": [\\n {\\n \\"DataSourceName\\": \\"mysql_datasource_1\\",\\n \\"DataSourceProperties\\": {\\n \\"key\\": \\"TimeZone\\"\\n }\\n }\\n ],\\n \\"DestinationDataSourceSettings\\": [\\n {\\n \\"DataSourceName\\": \\"holo_datasource_1\\",\\n \\"DataSourceProperties\\": {\\n \\"key\\": \\"TimeZone\\"\\n }\\n }\\n ],\\n \\"ResourceSettings\\": {\\n \\"OfflineResourceSettings\\": {\\n \\"ResourceGroupIdentifier\\": \\"S_res_group_111_222\\"\\n },\\n \\"RealtimeResourceSettings\\": {\\n \\"ResourceGroupIdentifier\\": \\"S_res_group_111_222\\"\\n },\\n \\"RequestedCu\\": 2\\n },\\n \\"TransformationRules\\": [\\n {\\n \\"RuleActionType\\": \\"Rename\\",\\n \\"RuleExpression\\": \\"{\\\\\\"expression\\\\\\":\\\\\\"${srcDatasoureName}_${srcDatabaseName}\\\\\\"}\\",\\n \\"RuleName\\": \\"rename_rule_1\\",\\n \\"RuleTargetType\\": \\"Table\\"\\n }\\n ],\\n \\"TableMappings\\": [\\n {\\n \\"SourceObjectSelectionRules\\": [\\n {\\n \\"Expression\\": \\"mysql_table_1\\",\\n \\"ObjectType\\": \\"Table\\"\\n }\\n ],\\n \\"TransformationRules\\": [\\n {\\n \\"RuleActionType\\": \\"Rename\\",\\n \\"RuleName\\": \\"rename_rule_1\\",\\n \\"RuleTargetType\\": \\"Table\\"\\n }\\n ]\\n }\\n ],\\n \\"JobSettings\\": {\\n \\"ColumnDataTypeSettings\\": [\\n {\\n \\"SourceDataType\\": \\"bigint\\",\\n \\"DestinationDataType\\": \\"text\\"\\n }\\n ],\\n \\"DdlHandlingSettings\\": [\\n {\\n \\"Action\\": \\"Critical\\",\\n \\"Type\\": \\"AddColumn\\"\\n }\\n ],\\n \\"RuntimeSettings\\": [\\n {\\n \\"Name\\": \\"runtime.offline.concurrent\\",\\n \\"Value\\": \\"1\\"\\n }\\n ],\\n \\"CycleScheduleSettings\\": {\\n \\"CycleMigrationType\\": \\"Full\\",\\n \\"ScheduleParameters\\": \\"bizdate=$bizdate\\"\\n },\\n \\"ChannelSettings\\": \\"{\\\\\\"structInfo\\\\\\":\\\\\\"MANAGED\\\\\\",\\\\\\"storageType\\\\\\":\\\\\\"TEXTFILE\\\\\\",\\\\\\"writeMode\\\\\\":\\\\\\"APPEND\\\\\\",\\\\\\"partitionColumns\\\\\\":[{\\\\\\"columnName\\\\\\":\\\\\\"pt\\\\\\",\\\\\\"columnType\\\\\\":\\\\\\"STRING\\\\\\",\\\\\\"comment\\\\\\":\\\\\\"\\\\\\"}],\\\\\\"fieldDelimiter\\\\\\":\\\\\\"\\\\\\"}\\\\n\\"\\n },\\n \\"CreatedTime\\": 1671516776,\\n \\"CreatedUid\\": \\"100000001\\",\\n \\"UpdatedTime\\": 1673859985,\\n \\"UpdatedUid\\": \\"100000001\\",\\n \\"StartedTime\\": 1673859999,\\n \\"StartedUid\\": \\"100000001\\",\\n \\"JobStatus\\": \\"Finished\\",\\n \\"ErrorMessage\\": \\"error details xxx\\",\\n \\"RunStats\\": {\\n \\"key\\": \\"StructureMigrationTotalTables\\"\\n }\\n },\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\"\\n}","type":"json"}]', + ], + 'GetDISyncInstanceInfo' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Content', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The code for the file. The code format varies based on the file type. To view the code format for a specific file type, go to Operation Center, right-click a node of the file type, and then select View Code.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SHOW TABLES;', - ], + 'AK' => [], ], [ - 'name' => 'ResourceFile', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The OSS URL for uploading files provided by POP.', - 'type' => 'string', - 'required' => false, - 'example' => 'http://bucketname1.oss-cn-shanghai.aliyuncs.com/example', - 'isFileTransferUrl' => true, - ], + 'PrivateKey' => [], ], [ - 'name' => 'OriginResourceName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the original resource file.', - 'type' => 'string', - 'required' => true, - 'example' => 'origin_file_name.sql', - ], + 'APP' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'UploadMode', - 'in' => 'formData', - 'schema' => [ - 'description' => 'File resource Upload mode. Currently, only files of the File type of MaxCompute are valid. The values are as follows:'."\n" - ."\n" - .'- true: The Resource mode that can be downloaded.'."\n" - .'- false: The text mode for online editing.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to query the ID.'."\n" + ."\n" + .'You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '10000000000', 'minimum' => '1', 'example' => '10000', 'title' => ''], ], [ - 'name' => 'RegisterToCalcEngine', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Whether to synchronously Upload resources to the computing engine.', - 'type' => 'boolean', - 'required' => true, - 'example' => 'false', - ], + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the object that you want to query. Valid values:'."\n" + ."\n" + .'* DI_REALTIME: real-time synchronization task'."\n" + .'* DI_SOLUTION: data synchronization solution'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DI_REALTIME', 'title' => ''], ], [ - 'name' => 'StorageURL', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The storage path of the resource file on the computing engine. Currently, only EMR and CDH use this field. EMR format is [oss | hdfs]:// path/to/object. CDH must be/user/admin/lib by default.', - 'type' => 'string', - 'required' => false, - 'example' => 'oss://oss-cn-shanghai.aliyuncs.com/emr-test', - ], + 'name' => 'FileId', + 'in' => 'query', + 'schema' => ['description' => '* If you set the TaskType parameter to DI_REALTIME, set the FileId parameter to the ID of the real-time synchronization task that you want to query.'."\n" + .'* If you set the TaskType parameter to DI_SOLUTION, set the FileId parameter to the ID of the data synchronization solution that you want to query.'."\n" + ."\n" + .'You can call the [ListFiles](~~173942~~) operation to query the ID of the real-time synchronization task or data synchronization solution.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9999999999999999', 'minimum' => '1', 'example' => '100', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0bc1411515937635973****', 'title' => ''], 'Data' => [ - 'description' => 'The ID of the file after it is created.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000001', - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request. You can use the ID to locate logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG', + 'description' => 'The status of the real-time synchronization task or data synchronization solution.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => '* If the TaskType parameter is set to DI_REALTIME, the Status parameter indicates the status of the real-time synchronization task. Valid values: PAUSE, NORUN, RUN, KILLING, and WAIT.'."\n" + .'* If the TaskType parameter is set to DI_SOLUTION, the Status parameter indicates the status of the data synchronization solution. Valid values: success and fail.'."\n", 'type' => 'string', 'example' => 'RUN', 'title' => ''], + 'Message' => ['description' => 'The cause of the failure to obtain the status of the real-time synchronization task or data synchronization solution. If the status of the real-time synchronization task or data synchronization solution is obtained, the value null is returned.'."\n", 'type' => 'string', 'example' => 'fileId[100] is invalid', 'title' => ''], + 'Name' => ['description' => '* If the TaskType parameter is set to DI_REALTIME, the Name parameter indicates the name of the real-time synchronization task.'."\n" + .'* If the TaskType parameter is set to DI_SOLUTION, the value null is returned.'."\n", 'type' => 'string', 'example' => 'streamx_name', 'title' => ''], + 'SolutionInfo' => [ + 'description' => '* If the TaskType parameter is set to DI_REALTIME, the value null is returned.'."\n" + .'* If the TaskType parameter is set to DI_SOLUTION, the SolutionInfo parameter indicates the details of the data synchronization solution.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status of the data synchronization solution.'."\n", 'type' => 'string', 'example' => 'run', 'title' => ''], + 'Id' => ['description' => 'The ID of the data synchronization solution.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'CreatorName' => ['description' => 'The creator of the data synchronization solution.'."\n", 'type' => 'string', 'example' => 'dataworks_3h1', 'title' => ''], + 'StepDetail' => [ + 'description' => 'The step details of the data synchronization solution.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status of the step in the data synchronization solution.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'StepId' => ['description' => 'The ID of the step in the data synchronization solution.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'StepName' => ['description' => 'The name of the step in the data synchronization solution.'."\n", 'type' => 'string', 'example' => 'Create a base table', 'title' => ''], + 'Info' => ['description' => 'The information of the data synchronization solution.'."\n", 'type' => 'string', 'example' => '{\\"fusionProps\\":{\\"dataSource\\":[{\\"fileName\\":\\"holo_20221020161613\\",\\"status\\":\\"SUCCESS\\"}]},\\"customProps\\":{\\"showSN\\":true,\\"columns\\":[{\\"dataIndex\\":\\"fileName\\",\\"width\\":0.8,\\"title\\":\\"Real-time synchronization name\\"},{\\"dataIndex\\":\\"status\\",\\"width\\":0.2,\\"title\\":\\"Status\\"}]},\\"componentName\\":\\"Table\\"}', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + 400 => [ + ['errorCode' => 'Param.Invalid', 'errorMessage' => 'The parameter is invalid.', 'description' => 'Param invalid'], ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal error occurred.', 'description' => 'InternalError '], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'GetDISyncInstanceInfo', + 'summary' => 'Queries the status of a real-time synchronization task or a data synchronization solution.', + 'changeSet' => [ + ['createdAt' => '2022-09-14T09:22:47.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-09-14T09:22:47.000Z', 'description' => 'Response parameters changed'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": 1000001,\\n \\"RequestId\\": \\"0000-ABCD-EFG\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 1000001\\n 0000-ABCD-EFG\\n","errorExample":""}]', - 'title' => 'CreateResourceFile', - ], - 'CreateDISyncTask' => [ - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0bc1411515937635973****\\",\\n \\"Data\\": {\\n \\"Status\\": \\"RUN\\",\\n \\"Message\\": \\"fileId[100] is invalid\\",\\n \\"Name\\": \\"streamx_name\\",\\n \\"SolutionInfo\\": {\\n \\"Status\\": \\"run\\",\\n \\"Id\\": 100,\\n \\"CreatorName\\": \\"dataworks_3h1\\",\\n \\"StepDetail\\": [\\n {\\n \\"Status\\": \\"success\\",\\n \\"StepId\\": 1,\\n \\"StepName\\": \\"Create a base table\\",\\n \\"Info\\": \\"{\\\\\\\\\\\\\\"fusionProps\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"dataSource\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"fileName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"holo_20221020161613\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"status\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"SUCCESS\\\\\\\\\\\\\\"}]},\\\\\\\\\\\\\\"customProps\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"showSN\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"columns\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"dataIndex\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"fileName\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"width\\\\\\\\\\\\\\":0.8,\\\\\\\\\\\\\\"title\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Real-time synchronization name\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"dataIndex\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"status\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"width\\\\\\\\\\\\\\":0.2,\\\\\\\\\\\\\\"title\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Status\\\\\\\\\\\\\\"}]},\\\\\\\\\\\\\\"componentName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Table\\\\\\\\\\\\\\"}\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]', + ], + 'GetDISyncTask' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -20323,1031 +13891,1086 @@ 'PrivateKey' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '93925', - 'abilityTreeNodes' => [ - 'FEATUREdideBP0OJZ', - ], + 'abilityTreeCode' => '93929', + 'abilityTreeNodes' => ['FEATUREdideC95Y41'], ], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '10000000000', - 'minimum' => '1', - 'example' => '10000', - ], + 'schema' => ['description' => 'The ID of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the workspace ID.'."\n" + ."\n" + .'You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '10000000000', 'minimum' => '1', 'example' => '10000', 'title' => ''], ], [ 'name' => 'TaskType', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the data synchronization task. Valid values: DI_OFFLINE, DI_REALTIME, and DI_SOLUTION.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'DI_OFFLINE', - ], - ], - [ - 'name' => 'TaskContent', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The script content of the data synchronization task.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '{"type":"job","version":"2.0","steps":[{"stepType":"mysql","parameter":{"envType":1,"datasource":"mysql_pub","column":["id","name","create_time","age","score","t_01"],"connection":[{"datasource":"mysql_pub","table":["u_pk"]}],"where":"","splitPk":"id","encoding":"UTF-8"},"name":"Reader","category":"reader"},{"stepType":"odps","parameter":{"partition":"pt=${bizdate}","truncate":true,"datasource":"odps_source","envType":1,"column":["id","name","create_time","age","score","t_01"],"emptyAsNull":false,"tableComment":"null","table":"u_pk"},"name":"Writer","category":"writer"}],"setting":{"executeMode":null,"errorLimit":{"record":""},"speed":{"concurrent":2,"throttle":false}},"order":{"hops":[{"from":"Reader","to":"Writer"}]}}', - 'default' => '', - ], - ], - [ - 'name' => 'TaskParam', - 'in' => 'query', - 'schema' => [ - 'description' => 'The configuration parameters of the data synchronization task. The following parameters are supported:'."\n" - ."\n" - .'* FileFolderPath: the storage path of the data synchronization task.'."\n" - .'* ResourceGroup: the identifier of the resource group for Data Integration that is used by the data synchronization task. You can call the [ListResourceGroups](~~173913~~) operation to query the identifier of the resource group.'."\n" - .'* Cu: the specifications occupied by the data synchronization task in the serverless resource group. The value of this parameter must be a multiple of 0.5.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '{"FileFolderPath":"Business Flow/XXX/Data Integration","ResourceGroup":"S_res_group_XXX_XXXX"}', - ], - ], - [ - 'name' => 'TaskName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the data synchronization task.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'new_di_task', - ], + 'schema' => ['description' => 'The type of the object that you want to query. Valid values:'."\n" + ."\n" + .'- DI\\_REALTIME: real-time synchronization task'."\n" + ."\n" + .'- DI\\_SOLUTION: data synchronization solution', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DI_REALTIME', 'title' => ''], ], [ - 'name' => 'ClientToken', + 'name' => 'FileId', 'in' => 'query', - 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request. This parameter can be left empty.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0000-ABCD-EFG****', - ], + 'schema' => ['description' => '- If you set TaskType to DI\\_REALTIME, set this parameter to the ID of the real-time synchronization task that you want to deploy.'."\n" + ."\n" + .'- If you set TaskType to DI\\_SOLUTION, set this parameter to the ID of the data synchronization solution that you want to deploy.'."\n" + ."\n" + .'You can call the [ListFiles](~~173942~~) operation to query the ID of the real-time synchronization task or data synchronization solution.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9999999999999999', 'minimum' => '1', 'example' => '100', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0bc1411515937635973****', - ], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- True'."\n" + ."\n" + .'- False', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.', 'type' => 'string', 'example' => '0bc1411515937635973**** ', 'title' => ''], 'Data' => [ - 'description' => 'The information that indicates whether the data synchronization task is created.'."\n", + 'description' => 'The returned results.', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The creation status of the data synchronization task. Valid values:'."\n" - ."\n" - .'* success'."\n" - .'* fail'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Message' => [ - 'description' => 'The error message that is returned if the data synchronization task fails to be created. If the data synchronization task is successfully created, this parameter is not returned. If the data synchronization task fails to be created, an error message in the "Invalid path: Workflow/xxxx/Data Integration" format is returned.'."\n", - 'type' => 'string', - 'example' => 'Invalid path: Business Flow/xxxx/Data Integration', - ], - 'FileId' => [ - 'description' => 'The ID of the data synchronization task that is created.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000001', - ], - ], - ], - ], - 'description' => '', - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Invalid.DI.Parameter', - 'errorMessage' => 'The parameter is invalid.', - ], - [ - 'errorCode' => 'Invalid.DI.Parameter.File.Existed', - 'errorMessage' => 'The file name already exists.', - ], - ], - 403 => [ - [ - 'errorCode' => 'Forbidden.DI.NoPrivilege', - 'errorMessage' => 'No access.', + 'Code' => ['description' => '- If the TaskType parameter is set to DI\\_REALTIME, the details of the real-time synchronization task are returned.'."\n" + ."\n" + .'- If the TaskType parameter is set to DI\\_SOLUTION, the value null is returned.', 'type' => 'string', 'example' => '{"extend":{"mode":"wizard","resourceGroup":"S_res_group_287114642182658_1560324290517"},"nodeDef":{},"order":{"hops":[{"from":"datahub_8htXSsfiS2vtZCVG","to":"datahub_CRHBAyGfhSaLmv2f"}]},"setting":{"errorLimit":{},"jvmOption":""},"steps":[{"stepType":"datahub","category":"writer","displayName":"DataHub1","parameter":{"batchSize":1000,"datasource":"datahub_cloud_dev_test","topic":"dwd_tfc_opt_speed_rid_amap_rt"},"name":"datahub_CRHBAyGfhSaLmv2f","gui":{"x":262,"y":325}},{"stepType":"datahub","displayName":"DataHub2","parameter":{"datasource":"datahub_uric_test","topic":"dwd_tfc_opt_speed_rid_amap_rt_330000","batchSize":1000},"name":"datahub_8htXSsfiS2vtZCVG","gui":{"x":268,"y":160.5},"category":"writer"}]}', 'title' => ''], + 'Status' => ['description' => 'Indicates whether the details of the real-time synchronization task or data synchronization solution are obtained. Valid values:'."\n" + ."\n" + .'success: The details are obtained. fail: The details fail to be obtained.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Message' => ['description' => 'The cause of the failure to obtain the details of the real-time synchronization task or data synchronization solution.'."\n" + ."\n" + .'If the details of the real-time synchronization task or data synchronization solution are obtained, the value null is returned.', 'type' => 'string', 'example' => 'fileId:[100] is invalid.', 'title' => ''], + 'AlarmList' => [ + 'description' => 'The alert rules that are associated with the real-time synchronization task. The value of this parameter is an array.', + 'type' => 'array', + 'items' => [ + 'description' => 'The alert rule that is associated with the real-time synchronization task.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the alert rule.', 'type' => 'integer', 'format' => 'int64', 'example' => '45242', 'title' => ''], + 'Enabled' => ['description' => 'Indicates whether the alert rule is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RuleName' => ['description' => 'The name of the alert rule.', 'type' => 'string', 'example' => 'Delay alert rule name 1', 'title' => ''], + 'Metric' => ['description' => 'The alert type. Valid values:'."\n" + ."\n" + .'- taskStatus'."\n" + ."\n" + .'- bizDelay'."\n" + ."\n" + .'- taskFailoverCount'."\n" + ."\n" + .'- ddlUnsupport'."\n" + ."\n" + .'- ddlReport'."\n" + ."\n" + .'- totalDirtyRecordWriteInLines', 'type' => 'string', 'example' => 'taskStatus', 'title' => ''], + 'Description' => ['description' => 'The description of the alert rule.', 'type' => 'string', 'example' => 'Description', 'title' => ''], + 'AlarmRuleList' => [ + 'description' => 'The alert notification settings. The value of this parameter is an array.', + 'type' => 'array', + 'items' => [ + 'description' => 'The alert notification setting.', + 'type' => 'object', + 'properties' => [ + 'Level' => ['description' => '- WARNING'."\n" + ."\n" + .'- CRITICAL', 'type' => 'string', 'example' => 'WARNING', 'title' => ''], + 'Comparator' => ['description' => 'The comparison operator, which indicates the method used to compare a metric with the alert rule.'."\n" + ."\n" + .'- \'=\''."\n" + ."\n" + .'- \'<\''."\n" + ."\n" + .'- \'>\'', 'type' => 'string', 'example' => '=', 'title' => ''], + 'Threshold' => ['description' => 'The threshold for the comparison between a metric and the alert rule.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Duration' => ['description' => 'The duration that a condition is met before an alert is triggered. Unit: minutes.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'Aggregator' => ['description' => 'The calculation method of a metric. Valid values:'."\n" + ."\n" + .'- avg'."\n" + ."\n" + .'- max', 'type' => 'string', 'example' => 'avg', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'NotifyRule' => [ + 'description' => 'The settings for alert notification rules. The value of this parameter is an array.', + 'type' => 'object', + 'properties' => [ + 'Interval' => ['description' => 'The alert interval. Unit: minutes.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], + 'Warning' => [ + 'description' => 'The settings for Warning-level alert notifications.', + 'type' => 'array', + 'items' => ['description' => 'The alert notification method. Valid values:'."\n" + ."\n" + .'- Mail'."\n" + ."\n" + .'- Phone'."\n" + ."\n" + .'- Sms'."\n" + ."\n" + .'- Ding', 'type' => 'string', 'example' => 'Ding', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Critical' => [ + 'description' => 'The settings for Critical-level alert notifications.', + 'type' => 'array', + 'items' => ['description' => 'The alert notification method. Valid values:'."\n" + ."\n" + .'- Mail'."\n" + ."\n" + .'- Phone'."\n" + ."\n" + .'- Sms'."\n" + ."\n" + .'- Ding', 'type' => 'string', 'example' => 'Ding', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'SolutionDetail' => [ + 'description' => '- If the TaskType parameter is set to DI\\_REALTIME, the value null is returned.'."\n" + ."\n" + .'- If the TaskType parameter is set to DI\\_SOLUTION, the details of the data synchronization solution are returned.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status of the data synchronization solution. Valid values:'."\n" + ."\n" + .'- 0: successful'."\n" + ."\n" + .'- 1: not running'."\n" + ."\n" + .'- 2: running'."\n" + ."\n" + .'- 3: failed'."\n" + ."\n" + .'- 4: committed'."\n" + ."\n" + .'- 5: pending manual confirmation'."\n" + ."\n" + .'- 6: manually confirmed'."\n" + ."\n" + .'- 7: others'."\n" + ."\n" + .'- 8: waiting'."\n" + ."\n" + .'- 9: deleted', 'type' => 'string', 'example' => '0', 'title' => ''], + 'Type' => ['description' => 'The type of the data synchronization solution.', 'type' => 'string', 'example' => 'holo', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the data synchronization solution.', 'type' => 'string', 'example' => '2021-12-07 14:40:51', 'title' => ''], + 'CreatorName' => ['description' => 'The creator of the data synchronization solution.', 'type' => 'string', 'example' => 'dataworks_di', 'title' => ''], + 'ProjectId' => ['description' => 'The ID of the project to which the data synchronization solution belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'title' => ''], + 'SourceType' => ['description' => 'The type of the source of the data synchronization solution.', 'type' => 'string', 'example' => 'mysql', 'title' => ''], + 'ProcessContent' => ['description' => 'The configuration details of the data synchronization solution.', 'type' => 'string', 'example' => '{"holoDatasource":"holo","offlineSyncConfig":{"nodeNameRule":"oneclick_holo_di_${db_table_name_src}_to_${db_table_name_dest}","resourceGroup":"group_219193793999490"},"processRuleId":1007,"readerConcurrent":10,"realtimeSyncConfig":{"content":{"order":{"hops":[{"from":"reader","to":"writer"}]},"setting":{"speed":{"readerConcurrent":10}},"steps":[{"stepType":"mysql","name":"reader","category":"reader","parameter":{"connection":[{"datasource":"mm","datasourceType":"mysql","table":[]}]}},{"stepType":"holo","name":"writer","category":"writer","parameter":{"datasource":"holo","writeMode":"replay","datasourceSchema":"public","tableMappingRule":{"datasource":[{"tableRule":[],"srcDatasourceName":"mm"}]}}}]},"extend":{"mode":"migration_holo","resourceGroup":"group_219193793999490"}},"setting":{"autoCreateWorkflow":true,"userDefinedFileNameExpression":"oneclick"},"srcType":"mysql","tableMappingRuleFromRealtimeSyncConfig":{"datasource":[{"srcDatasourceName":"mm","tableRule":[]}]}}', 'title' => ''], + 'Name' => ['description' => 'The name of the data synchronization solution.', 'type' => 'string', 'example' => 'holo_20211206161025', 'title' => ''], + 'ProcessExtra' => ['description' => 'The additional parameters of the data synchronization solution.', 'type' => 'string', 'example' => '{"processType":"new","tableNum":300}', 'title' => ''], + 'SubmitTime' => ['description' => 'The time when the data synchronization solution was committed.', 'type' => 'string', 'example' => '2021-12-07 14:40:51', 'title' => ''], + 'Id' => ['description' => 'The ID of the data synchronization solution.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Param.Invalid', 'errorMessage' => 'The parameter is invalid.', 'description' => 'Param invalid'], + ], + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden.', 'description' => ''], + ], 500 => [ - [ - 'errorCode' => 'InternalError.DI.Parameter', - 'errorMessage' => 'A DI internal error occurred.', - ], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal error occurred.', 'description' => 'InternalError '], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0bc1411515937635973****\\",\\n \\"Data\\": {\\n \\"Status\\": \\"success\\",\\n \\"Message\\": \\"不合法的目录路径：业务流程/xxxx/数据集成\\",\\n \\"FileId\\": 1000001\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 0bc1411515937635973****\\n \\n success\\n 1000001\\n \\n","errorExample":""}]', - 'title' => 'CreateDISyncTask', - 'summary' => 'Creates a data synchronization task.', - 'description' => 'You cannot configure scheduling properties for a task by calling this operation. If you want to configure scheduling properties for a task, you can call the UpdateFile operation.[](~~2780137~~)'."\n", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0bc1411515937635973****\\\\t\\",\\n \\"Data\\": {\\n \\"Code\\": \\"{\\\\\\"extend\\\\\\":{\\\\\\"mode\\\\\\":\\\\\\"wizard\\\\\\",\\\\\\"resourceGroup\\\\\\":\\\\\\"S_res_group_287114642182658_1560324290517\\\\\\"},\\\\\\"nodeDef\\\\\\":{},\\\\\\"order\\\\\\":{\\\\\\"hops\\\\\\":[{\\\\\\"from\\\\\\":\\\\\\"datahub_8htXSsfiS2vtZCVG\\\\\\",\\\\\\"to\\\\\\":\\\\\\"datahub_CRHBAyGfhSaLmv2f\\\\\\"}]},\\\\\\"setting\\\\\\":{\\\\\\"errorLimit\\\\\\":{},\\\\\\"jvmOption\\\\\\":\\\\\\"\\\\\\"},\\\\\\"steps\\\\\\":[{\\\\\\"stepType\\\\\\":\\\\\\"datahub\\\\\\",\\\\\\"category\\\\\\":\\\\\\"writer\\\\\\",\\\\\\"displayName\\\\\\":\\\\\\"DataHub1\\\\\\",\\\\\\"parameter\\\\\\":{\\\\\\"batchSize\\\\\\":1000,\\\\\\"datasource\\\\\\":\\\\\\"datahub_cloud_dev_test\\\\\\",\\\\\\"topic\\\\\\":\\\\\\"dwd_tfc_opt_speed_rid_amap_rt\\\\\\"},\\\\\\"name\\\\\\":\\\\\\"datahub_CRHBAyGfhSaLmv2f\\\\\\",\\\\\\"gui\\\\\\":{\\\\\\"x\\\\\\":262,\\\\\\"y\\\\\\":325}},{\\\\\\"stepType\\\\\\":\\\\\\"datahub\\\\\\",\\\\\\"displayName\\\\\\":\\\\\\"DataHub2\\\\\\",\\\\\\"parameter\\\\\\":{\\\\\\"datasource\\\\\\":\\\\\\"datahub_uric_test\\\\\\",\\\\\\"topic\\\\\\":\\\\\\"dwd_tfc_opt_speed_rid_amap_rt_330000\\\\\\",\\\\\\"batchSize\\\\\\":1000},\\\\\\"name\\\\\\":\\\\\\"datahub_8htXSsfiS2vtZCVG\\\\\\",\\\\\\"gui\\\\\\":{\\\\\\"x\\\\\\":268,\\\\\\"y\\\\\\":160.5},\\\\\\"category\\\\\\":\\\\\\"writer\\\\\\"}]}\\",\\n \\"Status\\": \\"success\\",\\n \\"Message\\": \\"fileId:[100] is invalid.\\",\\n \\"AlarmList\\": [\\n {\\n \\"Id\\": 45242,\\n \\"Enabled\\": true,\\n \\"RuleName\\": \\"Delay alert rule name 1\\",\\n \\"Metric\\": \\"taskStatus\\",\\n \\"Description\\": \\"Description\\",\\n \\"AlarmRuleList\\": [\\n {\\n \\"Level\\": \\"WARNING\\",\\n \\"Comparator\\": \\"=\\",\\n \\"Threshold\\": 1,\\n \\"Duration\\": 3,\\n \\"Aggregator\\": \\"avg\\"\\n }\\n ],\\n \\"NotifyRule\\": {\\n \\"Interval\\": 5,\\n \\"Warning\\": [\\n \\"Ding\\"\\n ],\\n \\"Critical\\": [\\n \\"Ding\\"\\n ]\\n }\\n }\\n ],\\n \\"SolutionDetail\\": {\\n \\"Status\\": \\"0\\",\\n \\"Type\\": \\"holo\\",\\n \\"StartTime\\": \\"2021-12-07 14:40:51\\",\\n \\"CreatorName\\": \\"dataworks_di\\",\\n \\"ProjectId\\": 10000,\\n \\"SourceType\\": \\"mysql\\",\\n \\"ProcessContent\\": \\"{\\\\\\"holoDatasource\\\\\\":\\\\\\"holo\\\\\\",\\\\\\"offlineSyncConfig\\\\\\":{\\\\\\"nodeNameRule\\\\\\":\\\\\\"oneclick_holo_di_${db_table_name_src}_to_${db_table_name_dest}\\\\\\",\\\\\\"resourceGroup\\\\\\":\\\\\\"group_219193793999490\\\\\\"},\\\\\\"processRuleId\\\\\\":1007,\\\\\\"readerConcurrent\\\\\\":10,\\\\\\"realtimeSyncConfig\\\\\\":{\\\\\\"content\\\\\\":{\\\\\\"order\\\\\\":{\\\\\\"hops\\\\\\":[{\\\\\\"from\\\\\\":\\\\\\"reader\\\\\\",\\\\\\"to\\\\\\":\\\\\\"writer\\\\\\"}]},\\\\\\"setting\\\\\\":{\\\\\\"speed\\\\\\":{\\\\\\"readerConcurrent\\\\\\":10}},\\\\\\"steps\\\\\\":[{\\\\\\"stepType\\\\\\":\\\\\\"mysql\\\\\\",\\\\\\"name\\\\\\":\\\\\\"reader\\\\\\",\\\\\\"category\\\\\\":\\\\\\"reader\\\\\\",\\\\\\"parameter\\\\\\":{\\\\\\"connection\\\\\\":[{\\\\\\"datasource\\\\\\":\\\\\\"mm\\\\\\",\\\\\\"datasourceType\\\\\\":\\\\\\"mysql\\\\\\",\\\\\\"table\\\\\\":[]}]}},{\\\\\\"stepType\\\\\\":\\\\\\"holo\\\\\\",\\\\\\"name\\\\\\":\\\\\\"writer\\\\\\",\\\\\\"category\\\\\\":\\\\\\"writer\\\\\\",\\\\\\"parameter\\\\\\":{\\\\\\"datasource\\\\\\":\\\\\\"holo\\\\\\",\\\\\\"writeMode\\\\\\":\\\\\\"replay\\\\\\",\\\\\\"datasourceSchema\\\\\\":\\\\\\"public\\\\\\",\\\\\\"tableMappingRule\\\\\\":{\\\\\\"datasource\\\\\\":[{\\\\\\"tableRule\\\\\\":[],\\\\\\"srcDatasourceName\\\\\\":\\\\\\"mm\\\\\\"}]}}}]},\\\\\\"extend\\\\\\":{\\\\\\"mode\\\\\\":\\\\\\"migration_holo\\\\\\",\\\\\\"resourceGroup\\\\\\":\\\\\\"group_219193793999490\\\\\\"}},\\\\\\"setting\\\\\\":{\\\\\\"autoCreateWorkflow\\\\\\":true,\\\\\\"userDefinedFileNameExpression\\\\\\":\\\\\\"oneclick\\\\\\"},\\\\\\"srcType\\\\\\":\\\\\\"mysql\\\\\\",\\\\\\"tableMappingRuleFromRealtimeSyncConfig\\\\\\":{\\\\\\"datasource\\\\\\":[{\\\\\\"srcDatasourceName\\\\\\":\\\\\\"mm\\\\\\",\\\\\\"tableRule\\\\\\":[]}]}}\\",\\n \\"Name\\": \\"holo_20211206161025\\",\\n \\"ProcessExtra\\": \\"{\\\\\\"processType\\\\\\":\\\\\\"new\\\\\\",\\\\\\"tableNum\\\\\\":300}\\",\\n \\"SubmitTime\\": \\"2021-12-07 14:40:51\\",\\n \\"Id\\": 100\\n }\\n }\\n}","type":"json"}]', + 'title' => 'GetDISyncTask', + 'summary' => 'Retrieves the details of a synchronization task or a data synchronization solution.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteDISyncTask' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2025-01-13T02:51:15.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], - 'security' => [ - [ - 'AK' => [], - ], + 'ramActions' => [ [ - 'PrivateKey' => [], + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], + ], + ], + 'GetDag' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'APP' => [], + 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', + 'abilityTreeCode' => '78234', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB'], ], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the workspace ID.'."\n" - ."\n" - .'You must configure this parameter to specify the DataWorks workspace to which the operation is applied.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '10000000000', - 'minimum' => '1', - 'example' => '10000', - ], + 'name' => 'DagId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the DAG. You can use one of the following method to obtain the ID:'."\n" + ."\n" + .'- Call the [RunCycleDagNodes](~~2780209~~) operation and obtain the value of the **Data** response parameter.'."\n" + ."\n" + .'- Call the [RunSmokeTest](~~2780210~~) operation and obtain the value of the **Data** response parameter.'."\n" + ."\n" + .'- Call the [RunManualDagNodes](~~2780218~~) operation and obtain the value of the **DagId** response parameter.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '2', 'example' => '123141452344525', 'title' => ''], ], [ - 'name' => 'TaskType', - 'in' => 'query', + 'name' => 'ProjectEnv', + 'in' => 'formData', 'schema' => [ - 'description' => 'The type of the task. Set the value to DI_REALTIME, which indicates a real-time synchronization task.'."\n", + 'description' => 'The environment of the workspace. Valid values: PROD and DEV.', 'type' => 'string', 'required' => true, 'docRequired' => true, - 'example' => 'DI_REALTIME', - ], - ], - [ - 'name' => 'FileId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the real-time synchronization task. You can call the [ListFiles](~~173942~~) operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9999999999999999', - 'minimum' => '1', - 'example' => '100', + 'enum' => ['PROD', 'DEV'], + 'example' => 'PROD', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The returned result.'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => '0bc1411515937635973****', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7782a299-b291-4fee-8424-cf8058efa8e8', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The connection does not exist.', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'The deletion result.'."\n", + 'description' => 'The details of the DAG.', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'Indicates whether the synchronization task is deleted. Valid values:'."\n" - ."\n" - .'* success: The synchronization task is deleted.'."\n" - .'* fail: The synchronization task fails to be deleted. You can troubleshoot the issue based on the failure reason.'."\n", - 'type' => 'string', - 'example' => 'fail', - ], - 'Message' => [ - 'description' => 'The reason why the synchronization task fails to be deleted. If the synchronization task is deleted, the value null is returned for this parameter.'."\n", - 'type' => 'string', - 'example' => 'fileId:[100] is invalid.', - ], - ], + 'Type' => ['description' => 'The type of the DAG. Valid values: MANUAL, SMOKE\\_TEST, SUPPLY\\_DATA, and BUSINESS\\_PROCESS\\_DAG. The value MANUAL indicates the DAG for a manually triggered workflow. The value SMOKE\\_TEST indicates the DAG for a smoke testing workflow. The value SUPPLY\\_DATA indicates the DAG for a data backfill instance. The value BUSINESS\\_PROCESS\\_DAG indicates the DAG for a one-time workflow.', 'type' => 'string', 'example' => 'MANUAL_FLOW', 'title' => ''], + 'Status' => ['description' => 'The status of the DAG. Valid values: CREATED, RUNNING, FAILURE, and SUCCESS.', 'type' => 'string', 'example' => 'FAILURE', 'title' => ''], + 'FinishTime' => ['description' => 'The time when the DAG finished running.', 'type' => 'integer', 'format' => 'int64', 'example' => '1605052800000', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the DAG was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1605052800000', 'title' => ''], + 'ProjectId' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '112345', 'title' => ''], + 'DagId' => ['description' => 'The DAG ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '351249682', 'title' => ''], + 'Gmtdate' => ['description' => 'The time when the DAG was scheduled to run.', 'type' => 'integer', 'format' => 'int64', 'example' => '1605052800000', 'title' => ''], + 'StartTime' => ['description' => 'The time when the DAG started to run.', 'type' => 'integer', 'format' => 'int64', 'example' => '1605052800000', 'title' => ''], + 'CreateUser' => ['description' => 'The creator.', 'type' => 'string', 'example' => '1736629400048545', 'title' => ''], + 'Bizdate' => ['description' => 'The data timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1605052800000', 'title' => ''], + 'Name' => ['description' => 'The name of the DAG.', 'type' => 'string', 'example' => 'test_dag', 'title' => ''], + 'ModifyTime' => ['description' => 'The time when the DAG was last modified.', 'type' => 'integer', 'format' => 'int64', 'example' => '1605052800000', 'title' => ''], + 'OpSeq' => ['description' => 'The sequence number of the operation.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Param.Invalid', - 'errorMessage' => 'The parameter is invalid.', - ], - ], - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal error occurred.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"7782a299-b291-4fee-8424-cf8058efa8e8\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Type\\": \\"MANUAL_FLOW\\",\\n \\"Status\\": \\"FAILURE\\",\\n \\"FinishTime\\": 1605052800000,\\n \\"CreateTime\\": 1605052800000,\\n \\"ProjectId\\": 112345,\\n \\"DagId\\": 351249682,\\n \\"Gmtdate\\": 1605052800000,\\n \\"StartTime\\": 1605052800000,\\n \\"CreateUser\\": \\"1736629400048545\\",\\n \\"Bizdate\\": 1605052800000,\\n \\"Name\\": \\"test_dag\\",\\n \\"ModifyTime\\": 1605052800000,\\n \\"OpSeq\\": 123\\n }\\n}","type":"json"}]', + 'title' => 'GetDag', + 'summary' => 'Queries the information about a directed acyclic graph (DAG). You can call the GetDag operation to query the information about the DAG for a manually triggered workflow, a manually triggered node, or a data backfill instance. However, you cannot query the information about the DAG for an auto triggered node or an auto triggered workflow.', + 'description' => 'Supported DAG types:'."\n" + ."\n" + .'- MANUAL: DAG for a manually triggered workflow'."\n" + ."\n" + .'- SMOKE\\_TEST: DAG for a smoke testing workflow'."\n" + ."\n" + .'- SUPPLY\\_DATA: DAG for a data backfill instance'."\n" + ."\n" + .'- BUSINESS\\_PROCESS\\_DAG: DAG for a one-time workflow'."\n" + ."\n" + .'Supported DAG states:'."\n" + ."\n" + .'- CREATED: The DAG is created.'."\n" + ."\n" + .'- RUNNING: The DAG is running.'."\n" + ."\n" + .'- FAILURE: The DAG fails to run.'."\n" + ."\n" + .'- SUCCESS: The DAG is successfully run.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0bc1411515937635973****\\",\\n \\"Data\\": {\\n \\"Status\\": \\"fail\\",\\n \\"Message\\": \\"fileId:[100] is invalid.\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 0bc1411515937635973****\\n \\n fail\\n fileId:[100] is invalid.\\n \\n","errorExample":""}]', - 'title' => 'DeleteDISyncTask', - 'summary' => 'Deletes a synchronization task. You can call this operation to delete only a real-time synchronization task.', - 'description' => 'If you want to delete a batch synchronization task, call the DeleteFile operation. For more information, see [Delete a synchronization task](~~321443~~).'."\n", ], - 'UpdateDISyncTask' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetDataServiceApi' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'APP' => [], - ], - [ - 'PrivateKey' => [], - ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '78371', - 'abilityTreeNodes' => [ - 'FEATUREdideBP0OJZ', - ], + 'abilityTreeCode' => '78235', + 'abilityTreeNodes' => ['FEATUREdide7T0EJX'], ], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the workspace ID. You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '10000000000', - 'minimum' => '1', - 'example' => '10000', - ], - ], - [ - 'name' => 'TaskType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the data synchronization task. Set the value to DI_OFFLINE. You can call the UpdateDISyncTask operation to update only batch synchronization tasks.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'DI_OFFLINE', - ], - ], - [ - 'name' => 'TaskContent', - 'in' => 'query', - 'schema' => [ - 'description' => 'The updated configurations of the data synchronization task. Calling this API operation to update a data synchronization task is equivalent to updating a data synchronization task by using the code editor in the DataWorks console. For more information, see [Create a synchronization task by using the code editor](~~137717~~). You can call the UpdateDISyncTask operation to update only batch synchronization tasks. If you do not need to update the configurations of the data synchronization task, leave this parameter empty.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '{"type":"job","version":"2.0","steps":[{"stepType":"mysql","parameter":{"envType":1,"datasource":"mysql_pub","column":["id","name","create_time","age","score","t_01"],"connection":[{"datasource":"mysql_pub","table":["u_pk"]}],"where":"","splitPk":"id","encoding":"UTF-8"},"name":"Reader","category":"reader"},{"stepType":"odps","parameter":{"partition":"pt=${bizdate}","truncate":true,"datasource":"odps_first","envType":1,"column":["id","name","create_time","age","score","t_01"],"emptyAsNull":false,"tableComment":"null","table":"u_pk"},"name":"Writer","category":"writer"}],"setting":{"executeMode":null,"errorLimit":{"record":""},"speed":{"concurrent":2,"throttle":false}},"order":{"hops":[{"from":"Reader","to":"Writer"}]}}', - 'default' => '', - ], + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10002', 'title' => ''], ], [ - 'name' => 'TaskParam', - 'in' => 'query', - 'schema' => [ - 'description' => 'The configuration parameters of the data synchronization task. You must configure this parameter in the JSON format.'."\n" - ."\n" - .'* ResourceGroup: the identifier of the resource group for Data Integration that is used by the data synchronization task. You can call the [ListResourceGroups](~~173913~~) operation to query the identifier of the resource group.'."\n" - .'* Cu: the specifications occupied by the data synchronization task in the serverless resource group. The value of this parameter must be a multiple of 0.5.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '{"ResourceGroup":"S_res_group_XXX_XXXX"}', - ], + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10001', 'title' => ''], ], [ - 'name' => 'FileId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the data synchronization task. You can call the [ListFiles](~~173942~~) operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '1000000', - ], + 'name' => 'ApiId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the DataService Studio API.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10000', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The returned result.'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => '0bc1411515937635973****', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '0000-ABCD-EFG****', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned.', 'type' => 'string', 'example' => 'The specified parameters are invalid.', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned.', 'type' => 'string', 'example' => '1031203110005', 'title' => ''], 'Data' => [ - 'description' => 'The information that indicates whether the data synchronization task is updated.'."\n", + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The update status of the data synchronization task. Valid values:'."\n" - ."\n" - .'* success'."\n" - .'* fail'."\n", - 'type' => 'string', - 'example' => 'success', + 'Timeout' => ['description' => 'The timeout period of the API request. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '10000', 'title' => ''], + 'Status' => ['description' => 'The status of the API. Valid values: 0 and 1. The value 0 indicates that the API is not published. The value 1 indicates that the API is published.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ApiId' => ['description' => 'The ID of the DataService Studio API.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'title' => ''], + 'ApiMode' => ['description' => 'The type of the API. Valid values: 0, 1, and 2. The value 0 indicates that the API is generated in wizard mode. The value 1 indicates that the API is generated in script mode. The value 2 indicates that the API is generated by registration.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ProjectId' => ['description' => 'The ID of the workspace.', 'type' => 'integer', 'format' => 'int64', 'example' => '10001', 'title' => ''], + 'ResponseContentType' => ['description' => 'The format in which the response of the API request is returned. Valid values: 0 and 1. The value 0 indicates the JSON format. The value 1 indicates the XML format. APIs generated in wizard or script mode support the JSON format. APIs generated by registration support the JSON and XML formats.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'CreatorId' => ['description' => 'The ID of the Alibaba Cloud account used by the creator of the API.', 'type' => 'string', 'example' => '1234567', 'title' => ''], + 'VisibleRange' => ['description' => 'The scope in which the API is visible. Valid values: 0 and 1. The value 0 indicates that the API is visible to the members in a specific workspace. The value 1 indicates that the API is visible only to the API creator.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ModifiedTime' => ['description' => 'The time when the API was last modified.', 'type' => 'string', 'example' => '2020-06-23T00:21:01+0800', 'title' => ''], + 'OperatorId' => ['description' => 'The ID of the Alibaba Cloud account used by the user who last modified the API.', 'type' => 'string', 'example' => '2345678', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the group.', 'type' => 'string', 'example' => 'ab123****', 'title' => ''], + 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'Test API description', 'title' => ''], + 'FolderId' => ['description' => 'The ID of the folder.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'RequestMethod' => ['description' => 'The request method of the API. Valid values: 0, 1, 2, and 3. The value 0 indicates the GET method. The value 1 indicates the POST method. The value 2 indicates the PUT method. The value 3 indicates the DELETE method. APIs generated in wizard or script mode support the GET and POST methods. APIs generated by registration support the GET, POST, PUT, and DELETE methods.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'CreatedTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2020-06-23T00:21:01+0800', 'title' => ''], + 'ApiName' => ['description' => 'The name of the API.', 'type' => 'string', 'example' => 'Test API name', 'title' => ''], + 'TenantId' => ['description' => 'The ID of the tenant.', 'type' => 'integer', 'format' => 'int64', 'example' => '10002', 'title' => ''], + 'ApiPath' => ['description' => 'The path of the API.', 'type' => 'string', 'example' => '/test/1', 'title' => ''], + 'Protocols' => [ + 'description' => 'The list of fields.', + 'type' => 'array', + 'items' => ['description' => 'The protocol used by the API. Valid values: 0 and 1. The value 0 indicates that the API uses HTTP. The value 1 indicates that the API uses HTTPS. Two protocols are presented in a list.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'Message' => [ - 'description' => 'The error message returned if the data synchronization task fails to be updated. If the data synchronization task is successfully updated, the value null is returned for this parameter.'."\n", - 'type' => 'string', - 'example' => 'ResourceGroup:[S_res_group_XXX] is invalid.', + 'RegistrationDetails' => [ + 'description' => 'The details of the API generated by registration. This parameter is returned only if the API is generated by registration.', + 'type' => 'object', + 'properties' => [ + 'ServiceHost' => ['description' => 'The address of the backend service.', 'type' => 'string', 'example' => 'http://example.aliyundoc.com', 'title' => ''], + 'ServiceContentType' => ['description' => 'The format in which the response of the API request is returned. Valid values:'."\n" + ."\n" + .'- 0: indicates the JSON format.'."\n" + ."\n" + .'- 1: indicates the XML format.'."\n" + ."\n" + .'APIs generated in wizard or script mode support the JSON format. APIs generated by registration support the JSON and XML formats.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ServicePath' => ['description' => 'The path of the backend service.', 'type' => 'string', 'example' => '/index', 'title' => ''], + 'SuccessfulResultSample' => ['description' => 'Sample success responses', 'type' => 'string', 'example' => '{"success": true}', 'title' => ''], + 'FailedResultSample' => ['description' => 'The sample error response of the API.', 'type' => 'string', 'example' => '{"success": false}', 'title' => ''], + 'ServiceRequestBodyDescription' => ['description' => 'The description of the request body initiated to call the backend service.', 'type' => 'string', 'example' => '{"abc":1}', 'title' => ''], + 'RegistrationErrorCodes' => [ + 'description' => 'The error codes returned for the API generated by registration.', + 'type' => 'array', + 'items' => [ + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'fail to call', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '1001', 'title' => ''], + 'ErrorSolution' => ['description' => 'The solution used to fix the error.', 'type' => 'string', 'example' => 'retry', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'RegistrationRequestParameters' => [ + 'description' => 'The request parameters of the API generated by registration.', + 'type' => 'array', + 'items' => [ + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'ColumnName' => ['description' => 'The name of the associated field. This parameter is supported only if the API is generated in wizard mode.', 'type' => 'string', 'example' => 'column1', 'title' => ''], + 'ParameterName' => ['description' => 'The name of the parameter.', 'type' => 'string', 'example' => 'name1', 'title' => ''], + 'ParameterPosition' => ['description' => 'The position of the parameter. Valid values:'."\n" + ."\n" + .'- 0: indicates that the parameter is in the URL path of the request.'."\n" + ."\n" + .'- 1: indicates that the parameter is in the Query parameter of the request URL.'."\n" + ."\n" + .'- 2: indicates that the parameter is in the request header.'."\n" + ."\n" + .'- 3: indicates that the parameter is in the request body.'."\n" + ."\n" + .'APIs generated in wizard or script mode support only the Query position. APIs generated by registration whose request method is GET or DELETE support the Query and Head positions. APIs generated by registration whose request method is PUT or POST support the Query, Head, and Body positions.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ParameterDescription' => ['description' => 'The description.', 'type' => 'string', 'example' => 'description1', 'title' => ''], + 'DefaultValue' => ['description' => 'The default value.', 'type' => 'string', 'example' => 'default1', 'title' => ''], + 'ParameterOperator' => ['description' => 'The operator used for the value of the parameter. Valid values:'."\n" + ."\n" + .'- 0: Equal'."\n" + ."\n" + .'- 1: Like'."\n" + ."\n" + .'- 2: Const'."\n" + ."\n" + .'- 3: In'."\n" + ."\n" + .'APIs generated in wizard mode support the Equal, Like, and In operators. APIs generated in script mode support the Equal operator. APIs generated by registration support the Equal and Const operators.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ParameterDataType' => ['description' => 'The data type of the parameter. Valid values:'."\n" + ."\n" + .'- 0: String'."\n" + ."\n" + .'- 1: Int'."\n" + ."\n" + .'- 2: Long'."\n" + ."\n" + .'- 3: Float'."\n" + ."\n" + .'- 4: Double'."\n" + ."\n" + .'- 5: Boolean'."\n" + ."\n" + .'- 6: StringList'."\n" + ."\n" + .'- 7: IntList'."\n" + ."\n" + .'- 8: LongList'."\n" + ."\n" + .'- 9: FloatList'."\n" + ."\n" + .'- 10: DoubleList'."\n" + ."\n" + .'- 11: BooleanList', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ExampleValue' => ['description' => 'The sample value.', 'type' => 'string', 'example' => 'example1', 'title' => ''], + 'IsRequiredParameter' => ['description' => 'Indicates whether the parameter is required.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'ScriptDetails' => [ + 'description' => 'The details of the API generated in script mode. This parameter is returned only if the API is generated in script mode.', + 'type' => 'object', + 'properties' => [ + 'Script' => ['description' => 'The SQL script.', 'type' => 'string', 'example' => 'select a from t', 'title' => ''], + 'IsPagedResponse' => ['description' => 'Indicates whether the entries were returned by page.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ScriptRequestParameters' => [ + 'description' => 'The request parameters of the API generated in script mode.', + 'type' => 'array', + 'items' => [ + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'ColumnName' => ['description' => 'The name of the associated field. This parameter is supported only if the API is generated in wizard mode.', 'type' => 'string', 'example' => 'column1', 'title' => ''], + 'ParameterName' => ['description' => 'The name of the parameter.', 'type' => 'string', 'example' => 'param1', 'title' => ''], + 'ParameterPosition' => ['description' => 'The position of the parameter. Valid values: 0, 1, 2, and 3. The value 0 indicates that the parameter is in the URL path of the request. The value 1 indicates that the parameter is in the Query parameter of the request URL. The value 2 indicates that the parameter is in the request header. The value 3 indicates that the parameter is in the request body. APIs generated in wizard or script mode support only the Query position. APIs generated by registration whose request method is GET or DELETE support the Query and Head positions. APIs generated by registration whose request method is PUT or POST support the Query, Head, and Body positions.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ParameterDescription' => ['description' => 'The description.', 'type' => 'string', 'example' => 'description1', 'title' => ''], + 'DefaultValue' => ['description' => 'The default value.', 'type' => 'string', 'example' => 'default1', 'title' => ''], + 'ParameterOperator' => ['description' => 'The operator used for the value of the parameter. Valid values: 0, 1, 2, and 3. The value 0 indicates the Equal operator. The value 1 indicates the Like operator. The value 2 indicates the Const operator. The value 3 indicates the In operator. APIs generated in wizard mode support the Equal, Like, and In operators. APIs generated in script mode support the Equal operator. APIs generated by registration support the Equal and Const operators.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ParameterDataType' => ['description' => 'The data type of the parameter. Valid values:'."\n" + ."\n" + .'- 0: String'."\n" + ."\n" + .'- 1: Int'."\n" + ."\n" + .'- 2: Long'."\n" + ."\n" + .'- 3: Float'."\n" + ."\n" + .'- 4: Double'."\n" + ."\n" + .'- 5: Boolean'."\n" + ."\n" + .'- 6: StringList'."\n" + ."\n" + .'- 7: IntList'."\n" + ."\n" + .'- 8: LongList'."\n" + ."\n" + .'- 9: FloatList'."\n" + ."\n" + .'- 10: DoubleList'."\n" + ."\n" + .'- 11: BooleanList', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ExampleValue' => ['description' => 'The sample value.', 'type' => 'string', 'example' => 'example1', 'title' => ''], + 'IsRequiredParameter' => ['description' => 'Indicates whether the parameter is required.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'ScriptResponseParameters' => [ + 'description' => 'The response parameters of the API generated in script mode.', + 'type' => 'array', + 'items' => [ + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'ParameterDescription' => ['description' => 'The description.', 'type' => 'string', 'example' => 'description2', 'title' => ''], + 'ColumnName' => ['description' => 'The name of the associated field. This parameter is supported only if the API is generated in wizard mode.', 'type' => 'string', 'example' => 'column2', 'title' => ''], + 'ParameterName' => ['description' => 'The name of the parameter.', 'type' => 'string', 'example' => 'param2', 'title' => ''], + 'ParameterDataType' => ['description' => 'The data type of the parameter. Valid values:'."\n" + ."\n" + .'- 0: String'."\n" + ."\n" + .'- 1: Int'."\n" + ."\n" + .'- 2: Long'."\n" + ."\n" + .'- 3: Float'."\n" + ."\n" + .'- 4: Double'."\n" + ."\n" + .'- 5: Boolean'."\n" + ."\n" + .'- 6: StringList'."\n" + ."\n" + .'- 7: IntList'."\n" + ."\n" + .'- 8: LongList'."\n" + ."\n" + .'- 9: FloatList'."\n" + ."\n" + .'- 10: DoubleList'."\n" + ."\n" + .'- 11: BooleanList', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ExampleValue' => ['description' => 'The sample value.', 'type' => 'string', 'example' => 'example2', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'ScriptConnection' => [ + 'description' => 'The data source information of the API generated in script mode.', + 'type' => 'object', + 'properties' => [ + 'TableName' => ['description' => 'The name of the table in the data source.', 'type' => 'string', 'example' => 't', 'title' => ''], + 'ConnectionId' => ['description' => 'The ID of the data source.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'WizardDetails' => [ + 'description' => 'The details of the API generated in wizard mode. This parameter is returned only if the API is generated in wizard mode.', + 'type' => 'object', + 'properties' => [ + 'IsPagedResponse' => ['description' => 'Indicates whether the entries were returned by page.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'WizardRequestParameters' => [ + 'description' => 'The request parameters of the API generated in wizard mode.', + 'type' => 'array', + 'items' => [ + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'ColumnName' => ['description' => 'The name of the associated field. This parameter is supported only if the API is generated in wizard mode.', 'type' => 'string', 'example' => 'column1', 'title' => ''], + 'ParameterName' => ['description' => 'The name of the parameter.', 'type' => 'string', 'example' => 'param1', 'title' => ''], + 'ParameterPosition' => ['description' => 'The position of the parameter. Valid values: 0, 1, 2, and 3. The value 0 indicates that the parameter is in the URL path of the request. The value 1 indicates that the parameter is in the Query parameter of the request URL. The value 2 indicates that the parameter is in the request header. The value 3 indicates that the parameter is in the request body. APIs generated in wizard or script mode support only the Query position. APIs generated by registration whose request method is GET or DELETE support the Query and Head positions. APIs generated by registration whose request method is PUT or POST support the Query, Head, and Body positions.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ParameterDescription' => ['description' => 'The description.', 'type' => 'string', 'example' => 'description1', 'title' => ''], + 'DefaultValue' => ['description' => 'The default value.', 'type' => 'string', 'example' => 'default1', 'title' => ''], + 'ParameterOperator' => ['description' => 'The operator used for the value of the parameter. Valid values: 0, 1, 2, and 3. The value 0 indicates the Equal operator. The value 1 indicates the Like operator. The value 2 indicates the Const operator. The value 3 indicates the In operator. APIs generated in wizard mode support the Equal, Like, and In operators. APIs generated in script mode support the Equal operator. APIs generated by registration support the Equal and Const operators.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ParameterDataType' => ['description' => 'The data type of the parameter. Valid values:'."\n" + ."\n" + .'- 0: String'."\n" + ."\n" + .'- 1: Int'."\n" + ."\n" + .'- 2: Long'."\n" + ."\n" + .'- 3: Float'."\n" + ."\n" + .'- 4: Double'."\n" + ."\n" + .'- 5: Boolean'."\n" + ."\n" + .'- 6: StringList'."\n" + ."\n" + .'- 7: IntList'."\n" + ."\n" + .'- 8: LongList'."\n" + ."\n" + .'- 9: FloatList'."\n" + ."\n" + .'- 10: DoubleList'."\n" + ."\n" + .'- 11: BooleanList', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ExampleValue' => ['description' => 'The sample value.', 'type' => 'string', 'example' => 'example1', 'title' => ''], + 'IsRequiredParameter' => ['description' => 'Indicates whether the parameter is required.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'WizardResponseParameters' => [ + 'description' => 'The response parameters of the API generated in wizard mode.', + 'type' => 'array', + 'items' => [ + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'ParameterDescription' => ['description' => 'The description.', 'type' => 'string', 'example' => 'description2', 'title' => ''], + 'ColumnName' => ['description' => 'The name of the associated field. This parameter is supported only if the API is generated in wizard mode.', 'type' => 'string', 'example' => 'column2', 'title' => ''], + 'ParameterName' => ['description' => 'The name of the parameter.', 'type' => 'string', 'example' => 'param2', 'title' => ''], + 'ParameterDataType' => ['description' => 'The data type of the parameter. Valid values:'."\n" + ."\n" + .'- 0: String'."\n" + ."\n" + .'- 1: Int'."\n" + ."\n" + .'- 2: Long'."\n" + ."\n" + .'- 3: Float'."\n" + ."\n" + .'- 4: Double'."\n" + ."\n" + .'- 5: Boolean'."\n" + ."\n" + .'- 6: StringList'."\n" + ."\n" + .'- 7: IntList'."\n" + ."\n" + .'- 8: LongList'."\n" + ."\n" + .'- 9: FloatList'."\n" + ."\n" + .'- 10: DoubleList'."\n" + ."\n" + .'- 11: BooleanList', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ExampleValue' => ['description' => 'The sample value.', 'type' => 'string', 'example' => 'example2', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'WizardConnection' => [ + 'description' => 'The data source information of the API generated in wizard mode.', + 'type' => 'object', + 'properties' => [ + 'TableName' => ['description' => 'The name of the table in the data source.', 'type' => 'string', 'example' => 't', 'title' => ''], + 'ConnectionId' => ['description' => 'The ID of the data source.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Invalid.DI.Parameter', - 'errorMessage' => 'The parameter is invalid.', - ], - ], 403 => [ - [ - 'errorCode' => 'Forbidden.DI.NoPrivilege', - 'errorMessage' => 'No access.', - ], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.DI.Parameter', - 'errorMessage' => 'A DI internal error occurred.', - ], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0bc1411515937635973****\\",\\n \\"Data\\": {\\n \\"Status\\": \\"success\\",\\n \\"Message\\": \\"ResourceGroup:[S_res_group_XXX] is invalid.\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"0bc1411515937635973****\\n\\n success\\n ResourceGroup:[S_res_group_XXX] is invalid.\\n\\ntrue","errorExample":""}]', - 'title' => 'UpdateDISyncTask', - 'summary' => 'Updates a data synchronization task.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Data\\": {\\n \\"Timeout\\": 10000,\\n \\"Status\\": 0,\\n \\"ApiId\\": 10000,\\n \\"ApiMode\\": 0,\\n \\"ProjectId\\": 10001,\\n \\"ResponseContentType\\": 0,\\n \\"CreatorId\\": \\"1234567\\",\\n \\"VisibleRange\\": 0,\\n \\"ModifiedTime\\": \\"2020-06-23T00:21:01+0800\\",\\n \\"OperatorId\\": \\"2345678\\",\\n \\"GroupId\\": \\"ab123****\\",\\n \\"Description\\": \\"Test API description\\",\\n \\"FolderId\\": 0,\\n \\"RequestMethod\\": 0,\\n \\"CreatedTime\\": \\"2020-06-23T00:21:01+0800\\",\\n \\"ApiName\\": \\"Test API name\\",\\n \\"TenantId\\": 10002,\\n \\"ApiPath\\": \\"/test/1\\",\\n \\"Protocols\\": [\\n 0\\n ],\\n \\"RegistrationDetails\\": {\\n \\"ServiceHost\\": \\"http://example.aliyundoc.com\\",\\n \\"ServiceContentType\\": 0,\\n \\"ServicePath\\": \\"/index\\",\\n \\"SuccessfulResultSample\\": \\"{\\\\\\"success\\\\\\": true}\\",\\n \\"FailedResultSample\\": \\"{\\\\\\"success\\\\\\": false}\\",\\n \\"ServiceRequestBodyDescription\\": \\"{\\\\\\"abc\\\\\\":1}\\",\\n \\"RegistrationErrorCodes\\": [\\n {\\n \\"ErrorMessage\\": \\"fail to call\\",\\n \\"ErrorCode\\": \\"1001\\",\\n \\"ErrorSolution\\": \\"retry\\"\\n }\\n ],\\n \\"RegistrationRequestParameters\\": [\\n {\\n \\"ColumnName\\": \\"column1\\",\\n \\"ParameterName\\": \\"name1\\",\\n \\"ParameterPosition\\": 0,\\n \\"ParameterDescription\\": \\"description1\\",\\n \\"DefaultValue\\": \\"default1\\",\\n \\"ParameterOperator\\": 0,\\n \\"ParameterDataType\\": 0,\\n \\"ExampleValue\\": \\"example1\\",\\n \\"IsRequiredParameter\\": true\\n }\\n ]\\n },\\n \\"ScriptDetails\\": {\\n \\"Script\\": \\"select a from t\\",\\n \\"IsPagedResponse\\": true,\\n \\"ScriptRequestParameters\\": [\\n {\\n \\"ColumnName\\": \\"column1\\",\\n \\"ParameterName\\": \\"param1\\",\\n \\"ParameterPosition\\": 0,\\n \\"ParameterDescription\\": \\"description1\\",\\n \\"DefaultValue\\": \\"default1\\",\\n \\"ParameterOperator\\": 0,\\n \\"ParameterDataType\\": 0,\\n \\"ExampleValue\\": \\"example1\\",\\n \\"IsRequiredParameter\\": true\\n }\\n ],\\n \\"ScriptResponseParameters\\": [\\n {\\n \\"ParameterDescription\\": \\"description2\\",\\n \\"ColumnName\\": \\"column2\\",\\n \\"ParameterName\\": \\"param2\\",\\n \\"ParameterDataType\\": 0,\\n \\"ExampleValue\\": \\"example2\\"\\n }\\n ],\\n \\"ScriptConnection\\": {\\n \\"TableName\\": \\"t\\",\\n \\"ConnectionId\\": 123\\n }\\n },\\n \\"WizardDetails\\": {\\n \\"IsPagedResponse\\": true,\\n \\"WizardRequestParameters\\": [\\n {\\n \\"ColumnName\\": \\"column1\\",\\n \\"ParameterName\\": \\"param1\\",\\n \\"ParameterPosition\\": 0,\\n \\"ParameterDescription\\": \\"description1\\",\\n \\"DefaultValue\\": \\"default1\\",\\n \\"ParameterOperator\\": 0,\\n \\"ParameterDataType\\": 0,\\n \\"ExampleValue\\": \\"example1\\",\\n \\"IsRequiredParameter\\": true\\n }\\n ],\\n \\"WizardResponseParameters\\": [\\n {\\n \\"ParameterDescription\\": \\"description2\\",\\n \\"ColumnName\\": \\"column2\\",\\n \\"ParameterName\\": \\"param2\\",\\n \\"ParameterDataType\\": 0,\\n \\"ExampleValue\\": \\"example2\\"\\n }\\n ],\\n \\"WizardConnection\\": {\\n \\"TableName\\": \\"t\\",\\n \\"ConnectionId\\": 123\\n }\\n }\\n }\\n}","type":"json"}]', + 'title' => 'GetDataServiceApi', + 'summary' => 'Retrieves the details of a DataService Studio API in the development state.', 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', + 'responseParamsDescription' => 'The details about the APIs of different types are returned in different parameters. The details about the API generated in wizard mode are returned in the WizardDetails parameter. The details about the API generated in script mode are returned in the ScriptDetails parameter. The details about the API generated by registration are returned in the RegistrationDetails parameter.', 'extraInfo' => ' ', - ], - 'TestNetworkConnection' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2023-10-10T02:04:50.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'translator' => 'manual', + ], + 'GetDataServiceApiTest' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'APP' => [], - ], - [ - 'PrivateKey' => [], - ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '78363', - 'abilityTreeNodes' => [ - 'FEATUREdideRWC5F7', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the DataWorks workspace to which the data source belongs. You can call the [ListProjects](~~178393~~) operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '10000000000', - 'minimum' => '1', - 'example' => '10000', - ], - ], - [ - 'name' => 'DatasourceName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the data source.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mysql_name', - ], - ], - [ - 'name' => 'EnvType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The environment in which the data source resides. Valid values:'."\n" - ."\n" - .'* 0: development environment'."\n" - .'* 1: production environment'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'ResourceGroup', + 'name' => 'TestId', 'in' => 'query', - 'schema' => [ - 'description' => 'The identifier of the resource group. You can call the [ListResourceGroups](~~173913~~) operation to query the identifier of the resource group.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'S_res_group_2XXXX4_1619100XXXXX', - ], + 'schema' => ['description' => 'The Id of the test. TestDataServiceApi is executed asynchronously after the API is called and the test Id is returned. You can also use ListDataServiceApiTest to obtain the latest test Id.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '123434'], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ + 'description' => 'The returned result.'."\n", 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG ', - ], - 'TaskList' => [ - 'description' => 'The information about the connectivity test.'."\n", + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'adssdsewe'], + 'Data' => [ + 'description' => 'Return object', 'type' => 'object', 'properties' => [ - 'ConnectMessage' => [ - 'description' => 'The reason why the data source and resource group failed the connectivity test. If data source and the resource group passed the connectivity test, this parameter is left empty.'."\n", - 'type' => 'string', - 'example' => 'Connectable', - ], - 'ConnectStatus' => [ - 'description' => 'The result of the connectivity test. Valid values:'."\n" - ."\n" - .'* true: The data source and the resource group passed the connectivity test.'."\n" - .'* false: The data source and the resource group failed the connectivity test. You can troubleshoot issues based on the ConnectMessage parameter.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'ApiId' => ['description' => 'Test API Id', 'type' => 'integer', 'format' => 'int64', 'example' => '12343'], + 'ParamMap' => ['description' => 'Test API request parameters', 'type' => 'string', 'example' => '{"name":"test"}'], + 'RetCode' => ['description' => 'The test API returns the code. If it is not completed, the data is empty.', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'RetResult' => ['description' => 'Return data', 'type' => 'string', 'example' => '{"id":2}'], + 'DebugInfo' => ['description' => 'Debug information', 'type' => 'string', 'example' => '[INFO] [16:15:13.240] resource group is 498774069027041[INFO]'], + 'CostTime' => ['description' => 'Time consuming', 'type' => 'string', 'example' => '10'], + 'NodesDebugInfo' => ['description' => 'Node Debug information', 'type' => 'string', 'example' => '[INFO] [16:15:13.240] resource group is 498774069027041[INFO]'], + 'Status' => ['description' => 'Whether the task has been completed, including: RUNNING,FINISHED', 'type' => 'string', 'example' => 'FINISHED'], ], ], ], - 'description' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Invalid.DI.Parameter', - 'errorMessage' => 'The parameter is invalid.', - ], - ], 403 => [ - [ - 'errorCode' => 'Forbidden.DI.NoPrivilege', - 'errorMessage' => 'No access.', - ], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.DI.Parameter', - 'errorMessage' => 'A DI internal error occurred.', - ], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0000-ABCD-EFG\\\\t\\",\\n \\"TaskList\\": {\\n \\"ConnectMessage\\": \\"Connectable\\",\\n \\"ConnectStatus\\": true\\n }\\n}","errorExample":""},{"type":"xml","example":"0000-ABCD-EFG\\t\\n\\n true\\n 可连通\\n\\ntrue","errorExample":""}]', - 'title' => 'TestNetworkConnection', - 'summary' => 'Tests the network connectivity between a data source and a resource group.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'GetDataSourceMeta' => [ - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"adssd****\\",\\n \\"Data\\": {\\n \\"ApiId\\": 12343,\\n \\"ParamMap\\": \\"{\\\\\\"name\\\\\\":\\\\\\"test\\\\\\"}\\",\\n \\"RetCode\\": 0,\\n \\"RetResult\\": \\"{\\\\\\"id\\\\\\":2}\\",\\n \\"DebugInfo\\": \\"[INFO] [16:15:13.240] resource group is 498774069027041[INFO]\\",\\n \\"CostTime\\": \\"10\\",\\n \\"NodesDebugInfo\\": \\"[INFO] [16:15:13.240] resource group is 498774069027041[INFO]\\",\\n \\"Status\\": \\"FINISHED\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n adssdsewe\\n \\n 12343\\n {\\"name\\":\\"test\\"}\\n 0\\n {\\"id\\":2}\\n [<span style=\\\\\\"color: #92D581;\\\\\\">INFO</span>] [16:15:13.240] resource group is 498774069027041[<span style=\\\\\\"color: #92D581;\\\\\\">INFO</span>]\\n 10\\n [<span style=\\\\\\"color: #92D581;\\\\\\">INFO</span>] [16:15:13.240] resource group is 498774069027041[<span style=\\\\\\"color: #92D581;\\\\\\">INFO</span>]\\n FINISHED\\n \\n","errorExample":""}]', + 'title' => 'GetDataServiceApiTest', + 'summary' => 'Queries the test results of an API in DataService Studio.', + 'changeSet' => [ + ['createdAt' => '2022-05-30T02:35:45.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'GetDataServiceApplication' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'APP' => [], - ], - [ - 'PrivateKey' => [], - ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', + 'abilityTreeCode' => '78236', + 'abilityTreeNodes' => ['FEATUREdide7T0EJX'], ], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '10000000000', - 'minimum' => '1', - 'example' => '10000', - ], - ], - [ - 'name' => 'DatasourceName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the data source.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mysql_name', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10002', 'title' => ''], ], [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'maximum' => '10000', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10001', 'title' => ''], ], [ - 'name' => 'EnvType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The environment in which the data source resides. Valid values:'."\n" - ."\n" - .'* 0: development environment'."\n" - .'* 1: production environment'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'name' => 'ApplicationId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the application. You can view the information about the application in the API Gateway console.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10000', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The returned result.'."\n", 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG ', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0000-ABCD-EFG****', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Normal', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '0', 'title' => ''], 'Data' => [ - 'description' => 'The returned result.'."\n", + 'description' => 'The details of the application.', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'Indicates whether the metadata of the data source is obtained. Valid values:'."\n" - ."\n" - .'* success: The metadata of the data source is obtained.'."\n" - .'* fail: The metadata of the data source failed to be obtained. You can troubleshoot issues based on the Message parameter.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Message' => [ - 'description' => 'The reason why the metadata of the data source fails to be obtained. If the metadata of the data source is obtained, no value is returned for this parameter.'."\n", - 'type' => 'string', - 'example' => 'read datasource time out', - ], - 'Meta' => [ - 'description' => 'The returned metadata of the data source. The returned metadata is in the JSON format.'."\n" - ."\n" - .'`{"dbTables":[{"dbName":"testdb","schema":[{"tableInfos":[{"dbName":"testdb","enable":true,"table":"table1","tableName":"table1"}]},{"tableInfos":[{"dbName":"testdb","enable":true,"table":"table2","tableName":"table2"}]}]}]}`'."\n" - ."\n" - .'Parameter description:'."\n" - ."\n" - .'* dbName: the name of the database in which the data source resides.'."\n" - .'* schema: the schema of the database.'."\n" - .'* enable: indicates whether the database is available. The valid values are true and false. The value true indicates that the database is available. The value false indicates that the database is unavailable.'."\n" - .'* tableName: the name of the table in the database.'."\n" - .'* tableInfos: the information about the table in the database.'."\n", - 'type' => 'string', - 'example' => '{"dbTables":[{"dbName":"testdb","schema":[{"tableInfos":[{"dbName":"testdb","enable":true,"table":"table1","tableName":"table1"}]},{"tableInfos":[{"dbName":"testdb","enable":true,"table":"table2","tableName":"table2"}]}]}]}', - ], - ], + 'ApplicationCode' => ['description' => 'The AppCode for simple authentication. You can select simple authentication or signature authentication when you call an API operation.', 'type' => 'string', 'example' => 'CODE123', 'title' => ''], + 'ApplicationKey' => ['description' => 'The AppKey for signature authentication. You can select simple authentication or signature authentication when you call an API operation.', 'type' => 'string', 'example' => 'KEY123', 'title' => ''], + 'ApplicationSecret' => ['description' => 'The AppSecret for signature authentication. You can select simple authentication or signature authentication when you call an API operation.', 'type' => 'string', 'example' => 'SECRET123', 'title' => ''], + 'ProjectId' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10001', 'title' => ''], + 'ApplicationName' => ['description' => 'The name of the application.', 'type' => 'string', 'example' => 'Test application', 'title' => ''], + 'ApplicationId' => ['description' => 'The application ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Invalid.DI.Parameter', - 'errorMessage' => 'The parameter is invalid.', - ], - ], 403 => [ - [ - 'errorCode' => 'Forbidden.DI.NoPrivilege', - 'errorMessage' => 'No access.', - ], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.DI.Parameter', - 'errorMessage' => 'A DI internal error occurred.', - ], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0000-ABCD-EFG\\\\t\\",\\n \\"Data\\": {\\n \\"Status\\": \\"success\\",\\n \\"Message\\": \\"read datasource time out\\",\\n \\"Meta\\": \\"{\\\\\\"dbTables\\\\\\":[{\\\\\\"dbName\\\\\\":\\\\\\"testdb\\\\\\",\\\\\\"schema\\\\\\":[{\\\\\\"tableInfos\\\\\\":[{\\\\\\"dbName\\\\\\":\\\\\\"testdb\\\\\\",\\\\\\"enable\\\\\\":true,\\\\\\"table\\\\\\":\\\\\\"table1\\\\\\",\\\\\\"tableName\\\\\\":\\\\\\"table1\\\\\\"}]},{\\\\\\"tableInfos\\\\\\":[{\\\\\\"dbName\\\\\\":\\\\\\"testdb\\\\\\",\\\\\\"enable\\\\\\":true,\\\\\\"table\\\\\\":\\\\\\"table2\\\\\\",\\\\\\"tableName\\\\\\":\\\\\\"table2\\\\\\"}]}]}]}\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 0000-ABCD-EFG\\t\\n \\n success\\n read datasource time out\\n {\\"dbTables\\":[{\\"dbName\\":\\"testdb\\",\\"schema\\":[{\\"tableInfos\\":[{\\"dbName\\":\\"testdb\\",\\"enable\\":true,\\"table\\":\\"table1\\",\\"tableName\\":\\"table1\\"}]},{\\"tableInfos\\":[{\\"dbName\\":\\"testdb\\",\\"enable\\":true,\\"table\\":\\"table2\\",\\"tableName\\":\\"table2\\"}]}]}]}\\n \\n","errorExample":""}]', - 'title' => 'GetDataSourceMeta', - 'summary' => 'Queries the metadata of a specified data source.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"Normal\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"0\\",\\n \\"Data\\": {\\n \\"ApplicationCode\\": \\"CODE123\\",\\n \\"ApplicationKey\\": \\"KEY123\\",\\n \\"ApplicationSecret\\": \\"SECRET123\\",\\n \\"ProjectId\\": 10001,\\n \\"ApplicationName\\": \\"Test application\\",\\n \\"ApplicationId\\": 10000\\n }\\n}","type":"json"}]', + 'title' => 'GetDataServiceApplication', + 'summary' => 'Retrieves the details of an application.', 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', + 'responseParamsDescription' => 'The disclosure of the ApplicationCode or ApplicationSecret parameter may threaten the security of your API resources in DataService Studio. Therefore, the values of the ApplicationCode and ApplicationSecret parameters are masked before they are returned.', 'extraInfo' => ' ', - ], - 'ListDIProjectConfig' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2023-10-10T02:04:50.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'translator' => 'manual', + ], + 'GetDataServiceFolder' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'PrivateKey' => [], - ], - [ - 'APP' => [], - ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', + 'abilityTreeCode' => '78237', + 'abilityTreeNodes' => ['FEATUREdide7T0EJX'], ], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '10000000000', - 'minimum' => '1', - 'example' => '1000', - ], + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['description' => 'The tenant ID. This parameter is deprecated. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '10003'], ], [ - 'name' => 'DestinationType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the destinations of the synchronization solutions. This parameter cannot be left empty. Valid values: analyticdb_for_mysql, odps, elasticsearch, holo, mysql, and polardb.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'elasticsearch', - ], + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the workspace.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '10002'], ], [ - 'name' => 'SourceType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the sources of the synchronization solutions. Valid values: oracle, mysql, polardb, datahub, drds, and analyticdb_for_mysql. If you do not configure this parameter, DataWorks applies the default global configuration to all sources.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'mysql', - ], + 'name' => 'FolderId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the folder.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '10001'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG ', - ], - 'Data' => [ - 'description' => 'The information about the query.'."\n", + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0000-ABCD-EF****'], + 'Folder' => [ + 'description' => 'The details of the folder.'."\n", 'type' => 'object', 'properties' => [ - 'Config' => [ - 'description' => 'The default global configuration of synchronization solutions. The value indicates the processing rules of different types of DDL messages. Example: {"RENAMECOLUMN":"WARNING","DROPTABLE":"WARNING","CREATETABLE":"WARNING","MODIFYCOLUMN":"WARNING","TRUNCATETABLE":"WARNING","DROPCOLUMN":"WARNING","ADDCOLUMN":"WARNING","RENAMETABLE":"WARNING"}'."\n" - ."\n" - .'Field description:'."\n" - ."\n" - .'* RENAMECOLUMN: renames a column.'."\n" - .'* DROPTABLE: deletes a table.'."\n" - .'* CREATETABLE: creates a table.'."\n" - .'* MODIFYCOLUMN: changes the data type of a column.'."\n" - .'* TRUNCATETABLE: clears a table.'."\n" - .'* DROPCOLUMN: deletes a column.'."\n" - .'* ADDCOLUMN: creates a column.'."\n" - .'* RENAMETABLE: renames a table.'."\n" - ."\n" - .'DataWorks processes a DDL message of a specific type based on the following rules:'."\n" - ."\n" - .'* WARNING: ignores the message and records an alert in real-time synchronization logs. The alert contains information about the situation that the message is ignored because of an execution error.'."\n" - .'* IGNORE: discards the message and does not send it to the destination.'."\n" - .'* CRITICAL: terminates the real-time synchronization node and sets the node status to Failed.'."\n" - .'* NORMAL: sends the message to the destination to process the message. Each destination processes DDL messages based on its own business logic. If DataWorks adopts the NORMAL policy, DataWorks only forwards DDL messages.'."\n", - 'type' => 'string', - 'example' => '{"RENAMECOLUMN":"WARNING","DROPTABLE":"WARNING","CREATETABLE":"WARNING","MODIFYCOLUMN":"WARNING","TRUNCATETABLE":"WARNING","DROPCOLUMN":"WARNING","ADDCOLUMN":"WARNING","RENAMETABLE":"WARNING"}', - ], + 'ParentId' => ['description' => 'The parent folder ID. The ID of the root folder in a business process is 0, and the ID of a folder created by a user in a business process is greater than 0.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'ModifiedTime' => ['description' => 'The time when the folder was last modified.'."\n", 'type' => 'string', 'example' => '2020-09-24T18:37:51+0800'], + 'GroupId' => ['description' => 'The ID of the business process to which the folder belongs.'."\n", 'type' => 'string', 'example' => 'ds_1234'], + 'FolderId' => ['description' => 'The folder ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '11'], + 'ProjectId' => ['description' => 'The workspace ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10001'], + 'FolderName' => ['description' => 'The name of the folder.'."\n", 'type' => 'string', 'example' => 'test1'], + 'CreatedTime' => ['description' => 'The time when the folder was created.'."\n", 'type' => 'string', 'example' => '2020-09-24T18:37:51+0800'], + 'TenantId' => ['description' => 'The tenant ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10002'], ], ], ], - 'description' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Invalid.DI.Parameter', - 'errorMessage' => 'The parameter is invalid.', - ], - ], 403 => [ - [ - 'errorCode' => 'Forbidden.DI.NoPrivilege', - 'errorMessage' => 'No access.', - ], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.DI.Parameter', - 'errorMessage' => 'A DI internal error occurred.', - ], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0000-ABCD-EFG\\\\t\\",\\n \\"Data\\": {\\n \\"Config\\": \\"{\\\\\\"RENAMECOLUMN\\\\\\":\\\\\\"WARNING\\\\\\",\\\\\\"DROPTABLE\\\\\\":\\\\\\"WARNING\\\\\\",\\\\\\"CREATETABLE\\\\\\":\\\\\\"WARNING\\\\\\",\\\\\\"MODIFYCOLUMN\\\\\\":\\\\\\"WARNING\\\\\\",\\\\\\"TRUNCATETABLE\\\\\\":\\\\\\"WARNING\\\\\\",\\\\\\"DROPCOLUMN\\\\\\":\\\\\\"WARNING\\\\\\",\\\\\\"ADDCOLUMN\\\\\\":\\\\\\"WARNING\\\\\\",\\\\\\"RENAMETABLE\\\\\\":\\\\\\"WARNING\\\\\\"}\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"0000-ABCD-EFG\\t\\n\\n {\\"RENAMECOLUMN\\":\\"WARNING\\",\\"DROPTABLE\\":\\"WARNING\\",\\"CREATETABLE\\":\\"WARNING\\",\\"MODIFYCOLUMN\\":\\"WARNING\\",\\"TRUNCATETABLE\\":\\"WARNING\\",\\"DROPCOLUMN\\":\\"WARNING\\",\\"ADDCOLUMN\\":\\"WARNING\\",\\"RENAMETABLE\\":\\"WARNING\\"}\\n\\ntrue","errorExample":""}]', - 'title' => 'ListDIProjectConfig', - 'summary' => 'Queries the default global configurations of synchronization solutions in a specified DataWorks workspace.', - 'description' => 'DataWorks allows you to specify a default global configuration only for the processing rules of DDL messages in synchronization solutions. After you configure the **processing rules of DDL messages** in synchronization solutions, the configuration is used as the default global configuration and applies to all real-time synchronization tasks in the solutions. You can modify the **processing rules of DDL messages** based on your business requirements. For more information about how to configure a synchronization solution, see [Synchronization solutions](~~199008~~).'."\n", + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EF****\\",\\n \\"Folder\\": {\\n \\"ParentId\\": 0,\\n \\"ModifiedTime\\": \\"2020-09-24T18:37:51+0800\\",\\n \\"GroupId\\": \\"ds_1234\\",\\n \\"FolderId\\": 11,\\n \\"ProjectId\\": 10001,\\n \\"FolderName\\": \\"test1\\",\\n \\"CreatedTime\\": \\"2020-09-24T18:37:51+0800\\",\\n \\"TenantId\\": 10002\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 0000-ABCD-EF****\\n \\n 0\\n 2020-09-24T18:37:51+0800\\n ds_1234\\n 11\\n 10001\\n test1\\n 2020-09-24T18:37:51+0800\\n 10002\\n \\n","errorExample":""}]', + 'title' => 'GetDataServiceFolder', + 'summary' => 'Queries a folder.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateDIProjectConfig' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2023-10-10T02:04:50.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'GetDataServiceGroup' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'APP' => [], - ], - [ - 'PrivateKey' => [], - ], ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '78238', + 'abilityTreeNodes' => ['FEATUREdide7T0EJX'], + ], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '10000000000', - 'minimum' => '1', - 'example' => '10000', - ], - ], - [ - 'name' => 'DestinationType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the destinations of the synchronization solutions. This parameter cannot be left empty. Valid values: analyticdb_for_mysql, odps, elasticsearch, holo, mysql, and polardb.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'odps', - ], + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['description' => 'The tenant ID. This parameter is deprecated.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '10001', 'title' => ''], ], [ - 'name' => 'SourceType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the sources of the synchronization solutions. Valid values: oracle, mysql, polardb, datahub, drds, and analyticdb_for_mysql. If you do not configure this parameter, DataWorks applies the default global configuration to all sources.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'mysql', - ], + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '10002', 'title' => ''], ], [ - 'name' => 'ProjectConfig', - 'in' => 'query', - 'schema' => [ - 'description' => 'The new default global configuration of the synchronization solutions. The value indicates the processing rules of different types of DDL messages. The value must be in the JSON format. Example: {"RENAMECOLUMN":"WARNING","DROPTABLE":"WARNING","CREATETABLE":"WARNING","MODIFYCOLUMN":"WARNING","TRUNCATETABLE":"WARNING","DROPCOLUMN":"WARNING","ADDCOLUMN":"WARNING","RENAMETABLE":"WARNING"}.'."\n" - ."\n" - .'Field description:'."\n" - ."\n" - .'* RENAMECOLUMN: renames a column.'."\n" - .'* DROPTABLE: deletes a table.'."\n" - .'* CREATETABLE: creates a table.'."\n" - .'* MODIFYCOLUMN: changes the data type of a column.'."\n" - .'* TRUNCATETABLE: clears a table.'."\n" - .'* DROPCOLUMN: deletes a column.'."\n" - .'* ADDCOLUMN: creates a column.'."\n" - .'* RENAMETABLE: renames a table.'."\n" - ."\n" - .'DataWorks processes a DDL message of a specific type based on the following rules:'."\n" - ."\n" - .'* WARNING: ignores the message and records an alert in real-time synchronization logs. The alert contains information about the situation that the message is ignored because of an execution error.'."\n" - .'* IGNORE: discards the message and does not send it to the destination.'."\n" - .'* CRITICAL: terminates the real-time synchronization task and sets the node status to Failed.'."\n" - .'* NORMAL: sends the message to the destination to process the message. Each destination processes DDL messages based on its own business logic. If DataWorks adopts the NORMAL policy, DataWorks only forwards DDL messages.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '{"RENAMECOLUMN":"WARNING","DROPTABLE":"WARNING","CREATETABLE":"WARNING","MODIFYCOLUMN":"WARNING","TRUNCATETABLE":"WARNING","DROPCOLUMN":"WARNING","ADDCOLUMN":"WARNING","RENAMETABLE":"WARNING"}', - ], + 'name' => 'GroupId', + 'in' => 'formData', + 'schema' => ['description' => 'The business process ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ds_123abc', 'title' => ''], ], ], 'responses' => [ @@ -21355,534 +14978,598 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG ', - ], - 'Data' => [ - 'description' => 'The information about the modification.'."\n", + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0000-ABCD-EF****', 'title' => ''], + 'Group' => [ + 'description' => 'The details of the business process.', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'Indicates whether the default global configuration of synchronization solutions is modified. Valid values:'."\n" - ."\n" - .'* success'."\n" - .'* fail'."\n", - 'type' => 'string', - 'example' => 'success', - ], - ], + 'ModifiedTime' => ['description' => 'The time when the business process was last modified.', 'type' => 'string', 'example' => '2020-09-24T18:37:51+0800', 'title' => ''], + 'Description' => ['description' => 'The description of the business process.', 'type' => 'string', 'example' => 'Workflow description', 'title' => ''], + 'GroupName' => ['description' => 'The name of the business process.', 'type' => 'string', 'example' => 'Workflow name', 'title' => ''], + 'GroupId' => ['description' => 'The business process ID.', 'type' => 'string', 'example' => 'ds_123abc', 'title' => ''], + 'ProjectId' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10002', 'title' => ''], + 'ApiGatewayGroupId' => ['description' => 'The ID of the API group that is associated with the business process in the API Gateway console.', 'type' => 'string', 'example' => '100abc', 'title' => ''], + 'CreatorId' => ['description' => 'The user identifier (UID) of the creator of the business process. The value of this parameter may be empty for creators of some existing business processes.', 'type' => 'string', 'example' => '10001', 'title' => ''], + 'CreatedTime' => ['description' => 'The time when the business process was created.', 'type' => 'string', 'example' => '2020-09-24T18:37:51+0800', 'title' => ''], + 'TenantId' => ['description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10003', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Invalid.DI.Parameter', - 'errorMessage' => 'The parameter is invalid.', - ], - ], 403 => [ - [ - 'errorCode' => 'Forbidden.DI.NoPrivilege', - 'errorMessage' => 'No access.', - ], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.DI.Parameter', - 'errorMessage' => 'A DI internal error occurred.', - ], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0000-ABCD-EFG\\\\t\\",\\n \\"Data\\": {\\n \\"Status\\": \\"success\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 0000-ABCD-EFG\\t\\n \\n success\\n \\n","errorExample":""}]', - 'title' => 'UpdateDIProjectConfig', - 'summary' => 'Modifies the default global configuration of synchronization solutions in a DataWorks workspace.', - 'description' => 'DataWorks allows you to specify a default global configuration only for the processing rules of DDL messages in synchronization solutions. After you configure the **processing rules of DDL messages** in synchronization solutions, the configuration is used as the default global configuration and applies to all real-time synchronization tasks in the solutions. You can modify the **processing rules of DDL messages** based on your business requirements. For more information about how to configure a synchronization solution, see [Synchronization solutions](~~199008~~).'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'GetDISyncTask' => [ - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EF****\\",\\n \\"Group\\": {\\n \\"ModifiedTime\\": \\"2020-09-24T18:37:51+0800\\",\\n \\"Description\\": \\"Workflow description\\",\\n \\"GroupName\\": \\"Workflow name\\",\\n \\"GroupId\\": \\"ds_123abc\\",\\n \\"ProjectId\\": 10002,\\n \\"ApiGatewayGroupId\\": \\"100abc\\",\\n \\"CreatorId\\": \\"10001\\",\\n \\"CreatedTime\\": \\"2020-09-24T18:37:51+0800\\",\\n \\"TenantId\\": 10003\\n }\\n}","type":"json"}]', + 'title' => 'GetDataServiceGroup', + 'summary' => 'Retrieves the details of a business process.', + 'changeSet' => [ + ['createdAt' => '2023-10-10T02:04:49.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'translator' => 'manual', + ], + 'GetDataServicePublishedApi' => [ + 'summary' => 'Retrieves the details of a published DataService Studio API.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'APP' => [], - ], - [ - 'PrivateKey' => [], - ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '93929', - 'abilityTreeNodes' => [ - 'FEATUREdideC95Y41', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '78239', + 'abilityTreeNodes' => ['FEATUREdide7T0EJX'], ], 'parameters' => [ [ 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the workspace ID.'."\n" - ."\n" - .'You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '10000000000', - 'minimum' => '1', - 'example' => '10000', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10002', 'title' => ''], ], [ - 'name' => 'TaskType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the object that you want to query. Valid values:'."\n" - ."\n" - .'* DI_REALTIME: real-time synchronization task'."\n" - .'* DI_SOLUTION: data synchronization solution'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'DI_REALTIME', - ], + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10003', 'title' => ''], ], [ - 'name' => 'FileId', - 'in' => 'query', - 'schema' => [ - 'description' => '* If you set TaskType to DI_REALTIME, set this parameter to the ID of the real-time synchronization task that you want to deploy.'."\n" - .'* If you set TaskType to DI_SOLUTION, set this parameter to the ID of the data synchronization solution that you want to deploy.'."\n" - ."\n" - .'You can call the [ListFiles](~~173942~~) operation to query the ID of the real-time synchronization task or data synchronization solution.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9999999999999999', - 'minimum' => '1', - 'example' => '100', - ], + 'name' => 'ApiId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the API.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10001', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* True'."\n" - .'* False'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => '0bc1411515937635973**** ', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '0000-ABCD-EFG****', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned.', 'type' => 'string', 'example' => 'The connection does not exist.', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned.', 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], 'Data' => [ - 'description' => 'The returned results.'."\n", + 'description' => 'Information about published APIs.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => '* If the TaskType parameter is set to DI_REALTIME, the details of the real-time synchronization task are returned.'."\n" - .'* If the TaskType parameter is set to DI_SOLUTION, the value null is returned.'."\n", - 'type' => 'string', - 'example' => '{"extend":{"mode":"wizard","resourceGroup":"S_res_group_287114642182658_1560324290517"},"nodeDef":{},"order":{"hops":[{"from":"datahub_8htXSsfiS2vtZCVG","to":"datahub_CRHBAyGfhSaLmv2f"}]},"setting":{"errorLimit":{},"jvmOption":""},"steps":[{"stepType":"datahub","category":"writer","displayName":"DataHub1","parameter":{"batchSize":1000,"datasource":"datahub_cloud_dev_test","topic":"dwd_tfc_opt_speed_rid_amap_rt"},"name":"datahub_CRHBAyGfhSaLmv2f","gui":{"x":262,"y":325}},{"stepType":"datahub","displayName":"DataHub2","parameter":{"datasource":"datahub_uric_test","topic":"dwd_tfc_opt_speed_rid_amap_rt_330000","batchSize":1000},"name":"datahub_8htXSsfiS2vtZCVG","gui":{"x":268,"y":160.5},"category":"writer"}]}', - ], - 'Status' => [ - 'description' => 'Indicates whether the details of the real-time synchronization task or data synchronization solution are obtained. Valid values:'."\n" - ."\n" - .'success: The details are obtained. fail: The details fail to be obtained.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Message' => [ - 'description' => 'The cause of the failure to obtain the details of the real-time synchronization task or data synchronization solution.'."\n" - ."\n" - .'If the details of the real-time synchronization task or data synchronization solution are obtained, the value null is returned.'."\n", - 'type' => 'string', - 'example' => 'fileId:[100] is invalid.', - ], - 'AlarmList' => [ - 'description' => 'The alert rules that are associated with the real-time synchronization task. The value of this parameter is an array.'."\n", + 'Timeout' => ['description' => 'The timeout period of the API request. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '10000', 'title' => ''], + 'Status' => ['description' => 'The status of the API. Valid values: 0 and 1. The value 0 indicates that the API is not published. The value 1 indicates that the API is published.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ApiId' => ['description' => 'The ID of the DataService Studio API.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'title' => ''], + 'ApiMode' => ['description' => 'The type of the API. Valid values: 0, 1, and 2. The value 0 indicates that the API is generated in wizard mode. The value 1 indicates that the API is generated in script mode. The value 2 indicates that the API is generated by registration.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ProjectId' => ['description' => 'The ID of the workspace.', 'type' => 'integer', 'format' => 'int64', 'example' => '10001', 'title' => ''], + 'ResponseContentType' => ['description' => 'The format in which the response of the API request is returned. Valid values: 0 and 1. The value 0 indicates the JSON format. The value 1 indicates the XML format. APIs generated in wizard or script mode support the JSON format. APIs generated by registration support the JSON and XML formats.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'CreatorId' => ['description' => 'The ID of the Alibaba Cloud account used by the creator of the API.', 'type' => 'string', 'example' => '1234567', 'title' => ''], + 'VisibleRange' => ['description' => 'The scope in which the API is visible. Valid values: 0 and 1. The value 0 indicates that the API is visible to the members in a specific workspace. The value 1 indicates that the API is visible only to the API creator.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ModifiedTime' => ['description' => 'The time when the API was last modified.', 'type' => 'string', 'example' => '2020-06-23T00:21:01+0800', 'title' => ''], + 'OperatorId' => ['description' => 'The ID of the Alibaba Cloud account used by the user who last modified the API.', 'type' => 'string', 'example' => '2345678', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the group.', 'type' => 'string', 'example' => 'ab12**', 'title' => ''], + 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'Test API description', 'title' => ''], + 'RequestMethod' => ['description' => 'The request method of the API. Valid values: 0, 1, 2, and 3. The value 0 indicates the GET method, the value 1 indicates the POST method, the value 2 indicates the PUT method, and the value 3 indicates the DELETE method. APIs generated in wizard or script mode support the GET and POST methods. APIs generated by registration support the GET, POST, PUT, and DELETE methods.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'CreatedTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2020-06-23T00:21:01+0800', 'title' => ''], + 'ApiName' => ['description' => 'The name of the API.', 'type' => 'string', 'example' => 'Test API name', 'title' => ''], + 'TenantId' => ['description' => 'The ID of the tenant.', 'type' => 'integer', 'format' => 'int64', 'example' => '10001', 'title' => ''], + 'ApiPath' => ['description' => 'The path of the API.', 'type' => 'string', 'example' => '/test/1', 'title' => ''], + 'Protocols' => [ + 'description' => 'The protocol used by the API. Valid values: 0 and 1. The value 0 indicates HTTP. The value 1 indicates HTTPS. Multiple protocols are presented in a list.', 'type' => 'array', - 'items' => [ - 'description' => 'The alert rule that is associated with the real-time synchronization task.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the alert rule.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '45242', - ], - 'Enabled' => [ - 'description' => 'Indicates whether the alert rule is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RuleName' => [ - 'description' => 'The name of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'Delay alert rule name 1', - ], - 'Metric' => [ - 'description' => 'The alert type. Valid values:'."\n" - ."\n" - .'* taskStatus'."\n" - .'* bizDelay'."\n" - .'* taskFailoverCount'."\n" - .'* ddlUnsupport'."\n" - .'* ddlReport'."\n" - .'* totalDirtyRecordWriteInLines'."\n", - 'type' => 'string', - 'example' => 'taskStatus', - ], - 'Description' => [ - 'description' => 'The description of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'Description', - ], - 'AlarmRuleList' => [ - 'description' => 'The alert notification settings. The value of this parameter is an array.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The alert notification setting.'."\n", - 'type' => 'object', - 'properties' => [ - 'Level' => [ - 'description' => '* WARNING'."\n" - .'* CRITICAL'."\n", - 'type' => 'string', - 'example' => 'WARNING', - ], - 'Comparator' => [ - 'description' => 'The comparison operator, which indicates the method used to compare a metric with the alert rule.'."\n" - ."\n" - .'* \'=\''."\n" - .'* \'<\''."\n" - .'* \'>\''."\n", - 'type' => 'string', - 'example' => '=', - ], - 'Threshold' => [ - 'description' => 'The threshold for the comparison between a metric and the alert rule.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Duration' => [ - 'description' => 'The duration that a condition is met before an alert is triggered. Unit: minutes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'Aggregator' => [ - 'description' => 'The calculation method of a metric. Valid values:'."\n" - ."\n" - .'* avg'."\n" - .'* max'."\n", - 'type' => 'string', - 'example' => 'avg', - ], - ], + 'items' => ['description' => 'The protocol used by the API. Valid values: 0 and 1. The value 0 indicates that the API uses HTTP. The value 1 indicates that the API uses HTTPS. Two protocols are presented in a list.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'RegistrationDetails' => [ + 'description' => 'Registered API details. Only returned for registered APIs.', + 'type' => 'object', + 'properties' => [ + 'ServiceHost' => ['description' => 'The URL of the backend service.', 'type' => 'string', 'example' => 'http://www.abc.com', 'title' => ''], + 'ServiceContentType' => ['description' => 'The format in which the response of the API request is returned. Valid values: 0 and 1. The value 0 indicates the JSON format. The value 1 indicates the XML format. APIs generated in wizard or script mode support the JSON format. APIs generated by registration support the JSON and XML formats.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ServicePath' => ['description' => 'The path of the backend service.', 'type' => 'string', 'example' => '/index', 'title' => ''], + 'SuccessfulResultSample' => ['description' => 'The sample success response of the API.', 'type' => 'string', 'example' => '{"success": true}', 'title' => ''], + 'FailedResultSample' => ['description' => 'The sample error response of the API.', 'type' => 'string', 'example' => '{"success": false}', 'title' => ''], + 'ServiceRequestBodyDescription' => ['description' => 'The description of the request body initiated to call the backend service.', 'type' => 'string', 'example' => '{"abc":1}', 'title' => ''], + 'RegistrationErrorCodes' => [ + 'title' => '', + 'description' => 'The list of error codes for the registered API.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'title' => '', 'example' => 'The connection does not exist.'], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'title' => '', 'example' => 'Invalid.Tenant.ConnectionNotExists'], + 'ErrorSolution' => ['description' => 'The solution.', 'type' => 'string', 'title' => '', 'example' => 'retry'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'NotifyRule' => [ - 'description' => 'The settings for alert notification rules. The value of this parameter is an array.'."\n", + 'example' => '', + ], + 'RegistrationRequestParameters' => [ + 'title' => '', + 'description' => 'The list of request parameters for the registered API.', + 'type' => 'array', + 'items' => [ 'type' => 'object', 'properties' => [ - 'Interval' => [ - 'description' => 'The alert interval. Unit: minutes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - 'Warning' => [ - 'description' => 'The settings for Warning-level alert notifications.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The alert notification method. Valid values:'."\n" - ."\n" - .'* Mail'."\n" - .'* Phone'."\n" - .'* Sms'."\n" - .'* Ding'."\n", - 'type' => 'string', - 'example' => 'Ding', - ], - ], - 'Critical' => [ - 'description' => 'The settings for Critical-level alert notifications.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The alert notification method. Valid values:'."\n" - ."\n" - .'* Mail'."\n" - .'* Phone'."\n" - .'* Sms'."\n" - .'* Ding'."\n", - 'type' => 'string', - 'example' => 'Ding', - ], - ], + 'ParameterName' => ['description' => 'The name of the parameter.', 'type' => 'string', 'example' => 'name1', 'title' => ''], + 'ParameterPosition' => ['description' => 'The position of the parameter. Valid values: 0, 1, 2, and 3. The value 0 indicates that the parameter is in the URL path of the request. The value 1 indicates that the parameter is in the Query parameter of the request URL. The value 2 indicates that the parameter is in the request header. The value 3 indicates that the parameter is in the request body. APIs generated in wizard or script mode support only the Query position. APIs generated by registration whose request method is GET or DELETE support the Query and Head positions. APIs generated by registration whose request method is PUT or POST support the Query, Head, and Body positions.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ParameterDescription' => ['description' => 'The description.', 'type' => 'string', 'example' => 'description1', 'title' => ''], + 'DefaultValue' => ['description' => 'The default value.', 'type' => 'string', 'example' => 'default1', 'title' => ''], + 'ParameterOperator' => ['description' => 'The operator used for the value of the parameter. Valid values: 0, 1, 2, and 3. The value 0 indicates the Equal operator. The value 1 indicates the Like operator. The value 2 indicates the Const operator. The value 3 indicates the In operator. APIs generated in wizard mode support the Equal, Like, and In operators. APIs generated in script mode support the Equal operator. APIs generated by registration support the Equal and Const operators.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ExampleValue' => ['description' => 'The sample value.', 'type' => 'string', 'example' => 'example1', 'title' => ''], + 'ParameterDataType' => ['description' => 'The data type of the parameter. Valid values:'."\n" + ."\n" + .'- 0: String'."\n" + ."\n" + .'- 1: Int'."\n" + ."\n" + .'- 2: Long'."\n" + ."\n" + .'- 3: Float'."\n" + ."\n" + .'- 4: Double'."\n" + ."\n" + .'- 5: Boolean'."\n" + ."\n" + .'- 6: StringList'."\n" + ."\n" + .'- 7: IntList'."\n" + ."\n" + .'- 8: LongList'."\n" + ."\n" + .'- 9: FloatList'."\n" + ."\n" + .'- 10: DoubleList'."\n" + ."\n" + .'- 11: BooleanList', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'IsRequiredParameter' => ['description' => 'Indicates whether the parameter is required.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => 'The returned result.', + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], - 'SolutionDetail' => [ - 'description' => '* If the TaskType parameter is set to DI_REALTIME, the value null is returned.'."\n" - .'* If the TaskType parameter is set to DI_SOLUTION, the details of the data synchronization solution are returned.'."\n", + 'ScriptDetails' => [ + 'description' => 'The details of the API generated in script mode. This parameter is returned only if the API is generated in script mode.', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The status of the data synchronization solution. Valid values:'."\n" - ."\n" - .'* 0: successful'."\n" - .'* 1: not running'."\n" - .'* 2: running'."\n" - .'* 3: failed'."\n" - .'* 4: committed'."\n" - .'* 5: pending manual confirmation'."\n" - .'* 6: manually confirmed'."\n" - .'* 7: others'."\n" - .'* 8: waiting'."\n" - .'* 9: deleted'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'Type' => [ - 'description' => 'The type of the data synchronization solution.'."\n", - 'type' => 'string', - 'example' => 'holo', - ], - 'StartTime' => [ - 'description' => 'The start time of the data synchronization solution.'."\n", - 'type' => 'string', - 'example' => '2021-12-07 14:40:51', - ], - 'CreatorName' => [ - 'description' => 'The creator of the data synchronization solution.'."\n", - 'type' => 'string', - 'example' => 'dataworks_di', - ], - 'ProjectId' => [ - 'description' => 'The ID of the project to which the data synchronization solution belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000', - ], - 'SourceType' => [ - 'description' => 'The type of the source of the data synchronization solution.'."\n", - 'type' => 'string', - 'example' => 'mysql', - ], - 'ProcessContent' => [ - 'description' => 'The configuration details of the data synchronization solution.'."\n", - 'type' => 'string', - 'example' => '{"holoDatasource":"holo","offlineSyncConfig":{"nodeNameRule":"oneclick_holo_di_${db_table_name_src}_to_${db_table_name_dest}","resourceGroup":"group_219193793999490"},"processRuleId":1007,"readerConcurrent":10,"realtimeSyncConfig":{"content":{"order":{"hops":[{"from":"reader","to":"writer"}]},"setting":{"speed":{"readerConcurrent":10}},"steps":[{"stepType":"mysql","name":"reader","category":"reader","parameter":{"connection":[{"datasource":"mm","datasourceType":"mysql","table":[]}]}},{"stepType":"holo","name":"writer","category":"writer","parameter":{"datasource":"holo","writeMode":"replay","datasourceSchema":"public","tableMappingRule":{"datasource":[{"tableRule":[],"srcDatasourceName":"mm"}]}}}]},"extend":{"mode":"migration_holo","resourceGroup":"group_219193793999490"}},"setting":{"autoCreateWorkflow":true,"userDefinedFileNameExpression":"oneclick"},"srcType":"mysql","tableMappingRuleFromRealtimeSyncConfig":{"datasource":[{"srcDatasourceName":"mm","tableRule":[]}]}}', - ], - 'Name' => [ - 'description' => 'The name of the data synchronization solution.'."\n", - 'type' => 'string', - 'example' => 'holo_20211206161025', + 'IsPagedResponse' => ['description' => 'Indicates whether the entries were returned by page.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'SuccessfulResultSample' => ['description' => 'The sample success response of the API.', 'type' => 'string', 'example' => '{"success": true}', 'title' => ''], + 'FailedResultSample' => ['description' => 'The sample error response of the API.', 'type' => 'string', 'example' => '{"success": false}', 'title' => ''], + 'Script' => ['description' => 'The SQL script.', 'type' => 'string', 'example' => 'select a from t', 'title' => ''], + 'ScriptErrorCodes' => [ + 'description' => 'The error codes returned for the API generated in script mode.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'fail to call', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '1001', 'title' => ''], + 'ErrorSolution' => ['description' => 'The solution used to fix the error.', 'type' => 'string', 'example' => 'retry', 'title' => ''], + ], + 'description' => 'The returned result.', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'ProcessExtra' => [ - 'description' => 'The additional parameters of the data synchronization solution.'."\n", - 'type' => 'string', - 'example' => '{"processType":"new","tableNum":300}', + 'ScriptRequestParameters' => [ + 'description' => 'The request parameters of the API generated in script mode.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ParameterName' => ['description' => 'The name of the parameter.', 'type' => 'string', 'example' => 'param1', 'title' => ''], + 'ParameterPosition' => ['description' => 'The position of the parameter. Valid values:'."\n" + ."\n" + .'- 0: indicates that the parameter is in the URL path of the request.'."\n" + ."\n" + .'- 1: indicates that the parameter is in the Query parameter of the request URL.'."\n" + ."\n" + .'- 2: indicates that the parameter is in the request header.'."\n" + ."\n" + .'- 3: indicates that the parameter is in the request body.'."\n" + ."\n" + .'APIs generated in wizard or script mode support only the Query position. APIs generated by registration whose request method is GET or DELETE support the Query and Head positions. APIs generated by registration whose request method is PUT or POST support the Query, Head, and Body positions.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ParameterDescription' => ['description' => 'The description.', 'type' => 'string', 'example' => 'description1', 'title' => ''], + 'DefaultValue' => ['description' => 'The default value.', 'type' => 'string', 'example' => 'default1', 'title' => ''], + 'ParameterOperator' => ['description' => 'The operator used for the value of the parameter. Valid values:'."\n" + ."\n" + .'- 0: Equal'."\n" + ."\n" + .'- 1: Like'."\n" + ."\n" + .'- 2: Const'."\n" + ."\n" + .'- 3: In'."\n" + ."\n" + .'APIs generated in wizard mode support the Equal, Like, and In operators. APIs generated in script mode support the Equal operator. APIs generated by registration support the Equal and Const operators.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ExampleValue' => ['description' => 'The sample value.', 'type' => 'string', 'example' => 'example1', 'title' => ''], + 'ParameterDataType' => ['description' => 'The data type of the parameter. Valid values:'."\n" + ."\n" + .'- 0: String'."\n" + ."\n" + .'- 1: Int'."\n" + ."\n" + .'- 2: Long'."\n" + ."\n" + .'- 3: Float'."\n" + ."\n" + .'- 4: Double'."\n" + ."\n" + .'- 5: Boolean'."\n" + ."\n" + .'- 6: StringList'."\n" + ."\n" + .'- 7: IntList'."\n" + ."\n" + .'- 8: LongList'."\n" + ."\n" + .'- 9: FloatList'."\n" + ."\n" + .'- 10: DoubleList'."\n" + ."\n" + .'- 11: BooleanList', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'IsRequiredParameter' => ['description' => 'Indicates whether the parameter is required.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => 'The returned result.', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'SubmitTime' => [ - 'description' => 'The time when the data synchronization solution was committed.'."\n", - 'type' => 'string', - 'example' => '2021-12-07 14:40:51', + 'ScriptResponseParameters' => [ + 'description' => 'The response parameters of the API generated in script mode.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ParameterDescription' => ['description' => 'The description.', 'type' => 'string', 'example' => 'description2', 'title' => ''], + 'ParameterName' => ['description' => 'The name of the parameter.', 'type' => 'string', 'example' => 'param2', 'title' => ''], + 'ExampleValue' => ['description' => 'The sample value.', 'type' => 'string', 'example' => 'example2', 'title' => ''], + 'ParameterDataType' => ['description' => 'The data type of the parameter. Valid values:'."\n" + ."\n" + .'- 0: String'."\n" + ."\n" + .'- 1: Int'."\n" + ."\n" + .'- 2: Long'."\n" + ."\n" + .'- 3: Float'."\n" + ."\n" + .'- 4: Double'."\n" + ."\n" + .'- 5: Boolean'."\n" + ."\n" + .'- 6: StringList'."\n" + ."\n" + .'- 7: IntList'."\n" + ."\n" + .'- 8: LongList'."\n" + ."\n" + .'- 9: FloatList'."\n" + ."\n" + .'- 10: DoubleList'."\n" + ."\n" + .'- 11: BooleanList', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + ], + 'description' => 'The returned result.', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'Id' => [ - 'description' => 'The ID of the data synchronization solution.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', + 'ScriptConnection' => [ + 'description' => 'The data source information of the API generated in script mode.', + 'type' => 'object', + 'properties' => [ + 'TableName' => ['description' => 'The name of the table in the data source.', 'type' => 'string', 'example' => 't', 'title' => ''], + 'ConnectionId' => ['description' => 'The ID of the data source.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Param.Invalid', - 'errorMessage' => 'The parameter is invalid.', - ], - ], - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden.', + 'WizardDetails' => [ + 'description' => 'The details of the API generated in wizard mode. This parameter is returned only if the API is generated in wizard mode.', + 'type' => 'object', + 'properties' => [ + 'IsPagedResponse' => ['description' => 'Indicates whether the entries were returned by page.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'SuccessfulResultSample' => ['description' => 'The sample success response of the API.', 'type' => 'string', 'example' => '{"success": true}', 'title' => ''], + 'FailedResultSample' => ['description' => 'The sample error response of the API.', 'type' => 'string', 'example' => '{"success": false}', 'title' => ''], + 'WizardErrorCodes' => [ + 'description' => 'The error codes returned for the API generated in wizard mode.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'fail to call', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '1001', 'title' => ''], + 'ErrorSolution' => ['description' => 'The solution used to fix the error.', 'type' => 'string', 'example' => 'retry', 'title' => ''], + ], + 'description' => 'The returned result.', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'WizardRequestParameters' => [ + 'description' => 'The request parameters of the API generated in wizard mode.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ParameterName' => ['description' => 'The name of the parameter.', 'type' => 'string', 'example' => 'param1', 'title' => ''], + 'ParameterPosition' => ['description' => 'The position of the parameter. Valid values: 0, 1, 2, and 3. The value 0 indicates that the parameter is in the URL path of the request. The value 1 indicates that the parameter is in the Query parameter of the request URL. The value 2 indicates that the parameter is in the request header. The value 3 indicates that the parameter is in the request body. APIs generated in wizard or script mode support only the Query position. APIs generated by registration whose request method is GET or DELETE support the Query and Head positions. APIs generated by registration whose request method is PUT or POST support the Query, Head, and Body positions.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ParameterDescription' => ['description' => 'The description.', 'type' => 'string', 'example' => 'description1', 'title' => ''], + 'DefaultValue' => ['description' => 'The default value.', 'type' => 'string', 'example' => 'default1', 'title' => ''], + 'ParameterOperator' => ['description' => 'The operator used for the value of the parameter. Valid values: 0, 1, 2, and 3. The value 0 indicates the Equal operator. The value 1 indicates the Like operator. The value 2 indicates the Const operator. The value 3 indicates the In operator. APIs generated in wizard mode support the Equal, Like, and In operators. APIs generated in script mode support the Equal operator. APIs generated by registration support the Equal and Const operators.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ExampleValue' => ['description' => 'The sample value.', 'type' => 'string', 'example' => 'example1', 'title' => ''], + 'ParameterDataType' => ['description' => 'The data type of the parameter. Valid values:'."\n" + ."\n" + .'- 0: String'."\n" + ."\n" + .'- 1: Int'."\n" + ."\n" + .'- 2: Long'."\n" + ."\n" + .'- 3: Float'."\n" + ."\n" + .'- 4: Double'."\n" + ."\n" + .'- 5: Boolean'."\n" + ."\n" + .'- 6: StringList'."\n" + ."\n" + .'- 7: IntList'."\n" + ."\n" + .'- 8: LongList'."\n" + ."\n" + .'- 9: FloatList'."\n" + ."\n" + .'- 10: DoubleList'."\n" + ."\n" + .'- 11: BooleanList', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'IsRequiredParameter' => ['description' => 'Indicates whether the parameter is required.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => 'The returned result.', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'WizardResponseParameters' => [ + 'description' => 'The response parameters of the API generated in wizard mode.', + 'type' => 'array', + 'items' => [ + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'ParameterDescription' => ['description' => 'The description.', 'type' => 'string', 'example' => 'description2', 'title' => ''], + 'ParameterName' => ['description' => 'The name of the parameter.', 'type' => 'string', 'example' => 'param2', 'title' => ''], + 'ExampleValue' => ['description' => 'The sample value.', 'type' => 'string', 'example' => 'example2', 'title' => ''], + 'ParameterDataType' => ['description' => 'The data type of the parameter. Valid values:'."\n" + ."\n" + .'- 0: String'."\n" + ."\n" + .'- 1: Int'."\n" + ."\n" + .'- 2: Long'."\n" + ."\n" + .'- 3: Float'."\n" + ."\n" + .'- 4: Double'."\n" + ."\n" + .'- 5: Boolean'."\n" + ."\n" + .'- 6: StringList'."\n" + ."\n" + .'- 7: IntList'."\n" + ."\n" + .'- 8: LongList'."\n" + ."\n" + .'- 9: FloatList'."\n" + ."\n" + .'- 10: DoubleList'."\n" + ."\n" + .'- 11: BooleanList', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'WizardConnection' => [ + 'description' => 'The data source information of the API generated in wizard mode.', + 'type' => 'object', + 'properties' => [ + 'TableName' => ['description' => 'The name of the table in the data source.', 'type' => 'string', 'example' => 't', 'title' => ''], + 'ConnectionId' => ['description' => 'The ID of the data source.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'SqlMode' => ['description' => 'The SQL mode. 0: Basic SQL; 1: Advanced SQL.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal error occurred.', - ], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0bc1411515937635973****\\\\t\\",\\n \\"Data\\": {\\n \\"Code\\": \\"{\\\\\\"extend\\\\\\":{\\\\\\"mode\\\\\\":\\\\\\"wizard\\\\\\",\\\\\\"resourceGroup\\\\\\":\\\\\\"S_res_group_287114642182658_1560324290517\\\\\\"},\\\\\\"nodeDef\\\\\\":{},\\\\\\"order\\\\\\":{\\\\\\"hops\\\\\\":[{\\\\\\"from\\\\\\":\\\\\\"datahub_8htXSsfiS2vtZCVG\\\\\\",\\\\\\"to\\\\\\":\\\\\\"datahub_CRHBAyGfhSaLmv2f\\\\\\"}]},\\\\\\"setting\\\\\\":{\\\\\\"errorLimit\\\\\\":{},\\\\\\"jvmOption\\\\\\":\\\\\\"\\\\\\"},\\\\\\"steps\\\\\\":[{\\\\\\"stepType\\\\\\":\\\\\\"datahub\\\\\\",\\\\\\"category\\\\\\":\\\\\\"writer\\\\\\",\\\\\\"displayName\\\\\\":\\\\\\"DataHub1\\\\\\",\\\\\\"parameter\\\\\\":{\\\\\\"batchSize\\\\\\":1000,\\\\\\"datasource\\\\\\":\\\\\\"datahub_cloud_dev_test\\\\\\",\\\\\\"topic\\\\\\":\\\\\\"dwd_tfc_opt_speed_rid_amap_rt\\\\\\"},\\\\\\"name\\\\\\":\\\\\\"datahub_CRHBAyGfhSaLmv2f\\\\\\",\\\\\\"gui\\\\\\":{\\\\\\"x\\\\\\":262,\\\\\\"y\\\\\\":325}},{\\\\\\"stepType\\\\\\":\\\\\\"datahub\\\\\\",\\\\\\"displayName\\\\\\":\\\\\\"DataHub2\\\\\\",\\\\\\"parameter\\\\\\":{\\\\\\"datasource\\\\\\":\\\\\\"datahub_uric_test\\\\\\",\\\\\\"topic\\\\\\":\\\\\\"dwd_tfc_opt_speed_rid_amap_rt_330000\\\\\\",\\\\\\"batchSize\\\\\\":1000},\\\\\\"name\\\\\\":\\\\\\"datahub_8htXSsfiS2vtZCVG\\\\\\",\\\\\\"gui\\\\\\":{\\\\\\"x\\\\\\":268,\\\\\\"y\\\\\\":160.5},\\\\\\"category\\\\\\":\\\\\\"writer\\\\\\"}]}\\",\\n \\"Status\\": \\"success\\",\\n \\"Message\\": \\"fileId:[100] is invalid.\\",\\n \\"AlarmList\\": [\\n {\\n \\"Id\\": 45242,\\n \\"Enabled\\": true,\\n \\"RuleName\\": \\"Delay alert rule name 1\\",\\n \\"Metric\\": \\"taskStatus\\",\\n \\"Description\\": \\"Description\\",\\n \\"AlarmRuleList\\": [\\n {\\n \\"Level\\": \\"WARNING\\",\\n \\"Comparator\\": \\"=\\",\\n \\"Threshold\\": 1,\\n \\"Duration\\": 3,\\n \\"Aggregator\\": \\"avg\\"\\n }\\n ],\\n \\"NotifyRule\\": {\\n \\"Interval\\": 5,\\n \\"Warning\\": [\\n \\"Ding\\"\\n ],\\n \\"Critical\\": [\\n \\"Ding\\"\\n ]\\n }\\n }\\n ],\\n \\"SolutionDetail\\": {\\n \\"Status\\": \\"0\\",\\n \\"Type\\": \\"holo\\",\\n \\"StartTime\\": \\"2021-12-07 14:40:51\\",\\n \\"CreatorName\\": \\"dataworks_di\\",\\n \\"ProjectId\\": 10000,\\n \\"SourceType\\": \\"mysql\\",\\n \\"ProcessContent\\": \\"{\\\\\\"holoDatasource\\\\\\":\\\\\\"holo\\\\\\",\\\\\\"offlineSyncConfig\\\\\\":{\\\\\\"nodeNameRule\\\\\\":\\\\\\"oneclick_holo_di_${db_table_name_src}_to_${db_table_name_dest}\\\\\\",\\\\\\"resourceGroup\\\\\\":\\\\\\"group_219193793999490\\\\\\"},\\\\\\"processRuleId\\\\\\":1007,\\\\\\"readerConcurrent\\\\\\":10,\\\\\\"realtimeSyncConfig\\\\\\":{\\\\\\"content\\\\\\":{\\\\\\"order\\\\\\":{\\\\\\"hops\\\\\\":[{\\\\\\"from\\\\\\":\\\\\\"reader\\\\\\",\\\\\\"to\\\\\\":\\\\\\"writer\\\\\\"}]},\\\\\\"setting\\\\\\":{\\\\\\"speed\\\\\\":{\\\\\\"readerConcurrent\\\\\\":10}},\\\\\\"steps\\\\\\":[{\\\\\\"stepType\\\\\\":\\\\\\"mysql\\\\\\",\\\\\\"name\\\\\\":\\\\\\"reader\\\\\\",\\\\\\"category\\\\\\":\\\\\\"reader\\\\\\",\\\\\\"parameter\\\\\\":{\\\\\\"connection\\\\\\":[{\\\\\\"datasource\\\\\\":\\\\\\"mm\\\\\\",\\\\\\"datasourceType\\\\\\":\\\\\\"mysql\\\\\\",\\\\\\"table\\\\\\":[]}]}},{\\\\\\"stepType\\\\\\":\\\\\\"holo\\\\\\",\\\\\\"name\\\\\\":\\\\\\"writer\\\\\\",\\\\\\"category\\\\\\":\\\\\\"writer\\\\\\",\\\\\\"parameter\\\\\\":{\\\\\\"datasource\\\\\\":\\\\\\"holo\\\\\\",\\\\\\"writeMode\\\\\\":\\\\\\"replay\\\\\\",\\\\\\"datasourceSchema\\\\\\":\\\\\\"public\\\\\\",\\\\\\"tableMappingRule\\\\\\":{\\\\\\"datasource\\\\\\":[{\\\\\\"tableRule\\\\\\":[],\\\\\\"srcDatasourceName\\\\\\":\\\\\\"mm\\\\\\"}]}}}]},\\\\\\"extend\\\\\\":{\\\\\\"mode\\\\\\":\\\\\\"migration_holo\\\\\\",\\\\\\"resourceGroup\\\\\\":\\\\\\"group_219193793999490\\\\\\"}},\\\\\\"setting\\\\\\":{\\\\\\"autoCreateWorkflow\\\\\\":true,\\\\\\"userDefinedFileNameExpression\\\\\\":\\\\\\"oneclick\\\\\\"},\\\\\\"srcType\\\\\\":\\\\\\"mysql\\\\\\",\\\\\\"tableMappingRuleFromRealtimeSyncConfig\\\\\\":{\\\\\\"datasource\\\\\\":[{\\\\\\"srcDatasourceName\\\\\\":\\\\\\"mm\\\\\\",\\\\\\"tableRule\\\\\\":[]}]}}\\",\\n \\"Name\\": \\"holo_20211206161025\\",\\n \\"ProcessExtra\\": \\"{\\\\\\"processType\\\\\\":\\\\\\"new\\\\\\",\\\\\\"tableNum\\\\\\":300}\\",\\n \\"SubmitTime\\": \\"2021-12-07 14:40:51\\",\\n \\"Id\\": 100\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 0bc1411515937635973****\\t\\n \\n {\\"extend\\":{\\"mode\\":\\"wizard\\",\\"resourceGroup\\":\\"S_res_group_287114642182658_1560324290517\\"},\\"nodeDef\\":{},\\"order\\":{\\"hops\\":[{\\"from\\":\\"datahub_8htXSsfiS2vtZCVG\\",\\"to\\":\\"datahub_CRHBAyGfhSaLmv2f\\"}]},\\"setting\\":{\\"errorLimit\\":{},\\"jvmOption\\":\\"\\"},\\"steps\\":[{\\"stepType\\":\\"datahub\\",\\"category\\":\\"writer\\",\\"displayName\\":\\"DataHub1\\",\\"parameter\\":{\\"batchSize\\":1000,\\"datasource\\":\\"datahub_cloud_dev_test\\",\\"topic\\":\\"dwd_tfc_opt_speed_rid_amap_rt\\"},\\"name\\":\\"datahub_CRHBAyGfhSaLmv2f\\",\\"gui\\":{\\"x\\":262,\\"y\\":325}},{\\"stepType\\":\\"datahub\\",\\"displayName\\":\\"DataHub2\\",\\"parameter\\":{\\"datasource\\":\\"datahub_uric_test\\",\\"topic\\":\\"dwd_tfc_opt_speed_rid_amap_rt_330000\\",\\"batchSize\\":1000},\\"name\\":\\"datahub_8htXSsfiS2vtZCVG\\",\\"gui\\":{\\"x\\":268,\\"y\\":160.5},\\"category\\":\\"writer\\"}]}\\n success\\n fileId:[100] is invalid.\\n \\n 0\\n holo\\n 2021-12-07 14:40:51\\n dataworks_di\\n 10000\\n mysql\\n {\\"holoDatasource\\":\\"holo\\",\\"offlineSyncConfig\\":{\\"nodeNameRule\\":\\"oneclick_holo_di_${db_table_name_src}_to_${db_table_name_dest}\\",\\"resourceGroup\\":\\"group_219193793999490\\"},\\"processRuleId\\":1007,\\"readerConcurrent\\":10,\\"realtimeSyncConfig\\":{\\"content\\":{\\"order\\":{\\"hops\\":[{\\"from\\":\\"reader\\",\\"to\\":\\"writer\\"}]},\\"setting\\":{\\"speed\\":{\\"readerConcurrent\\":10}},\\"steps\\":[{\\"stepType\\":\\"mysql\\",\\"name\\":\\"reader\\",\\"category\\":\\"reader\\",\\"parameter\\":{\\"connection\\":[{\\"datasource\\":\\"mm\\",\\"datasourceType\\":\\"mysql\\",\\"table\\":[]}]}},{\\"stepType\\":\\"holo\\",\\"name\\":\\"writer\\",\\"category\\":\\"writer\\",\\"parameter\\":{\\"datasource\\":\\"holo\\",\\"writeMode\\":\\"replay\\",\\"datasourceSchema\\":\\"public\\",\\"tableMappingRule\\":{\\"datasource\\":[{\\"tableRule\\":[],\\"srcDatasourceName\\":\\"mm\\"}]}}}]},\\"extend\\":{\\"mode\\":\\"migration_holo\\",\\"resourceGroup\\":\\"group_219193793999490\\"}},\\"setting\\":{\\"autoCreateWorkflow\\":true,\\"userDefinedFileNameExpression\\":\\"oneclick\\"},\\"srcType\\":\\"mysql\\",\\"tableMappingRuleFromRealtimeSyncConfig\\":{\\"datasource\\":[{\\"srcDatasourceName\\":\\"mm\\",\\"tableRule\\":[]}]}}\\n holo_20211206161025\\n {\\"processType\\":\\"new\\",\\"tableNum\\":300}\\n 2021-12-07 14:40:51\\n 100\\n \\n \\n","errorExample":""}]', - 'title' => 'GetDISyncTask', - 'summary' => 'Queries the details of a real-time synchronization task or a data synchronization solution.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Data\\": {\\n \\"Timeout\\": 10000,\\n \\"Status\\": 1,\\n \\"ApiId\\": 10000,\\n \\"ApiMode\\": 0,\\n \\"ProjectId\\": 10001,\\n \\"ResponseContentType\\": 0,\\n \\"CreatorId\\": \\"1234567\\",\\n \\"VisibleRange\\": 0,\\n \\"ModifiedTime\\": \\"2020-06-23T00:21:01+0800\\",\\n \\"OperatorId\\": \\"2345678\\",\\n \\"GroupId\\": \\"ab12**\\",\\n \\"Description\\": \\"Test API description\\",\\n \\"RequestMethod\\": 0,\\n \\"CreatedTime\\": \\"2020-06-23T00:21:01+0800\\",\\n \\"ApiName\\": \\"Test API name\\",\\n \\"TenantId\\": 10001,\\n \\"ApiPath\\": \\"/test/1\\",\\n \\"Protocols\\": [\\n 0\\n ],\\n \\"RegistrationDetails\\": {\\n \\"ServiceHost\\": \\"http://www.abc.com\\",\\n \\"ServiceContentType\\": 0,\\n \\"ServicePath\\": \\"/index\\",\\n \\"SuccessfulResultSample\\": \\"{\\\\\\"success\\\\\\": true}\\",\\n \\"FailedResultSample\\": \\"{\\\\\\"success\\\\\\": false}\\",\\n \\"ServiceRequestBodyDescription\\": \\"{\\\\\\"abc\\\\\\":1}\\",\\n \\"RegistrationErrorCodes\\": [\\n {\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"ErrorSolution\\": \\"retry\\"\\n }\\n ],\\n \\"RegistrationRequestParameters\\": [\\n {\\n \\"ParameterName\\": \\"name1\\",\\n \\"ParameterPosition\\": 0,\\n \\"ParameterDescription\\": \\"description1\\",\\n \\"DefaultValue\\": \\"default1\\",\\n \\"ParameterOperator\\": 0,\\n \\"ExampleValue\\": \\"example1\\",\\n \\"ParameterDataType\\": 0,\\n \\"IsRequiredParameter\\": true\\n }\\n ]\\n },\\n \\"ScriptDetails\\": {\\n \\"IsPagedResponse\\": true,\\n \\"SuccessfulResultSample\\": \\"{\\\\\\"success\\\\\\": true}\\",\\n \\"FailedResultSample\\": \\"{\\\\\\"success\\\\\\": false}\\",\\n \\"Script\\": \\"select a from t\\",\\n \\"ScriptErrorCodes\\": [\\n {\\n \\"ErrorMessage\\": \\"fail to call\\",\\n \\"ErrorCode\\": \\"1001\\",\\n \\"ErrorSolution\\": \\"retry\\"\\n }\\n ],\\n \\"ScriptRequestParameters\\": [\\n {\\n \\"ParameterName\\": \\"param1\\",\\n \\"ParameterPosition\\": 0,\\n \\"ParameterDescription\\": \\"description1\\",\\n \\"DefaultValue\\": \\"default1\\",\\n \\"ParameterOperator\\": 0,\\n \\"ExampleValue\\": \\"example1\\",\\n \\"ParameterDataType\\": 0,\\n \\"IsRequiredParameter\\": true\\n }\\n ],\\n \\"ScriptResponseParameters\\": [\\n {\\n \\"ParameterDescription\\": \\"description2\\",\\n \\"ParameterName\\": \\"param2\\",\\n \\"ExampleValue\\": \\"example2\\",\\n \\"ParameterDataType\\": 0\\n }\\n ],\\n \\"ScriptConnection\\": {\\n \\"TableName\\": \\"t\\",\\n \\"ConnectionId\\": 123\\n }\\n },\\n \\"WizardDetails\\": {\\n \\"IsPagedResponse\\": true,\\n \\"SuccessfulResultSample\\": \\"{\\\\\\"success\\\\\\": true}\\",\\n \\"FailedResultSample\\": \\"{\\\\\\"success\\\\\\": false}\\",\\n \\"WizardErrorCodes\\": [\\n {\\n \\"ErrorMessage\\": \\"fail to call\\",\\n \\"ErrorCode\\": \\"1001\\",\\n \\"ErrorSolution\\": \\"retry\\"\\n }\\n ],\\n \\"WizardRequestParameters\\": [\\n {\\n \\"ParameterName\\": \\"param1\\",\\n \\"ParameterPosition\\": 0,\\n \\"ParameterDescription\\": \\"description1\\",\\n \\"DefaultValue\\": \\"default1\\",\\n \\"ParameterOperator\\": 0,\\n \\"ExampleValue\\": \\"example1\\",\\n \\"ParameterDataType\\": 0,\\n \\"IsRequiredParameter\\": true\\n }\\n ],\\n \\"WizardResponseParameters\\": [\\n {\\n \\"ParameterDescription\\": \\"description2\\",\\n \\"ParameterName\\": \\"param2\\",\\n \\"ExampleValue\\": \\"example2\\",\\n \\"ParameterDataType\\": 0\\n }\\n ],\\n \\"WizardConnection\\": {\\n \\"TableName\\": \\"t\\",\\n \\"ConnectionId\\": 123\\n }\\n },\\n \\"SqlMode\\": 0\\n }\\n}","type":"json"}]', + 'title' => 'GetDataServicePublishedApi', 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', + 'responseParamsDescription' => 'The details of different types of APIs are returned in different fields. Wizard APIs use the WizardDetails field, script APIs use the ScriptDetails field, and registration APIs use the RegistrationDetails field.', 'extraInfo' => ' ', - ], - 'DeployDISyncTask' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2023-10-10T02:04:49.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'translator' => 'manual', + ], + 'GetDataSourceMeta' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], [ - 'PrivateKey' => [], + 'APP' => [], ], [ - 'APP' => [], + 'PrivateKey' => [], ], ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'get', - ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the object that you want to deploy. Valid values:'."\n" - ."\n" - .'* DI_REALTIME: real-time synchronization node'."\n" - .'* DI_SOLUTION: data synchronization solution'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '10000000000', - 'minimum' => '1', - 'example' => '10000', - ], + 'schema' => ['description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '10000000000', 'minimum' => '1', 'example' => '10000'], ], [ - 'name' => 'TaskType', + 'name' => 'DatasourceName', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the object that you want to deploy. Valid values:'."\n" - ."\n" - .'* DI_REALTIME: real-time synchronization task'."\n" - .'* DI_SOLUTION: synchronization task created in Data Integration'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'DI_REALTIME', - ], + 'schema' => ['description' => 'The name of the data source.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mysql_name'], ], [ - 'name' => 'FileId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => '* If you set the TaskType parameter to DI_REALTIME, set the FileId parameter to the ID of the real-time synchronization task that you want to deploy.'."\n" - .'* If you set the TaskType parameter to DI_SOLUTION, set the FileId parameter to the ID of the synchronization task that you want to deploy.'."\n" - ."\n" - .'You can call the [ListFiles](~~173942~~) operation to query the ID of the real-time synchronization task or the synchronization task created in Data Integration.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9999999999999999', - 'minimum' => '1', - 'example' => '100', - ], + 'schema' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1', 'example' => '1', 'default' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'maximum' => '10000', 'minimum' => '1', 'example' => '10', 'default' => '10'], + ], + [ + 'name' => 'EnvType', + 'in' => 'query', + 'schema' => ['description' => 'The environment in which the data source resides. Valid values:'."\n" + ."\n" + .'* 0: development environment'."\n" + .'* 1: production environment'."\n", 'type' => 'string', 'required' => false, 'example' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'description' => 'The returned result.'."\n", 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'The ID of the request. You can query logs and troubleshoot issues based on the ID.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '0bc1411515937635973****', - ], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], + 'RequestId' => ['description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", 'type' => 'string', 'example' => '0000-ABCD-EFG '], 'Data' => [ - 'description' => 'Indicates whether the real-time synchronization node or data synchronization solution is deployed. Valid values:'."\n" - ."\n" - .'* success: The real-time synchronization node or data synchronization solution is deployed.'."\n" - .'* fail: The real-time synchronization node or data synchronization solution fails to be deployed.'."\n", + 'description' => 'The returned result.'."\n", 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The cause of the failure to deploy the real-time synchronization node or data synchronization solution.'."\n" - ."\n" - .'If the real-time synchronization node or data synchronization solution is deployed, the value null is returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Message' => [ - 'description' => 'The reason for the failure to publish a data integration synchronization task.'."\n" - ."\n" - .'If the data integration synchronization task is published successfully, the return value of this parameter is empty.', - 'type' => 'string', - 'example' => 'submit and deploy fail.', - ], + 'Status' => ['description' => 'Indicates whether the metadata of the data source is obtained. Valid values:'."\n" + ."\n" + .'* success: The metadata of the data source is obtained.'."\n" + .'* fail: The metadata of the data source failed to be obtained. You can troubleshoot issues based on the Message parameter.'."\n", 'type' => 'string', 'example' => 'success'], + 'Message' => ['description' => 'The reason why the metadata of the data source fails to be obtained. If the metadata of the data source is obtained, no value is returned for this parameter.'."\n", 'type' => 'string', 'example' => 'read datasource time out'], + 'Meta' => ['description' => 'The returned metadata of the data source. The returned metadata is in the JSON format.'."\n" + ."\n" + .'`{"dbTables":[{"dbName":"testdb","schema":[{"tableInfos":[{"dbName":"testdb","enable":true,"table":"table1","tableName":"table1"}]},{"tableInfos":[{"dbName":"testdb","enable":true,"table":"table2","tableName":"table2"}]}]}]}`'."\n" + ."\n" + .'Parameter description:'."\n" + ."\n" + .'* dbName: the name of the database in which the data source resides.'."\n" + .'* schema: the schema of the database.'."\n" + .'* enable: indicates whether the database is available. The valid values are true and false. The value true indicates that the database is available. The value false indicates that the database is unavailable.'."\n" + .'* tableName: the name of the table in the database.'."\n" + .'* tableInfos: the information about the table in the database.'."\n", 'type' => 'string', 'example' => '{"dbTables":[{"dbName":"testdb","schema":[{"tableInfos":[{"dbName":"testdb","enable":true,"table":"table1","tableName":"table1"}]},{"tableInfos":[{"dbName":"testdb","enable":true,"table":"table2","tableName":"table2"}]}]}]}'], ], ], ], @@ -21891,100 +15578,73 @@ ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Param.Invalid', - 'errorMessage' => 'The parameter is invalid.', - ], + ['errorCode' => 'Invalid.DI.Parameter', 'errorMessage' => 'The parameter is invalid.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden.', - ], + ['errorCode' => 'Forbidden.DI.NoPrivilege', 'errorMessage' => 'No access.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal error occurred.', - ], + ['errorCode' => 'InternalError.DI.Parameter', 'errorMessage' => 'A DI internal error occurred.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0bc14115159376359******\\",\\n \\"Data\\": {\\n \\"Status\\": \\"success\\",\\n \\"Message\\": \\"submit and deploy fail.\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 0bc1411515937635973****\\n \\n success\\n submit and deploy fail.\\n \\n","errorExample":""}]', - 'title' => 'DeployDISyncTask', - 'summary' => 'Deploys a real-time synchronization task.', - ], - 'GetDISyncInstanceInfo' => [ - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0000-ABCD-EFG\\\\t\\",\\n \\"Data\\": {\\n \\"Status\\": \\"success\\",\\n \\"Message\\": \\"read datasource time out\\",\\n \\"Meta\\": \\"{\\\\\\"dbTables\\\\\\":[{\\\\\\"dbName\\\\\\":\\\\\\"testdb\\\\\\",\\\\\\"schema\\\\\\":[{\\\\\\"tableInfos\\\\\\":[{\\\\\\"dbName\\\\\\":\\\\\\"testdb\\\\\\",\\\\\\"enable\\\\\\":true,\\\\\\"table\\\\\\":\\\\\\"table1\\\\\\",\\\\\\"tableName\\\\\\":\\\\\\"table1\\\\\\"}]},{\\\\\\"tableInfos\\\\\\":[{\\\\\\"dbName\\\\\\":\\\\\\"testdb\\\\\\",\\\\\\"enable\\\\\\":true,\\\\\\"table\\\\\\":\\\\\\"table2\\\\\\",\\\\\\"tableName\\\\\\":\\\\\\"table2\\\\\\"}]}]}]}\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 0000-ABCD-EFG\\t\\n \\n success\\n read datasource time out\\n {\\"dbTables\\":[{\\"dbName\\":\\"testdb\\",\\"schema\\":[{\\"tableInfos\\":[{\\"dbName\\":\\"testdb\\",\\"enable\\":true,\\"table\\":\\"table1\\",\\"tableName\\":\\"table1\\"}]},{\\"tableInfos\\":[{\\"dbName\\":\\"testdb\\",\\"enable\\":true,\\"table\\":\\"table2\\",\\"tableName\\":\\"table2\\"}]}]}]}\\n \\n","errorExample":""}]', + 'title' => 'GetDataSourceMeta', + 'summary' => 'Queries the metadata of a specified data source.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-11-14T10:54:41.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], - 'security' => [ - [ - 'AK' => [], - ], + 'ramActions' => [ [ - 'PrivateKey' => [], + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], + ], + ], + 'GetDeployment' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'APP' => [], + 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', + 'abilityTreeCode' => '78242', + 'abilityTreeNodes' => ['FEATUREdide8FM783'], ], 'parameters' => [ [ 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to query the ID.'."\n" - ."\n" - .'You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '10000000000', - 'minimum' => '1', - 'example' => '10000', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the DataWorks workspace. You can click the Workspace Manage icon in the upper-right corner of the DataStudio page to go to the Workspace Management page and view the workspace ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10000', 'title' => ''], ], [ - 'name' => 'TaskType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the object that you want to query. Valid values:'."\n" - ."\n" - .'* DI_REALTIME: real-time synchronization task'."\n" - .'* DI_SOLUTION: data synchronization solution'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'DI_REALTIME', - ], + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => ['description' => 'The GUID of the DataWorks workspace. You can view the GUID in the upper part of the DataStudio page. You can also select another GUID to switch to another workspace.'."\n" + ."\n" + .'You must specify either this parameter or the ProjectId parameter to determine the DataWorks workspace to which the operation is applied.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dw_project', 'title' => ''], ], [ - 'name' => 'FileId', - 'in' => 'query', - 'schema' => [ - 'description' => '* If you set the TaskType parameter to DI_REALTIME, set the FileId parameter to the ID of the real-time synchronization task that you want to query.'."\n" - .'* If you set the TaskType parameter to DI_SOLUTION, set the FileId parameter to the ID of the data synchronization solution that you want to query.'."\n" - ."\n" - .'You can call the [ListFiles](~~173942~~) operation to query the ID of the real-time synchronization task or data synchronization solution.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9999999999999999', - 'minimum' => '1', - 'example' => '100', - ], + 'name' => 'DeploymentId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the deployment task. A deployment task ID is generated when you call the [SubmitFile](~~173944~~) or [DeployFile](~~173956~~) operation.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '3000001', 'title' => ''], ], ], 'responses' => [ @@ -21993,498 +15653,247 @@ 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0bc1411515937635973****', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'The connection does not exist.', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request. You can troubleshoot errors based on the ID.'."\n", 'type' => 'string', 'example' => '0000-ABCD-EFG****', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned.', 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'The status of the real-time synchronization task or data synchronization solution.'."\n", + 'description' => 'The details of the deployment package.'."\n", 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => '* If the TaskType parameter is set to DI_REALTIME, the Status parameter indicates the status of the real-time synchronization task. Valid values: PAUSE, NORUN, RUN, KILLING, and WAIT.'."\n" - .'* If the TaskType parameter is set to DI_SOLUTION, the Status parameter indicates the status of the data synchronization solution. Valid values: success and fail.'."\n", - 'type' => 'string', - 'example' => 'RUN', - ], - 'Message' => [ - 'description' => 'The cause of the failure to obtain the status of the real-time synchronization task or data synchronization solution. If the status of the real-time synchronization task or data synchronization solution is obtained, the value null is returned.'."\n", - 'type' => 'string', - 'example' => 'fileId[100] is invalid', - ], - 'Name' => [ - 'description' => '* If the TaskType parameter is set to DI_REALTIME, the Name parameter indicates the name of the real-time synchronization task.'."\n" - .'* If the TaskType parameter is set to DI_SOLUTION, the value null is returned.'."\n", - 'type' => 'string', - 'example' => 'streamx_name', - ], - 'SolutionInfo' => [ - 'description' => '* If the TaskType parameter is set to DI_REALTIME, the value null is returned.'."\n" - .'* If the TaskType parameter is set to DI_SOLUTION, the SolutionInfo parameter indicates the details of the data synchronization solution.'."\n", + 'Deployment' => [ + 'description' => 'The details of the deployment package.'."\n", 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The status of the data synchronization solution.'."\n", - 'type' => 'string', - 'example' => 'run', - ], - 'Id' => [ - 'description' => 'The ID of the data synchronization solution.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'CreatorName' => [ - 'description' => 'The creator of the data synchronization solution.'."\n", - 'type' => 'string', - 'example' => 'dataworks_3h1', - ], - 'StepDetail' => [ - 'description' => 'The step details of the data synchronization solution.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status of the step in the data synchronization solution.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'StepId' => [ - 'description' => 'The ID of the step in the data synchronization solution.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'StepName' => [ - 'description' => 'The name of the step in the data synchronization solution.'."\n", - 'type' => 'string', - 'example' => 'Create a base table', - ], - 'Info' => [ - 'description' => 'The information of the data synchronization solution.'."\n", - 'type' => 'string', - 'example' => '{\\"fusionProps\\":{\\"dataSource\\":[{\\"fileName\\":\\"holo_20221020161613\\",\\"status\\":\\"SUCCESS\\"}]},\\"customProps\\":{\\"showSN\\":true,\\"columns\\":[{\\"dataIndex\\":\\"fileName\\",\\"width\\":0.8,\\"title\\":\\"Real-time synchronization name\\"},{\\"dataIndex\\":\\"status\\",\\"width\\":0.2,\\"title\\":\\"Status\\"}]},\\"componentName\\":\\"Table\\"}', - ], - ], - ], - ], - ], + 'Status' => ['description' => 'The status of the deployment task. Valid values: 0, 1, and 2. A value of 0 indicates that the task is ready. A value of 1 indicates that the task was successful. A value of 2 indicates that the task failed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message that was returned when the deployment package failed. In this case, the value of the Status parameter is 2.'."\n", 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'FromEnvironment' => ['description' => 'The environment in which the deployment task was run. Valid values: 0 and 1. A value of 0 indicates the on-premises environment. A value of 1 indicates the development environment.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ToEnvironment' => ['description' => 'The environment to which the file was deployed. Valid values: 1 and 2. A value of 1 indicates the development environment. A value of 2 indicates the production environment.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'CheckingStatus' => ['description' => 'The check status of one or more files in the deployment task. If the value of the ToEnvironment parameter is 1, the files can be deployed to the production environment only when the value of the Status parameter is 1 and the CheckingStatus parameter is empty. Valid values:'."\n" + ."\n" + .'* 7: The file failed the check.'."\n" + .'* 8: The file is being checked.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '7', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the deployment task was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1593877765000', 'title' => ''], + 'HandlerId' => ['description' => 'The ID of the Alibaba Cloud account used by the user who ran the deployment task.'."\n", 'type' => 'string', 'example' => '2003****', 'title' => ''], + 'CreatorId' => ['description' => 'The ID of the Alibaba Cloud account used by the user who created the deployment task.'."\n", 'type' => 'string', 'example' => '20030****', 'title' => ''], + 'ExecuteTime' => ['description' => 'The time when the deployment task was run. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1593877765000', 'title' => ''], + 'Name' => ['description' => 'The name of the deployment task. The value is the same as the name of the specific deployment task that is displayed on the Release Package page in the Deploy module.'."\n", 'type' => 'string', 'example' => 'ods_user_info_d-2020-07-04_20030****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'DeployedItems' => [ + 'description' => 'The deployed items.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the deployed item.'."\n", + 'type' => 'object', + 'properties' => [ + 'FileId' => ['description' => 'The file ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '5076****', 'title' => ''], + 'FileVersion' => ['description' => 'The version of the file.', 'type' => 'integer', 'format' => 'int64', 'example' => '7', 'title' => ''], + 'Status' => ['description' => '- UNPUBLISHED(0): not published'."\n" + .'- SUCCESS(1): Published'."\n" + .'- ERROR(2): Publishing failed'."\n" + .'- CLONED(3): successfully CLONED'."\n" + .'- DEPLOY_ERROR(4): Publishing failed'."\n" + .'- CLONING(5): CLONING'."\n" + .'- REJECT(6): release rejected', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Param.Invalid', - 'errorMessage' => 'The parameter is invalid.', - ], - ], 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden.', - ], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal error occurred.', - ], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0bc1411515937635973****\\",\\n \\"Data\\": {\\n \\"Status\\": \\"RUN\\",\\n \\"Message\\": \\"fileId[100] is invalid\\",\\n \\"Name\\": \\"streamx_name\\",\\n \\"SolutionInfo\\": {\\n \\"Status\\": \\"run\\",\\n \\"Id\\": 100,\\n \\"CreatorName\\": \\"dataworks_3h1\\",\\n \\"StepDetail\\": [\\n {\\n \\"Status\\": \\"success\\",\\n \\"StepId\\": 1,\\n \\"StepName\\": \\"Create a base table\\",\\n \\"Info\\": \\"{\\\\\\\\\\\\\\"fusionProps\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"dataSource\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"fileName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"holo_20221020161613\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"status\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"SUCCESS\\\\\\\\\\\\\\"}]},\\\\\\\\\\\\\\"customProps\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"showSN\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"columns\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"dataIndex\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"fileName\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"width\\\\\\\\\\\\\\":0.8,\\\\\\\\\\\\\\"title\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Real-time synchronization name\\\\\\\\\\\\\\"},{\\\\\\\\\\\\\\"dataIndex\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"status\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"width\\\\\\\\\\\\\\":0.2,\\\\\\\\\\\\\\"title\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Status\\\\\\\\\\\\\\"}]},\\\\\\\\\\\\\\"componentName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Table\\\\\\\\\\\\\\"}\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 0bc1411515937635973****\\n \\n RUN\\n fileId[100] is invalid\\n streamx_name\\n \\n run\\n 100\\n dataworks_3h1\\n \\n success\\n 1\\n 创建base表\\n {\\\\\\"fusionProps\\\\\\":{\\\\\\"dataSource\\\\\\":[{\\\\\\"fileName\\\\\\":\\\\\\"holo_20221020161613\\\\\\",\\\\\\"status\\\\\\":\\\\\\"SUCCESS\\\\\\"}]},\\\\\\"customProps\\\\\\":{\\\\\\"showSN\\\\\\":true,\\\\\\"columns\\\\\\":[{\\\\\\"dataIndex\\\\\\":\\\\\\"fileName\\\\\\",\\\\\\"width\\\\\\":0.8,\\\\\\"title\\\\\\":\\\\\\"实时同步名称\\\\\\"},{\\\\\\"dataIndex\\\\\\":\\\\\\"status\\\\\\",\\\\\\"width\\\\\\":0.2,\\\\\\"title\\\\\\":\\\\\\"状态\\\\\\"}]},\\\\\\"componentName\\\\\\":\\\\\\"Table\\\\\\"}\\n \\n \\n \\n","errorExample":""}]', - 'title' => 'GetDISyncInstanceInfo', - 'summary' => 'Queries the status of a real-time synchronization task or a data synchronization solution.', - ], - 'TerminateDISyncInstance' => [ - 'methods' => [ - 'post', - 'get', + 'title' => 'GetDeployment', + 'summary' => 'Queries the information about a deployment package.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-09-27T08:00:16.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], - 'security' => [ - [ - 'AK' => [], - ], + 'ramActions' => [ [ - 'PrivateKey' => [], + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Deployment\\": {\\n \\"Status\\": 1,\\n \\"ErrorMessage\\": \\"Success\\",\\n \\"FromEnvironment\\": 0,\\n \\"ToEnvironment\\": 1,\\n \\"CheckingStatus\\": 7,\\n \\"CreateTime\\": 1593877765000,\\n \\"HandlerId\\": \\"2003****\\",\\n \\"CreatorId\\": \\"20030****\\",\\n \\"ExecuteTime\\": 1593877765000,\\n \\"Name\\": \\"ods_user_info_d-2020-07-04_20030****\\"\\n },\\n \\"DeployedItems\\": [\\n {\\n \\"FileId\\": 0,\\n \\"FileVersion\\": 7,\\n \\"Status\\": 1\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'GetExtension' => [ + 'summary' => 'Retrieves the details of an extension.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'APP' => [], + 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdideZKHMWN'], ], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the workspace ID.'."\n" - ."\n" - .'You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '10000000000', - 'minimum' => '1', - 'example' => '10000', - ], - ], - [ - 'name' => 'TaskType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The value DI_REALTIME indicates that the task is a real-time synchronization task.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'DI_REALTIME', - ], - ], - [ - 'name' => 'FileId', + 'name' => 'ExtensionCode', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the real-time synchronization task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9999999999999999', - 'minimum' => '1', - 'example' => '100', - ], + 'schema' => ['description' => 'The unique code of the extension.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ce4*********086da5', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'title' => 'Schema of Response', + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => '0bc1411515937635973****', - ], - 'Data' => [ - 'description' => 'The returned results.'."\n", + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID. You can use the request ID to query logs and troubleshoot issues.', 'type' => 'string', 'example' => '0000-ABCD-EFG'], + 'Extension' => [ + 'description' => 'The details of the extension.', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'Indicates whether the real-time synchronization task is undeployed. Valid values:'."\n" - ."\n" - .'* success'."\n" - .'* fail'."\n", - 'type' => 'string', - 'example' => 'success', + 'ExtensionCode' => ['description' => 'The unique code of the extension.', 'type' => 'string', 'example' => 'ce4*********086da5', 'title' => ''], + 'ExtensionName' => ['description' => 'The name of the extension.', 'type' => 'string', 'example' => 'Extension name', 'title' => ''], + 'ExtensionDesc' => ['description' => 'The description of the extension.', 'type' => 'string', 'example' => 'This is a description', 'title' => ''], + 'HelpDocUrl' => ['description' => 'The URL of the help documentation of the extension.', 'type' => 'string', 'example' => 'https://www.aliyun.com/', 'title' => ''], + 'Status' => ['description' => 'The state of the extension. 0: Testing, 1: Publishing, 3: Disabled, 4: Processing, 5: Approved, 6: Approve Failed', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ProjectTesting' => ['description' => 'The workspace for testing. If the extension is being tested, the extension can be used only in the workspace for testing.', 'type' => 'integer', 'format' => 'int64', 'example' => '1355211', 'title' => ''], + 'DetailUrl' => ['description' => 'The URL of the extension details page, on which users can view the details of the process blocked by the extension.', 'type' => 'string', 'example' => 'https://www.aliyun.com/', 'title' => ''], + 'ParameterSetting' => ['description' => 'The parameter settings of the extension. For more information, see [Configure extension parameters](~~405354~~).', 'type' => 'string', 'example' => 'extension.project.disabled=projectId1,projectId2,projectId3', 'title' => ''], + 'OptionSetting' => ['description' => 'The options defined for the extension.', 'type' => 'string', 'example' => 'Option configuration', 'title' => ''], + 'BindEventList' => [ + 'description' => 'The list of extension points.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the extension point.', + 'type' => 'object', + 'properties' => [ + 'EventCode' => ['description' => 'The code of the extension point event.', 'type' => 'string', 'example' => 'commit-file', 'title' => ''], + 'EventName' => ['description' => 'The name of the extension point event.', 'type' => 'string', 'example' => 'File submission pre-event'."\n", 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'Message' => [ - 'description' => 'The reason why the real-time synchronization task fails to be terminated. If the real-time synchronization task is undeployed, the value of this parameter is null.'."\n", - 'type' => 'string', - 'example' => 'fileId:[100] is invalid.', + 'EventCategoryList' => [ + 'description' => 'The list of event types.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the event type.', + 'type' => 'object', + 'properties' => [ + 'CategoryCode' => ['description' => 'The code of the event type.', 'type' => 'string', 'example' => 'file-change', 'title' => ''], + 'CategoryName' => ['description' => 'The name of the event type.', 'type' => 'string', 'example' => 'File change event', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Param.Invalid', - 'errorMessage' => 'The parameter is invalid.', - ], - ], - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal error occurred.', - ], + 'title' => 'GetExtension', + 'changeSet' => [ + ['createdAt' => '2022-08-22T01:59:31.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-04-26T08:35:01.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetExtension'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0bc1411515937635973****\\",\\n \\"Data\\": {\\n \\"Status\\": \\"success\\",\\n \\"Message\\": \\"fileId:[100] is invalid.\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 0bc1411515937635973****\\n \\n success\\n fileId:[100] is invalid.\\n \\n","errorExample":""}]', - 'title' => 'TerminateDISyncInstance', - 'summary' => 'Undeploys a real-time synchronization task.', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG\\",\\n \\"Extension\\": {\\n \\"ExtensionCode\\": \\"ce4*********086da5\\",\\n \\"ExtensionName\\": \\"Extension name\\",\\n \\"ExtensionDesc\\": \\"This is a description\\",\\n \\"HelpDocUrl\\": \\"https://www.aliyun.com/\\",\\n \\"Status\\": 0,\\n \\"ProjectTesting\\": 1355211,\\n \\"DetailUrl\\": \\"https://www.aliyun.com/\\",\\n \\"ParameterSetting\\": \\"extension.project.disabled=projectId1,projectId2,projectId3\\",\\n \\"OptionSetting\\": \\"Option configuration\\",\\n \\"BindEventList\\": [\\n {\\n \\"EventCode\\": \\"commit-file\\",\\n \\"EventName\\": \\"File submission pre-event\\\\n\\"\\n }\\n ],\\n \\"EventCategoryList\\": [\\n {\\n \\"CategoryCode\\": \\"file-change\\",\\n \\"CategoryName\\": \\"File change event\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], - 'GenerateDISyncTaskConfigForCreating' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetFile' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'APP' => [], - ], - [ - 'PrivateKey' => [], - ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', + 'abilityTreeCode' => '78245', + 'abilityTreeNodes' => ['FEATUREdide8FM783'], ], 'parameters' => [ [ 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the ID.'."\n" - ."\n" - .'You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '10000000000', - 'minimum' => '1', - 'example' => '10000', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace Management page to obtain the workspace ID.'."\n" + ."\n" + .'You must configure this parameter or the ProjectIdentifier parameter to determine the DataWorks workspace to which the operation is applied.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10000'], ], [ - 'name' => 'TaskType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of task that you want to create in Data Integration in asynchronous mode. Valid values:'."\n" - ."\n" - .'* DI_REALTIME: real-time synchronization task'."\n" - .'* DI_SOLUTION: another type of synchronization task'."\n" - ."\n" - .'DataWorks allows you to create real-time synchronization tasks and other types of synchronization tasks in Data Integration only in asynchronous mode.'."\n" - ."\n" - .'* DI_OFFLINE'."\n" - .'* DI_REALTIME'."\n" - .'* DI_SOLUTION'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [], - 'example' => 'DI_REALTIME', - 'enum' => [ - 'DI_OFFLINE', - 'DI_REALTIME', - 'DI_SOLUTION', - ], - ], + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace Management page to obtain the workspace name.'."\n" + ."\n" + .'You must configure this parameter or the ProjectId parameter to determine the DataWorks workspace to which the operation is applied.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dw_project'], ], [ - 'name' => 'TaskParam', - 'in' => 'query', - 'schema' => [ - 'description' => 'The script for the synchronization task. DataWorks allows you to create the following types of synchronization tasks:'."\n" - ."\n" - .'* Synchronization task that is used to synchronize data from MySQL to MaxCompute'."\n" - .'* Synchronization task that is used to synchronize data from MySQL data to Kafka'."\n" - .'* Synchronization task that is used to synchronize data from MySQL to Hologres'."\n" - ."\n" - .'The SelectedTables parameter is used to specify tables that you want to synchronize from multiple databases. The Tables parameter is used to specify tables that you want to synchronize from a single database.'."\n" - ."\n" - .'* If the script contains the SelectedTables parameter, the system synchronizes data from the tables that you specify in the SelectedTables parameter.'."\n" - .'* If the script contains the Tables parameter, the system synchronizes data from the tables that you specify in the Tables parameter.'."\n" - ."\n" - .'The following sample code provides a script for data synchronization from MySQL to MaxCompute:'."\n" - ."\n" - .' {'."\n" - .' "type": "realtime",'."\n" - .' "version": "1.0",'."\n" - .' "setting": {'."\n" - .' "resourceGroup": "S_res_group_280749521950784_1623033752022",'."\n" - .' "taskType": "oneclick_to_odps"'."\n" - .' },'."\n" - .' "steps": ['."\n" - .' {'."\n" - .' "stepType": "mysql",'."\n" - .' "parameter": {'."\n" - .' "connection": ['."\n" - .' {'."\n" - .' "datasourceType": "mysql",'."\n" - .' "datasource": "mysql_pub1",'."\n" - .' "selectedTables": ['."\n" - .' {'."\n" - .' "dbName": "mysql_db",'."\n" - .' "schema": ['."\n" - .' {'."\n" - .' "tableInfos": ['."\n" - .' {'."\n" - .' "table": "molin_di_test_in_pk_v4"'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .' ]'."\n" - .' },'."\n" - .' "name": "Reader",'."\n" - .' "category": "reader"'."\n" - .' },'."\n" - .' {'."\n" - .' "stepType": "odps",'."\n" - .' "parameter": {'."\n" - .' "datasource": "odps_source"'."\n" - .' },'."\n" - .' "name": "Writer",'."\n" - .' "category": "writer"'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - ."\n" - .'The following sample code provides a script for data synchronization from MySQL to Kafka:'."\n" - ."\n" - .' {'."\n" - .' "type": "realtime",'."\n" - .' "version": "1.0",'."\n" - .' "setting": {'."\n" - .' "resourceGroup": "S_res_group_280749521950784_1623033752022",'."\n" - .' "taskType": "oneclick_to_kafka"'."\n" - .' },'."\n" - .' "steps": ['."\n" - .' {'."\n" - .' "stepType": "mysql",'."\n" - .' "parameter": {'."\n" - .' "connection": ['."\n" - .' {'."\n" - .' "datasourceType": "mysql",'."\n" - .' "datasource": "pkset_test",'."\n" - .' "selectedTables": ['."\n" - .' {'."\n" - .' "dbName": "mysql_db",'."\n" - .' "schema": ['."\n" - .' {'."\n" - .' "tableInfos": ['."\n" - .' {'."\n" - .' "table": "molin_di_test_in_pk_v4"'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .' ]'."\n" - .' },'."\n" - .' "name": "Reader",'."\n" - .' "category": "reader"'."\n" - .' },'."\n" - .' {'."\n" - .' "stepType": "kafka",'."\n" - .' "parameter": {'."\n" - .' "datasource": "azn_kafka"'."\n" - .' },'."\n" - .' "name": "Writer",'."\n" - .' "category": "writer"'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - ."\n" - .'The following sample code provides a script for data synchronization from MySQL to Hologres:'."\n" - ."\n" - .' {'."\n" - .' "type": "realtime",'."\n" - .' "version": "1.0",'."\n" - .' "setting": {'."\n" - .' "resourceGroup": "S_res_group_280749521950784_1623033752022",'."\n" - .' "taskType": "oneclick_to_holo"'."\n" - .' },'."\n" - .' "steps": ['."\n" - .' {'."\n" - .' "stepType": "mysql",'."\n" - .' "parameter": {'."\n" - .' "connection": ['."\n" - .' {'."\n" - .' "datasourceType": "mysql",'."\n" - .' "datasource": "mysql_pub",'."\n" - .' "selectedTables": ['."\n" - .' {'."\n" - .' "dbName": "mysql_db",'."\n" - .' "schema": ['."\n" - .' {'."\n" - .' "tableInfos": ['."\n" - .' {'."\n" - .' "table": "molin_di_test_in2_pk_v3"'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .' ]'."\n" - .' },'."\n" - .' "name": "Reader",'."\n" - .' "category": "reader"'."\n" - .' },'."\n" - .' {'."\n" - .' "stepType": "holo",'."\n" - .' "parameter": {'."\n" - .' "datasource": "holo"'."\n" - .' },'."\n" - .' "name": "Writer",'."\n" - .' "category": "writer"'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '{ "type": "realtime", "version": "1.0", "setting": { "resourceGroup": "S_res_group_280749521950784_1623033752022", "scheduleResgroupId": 30003913, "name": "openapi_realtime_solution_0813_1739", "taskType": "oneclick_to_odps" }, "steps": [ { "stepType": "mysql", "parameter": { "connection": [ { "datasourceType": "mysql", "datasource": "mysql_pub", "table": [ "xyx" ] } ] }, "name": "Reader", "category": "reader" }, { "stepType": "odps", "parameter": { "datasource": "odps_first" }, "name": "Writer", "category": "writer" } ] }', - ], + 'name' => 'FileId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the file. You can call the [ListFiles](~~173942~~) operation to obtain the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100000001'], ], [ - 'name' => 'ClientToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request. This parameter is used to prevent repeated operations that are caused by multiple calls.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ABFUOEUOTRTRJKE', - ], + 'name' => 'NodeId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the node that is scheduled. You can call the [ListFiles](~~173942~~) operation to obtain the node ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '200000001'], ], ], 'responses' => [ @@ -22493,232 +15902,321 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0bc1411515937635973****', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorMessage' => ['description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'The connection does not exist.'], + 'RequestId' => ['description' => 'The ID of the request. You can use the ID to troubleshoot issues.'."\n", 'type' => 'string', 'example' => '0000-ABCD-EFG****'], + 'ErrorCode' => ['description' => 'The error code returned.'."\n", 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists'], + 'Success' => ['description' => 'Indicates whether the request is successful. Valid values:'."\n" + ."\n" + .'* true: The request is successful.'."\n" + .'* false: The request fails.'."\n", 'type' => 'boolean', 'example' => 'true'], 'Data' => [ - 'description' => 'The information returned for the ID of the asynchronous thread.'."\n", + 'description' => 'The details of the file.'."\n", 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'Indicates whether the ID of the asynchronous thread is generated. Valid values: Valid values:'."\n" - ."\n" - .'* success: indicates that the ID of the asynchronous thread is generated.'."\n" - .'* fail: indicates that the ID of the asynchronous thread fails to be generated. You can view the reason for the failure and troubleshoot the issue based on the reason.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'ProcessId' => [ - 'description' => 'The ID of the asynchronous thread. You can call the [QueryDISyncTaskConfigProcessResult](~~383465~~) operation to obtain the asynchronously generated parameters based on the ID. The parameters are used to create a synchronization task in Data Integration.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'Message' => [ - 'description' => 'The reason why the ID of the asynchronous thread fails to be generated. If the ID is successfully generated, no value is returned for this parameter.'."\n", - 'type' => 'string', - 'example' => 'XXX is invalid.', + 'File' => [ + 'description' => 'The basic information about the file.'."\n", + 'type' => 'object', + 'properties' => [ + 'CommitStatus' => ['description' => 'Indicates whether the latest code in the file is committed. Valid values: 0 and 1. The value 0 indicates that the latest code in the file is not committed. The value 1 indicates that the latest code in the file is committed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'AutoParsing' => ['description' => 'Indicates whether the automatic parsing feature is enabled for the file. Valid values:'."\n" + ."\n" + .'* true: The automatic parsing feature is enabled for the file.'."\n" + .'* false: The automatic parsing feature is not enabled for the file.'."\n" + ."\n" + .'This parameter corresponds to the Analyze Code parameter that is displayed after Same Cycle is selected in the Dependencies section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", 'type' => 'boolean', 'example' => 'true'], + 'Owner' => ['description' => 'The ID of the Alibaba Cloud account used by the file owner.'."\n", 'type' => 'string', 'example' => '7775674356****'], + 'CreateTime' => ['description' => 'The time when the file was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1593879116000'], + 'FileType' => ['description' => 'The type of the code for the file. The code for files varies based on the file type. For more information, see [DataWorks nodes](~~600169~~).'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'CurrentVersion' => ['description' => 'The latest version number of the file.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'BizId' => ['description' => 'The ID of the workflow to which the file belongs. This parameter is deprecated and replaced by the BusinessId parameter.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1000001'], + 'LastEditUser' => ['description' => 'The ID of the Alibaba Cloud account used to last modify the file.'."\n", 'type' => 'string', 'example' => '62465892****'], + 'FileName' => ['description' => 'The name of the file.'."\n", 'type' => 'string', 'example' => 'ods_user_info_d'], + 'ConnectionName' => ['description' => 'The ID of the compute engine instance that is used to run the node that corresponds to the file.'."\n", 'type' => 'string', 'example' => 'odps_first'], + 'UseType' => ['description' => 'The module to which the file belongs. Valid values:'."\n" + ."\n" + .'* NORMAL: The file is used for DataStudio.'."\n" + .'* MANUAL: The file is used for a manually triggered node.'."\n" + .'* MANUAL_BIZ: The file is used for a manually triggered workflow.'."\n" + .'* SKIP: The file is used for a dry-run DataStudio node.'."\n" + .'* ADHOCQUERY: The file is used for an ad hoc query.'."\n" + .'* COMPONENT: The file is used for a snippet.'."\n", 'type' => 'string', 'example' => 'NORMAL'], + 'FileFolderId' => ['description' => 'The ID of the folder to which the file belongs.'."\n", 'type' => 'string', 'example' => '2735c2****'], + 'ParentId' => ['description' => 'The ID of the node group file to which the current file belongs. This parameter is returned only if the current file is an inner file of the node group file.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '-1'], + 'CreateUser' => ['description' => 'The ID of the Alibaba Cloud account used to create the file.'."\n", 'type' => 'string', 'example' => '424732****'], + 'IsMaxCompute' => ['description' => 'Indicates whether the file needs to be uploaded to MaxCompute.'."\n" + ."\n" + .'This parameter is returned only if the file is a MaxCompute resource file.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'BusinessId' => ['description' => 'The ID of the workflow to which the file belongs.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1000001'], + 'FileDescription' => ['description' => 'The description of the file.'."\n", 'type' => 'string', 'example' => 'My first DataWorks file'], + 'DeletedStatus' => ['description' => 'The status of the file. Valid values:'."\n" + ."\n" + .'* NORMAL: The file is not deleted.'."\n" + .'* RECYCLE_BIN: The file is stored in the recycle bin.'."\n" + .'* DELETED: The file is deleted.'."\n", 'type' => 'string', 'example' => 'RECYCLE'], + 'LastEditTime' => ['description' => 'The time when the file was last modified. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1593879116000'], + 'Content' => ['description' => 'The code in the file.'."\n", 'type' => 'string', 'example' => 'SHOW TABLES;'], + 'NodeId' => ['description' => 'The ID of the auto triggered node that is generated in the scheduling system after the file is committed.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '300001'], + 'AdvancedSettings' => ['description' => 'The advanced configurations of the node.'."\n" + ."\n" + .'This parameter is valid for an EMR node. This parameter corresponds to the Advanced Settings tab in the right-side navigation pane on the configuration tab of the node in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n" + ."\n" + .'> You cannot configure advanced parameters for EMR Shell nodes.'."\n" + ."\n" + .'For information about the advanced parameters of each type of EMR node, see [Develop EMR tasks](~~473077~~).'."\n", 'type' => 'string', 'example' => '{"queue":"default","SPARK_CONF":"--conf spark.driver.memory=2g"}'], + 'FileId' => ['description' => 'The ID of the file.', 'type' => 'integer', 'format' => 'int64', 'example' => '100000001'], + ], ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Invalid.DI.Parameter', - 'errorMessage' => 'The parameter is invalid.', - ], - [ - 'errorCode' => 'Invalid.DI.Parameter.File.Existed', - 'errorMessage' => 'The file name already exists.', - ], - ], - 403 => [ - [ - 'errorCode' => 'Forbidden.DI.NoPrivilege', - 'errorMessage' => 'No access.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError.DI.Parameter', - 'errorMessage' => 'A DI internal error occurred.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0bc1411515937635973****\\",\\n \\"Data\\": {\\n \\"Status\\": \\"true\\",\\n \\"ProcessId\\": 10,\\n \\"Message\\": \\"XXX is invalid.\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 0bc1411515937635973****\\n \\n true\\n 10\\n XXX is invalid.\\n \\n","errorExample":""}]', - 'title' => 'GenerateDISyncTaskConfigForCreating', - 'summary' => 'Generates an ID for an asynchronous thread that is used to create a synchronization task in Data Integration.', - 'description' => 'DataWorks allows you to use the [CreateDISyncTask](~~278725~~) operation to directly create a batch synchronization task in Data Integration. To create a real-time synchronization task or another type of synchronization task, you must first call the [GenerateDISyncTaskConfigForCreating](~~383463~~) operation to generate the ID of an asynchronous thread and call the [QueryDISyncTaskConfigProcessResult](~~383465~~) operation to obtain the asynchronously generated parameters based on the ID. Then, you can use the parameters as request parameters of [CreateDISyncTask](~~278725~~) and call the [CreateDISyncTask](~~278725~~) operation to create a real-time synchronization task or another type of synchronization task. DataWorks allows you to create real-time synchronization tasks and other types of synchronization tasks in Data Integration only in asynchronous mode.'."\n", - ], - 'GenerateDISyncTaskConfigForUpdating' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - [ - 'APP' => [], - ], + 'NodeConfiguration' => [ + 'description' => 'The scheduling configurations of the file.'."\n", + 'type' => 'object', + 'properties' => [ + 'RerunMode' => ['description' => 'Indicates whether the node that corresponds to the file can be rerun. Valid values:'."\n" + ."\n" + .'* ALL_ALLOWED: The node can be rerun regardless of whether it is successfully run or fails to run.'."\n" + .'* FAILURE_ALLOWED: The node can be rerun only after it fails to run.'."\n" + .'* ALL_DENIED: The node cannot be rerun regardless of whether it is successfully run or fails to run.'."\n" + ."\n" + .'This parameter corresponds to the Rerun parameter in the Schedule section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", 'type' => 'string', 'example' => 'ALL_ALLOWED'], + 'SchedulerType' => ['description' => 'The scheduling type of the node. Valid values:'."\n" + ."\n" + .'* NORMAL: The node is an auto triggered node.'."\n" + .'* MANUAL: The node is a manually triggered node. Manually triggered nodes cannot be automatically triggered. They correspond to the nodes in the Manually Triggered Workflows pane.'."\n" + .'* PAUSE: The node is a paused node.'."\n" + .'* SKIP: The node is a dry-run node. Dry-run nodes are started as scheduled but the system sets the status of the nodes to successful when it starts to run them.'."\n", 'type' => 'string', 'example' => 'NORMAL'], + 'Stop' => ['description' => 'Indicates whether the scheduling for the node is suspended Valid values:'."\n" + ."\n" + .'* true: The scheduling for the node is suspended.'."\n" + .'* false: The scheduling for the node is not suspended.'."\n" + ."\n" + .'This parameter corresponds to the Recurrence parameter in the Schedule section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", 'type' => 'boolean', 'example' => 'false'], + 'ParaValue' => ['description' => 'The scheduling parameters of the node.'."\n" + ."\n" + .'This parameter corresponds to the Parameters section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console). For more information about the configurations of the scheduling parameters, see [Configure scheduling parameters](~~137548~~).'."\n", 'type' => 'string', 'example' => 'a=x b=y'], + 'StartEffectDate' => ['description' => 'The start time of automatic scheduling. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n" + ."\n" + .'This parameter corresponds to the Validity Period parameter in the Schedule section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '936923400000'], + 'EndEffectDate' => ['description' => 'The end time of automatic scheduling. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n" + ."\n" + .'This parameter corresponds to the Validity Period parameter in the Schedule section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '4155787800000'], + 'CycleType' => ['description' => 'The type of the scheduling cycle. Valid values: NOT_DAY and DAY. The value NOT_DAY indicates that the node is scheduled to run by minute or hour. The value DAY indicates that the node is scheduled to run by day, week, or month.'."\n" + ."\n" + .'This parameter corresponds to the Scheduling Cycle parameter in the Schedule section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", 'type' => 'string', 'example' => 'DAY'], + 'DependentNodeIdList' => ['description' => 'The ID of the node on which the node corresponding to the file depends when the DependentType parameter is set to USER_DEFINE. Multiple IDs are separated by commas (,).'."\n" + ."\n" + .'The value of this parameter is equivalent to the ID of the node that you specified after you select Previous Cycle and set Depend On to Other Nodes in the Dependencies section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", 'type' => 'string', 'example' => '5,10,15,20'], + 'ResourceGroupId' => ['description' => 'The ID of the resource group that is used to run the node. You can call the [ListResourceGroups](~~173913~~) operation to query the available resource groups in the workspace.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '375827434852437'], + 'DependentType' => ['description' => 'The type of the cross-cycle scheduling dependency of the node. Valid values:'."\n" + ."\n" + .'* SELF: The instance generated for the node in the current cycle depends on the instance generated for the node in the previous cycle.'."\n" + .'* CHILD: The instance generated for the node in the current cycle depends on the instances generated for the descendant nodes at the nearest level of the node in the previous cycle.'."\n" + .'* USER_DEFINE: The instance generated for the node in the current cycle depends on the instances generated for one or more specified nodes in the previous cycle.'."\n" + .'* NONE: No cross-cycle scheduling dependency type is selected for the node.'."\n", 'type' => 'string', 'example' => 'USER_DEFINE'], + 'AutoRerunTimes' => ['description' => 'The number of automatic reruns that are allowed after an error occurs.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'AutoRerunIntervalMillis' => ['description' => 'The interval between automatic reruns after an error occurs. Unit: milliseconds.'."\n" + ."\n" + .'This parameter corresponds to the Rerun Interval parameter that is displayed after the Auto Rerun upon Error check box is selected in the Schedule section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n" + ."\n" + .'The interval that you specify in the DataWorks console is measured in minutes. Pay attention to the conversion between the units of time when you call the operation.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '120000'], + 'CronExpress' => ['description' => 'The CRON expression that represents the periodic scheduling policy of the node.'."\n", 'type' => 'string', 'example' => '00 05 00 * * ?'], + 'InputList' => [ + 'description' => 'The output names of the parent files on which the current file depends.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Input' => ['description' => 'The output name of the parent file on which the current file depends.'."\n" + ."\n" + .'This parameter corresponds to the Output Name of Ancestor Node parameter under Parent Nodes after Same Cycle is selected in the Dependencies section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", 'type' => 'string', 'example' => 'project.001_out'], + 'ParseType' => ['description' => 'The mode of the configuration file dependency. Valid values:'."\n" + ."\n" + .'* MANUAL: Scheduling dependencies are manually configured.'."\n" + .'* AUTO: Scheduling dependencies are automatically parsed.'."\n", 'type' => 'string', 'example' => 'MANUAL'], + ], + ], + ], + 'OutputList' => [ + 'description' => 'The output names of the current file.'."\n" + ."\n" + .'This parameter corresponds to the Output Name parameter under Output after Same Cycle is selected in the Dependencies section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'RefTableName' => ['description' => 'The output table name of the current file.'."\n" + ."\n" + .'This parameter corresponds to the Output Table Name parameter under Output after Same Cycle is selected in the Dependencies section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", 'type' => 'string', 'example' => 'ods_user_info_d'], + 'Output' => ['description' => 'The output name of the current file.'."\n" + ."\n" + .'This parameter corresponds to the Output Name parameter under Output after Same Cycle is selected in the Dependencies section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", 'type' => 'string', 'example' => 'dw_project.002_out'], + ], + ], + ], + 'StartImmediately' => ['description' => 'Indicates whether a node is immediately run after the node is deployed to the production environment.'."\n" + ."\n" + .'This parameter is valid only for an EMR Spark Streaming node or an EMR Streaming SQL node. This parameter corresponds to the Start Method parameter in the Schedule section of the Configure tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", 'type' => 'boolean', 'example' => 'true'], + 'InputParameters' => [ + 'description' => 'Input parameters of the node.'."\n" + ."\n" + .'This parameter corresponds to the Input Parameters table in the Input and Output Parameters section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ParameterName' => ['description' => 'The name of the input parameter of the node. In the code, you can use the ${...} method to reference the input parameter of the node.'."\n" + ."\n" + .'This parameter corresponds to the Parameter Name parameter in the Input Parameters table in the Input and Output Parameters section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", 'type' => 'string', 'example' => 'input'], + 'ValueSource' => ['description' => 'The value source of the input parameter of the node.'."\n" + ."\n" + .'This parameter corresponds to the Value Source parameter in the Input Parameters table in the Input and Output Parameters section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", 'type' => 'string', 'example' => 'project_001.parent_node:outputs'], + ], + ], + ], + 'OutputParameters' => [ + 'description' => 'Output parameters of the node.'."\n" + ."\n" + .'This parameter corresponds to the Output Parameters table in the Input and Output Parameters section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ParameterName' => ['description' => 'The name of the output parameter of the node.'."\n" + ."\n" + .'This parameter corresponds to the Parameter Name parameter in the Output Parameters table in the Input and Output Parameters section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", 'type' => 'string', 'example' => 'output'], + 'Value' => ['description' => 'The value of the output parameter of the node.'."\n" + ."\n" + .'This parameter corresponds to the Value parameter in the Output Parameters table in the Input and Output Parameters section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", 'type' => 'string', 'example' => '${bizdate}'], + 'Type' => ['description' => 'The type of the output parameter of the node. Valid values:'."\n" + ."\n" + .'* 1: indicates a constant.'."\n" + .'* 2: indicates a variable.'."\n" + .'* 3: indicates a pass-through variable.'."\n" + ."\n" + .'This parameter corresponds to the Type parameter in the Output Parameters table in the Input and Output Parameters section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", 'type' => 'string', 'example' => '1'], + 'Description' => ['description' => 'The description of the output parameter of the node.'."\n", 'type' => 'string', 'example' => 'It\'s a context output parameter.'], + ], + ], + ], + 'ApplyScheduleImmediately' => ['description' => 'Indicates whether scheduling configurations immediately take effect after the deployment.'."\n", 'type' => 'string', 'example' => 'true'], + 'IgnoreParentSkipRunningProperty' => ['description' => 'Indicates whether to skip the dry-run property of the ancestor nodes of the node that corresponds to the file. This parameter corresponds to the Skip the dry-run property of the ancestor node parameter that is displayed after you configure the Depend On parameter in the Dependencies section of the Properties tab in the DataWorks console.'."\n", 'type' => 'string', 'example' => 'true'], + 'Timeout' => ['description' => 'The timeout period.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ImageId' => ['description' => 'The ID of the custom image.'."\n", 'type' => 'string', 'example' => 'm-bp1h4b5a8ogkbll2f3tr'], + ], + ], + 'ResourceDownloadLink' => [ + 'description' => 'The download URL of the resource.'."\n", + 'type' => 'object', + 'properties' => [ + 'downloadLink' => ['description' => 'The download URL of the resource.'."\n", 'type' => 'string', 'example' => 'http://xx'], + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"File\\": {\\n \\"CommitStatus\\": 0,\\n \\"AutoParsing\\": true,\\n \\"Owner\\": \\"7775674356****\\",\\n \\"CreateTime\\": 1593879116000,\\n \\"FileType\\": 10,\\n \\"CurrentVersion\\": 3,\\n \\"BizId\\": 1000001,\\n \\"LastEditUser\\": \\"62465892****\\",\\n \\"FileName\\": \\"ods_user_info_d\\",\\n \\"ConnectionName\\": \\"odps_source\\",\\n \\"UseType\\": \\"NORMAL\\",\\n \\"FileFolderId\\": \\"2735c2****\\",\\n \\"ParentId\\": -1,\\n \\"CreateUser\\": \\"424732****\\",\\n \\"IsMaxCompute\\": true,\\n \\"BusinessId\\": 1000001,\\n \\"FileDescription\\": \\"My first DataWorks file\\",\\n \\"DeletedStatus\\": \\"RECYCLE\\",\\n \\"LastEditTime\\": 1593879116000,\\n \\"Content\\": \\"SHOW TABLES;\\",\\n \\"NodeId\\": 300001,\\n \\"AdvancedSettings\\": \\"{\\\\\\\\\\\\\\"priority\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"ENABLE_SPARKSQL_JDBC\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"FLOW_SKIP_SQL_ANALYZE\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"queue\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"default\\\\\\\\\\\\\\"}\\",\\n \\"FileId\\": 100000001\\n },\\n \\"NodeConfiguration\\": {\\n \\"RerunMode\\": \\"ALL_ALLOWED\\",\\n \\"SchedulerType\\": \\"NORMAL\\",\\n \\"Stop\\": false,\\n \\"ParaValue\\": \\"a=x b=y\\",\\n \\"StartEffectDate\\": 936923400000,\\n \\"EndEffectDate\\": 4155787800000,\\n \\"CycleType\\": \\"DAY\\",\\n \\"DependentNodeIdList\\": \\"5,10,15,20\\",\\n \\"ResourceGroupId\\": 375827434852437,\\n \\"DependentType\\": \\"USER_DEFINE\\",\\n \\"AutoRerunTimes\\": 3,\\n \\"AutoRerunIntervalMillis\\": 120000,\\n \\"CronExpress\\": \\"00 05 00 * * ?\\",\\n \\"InputList\\": [\\n {\\n \\"Input\\": \\"project.001_out\\",\\n \\"ParseType\\": \\"MANUAL\\"\\n }\\n ],\\n \\"OutputList\\": [\\n {\\n \\"RefTableName\\": \\"ods_user_info_d\\",\\n \\"Output\\": \\"dw_project.002_out\\"\\n }\\n ],\\n \\"StartImmediately\\": true,\\n \\"InputParameters\\": [\\n {\\n \\"ParameterName\\": \\"input\\",\\n \\"ValueSource\\": \\"project_001.parent_node:outputs\\"\\n }\\n ],\\n \\"OutputParameters\\": [\\n {\\n \\"ParameterName\\": \\"output\\",\\n \\"Value\\": \\"${bizdate}\\",\\n \\"Type\\": \\"1\\",\\n \\"Description\\": \\"It\'s a context output parameter.\\"\\n }\\n ],\\n \\"ApplyScheduleImmediately\\": \\"true\\",\\n \\"IgnoreParentSkipRunningProperty\\": \\"true\\",\\n \\"Timeout\\": 1,\\n \\"ImageId\\": \\"m-bp1h4b5a8ogkbll2f3tr\\"\\n },\\n \\"ResourceDownloadLink\\": {\\n \\"downloadLink\\": \\"http://xx\\"\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n The connection does not exist.\\n 0000-ABCD-EFG****\\n Invalid.Tenant.ConnectionNotExists\\n true\\n \\n \\n 0\\n true\\n 7775674356****\\n 1593879116000\\n 10\\n 3\\n 1000001\\n 62465892****\\n ods_user_info_d\\n odps_source\\n NORMAL\\n 2735c2****\\n -1\\n 424732****\\n true\\n 1000001\\n 我的第一个Dataworks文件\\n RECYCLE\\n 1593879116000\\n SHOW TABLES;\\n 300001\\n {\\"queue\\":\\"default\\",\\"SPARK_CONF\\":\\"--conf spark.driver.memory=2g\\"}\\n 100000001\\n \\n \\n ALL_ALLOWED\\n NORMAL\\n false\\n a=x b=y\\n 936923400000\\n 4155787800000\\n DAY\\n 5,10,15,20\\n 375827434852437\\n USER_DEFINE\\n 3\\n 120000\\n 00 05 00 * * ?\\n \\n project.001_out\\n MANUAL\\n \\n \\n ods_user_info_d\\n dw_project.002_out\\n \\n true\\n \\n input\\n project_001.parent_node:outputs\\n \\n \\n output\\n ${bizdate}\\n 1\\n It\'s a context output parameter.\\n \\n \\n \\n","errorExample":""}]', + 'title' => 'GetFile', + 'summary' => 'Queries the information about a file.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-02-08T09:17:18.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-12-13T08:36:52.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-09-03T06:53:45.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-09-02T08:43:19.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-09-12T02:05:45.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'PrivateKey' => [], + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], ], - 'operationType' => 'readAndWrite', + ], + 'GetFileTypeStatistic' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', + 'abilityTreeCode' => '78246', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB'], ], 'parameters' => [ [ 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the workspace ID.'."\n" - ."\n" - .'You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '10000000000', - 'minimum' => '1', - 'example' => '10000', - ], - ], - [ - 'name' => 'TaskType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the object that you want to update in Data Integration in asynchronous mode. Valid values:'."\n" - ."\n" - .'* DI_REALTIME: real-time synchronization task'."\n" - .'* DI_SOLUTION: synchronization solution DataWorks allows you to create or update real-time synchronization tasks in Data Integration only in asynchronous mode.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* DI_OFFLINE'."\n" - .'* DI_REALTIME'."\n" - .'* DI_SOLUTION'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'DI_REALTIME', - 'enum' => [ - 'DI_OFFLINE', - 'DI_REALTIME', - 'DI_SOLUTION', - ], - ], - ], - [ - 'name' => 'TaskParam', - 'in' => 'query', - 'schema' => [ - 'description' => 'The script for updating the real-time synchronization task in Data Integration. DataWorks allows you to add or remove tables for a real-time synchronization task in Data Integration only in asynchronous mode. The following types of real-time synchronization tasks are supported:'."\n" - ."\n" - .'* Synchronization task that is used to synchronize data from MySQL to MaxCompute'."\n" - .'* Synchronization task that is used to synchronize data from MySQL data to Kafka'."\n" - .'* Synchronization task that is used to synchronize data from MySQL to Hologres'."\n" - ."\n" - .'The SelectedTables parameter is used to specify tables that you want to synchronize from multiple databases. The Tables parameter is used to specify tables that you want to synchronize from a single database.'."\n" - ."\n" - .'* If the script contains the SelectedTables parameter, the system synchronizes data from the tables that you specify in the SelectedTables parameter.'."\n" - .'* If the script contains the Tables parameter, the system synchronizes data from the tables that you specify in the Tables parameter.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '{ "steps": [ { "parameter": { "connection": [ { "table": [ "xyx" ] } ] }, "name": "Reader", "category": "reader" } ] }', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Management page to obtain the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '123465', 'isFileTransferUrl' => false], ], [ - 'name' => 'ClientToken', - 'in' => 'query', + 'name' => 'ProjectEnv', + 'in' => 'formData', 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request. This parameter is used to prevent repeated operations that are caused by multiple calls.'."\n", + 'description' => 'The environment of the workspace. Valid values: PROD and DEV. The value PROD indicates the production environment. The value DEV indicates the development environment.'."\n", 'type' => 'string', - 'required' => false, - 'example' => 'ABFUOEUOTRTRJKE', - ], - ], - [ - 'name' => 'TaskId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The task ID.'."\n" - ."\n" - .'* If you set the TaskType parameter to DI_REALTIME, set the TaskId parameter to the value of the FileId parameter for the real-time synchronization task.'."\n" - .'* If you set the TaskType parameter to DI_SOLUTION, set the TaskId parameter to the value of the FileId parameter for the synchronization solution.'."\n", - 'type' => 'integer', - 'format' => 'int64', 'required' => true, 'docRequired' => true, - 'maximum' => '9999999999999999', - 'minimum' => '0', - 'example' => '100', + 'example' => 'PROD', + 'isFileTransferUrl' => false, + 'enum' => ['PROD', 'DEV'], ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The returned results.'."\n", 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => '0bc1411515937635973****', - ], - 'Data' => [ - 'description' => 'The information returned for the ID of the asynchronous thread.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'Indicates whether the ID of the asynchronous thread is generated. Valid values:'."\n" + 'RequestId' => ['description' => 'The ID of the request. You can use the ID to locate logs and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF'], + 'ProgramTypeAndCounts' => [ + 'description' => 'An array of node types and quantity.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Count' => ['description' => 'The number of nodes.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ProgramType' => ['description' => 'The type of the node.'."\n" ."\n" - .'* success: indicates that the ID of the asynchronous thread is generated.'."\n" - .'* fail: indicates that the ID of the asynchronous thread fails to be generated. You can view the reason for the failure and troubleshoot the issue based on the reason.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'ProcessId' => [ - 'description' => 'The ID of the asynchronous thread. You can call the [QueryDISyncTaskConfigProcessResult](~~383465~~) operation to obtain the asynchronously generated parameters based on the ID. The parameters are used to update a real-time synchronization task in Data Integration.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'Message' => [ - 'description' => 'The reason why the ID of the asynchronous thread fails to be generated. If the ID is successfully generated, no value is returned for this parameter.'."\n", - 'type' => 'string', - 'example' => 'XXX is invalid.', + .'Valid values:'."\n" + ."\n" + .'6 (Shell node), 10 (ODPS SQL node), 11 (ODPS MR node), 23 (Data Integration node), 24 (ODPS Script node), 99 (zero load node), 221 (PyODPS 2 node), 225 (ODPS Spark node), 227 (EMR Hive node), 228 (EMR Spark node), 229 (EMR Spark SQL node), 230 (EMR MR node), 239 (OSS object inspection node), 257 (EMR Shell node), 258 (EMR Spark Shell node), 259 (EMR Presto node), 260 (EMR Impala node), 900 (real-time data synchronization node), 1089 (cross-tenant collaboration node), 1091 (Hologres development node), 1093 (Hologres SQL node), 1100 (assignment node), and 1221 (PyODPS 3 node).'."\n", 'type' => 'string', 'example' => 'ODPS_SQL'], ], ], ], @@ -22726,1162 +16224,1343 @@ ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Invalid.DI.Parameter', - 'errorMessage' => 'The parameter is invalid.', - ], - [ - 'errorCode' => 'Invalid.DI.Parameter.File.Existed', - 'errorMessage' => 'The file name already exists.', - ], - ], - 403 => [ - [ - 'errorCode' => 'Forbidden.DI.NoPrivilege', - 'errorMessage' => 'No access.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError.DI.Parameter', - 'errorMessage' => 'A DI internal error occurred.', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF\\",\\n \\"ProgramTypeAndCounts\\": [\\n {\\n \\"Count\\": 1,\\n \\"ProgramType\\": \\"ODPS_SQL\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF\\n\\n 1\\n ODPS_SQL\\n","errorExample":""}]', + 'title' => 'GetFileTypeStatistic', + 'summary' => 'Queries the distribution of node types.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-08-12T08:47:01.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-08-12T08:47:01.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-08-12T08:47:01.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0bc1411515937635973****\\",\\n \\"Data\\": {\\n \\"Status\\": \\"true\\",\\n \\"ProcessId\\": 10,\\n \\"Message\\": \\"XXX is invalid.\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 0bc1411515937635973****\\n \\n true\\n 10\\n XXX is invalid.\\n \\n","errorExample":""}]', - 'title' => 'GenerateDISyncTaskConfigForUpdating', - 'summary' => 'Generates the JSON for an asynchronous thread that is used to update a real-time synchronization task in Data Integration.', - 'description' => 'DataWorks allows you to use only the [UpdateDISyncTask](~~289109~~) operation to update a batch synchronization task in Data Integration. To update a real-time synchronization task, you must first call the GenerateDISyncTaskConfigForUpdating operation to generate the ID of an asynchronous thread and call the [QueryDISyncTaskConfigProcessResult](~~383465~~) operation to obtain the asynchronously generated parameters based on the ID. Then, you can call the UpdateDISyncTask operation and use the parameters as request parameters to update a real-time synchronization task in Data Integration. DataWorks allows you to create or update real-time synchronization tasks in Data Integration only in asynchronous mode.'."\n", ], - 'StartDISyncInstance' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetFileVersion' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', + 'abilityTreeCode' => '78247', + 'abilityTreeNodes' => ['FEATUREdide8FM783'], ], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the workspace ID. You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '10000000000', - 'minimum' => '1', - 'example' => '10000', - ], + 'name' => 'FileId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the file. You can call the [ListFiles](~~173942~~) operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1000001', 'title' => ''], ], [ - 'name' => 'TaskType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the object that you want to start. Valid values:'."\n" - ."\n" - .'* DI_REALTIME: real-time synchronization task'."\n" - .'* DI_SOLUTION: data synchronization solution'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'DI_REALTIME', - ], + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The DataWorks workspace ID. You can click the Workspace Manage icon in the upper-right corner of the DataStudio page to go to the Workspace page and view the workspace ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '1000011', 'title' => ''], ], [ - 'name' => 'FileId', - 'in' => 'query', - 'schema' => [ - 'description' => '* If you set TaskType to DI_REALTIME, set this parameter to the ID of the real-time synchronization task that you want to start.'."\n" - .'* If you set TaskType to DI_SOLUTION, set this parameter to the ID of the data synchronization solution that you want to start.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9999999999999999', - 'minimum' => '1', - 'example' => '100', - ], + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => ['description' => 'The unique identifier of the DataWorks workspace. You can click the identifier in the upper-left corner of the DataStudio page to switch to another workspace.'."\n" + ."\n" + .'You must specify either this parameter or ProjectId to determine the DataWorks workspace to which the operation is applied.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dw_project', 'title' => ''], ], [ - 'name' => 'StartParam', - 'in' => 'query', - 'schema' => [ - 'description' => '* If you set TaskType to DI_REALTIME, the StartParam parameter specifies the startup parameters for the real-time synchronization task. The startup parameters include failover-related parameters, the parameter that specifies the number of dirty data records allowed, and the parameters in the data definition language (DDL) statements.'."\n" - .'* If you set TaskType to DI_SOLUTION, the StartParam parameter does not take effect.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"failoverLimit":{"count":10,"interval":30},"errorLimit":{"record":0},"ddlMarkMap":{"RENAMECOLUMN":"WARNING","DROPTABLE":"WARNING","CREATETABLE":"IGNORE","MODIFYCOLUMN":"WARNING","TRUNCATETABLE":"NORMAL","DROPCOLUMN":"IGNORE","ADDCOLUMN":"NORMAL","RENAMETABLE":"CRITICAL"}}', - ], + 'name' => 'FileVersion', + 'in' => 'formData', + 'schema' => ['description' => 'The file version whose details you want to query.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '2', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => '0bc1411515937635973****', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'The connection does not exist.', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request. You can troubleshoot issues based on the ID.'."\n", 'type' => 'string', 'example' => '0000-ABCD-EFG****', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned.'."\n", 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'The result returned for the start.'."\n", + 'description' => 'The details of the file version.'."\n", 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'Indicates whether the real-time synchronization task or the data synchronization solution is started. Valid values:'."\n" - ."\n" - .'* success: The real-time synchronization task or the data synchronization solution is started.'."\n" - .'* fail: The real-time synchronization task or the data synchronization solution fails to be started. You can troubleshoot the issue based on the provided cause.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Message' => [ - 'description' => 'The reason why the real-time synchronization task or the data synchronization solution fails to be started.'."\n" - ."\n" - .'If the real-time synchronization task or the data synchronization solution is started, the value null is returned.'."\n", - 'type' => 'string', - 'example' => 'fileId:[100] is invalid.', - ], - ], + 'FileContent' => ['description' => 'The file code.'."\n", 'type' => 'string', 'example' => 'SHOW TABLES;', 'title' => ''], + 'IsCurrentProd' => ['description' => 'Indicates whether the version is the latest version in the production environment.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Status' => ['description' => 'The status of the file version. Valid values: COMMITTING, COMMITTED, CHECK_OK, PACKAGED, DEPLOYING, DEPLOYED, and CANCELLED. The value CHECK_OK is equivalent to the value COMMITTED.'."\n", 'type' => 'string', 'example' => 'COMMITTED', 'title' => ''], + 'NodeContent' => ['description' => 'The scheduling configurations of the node that corresponds to the file version.'."\n", 'type' => 'string', 'example' => '{"cycleType":0,"cronExpress":"00 05 00 * * ?"}', 'title' => ''], + 'CommitUser' => ['description' => 'The ID of the Alibaba Cloud account that is used to create the file version.'."\n", 'type' => 'string', 'example' => '7384234****', 'title' => ''], + 'Comment' => ['description' => 'The description of the file version.'."\n", 'type' => 'string', 'example' => 'Second version submission', 'title' => ''], + 'FilePropertyContent' => ['description' => 'The basic information about the file.'."\n", 'type' => 'string', 'example' => '{"fileName":"ods_user_info_d","fileType":10}', 'title' => ''], + 'FileName' => ['description' => 'The file name.'."\n", 'type' => 'string', 'example' => 'ods_user_info_d', 'title' => ''], + 'UseType' => ['description' => 'The functional module to which the file belongs. Valid values: NORMAL, MANUAL, MANUAL_BIZ, SKIP, ADHOCQUERY, and COMPONENT. The value NORMAL indicates DataStudio. The value MANUAL indicates a manually triggered node. The value MANUAL_BIZ indicates a manually triggered workflow. The value SKIP indicates a dry-run DataStudio node. The value ADHOCQUERY indicates an ad hoc query. The value COMPONENT indicates snippets.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], + 'ChangeType' => ['description' => 'The change type of the file version. Valid values: CREATE, UPDATE, and DELETE.'."\n", 'type' => 'string', 'example' => 'UPDATE', 'title' => ''], + 'FileVersion' => ['description' => 'The file version.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'CommitTime' => ['description' => 'The time when the version was generated. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1593881265000', 'title' => ''], + 'NodeId' => ['description' => 'The ID of the node that corresponds to the file version.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '3000001', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Param.Invalid', - 'errorMessage' => 'The parameter is invalid.', - ], - ], 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden.', - ], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal error occurred.', - ], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0bc1411515937635973****\\",\\n \\"Data\\": {\\n \\"Status\\": \\"success\\",\\n \\"Message\\": \\"fileId:[100] is invalid.\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 0bc1411515937635973****\\n \\n success\\n fileId:[100] is invalid.\\n \\n true\\n","errorExample":""}]', - 'title' => 'StartDISyncInstance', - 'summary' => 'Starts a real-time synchronization task or a synchronization solution.', - ], - 'StopDISyncInstance' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'GetFileVersion', + 'summary' => 'Queries the information about a file version.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"FileContent\\": \\"SHOW TABLES;\\",\\n \\"IsCurrentProd\\": true,\\n \\"Status\\": \\"COMMITTED\\",\\n \\"NodeContent\\": \\"{\\\\\\"cycleType\\\\\\":0,\\\\\\"cronExpress\\\\\\":\\\\\\"00 05 00 * * ?\\\\\\"}\\",\\n \\"CommitUser\\": \\"7384234****\\",\\n \\"Comment\\": \\"Second version submission\\",\\n \\"FilePropertyContent\\": \\"{\\\\\\"fileName\\\\\\":\\\\\\"ods_user_info_d\\\\\\",\\\\\\"fileType\\\\\\":10}\\",\\n \\"FileName\\": \\"ods_user_info_d\\",\\n \\"UseType\\": \\"0\\",\\n \\"ChangeType\\": \\"UPDATE\\",\\n \\"FileVersion\\": 2,\\n \\"CommitTime\\": 1593881265000,\\n \\"NodeId\\": 3000001\\n }\\n}","type":"json"}]', + ], + 'GetFolder' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'PrivateKey' => [], - ], - [ - 'APP' => [], - ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', + 'abilityTreeCode' => '78248', + 'abilityTreeNodes' => ['FEATUREdide8FM783'], ], 'parameters' => [ [ 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the workspace ID.'."\n" - ."\n" - .'You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '10000000000', - 'minimum' => '1', - 'example' => '10000', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the DataWorks workspace. Log on to the DataWorks console and go to the Workspace Management page to obtain the workspace ID. You must set either this parameter or ProjectIdentifier to specify the DataWorks workspace for the API call.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '1000011', 'title' => ''], ], [ - 'name' => 'TaskType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the synchronization task that you want to stop. Set the value to DI_REALTIME.'."\n" - ."\n" - .'DI_REALTIME indicates a real-time synchronization task.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'DI_REALTIME', - ], + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the DataWorks workspace. Log on to the DataWorks console and go to the Workspace Management page to obtain the workspace name. You must set either this parameter or ProjectId to specify the DataWorks workspace for the API call.', 'type' => 'string', 'required' => false, 'example' => 'dw_project', 'title' => ''], ], [ - 'name' => 'FileId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the synchronization task. You can call the [ListFiles](~~173942~~) operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9999999999999999', - 'minimum' => '1', - 'example' => '100', - ], + 'name' => 'FolderId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the folder. You must set either this parameter or FolderPath. You can call the [ListFolders](~~173955~~) operation to obtain the folder ID.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '273****', 'title' => ''], + ], + [ + 'name' => 'FolderPath', + 'in' => 'formData', + 'schema' => ['description' => 'The path of the folder. You must set either this parameter or FolderId. You can call the [ListFolders](~~173955~~) operation to obtain the folder path.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'minLength' => 1, 'example' => 'Business_process/my_first_business_process/MaxCompute/ods_layer', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => '0bc1411515937635973****', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The connection does not exist.', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request. Use this ID to troubleshoot issues if an error occurs.', 'type' => 'string', 'example' => '0000-ABCD-EFG****', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'The information returned for the synchronization task.'."\n", + 'description' => 'The details of the folder.', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'Indicates whether the synchronization task is stopped. Valid values:'."\n" - ."\n" - .'* success'."\n" - .'* fail'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Message' => [ - 'description' => 'The reason why the synchronization task fails to be stopped.'."\n" - ."\n" - .'If the synchronization task is stopped, the value null is returned.'."\n", - 'type' => 'string', - 'example' => 'fileId:[100] is invalid.', - ], + 'FolderPath' => ['description' => 'The path of the folder.', 'type' => 'string', 'example' => 'Business_process/my_first_business_process/MaxCompute/ods_layer', 'title' => ''], + 'FolderId' => ['description' => 'The ID of the folder.', 'type' => 'string', 'example' => '2735****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Param.Invalid', - 'errorMessage' => 'The parameter is invalid.', - ], - ], 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden.', - ], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal error occurred.', - ], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0bc1411515937635973****\\",\\n \\"Data\\": {\\n \\"Status\\": \\"success\\",\\n \\"Message\\": \\"fileId:[100] is invalid.\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 0bc1411515937635973****\\n \\n success\\n fileId:[100] is invalid.\\n \\n","errorExample":""}]', - 'title' => 'StopDISyncInstance', - 'summary' => 'Stops a real-time synchronization task.', - ], - 'QueryDISyncTaskConfigProcessResult' => [ - 'methods' => [ - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"FolderPath\\": \\"Business_process/my_first_business_process/MaxCompute/ods_layer\\",\\n \\"FolderId\\": \\"2735****\\"\\n }\\n}","type":"json"}]', + 'title' => 'GetFolder', + 'summary' => 'You can call GetFolder to retrieve the details of a folder.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-09-20T06:18:12.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], - 'security' => [ + 'ramActions' => [ [ - 'AK' => [], - ], - [ - 'PrivateKey' => [], + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], + ], + ], + 'GetIDEEventDetail' => [ + 'summary' => 'Queries the data snapshot of an extension point based on the ID of a message in DataWorks OpenEvent when the related extension point event is triggered.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'APP' => [], + 'AK' => [], ], ], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '101710', + 'abilityTreeNodes' => ['FEATUREdide8FM783'], ], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the ID.'."\n" - ."\n" - .'You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '10000000000', - 'minimum' => '1', - 'example' => '10000', - ], - ], - [ - 'name' => 'TaskType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the object that you want to create or update in Data Integration in asynchronous mode. Valid values:'."\n" - ."\n" - .'* DI_REALTIME: real-time synchronization task'."\n" - .'* DI_SOLUTION: synchronization solution DataWorks allows you to create or update real-time synchronization tasks and synchronization solutions in Data Integration only in asynchronous mode.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* DI_OFFLINE'."\n" - .'* DI_REALTIME'."\n" - .'* DI_SOLUTION'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [], - 'example' => 'DI_REALTIME', - 'enum' => [ - 'DI_OFFLINE', - 'DI_REALTIME', - 'DI_SOLUTION', - ], - ], + 'name' => 'MessageId', + 'in' => 'formData', + 'schema' => ['description' => 'The message ID in DataWorks OpenEvent. You can obtain the ID from a received message when an extension point event is triggered.'."\n", 'type' => 'string', 'required' => true, 'example' => '8abcb91f-d266-4073-b907-2ed67****1', 'title' => ''], ], [ - 'name' => 'AsyncProcessId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The asynchronous thread ID. You can call the [GenerateDISyncTaskConfigForCreating](~~383463~~) or [GenerateDISyncTaskConfigForUpdating](~~383464~~) operation to obtain the ID.'."\n" - ."\n" - .'* The GenerateDISyncTaskConfigForCreating operation is used to generate the ID of the asynchronous thread that is used to create a real-time synchronization task in Data Integration.'."\n" - .'* The GenerateDISyncTaskConfigForUpdating operation is used to generate the ID of the asynchronous thread that is used to update a real-time synchronization task in Data Integration.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9999999999999999', - 'minimum' => '1', - 'example' => '10', - ], + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The DataWorks workspace ID. You can obtain the ID from the message.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The returned results.'."\n", + 'title' => 'Schema of Response', + 'description' => 'The response.'."\n", 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '8abcb91f-d266-4073-b907-2ed670378ed1'], + 'EventDetail' => [ + 'description' => 'The data snapshot that is generated when an extension point event is triggered.'."\n" ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => '0bc1411515937635973****', - ], - 'Data' => [ - 'description' => 'The information returned for the parameters that are asynchronously generated and used to create or update a real-time synchronization task in Data Integration.'."\n", + .'The fields contained in data snapshots vary based on the types of the triggered extension point events. For more information, see the description of the fields.'."\n", 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'Indicates whether the parameters are obtained. Valid values:'."\n" - ."\n" - .'* success: The parameters are obtained.'."\n" - .'* fail: The parameters fail to be obtained. You can view the reason for the failure and troubleshoot the issue based on the reason.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Message' => [ - 'description' => 'The reason why the parameters fail to be obtained. If the parameters are obtained, the value null is returned.'."\n", - 'type' => 'string', - 'example' => 'fileId:[100] is invalid.', + 'FileExecutionCommand' => [ + 'description' => 'The data snapshot when the code in the file is run. This parameter is valid only if the message type is IDE_FILE_EXECUTE_BEFORE.'."\n", + 'type' => 'object', + 'properties' => [ + 'FileId' => ['description' => 'The file ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234123', 'title' => ''], + 'DataSourceName' => ['description' => 'The name of the data source with which the file is associated.'."\n", 'type' => 'string', 'example' => 'odps_source', 'title' => ''], + 'Content' => ['description' => 'The code in the file of the current version.'."\n", 'type' => 'string', 'example' => 'SHOW TABLES;', 'title' => ''], + 'FileType' => ['description' => 'The type of the code for the file. The code for files varies based on the file type. For more information, see [DataWorks nodes](~~600169~~).'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'TaskContent' => [ - 'description' => 'The parameters that are obtained. The parameters are used as the request parameters of the [CreateDISyncTask](~~278725~~) or [UpdateDISyncTask](~~289109~~) operation to create or update a real-time synchronization task in Data Integration.'."\n", - 'type' => 'string', - 'example' => '{"extend":{"mode":"migration_holo","resourceGroup":"280749","name":"h"},"type":"job","steps":[{"stepType":"mysql","parameter":{"connection":[{"datasourceType":"mysql","datasource":"mm","selectedTables":[{"schema":[{"tableInfos":[{"enable":true,"table":"m_v1","tableName":"m_v1"}]}],"dbName":"m"}]}]},"name":"reader","category":"reader"},{"stepType":"holo","parameter":{"datasource":"h","tableMappingRule":{"datasource":[{"tableRule":[{"srcTable":"m_v1","mergeIntoCycleType":"DEFAULT","hourDeltaEnable":false,"dstTable":"m.m_v1","dayDeltaEnable":false,"primaryKeyInfo":{"column":["id"],"type":"pk"},"dstCreateTableInfo":{"indexType":"m_v1","dataColumn":[{"columnSize":0,"name":"id","index":0,"comment":"","newDigit":0,"type":"int8","digit":0,"primaryKey":true}],"schemaName":"m","tableName":"m_v1"},"srcDbName":"m"],"srcDatasourceName":"mm"}],"totalTableMapping":1},"writeMode":"replay"},"name":"writer","category":"writer"}],"version":"2.0","order":{"hops":[{"from":"reader","to":"writer"}]}}', + 'DeletedFile' => [ + 'description' => 'The data snapshot when the file is deleted. This parameter is valid only if the message type is IDE_FILE_DELETE_BEFORE.'."\n", + 'type' => 'object', + 'properties' => [ + 'Owner' => ['description' => 'The file owner.'."\n", 'type' => 'string', 'example' => '7384234****', 'title' => ''], + 'FileType' => ['description' => 'The type of the code for the file. The code of files varies based on the file type. For more information, see [DataWorks nodes](~~600169~~).'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'CurrentVersion' => ['description' => 'The latest version number of the file.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'BusinessId' => ['description' => 'The ID of the workflow to which the file belongs.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '74328', 'title' => ''], + 'FileName' => ['description' => 'The name of the file.'."\n", 'type' => 'string', 'example' => 'hello_dataworks.sql', 'title' => ''], + 'DataSourceName' => ['description' => 'The name of the data source with which the file is associated.'."\n", 'type' => 'string', 'example' => 'odps_source', 'title' => ''], + 'UseType' => ['description' => 'The module to which the file belongs. Valid values:'."\n" + ."\n" + .'* NORMAL: The file is used for DataStudio.'."\n" + .'* MANUAL: The file is used for a manually triggered node.'."\n" + .'* MANUAL_BIZ: The file is used for a manually triggered workflow.'."\n" + .'* SKIP: The file is used for a dry-run DataStudio node.'."\n" + .'* ADHOCQUERY: The file is used for an ad hoc query.'."\n" + .'* COMPONENT: The file is used for a snippet.'."\n", 'type' => 'string', 'example' => 'NORMAL', 'title' => ''], + 'FolderId' => ['description' => 'The ID of the folder to which the file belongs. You can call the [GetFolder](~~173952~~) operation to query the details of the file based on the folder ID.'."\n", 'type' => 'string', 'example' => 'aldurie78l2falure', 'title' => ''], + 'ParentFileId' => ['description' => 'The ID of the do-while node or for-each node that corresponds to the file.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234122', 'title' => ''], + 'Content' => ['description' => 'The code in the file of the current version.'."\n", 'type' => 'string', 'example' => 'SHOW TABLES;', 'title' => ''], + 'NodeId' => ['description' => 'The ID of the node that is scheduled.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '421429', 'title' => ''], + 'FileId' => ['description' => 'The file ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234123', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Param.Invalid', - 'errorMessage' => 'The parameter is invalid.', - ], - ], - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal error occurred.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0bc1411515937635973****\\",\\n \\"Data\\": {\\n \\"Status\\": \\"success\\",\\n \\"Message\\": \\"fileId:[100] is invalid.\\",\\n \\"TaskContent\\": \\"{\\\\\\"extend\\\\\\":{\\\\\\"mode\\\\\\":\\\\\\"migration_holo\\\\\\",\\\\\\"resourceGroup\\\\\\":\\\\\\"280749\\\\\\",\\\\\\"name\\\\\\":\\\\\\"h\\\\\\"},\\\\\\"type\\\\\\":\\\\\\"job\\\\\\",\\\\\\"steps\\\\\\":[{\\\\\\"stepType\\\\\\":\\\\\\"mysql\\\\\\",\\\\\\"parameter\\\\\\":{\\\\\\"connection\\\\\\":[{\\\\\\"datasourceType\\\\\\":\\\\\\"mysql\\\\\\",\\\\\\"datasource\\\\\\":\\\\\\"mm\\\\\\",\\\\\\"selectedTables\\\\\\":[{\\\\\\"schema\\\\\\":[{\\\\\\"tableInfos\\\\\\":[{\\\\\\"enable\\\\\\":true,\\\\\\"table\\\\\\":\\\\\\"m_v1\\\\\\",\\\\\\"tableName\\\\\\":\\\\\\"m_v1\\\\\\"}]}],\\\\\\"dbName\\\\\\":\\\\\\"m\\\\\\"}]}]},\\\\\\"name\\\\\\":\\\\\\"reader\\\\\\",\\\\\\"category\\\\\\":\\\\\\"reader\\\\\\"},{\\\\\\"stepType\\\\\\":\\\\\\"holo\\\\\\",\\\\\\"parameter\\\\\\":{\\\\\\"datasource\\\\\\":\\\\\\"h\\\\\\",\\\\\\"tableMappingRule\\\\\\":{\\\\\\"datasource\\\\\\":[{\\\\\\"tableRule\\\\\\":[{\\\\\\"srcTable\\\\\\":\\\\\\"m_v1\\\\\\",\\\\\\"mergeIntoCycleType\\\\\\":\\\\\\"DEFAULT\\\\\\",\\\\\\"hourDeltaEnable\\\\\\":false,\\\\\\"dstTable\\\\\\":\\\\\\"m.m_v1\\\\\\",\\\\\\"dayDeltaEnable\\\\\\":false,\\\\\\"primaryKeyInfo\\\\\\":{\\\\\\"column\\\\\\":[\\\\\\"id\\\\\\"],\\\\\\"type\\\\\\":\\\\\\"pk\\\\\\"},\\\\\\"dstCreateTableInfo\\\\\\":{\\\\\\"indexType\\\\\\":\\\\\\"m_v1\\\\\\",\\\\\\"dataColumn\\\\\\":[{\\\\\\"columnSize\\\\\\":0,\\\\\\"name\\\\\\":\\\\\\"id\\\\\\",\\\\\\"index\\\\\\":0,\\\\\\"comment\\\\\\":\\\\\\"\\\\\\",\\\\\\"newDigit\\\\\\":0,\\\\\\"type\\\\\\":\\\\\\"int8\\\\\\",\\\\\\"digit\\\\\\":0,\\\\\\"primaryKey\\\\\\":true}],\\\\\\"schemaName\\\\\\":\\\\\\"m\\\\\\",\\\\\\"tableName\\\\\\":\\\\\\"m_v1\\\\\\"},\\\\\\"srcDbName\\\\\\":\\\\\\"m\\\\\\"}],\\\\\\"srcDatasourceName\\\\\\":\\\\\\"mm\\\\\\"}],\\\\\\"totalTableMapping\\\\\\":1},\\\\\\"writeMode\\\\\\":\\\\\\"replay\\\\\\"},\\\\\\"name\\\\\\":\\\\\\"writer\\\\\\",\\\\\\"category\\\\\\":\\\\\\"writer\\\\\\"}],\\\\\\"version\\\\\\":\\\\\\"2.0\\\\\\",\\\\\\"order\\\\\\":{\\\\\\"hops\\\\\\":[{\\\\\\"from\\\\\\":\\\\\\"reader\\\\\\",\\\\\\"to\\\\\\":\\\\\\"writer\\\\\\"}]}}\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 0bc1411515937635973****\\n \\n success\\n fileId:[100] is invalid.\\n {\\"extend\\":{\\"mode\\":\\"migration_holo\\",\\"resourceGroup\\":\\"280749\\",\\"name\\":\\"h\\"},\\"type\\":\\"job\\",\\"steps\\":[{\\"stepType\\":\\"mysql\\",\\"parameter\\":{\\"connection\\":[{\\"datasourceType\\":\\"mysql\\",\\"datasource\\":\\"mm\\",\\"selectedTables\\":[{\\"schema\\":[{\\"tableInfos\\":[{\\"enable\\":true,\\"table\\":\\"m_v1\\",\\"tableName\\":\\"m_v1\\"}]}],\\"dbName\\":\\"m\\"}]}]},\\"name\\":\\"reader\\",\\"category\\":\\"reader\\"},{\\"stepType\\":\\"holo\\",\\"parameter\\":{\\"datasource\\":\\"h\\",\\"tableMappingRule\\":{\\"datasource\\":[{\\"tableRule\\":[{\\"srcTable\\":\\"m_v1\\",\\"mergeIntoCycleType\\":\\"DEFAULT\\",\\"hourDeltaEnable\\":false,\\"dstTable\\":\\"m.m_v1\\",\\"dayDeltaEnable\\":false,\\"primaryKeyInfo\\":{\\"column\\":[\\"id\\"],\\"type\\":\\"pk\\"},\\"dstCreateTableInfo\\":{\\"indexType\\":\\"m_v1\\",\\"dataColumn\\":[{\\"columnSize\\":0,\\"name\\":\\"id\\",\\"index\\":0,\\"comment\\":\\"\\",\\"newDigit\\":0,\\"type\\":\\"int8\\",\\"digit\\":0,\\"primaryKey\\":true}],\\"schemaName\\":\\"m\\",\\"tableName\\":\\"m_v1\\"},\\"srcDbName\\":\\"m\\"}],\\"srcDatasourceName\\":\\"mm\\"}],\\"totalTableMapping\\":1},\\"writeMode\\":\\"replay\\"},\\"name\\":\\"writer\\",\\"category\\":\\"writer\\"}],\\"version\\":\\"2.0\\",\\"order\\":{\\"hops\\":[{\\"from\\":\\"reader\\",\\"to\\":\\"writer\\"}]}}\\n \\n","errorExample":""}]', - 'title' => 'QueryDISyncTaskConfigProcessResult', - 'summary' => 'Queries the execution results of an asynchronous task.', - 'description' => 'DataWorks allows you to call only the [CreateDISyncTask](~~278725~~) operation to create a batch synchronization task or the [UpdateDISyncTask](~~289109~~) operation to update a batch synchronization task in Data Integration. To create or update a real-time synchronization task, you must first call the [GenerateDISyncTaskConfigForCreating](~~383463~~) or [GenerateDISyncTaskConfigForUpdating](~~383464~~) operation to obtain the ID of an asynchronous thread and call the [QueryDISyncTaskConfigProcessResult](~~383465~~) operation to obtain the asynchronously generated parameters based on the ID. Then, you can call the CreateDISyncTask or UpdateDISyncTask operation and use the parameters as request parameters to create or update a real-time synchronization task. DataWorks allows you to create or update real-time synchronization tasks in Data Integration only in asynchronous mode.'."\n", - ], - 'CreateDIJob' => [ - 'summary' => 'Creates a new-version synchronization task. The following types of synchronization tasks are supported: real-time synchronization of all data in a MySQL database to Hologres and batch synchronization of all data in a MySQL database to Hive.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '155151', - 'abilityTreeNodes' => [ - 'FEATUREdideQHGTK4', - ], - ], - 'parameters' => [ - [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The DataWorks workspace ID. You can call the [ListProjects](~~178393~~) operation to obtain the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10000', + 'CommittedFile' => [ + 'description' => 'The data snapshot when the file is committed and deployed.'."\n" + ."\n" + .'This parameter is valid only if the message type is IDE_FILE_SUBMIT_BEFORE or IDE_FILE_DEPLOY_BEFORE.'."\n", + 'type' => 'object', + 'properties' => [ + 'FileId' => ['description' => 'The file ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234123', 'title' => ''], + 'Content' => ['description' => 'The code in the file of the current version.'."\n", 'type' => 'string', 'example' => 'SHOW TABLES;', 'title' => ''], + 'Committor' => ['description' => 'The ID of the Alibaba Cloud account that is used to generate the file of the current version.'."\n", 'type' => 'string', 'example' => '7384234****', 'title' => ''], + 'FileType' => ['description' => 'The type of the code for the file. The code of files varies based on the file type. For more information, see [DataWorks nodes](~~600169~~).'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'ChangeType' => ['description' => 'The type of the change to the file of the current version. Valid values: CREATE, UPDATE, and DELETE.'."\n", 'type' => 'string', 'example' => 'UPDATE', 'title' => ''], + 'FileName' => ['description' => 'The name of the file.'."\n", 'type' => 'string', 'example' => 'hello_dataworks.sql', 'title' => ''], + 'NodeId' => ['description' => 'The ID of the node that is scheduled.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '421429', 'title' => ''], + 'Comment' => ['description' => 'The description of the file version.'."\n", 'type' => 'string', 'example' => 'Second version submission', 'title' => ''], + 'UseType' => ['description' => 'The module to which the file belongs. Valid values:'."\n" + ."\n" + .'* NORMAL: The file is used for DataStudio.'."\n" + .'* MANUAL: The file is used for a manually triggered node.'."\n" + .'* MANUAL_BIZ: The file is used for a manually triggered workflow.'."\n" + .'* SKIP: The file is used for a dry-run DataStudio node.'."\n" + .'* ADHOCQUERY: The file is used for an ad hoc query.'."\n" + .'* COMPONENT: The file is used for a snippet.'."\n", 'type' => 'string', 'example' => 'NORMAL', 'title' => ''], + 'FilePropertyContent' => [ + 'description' => 'The details of the file.'."\n", + 'type' => 'object', + 'properties' => [ + 'DataSourceName' => ['description' => 'The name of the data source with which the file is associated.'."\n", 'type' => 'string', 'example' => 'odps_source', 'title' => ''], + 'ParentFileId' => ['description' => 'The ID of the do-while node or for-each node that corresponds to the file.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234122', 'title' => ''], + 'BusinessId' => ['description' => 'The ID of the workflow to which the file belongs.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '74328', 'title' => ''], + 'CurrentVersion' => ['description' => 'The latest version number of the file.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Owner' => ['description' => 'The file owner.'."\n", 'type' => 'string', 'example' => '7384234****', 'title' => ''], + 'FolderId' => ['description' => 'The ID of the folder to which the file belongs. You can call the [GetFolder](~~173952~~) operation to query the details of the file based on the folder ID.'."\n", 'type' => 'string', 'example' => 'aldurie78l2falure', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'NodeConfiguration' => [ + 'description' => 'The scheduling properties of the node that corresponds to the file.'."\n", + 'type' => 'object', + 'properties' => [ + 'RerunMode' => ['description' => 'Indicates whether the node that corresponds to the file can be rerun. Valid values:'."\n" + ."\n" + .'* ALL_ALLOWED: The node can be rerun regardless of whether it is successfully run or fails to run.'."\n" + .'* FAILURE_ALLOWED: The node can be rerun only after it fails to run.'."\n" + .'* ALL_DENIED: The node cannot be rerun regardless of whether it is successfully run or fails to run.'."\n" + ."\n" + .'This parameter corresponds to the Rerun parameter in the Schedule section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", 'type' => 'string', 'example' => 'ALL_ALLOWED', 'title' => ''], + 'SchedulerType' => ['description' => 'The scheduling type of the node. Valid values:'."\n" + ."\n" + .'* NORMAL: The node is an auto triggered node.'."\n" + .'* MANUAL: The node is a manually triggered node. Manually triggered nodes cannot be automatically triggered. They correspond to the nodes in the Manually Triggered Workflows pane.'."\n" + .'* PAUSE: The node is a paused node.'."\n" + .'* SKIP: The node is a dry-run node. Dry-run nodes are started as scheduled, but the system sets the status of the nodes to successful when it starts to run them.'."\n", 'type' => 'string', 'example' => 'NORMAL', 'title' => ''], + 'ParaValue' => ['description' => 'The scheduling parameters of the node.'."\n" + ."\n" + .'This parameter corresponds to the Scheduling Parameter section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console). For more information about the configurations of the scheduling parameters, see [Configure scheduling parameters](~~137548~~).'."\n", 'type' => 'string', 'example' => 'a=x b=y', 'title' => ''], + 'CycleType' => ['description' => 'The type of the scheduling cycle of the node that corresponds to the file. Valid values: NOT_DAY and DAY. The value NOT_DAY indicates that the node is scheduled to run by minute or hour. The value DAY indicates that the node is scheduled to run by day, week, or month.'."\n" + ."\n" + .'This parameter corresponds to the Scheduling Cycle parameter in the Schedule section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", 'type' => 'string', 'example' => 'DAY', 'title' => ''], + 'DependentNodeIdList' => ['description' => 'The ID of the node on which the node that corresponds to the file depends when the DependentType parameter is set to USER_DEFINE. Multiple IDs are separated by commas (,).'."\n" + ."\n" + .'The value of this parameter is equivalent to the ID of the node that you specified after you select Other Nodes for Cross-Cycle Dependency (Original Previous-Cycle Dependency) in the Dependencies section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", 'type' => 'string', 'example' => '5,10,15,20', 'title' => ''], + 'ResourceGroupId' => ['description' => 'The ID of the resource group that is used to run the node that corresponds to the file. You can call the [ListResourceGroups](~~173913~~) operation to query the available resource groups in the workspace.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '375827434852437', 'title' => ''], + 'AutoRerunTimes' => ['description' => 'The number of times that the node corresponding to the file can be rerun.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'AutoRerunIntervalMillis' => ['description' => 'The interval at which the node corresponding to the file is rerun. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '120000', 'title' => ''], + 'CronExpress' => ['description' => 'The CRON expression that is used to schedule the node corresponding to the file.'."\n", 'type' => 'string', 'example' => '00 05 00 * * ?', 'title' => ''], + 'InputList' => [ + 'description' => 'The output names of the parent files on which the current file depends.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The output information about the parent files on which the current file depends.'."\n", + 'type' => 'object', + 'properties' => [ + 'Input' => ['description' => 'The output name of the parent file on which the current file depends.'."\n" + ."\n" + .'This parameter corresponds to the Output Name of Ancestor Node parameter under Parent Nodes in the Dependencies section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", 'type' => 'string', 'example' => 'dw_project_root', 'title' => ''], + 'ParseType' => ['description' => 'The mode of the configuration file dependency. Valid values:'."\n" + ."\n" + .'* MANUAL: Scheduling dependencies are manually configured.'."\n" + .'* AUTO: Scheduling dependencies are automatically parsed.'."\n", 'type' => 'string', 'example' => 'MANUAL', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'OutputList' => [ + 'description' => 'The output names of the current file.'."\n" + ."\n" + .'This parameter corresponds to the Output Name of Current Node parameter in the Dependencies section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The output information about the current file.'."\n", + 'type' => 'object', + 'properties' => [ + 'RefTableName' => ['description' => 'The output table name of the current file.'."\n" + ."\n" + .'This parameter corresponds to the Output Table Name parameter under Output Name of Current Node in the Dependencies section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", 'type' => 'string', 'example' => 'ods_user_info_d', 'title' => ''], + 'Output' => ['description' => 'The output name of the current file.'."\n" + ."\n" + .'This parameter corresponds to the Output Name parameter under Output Name of Current Node in the Dependencies section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", 'type' => 'string', 'example' => 'dw_project.002_out', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'DependentType' => ['description' => 'The type of the cross-cycle scheduling dependency of the node. Valid values:'."\n" + ."\n" + .'* SELF: The instance generated for the node in the current cycle depends on the instance generated for the node in the previous cycle.'."\n" + .'* CHILD: The instance generated for the node in the current cycle depends on the instances generated for the descendant nodes at the nearest level of the node in the previous cycle.'."\n" + .'* USER_DEFINE: The instance generated for the node in the current cycle depends on the instances generated for one or more specified nodes in the previous cycle.'."\n" + .'* NONE: No cross-cycle scheduling dependency type is selected for the node.'."\n", 'type' => 'string', 'example' => 'USER_DEFINE', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'TableModel' => [ + 'description' => 'The data snapshot when the table is committed and deployed. This parameter is valid only if the message type is IDE_TABLE_SUBMIT_BEFORE or IDE_TABLE_DEPLOY_BEFORE.'."\n", + 'type' => 'object', + 'properties' => [ + 'Env' => ['description' => 'The environment in which the table is used. Valid values:'."\n" + ."\n" + .'* DEV'."\n" + .'* PROD'."\n", 'type' => 'string', 'example' => 'DEV', 'title' => ''], + 'LifeCycle' => ['description' => 'The lifecycle of the metatable. Unit: day.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '7', 'title' => ''], + 'TableName' => ['description' => 'The name of the table.'."\n", 'type' => 'string', 'example' => 'tb_hello', 'title' => ''], + 'DataSourceName' => ['description' => 'The name of the data source to which the table belongs.'."\n", 'type' => 'string', 'example' => 'odps_source', 'title' => ''], + 'Columns' => [ + 'description' => 'The columns in the table.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The column in the table.'."\n", + 'type' => 'object', + 'properties' => [ + 'ColumnName' => ['description' => 'The name of the column.'."\n", 'type' => 'string', 'example' => 'ID', 'title' => ''], + 'ColumnType' => ['description' => 'The data type of the column.'."\n", 'type' => 'string', 'example' => 'BIGINT', 'title' => ''], + 'IsPartitionColumn' => ['description' => 'Indicates whether the column is a partition key column. Valid values:'."\n" + ."\n" + .'* true: The column is a partition key column.'."\n" + .'* false: The column is not a partition key column.'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Comment' => ['description' => 'The remarks of the column.'."\n", 'type' => 'string', 'example' => 'ID', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Comment' => ['description' => 'The remarks of the table.'."\n", 'type' => 'string', 'example' => 'A new table', 'title' => ''], + 'Location' => ['description' => 'The path of the table.'."\n", 'type' => 'string', 'example' => 'hdfs://path/to/object', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ], + ], + 'title' => 'GetIDEEventDetail', + 'description' => "\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetIDEEventDetail'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8abcb91f-d266-4073-b907-2ed670378ed1\\",\\n \\"EventDetail\\": {\\n \\"FileExecutionCommand\\": {\\n \\"FileId\\": 1234123,\\n \\"DataSourceName\\": \\"odps_source\\",\\n \\"Content\\": \\"SHOW TABLES;\\",\\n \\"FileType\\": 10\\n },\\n \\"DeletedFile\\": {\\n \\"Owner\\": \\"7384234****\\",\\n \\"FileType\\": 10,\\n \\"CurrentVersion\\": 1,\\n \\"BusinessId\\": 74328,\\n \\"FileName\\": \\"hello_dataworks.sql\\",\\n \\"DataSourceName\\": \\"odps_source\\",\\n \\"UseType\\": \\"NORMAL\\",\\n \\"FolderId\\": \\"aldurie78l2falure\\",\\n \\"ParentFileId\\": 1234122,\\n \\"Content\\": \\"SHOW TABLES;\\",\\n \\"NodeId\\": 421429,\\n \\"FileId\\": 1234123\\n },\\n \\"CommittedFile\\": {\\n \\"FileId\\": 1234123,\\n \\"Content\\": \\"SHOW TABLES;\\",\\n \\"Committor\\": \\"7384234****\\",\\n \\"FileType\\": 10,\\n \\"ChangeType\\": \\"UPDATE\\",\\n \\"FileName\\": \\"hello_dataworks.sql\\",\\n \\"NodeId\\": 421429,\\n \\"Comment\\": \\"Second version submission\\",\\n \\"UseType\\": \\"NORMAL\\",\\n \\"FilePropertyContent\\": {\\n \\"DataSourceName\\": \\"odps_source\\",\\n \\"ParentFileId\\": 1234122,\\n \\"BusinessId\\": 74328,\\n \\"CurrentVersion\\": 1,\\n \\"Owner\\": \\"7384234****\\",\\n \\"FolderId\\": \\"aldurie78l2falure\\"\\n },\\n \\"NodeConfiguration\\": {\\n \\"RerunMode\\": \\"ALL_ALLOWED\\",\\n \\"SchedulerType\\": \\"NORMAL\\",\\n \\"ParaValue\\": \\"a=x b=y\\",\\n \\"CycleType\\": \\"DAY\\",\\n \\"DependentNodeIdList\\": \\"5,10,15,20\\",\\n \\"ResourceGroupId\\": 375827434852437,\\n \\"AutoRerunTimes\\": 3,\\n \\"AutoRerunIntervalMillis\\": 120000,\\n \\"CronExpress\\": \\"00 05 00 * * ?\\",\\n \\"InputList\\": [\\n {\\n \\"Input\\": \\"dw_project_root\\",\\n \\"ParseType\\": \\"MANUAL\\"\\n }\\n ],\\n \\"OutputList\\": [\\n {\\n \\"RefTableName\\": \\"ods_user_info_d\\",\\n \\"Output\\": \\"dw_project.002_out\\"\\n }\\n ],\\n \\"DependentType\\": \\"USER_DEFINE\\"\\n }\\n },\\n \\"TableModel\\": {\\n \\"Env\\": \\"DEV\\",\\n \\"LifeCycle\\": 7,\\n \\"TableName\\": \\"tb_hello\\",\\n \\"DataSourceName\\": \\"odps_source\\",\\n \\"Columns\\": [\\n {\\n \\"ColumnName\\": \\"ID\\",\\n \\"ColumnType\\": \\"BIGINT\\",\\n \\"IsPartitionColumn\\": false,\\n \\"Comment\\": \\"ID\\"\\n }\\n ],\\n \\"Comment\\": \\"A new table\\",\\n \\"Location\\": \\"hdfs://path/to/object\\"\\n }\\n }\\n}","type":"json"}]', + ], + 'GetInstance' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'JobName', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '78249', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB'], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the synchronization task.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mysql_to_holo_sync_8772', - ], + 'schema' => ['description' => 'The instance ID. You can call the [ListInstances](~~173982~~) operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1234', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'ProjectEnv', 'in' => 'formData', 'schema' => [ - 'description' => 'The description of the synchronization task.'."\n", + 'description' => 'The environment of the workspace. Valid values: PROD and DEV.'."\n", 'type' => 'string', - 'required' => false, - 'example' => 'Synchronize mysql to hologres', + 'required' => true, + 'docRequired' => true, + 'example' => 'PROD', + 'enum' => ['PROD', 'DEV'], + 'title' => '', ], ], - [ - 'name' => 'MigrationType', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The synchronization type. Valid values:'."\n" - ."\n" - .'* FullAndRealtimeIncremental (one-time full synchronization and real-time incremental synchronization)'."\n" - .'* RealtimeIncremental (real-time incremental synchronization)'."\n" - .'* Full (full synchronization)'."\n" - .'* OfflineIncremental (batch incremental synchronization)'."\n" - .'* FullAndOfflineIncremental (one-time full synchronization and batch incremental synchronization)'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'FullAndRealtimeIncremental', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'E6F0DBDD-5AD****', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned when the instance fails to be scheduled.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], + 'Data' => [ + 'description' => 'The details of the instance.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status of the node that generates the instance. Valid values:'."\n" + ."\n" + .'* NOT_RUN: The node is not run.'."\n" + .'* WAIT_TIME: The node is waiting for its scheduling time to arrive.'."\n" + .'* WAIT_RESOURCE: The node is waiting for resources.'."\n" + .'* RUNNING: The node is running.'."\n" + .'* CHECKING: Data quality is being checked for the node.'."\n" + .'* CHECKING_CONDITION: Branch conditions are being checked for the node.'."\n" + .'* FAILURE: The node fails to run.'."\n" + .'* SUCCESS: The node is successfully run.'."\n", 'type' => 'string', 'example' => 'NOT_RUN', 'title' => ''], + 'CycTime' => ['description' => 'The scheduling time of the instance.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1590422400000', 'title' => ''], + 'BeginRunningTime' => ['description' => 'The time when the instance started to run.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1590416703313', 'title' => ''], + 'FinishTime' => ['description' => 'The time when the running of the instance was complete.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1590416703313', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the instance was generated.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1590416703313', 'title' => ''], + 'DagId' => ['description' => 'The workflow ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '338450167', 'title' => ''], + 'Priority' => ['description' => 'The priority of the instance. Valid values: 1, 3, 5, 7, and 8. A greater value indicates a higher priority. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'TaskType' => ['description' => 'The scheduling type of the node that generates the instance. Valid values:'."\n" + ."\n" + .'* NORMAL(0): The node is an auto triggered node. The scheduling system regularly runs the node.'."\n" + .'* MANUAL(1): The node is a manually triggered node. The scheduling system does not regularly run the node.'."\n" + .'* PAUSE(2): The node is a frozen node. The scheduling system regularly runs the node but sets the status of the node to failed when the scheduling system starts to run the node.'."\n" + .'* SKIP(3): The node is a dry-run node. The scheduling system regularly runs the node but sets the status of the node to successful when the scheduling system starts to run the node.'."\n" + .'* SKIP_UNCHOOSE(4): The node is an unselected node in a temporary workflow. This type of node exists only in temporary workflows. The scheduling system sets the status of the node to successful when the scheduling system starts to run the node.'."\n" + .'* SKIP_CYCLE(5): The node is a node that is scheduled by the week or month and is waiting for the scheduling time to arrive. The scheduling system regularly runs the node but sets the status of the node to successful when the scheduling system starts to run the node.'."\n" + .'* CONDITION_UNCHOOSE(6): The node is not selected by its ancestor branch node and is run as a dry-run node.'."\n" + .'* REALTIME_DEPRECATED(7): The node has instances that are generated in real time but deprecated. The scheduling system sets the status of the node to successful.'."\n", 'type' => 'string', 'example' => 'NORMAL(0)', 'title' => ''], + 'ParamValues' => ['description' => 'The parameters related to the node.'."\n", 'type' => 'string', 'example' => 'bizdate=$bizdate tbods=$tbods tbdw=$tbdw tbpmic=$tbpmic tbpidx=$tbpidx tbptcif=$tbptcif', 'title' => ''], + 'Connection' => ['description' => 'The connection string.'."\n", 'type' => 'string', 'example' => 'odps_first', 'title' => ''], + 'BaselineId' => ['description' => 'The baseline ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123123', 'title' => ''], + 'DqcType' => ['description' => 'Indicates whether the instance is associated with a monitoring rule in Data Quality. Valid values:'."\n" + ."\n" + .'* 0: The instance is associated with a monitoring rule in Data Quality.'."\n" + .'* 1: The instance is not associated with a monitoring rule in Data Quality.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'DagType' => ['description' => 'The type of the workflow. Valid values:'."\n" + ."\n" + .'* DAILY: The workflow is used to run auto triggered nodes.'."\n" + .'* MANUAL: The workflow is used to run manually triggered nodes.'."\n" + .'* SMOKE_TEST: The workflow is used to perform smoke testing.'."\n" + .'* SUPPLY_DATA: The workflow is used to backfill data.'."\n", 'type' => 'string', 'example' => 'DAILY', 'title' => ''], + 'BusinessId' => ['description' => 'The workflow ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'TaskRerunTime' => ['description' => 'The number of times the node can be rerun. The value of this parameter can be empty or an integer that is greater than or equal to 0.'."\n" + ."\n" + .'* If the value of this parameter is empty, the number of times that the node can be rerun is not specified.'."\n" + .'* If the value of this parameter is 0, the node cannot be rerun.'."\n" + .'* If the value of this parameter is a positive integer such as n, the node can still be rerun n times. For example, if the value of this parameter is 1, the node can still be rerun once. If the value of this parameter is 2, the node can still be rerun twice.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'PeriodNumber' => ['description' => 'The sequence number of the cycle. This parameter indicates the sequence number of the cycle of the instance on the current day.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ModifyTime' => ['description' => 'The time when the instance was last modified.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1590416703313', 'title' => ''], + 'Repeatability' => ['description' => 'Indicates whether the node that generates the instance can be rerun.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RepeatInterval' => ['description' => 'The interval at which the node is rerun after the node fails to run. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '60000', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '11713307578', 'title' => ''], + 'BeginWaitResTime' => ['description' => 'The time when the instance started to wait for resources.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1590416703313', 'title' => ''], + 'RelatedFlowId' => ['description' => 'The ID of the workflow to which the node belongs.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123123', 'title' => ''], + 'Bizdate' => ['description' => 'The data timestamp of the instance. In most cases, the value is one day before the time when the instance was run.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1590336000000', 'title' => ''], + 'NodeName' => ['description' => 'The name of the node.'."\n", 'type' => 'string', 'example' => 'kzh', 'title' => ''], + 'BeginWaitTimeTime' => ['description' => 'The time when the instance started to wait to be scheduled.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1590416703313', 'title' => ''], + 'DqcDescription' => ['description' => 'The table and partition filter expression in Data Quality that are associated with the node.'."\n", 'type' => 'string', 'example' => '[{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\\u003d$[yyyy-mm-dd-1]"}]', 'title' => ''], + 'NodeId' => ['description' => 'The node ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '33115', 'title' => ''], + 'CreateUser' => ['description' => 'The creator of the instance.'."\n", 'type' => 'string', 'example' => '111', 'title' => ''], + 'Owner' => ['description' => 'The owner of the instance.'."\n", 'type' => 'string', 'example' => '111', 'title' => ''], + ], + 'title' => '', + ], + ], + 'title' => '', ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"ErrorMessage\\": \\"test\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"0\\",\\n \\"Data\\": {\\n \\"Status\\": \\"NOT_RUN\\",\\n \\"CycTime\\": 1590422400000,\\n \\"BeginRunningTime\\": 1590416703313,\\n \\"FinishTime\\": 1590416703313,\\n \\"CreateTime\\": 1590416703313,\\n \\"DagId\\": 338450167,\\n \\"Priority\\": 1,\\n \\"TaskType\\": \\"NORMAL(0)\\",\\n \\"ParamValues\\": \\"bizdate=$bizdate tbods=$tbods tbdw=$tbdw tbpmic=$tbpmic tbpidx=$tbpidx tbptcif=$tbptcif\\",\\n \\"Connection\\": \\"odps_first\\",\\n \\"BaselineId\\": 123123,\\n \\"DqcType\\": 1,\\n \\"DagType\\": \\"DAILY\\",\\n \\"BusinessId\\": 123,\\n \\"TaskRerunTime\\": 0,\\n \\"PeriodNumber\\": 1,\\n \\"ModifyTime\\": 1590416703313,\\n \\"Repeatability\\": true,\\n \\"RepeatInterval\\": 60000,\\n \\"InstanceId\\": 11713307578,\\n \\"BeginWaitResTime\\": 1590416703313,\\n \\"RelatedFlowId\\": 123123,\\n \\"Bizdate\\": 1590336000000,\\n \\"NodeName\\": \\"kzh\\",\\n \\"BeginWaitTimeTime\\": 1590416703313,\\n \\"DqcDescription\\": \\"[{\\\\\\"projectName\\\\\\":\\\\\\"ztjy_dim\\\\\\",\\\\\\"tableName\\\\\\":\\\\\\"dim_user_agent_manage_area_a\\\\\\",\\\\\\"partition\\\\\\":\\\\\\"ds\\\\\\\\u003d$[yyyy-mm-dd-1]\\\\\\"}]\\",\\n \\"NodeId\\": 33115,\\n \\"CreateUser\\": \\"111\\",\\n \\"Owner\\": \\"111\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n E6F0DBDD-5AD****\\n test\\n true\\n 0\\n \\n NOT_RUN\\n 1590422400000\\n 1590416703313\\n 1590416703313\\n 1590416703313\\n 338450167\\n 1\\n NORMAL(0)\\n bizdate=$bizdate tbods=$tbods tbdw=$tbdw tbpmic=$tbpmic tbpidx=$tbpidx tbptcif=$tbptcif\\n odps_first\\n 123123\\n 1\\n DAILY\\n 123\\n 0\\n 1590416703313\\n true\\n 60000\\n 11713307578\\n 1590416703313\\n 123123\\n 1590336000000\\n kzh\\n 1590416703313\\n [{\\"projectName\\":\\"ztjy_dim\\",\\"tableName\\":\\"dim_user_agent_manage_area_a\\",\\"partition\\":\\"ds\\\\u003d$[yyyy-mm-dd-1]\\"}]\\n 33115\\n 111\\n \\n","errorExample":""}]', + 'title' => 'GetInstance', + 'summary' => 'Queries the information about an instance.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'SourceDataSourceType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The source type. Set this parameter to MySQL.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'MySQL', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'GetInstanceConsumeTimeRank' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'DestinationDataSourceType', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'ProjectId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The destination type. Valid values: Hologres and Hive.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Hologres', - ], + 'schema' => ['description' => 'The ID of the DataWorks workspace.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '99999999999', 'minimum' => '2', 'example' => '100000', 'title' => ''], ], [ - 'name' => 'SourceDataSourceSettings', + 'name' => 'Bizdate', 'in' => 'formData', - 'style' => 'json', + 'schema' => ['description' => 'The data timestamp, accurate to the day. The value must be in the yyyy-MM-dd\'T\'HH:mm:ssZ format in UTC.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-09-21T00:00:00+0800', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The settings of the source. Only a single source is supported.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'DataSourceName' => [ - 'description' => 'The name of the data source.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mysql_datasource_1', - ], - 'DataSourceProperties' => [ - 'description' => 'The properties of the data source.'."\n", - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'TimeZone', - 'description' => 'The properties of the source. The properties of a MySQL data source include TimeZone and Encoding.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The unique ID generated for each request.', 'type' => 'string', 'example' => '6347364dadsfadf****', 'title' => ''], + 'InstanceConsumeTimeRank' => [ + 'description' => 'The ranking records of instance running durations.', + 'type' => 'object', + 'properties' => [ + 'UpdateTime' => ['description' => 'The timestamp when the ranking was updated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1600963200000', 'title' => ''], + 'ConsumeTimeRank' => [ + 'description' => 'The ranking data of instance running durations.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Owner' => ['description' => 'The Alibaba Cloud UID of the node owner.', 'type' => 'string', 'example' => '952795279527', 'title' => ''], + 'NodeName' => ['description' => 'The name of the node.', 'type' => 'string', 'example' => 'Node name', 'title' => ''], + 'Bizdate' => ['description' => 'The data timestamp on which the instance was run.', 'type' => 'integer', 'format' => 'int64', 'example' => '1600963200000', 'title' => ''], + 'InstanceId' => ['description' => 'The ID of the instance.', 'type' => 'integer', 'format' => 'int64', 'example' => '95279527', 'title' => ''], + 'PrgType' => ['description' => 'The type of the task.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'NodeId' => ['description' => 'The ID of the task node.', 'type' => 'integer', 'format' => 'int64', 'example' => '9527', 'title' => ''], + 'Consumed' => ['description' => 'The running duration of the instance. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], - 'required' => false, ], - 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'DestinationDataSourceSettings', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The settings of the destination. Only a single destination is supported.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'DataSourceName' => [ - 'description' => 'The name of the data source.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'holo_datasource_1', - ], - 'DataSourceProperties' => [ - 'description' => 'The properties of the data source.'."\n", + ], + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'ResourceNotAuthorized.Api', 'errorMessage' => 'You are not authorized to access the resources.', 'description' => ''], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Resource', 'errorMessage' => 'You have reached the limit for the resource. Please contact us by submitting a ticket.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'Forbidden.Not.Server', 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.', 'description' => ''], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'Forbidden.Wkbench.ProjectNoPermission', 'errorMessage' => 'You are not authorized to access the workspace.', 'description' => ''], + ['errorCode' => 'Invalid.Wkbench.Parameter', 'errorMessage' => 'The specified parameters are invalid.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6347364dadsfadf****\\",\\n \\"InstanceConsumeTimeRank\\": {\\n \\"UpdateTime\\": 1600963200000,\\n \\"ConsumeTimeRank\\": [\\n {\\n \\"Owner\\": \\"952795279527\\",\\n \\"NodeName\\": \\"Node name\\",\\n \\"Bizdate\\": 1600963200000,\\n \\"InstanceId\\": 95279527,\\n \\"PrgType\\": 10,\\n \\"NodeId\\": 9527,\\n \\"Consumed\\": 1000\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Queries the ranking of instances by running duration', + 'summary' => 'Queries the ranking of instances by running duration.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'GetInstanceCountTrend' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The DataWorks workspace ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '99999999999', 'minimum' => '2', 'example' => '10000'], + ], + [ + 'name' => 'BeginDate', + 'in' => 'formData', + 'schema' => ['description' => 'The beginning of the time range to query, accurate to the day. Specify the time in the ISO 8601 standard in the yyyy-MM-dd\'T\'HH:mm:ssZ format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-04-02T00:00:00+0800'], + ], + [ + 'name' => 'EndDate', + 'in' => 'formData', + 'schema' => ['description' => 'The end of the time range to query, accurate to the day. Specify the time in the ISO 8601 standard in the yyyy-MM-dd\'T\'HH:mm:ssZ format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-09-10T00:00:00+0800'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '95279527adhfj****'], + 'InstanceCounts' => [ + 'description' => 'The quantity trend of instances.'."\n", + 'type' => 'array', + 'items' => [ 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'TimeZone', - 'description' => 'The properties of the destination. No properties can be configured for a Hologres data source.'."\n", + 'properties' => [ + 'Date' => ['description' => 'The data timestamp.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1600963200000'], + 'Count' => ['description' => 'The number of instances.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '9527'], ], ], ], - 'required' => false, ], - 'required' => false, + 'description' => '', ], ], + ], + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'ResourceNotAuthorized.Api', 'errorMessage' => 'You are not authorized to access the resources.', 'description' => ''], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Resource', 'errorMessage' => 'You have reached the limit for the resource. Please contact us by submitting a ticket.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'Forbidden.Not.Server', 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.', 'description' => ''], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'Forbidden.Wkbench.NoProject', 'errorMessage' => 'You have not joined any project.', 'description' => ''], + ['errorCode' => 'Invalid.Wkbench.Parameter', 'errorMessage' => 'The specified parameters are invalid.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"95279527adhfj****\\",\\n \\"InstanceCounts\\": [\\n {\\n \\"Date\\": 1600963200000,\\n \\"Count\\": 9527\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"95279527adhfj****\\n\\n 9527\\n 1600963200000\\n","errorExample":""}]', + 'title' => 'GetInstanceCountTrend', + 'summary' => 'Queries the quantity trend of auto triggered instances.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'GetInstanceErrorRank' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ResourceSettings', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'ProjectId', 'in' => 'formData', - 'style' => 'json', + 'schema' => ['description' => 'The ID of the DataWorks workspace.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '99999999999', 'minimum' => '2', 'example' => '9527', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The resource settings.'."\n", 'type' => 'object', 'properties' => [ - 'OfflineResourceSettings' => [ - 'description' => 'The resource used for batch synchronization.'."\n", - 'type' => 'object', - 'properties' => [ - 'ResourceGroupIdentifier' => [ - 'description' => 'The identifier of the resource group for Data Integration used for batch synchronization.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'S_res_group_111_222', - ], - ], - 'required' => false, - ], - 'RealtimeResourceSettings' => [ - 'description' => 'The resource used for real-time synchronization.'."\n", + 'RequestId' => ['description' => 'The unique ID generated for each request.', 'type' => 'string', 'example' => '952795279527****', 'title' => ''], + 'InstanceErrorRank' => [ + 'description' => 'The error ranking data of nodes.', 'type' => 'object', 'properties' => [ - 'ResourceGroupIdentifier' => [ - 'description' => 'The identifier of the resource group for Data Integration used for real-time synchronization.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'S_res_group_111_222', + 'UpdateTime' => ['description' => 'The timestamp when the error ranking was updated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1600963200000', 'title' => ''], + 'ErrorRank' => [ + 'description' => 'The error ranking data of nodes in the last month.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Owner' => ['description' => 'The Alibaba Cloud UID of the node owner.', 'type' => 'string', 'example' => '952795279527', 'title' => ''], + 'NodeName' => ['description' => 'The name of the node.', 'type' => 'string', 'example' => 'Node name', 'title' => ''], + 'ProjectId' => ['description' => 'The ID of the DataWorks workspace.', 'type' => 'integer', 'format' => 'int64', 'example' => '9527', 'title' => ''], + 'NodeId' => ['description' => 'The ID of the node.', 'type' => 'integer', 'format' => 'int64', 'example' => '9527', 'title' => ''], + 'Count' => ['description' => 'The number of errors of the node.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'PrgType' => ['description' => 'The type of the node task.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], - 'required' => false, - ], - 'RequestedCu' => [ - 'description' => 'The number of compute units (CUs) in the resource group that are used for incremental and full synchronization.'."\n", - 'type' => 'number', - 'format' => 'float', - 'required' => false, - 'example' => '2.0', + 'title' => '', + 'example' => '', ], ], - 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'ResourceNotAuthorized.Api', 'errorMessage' => 'You are not authorized to access the resources.', 'description' => ''], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Resource', 'errorMessage' => 'You have reached the limit for the resource. Please contact us by submitting a ticket.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'Forbidden.Not.Server', 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.', 'description' => ''], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'Forbidden.Wkbench.ProjectNoPermission', 'errorMessage' => 'You are not authorized to access the workspace.', 'description' => ''], + ['errorCode' => 'Invalid.Wkbench.Parameter', 'errorMessage' => 'The specified parameters are invalid.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"952795279527****\\",\\n \\"InstanceErrorRank\\": {\\n \\"UpdateTime\\": 1600963200000,\\n \\"ErrorRank\\": [\\n {\\n \\"Owner\\": \\"952795279527\\",\\n \\"NodeName\\": \\"Node name\\",\\n \\"ProjectId\\": 9527,\\n \\"NodeId\\": 9527,\\n \\"Count\\": 5,\\n \\"PrgType\\": 10\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Obtains the error ranking of nodes in the last month', + 'summary' => 'Calls GetInstanceErrorRank to obtain the error ranking of nodes in the last month.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'GetInstanceLog' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '78253', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB'], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1234'], + ], + [ + 'name' => 'ProjectEnv', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The environment of the workspace. Valid values: PROD and DEV.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'PROD', + 'enum' => ['PROD', 'DEV'], ], ], [ - 'name' => 'TransformationRules', + 'name' => 'InstanceHistoryId', 'in' => 'formData', - 'style' => 'json', + 'schema' => ['description' => 'The historical record number of the instance. You can call the ListInstanceHistory operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The list of transformation rules that you want to apply to the synchronization objects selected from the source. Each entry in the list defines a transformation rule.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The transformation rule that you want to apply to the synchronization objects selected from the source.'."\n", - 'type' => 'object', - 'properties' => [ - 'RuleName' => [ - 'description' => 'The name of the rule. If the values of the RuleActionType parameter and the RuleTargetType parameter are the same for multiple transformation rules, you must make sure that the transformation rule names are unique.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rename_rule_1', - ], - 'RuleActionType' => [ - 'description' => 'The action type. Valid values:'."\n" - ."\n" - .'* DefinePrimaryKey'."\n" - .'* Rename'."\n" - .'* AddColumn'."\n" - .'* HandleDml'."\n" - .'* DefineIncrementalCondition'."\n" - .'* DefineCycleScheduleSettings'."\n" - .'* DefineRuntimeSettings'."\n" - .'* DefinePartitionKey'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Rename', - ], - 'RuleTargetType' => [ - 'description' => 'The type of the object on which you want to perform the action. Valid values:'."\n" - ."\n" - .'* Table'."\n" - .'* Schema'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Table', - ], - 'RuleExpression' => [ - 'description' => 'The expression of the rule. An expression must be a JSON string.'."\n" - ."\n" - .'Example of a renaming rule: {"expression":"${srcDatasourceName}\\_${srcDatabaseName}\\_0922","variables":\\[{"variableName":"srcDatabaseName","variableRules":\\[{"from":"fromdb","to":"todb"}]}]}'."\n" - ."\n" - .'* expression: the expression of the renaming rule. You can use the following variables in an expression: ${srcDatasourceName}, ${srcDatabaseName}, and ${srcTableName}. ${srcDatasourceName} indicates the name of the source. ${srcDatabaseName} indicates the name of a source database. ${srcTableName} indicates the name of a source table.'."\n" - .'* variables: the generation rule for a variable used in the expression of the renaming rule. The default value of the specified variable is the original value of the object indicated by the variable. You can define a group of string replacement rules to change the original values based on your business requirements. variableName: the name of the variable. Do not enclose the variable name in ${}. variableRules: the string replacement rules for variables. The system runs the string replacement rules in sequence for string replacement. from specifies the original string. to specifies the new string.'."\n" - ."\n" - .'Example of a rule used to add a specific field to the destination and assign a value to the field: {"columns":\\[{"columnName":"my_add_column","columnValueType":"Constant","columnValue":"123"}]}'."\n" - ."\n" - .'* If you do not configure such a rule, no fields are added to the destination and no values are assigned by default.'."\n" - .'* columnName: the name of the field that is added.'."\n" - .'* columnValueType: the type of the value of the field. Valid values: Constant and Variable.'."\n" - .'* columnValue: the value of the field that you want to add. If you set the valueType parameter to Constant, set the columnValue parameter to a custom constant of the STRING type. If you set the valueType parameter to Variable, set the columnValue to a built-in variable. The following built-in variables are supported: EXECUTE_TIME (LONG data type), DB_NAME_SRC (STRING data type), DATASOURCE_NAME_SRC (STRING data type), TABLE_NAME_SRC (STRING data type), DB_NAME_DEST (STRING data type), DATASOURCE_NAME_DEST (STRING data type), TABLE_NAME_DEST (STRING data type), and DB_NAME_SRC_TRANSED (STRING data type). EXECUTE_TIME specifies the execution time. DB_NAME_SRC specifies the name of a source database. DATASOURCE_NAME_SRC specifies the name of the source. TABLE_NAME_SRC specifies the name of a source table. DB_NAME_DEST specifies the name of a destination database. DATASOURCE_NAME_DEST specifies the name of the destination. TABLE_NAME_DEST specifies the name of a destination table. DB_NAME_SRC_TRANSED specifies the database name obtained after a transformation.'."\n" - ."\n" - .'Example of a rule used to specify primary key fields for a destination table: {"columns":\\["ukcolumn1","ukcolumn2"]}'."\n" - ."\n" - .'* If you do not configure such a rule, the primary key fields in the mapped source table are used for the destination table by default.'."\n" - .'* If the destination table is an existing table, Data Integration does not modify the schema of the destination table. If the specified primary key fields do not exist in the destination table, an error is reported when the synchronization task starts to run.'."\n" - .'* If the destination table is automatically created by the system, Data Integration automatically creates the schema of the destination table. The schema contains the primary key fields that you specify. If the specified primary key fields do not exist in the destination table, an error is reported when the synchronization task starts to run.'."\n" - ."\n" - .'Example of a rule used to process DML messages: {"dmlPolicies":\\[{"dmlType":"Delete","dmlAction":"Filter","filterCondition":"id > 1"}]}'."\n" - ."\n" - .'* If you do not configure such a rule, the default processing policy for messages generated for insert, update, and delete operations is Normal.'."\n" - .'* dmlType: the DML operation. Valid values: Insert, Update, and Delete.'."\n" - .'* dmlAction: the processing policy for DML messages. Valid values: Normal, Ignore, Filter, and LogicalDelete. Filter indicates conditional processing. You can set the dmlAction parameter to Filter only when the dmlType parameter is set to Update or Delete.'."\n" - .'* filterCondition: the condition used to filter DML messages. This parameter is required only when the dmlAction parameter is set to Filter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"expression":"${srcDatasoureName}_${srcDatabaseName}"}', - ], - ], - 'required' => false, + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Data' => ['description' => 'The content of the logs.'."\n", 'type' => 'string', 'example' => 'log_content'], + 'ErrorMessage' => ['description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'The connection does not exist.'], + 'RequestId' => ['description' => 'The ID of the request. You can locate logs and troubleshoot issues based on the ID.'."\n", 'type' => 'string', 'example' => 'E6F0DBDD-5AD****'], + 'ErrorCode' => ['description' => 'The error code returned.'."\n", 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists'], + 'Success' => ['description' => 'Indicates whether the request is successful.'."\n", 'type' => 'boolean', 'example' => 'true'], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"log_content\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n log_content\\n The connection does not exist.\\n E6F0DBDD-5AD****\\n Invalid.Tenant.ConnectionNotExists\\n true\\n","errorExample":""}]', + 'title' => 'GetInstanceLog', + 'summary' => 'Queries the logs of an instance. ', + 'description' => 'You may not obtain the instance logs that were generated more than seven days ago.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'required' => false, ], ], + ], + ], + 'GetInstanceStatusCount' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'TableMappings', + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The workspace ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '1234', 'isFileTransferUrl' => false], + ], + [ + 'name' => 'ProjectEnv', 'in' => 'formData', - 'style' => 'json', 'schema' => [ - 'description' => 'The list of mappings between rules used to select synchronization objects in the source and transformation rules applied to the selected synchronization objects. Each entry in the list displays a mapping between a rule used to select synchronization objects and a transformation rule applied to the selected synchronization objects.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The mapping between a rule used to select synchronization objects in the source and a transformation rule applied to the selected synchronization objects.'."\n", - 'type' => 'object', - 'properties' => [ - 'SourceObjectSelectionRules' => [ - 'description' => 'The rules used to select synchronization objects in the source.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The rule used to select synchronization objects in the source. The objects can be databases or tables.'."\n", - 'type' => 'object', - 'properties' => [ - 'ObjectType' => [ - 'description' => 'The object type. Valid values:'."\n" - ."\n" - .'* Table'."\n" - .'* Database'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Table', - ], - 'Expression' => [ - 'description' => 'The expression.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mysql_table_1', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'TransformationRules' => [ - 'description' => 'The list of transformation rules that you want to apply to the synchronization objects selected from the source.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The transformation rule that you want to apply to the synchronization objects selected from the source.'."\n", - 'type' => 'object', - 'properties' => [ - 'RuleName' => [ - 'description' => 'The name of the rule. If the values of the RuleActionType parameter and the RuleTargetType parameter are the same for multiple transformation rules, you must make sure that the transformation rule names are unique.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rename_rule_1', - ], - 'RuleActionType' => [ - 'description' => 'The action type. Valid values:'."\n" - ."\n" - .'* DefinePrimaryKey'."\n" - .'* Rename'."\n" - .'* AddColumn'."\n" - .'* HandleDml'."\n" - .'* DefineIncrementalCondition'."\n" - .'* DefineCycleScheduleSettings'."\n" - .'* DefineRuntimeSettings'."\n" - .'* DefinePartitionKey'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Rename', - ], - 'RuleTargetType' => [ - 'description' => 'The type of the object on which you want to perform the action. Valid values:'."\n" - ."\n" - .'* Table'."\n" - .'* Schema'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Table', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, + 'description' => 'The runtime environment. Valid values: PROD and DEV.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'PROD', + 'isFileTransferUrl' => false, + 'enum' => ['PROD', 'DEV'], ], ], [ - 'name' => 'JobSettings', + 'name' => 'BizDate', 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The settings for the dimension of the synchronization task. The settings include processing policies for DDL messages, policies for data type mappings between source fields and destination fields, and runtime parameters of the synchronization task.'."\n", - 'type' => 'object', - 'properties' => [ - 'DdlHandlingSettings' => [ - 'description' => 'The processing settings for DDL messages.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The processing setting for a specific type of DDL message.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the DDL operation. Valid values:'."\n" - ."\n" - .'* RenameColumn'."\n" - .'* ModifyColumn'."\n" - .'* CreateTable'."\n" - .'* TruncateTable'."\n" - .'* DropTable'."\n" - .'* DropColumn'."\n" - .'* AddColumn'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'AddColumn', - ], - 'Action' => [ - 'description' => 'The processing policy. Valid values:'."\n" - ."\n" - .'* Ignore: ignores a DDL message.'."\n" - .'* Critical: reports an error for a DDL message.'."\n" - .'* Normal: normally processes a DDL message.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Critical', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'ColumnDataTypeSettings' => [ - 'description' => 'The settings for data type mappings between source fields and destination fields. The value of this parameter must be an array.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data type mapping between a source field and a destination field.'."\n", - 'type' => 'object', - 'properties' => [ - 'SourceDataType' => [ - 'description' => 'The data type of the source field.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'bigint', - ], - 'DestinationDataType' => [ - 'description' => 'The data type of the destination field.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'text', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'RuntimeSettings' => [ - 'description' => 'The runtime settings. The value of this parameter must be an array.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The runtime setting.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the configuration item. Valid values:'."\n" - ."\n" - .'* runtime.offline.speed.limit.mb: specifies the maximum transmission rate that is allowed for a batch synchronization task. This configuration item takes effect only when runtime.offline.speed.limit.enable is set to true.'."\n" - .'* runtime.offline.speed.limit.enable: specifies whether throttling is enabled for a batch synchronization task.'."\n" - .'* dst.offline.connection.max: specifies the maximum number of connections that are allowed for writing data to the destination of a batch synchronization task.'."\n" - .'* runtime.offline.concurrent: specifies the maximum number of parallel threads that are allowed for a batch synchronization task.'."\n" - .'* dst.realtime.connection.max: specifies the maximum number of connections that are allowed for writing data to the destination of a real-time synchronization task.'."\n" - .'* runtime.enable.auto.create.schema: specifies whether schemas are automatically created in the destination of a synchronization task.'."\n" - .'* src.offline.datasource.max.connection: specifies the maximum number of connections that are allowed for reading data from the source of a batch synchronization task.'."\n" - .'* runtime.realtime.concurrent: specifies the maximum number of parallel threads that are allowed for a real-time synchronization task.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'runtime.offline.concurrent', - ], - 'Value' => [ - 'description' => 'The value of the configuration item.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'CycleScheduleSettings' => [ - 'description' => 'The settings for periodic scheduling.'."\n", - 'type' => 'object', - 'properties' => [ - 'CycleMigrationType' => [ - 'description' => 'The synchronization type that requires periodic scheduling. Valid values:'."\n" - ."\n" - .'* Full: full synchronization'."\n" - .'* OfflineIncremental: batch incremental synchronization'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Full', - ], - 'ScheduleParameters' => [ - 'description' => 'The scheduling parameters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'bizdate=$bizdate'."\n", - ], - ], - 'required' => false, - ], - 'ChannelSettings' => [ - 'description' => 'The channel control settings for the synchronization task. The value of this parameter must be a JSON string.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"structInfo":"MANAGED","storageType":"TEXTFILE","writeMode":"APPEND","partitionColumns":[{"columnName":"pt","columnType":"STRING","comment":""}],"fieldDelimiter":""}'."\n", - ], - 'ImportRuleSettings' => [ - 'description' => 'The import settings for the synchronization task.'."\n", - 'type' => 'object', - 'properties' => [ - 'Source' => [ - 'description' => 'The import source of the task. Set the value to Datastudio, which indicates synchronization tasks created in DataStudio.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Datastudio', - ], - 'FileId' => [ - 'description' => 'The ID of the task to be imported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '10000', - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], - ], - [ - 'name' => 'SystemDebug', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to perform system debugging. Valid values: true and false. Default value: false.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The data timestamp of instances.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-01-01', 'isFileTransferUrl' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID. You can use the request ID to query logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '4F6AB6B3-41FB-5EBB-AFB2-0C98D49DA2BB', - ], - 'DIJobId' => [ - 'description' => 'The synchronization task ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '11792', + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0000-ABCD-EFG****'], + 'StatusCount' => [ + 'description' => 'The statistics of instances.'."\n", + 'type' => 'object', + 'properties' => [ + 'FailureCount' => ['description' => 'The number of instances that failed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'WaitTimeCount' => ['description' => 'The number of instances that are waiting for their scheduling time to arrive.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'RunningCount' => ['description' => 'The number of instances that are running.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'SuccessCount' => ['description' => 'The number of instances that are successfully run.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'TotalCount' => ['description' => 'The total number of instances returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'NotRunCount' => ['description' => 'The number of instances that are not run.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'WaitResCount' => ['description' => 'The number of instances that are waiting for resources.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + ], ], ], + 'description' => '', ], ], ], - 'errorCodes' => [ - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4F6AB6B3-41FB-5EBB-AFB2-0C98D49DA2BB\\",\\n \\"DIJobId\\": 11792\\n}","errorExample":""},{"type":"xml","example":"\\n 4F6AB6B3-41FB-5EBB-AFB2-0C98D49DA2BB\\n 11792\\n","errorExample":""}]', - 'title' => 'CreateDIJob', - ], - 'DeleteDIJob' => [ - 'summary' => 'Deletes a Data Integration task of a new version. Only the following type of task is supported: real-time data synchronization from a MySQL database to Hologres.', - 'methods' => [ - 'post', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"StatusCount\\": {\\n \\"FailureCount\\": 1,\\n \\"WaitTimeCount\\": 1,\\n \\"RunningCount\\": 1,\\n \\"SuccessCount\\": 1,\\n \\"TotalCount\\": 1,\\n \\"NotRunCount\\": 1,\\n \\"WaitResCount\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n 1\\n 1\\n 1\\n 1\\n 1\\n 1\\n\\n0000-ABCD-EFG****","errorExample":""}]', + 'title' => 'GetInstanceStatusCount', + 'summary' => 'Queries the statistics of instances in different states.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-01-13T07:25:27.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'GetInstanceStatusStatistic' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '155161', - 'abilityTreeNodes' => [ - 'FEATUREdideQHGTK4', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '78255', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB'], ], 'parameters' => [ [ - 'name' => 'DIJobId', + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '1', 'isFileTransferUrl' => false, 'example' => '1234', 'title' => ''], + ], + [ + 'name' => 'ProjectEnv', 'in' => 'formData', 'schema' => [ - 'description' => 'The task ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The runtime environment. Valid values: PROD and DEV.'."\n", + 'enumValueTitles' => [], + 'type' => 'string', 'required' => true, - 'example' => '11126', + 'docRequired' => true, + 'isFileTransferUrl' => false, + 'enum' => ['PROD', 'DEV'], + 'example' => 'PROD', + 'title' => '', + ], + ], + [ + 'name' => 'BizDate', + 'in' => 'formData', + 'schema' => ['description' => 'The date on which the numbers of instances in different states are obtained. Specify the date in the yyyy-MM-dd format.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'maxLength' => 10, 'minLength' => 10, 'isFileTransferUrl' => false, 'example' => '2020-01-01', 'title' => ''], + ], + [ + 'name' => 'SchedulerType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The scheduling type of the node. Valid values:'."\n" + ."\n" + .'* NORMAL: auto triggered node'."\n" + .'* MANUAL: manually triggered node'."\n" + .'* PAUSE: paused node'."\n" + .'* SKIP: dry-run node'."\n", + 'enumValueTitles' => [], + 'type' => 'string', + 'enum' => ['NORMAL', 'MANUAL', 'PAUSE', 'SKIP'], + 'required' => false, + 'example' => 'NORMAL', + 'title' => '', + ], + ], + [ + 'name' => 'DagType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The type of the directed acyclic graph (DAG). Valid values:'."\n" + ."\n" + .'* MANUAL: DAG for a manually triggered workflow'."\n" + .'* SMOKE_TEST: DAG for a smoke testing workflow'."\n" + .'* SUPPLY_DATA: DAG for a data backfill instance'."\n" + .'* BUSINESS_PROCESS_DAG: DAG for a one-time workflow'."\n" + ."\n" + .''."\n" + ."\n" + .'* DAILY'."\n" + .'* MANUAL'."\n" + .'* SMOKE_TEST'."\n" + .'* SUPPLY_DATA'."\n" + .'* BUSINESS_PROCESS_DAG'."\n", + 'enumValueTitles' => [], + 'type' => 'string', + 'enum' => ['DAILY', 'MANUAL', 'SMOKE_TEST', 'SUPPLY_DATA', 'BUSINESS_PROCESS_DAG'], + 'required' => false, + 'example' => 'MANUAL', + 'title' => '', + ], + ], + [ + 'name' => 'SchedulerPeriod', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The scheduling cycle. Valid values:'."\n" + ."\n" + .'* MINUTE'."\n" + .'* HOUR'."\n" + .'* DAY'."\n" + .'* WEEK'."\n" + .'* MONTH'."\n", + 'enumValueTitles' => [], + 'type' => 'string', + 'enum' => ['MINUTE', 'HOUR', 'DAY', 'WEEK', 'MONTH'], + 'required' => false, + 'example' => 'DAY', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D33D4A51-5845-579A-B4BA-FAADD0F83D53', + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0000-ABCD-EFG****', 'title' => ''], + 'StatusCount' => [ + 'description' => 'The numbers of instances in different states.'."\n", + 'type' => 'object', + 'properties' => [ + 'FailureCount' => ['description' => 'The number of instances that failed to run.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'WaitTimeCount' => ['description' => 'The number of instances that are waiting to run.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RunningCount' => ['description' => 'The number of instances that are running.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'SuccessCount' => ['description' => 'The number of instances that are successfully run.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of instances returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'NotRunCount' => ['description' => 'The number of instances that are not run.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'WaitResCount' => ['description' => 'The number of instances that are waiting for resources.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + 'title' => 'GetInstanceStatusStatistic', + 'summary' => 'Queries the number of instances that are in each state.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-12-07T06:42:31.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"StatusCount\\": {\\n \\"FailureCount\\": 1,\\n \\"WaitTimeCount\\": 1,\\n \\"RunningCount\\": 1,\\n \\"SuccessCount\\": 1,\\n \\"TotalCount\\": 1,\\n \\"NotRunCount\\": 1,\\n \\"WaitResCount\\": 1\\n }\\n}","type":"json"}]', + ], + 'GetManualDagInstances' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'ProjectEnv', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The environment of Operation Center. Valid values: PROD and DEV.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'RPOD', + 'enum' => ['PROD', 'DEV'], ], ], - 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], + [ + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the workspace to which the manually triggered workflow belongs. You can log on to the DataWorks console and go to the Workspace Settings panel to query the name.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_workspace'], + ], + [ + 'name' => 'DagId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the directed acyclic graph (DAG) for the manually triggered workflow. You can call the [CreateManualDag](~~189728~~) operation to query the ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '7000001231241'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D33D4A51-5845-579A-B4BA-FAADD0F83D53\\"\\n}","errorExample":""},{"type":"xml","example":"\\n D33D4A51-5845-579A-B4BA-FAADD0F83D53\\n","errorExample":""}]', - 'title' => 'DeleteDIJob', - ], - 'GetDIJob' => [ - 'summary' => 'Queries the information about a new-version synchronization task created in Data Integration. The following types of synchronization tasks are supported: real-time synchronization of all data in a MySQL database to Hologres.', - 'methods' => [ - 'post', + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF'], + 'Instances' => [ + 'description' => 'The instances in the manually triggered workflow.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status of the instance. Valid values:'."\n" + ."\n" + .'* NOT_RUN: The instance is not run.'."\n" + .'* WAIT_TIME: The instance is waiting for its scheduling time to arrive.'."\n" + .'* WAIT_RESOURCE: The instance is waiting for resources.'."\n" + .'* RUNNING: The instance is running.'."\n" + .'* CHECKING: Data quality is being checked for the instance.'."\n" + .'* CHECKING_CONDITION: Branch conditions are being checked for the instance.'."\n" + .'* FAILURE: The instance fails to be run.'."\n" + .'* SUCCESS: The instance is successfully run.'."\n", 'type' => 'string', 'example' => 'WAIT_TIME'], + 'BeginRunningTime' => ['description' => 'The time when the instance started to run.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1605178414676'], + 'BizDate' => ['description' => 'The data timestamp of the instance. In most cases, the value is one day before the time when the instance was run.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1605178414676'], + 'CycTime' => ['description' => 'The time when the instance was scheduled to run.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1605178414676'], + 'FinishTime' => ['description' => 'The time when the instance finished running.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1605178414676'], + 'CreateTime' => ['description' => 'The time when the instance was generated.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1605178414676'], + 'DagId' => ['description' => 'The ID of the DAG for the manually triggered workflow.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '350850491'], + 'InstanceId' => ['description' => 'The ID of the instance in the manually triggered workflow.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '11726873619'], + 'BeginWaitResTime' => ['description' => 'The time when the instance started to wait for resources.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1605178414676'], + 'TaskType' => ['description' => 'The scheduling type of the node that generates the instance. Valid values:'."\n" + ."\n" + .'* NORMAL(0): The node is an auto triggered node. The scheduling system regularly runs the node.'."\n" + .'* MANUAL(1): The node is a manually triggered node. The scheduling system does not regularly run the node.'."\n" + .'* PAUSE(2): The node is a paused node. The scheduling system regularly runs the node but sets the status of the node to failed when the scheduling system starts to run the node.'."\n" + .'* SKIP(3): The node is a dry-run node. The scheduling system regularly runs the node but sets the status of the node to successful when the scheduling system starts to run the node.'."\n" + .'* SKIP_UNCHOOSE(4): The node is an unselected node in a temporary workflow. This type of node exists only in temporary workflows. The scheduling system sets the status of the node to successful when the scheduling system starts to run the node.'."\n" + .'* SKIP_CYCLE(5): The node is a node that is scheduled by week or month and is waiting for the scheduling time to arrive. The scheduling system regularly runs the node but sets the status of the node to successful when the scheduling system starts to run the node.'."\n" + .'* CONDITION_UNCHOOSE(6): The node is not selected by its ancestor branch node and is run as a dry-run node.'."\n" + .'* REALTIME_DEPRECATED(7): The node has instances that are generated in real time but deprecated. The scheduling system sets the status of the node to successful.'."\n", 'type' => 'string', 'example' => 'NORMAL(0)'], + 'ParamValues' => ['description' => 'The parameters related to the instance.'."\n", 'type' => 'string', 'example' => 'xxx'], + 'DagType' => ['description' => 'The type of the manually triggered workflow.'."\n", 'type' => 'string', 'example' => '5'], + 'NodeName' => ['description' => 'The name of the node.'."\n", 'type' => 'string', 'example' => 'test2'], + 'BeginWaitTimeTime' => ['description' => 'The time when the instance started to wait to be scheduled.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1605178414676'], + 'NodeId' => ['description' => 'The ID of the node in the manually triggered workflow.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '37851'], + 'ModifyTime' => ['description' => 'The time when the instance was last modified.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1605178414676'], + 'CreateUser' => ['description' => 'The user who performed the operation.'."\n", 'type' => 'string', 'example' => 'xxx'], + ], + ], + ], + ], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF\\",\\n \\"Instances\\": [\\n {\\n \\"Status\\": \\"WAIT_TIME\\",\\n \\"BeginRunningTime\\": 1605178414676,\\n \\"BizDate\\": 1605178414676,\\n \\"CycTime\\": 1605178414676,\\n \\"FinishTime\\": 1605178414676,\\n \\"CreateTime\\": 1605178414676,\\n \\"DagId\\": 350850491,\\n \\"InstanceId\\": 11726873619,\\n \\"BeginWaitResTime\\": 1605178414676,\\n \\"TaskType\\": \\"NORMAL(0)\\",\\n \\"ParamValues\\": \\"xxx\\",\\n \\"DagType\\": \\"5\\",\\n \\"NodeName\\": \\"test2\\",\\n \\"BeginWaitTimeTime\\": 1605178414676,\\n \\"NodeId\\": 37851,\\n \\"ModifyTime\\": 1605178414676,\\n \\"CreateUser\\": \\"xxx\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF\\n \\n WAIT_TIME\\n 1605178414676\\n 1605178414676\\n 1605178414676\\n 1605178414676\\n 1605178414676\\n 350850491\\n 11726873619\\n 1605178414676\\n NORMAL(0)\\n xxx\\n 5\\n test2\\n 1605178414676\\n 37851\\n 1605178414676\\n xxx\\n \\n","errorExample":""}]', + 'title' => 'GetManualDagInstances', + 'summary' => 'Queries the information about instances in a manually triggered workflow.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'GetMetaCategory' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -23891,13273 +17570,179 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '154572', - 'abilityTreeNodes' => [ - 'FEATUREdideQHGTK4', - ], + 'abilityTreeCode' => '78257', + 'abilityTreeNodes' => ['FEATUREdideE9XYA6'], ], 'parameters' => [ [ - 'name' => 'DIJobId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the synchronization task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '11588', - ], + 'name' => 'ParentCategoryId', + 'in' => 'query', + 'schema' => ['description' => 'The category tree ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '333', 'title' => ''], ], [ - 'name' => 'WithDetails', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether to return detailed configuration information, including TransformationRules, TableMappings, and JobSettings. Valid values: true and false. Default value: true.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => ['description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page. Default value: 10. Maximum value: 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The returned result.'."\n", + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The connection does not exist.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0bc1ec92159376', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], 'Data' => [ - 'description' => 'The information about the synchronization task.'."\n", + 'description' => 'The business data.'."\n", 'type' => 'object', 'properties' => [ - 'ProjectId' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '22', - ], - 'DIJobId' => [ - 'description' => 'The ID of the synchronization task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '11588', - ], - 'JobName' => [ - 'description' => 'The name of the synchronization task.'."\n", - 'type' => 'string', - 'example' => 'mysql_to_holo_sync_445', - ], - 'Description' => [ - 'description' => 'The description of the synchronization task.'."\n", - 'type' => 'string', - 'example' => 'Synchronize mysql to hologres'."\n", - ], - 'MigrationType' => [ - 'description' => 'The synchronization type. Valid values:'."\n" - ."\n" - .'* FullAndRealtimeIncremental: one-time full synchronization and real-time incremental synchronization'."\n" - .'* RealtimeIncremental: real-time incremental synchronization'."\n" - .'* Full: full synchronization'."\n" - .'* OfflineIncremental: batch incremental synchronization'."\n" - .'* FullAndOfflineIncremental: one-time full synchronization and batch incremental synchronization'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'FullAndRealtimeIncremental', - ], - 'SourceDataSourceType' => [ - 'description' => 'The source type. The value MySQL is returned.'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'MySQL', - ], - 'DestinationDataSourceType' => [ - 'description' => 'The destination type. Valid values: Hologres and Hive.'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Hologres', - ], - 'SourceDataSourceSettings' => [ - 'description' => 'The settings of the source. Only a single source is supported.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'DataSourceName' => [ - 'description' => 'The name of the data source.'."\n", - 'type' => 'string', - 'example' => 'mysql_datasource_1', - ], - 'DataSourceProperties' => [ - 'description' => 'The properties of the data source.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => 'The properties of the source. The properties of a MySQL data source include TimeZone and Encoding.'."\n", - 'example' => 'TimeZone', - ], - ], - ], - ], - ], - 'DestinationDataSourceSettings' => [ - 'description' => 'The settings of the destination. Only a single destination is supported.'."\n", + 'PageNum' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of categories returned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'DataEntityList' => [ + 'description' => 'The information about the category tree.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ - 'DataSourceName' => [ - 'description' => 'The name of the data source.'."\n", - 'type' => 'string', - 'example' => 'holo_datasource_1', - ], - 'DataSourceProperties' => [ - 'description' => 'The properties of the data source.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'TimeZone', - 'description' => 'The properties of the destination. No properties are returned because DataWorks does not allow you to configure properties for a Hologres data source.'."\n", - ], - ], - ], - ], - ], - 'ResourceSettings' => [ - 'description' => 'The resource settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'OfflineResourceSettings' => [ - 'description' => 'The resource used for batch synchronization.'."\n", - 'type' => 'object', - 'properties' => [ - 'ResourceGroupIdentifier' => [ - 'description' => 'The identifier of the resource group for Data Integration used for batch synchronization.'."\n", - 'type' => 'string', - 'example' => 'S_res_group_111_222', - ], - ], - ], - 'RealtimeResourceSettings' => [ - 'description' => 'The resource used for real-time synchronization.'."\n", - 'type' => 'object', - 'properties' => [ - 'ResourceGroupIdentifier' => [ - 'description' => 'The identifier of the resource group for Data Integration used for real-time synchronization.'."\n", - 'type' => 'string', - 'example' => 'S_res_group_111_222', - ], - ], - ], - 'RequestedCu' => [ - 'description' => 'The number of compute units (CUs) in the resource group that are used for incremental and full synchronization.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '2.0', - ], - ], - ], - 'TransformationRules' => [ - 'description' => 'The list of transformation rules that are applied to the synchronization objects selected from the source. Each entry in the list defines a transformation rule.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The transformation rule that is applied to the synchronization objects selected from the source.'."\n", - 'type' => 'object', - 'properties' => [ - 'RuleActionType' => [ - 'description' => 'The action type. Valid values:'."\n" - ."\n" - .'* DefinePrimaryKey'."\n" - .'* Rename'."\n" - .'* AddColumn'."\n" - .'* HandleDml'."\n" - .'* DefineIncrementalCondition'."\n" - .'* DefineCycleScheduleSettings'."\n" - .'* DefineRuntimeSettings'."\n" - .'* DefinePartitionKey'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Rename', - ], - 'RuleExpression' => [ - 'description' => 'The expression of the rule. The expression is a JSON string.'."\n" - ."\n" - .'* Example of a renaming rule: `{"expression":"${srcDatasourceName}_${srcDatabaseName}_0922","variables":\\[{"variableName":"srcDatabaseName","variableRules":\\[{"from":"fromdb","to":"todb"}\\]}\\]}`.'."\n" - ."\n" - .' * expression: the expression of the renaming rule. The expression may contain the following variables:'."\n" - ."\n" - .' * ${srcDatasourceName}'."\n" - .' * ${srcDatabaseName}'."\n" - .' * ${srcTableName}'."\n" - ."\n" - .' * variables: the generation rule for a variable used in the expression of the renaming rule. The default value of the specified variable is the original value of the object indicated by the variable. A group of string replacement rules used to change the original values may be returned.'."\n" - ."\n" - .' * variableName: the name of the variable. The variable name is not enclosed in ${}.'."\n" - .' * variableRules: the string replacement rules for variables. The system runs the string replacement rules in sequence. from indicates the original string. to indicates the new string.'."\n" - ."\n" - .'* Example of a rule used to add a specific field to the destination and assign a value to the field: `{"columns":\\[{"columnName":"my_add_column","columnValueType":"Constant","columnValue":"123"}\\]}`.'."\n" - ."\n" - .' If no rule of this type is configured, no fields are added to the destination and no values are assigned by default.'."\n" - ."\n" - .' * columnName: the name of the field that is added.'."\n" - ."\n" - .' * columnValueType: the value type of the field. Valid values: Constant and Variable.'."\n" - ."\n" - .' * columnValue: the value of the field.'."\n" - ."\n" - .' * If the value of the columnValueType parameter is Constant, the value of the columnValue parameter is a constant of the STRING data type.'."\n" - .' * If the value of the columnValueType parameter is Variable, the value of the columnValue parameter is a built-in variable. The following built-in variables are supported: EXECUTE_TIME (LONG data type), DB_NAME_SRC (STRING data type), DATASOURCE_NAME_SRC (STRING data type), TABLE_NAME_SRC (STRING data type), DB_NAME_DEST (STRING data type), DATASOURCE_NAME_DEST (STRING data type), TABLE_NAME_DEST (STRING data type), and DB_NAME_SRC_TRANSED (STRING data type). EXECUTE_TIME indicates the execution time. DB_NAME_SRC indicates the name of a source database. DATASOURCE_NAME_SRC indicates the name of the source. TABLE_NAME_SRC indicates the name of a source table. DB_NAME_DEST indicates the name of a destination database. DATASOURCE_NAME_DEST indicates the name of the destination. TABLE_NAME_DEST indicates the name of a destination table. DB_NAME_SRC_TRANSED indicates the database name obtained after a transformation.'."\n" - ."\n" - .'* Example of a rule used to specify primary key fields for a destination table: `{"columns":\\["ukcolumn1","ukcolumn2"\\]}`.'."\n" - ."\n" - .' If no rule of this type is configured, the primary key fields in the mapped source table are used for the destination table by default.'."\n" - ."\n" - .' * If the destination table is an existing table, Data Integration does not modify the schema of the destination table. If the specified primary key fields do not exist in the destination table, an error is reported when the synchronization task starts to run.'."\n" - .' * If the destination table is automatically created by the system, Data Integration automatically creates the schema of the destination table. The schema contains the primary key fields that you specify. If the specified primary key fields do not exist in the destination table, an error is reported when the synchronization task starts to run.'."\n" - ."\n" - .'* Example of a rule used to process DML messages: `{"dmlPolicies":\\[{"dmlType":"Delete","dmlAction":"Filter","filterCondition":"id > 1"}\\]}`.'."\n" - ."\n" - .' If no rule of this type is configured, the default processing policy for messages generated for insert, update, and delete operations is Normal.'."\n" - ."\n" - .' * dmlType: the DML operation. Valid values: Insert, Update, and Delete.'."\n" - .' * dmlAction: the processing policy for DML messages. Valid values: Normal, Ignore, Filter, and LogicalDelete. Filter indicates conditional processing. The value Filter is returned for the dmlAction parameter only when the value of the dmlType parameter is Update or Delete.'."\n" - .' * filterCondition: the condition used to filter DML messages. This parameter is returned only when the value of the dmlAction parameter is Filter.'."\n", - 'type' => 'string', - 'example' => '{"expression":"${srcDatasoureName}_${srcDatabaseName}"}', - ], - 'RuleName' => [ - 'description' => 'The name of the rule. If the values of the RuleActionType parameter and the RuleTargetType parameter are the same for multiple transformation rules, you must make sure that the transformation rule names are unique.'."\n", - 'type' => 'string', - 'example' => 'rename_rule_1', - ], - 'RuleTargetType' => [ - 'description' => 'The type of the object on which the action is performed. Valid values:'."\n" - ."\n" - .'* Table'."\n" - .'* Schema'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Table', - ], - ], - ], - ], - 'TableMappings' => [ - 'description' => 'The list of mappings between rules used to select synchronization objects in the source and transformation rules applied to the selected synchronization objects. Each entry in the list displays a mapping between a rule used to select synchronization objects and a transformation rule applied to the selected synchronization objects.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The mapping between a rule used to select synchronization objects in the source and a transformation rule applied to the selected synchronization objects.'."\n", - 'type' => 'object', - 'properties' => [ - 'SourceObjectSelectionRules' => [ - 'description' => 'The list of rules used to select synchronization objects in the source.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The rule used to select synchronization objects in the source. The objects can be databases or tables.'."\n", - 'type' => 'object', - 'properties' => [ - 'Expression' => [ - 'description' => 'The expression.'."\n", - 'type' => 'string', - 'example' => 'mysql_table_1', - ], - 'ObjectType' => [ - 'description' => 'The object type. Valid values:'."\n" - ."\n" - .'* Table'."\n" - .'* Database'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Table', - ], - ], - ], - ], - 'TransformationRules' => [ - 'description' => 'The list of transformation rules that are applied to the synchronization objects selected from the source.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The transformation rule that is applied to the synchronization objects selected from the source.'."\n", - 'type' => 'object', - 'properties' => [ - 'RuleActionType' => [ - 'description' => 'The action type. Valid values:'."\n" - ."\n" - .'* DefinePrimaryKey'."\n" - .'* Rename'."\n" - .'* AddColumn'."\n" - .'* HandleDml'."\n" - .'* DefineIncrementalCondition'."\n" - .'* DefineCycleScheduleSettings'."\n" - .'* DefineRuntimeSettings'."\n" - .'* DefinePartitionKey'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Rename', - ], - 'RuleName' => [ - 'description' => 'The name of the rule. If the values of the RuleActionType parameter and the RuleTargetType parameter are the same for multiple transformation rules, you must make sure that the transformation rule names are unique.'."\n", - 'type' => 'string', - 'example' => 'rename_rule_1', - ], - 'RuleTargetType' => [ - 'description' => 'The type of the object on which the action is performed. Valid values:'."\n" - ."\n" - .'* Table'."\n" - .'* Schema'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Table', - ], - ], - ], - ], - ], - ], - ], - 'JobSettings' => [ - 'description' => 'The settings for the dimension of the synchronization task. The settings include processing policies for DDL messages, policies for data type mappings between source fields and destination fields, and runtime parameters of the synchronization task.'."\n", - 'type' => 'object', - 'properties' => [ - 'ColumnDataTypeSettings' => [ - 'description' => 'The settings for data type mappings between source fields and destination fields. The value of this parameter is an array.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'SourceDataType' => [ - 'description' => 'The data type of a source field.'."\n", - 'type' => 'string', - 'example' => 'bigint', - ], - 'DestinationDataType' => [ - 'description' => 'The data type of a destination field.'."\n", - 'type' => 'string', - 'example' => 'text', - ], - ], - ], - ], - 'DdlHandlingSettings' => [ - 'description' => 'The settings for processing DDL messages. The value of this parameter is an array.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The processing setting for a specific type of DDL message.'."\n", - 'type' => 'object', - 'properties' => [ - 'Action' => [ - 'description' => 'The processing policy. Valid values:'."\n" - ."\n" - .'* Ignore: ignores a DDL message.'."\n" - .'* Critical: reports an error for a DDL message.'."\n" - .'* Normal: normally processes a DDL message.'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Critical', - ], - 'Type' => [ - 'description' => 'The type of the DDL operation. Valid values:'."\n" - ."\n" - .'* RenameColumn'."\n" - .'* ModifyColumn'."\n" - .'* CreateTable'."\n" - .'* TruncateTable'."\n" - .'* DropTable'."\n" - .'* DropColumn'."\n" - .'* AddColumn'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'AddColumn', - ], - ], - ], - ], - 'RuntimeSettings' => [ - 'description' => 'The runtime settings. The value of this parameter is an array.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The runtime setting.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the configuration item. Valid values:'."\n" - ."\n" - .'* runtime.offline.speed.limit.mb: indicates the maximum transmission rate that is allowed for a batch synchronization task. This configuration item takes effect only when runtime.offline.speed.limit.enable is set to true.'."\n" - .'* runtime.offline.speed.limit.enable: indicates whether throttling is enabled for a batch synchronization task.'."\n" - .'* dst.offline.connection.max: indicates the maximum number of connections that are allowed for writing data to the destination of a batch synchronization task.'."\n" - .'* runtime.offline.concurrent: indicates the maximum number of parallel threads that are allowed for a batch synchronization task.'."\n" - .'* dst.realtime.connection.max: indicates the maximum number of connections that are allowed for writing data to the destination of a real-time synchronization task.'."\n" - .'* runtime.enable.auto.create.schema: indicates whether schemas are automatically created in the destination of a synchronization task.'."\n" - .'* src.offline.datasource.max.connection: indicates the maximum number of connections that are allowed for reading data from the source of a batch synchronization task.'."\n" - .'* runtime.realtime.concurrent: indicates the maximum number of parallel threads that are allowed for a real-time synchronization task.'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'runtime.offline.concurrent', - ], - 'Value' => [ - 'description' => 'The value of the configuration item.'."\n", - 'type' => 'string', - 'example' => '1', - ], - ], - ], - ], - 'CycleScheduleSettings' => [ - 'description' => 'The settings for periodic scheduling.'."\n", - 'type' => 'object', - 'properties' => [ - 'CycleMigrationType' => [ - 'description' => 'The synchronization type that requires periodic scheduling. Valid values:'."\n" - ."\n" - .'* Full: full synchronization'."\n" - .'* OfflineIncremental: batch incremental synchronization'."\n", - 'type' => 'string', - 'example' => 'Full', - ], - 'ScheduleParameters' => [ - 'description' => 'The scheduling parameters.'."\n", - 'type' => 'string', - 'example' => 'bizdate=$bizdate', - ], - ], - ], - 'ChannelSettings' => [ - 'description' => 'The channel control settings for the synchronization task. The value of this parameter is a JSON string.'."\n", - 'type' => 'string', - 'example' => '{"structInfo":"MANAGED","storageType":"TEXTFILE","writeMode":"APPEND","partitionColumns":[{"columnName":"pt","columnType":"STRING","comment":""}],"fieldDelimiter":""}'."\n", - ], - ], - ], - 'CreatedTime' => [ - 'description' => 'The timestamp when the synchronization task was created. The timestamp is accurate to the second.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1671516776', - ], - 'CreatedUid' => [ - 'description' => 'The ID of the user who creates the synchronization task.'."\n", - 'type' => 'string', - 'example' => '100000001', - ], - 'UpdatedTime' => [ - 'description' => 'The timestamp when the synchronization task was last modified. The timestamp is accurate to the second.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1673859985', - ], - 'UpdatedUid' => [ - 'description' => 'The ID of the user who last modifies the synchronization task.'."\n", - 'type' => 'string', - 'example' => '100000001', - ], - 'StartedTime' => [ - 'description' => 'The timestamp when the synchronization task was last started. The timestamp is accurate to the second.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1673859999', - ], - 'StartedUid' => [ - 'description' => 'The ID of the user who last starts the synchronization task.'."\n", - 'type' => 'string', - 'example' => '100000001', - ], - 'JobStatus' => [ - 'description' => 'The status of the synchronization task. Valid values:'."\n" - ."\n" - .'* Finished'."\n" - .'* Initialized'."\n" - .'* Stopped'."\n" - .'* Failed'."\n" - .'* Running'."\n" - .'* Stopping'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Finished', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned if the value of the JobStatus parameter is Failed.'."\n", - 'type' => 'string', - 'example' => 'error details xxx', - ], - 'RunStats' => [ - 'description' => 'The information about the running of the synchronization task.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => 'The detailed statistics on the running of the synchronization task.'."\n" - ."\n" - .'* StructureMigrationTotalTables: the total number of tables whose schemas need to be migrated.'."\n" - .'* StructureMigrationSuccessTables: the number of tables whose schemas are successfully migrated.'."\n" - .'* StructureMigrationFailedTables: the number of tables whose schemas fail to be migrated.'."\n" - .'* StructureMigrationStatus: the status of schema migration. Valid values: Waiting, Running, Finished, Failed, and Stopped.'."\n" - .'* StructureMigrationErrorMessage: the error message returned for schema migration.'."\n" - .'* FullMigrationTotalTables: the total number of tables whose full data needs to be synchronized.'."\n" - .'* FullMigrationSuccessTables: the number of tables whose full data is successfully synchronized.'."\n" - .'* FullMigrationFailedTables: the number of tables whose full data fails to be synchronized.'."\n" - .'* FullMigrationStatus: the status of full synchronization.'."\n" - .'* FullMigrationErrorMessage: the error message returned for full synchronization.'."\n" - .'* RealtimeMigrationMaxDelay: the latency of real-time synchronization. Unit: milliseconds.'."\n" - .'* RealtimeMigrationStatus: the status of real-time synchronization.'."\n" - .'* RealtimeMigrationErrorMessage: the error message returned for real-time synchronization.'."\n", - 'example' => 'StructureMigrationTotalTables', - ], - ], - ], - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": {\\n \\"ProjectId\\": 22,\\n \\"DIJobId\\": 11588,\\n \\"JobName\\": \\"mysql_to_holo_sync_445\\",\\n \\"Description\\": \\"Synchronize mysql to hologres\\\\n\\",\\n \\"MigrationType\\": \\"FullAndRealtimeIncremental\\",\\n \\"SourceDataSourceType\\": \\"MySQL\\",\\n \\"DestinationDataSourceType\\": \\"Hologres\\",\\n \\"SourceDataSourceSettings\\": [\\n {\\n \\"DataSourceName\\": \\"mysql_datasource_1\\",\\n \\"DataSourceProperties\\": {\\n \\"key\\": \\"TimeZone\\"\\n }\\n }\\n ],\\n \\"DestinationDataSourceSettings\\": [\\n {\\n \\"DataSourceName\\": \\"holo_datasource_1\\",\\n \\"DataSourceProperties\\": {\\n \\"key\\": \\"TimeZone\\"\\n }\\n }\\n ],\\n \\"ResourceSettings\\": {\\n \\"OfflineResourceSettings\\": {\\n \\"ResourceGroupIdentifier\\": \\"S_res_group_111_222\\"\\n },\\n \\"RealtimeResourceSettings\\": {\\n \\"ResourceGroupIdentifier\\": \\"S_res_group_111_222\\"\\n },\\n \\"RequestedCu\\": 2\\n },\\n \\"TransformationRules\\": [\\n {\\n \\"RuleActionType\\": \\"Rename\\",\\n \\"RuleExpression\\": \\"{\\\\\\"expression\\\\\\":\\\\\\"${srcDatasoureName}_${srcDatabaseName}\\\\\\"}\\",\\n \\"RuleName\\": \\"rename_rule_1\\",\\n \\"RuleTargetType\\": \\"Table\\"\\n }\\n ],\\n \\"TableMappings\\": [\\n {\\n \\"SourceObjectSelectionRules\\": [\\n {\\n \\"Expression\\": \\"mysql_table_1\\",\\n \\"ObjectType\\": \\"Table\\"\\n }\\n ],\\n \\"TransformationRules\\": [\\n {\\n \\"RuleActionType\\": \\"Rename\\",\\n \\"RuleName\\": \\"rename_rule_1\\",\\n \\"RuleTargetType\\": \\"Table\\"\\n }\\n ]\\n }\\n ],\\n \\"JobSettings\\": {\\n \\"ColumnDataTypeSettings\\": [\\n {\\n \\"SourceDataType\\": \\"bigint\\",\\n \\"DestinationDataType\\": \\"text\\"\\n }\\n ],\\n \\"DdlHandlingSettings\\": [\\n {\\n \\"Action\\": \\"Critical\\",\\n \\"Type\\": \\"AddColumn\\"\\n }\\n ],\\n \\"RuntimeSettings\\": [\\n {\\n \\"Name\\": \\"runtime.offline.concurrent\\",\\n \\"Value\\": \\"1\\"\\n }\\n ],\\n \\"CycleScheduleSettings\\": {\\n \\"CycleMigrationType\\": \\"Full\\",\\n \\"ScheduleParameters\\": \\"bizdate=$bizdate\\"\\n },\\n \\"ChannelSettings\\": \\"{\\\\\\"structInfo\\\\\\":\\\\\\"MANAGED\\\\\\",\\\\\\"storageType\\\\\\":\\\\\\"TEXTFILE\\\\\\",\\\\\\"writeMode\\\\\\":\\\\\\"APPEND\\\\\\",\\\\\\"partitionColumns\\\\\\":[{\\\\\\"columnName\\\\\\":\\\\\\"pt\\\\\\",\\\\\\"columnType\\\\\\":\\\\\\"STRING\\\\\\",\\\\\\"comment\\\\\\":\\\\\\"\\\\\\"}],\\\\\\"fieldDelimiter\\\\\\":\\\\\\"\\\\\\"}\\\\n\\"\\n },\\n \\"CreatedTime\\": 1671516776,\\n \\"CreatedUid\\": \\"100000001\\",\\n \\"UpdatedTime\\": 1673859985,\\n \\"UpdatedUid\\": \\"100000001\\",\\n \\"StartedTime\\": 1673859999,\\n \\"StartedUid\\": \\"100000001\\",\\n \\"JobStatus\\": \\"Finished\\",\\n \\"ErrorMessage\\": \\"error details xxx\\",\\n \\"RunStats\\": {\\n \\"key\\": \\"StructureMigrationTotalTables\\"\\n }\\n },\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 22\\n 11588\\n mysql_to_holo_sync_445\\n mysql同步到hologres\\n FullAndRealtimeIncremental\\n MySQL\\n Hologres\\n \\n mysql_datasource_1\\n \\n TimeZone\\n \\n \\n \\n holo_datasource_1\\n \\n TimeZone\\n \\n \\n \\n \\n S_res_group_111_222\\n \\n \\n S_res_group_111_222\\n \\n \\n \\n Rename\\n {\\"expression\\":\\"${srcDatasoureName}_${srcDatabaseName}\\"}\\n rename_rule_1\\n Table\\n \\n \\n \\n mysql_table_1\\n Table\\n \\n \\n Rename\\n rename_rule_1\\n Table\\n \\n \\n \\n \\n bigint\\n text\\n \\n \\n Critical\\n AddColumn\\n \\n \\n runtime.offline.concurrent\\n 1\\n \\n \\n 1671516776\\n 100000001\\n 1673859985\\n 100000001\\n 1673859999\\n 100000001\\n Finished\\n error details xxx\\n \\n StructureMigrationTotalTables\\n \\n \\n 0000-ABCD-EFG****\\n","errorExample":""}]', - 'title' => 'GetDIJob', - ], - 'ListDIJobs' => [ - 'summary' => 'Queries a list of new-version synchronization tasks. The following type of task is supported: real-time data synchronization from a MySQL database to Hologres.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '155162', - 'abilityTreeNodes' => [ - 'FEATUREdideQHGTK4', - ], - ], - 'parameters' => [ - [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the workspace.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1967', - ], - ], - [ - 'name' => 'JobName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the task. Fuzzy match is supported. If you do not configure this parameter, no limits are imposed on the tasks.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mysql_to_holo_sync_8772', - ], - ], - [ - 'name' => 'SourceDataSourceType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The source type. If you do not configure this parameter, no limits are imposed on the tasks.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'MySQL', - ], - ], - [ - 'name' => 'DestinationDataSourceType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The destination type. If you do not configure this parameter, no limits are imposed on the tasks.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Hologres', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The returned result.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '7263E4AC-9D2E-5B29-B8AF-7C5012E92A41', - ], - 'DIJobPaging' => [ - 'description' => 'The pagination information.'."\n", - 'type' => 'object', - 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '6', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'DIJobs' => [ - 'description' => 'The list of tasks.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'DIJobId' => [ - 'description' => 'The task ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16626', - ], - 'ProjectId' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1967', - ], - 'JobName' => [ - 'description' => 'The task name.'."\n", - 'type' => 'string', - 'example' => 'mysql_to_holo_sync_8772', - ], - 'MigrationType' => [ - 'description' => 'The synchronization type. Valid values:'."\n" - ."\n" - .'* FullAndRealtimeIncremental: one-time full synchronization and real-time incremental synchronization'."\n" - .'* RealtimeIncremental: real-time incremental synchronization'."\n" - .'* Full: one-time full synchronization'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'FullAndRealtimeIncremental' => '', - 'RealtimeIncremental' => '', - 'Full' => '', - ], - 'example' => 'Full', - ], - 'SourceDataSourceType' => [ - 'description' => 'The type of the source. The value MySQL is returned.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'MySQL' => 'MySQL', - ], - 'example' => 'MySQL', - ], - 'DestinationDataSourceType' => [ - 'description' => 'The type of the destination. The value Hologres is returned.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Hologres' => 'Hologres', - ], - 'example' => 'Hologres', - ], - 'JobStatus' => [ - 'description' => 'The task status. Valid values:'."\n" - ."\n" - .'* Finished'."\n" - .'* Initialized'."\n" - .'* Stopped'."\n" - .'* Failed'."\n" - .'* Running'."\n" - .'* Stopping'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Finished' => '', - 'Initialized' => '', - 'Stopped' => '', - 'Failed' => '', - 'Running' => '', - 'Stopping' => '', - ], - 'example' => 'Finished', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7263E4AC-9D2E-5B29-B8AF-7C5012E92A41\\",\\n \\"DIJobPaging\\": {\\n \\"TotalCount\\": 6,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"DIJobs\\": [\\n {\\n \\"DIJobId\\": 16626,\\n \\"ProjectId\\": 1967,\\n \\"JobName\\": \\"mysql_to_holo_sync_8772\\",\\n \\"MigrationType\\": \\"Full\\",\\n \\"SourceDataSourceType\\": \\"MySQL\\",\\n \\"DestinationDataSourceType\\": \\"Hologres\\",\\n \\"JobStatus\\": \\"Finished\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 7263E4AC-9D2E-5B29-B8AF-7C5012E92A41\\n \\n 6\\n 1\\n 10\\n \\n 16626\\n 1967\\n mysql_to_holo_sync_8772\\n Full\\n MySQL\\n Hologres\\n Finished\\n \\n \\n","errorExample":""}]', - 'title' => 'ListDIJobs', - 'description' => 'You can call this operation to obtain only the basic information about the tasks. If you want to obtain the details of a task, call the GetDIJob operation.'."\n", - ], - 'StartDIJob' => [ - 'summary' => 'Starts a synchronization task of a new version. Only the following type of task is supported: real-time data synchronization from a MySQL database to Hologres.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '155172', - 'abilityTreeNodes' => [ - 'FEATUREdideQHGTK4', - ], - ], - 'parameters' => [ - [ - 'name' => 'DIJobId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The task ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '11743', - ], - ], - [ - 'name' => 'RealtimeStartSettings', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The settings for the start.'."\n", - 'type' => 'object', - 'properties' => [ - 'StartTime' => [ - 'description' => 'The timestamp of the start offset. Unit: seconds. If you do not configure this parameter, the offset is not reset by default.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1671516776', - ], - 'FailoverSettings' => [ - 'description' => 'The failover settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Interval' => [ - 'description' => 'The failover interval. Unit: minutes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], - 'UpperLimit' => [ - 'description' => 'The maximum number of failovers.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '30', - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], - ], - [ - 'name' => 'ForceToRerun', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether to forcefully rerun all synchronization steps. If you do not configure this parameter, the system does not forcefully rerun the task.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '999431B2-6013-577F-B684-36F7433C753B', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"999431B2-6013-577F-B684-36F7433C753B\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 999431B2-6013-577F-B684-36F7433C753B\\n","errorExample":""}]', - 'title' => 'StartDIJob', - ], - 'StopDIJob' => [ - 'summary' => 'Stops a new-version synchronization task. The following type of synchronization task is supported: real-time synchronization of all data in a MySQL database to Hologres.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '155174', - 'abilityTreeNodes' => [ - 'FEATUREdideQHGTK4', - ], - ], - 'parameters' => [ - [ - 'name' => 'DIJobId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The task ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '11668', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '92F778C7-8F00-53B1-AE1A-B3B17101247D', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"92F778C7-8F00-53B1-AE1A-B3B17101247D\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 92F778C7-8F00-53B1-AE1A-B3B17101247D\\n","errorExample":""}]', - 'title' => 'StopDIJob', - ], - 'UpdateDIJob' => [ - 'summary' => 'Updates a new-version synchronization task. The following type of task is supported: real-time synchronization of all data in a MySQL database to Hologres.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '155160', - 'abilityTreeNodes' => [ - 'FEATUREdideQHGTK4', - ], - ], - 'parameters' => [ - [ - 'name' => 'DIJobId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the synchronization task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '11588', - ], - ], - [ - 'name' => 'Description', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The description of the synchronization task.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Synchronize mysql to hologres', - ], - ], - [ - 'name' => 'ResourceSettings', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The resource settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'OfflineResourceSettings' => [ - 'description' => 'The resource used for batch synchronization.'."\n", - 'type' => 'object', - 'properties' => [ - 'ResourceGroupIdentifier' => [ - 'description' => 'The identifier of the resource group for Data Integration used for batch synchronization.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'S_res_group_111_222', - ], - ], - 'required' => false, - ], - 'RealtimeResourceSettings' => [ - 'description' => 'The resource used for real-time synchronization.'."\n", - 'type' => 'object', - 'properties' => [ - 'ResourceGroupIdentifier' => [ - 'description' => 'The identifier of the resource group for Data Integration used for real-time synchronization.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'S_res_group_111_222', - ], - ], - 'required' => false, - ], - 'RequestedCu' => [ - 'description' => 'The number of compute units (CUs) in the resource group that are used for full and incremental synchronization.'."\n", - 'type' => 'number', - 'format' => 'float', - 'required' => false, - 'example' => '2.0', - ], - ], - 'required' => false, - ], - ], - [ - 'name' => 'TransformationRules', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The list of transformation rules that you want to apply to the synchronization objects selected from the source. Each entry in the list defines a transformation rule.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The transformation rule that you want to apply to the synchronization objects selected from the source.'."\n", - 'type' => 'object', - 'properties' => [ - 'RuleName' => [ - 'description' => 'The name of the rule. If the values of the RuleActionType parameter and the RuleTargetType parameter are the same for multiple transformation rules, you must make sure that the transformation rule names are unique.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rename_rule_1', - ], - 'RuleActionType' => [ - 'description' => 'The type of the action. Valid values:'."\n" - ."\n" - .'* DefinePrimaryKey'."\n" - .'* Rename'."\n" - .'* AddColumn'."\n" - .'* HandleDml'."\n" - .'* DefineIncrementalCondition'."\n" - .'* DefineCycleScheduleSettings'."\n" - .'* DefineRuntimeSettings'."\n" - .'* DefinePartitionKey'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Rename', - ], - 'RuleTargetType' => [ - 'description' => 'The type of the object on which you want to perform the action. Valid values:'."\n" - ."\n" - .'* Table'."\n" - .'* Schema'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Table', - ], - 'RuleExpression' => [ - 'description' => 'The expression of the rule. The expression must be a JSON string.'."\n" - ."\n" - .'Example of a renaming rule: {"expression":"${srcDatasourceName}\\_${srcDatabaseName}\\_0922","variables":\\[{"variableName":"srcDatabaseName","variableRules":\\[{"from":"fromdb","to":"todb"}]}]}.'."\n" - ."\n" - .'expression: the expression of the renaming rule. The expression may contain the following variables: ${srcDatasourceName}, ${srcDatabaseName}, and ${srcTableName}. ${srcDatasourceName} specifies the name of the source. ${srcDatabaseName} specifies the name of a source database. ${srcTableName} specifies the name of a source table. variables: the generation rule for a variable used in the expression of the renaming rule. The default value of the specified variable is the original value of the object indicated by the variable. You can define a group of string replacement rules to change the original values based on your business requirements. variableName: the name of the variable. Do not enclose the variable name in ${}. variableRules: the string replacement rules for variables. The system runs the string replacement rules in sequence. from specifies the original string. to specifies the new string. Example of a rule used to add a specific field to the destination and assign a value to the field: {"columns":\\[{"columnName":"my_add_column","columnValueType":"Constant","columnValue":"123"}]}.'."\n" - ."\n" - .'If you do not configure such a rule, no fields are added to the destination and no values are assigned by default. columnName: the name of the field that you want to add. columnValueType: the value type of the field. Valid values: Constant and Variable. columnValue: the value of the field that you want to add. If you set the valueType parameter to Constant, set the columnValue parameter to a custom constant of the STRING type. If you set the valueType parameter to Variable, set the columnValue to a built-in variable. The following built-in variables are supported: EXECUTE_TIME (LONG data type), DB_NAME_SRC (STRING data type), DATASOURCE_NAME_SRC (STRING data type), TABLE_NAME_SRC (STRING data type), DB_NAME_DEST (STRING data type), DATASOURCE_NAME_DEST (STRING data type), TABLE_NAME_DEST (STRING data type), and DB_NAME_SRC_TRANSED (STRING data type). EXECUTE_TIME specifies the execution time. DB_NAME_SRC indicates the name of a source database. DATASOURCE_NAME_SRC specifies the name of the source. TABLE_NAME_SRC specifies the name of a source table. DB_NAME_DEST specifies the name of a destination database. DATASOURCE_NAME_DEST specifies the name of the destination. TABLE_NAME_DEST specifies the name of a destination table. DB_NAME_SRC_TRANSED specifies the database name obtained after a transformation. Example of a rule used to specify primary key fields for a destination table: {"columns":\\["ukcolumn1","ukcolumn2"]}.'."\n" - ."\n" - .'If you do not configure such a rule, the primary key fields in the mapped source table are used for the destination table by default. If the destination table is an existing table, Data Integration does not modify the schema of the destination table. If the specified primary key fields do not exist in the destination table, an error is reported when the synchronization task starts to run. If the destination table is automatically created by the system, Data Integration automatically creates the schema of the destination table. The schema contains the primary key fields that you specify. If the specified primary key fields do not exist in the destination table, an error is reported when the synchronization task starts to run. Example of a rule used to process DML messages: {"dmlPolicies":\\[{"dmlType":"Delete","dmlAction":"Filter","filterCondition":"id > 1"}]}.'."\n" - ."\n" - .'If you do not configure such a rule, the default processing policy for messages generated for insert, update, and delete operations is Normal. dmlType: the DML operation. Valid values: Insert, Update, and Delete. dmlAction: the processing policy for DML messages. Valid values: Normal, Ignore, Filter, and LogicalDelete. Filter indicates conditional processing. You can set the dmlAction parameter to Filter only when the dmlType parameter is set to Update or Delete. filterCondition: the condition used to filter DML messages. This parameter is required only when the dmlAction parameter is set to Filter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"expression":"${srcDatasoureName}_${srcDatabaseName}"}', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - [ - 'name' => 'TableMappings', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The list of mappings between rules used to select synchronization objects in the source and transformation rules applied to the selected synchronization objects. Each entry in the list displays a mapping between a rule used to select synchronization objects and a transformation rule applied to the selected synchronization objects.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The mapping between a rule used to select synchronization objects in the source and a transformation rule applied to the selected synchronization objects.'."\n", - 'type' => 'object', - 'properties' => [ - 'SourceObjectSelectionRules' => [ - 'description' => 'The list of rules that you want to use to select synchronization objects in the source.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The rule that you want to use to select synchronization objects in the source. The objects can be databases or tables.'."\n", - 'type' => 'object', - 'properties' => [ - 'ObjectType' => [ - 'description' => 'The type of the object. Valid values:'."\n" - ."\n" - .'* Table'."\n" - .'* Database'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Table', - ], - 'Expression' => [ - 'description' => 'The expression.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mysql_table_1', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'TransformationRules' => [ - 'description' => 'The list of transformation rules that you want to apply to the synchronization objects selected from the source.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The transformation rule that you want to apply to the synchronization objects selected from the source.'."\n", - 'type' => 'object', - 'properties' => [ - 'RuleName' => [ - 'description' => 'The name of the rule. If the values of the RuleActionType parameter and the RuleTargetType parameter are the same for multiple transformation rules, you must make sure that the transformation rule names are unique.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rename_rule_1', - ], - 'RuleActionType' => [ - 'description' => 'The type of the action. Valid values:'."\n" - ."\n" - .'* DefinePrimaryKey'."\n" - .'* Rename'."\n" - .'* AddColumn'."\n" - .'* HandleDml'."\n" - .'* DefineIncrementalCondition'."\n" - .'* DefineCycleScheduleSettings'."\n" - .'* DefineRuntimeSettings'."\n" - .'* DefinePartitionKey'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Rename', - ], - 'RuleTargetType' => [ - 'description' => 'The type of the object on which you want to perform the action. Valid values:'."\n" - ."\n" - .'* Table'."\n" - .'* Schema'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Table', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - [ - 'name' => 'JobSettings', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The settings for the dimension of the synchronization task. The settings include processing policies for DDL messages, policies for data type mappings between source fields and destination fields, and runtime parameters of the synchronization task.'."\n", - 'type' => 'object', - 'properties' => [ - 'DdlHandlingSettings' => [ - 'description' => 'The settings for processing DDL messages. The value of this parameter must be an array.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The processing setting for a specific type of DDL message.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the DDL operation. Valid values:'."\n" - ."\n" - .'* RenameColumn'."\n" - .'* ModifyColumn'."\n" - .'* CreateTable'."\n" - .'* TruncateTable'."\n" - .'* DropTable'."\n" - .'* DropColumn'."\n" - .'* AddColumn'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'AddColumn', - ], - 'Action' => [ - 'description' => 'The processing policy for DDL messages. Valid values:'."\n" - ."\n" - .'* Ignore: ignores a DDL message.'."\n" - .'* Critical: reports an error for a DDL message.'."\n" - .'* Normal: normally processes a DDL message.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Critical', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'ColumnDataTypeSettings' => [ - 'description' => 'The settings for data type mappings between source fields and destination fields. The value of this parameter must be an array.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data type mapping between a source field and a destination field.'."\n", - 'type' => 'object', - 'properties' => [ - 'SourceDataType' => [ - 'description' => 'The data type of a source field.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'bigint', - ], - 'DestinationDataType' => [ - 'description' => 'The data type of a destination field.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'text', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'RuntimeSettings' => [ - 'description' => 'The runtime settings. The value of this parameter must be an array.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The runtime settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the configuration item. Valid values:'."\n" - ."\n" - .'* runtime.offline.speed.limit.mb: specifies the maximum transmission rate that is allowed for a batch synchronization task. This configuration item takes effect only when runtime.offline.speed.limit.enable is set to true.'."\n" - .'* runtime.offline.speed.limit.enable: specifies whether throttling is enabled for a batch synchronization task.'."\n" - .'* dst.offline.connection.max: specifies the maximum number of connections that are allowed for writing data to the destination of a batch synchronization task.'."\n" - .'* runtime.offline.concurrent: specifies the maximum number of parallel threads that are allowed for a batch synchronization task.'."\n" - .'* dst.realtime.connection.max: specifies the maximum number of connections that are allowed for writing data to the destination of a real-time synchronization task.'."\n" - .'* runtime.enable.auto.create.schema: specifies whether schemas are automatically created in the destination of a synchronization task.'."\n" - .'* src.offline.datasource.max.connection: specifies the maximum number of connections that are allowed for reading data from the source of a batch synchronization task.'."\n" - .'* runtime.realtime.concurrent: specifies the maximum number of parallel threads that are allowed for a real-time synchronization task.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'runtime.offline.concurrent', - ], - 'Value' => [ - 'description' => 'The value of the configuration item.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'CycleScheduleSettings' => [ - 'description' => 'The settings for periodic scheduling.'."\n", - 'type' => 'object', - 'properties' => [ - 'ScheduleParameters' => [ - 'description' => 'The scheduling parameters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'bizdate=$bizdate'."\n", - ], - ], - 'required' => false, - ], - 'ChannelSettings' => [ - 'description' => 'The channel control settings for the synchronization task. The value of this parameter must be a JSON string.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"structInfo":"MANAGED","storageType":"TEXTFILE","writeMode":"APPEND","partitionColumns":[{"columnName":"pt","columnType":"STRING","comment":""}],"fieldDelimiter":""}'."\n", - ], - ], - 'required' => false, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The returned result.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'AAC30B35-820D-5F3E-A42C-E96BB6379325', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"AAC30B35-820D-5F3E-A42C-E96BB6379325\\"\\n}","errorExample":""},{"type":"xml","example":"\\n AAC30B35-820D-5F3E-A42C-E96BB6379325\\n","errorExample":""}]', - 'title' => 'UpdateDIJob', - ], - 'CreateDIAlarmRule' => [ - 'summary' => 'Creates an alert rule for a Data Integration task of a new version. Only the following type of task is supported: real-time data synchronization from a MySQL database to Hologres.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '154822', - 'abilityTreeNodes' => [ - 'FEATUREdideTG7EYI', - ], - ], - 'parameters' => [ - [ - 'name' => 'DIJobId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the task with which the alert rule is associated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '11265', - ], - ], - [ - 'name' => 'Description', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The description of the task.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mysql synchronizes to hologres heartbeat alert', - ], - ], - [ - 'name' => 'MetricType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The metric type in the alert rule. Valid values:'."\n" - ."\n" - .'* Heartbeat'."\n" - .'* FailoverCount'."\n" - .'* Delay'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [], - 'example' => 'Heartbeat', - ], - ], - [ - 'name' => 'TriggerConditions', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The conditions that are used to trigger the alert rule.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The condition that is used to trigger the alert rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'Severity' => [ - 'description' => 'The severity level. Valid values:'."\n" - ."\n" - .'* Warning'."\n" - .'* Critical'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Warning', - ], - 'Duration' => [ - 'description' => 'The time interval for alert calculation. Unit: minutes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '15', - ], - 'Threshold' => [ - 'description' => 'The alert threshold.'."\n" - ."\n" - .'* If the alert rule is for task status, you do not need to specify a threshold.'."\n" - .'* If the alert rule is for failovers, specify the number of failovers.'."\n" - .'* If the alert rule is for latency, the threshold is the latency duration, in seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '5', - ], - ], - 'required' => false, - ], - 'required' => true, - ], - ], - [ - 'name' => 'NotificationSettings', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The alert notification settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'NotificationChannels' => [ - 'description' => 'The alert notification methods.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The alert notification method.'."\n", - 'type' => 'object', - 'properties' => [ - 'Severity' => [ - 'description' => 'The severity level. Valid values:'."\n" - ."\n" - .'* Warning'."\n" - .'* Critical'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Warning', - ], - 'Channels' => [ - 'description' => 'The alert notification methods.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The alert notification method. Valid values:'."\n" - ."\n" - .'* Mail: email'."\n" - .'* Phone: phone call'."\n" - .'* Sms: text message'."\n" - .'* Ding: DingTalk chatbot token'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Ding', - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => true, - ], - 'NotificationReceivers' => [ - 'description' => 'The settings of alert notification recipients.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The setting of an alert notification recipient.'."\n", - 'type' => 'object', - 'properties' => [ - 'ReceiverType' => [ - 'description' => 'The recipient type. Valid values: AliyunUid and DingToken.'."\n" - ."\n" - .'* If the alert notification method is Mail, Phone, or Sms, set this parameter to **AliyunUid**, which specifies the Alibaba Cloud account ID.'."\n" - .'* If the alert notification method is Ding, set this parameter to **DingToken**, which indicates the DingTalk chatbot token.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'DingToken', - ], - 'ReceiverValues' => [ - 'description' => 'The recipients.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The recipient.'."\n" - ."\n" - .'* If the ReceiverType parameter is set to AliyunUid, set this parameter to the Alibaba Cloud account ID of a user.'."\n" - .'* If the ReceiverType parameter is set to DingToken, set this parameter to the token of a DingTalk chatbot.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'token1', - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => true, - ], - 'InhibitionInterval' => [ - 'description' => 'The duration of the alert suppression interval. Default value: 5. Unit: minutes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '5', - ], - ], - 'required' => true, - ], - ], - [ - 'name' => 'Enabled', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether to enable the alert rule. By default, the alert rule is disabled.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'false', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'C636A747-7E4E-594D-94CD-2B4F8A9A9A63', - ], - 'DIAlarmRuleId' => [ - 'description' => 'The alert rule ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '34988', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C636A747-7E4E-594D-94CD-2B4F8A9A9A63\\",\\n \\"DIAlarmRuleId\\": 34988\\n}","errorExample":""},{"type":"xml","example":"\\n C636A747-7E4E-594D-94CD-2B4F8A9A9A63\\n 34988\\n","errorExample":""}]', - 'title' => 'CreateDIAlarmRule', - 'description' => 'You can configure alert rules only for tasks that can be used for real-time data synchronization.'."\n", - ], - 'DeleteDIAlarmRule' => [ - 'summary' => 'Deletes an alert rule for a Data Integration task of a new version. Only the following type of task is supported: real-time data synchronization from a MySQL database to Hologres.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '154894', - 'abilityTreeNodes' => [ - 'FEATUREdide39WW3A', - ], - ], - 'parameters' => [ - [ - 'name' => 'DIAlarmRuleId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The alert rule ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '34971', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490\\"\\n}","errorExample":""},{"type":"xml","example":"\\n C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490\\n","errorExample":""}]', - 'title' => 'DeleteDIAlarmRule', - 'description' => 'You can configure alert rules only for tasks whose MigrationType is set to RealtimeIncremental.'."\n", - ], - 'GetDIAlarmRule' => [ - 'summary' => 'Queries the details of an alert rule configured for a new-version synchronization task. Only the following types of tasks are supported: real-time data synchronization from a MySQL database to Hologres.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '154881', - 'abilityTreeNodes' => [ - 'FEATUREdide39WW3A', - ], - ], - 'parameters' => [ - [ - 'name' => 'DIAlarmRuleId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The alert rule ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '34994', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The returned result.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '4A807D85-AC9F-55F7-A58F-998D5249CAD9', - ], - 'DIAlarmRule' => [ - 'description' => 'The details of the alert rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'DIAlarmRuleId' => [ - 'description' => 'The alert rule ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '34988', - ], - 'DIJobId' => [ - 'description' => 'The ID of the task with which the alert rule is associated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '11170', - ], - 'Description' => [ - 'description' => 'The description of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'mysql synchronizes to hologres heartbeat alert', - ], - 'MetricType' => [ - 'description' => 'The metric type in the alert rule. Valid values:'."\n" - ."\n" - .'* Heartbeat'."\n" - .'* FailoverCount'."\n" - .'* Delay'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Heartbeat', - ], - 'Enabled' => [ - 'description' => 'Indicates whether the alert rule is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'TriggerConditions' => [ - 'description' => 'The conditions that are used to trigger the alert rule.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The condition that is used to trigger the alert rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'Severity' => [ - 'description' => 'The severity level. Valid values:'."\n" - ."\n" - .'* Warning'."\n" - .'* Critical'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Warning', - ], - 'Duration' => [ - 'description' => 'The time interval for alert calculation. Unit: minutes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '15', - ], - 'Threshold' => [ - 'description' => 'The alert threshold.'."\n" - ."\n" - .'* If the alert rule is for task status, no threshold is used.'."\n" - .'* If the alert rule is for failovers, specify the number of failovers.'."\n" - .'* If the alert rule is for latency, the threshold is the latency duration, in seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - ], - ], - ], - 'NotificationSettings' => [ - 'description' => 'The alert notification settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'NotificationChannels' => [ - 'description' => 'The alert notification methods.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The alert notification method.'."\n", - 'type' => 'object', - 'properties' => [ - 'Severity' => [ - 'description' => 'The severity level. Valid values:'."\n" - ."\n" - .'* Warning'."\n" - .'* Critical'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Warning', - ], - 'Channels' => [ - 'description' => 'The alert notification methods.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The alert notification method. Valid values:'."\n" - ."\n" - .'* Mail: email'."\n" - .'* Phone: phone call'."\n" - .'* Sms: text message'."\n" - .'* Ding: DingTalk chatbot token'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Ding', - ], - ], - ], - ], - ], - 'NotificationReceivers' => [ - 'description' => 'The alert notification recipients.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The alert notification recipient.'."\n", - 'type' => 'object', - 'properties' => [ - 'ReceiverType' => [ - 'description' => 'The recipient type. Valid values: AliyunUid and DingToken.'."\n" - ."\n" - .'* If the alert notification method is Mail, Phone, or Sms, the value of this parameter is **AliyunUid**, which indicates the Alibaba Cloud account ID.'."\n" - .'* If the alert notification method is Ding, the value of this parameter is **DingToken**, which indicates the DingTalk chatbot token.'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'DingToken', - ], - 'ReceiverValues' => [ - 'description' => 'The recipients.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The recipient.'."\n" - ."\n" - .'* If the recipient type is Alibaba Cloud account ID, set this parameter to the Alibaba Cloud account ID of a user.'."\n" - .'* If the recipient type is DingTalk chatbot token, set this parameter to the token of a DingTalk chatbot.'."\n", - 'type' => 'string', - 'example' => 'token1', - ], - ], - ], - ], - ], - 'InhibitionInterval' => [ - 'description' => 'The duration of the alert suppression interval. Unit: minutes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - ], - ], - 'CreatedUid' => [ - 'description' => 'The ID of the user who creates the alert rule.'."\n", - 'type' => 'string', - 'example' => '10000001', - ], - 'CreatedTime' => [ - 'description' => 'The timestamp when the alert rule was created. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1663573162', - ], - 'UpdatedUid' => [ - 'description' => 'The ID of the user who last updates the alert rule.'."\n", - 'type' => 'string', - 'example' => '10000001', - ], - 'UpdatedTime' => [ - 'description' => 'The timestamp when the alert rule was last updated. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1663573163', - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4A807D85-AC9F-55F7-A58F-998D5249CAD9\\",\\n \\"DIAlarmRule\\": {\\n \\"DIAlarmRuleId\\": 34988,\\n \\"DIJobId\\": 11170,\\n \\"Description\\": \\"mysql synchronizes to hologres heartbeat alert\\",\\n \\"MetricType\\": \\"Heartbeat\\",\\n \\"Enabled\\": true,\\n \\"TriggerConditions\\": [\\n {\\n \\"Severity\\": \\"Warning\\",\\n \\"Duration\\": 15,\\n \\"Threshold\\": 5\\n }\\n ],\\n \\"NotificationSettings\\": {\\n \\"NotificationChannels\\": [\\n {\\n \\"Severity\\": \\"Warning\\",\\n \\"Channels\\": [\\n \\"Ding\\"\\n ]\\n }\\n ],\\n \\"NotificationReceivers\\": [\\n {\\n \\"ReceiverType\\": \\"DingToken\\",\\n \\"ReceiverValues\\": [\\n \\"token1\\"\\n ]\\n }\\n ],\\n \\"InhibitionInterval\\": 5\\n },\\n \\"CreatedUid\\": \\"10000001\\",\\n \\"CreatedTime\\": 1663573162,\\n \\"UpdatedUid\\": \\"10000001\\",\\n \\"UpdatedTime\\": 1663573163\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 4A807D85-AC9F-55F7-A58F-998D5249CAD9\\n \\n 34988\\n 11170\\n mysql同步到hologres心跳告警\\n Heartbeat\\n true\\n \\n Warning\\n 15\\n 5\\n \\n \\n \\n Warning\\n Ding\\n \\n \\n DingToken\\n token1\\n \\n 5\\n \\n 10000001\\n 1663573162\\n 10000001\\n 1663573163\\n \\n","errorExample":""}]', - 'title' => 'GetDIAlarmRule', - 'description' => 'You can configure alert rules only for tasks that can be used for real-time data synchronization.'."\n", - ], - 'ListDIAlarmRules' => [ - 'summary' => 'Queries a list of alert rules configured for a new-version synchronization task. The following type of task is supported: real-time data synchronization from a MySQL database to Hologres.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '154898', - 'abilityTreeNodes' => [ - 'FEATUREdideTG7EYI', - ], - ], - 'parameters' => [ - [ - 'name' => 'DIJobId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the task with which the alert rules are associated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '11260', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - 'default' => '10', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The returned result.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '74C2FECD-5B3A-554A-BCF5-351A36DE9815', - ], - 'DIAlarmRulePaging' => [ - 'description' => 'The pagination information.'."\n", - 'type' => 'object', - 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'DIJobAlarmRules' => [ - 'description' => 'The alert rules.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The details of the alert rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'DIAlarmRuleId' => [ - 'description' => 'The alert rule ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '41998', - ], - 'DIJobId' => [ - 'description' => 'The ID of the task with which the alert rule is associated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '11260', - ], - 'Description' => [ - 'description' => 'The description of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'mysql synchronizes to hologres heartbeat alert', - ], - 'MetricType' => [ - 'description' => 'The metric type in the alert rule. Valid values:'."\n" - ."\n" - .'* Heartbeat'."\n" - .'* FailoverCount'."\n" - .'* Delay'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Heartbeat', - ], - 'Enabled' => [ - 'description' => 'Indicates whether the alert rule is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'TriggerConditions' => [ - 'description' => 'The conditions that are used to trigger the alert rule.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The condition that is used to trigger the alert rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'Severity' => [ - 'description' => 'The severity level. Valid values:'."\n" - ."\n" - .'* Warning'."\n" - .'* Critical'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Warning', - ], - 'Duration' => [ - 'description' => 'The time interval for alert calculation. Unit: minutes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '15', - ], - 'Threshold' => [ - 'description' => 'The alert threshold.'."\n" - ."\n" - .'* If the alert rule is for task status, no threshold is used.'."\n" - .'* If the alert rule is for failovers, the threshold is the number of failovers.'."\n" - .'* If the alert rule is for latency, the threshold is the latency duration, in seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - ], - ], - ], - 'NotificationSettings' => [ - 'description' => 'The alert notification settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'NotificationChannels' => [ - 'description' => 'The alert notification methods.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The alert notification method.'."\n", - 'type' => 'object', - 'properties' => [ - 'Severity' => [ - 'description' => 'The severity level. Valid values:'."\n" - ."\n" - .'* Warning'."\n" - .'* Critical'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Warning', - ], - 'Channels' => [ - 'description' => 'The alert notification methods.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The alert notification method. Valid values:'."\n" - ."\n" - .'* Mail: email'."\n" - .'* Phone: phone call'."\n" - .'* Sms: text message'."\n" - .'* Ding: DingTalk chatbot token'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Ding', - ], - ], - ], - ], - ], - 'NotificationReceivers' => [ - 'description' => 'The settings of alert notification recipients.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The setting of an alert notification recipient.'."\n", - 'type' => 'object', - 'properties' => [ - 'ReceiverType' => [ - 'description' => 'The recipient type. Valid values: AliyunUid and DingToken.'."\n" - ."\n" - .'* If the alert notification method is Mail, Phone, or Sms, the value of this parameter is **AliyunUid**, which indicates the Alibaba Cloud account ID.'."\n" - .'* If the alert notification method is Ding, the value of this parameter is **DingToken**, which indicates the DingTalk chatbot token.'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'DingToken', - ], - 'ReceiverValues' => [ - 'description' => 'The recipients.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The recipient.'."\n" - ."\n" - .'* If the recipient type is Alibaba Cloud account ID, the value of this parameter is the Alibaba Cloud account ID of a user.'."\n" - .'* If the recipient type is DingTalk chatbot token, the value of this parameter is the token of a DingTalk chatbot.'."\n", - 'type' => 'string', - 'example' => 'token1', - ], - ], - ], - ], - ], - 'InhibitionInterval' => [ - 'description' => 'The duration of the alert suppression interval. Unit: minutes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"74C2FECD-5B3A-554A-BCF5-35****\\",\\n \\"DIAlarmRulePaging\\": {\\n \\"TotalCount\\": 2,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"DIJobAlarmRules\\": [\\n {\\n \\"DIAlarmRuleId\\": 41998,\\n \\"DIJobId\\": 11260,\\n \\"Description\\": \\"mysql synchronizes to hologres heartbeat alert\\",\\n \\"MetricType\\": \\"Heartbeat\\",\\n \\"Enabled\\": true,\\n \\"TriggerConditions\\": [\\n {\\n \\"Severity\\": \\"Warning\\",\\n \\"Duration\\": 15,\\n \\"Threshold\\": 5\\n }\\n ],\\n \\"NotificationSettings\\": {\\n \\"NotificationChannels\\": [\\n {\\n \\"Severity\\": \\"Warning\\",\\n \\"Channels\\": [\\n \\"Ding\\"\\n ]\\n }\\n ],\\n \\"NotificationReceivers\\": [\\n {\\n \\"ReceiverType\\": \\"DingToken\\",\\n \\"ReceiverValues\\": [\\n \\"token1\\"\\n ]\\n }\\n ],\\n \\"InhibitionInterval\\": 5\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 74C2FECD-5B3A-554A-BCF5-351A36DE9815\\n \\n 2\\n 1\\n 10\\n \\n 41998\\n 11260\\n mysql同步到hologres心跳告警\\n Heartbeat\\n true\\n \\n Warning\\n 15\\n 5\\n \\n \\n \\n Warning\\n Ding\\n \\n \\n DingToken\\n token1\\n \\n 5\\n \\n \\n \\n","errorExample":""}]', - 'title' => 'ListDIAlarmRules', - 'description' => 'You can configure alert rules only for tasks that can be used for real-time data synchronization.'."\n", - ], - 'UpdateDIAlarmRule' => [ - 'summary' => 'Updates an alert rule for a new-version synchronization task. The following type of task is supported: real-time synchronization of all data in a MySQL database to Hologres.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '154892', - 'abilityTreeNodes' => [ - 'FEATUREdide39WW3A', - ], - ], - 'parameters' => [ - [ - 'name' => 'DIAlarmRuleId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The alert rule ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '34982', - ], - ], - [ - 'name' => 'Description', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The description of the alert rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mysql synchronizes to hologres heartbeat alert', - ], - ], - [ - 'name' => 'MetricType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The metric type in the alert rule. Valid values:'."\n" - ."\n" - .'* Heartbeat'."\n" - .'* FailoverCount'."\n" - .'* Delay'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [], - 'example' => 'Heartbeat', - ], - ], - [ - 'name' => 'TriggerConditions', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The conditions that are used to trigger the alert rule.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The condition that is used to trigger the alert rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'Severity' => [ - 'description' => 'The severity level. Valid values:'."\n" - ."\n" - .'* Warning'."\n" - .'* Critical'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Warning', - ], - 'Duration' => [ - 'description' => 'The time interval for alert calculation. Unit: minutes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '15', - ], - 'Threshold' => [ - 'description' => 'The alert threshold.'."\n" - ."\n" - .'* If the alert rule is for task status, you do not need to specify a threshold.'."\n" - .'* If the alert rule is for failovers, you must specify the number of failovers.'."\n" - .'* If the alert rule is for latency, you must specify the latency duration, in seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '5', - ], - ], - 'required' => false, - ], - 'required' => true, - ], - ], - [ - 'name' => 'NotificationSettings', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The alert notification settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'NotificationChannels' => [ - 'description' => 'The alert notification methods.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The alert notification method.'."\n", - 'type' => 'object', - 'properties' => [ - 'Severity' => [ - 'description' => 'The severity level. Valid values:'."\n" - ."\n" - .'* Warning'."\n" - .'* Critical'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Warning', - ], - 'Channels' => [ - 'description' => 'The alert notification methods.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The alert notification method. Valid values:'."\n" - ."\n" - .'* Mail: email'."\n" - .'* Phone: phone call'."\n" - .'* Sms: text message'."\n" - .'* Ding: DingTalk chatbot token'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Ding', - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => true, - ], - 'NotificationReceivers' => [ - 'description' => 'The settings of alert notification recipients.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The setting of an alert notification recipient.'."\n", - 'type' => 'object', - 'properties' => [ - 'ReceiverType' => [ - 'description' => 'The recipient type.'."\n" - ."\n" - .'* If the alert notification method is Mail, Phone, or Sms, the recipient type is the Alibaba Cloud account ID.'."\n" - .'* If the alert notification method is Ding, the recipient type is the DingTalk chatbot token.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'DingToken', - ], - 'ReceiverValues' => [ - 'description' => 'The recipients.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The recipient.'."\n" - ."\n" - .'* If the ReceiverType parameter is set to AliyunUid, set this parameter to the Alibaba Cloud account ID of a user.'."\n" - .'* If the ReceiverType parameter is set to DingToken, set this parameter to the token of a DingTalk chatbot.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'token1', - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => true, - ], - 'InhibitionInterval' => [ - 'description' => 'The duration of the alert suppression interval. Default value: 5. Unit: minutes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '5', - ], - ], - 'required' => true, - ], - ], - [ - 'name' => 'Enabled', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether to enable the alert rule. By default, the alert rule is disabled.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The returned result.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'A6C6B486-E3A2-5D52-9E76-D9380485D946', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A6C6B486-E3A2-5D52-9E76-D9380485D946\\"\\n}","errorExample":""},{"type":"xml","example":"\\n A6C6B486-E3A2-5D52-9E76-D9380485D946\\n","errorExample":""}]', - 'title' => 'UpdateDIAlarmRule', - 'description' => 'You can configure alert rules only for tasks that can be used for real-time data synchronization. You must update all fields in the alert rule.'."\n", - ], - 'QueryPublicModelEngine' => [ - 'summary' => 'Queries information about objects that are created in Data Modeling by using fast modeling language (FML) statements.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ - [ - 'name' => 'Text', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The FML statement that is used to query information about objects that are created in Data Modeling. For more information, see [Use FML statements to configure and manage data tables](~~298128~~). Only SHOW statements are supported.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'show dim tables', - ], - ], - [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to query the ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1234', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '4CFB2DED-7D9B-4C42-B4AA-CFF4991DFFF4', - ], - 'ReturnValue' => [ - 'description' => 'The returned information about objects.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The returned information about the object.'."\n", - 'type' => 'object', - 'example' => '', - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Valid.FML.NoPermission', - 'errorMessage' => 'You are not authorized to access the project resources.', - ], - [ - 'errorCode' => 'Valid.FML.OnlySupportQueryStatement', - 'errorMessage' => 'Only FML query statement is supported.', - ], - [ - 'errorCode' => 'Valid.FML.ProjectNotExist', - 'errorMessage' => 'The project does not exist.', - ], - [ - 'errorCode' => 'Valid.FML.StatementNotValid', - 'errorMessage' => 'The FML statement is invalid.', - ], - [ - 'errorCode' => 'Valid.FML.ProductExpired', - 'errorMessage' => '智能数据建模产品购买已到期', - ], - [ - 'errorCode' => 'Valid.FML.ProductNotActivated', - 'errorMessage' => '智能数据建模产品未开通', - ], - ], - 500 => [ - [ - 'errorCode' => 'Execute.FML.ProcessError', - 'errorMessage' => 'Failed to execute FML statement.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4CFB2DED-7D9B-4C42-B4AA-CFF4991DFFF4\\",\\n \\"ReturnValue\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 4CFB2DED-7D9B-4C42-B4AA-CFF4991DFFF4\\n \\n","errorExample":""}]', - 'title' => 'QueryPublicModelEngine', - 'description' => '* Each time you call this API operation, you must use FML statements to query information about objects that are created in Data Modeling.'."\n" - .'* The information about the objects can be queried by page, except for data layers, business processes, and data domains. You can add an offset to the end of an FML statement. The num LIMIT num statement specifies the offset when the information about the objects is queried, and the number of pages to return each time. The offset value must be a multiple of the number of pages.'."\n" - .'* A maximum of 1,000 entries can be returned each time you call this API operation.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => '## Response description'."\n" - ."\n" - .'### FML statement used to query data layers'."\n" - ."\n" - .'show layers; '."\n" - .'Response parameters'."\n" - ."\n" - .'|Parameter|Type|Example|Description|'."\n" - .'|---|---|---|---|'."\n" - .'|code|String|dws|The code of the data layer.|'."\n" - .'|englishName|String|dws|The name of the data layer.|'."\n" - .'|name|String|DWS layer|The display name of the data layer.|'."\n" - .'|ownerId|String|0123456|The owner ID.|'."\n" - .'|ownerName|String|A, B, C, and D|The name of the owner.|'."\n" - .'|description|String|Description of the DWS layer|The description of the data layer.|'."\n" - .'|uuid|String|obj-123456|The UUID of the data layer.|'."\n" - .'|gmtCreate|TimeStamp|1644397025000|The time when the data layer was created.|'."\n" - .'|gmtModified|TimeStamp|1644459965000|The time when the data layer was last modified.|'."\n" - .'|creatorId|String|0123456|The ID of the user who created the data layer.|'."\n" - .'|creatorName|String|A, B, C, and D|The name of the user who created the data layer.|'."\n" - .'|modifierId|String|0123456|The ID of the user who last modified the data layer.|'."\n" - .'|modifierName|String|A, B, C, and D|The name of the user who last modified the data layer.|'."\n" - ."\n" - .'### FML statement used to query data domains'."\n" - ."\n" - .'show domains; '."\n" - .'Response parameters'."\n" - ."\n" - .'|Parameter|Type|Example|Description|'."\n" - .'|---|---|---|---|'."\n" - .'|code|String|member|The code of the data domain.|'."\n" - .'|englishName|String|member|The name of the data domain.|'."\n" - .'|name|String|Member|The display name of the data domain.|'."\n" - .'|ownerId|String|0123456|The owner ID.|'."\n" - .'|ownerName|String|A, B, C, and D|The name of the owner.|'."\n" - .'|businessUnitCode|String|bu-123456|The code of the business unit.|'."\n" - .'|description|String|Description of the Member data domain|The description of the data domain.|'."\n" - .'|uuid|String|obj-123456|The UUID of the data domain.|'."\n" - .'|gmtCreate|TimeStamp|1644397025000|The time when the data domain was created.|'."\n" - .'|gmtModified|TimeStamp|1644459965000|The time when the data domain was last modified.|'."\n" - .'|creatorId|String|0123456|The ID of the user who created the data domain.|'."\n" - .'|creatorName|String|A, B, C, and D|The name of the user who created the data domain.|'."\n" - .'|modifierId|String|0123456|The ID of the user who last modified the data domain.|'."\n" - .'|modifierName|String|A, B, C, and D|The name of the user who last modified the data domain.|'."\n" - ."\n" - .'### FML statements used to query business processes'."\n" - ."\n" - .'* FML statement used to query business processes without configuring query conditions: show business\\_processes;'."\n" - .'* FML statement used to query a business process based on the code of the business process: show business\\_processes where code=\'bp-code\';'."\n" - .'* FML statement used to query business processes based on the code of a data domain: show business\\_processes where data\\_domain=\'dm-code\';'."\n" - ."\n" - .'Response parameters'."\n" - ."\n" - .'|Parameter|Type|Example|Description|'."\n" - .'|---|---|---|---|'."\n" - .'|code|String|bp-123456|The code of the business process.|'."\n" - .'|englishName|String|pay|The name of the business process.|'."\n" - .'|name|String|Payment|The display name of the business process.|'."\n" - .'|dataDomainCode|String|trade|The code of the data domain to which the business process belongs.|'."\n" - .'|dataDomainName|String|Transaction|The display name of the data domain to which the business process belongs.|'."\n" - .'|dataDomainUuid|String|dm-123456|The UUID of the data domain to which the business process belongs.|'."\n" - .'|ownerId|String|0123456|The owner ID.|'."\n" - .'|ownerName|String|A, B, C, and D|The name of the owner.|'."\n" - .'|description|String|Payment|The description of the business process.|'."\n" - .'|source|Integer|2|The source of the business process. Valid values:1: indicates that the business process is created by the system.2: indicates that the business process is created by a user.|'."\n" - .'|uuid|String|obj-123456|The UUID of the business process.|'."\n" - .'|gmtCreate|TimeStamp|1644397025000|The time when the business process was created.|'."\n" - .'|gmtModified|TimeStamp|1644459965000|The time when the business process was last modified.|'."\n" - .'|creatorId|String|creatorId|The ID of the user who created the business process.|'."\n" - .'|creatorName|String|A, B, C, and D|The name of the user who created the business process.|'."\n" - .'|modifierId|String|0123456|The ID of the user who last modified the business process.|'."\n" - .'|modifierName|String|A, B, C, and D|The name of the user who last modified the business process.|'."\n" - ."\n" - .'### FML statements used to query business categories'."\n" - ."\n" - .'```'."\n" - .' show business_categories;'."\n" - .' show business_categories where code=\'code\';'."\n" - .' show business_categories where keyword=\'keyword\';'."\n" - .' show business_categories where uuid=\'uuid\'; '."\n" - .'```'."\n" - ."\n" - .'Response parameters'."\n" - ."\n" - .'|Parameter|Type|Example|Description|'."\n" - .'|---|---|---|---|'."\n" - .'|categoryDetail|DirectoryDetailDTO|{"uuid": "cate\\_uuid", "code": "trd", "name": "Transaction"}|The details of the business category.|'."\n" - .'|name|String|E-commerce|The name of the directory.|'."\n" - .'|detailType|String|DICT|The type of the directory.|'."\n" - .'|parentUuid|String|dy-123456|The UUID of the parent directory.|'."\n" - .'|description|String|Description|The description of the directory.|'."\n" - .'|code|String|ind|The code of the business category.|'."\n" - .'|dataDomains|List|\\[{"uuid": "domain1", "code": "trd", "name": "Transaction data domain"}\\]|The data domains that are associated with the business category.|'."\n" - .'|ownerId|String|0123456|The owner ID.|'."\n" - .'|ownerName|String|A, B, C, and D|The name of the owner.|'."\n" - .'|businessUnitCode|String|bu-123456|The code of the business unit.|'."\n" - .'|description|String|Description|The description of the directory.|'."\n" - .'|categoryPath|String|tm.ind|The path of the business category.|'."\n" - ."\n" - .'### FML statement used to query data marts'."\n" - ."\n" - .'show markets; Response parameters'."\n" - ."\n" - .'|Parameter|Type|Example|Description|'."\n" - .'|---|---|---|---|'."\n" - .'|categoryDetail|DirectoryDetailDTO|{"uuid": "cate\\_uuid", "code": "trd", "name": "Transaction"}|The details of the data mart.|'."\n" - .'|name|String|E-commerce|The name of the directory.|'."\n" - .'|detailType|String|DICT|The type of the directory.|'."\n" - .'|parentUuid|String|dy-123456|The UUID of the parent directory.|'."\n" - .'|description|String|Description|The description of the directory.|'."\n" - .'|code|String|ind|The code of the business category.|'."\n" - .'|subDetailType|String|common|The subtype of the directory.|'."\n" - .'|auditDTOList|List|\\[{"baseId":"123","showName":"test"}\\]|The reviewers.|'."\n" - .'|code|String|member|The code of the data domain.|'."\n" - .'|englishName|String|member|The name of the data domain.|'."\n" - .'|name|String|Member|The display name of the data domain.|'."\n" - .'|ownerId|String|0123456|The owner ID.|'."\n" - .'|ownerName|String|A, B, C, and D|The name of the owner.|'."\n" - .'|businessUnitCode|String|bu-123456|The code of the business unit.|'."\n" - .'|description|String|Description of the Member data domain|The description of the data domain.|'."\n" - .'|auditDTOList|List|\\[{"baseId":"123","showName":"test"}\\]|The reviewers.|'."\n" - .'|categoryPath|String|tm.ind|The path of the business category.|'."\n" - ."\n" - .'### FML statement used to query subject areas'."\n" - ."\n" - .'show subjects; Response parameters'."\n" - ."\n" - .'|Parameter|Type|Example|Description|'."\n" - .'|---|---|---|---|'."\n" - .'|categoryDetail|DirectoryDetailDTO|{"uuid": "cate\\_uuid", "code": "trd", "name": "Transaction"}|The details of the subject area.|'."\n" - .'|name|String|E-commerce|The name of the directory.|'."\n" - .'|detailType|String|DICT|The type of the directory.|'."\n" - .'|parentUuid|String|dy-123456|The UUID of the parent directory.|'."\n" - .'|description|String|Description|The description of the directory.|'."\n" - .'|code|String|ind|The code of the business category.|'."\n" - .'|subDetailType|String|common|The subtype of the directory.|'."\n" - .'|auditDTOList|List|\\[{"baseId":"123","showName":"test"}\\]|The reviewers.|'."\n" - .'|code|String|member|The code of the data domain.|'."\n" - .'|englishName|String|member|The name of the data domain.|'."\n" - .'|name|String|Member|The display name of the data domain.|'."\n" - .'|ownerId|String|0123456|The owner ID.|'."\n" - .'|ownerName|String|A, B, C, and D|The name of the owner.|'."\n" - .'|businessUnitCode|String|bu-123456|The code of the business unit.|'."\n" - .'|description|String|Description of the Member data domain|The description of the subject area.|'."\n" - .'|auditDTOList|List|\\[{"baseId":"123","showName":"test"}\\]|The reviewers.|'."\n" - .'|categoryPath|String|tm.ind|The path of the business category.|'."\n" - ."\n" - .'### FML statement used to query data standard sets'."\n" - ."\n" - .'show dict groups; Response parameters'."\n" - ."\n" - .'|Parameter|Type|Example|Description|'."\n" - .'|---|---|---|---|'."\n" - .'|name|String|E-commerce|The name of the directory.|'."\n" - .'|detailType|String|DICT|The type of the directory.|'."\n" - .'|parentUuid|String|dy-123456|The UUID of the parent directory.|'."\n" - .'|description|String|Description|The description of the directory.|'."\n" - .'|code|String|ind|The code of the business category.|'."\n" - .'|uuid|List|obj-123456|The UUID of the data standard set.|'."\n" - .'|gmtCreate|TimeStamp|1644397025000|The time when the data standard set was created.|'."\n" - .'|gmtModified|TimeStamp|1644459965000|The time when the data standard set was last modified.|'."\n" - .'|creatorId|String|0123456|The ID of the user who created the data standard set.|'."\n" - .'|creatorName|String|A, B, C, and D|The name of the user who created the data standard set.|'."\n" - .'|modifierId|String|0123456|The ID of the user who last modified the data standard set.|'."\n" - .'|modifierName|String|A, B, C, and D|The name of the user who last modified the data standard set.|'."\n" - ."\n" - .'### FML statement used to query data standards'."\n" - ."\n" - .'show dicts; Response parameters'."\n" - ."\n" - .'|Parameter|Type|Example|Description|'."\n" - .'|---|---|---|---|'."\n" - .'|code|String|shop\\_type|The abbreviation for the name of the data standard.|'."\n" - .'|englishName|String|shop type|The name of the data standard.|'."\n" - .'|name|String|Shop type|The display name of the data standard.|'."\n" - .'|no|String|SN00001|The data standard ID.|'."\n" - .'|dataType|String|STRING|The data type of the fields that use the data standard.|'."\n" - .'|length|Integer|10|The maximum number of digits in the values of the fields that use the data standard.|'."\n" - .'|numericalPrecision|Integer|2|The number of decimal places that are retained in the values of the fields that use the data standard.|'."\n" - .'|notNull|Boolean|false|Indicates whether the values of the fields that use the data standard can be non-null.|'."\n" - .'|defaultValue|String|Flagship shop|The default value.|'."\n" - .'|parentNo|String|SN0001|The ID of the parent data standard.|'."\n" - .'|parentName|String|Shop|The name of the parent data standard.|'."\n" - .'|codeTableNo|String|shop\\_type|The code of the lookup table that defines the value range of the fields that use the data standard.|'."\n" - .'|codeTableName|String|Shop type|The name of the lookup table that defines the value range of the fields that use the data standard.|'."\n" - .'|codeTableUuid|String|tb-0001|The UUID of the lookup table that defines the value range of the fields that use the data standard.|'."\n" - .'|directoryUuid|String|Directory UUID|The UUID of the directory in which the data standard is stored.|'."\n" - .'|directoryName|String|Shop directory|The name of the directory in which the data standard is stored.|'."\n" - .'|description|String|remark|The description of the data standard.|'."\n" - .'|uuid|String|obj-123456|The UUID of the data standard.|'."\n" - .'|gmtCreate|TimeStamp|1644397025000|The time when the data standard was created.|'."\n" - .'|gmtModified|TimeStamp|1644459965000|The time when the data standard was last modified.|'."\n" - .'|creatorId|String|0123456|The ID of the user who created the data standard.|'."\n" - .'|creatorName|String|A, B, C, and D|The name of the user who created the data standard.|'."\n" - .'|modifierId|String|0123456|The ID of the user who last modified the data standard.|'."\n" - .'|modifierName|String|A, B, C, and D|The name of the user who last modified the data standard.|'."\n" - ."\n" - .'### FML statement used to query lookup tables'."\n" - ."\n" - .'show code tables; Response parameters'."\n" - ."\n" - .'|Parameter|Type|Example|Description|'."\n" - .'|---|---|---|---|'."\n" - .'|code|String|shop\\_type|The code of the lookup table.|'."\n" - .'|name|String|Shop type|The display name of the lookup table.|'."\n" - .'|extendName|String|shop type|The name of the lookup table.|'."\n" - .'|description|String|remark|The description of the lookup table.|'."\n" - .'|uuid|String|obj-123456|The UUID of the lookup table.|'."\n" - .'|gmtCreate|TimeStamp|1644397025000|The time when the lookup table was created.|'."\n" - .'|gmtModified|TimeStamp|1644459965000|The time when the lookup table was last modified.|'."\n" - .'|creatorId|String|0123456|The ID of the user who created the lookup table.|'."\n" - .'|creatorName|String|A, B, C, and D|The name of the user who created the lookup table.|'."\n" - .'|modifierId|String|0123456|The ID of the user who last modified the lookup table.|'."\n" - .'|modifierName|String|A, B, C, and D|The name of the user who last modified the lookup table.|'."\n" - ."\n" - .'### FML statement used to query measurement unit groups'."\n" - ."\n" - .'show measure\\_unit groups; Response parameters'."\n" - ."\n" - .'|Parameter|Type|Example|Description|'."\n" - .'|---|---|---|---|'."\n" - .'|name|String|E-commerce|The name of the directory.|'."\n" - .'|detailType|String|DICT|The type of the directory.|'."\n" - .'|parentUuid|String|dy-123456|The UUID of the parent directory.|'."\n" - .'|description|String|Description|The description of the directory.|'."\n" - .'|code|String|ind|The code of the business category.|'."\n" - .'|uuid|String|obj-123456|The UUID of the measurement unit group.|'."\n" - .'|gmtCreate|TimeStamp|1644397025000|The time when the measurement unit group was created.|'."\n" - .'|gmtModified|TimeStamp|1644459965000|The time when the measurement unit group was last modified.|'."\n" - .'|creatorId|String|0123456|The ID of the user who created the measurement unit group.|'."\n" - .'|creatorName|String|A, B, C, and D|The name of the user who created the measurement unit group.|'."\n" - .'|modifierId|String|0123456|The ID of the user who last modified the measurement unit group.|'."\n" - .'|modifierName|String|A, B, C, and D|The name of the user who last modified the measurement unit group.|'."\n" - ."\n" - .'### FML statement used to query measurement units'."\n" - ."\n" - .'show measure\\_units; Response parameters'."\n" - ."\n" - .'|Parameter|Type|Example|Description|'."\n" - .'|---|---|---|---|'."\n" - .'|code|String|yuan|The abbreviation for the name of the measurement unit.|'."\n" - .'|englishName|String|RMB|The name of the measurement unit.|'."\n" - .'|name|String|Yuan|The display name of the measurement unit.|'."\n" - .'|directoryUuid|String|di-0001|The UUID of the measurement unit group to which the measurement unit belongs.|'."\n" - .'|directoryName|String|Currency|The name of the measurement unit group to which the measurement unit belongs.|'."\n" - .'|description|String|remark|The description of the measurement unit.|'."\n" - .'|uuid|String|obj-123456|The UUID of the measurement unit.|'."\n" - .'|gmtCreate|TimeStamp|1644397025000|The time when the measurement unit was created.|'."\n" - .'|gmtModified|TimeStamp|1644459965000|The time when the measurement unit was last modified.|'."\n" - .'|creatorId|String|0123456|The ID of the user who created the measurement unit.|'."\n" - .'|creatorName|String|A, B, C, and D|The name of the user who created the measurement unit.|'."\n" - .'|modifierId|String|0123456|The ID of the user who last modified the measurement unit.|'."\n" - .'|modifierName|String|A, B, C, and D|The name of the user who last modified the measurement unit.|'."\n" - ."\n" - .'### FML statement used to query the data of a lookup table'."\n" - ."\n" - .'show codes from code\\_table; Response parameters'."\n" - ."\n" - .'|Parameter|Type|Example|Description|'."\n" - .'|---|---|---|---|'."\n" - .'|codeContent|String|0|The content of the lookup table.|'."\n" - .'|extendNameContent|String|female|The display name of the lookup table.|'."\n" - .'|nameContent|String|Female|The name of the lookup table.|'."\n" - .'|description|String|remark|The description of the lookup table.|'."\n" - .'|uuid|String|obj-123456|The UUID of the lookup table.|'."\n" - .'|gmtCreate|TimeStamp|1644397025000|The time when the lookup table was created.|'."\n" - .'|gmtModified|TimeStamp|1644459965000|The time when the lookup table was last modified.|'."\n" - .'|creatorId|String|0123456|The ID of the user who created the lookup table.|'."\n" - .'|creatorName|String|A, B, C, and D|The name of the user who created the lookup table.|'."\n" - .'|modifierId|String|0123456|The ID of the user who last modified the lookup table.|'."\n" - .'|modifierName|String|A, B, C, and D|The name of the user who last modified the lookup table.|'."\n" - ."\n" - .'### FML statement used to query naming dictionaries'."\n" - ."\n" - .'show naming dicts; Response parameters'."\n" - ."\n" - .'|Parameter|Type|Example|Description|'."\n" - .'|---|---|---|---|'."\n" - .'|code|String|shop|The abbreviation for the name of the naming dictionary.|'."\n" - .'|creatorId|String|0123456|The ID of the user who created the naming dictionary.|'."\n" - .'|creatorName|String|A, B, C, and D|The name of the user who created the naming dictionary.|'."\n" - .'|extendName|String|shop|The name of the naming dictionary.|'."\n" - .'|gmtCreate|TimeStamp|1644397025000|The time when the naming dictionary was created.|'."\n" - .'|gmtModified|TimeStamp|1644459965000|The time when the naming dictionary was last modified.|'."\n" - .'|modifierId|String|0123456|The ID of the user who last modified the naming dictionary.|'."\n" - .'|modifierName|String|A, B, C, and D|The name of the user who last modified the naming dictionary.|'."\n" - .'|name|String|Shop|The display name of the naming dictionary.|'."\n" - .'|ownerId|String|0123456|The owner ID.|'."\n" - .'|ownerName|String|A, B, C, and D|The name of the owner.|'."\n" - .'|uuid|String|obj-123456|The UUID of the naming dictionary.|'."\n" - ."\n" - .'### FML statement used to query tables'."\n" - ."\n" - .'show tables; Response parameters'."\n" - ."\n" - .'|Parameter|Type|Example|Description|'."\n" - .'|---|---|---|---|'."\n" - .'|code|String|dim\\_shop|The code of the table.|'."\n" - .'|name|String|Shop table|The display name of the table.|'."\n" - .'|type|Integer|1|The type of the table. Valid values:0: fact table1: dimension table3: aggregate table4: application table5: ODS table6: dimension|'."\n" - .'|detailType|String|normal|The subtype of the table. Valid values:Common dimension tableEnumeration dimension tableTransaction fact table|'."\n" - .'|businessProcessUuid|String|bp-123456|The UUID of the business process.|'."\n" - .'|businessUnitUuid|String|bu-123456|The UUID of the business unit.|'."\n" - .'|dataWarehouseLayerUuid|String|ly-123456|The UUID of the data layer.|'."\n" - .'|businessCategoryUuid|String|bc-123456|The UUID of the business category.|'."\n" - .'|ownerId|String|0123456|The owner ID.|'."\n" - .'|ownerName|String|A, B, C, and D|The name of the owner.|'."\n" - .'|description|String|Description|The description of the table.|'."\n" - .'|config|String|JSON string|The extended configurations for the table.|'."\n" - .'|lifeCycle|Integer|365|The lifecycle of the table.|'."\n" - .'|uuid|String|obj-123456|The UUID of the table.|'."\n" - .'|gmtCreate|TimeStamp|1644397025000|The time when the table was created.|'."\n" - .'|gmtModified|TimeStamp|1644459965000|The time when the table was last modified.|'."\n" - .'|creatorId|String|0123456|The ID of the user who created the table.|'."\n" - .'|creatorName|String|A, B, C, and D|The name of the user who created the table.|'."\n" - .'|modifierId|String|0123456|The ID of the user who last modified the table.|'."\n" - .'|modifierName|String|A, B, C, and D|The name of the user who last modified the table.|'."\n" - ."\n" - .'### FML statement used to query dimension tables'."\n" - ."\n" - .'show dim tables; '."\n" - .'Response parameters'."\n" - ."\n" - .'|Parameter|Type|Example|Description|'."\n" - .'|---|---|---|---|'."\n" - .'|code|String|dim\\_shop|The code of the dimension table.|'."\n" - .'|name|String|Shop table|The display name of the dimension table.|'."\n" - .'|type|Integer|1|The type of the table. Valid values:0: fact table1: dimension table|'."\n" - .'|detailType|String|normal|The subtype of the table. Valid values:Common dimension tableEnumeration dimension table|'."\n" - .'|businessProcessUuid|String|bp-123456|The UUID of the business process.|'."\n" - .'|businessUnitUuid|String|bu-123456|The UUID of the business unit.|'."\n" - .'|dataWarehouseLayerUuid|String|ly-123456|The UUID of the data layer.|'."\n" - .'|businessCategoryUuid|String|bc-123456|The UUID of the business category.|'."\n" - .'|ownerId|String|0123456|The owner ID.|'."\n" - .'|ownerName|String|A, B, C, and D|The name of the owner.|'."\n" - .'|description|String|Description|The description of the dimension table.|'."\n" - .'|config|String|JSON string|The extended configurations for the dimension table.|'."\n" - .'|lifeCycle|Integer|365|The lifecycle of the dimension table.|'."\n" - .'|uuid|String|obj-123456|The UUID of the dimension table.|'."\n" - .'|gmtCreate|TimeStamp|1644397025000|The time when the dimension table was created.|'."\n" - .'|gmtModified|TimeStamp|1644459965000|The time when the dimension table was last modified.|'."\n" - .'|creatorId|String|0123456|The ID of the user who created the dimension table.|'."\n" - .'|creatorName|String|A, B, C, and D|The name of the user who created the dimension table.|'."\n" - .'|modifierId|String|0123456|The ID of the user who last modified the dimension table.|'."\n" - .'|modifierName|String|A, B, C, and D|The name of the user who last modified the dimension table.|'."\n" - ."\n" - .'### FML statement used to query fact tables'."\n" - ."\n" - .'show fact tables; Response parameters'."\n" - ."\n" - .'|Parameter|Type|Example|Description|'."\n" - .'|---|---|---|---|'."\n" - .'|code|String|dim\\_shop|The code of the fact table.|'."\n" - .'|name|String|Shop table|The display name of the fact table.|'."\n" - .'|type|Integer|1|The type of the table. Valid values:0: fact table1: dimension table|'."\n" - .'|detailType|String|normal|The subtype of the table. Only transaction fact tables are supported.|'."\n" - .'|businessProcessUuid|String|bp-123456|The UUID of the business process.|'."\n" - .'|businessUnitUuid|String|bu-123456|The UUID of the business unit.|'."\n" - .'|dataWarehouseLayerUuid|String|ly-123456|The UUID of the data layer.|'."\n" - .'|businessCategoryUuid|String|bc-123456|The UUID of the business category.|'."\n" - .'|ownerId|String|0123456|The owner ID.|'."\n" - .'|ownerName|String|A, B, C, and D|The name of the owner.|'."\n" - .'|description|String|Description|The description of the fact table.|'."\n" - .'|config|String|JSON string|The extended configurations for the fact table.|'."\n" - .'|lifeCycle|Integer|365|The lifecycle of the fact table.|'."\n" - .'|uuid|String|obj-123456|The UUID of the fact table.|'."\n" - .'|gmtCreate|TimeStamp|1644397025000|The time when the fact table was created.|'."\n" - .'|gmtModified|TimeStamp|1644459965000|The time when the fact table was last modified.|'."\n" - .'|creatorId|String|0123456|The ID of the user who created the fact table.|'."\n" - .'|creatorName|String|A, B, C, and D|The name of the user who created the fact table.|'."\n" - .'|modifierId|String|0123456|The ID of the user who last modified the fact table.|'."\n" - .'|modifierName|String|A, B, C, and D|The name of the user who last modified the fact table.|'."\n" - ."\n" - .'### FML statement used to query aggregate tables'."\n" - ."\n" - .'show dws tables; Response parameters'."\n" - ."\n" - .'|Parameter|Type|Example|Description|'."\n" - .'|---|---|---|---|'."\n" - .'|dataDomainUuid|String|dm-12345|The UUID of the data domain.|'."\n" - .'|dataDomainCode|String|member|The code of the data domain.|'."\n" - .'|dataDomainName|String|Member|The name of the data domain.|'."\n" - .'|timePeriods|List|\\[{"uuid": "uuid", "code": "code", "name": "Display name"}\\]|The periods for the aggregate table.|'."\n" - .'|uuid|String|obj-123456|The UUID of the aggregate table.|'."\n" - .'|code|String|dws\\_001|The name of the aggregate table.|'."\n" - .'|name|String|Payment aggregate table|The display name of the aggregate table.|'."\n" - .'|adjuncts|List|\\[{"uuid": "uuid", "code": "code", "name": "Display name"}\\]|The modifiers for the aggregate table.|'."\n" - .'|dimensions|List|\\[{"uuid": "uuid", "code": "code", "name": "Display name"}\\]|The dimensions that are associated with the aggregate table.|'."\n" - .'|bizEntityUuid|String|dim-123456|The UUID of the business object.|'."\n" - .'|bizEntityCode|String|dim\\_shop|The abbreviation for the name of the business object.|'."\n" - .'|bizEntityName|String|Shop table|The display name of the business object.|'."\n" - .'|relUuid|String|dim\\_a-123456|The UUID of the dimension that is associated with the aggregate table.|'."\n" - .'|type|Integer|3|The type of the table. Only 3 (aggregate table) is supported.|'."\n" - .'|detailType|String|dws\\_normal|The subtype of the table. Valid values:dws\\_normal: single-granularity aggregate tabledws\\_advanced: multi-granularity aggregate table|'."\n" - .'|businessProcessUuid|String|bp-123456|The UUID of the business process.|'."\n" - .'|businessUnitUuid|String|bu-123456|The UUID of the business unit.|'."\n" - .'|dataWarehouseLayerUuid|String|ly-123456|The UUID of the data layer.|'."\n" - .'|businessCategoryUuid|String|bc-123456|The UUID of the business category.|'."\n" - .'|ownerId|String|0123456|The owner ID.|'."\n" - .'|ownerName|String|A, B, C, and D|The name of the owner.|'."\n" - .'|description|String|Description|The description of the aggregate table.|'."\n" - .'|config|String|JSON string|The extended configurations for the aggregate table.|'."\n" - .'|lifeCycle|Integer|365|The lifecycle of the aggregate table.|'."\n" - .'|gmtCreate|TimeStamp|1644397025000|The time when the aggregate table was created.|'."\n" - .'|gmtModified|TimeStamp|1644459965000|The time when the aggregate table was last modified.|'."\n" - .'|creatorId|String|0123456|The ID of the user who created the aggregate table.|'."\n" - .'|creatorName|String|A, B, C, and D|The name of the user who created the aggregate table.|'."\n" - .'|modifierId|String|0123456|The ID of the user who last modified the aggregate table.|'."\n" - .'|modifierName|String|A, B, C, and D|The name of the user who last modified the aggregate table.|'."\n" - ."\n" - .'### FML statement used to query application tables'."\n" - ."\n" - .'show ads tables; Response parameters'."\n" - ."\n" - .'|Parameter|Type|Example|Description|'."\n" - .'|---|---|---|---|'."\n" - .'|dataDomainUuid|String|dm-12345|The UUID of the data domain.|'."\n" - .'|dataDomainCode|String|member|The code of the data domain.|'."\n" - .'|dataDomainName|String|Member|The name of the data domain.|'."\n" - .'|timePeriods|List|\\[{"uuid": "uuid", "code": "code", "name": "Display name"}\\]|The periods for the application table.|'."\n" - .'|uuid|String|obj-123456|The UUID of the application table.|'."\n" - .'|code|String|dws\\_001|The name of the application table.|'."\n" - .'|name|String|Payment application table|The display name of the application table.|'."\n" - .'|adjuncts|List|\\[{"uuid": "uuid", "code": "code", "name": "Display name"}\\]|The modifiers for the application table.|'."\n" - .'|dimensions|List|\\[{"uuid": "uuid", "code": "code", "name": "Display name"}\\]|The dimensions that are associated with the application table.|'."\n" - .'|bizEntityUuid|String|dim-123456|The UUID of the business object.|'."\n" - .'|bizEntityCode|String|dim\\_shop|The abbreviation for the name of the business object.|'."\n" - .'|bizEntityName|String|Shop table|The display name of the business object.|'."\n" - .'|relUuid|String|dim\\_a-123456|The UUID of the dimension that is associated with the application table.|'."\n" - .'|type|Integer|1|The type of the table. Valid values:0: fact table1: dimension table4: application table|'."\n" - .'|detailType|String|normal|The subtype of the table. Valid values:Common dimension tableEnumeration dimension tableTransaction fact table|'."\n" - .'|businessProcessUuid|String|bp-123456|The UUID of the business process.|'."\n" - .'|businessUnitUuid|String|bu-123456|The UUID of the business unit.|'."\n" - .'|dataWarehouseLayerUuid|String|ly-123456|The UUID of the data layer.|'."\n" - .'|businessCategoryUuid|String|bc-123456|The UUID of the business category.|'."\n" - .'|ownerId|String|0123456|The owner ID.|'."\n" - .'|ownerName|String|A, B, C, and D|The name of the owner.|'."\n" - .'|description|String|Description|The description of the application table.|'."\n" - .'|config|String|JSON string|The extended configurations for the application table.|'."\n" - .'|lifeCycle|Integer|365|The lifecycle of the application table.|'."\n" - .'|gmtCreate|TimeStamp|1644397025000|The time when the application table was created.|'."\n" - .'|gmtModified|TimeStamp|1644459965000|The time when the application table was last modified.|'."\n" - .'|creatorId|String|0123456|The ID of the user who created the application table.|'."\n" - .'|creatorName|String|A, B, C, and D|The name of the user who created the application table.|'."\n" - .'|modifierId|String|0123456|The ID of the user who last modified the application table.|'."\n" - .'|modifierName|String|A, B, C, and D|The name of the user who last modified the application table.|'."\n" - ."\n" - .'### FML statement used to query tables and return the fields of each table'."\n" - ."\n" - .'show full tables; Response parameters'."\n" - ."\n" - .'|Parameter|Type|Example|Description|'."\n" - .'|---|---|---|---|'."\n" - .'|tableUuid|String|tb-123456|The UUID of the table.|'."\n" - .'|tableCode|String|dim\\_shop|The code of the table.|'."\n" - .'|tableName|String|Shop table|The name of the table.|'."\n" - .'|columnCode|String|shop\\_id|The code of the column.|'."\n" - .'|columnName|String|Shop ID|The name of the column.|'."\n" - .'|columnUuid|String|col-123456|The UUID of the column.|'."\n" - .'|columnType|String|STRING|The data type of the column.|'."\n" - .'|columnCategory|String|ATTRIBUTE|The type of the column.|'."\n" - ."\n" - .'### FML statement used to query information about the columns of a table'."\n" - ."\n" - .'show columns from table\\_code; Response parameters'."\n" - ."\n" - .'|Parameter|Type|Example|Description|'."\n" - .'|---|---|---|---|'."\n" - .'|code|String|seller\\_id|The code of the column.|'."\n" - .'|name|String|Seller ID|The display name of the column.|'."\n" - .'|dataType|String|STRING|The data type of the column.|'."\n" - .'|type|String|ATTRIBUTE|The type of the field.|'."\n" - .'|isPrimaryKey|Boolean|false|Indicates whether the field is a primary key column.|'."\n" - .'|isPartitionKey|Boolean|false|Indicates whether the field is a partition key column.|'."\n" - .'|partitionOrder|Integer|1|The order of the partition key column.|'."\n" - .'|notNull|Boolean|true|Indicates whether the field is non-null.|'."\n" - .'|dataDictionaryUuid|String|member\\_id|The UUID of the data dictionary.|'."\n" - .'|dataDictionaryCode|String|Member ID|The name of the data dictionary.|'."\n" - .'|codeTableUuid|String|cd-123456|The UUID of the associated lookup table.|'."\n" - .'|codeTableCode|String|sex|The code of the associated lookup table.|'."\n" - .'|codeTableName|String|Gender|The name of the associated lookup table.|'."\n" - .'|measureUnitCode|String|percent|The code of the associated measurement unit.|'."\n" - .'|measureUnitName|String|Percent|The name of the associated measurement unit.|'."\n" - .'|sourceProjectName|String|autotest|The name of the source workspace.|'."\n" - .'|sourceTableCode|String|dict|The code of the source table.|'."\n" - .'|sourceColumnCode|String|age|The code of the source field.|'."\n" - .'|sourceRelationTag|String|label|The tag of the source relationship.|'."\n" - .'|description|String|Description|The description of the field.|'."\n" - .'|orderId|String|1|The order of the field.|'."\n" - .'|columnGroupName|Integer|col\\_group\\_1|The name of the group to which the field belongs.|'."\n" - .'|config|String|JSON string|The extended configurations for the field.|'."\n" - .'|uuid|String|obj-123456|The UUID of the field.|'."\n" - .'|gmtCreate|TimeStamp|1644397025000|The time when the field was created.|'."\n" - .'|gmtModified|TimeStamp|1644459965000|The time when the field was last modified.|'."\n" - .'|creatorId|String|0123456|The ID of the user who created the field.|'."\n" - .'|creatorName|String|A, B, C, and D|The name of the user who created the field.|'."\n" - .'|modifierId|String|0123456|The ID of the user who last modified the field.|'."\n" - .'|modifierName|String|A, B, C, and D|The name of the user who last modified the field.|'."\n" - ."\n" - .'### FML statement used to query modifiers'."\n" - ."\n" - .'show adjuncts; Response parameters'."\n" - ."\n" - .'|Parameter|Type|Example|Description|'."\n" - .'|---|---|---|---|'."\n" - .'|businessUnitUuid|String|bu-123456|The UUID of the business unit.|'."\n" - .'|businessUnitCode|String|test\\_bu|The code of the business unit.|'."\n" - .'|businessUnitName|String|Test|The name of the business unit.|'."\n" - .'|dataDomainUuid|String|dt-123456|The UUID of the data domain.|'."\n" - .'|dataDomainCode|String|member|The code of the data domain.|'."\n" - .'|dataDomainName|String|Member|The name of the data domain.|'."\n" - .'|categoryUuid|String|cy-123456|The UUID of the business category.|'."\n" - .'|categoryCode|String|trade|The code of the business category.|'."\n" - .'|categoryName|String|E-commerce|The name of the business category.|'."\n" - .'|type|AdjunctTypeEnum|DIM\\_VAL|The type of the modifier.|'."\n" - .'|code|String|beauty|The abbreviation for the name of the modifier.|'."\n" - .'|name|String|Makeup|The display name of the modifier.|'."\n" - .'|extendName|String|beauty|The name of the modifier.|'."\n" - .'|description|String|Description|The description of the modifier.|'."\n" - .'|bizExpression|String|Statistical criterion|The statistical criterion of the modifier.|'."\n" - .'|expression|String|beauty = 1|The expression of the modifier.|'."\n" - .'|bizEntityUuid|String|dim-123456|The UUID of the business object.|'."\n" - .'|bizEntityCode|String|dim\\_shop|The abbreviation for the name of the business object.|'."\n" - .'|bizEntityName|String|Shop table|The display name of the business object.|'."\n" - .'|relUuid|String|dim\\_a-123456|The UUID of the dimension that is associated with the modifier.|'."\n" - .'|ownerId|String|0123456|The owner ID.|'."\n" - .'|ownerName|String|A, B, C, and D|The name of the owner.|'."\n" - .'|isDeleted|DeleteTagEnum|NO|Indicates whether the modifier is deleted.|'."\n" - .'|uuid|String|obj-123456|The UUID of the modifier.|'."\n" - .'|gmtCreate|TimeStamp|1644397025000|The time when the modifier was created.|'."\n" - .'|gmtModified|TimeStamp|1644459965000|The time when the modifier was last modified.|'."\n" - .'|creatorId|String|0123456|The ID of the user who created the modifier.|'."\n" - .'|creatorName|String|A, B, C, and D|The name of the user who created the modifier.|'."\n" - .'|modifierId|String|0123456|The ID of the user who last modified the modifier.|'."\n" - .'|modifierName|String|A, B, C, and D|The name of the user who last modified the modifier.|'."\n" - ."\n" - .'### FML statement used to query periods'."\n" - ."\n" - .'show time\\_periods; Response parameters'."\n" - ."\n" - .'|Parameter|Type|Example|Description|'."\n" - .'|---|---|---|---|'."\n" - .'|businessUnitUuid|String|bu-123456|The UUID of the business unit to which the period belongs.|'."\n" - .'|businessUnitCode|String|test\\_bu|The code of the business unit.|'."\n" - .'|type|TimePeriodTypeEnum|DAY|The type of the period.|'."\n" - .'|typeName|String|Day|The name of the type of the period.|'."\n" - .'|code|String|1d|The abbreviation for the name of the period.|'."\n" - .'|name|String|One day|The display name of the period.|'."\n" - .'|extendName|String|1d|The name of the period.|'."\n" - .'|description|String|Description|The description of the period.|'."\n" - .'|isDeleted|DeleteTagEnum|NO|Indicates whether the period is deleted.|'."\n" - .'|timeBegin|String|start\\_expression|The expression for the start time.|'."\n" - .'|timeEnd|String|end\\_expression|The expression for the end time.|'."\n" - .'|gmtCreate|TimeStamp|1633885261000|The time when the period was created.|'."\n" - .'|gmtModified|TimeStamp|1633885261000|The time when the period was last modified.|'."\n" - .'|modifierId|String|0123456|The ID of the user who last modified the period.|'."\n" - .'|modifierName|String|A, B, C, and D|The name of the user who last modified the period.|'."\n" - .'|ownerId|String|0123456|The owner ID.|'."\n" - .'|ownerName|String|A, B, C, and D|The name of the owner.|'."\n" - .'|beginOffset|Integer|1|The offset of the start time.|'."\n" - .'|endOffset|Integer|1|The offset of the end time.|'."\n" - .'|firstDay|Integer|1|The first day of the period. This parameter is returned if the type of the period is set to WEEK, MONTH, QUARTER, or YEAR. Valid values if the type of the period is set to WEEK: 1 to 7, which indicate Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, and Saturday. Valid values if the type of the period is set to MONTH: 1, 99, and 2 to 27. The value 1 indicates the first day of the month, the value 99 indicates the end of the month, and values from 2 to 27 indicate the 2nd to 27th days of the month. Valid values if the type of the period is set to QUARTER: 0 to 11, which indicate January to December. Valid values if the type of the period is set to YEAR: 0 to 11, which indicate January to December.|'."\n" - .'|uuid|String|obj-123456|The UUID of the period.|'."\n" - .'|creatorId|String|0123456|The ID of the user who created the period.|'."\n" - .'|creatorName|String|A, B, C, and D|The name of the user who created the period.|'."\n" - ."\n" - .'### FML statement used to query atomic metrics'."\n" - ."\n" - .'show atomic indicators; Response parameters'."\n" - ."\n" - .'|Parameter|Type|Example|Description|'."\n" - .'|---|---|---|---|'."\n" - .'|dataDistinct|YesOrNoEnum|YES|Indicates whether duplicate data is removed during statistics collection. Valid values:YESNO|'."\n" - .'|aggFunctionType|AggFunctionEnum|SUM|The type of the function for the atomic metric. Valid values:SUMCOUNTAVGMAXMINRATERANKUNDEFINED|'."\n" - .'|calExpression|String|price|The expression of the atomic metric.|'."\n" - .'|dataType|DataTypeNameEnum|TINYINT|The type of data that can be collected by the atomic metric. Valid values: TINYINT, SMALLINT, INT, BIGINT, BINARY, FLOAT, DOUBLE, DECIMAL, VARCHAR, CHAR, STRING, DATE, DATETIME, TIMESTAMP, BOOLEAN, ARRAY, MAP, STRUCT, and JSON|'."\n" - .'|dataRound|String|N|The number of decimal places after the decimal point. Valid values:NM|'."\n" - .'|dataUnitUuid|String|du-123456|The UUID of the metric unit.|'."\n" - .'|dataUnitCode|String|percent|The code of the metric unit.|'."\n" - .'|dataUnitName|String|Fen|The name of the metric unit.|'."\n" - .'|bizExpression|String|Aggregation of payment amount|The statistical criterion.|'."\n" - .'|dataRollUpType|String|AGG\\_FUNCTION|The method of the data roll-up. Valid values:AGG\\_FUNCTIONSUM\\_THEN\\_RATERATE\\_THEN\\_AVGNOT\\_SUPPORT|'."\n" - .'|businessUnitUuid|String|bu-0001|The UUID of the business unit.|'."\n" - .'|businessUnitCode|String|project\\_code|The code of the business unit.|'."\n" - .'|businessProcessUuid|String|di-0002|The UUID of the business process.|'."\n" - .'|businessProcessCode|String|pay|The code of the business process.|'."\n" - .'|businessProcessName|String|Payment|The name of the business process.|'."\n" - .'|dataDomainUuid|String|di-0003|The UUID of the data domain.|'."\n" - .'|dataDomainCode|String|trd|The code of the data domain.|'."\n" - .'|dataDomainName|String|Transaction|The name of the data domain.|'."\n" - .'|categoryUuid|String|di-0001|The UUID of the business category.|'."\n" - .'|categoryCode|String|tb|The code of the business category.|'."\n" - .'|categoryName|String|Taobao|The name of the business category.|'."\n" - .'|type|String|ATOMIC|The type of the metric. Valid values:ATOMICDERIVATIVEDERIVATIVE\\_COMPOSITE|'."\n" - .'|code|String|pay\\_amt|The abbreviation for the name of the atomic metric.|'."\n" - .'|name|String|Payment amount|The display name of the atomic metric.|'."\n" - .'|extendName|String|pay amount|The name of the atomic metric.|'."\n" - .'|description|String|remark|The description of the atomic metric.|'."\n" - .'|status|String|NORMAL|The status of the atomic metric. Valid values:DRAFTDEVNORMAL|'."\n" - .'|ownerId|String|0001|The owner ID.|'."\n" - .'|ownerName|String|Owner name|The name of the owner.|'."\n" - .'|isDeleted|DeleteTagEnum|NO|Indicates whether the atomic metric is deleted. Valid values:YESNO|'."\n" - .'|uuid|String|obj-123456|The UUID of the atomic metric.|'."\n" - .'|gmtCreate|TimeStamp|1644397025000|The time when the atomic metric was created.|'."\n" - .'|gmtModified|TimeStamp|1644459965000|The time when the atomic metric was last modified.|'."\n" - .'|creatorId|String|0123456|The ID of the user who created the atomic metric.|'."\n" - .'|creatorName|String|A, B, C, and D|The name of the user who created the atomic metric.|'."\n" - .'|modifierId|String|0123456|The ID of the user who last modified the atomic metric.|'."\n" - .'|modifierName|String|A, B, C, and D|The name of the user who last modified the atomic metric.|'."\n" - ."\n" - .'### FML statement used to query derived metrics'."\n" - ."\n" - .'show derivative indicators; Response parameters'."\n" - ."\n" - .'|Parameter|Type|Example|Description|'."\n" - .'|---|---|---|---|'."\n" - .'|timePeriodUuid|String|tp-0001|The UUID of the period.|'."\n" - .'|timePeriodCode|String|1d|The abbreviation for the name of the period.|'."\n" - .'|timePeriodName|String|Last day|The display name of the period.|'."\n" - .'|adjunctUuids|List|\\["adj-001"\\]|The UUIDs of modifiers.|'."\n" - .'|adjunctCodes|List|\\["male"\\]|The abbreviations for the names of modifiers.|'."\n" - .'|adjunctNames|List|Male|The display names of modifiers.|'."\n" - .'|atomicIndicatorUuid|String|ind-a-0001|The UUID of the atomic metric.|'."\n" - .'|atomicIndicatorCode|String|pay\\_amt|The abbreviation for the name of the atomic metric.|'."\n" - .'|atomicIndicatorName|String|Payment amount|The display name of the atomic metric.|'."\n" - .'|dataType|DataTypeNameEnum|BIGINT|The type of data that can be collected by the derived metric. Valid values: TINYINT, SMALLINT, INT, BIGINT, BINARY, FLOAT, DOUBLE, DECIMAL, VARCHAR, CHAR, STRING, DATE, DATETIME, TIMESTAMP, BOOLEAN, ARRAY, MAP, STRUCT, and JSON|'."\n" - .'|bizEntityUuid|String|dim-123456|The UUID of the business object.|'."\n" - .'|bizEntityCode|String|dim\\_shop|The abbreviation for the name of the business object.|'."\n" - .'|bizEntityName|String|Shop table|The display name of the business object.|'."\n" - .'|relUuid|String|dim\\_a-123456|The UUID of the dimension that is associated with the derived metric.|'."\n" - .'|indHash|String|hash-0001|The hash value for the elements of the derived metric.|'."\n" - .'|suggestCode|String|pay\\_amt\\_1d|The recommended code that is used by the derived metric.|'."\n" - .'|businessUnitUuid|String|bu-0001|The UUID of the business unit.|'."\n" - .'|businessUnitCode|String|project\\_code|The code of the business unit.|'."\n" - .'|businessProcessUuid|String|di-0002|The UUID of the business process.|'."\n" - .'|businessProcessCode|String|pay|The code of the business process.|'."\n" - .'|businessProcessName|String|Payment|The name of the business process.|'."\n" - .'|dataDomainUuid|String|di-0003|The UUID of the data domain.|'."\n" - .'|dataDomainCode|String|trd|The code of the data domain.|'."\n" - .'|dataDomainName|String|Transaction|The name of the data domain.|'."\n" - .'|categoryUuid|String|di-0001|The UUID of the business category.|'."\n" - .'|categoryCode|String|tb|The code of the business category.|'."\n" - .'|categoryName|String|Taobao|The name of the business category.|'."\n" - .'|type|IndicatorTypeEnum|ATOMIC|The type of the metric. Valid values:ATOMICDERIVATIVEDERIVATIVE\\_COMPOSITE|'."\n" - .'|code|String|pay\\_amt|The abbreviation for the name of the derived metric.|'."\n" - .'|name|String|Payment amount|The display name of the derived metric.|'."\n" - .'|extendName|String|pay amount|The name of the derived metric.|'."\n" - .'|description|String|remark|The description of the derived metric.|'."\n" - .'|status|IndicatorStatusEnum|NORMAL|The status of the derived metric. Valid values:DRAFTDEVNORMAL|'."\n" - .'|ownerId|String|0001|The owner ID.|'."\n" - .'|ownerName|String|Owner name|The name of the owner.|'."\n" - .'|isDeleted|DeleteTagEnum|NO|Indicates whether the derived metric is deleted. Valid values:YESNO|'."\n" - .'|uuid|String|obj-123456|The UUID of the derived metric.|'."\n" - .'|gmtCreate|TimeStamp|1644397025000|The time when the derived metric was created.|'."\n" - .'|gmtModified|TimeStamp|1644459965000|The time when the derived metric was last modified.|'."\n" - .'|creatorId|String|0123456|The ID of the user who created the derived metric.|'."\n" - .'|creatorName|String|A, B, C, and D|The name of the user who created the derived metric.|'."\n" - .'|modifierId|String|0123456|The ID of the user who last modified the derived metric.|'."\n" - .'|modifierName|String|A, B, C, and D|The name of the user who last modified the derived metric.|'."\n" - ."\n" - .'### FML statement used to query composite metrics'."\n" - ."\n" - .'show derivative composite indicators; Response parameters'."\n" - ."\n" - .'|Parameter|Type|Example|Description|'."\n" - .'|---|---|---|---|'."\n" - .'|businessUnitCode|String|project\\_code|The name of the workspace.|'."\n" - .'|businessProcessUuid|String|di-0002|The UUID of the business process.|'."\n" - .'|businessProcessCode|String|pay|The code of the business process.|'."\n" - .'|businessProcessName|String|Payment|The name of the business process.|'."\n" - .'|dataDomainUuid|String|di-0003|The UUID of the data domain.|'."\n" - .'|dataDomainCode|String|trd|The code of the data domain.|'."\n" - .'|dataDomainName|String|Transaction|The name of the data domain.|'."\n" - .'|categoryUuid|String|di-0001|The UUID of the business category.|'."\n" - .'|categoryCode|String|tb|The code of the business category.|'."\n" - .'|categoryName|String|Taobao|The name of the business category.|'."\n" - .'|type|String|DERIVATIVE\\_COMPOSITE|The computing logic. Valid values: DERIVATIVE\\_COMPOSITE and DERIVATIVE\\_COMPARISON. The value DERIVATIVE\\_COMPOSITE indicates a calculation expression. The value DERIVATIVE\\_COMPARISON indicates comparison.|'."\n" - .'|code|String|pay\\_amt|The abbreviation for the name of the composite metric.|'."\n" - .'|name|String|Payment amount|The display name of the composite metric.|'."\n" - .'|extendName|String|pay amount|The name of the composite metric.|'."\n" - .'|description|String|remark|The description of the composite metric.|'."\n" - .'|calculateExpression|String|{@pay\\_amt\\_1d\\[Last day\\_Payment amount\\]}/{@pay\\_amt\\_1m\\[Last 30 days\\_Payment amount\\]}|The calculation expression.|'."\n" - .'|comparisonPeriodType|String|DAY\\_MOM|The comparison type. Valid values: DAY\\_MOM, WEEK\\_MOM, WEEK\\_YOY, MONTH\\_MOM, MONTH\\_YOY, QUARTER\\_MOM, YEAR\\_MOM, and YEAR\\_YOY.|'."\n" - .'|comparisonIndicatorUuid|String|obj-123456|The UUID of the composite metric that is used for comparison.|'."\n" - .'|comparisonIndicatorCode|String|pay\\_amt\\_1d|The abbreviation for the name of the composite metric that is used for comparison.|'."\n" - .'|comparisonIndicatorName|String|Last day\\_Payment amount|The display name of the composite metric that is used for comparison.|'."\n" - .'|ownerId|String|0001|The ID of the owner of the composite metric.|'."\n" - .'|ownerName|String|Bob|The name of the owner of the composite metric.|'."\n" - .'|isDeleted|DeleteTagEnum|NO|Indicates whether the composite metric is deleted. Valid values: YES and NO.|'."\n" - .'|uuid|String|obj-123456|The UUID of the composite metric.|'."\n" - .'|gmtCreate|TimeStamp|1644397025000|The time when the composite metric was created.|'."\n" - .'|gmtModified|TimeStamp|1644459965000|The time when the composite metric was last modified.|'."\n" - .'|creatorId|String|0123456|The ID of the user who created the composite metric.|'."\n" - .'|creatorName|String|A, B, C, and D|The name of the user who created the composite metric.|'."\n" - .'|modifierId|String|0123456|The ID of the user who last modified the composite metric.|'."\n" - .'|modifierName|String|A, B, C, and D|The name of the user who last modified the composite metric.|'."\n" - ."\n" - .'### FML statement used to query information about the model on which a single metric depends'."\n" - ."\n" - .'show statistic indicator table\\_code; Response parameters'."\n" - ."\n" - .'|Parameter|Type|Example|Description|'."\n" - .'|---|---|---|---|'."\n" - .'|uuid|String|obj-123456|The UUID of the metric.|'."\n" - .'|code|String|pay\\_amt|The abbreviation for the name of the metric.|'."\n" - .'|name|String|Payment amount|The display name of the metric.|'."\n" - .'|extendName|String|pay amount|The name of the metric.|'."\n" - .'|relations|List|Example|The information about the model on which the metric depends. You can view the following code and table to obtain the structure of the EntityInfo parameter.|'."\n" - ."\n" - .'Sample structure and description of the EntityInfo parameter'."\n" - ."\n" - .'```'."\n" - .'['."\n" - .' {'."\n" - .' "uuid": "uuid",'."\n" - .' "code": "code",'."\n" - .' "name": "Display name",'."\n" - .' "extendName": "full name in English",'."\n" - .' "entityType": "EntityTypeEnum.BASE_DERIVATIVE_INDICATOR",'."\n" - .' "entityTypeName": "Entity type name",'."\n" - .' "entitySubType": "DERIVATIVE_INDICATOR",'."\n" - .' "entitySubTypeName": "Entity subtype name",'."\n" - .' "ownerId": "0001",'."\n" - .' "ownerName": "Owner name"'."\n" - .' }'."\n" - .']'."\n" - .'```'."\n" - ."\n" - .'|Parameter|Type|Example|Description|'."\n" - .'|---|---|---|---|'."\n" - .'|uuid|String|obj-123456|The UUID of the model.|'."\n" - .'|code|String|dws\\_001|The abbreviation for the name of the model.|'."\n" - .'|name|String|Payment aggregate table|The display name of the model.|'."\n" - .'|extendName|String|dws\\_001|The name of the model.|'."\n" - .'|entityType|EntityTypeEnum|Table|The entity type of the metric. The values of this parameter include but are not limited to `TABLE, BASE_ATOMIC_INDICATOR, and BASE_DERIVATIVE_INDICATOR`.|'."\n" - .'|entityTypeName|String|Table|The type name of the entity.|'."\n" - .'|entitySubType|String|DWS\\_TABLE|The subtype of the entity. The values of this parameter include but are not limited to `DWS_TABLE, ATOMIC_INDICATOR, and DERIVATIVE_INDICATOR`.|'."\n" - .'|entitySubTypeName|String|Aggregate table|The subtype name of the entity.|'."\n" - .'|ownerId|String|0001|The owner ID.|'."\n" - .'|ownerName|String|Bob|The name of the owner.|', - 'extraInfo' => ' ', - ], - 'GetAlertMessage' => [ - 'summary' => 'Queries alert information based on the alert ID that is specified by the AlertId parameter.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '201154', - 'abilityTreeNodes' => [ - 'FEATUREdideRJGWWC', - ], - ], - 'parameters' => [ - [ - 'name' => 'AlertId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The alert ID. You can all the [ListAlertMessages](~~173961~~) operation to obtain the alert ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1421', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified parameters are invalid.', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The information about returned alerts.'."\n", - 'type' => 'object', - 'properties' => [ - 'RemindId' => [ - 'description' => 'The ID of the custom alert rule that was triggered. This parameter is returned if the value of the Source parameter is REMIND_ALERT.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'AlertMessageStatus' => [ - 'description' => 'The sending status of the notification. Valid values:'."\n" - ."\n" - .'* READY_TO_SEND: The notification is waiting to be sent.'."\n" - .'* SEND_FAIL: The notification fails to be sent.'."\n" - .'* SEND_SUCCESS: The notification is sent.'."\n" - .'* SEND_OVERLIMIT: The number of notifications that are sent exceeds the upper limit.'."\n", - 'type' => 'string', - 'example' => 'READY_TO_SEND', - ], - 'AlertUser' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the alert recipient.'."\n", - 'type' => 'string', - 'example' => '9527952795****', - ], - 'AlertTime' => [ - 'description' => 'The time when the alert was reported.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1553524393000', - ], - 'AlertMethod' => [ - 'description' => 'The notification method. Valid values:'."\n" - ."\n" - .'* MAIL.'."\n" - .'* SMS.'."\n" - .'* PHONE. Only DataWorks Professional Edition and more advanced editions support the PHONE notification method.'."\n", - 'type' => 'string', - 'example' => 'SMS', - ], - 'Source' => [ - 'description' => 'The type of the alert. Valid values:'."\n" - ."\n" - .'* REMIND_ALERT: The alert is a custom alert.'."\n" - .'* TOPIC_ALERT: The alert is an event alert.'."\n" - .'* SLA_ALERT: The alert is a baseline alert.'."\n" - .'* NODE_CYCLE_ALERT: The alert is reported for a node dependency loop.'."\n" - .'* NODE_LONELY_ALERT: The alert is reported for isolated nodes.'."\n", - 'type' => 'string', - 'example' => 'REMIND_ALERT', - ], - 'Content' => [ - 'description' => 'The content of the alert.'."\n", - 'type' => 'string', - 'example' => 'Node error', - ], - 'RemindName' => [ - 'description' => 'The name of the custom alert rule that was triggered. This parameter is returned if the value of the Source parameter is REMIND_ALERT.'."\n", - 'type' => 'string', - 'example' => 'Custom monitoring rule name', - ], - 'AlertId' => [ - 'description' => 'The alert ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'Instances' => [ - 'description' => 'The instances that triggered the custom alert rule. This parameter is returned if the value of the Source parameter is REMIND_ALERT. This parameter is left empty if the value of the Source parameter is not REMIND_ALERT.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the instance.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status of the instance. Valid values:'."\n" - ."\n" - .'* NOT_RUN'."\n" - .'* WAIT_TIME'."\n" - .'* WAIT_RESOURCE'."\n" - .'* RUNNING'."\n" - .'* CHECKING'."\n" - .'* CHECKING_CONDITION'."\n" - .'* FAILURE'."\n" - .'* SUCCESS'."\n", - 'type' => 'string', - 'example' => 'NOT_RUN', - ], - 'InstanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12312312', - ], - 'NodeName' => [ - 'description' => 'The name of the node.'."\n", - 'type' => 'string', - 'example' => 'Node name', - ], - 'NodeId' => [ - 'description' => 'The node ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'ProjectId' => [ - 'description' => 'The ID of the workspace to which the node belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - ], - ], - ], - 'Topics' => [ - 'description' => 'The events that triggered alerts. This parameter is returned if the value of the Source parameter is TOPIC_ALERT. This parameter is left empty if the value of the Source parameter is not TOPIC_ALERT.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the event.'."\n", - 'type' => 'object', - 'properties' => [ - 'TopicName' => [ - 'description' => 'The name of the event.'."\n", - 'type' => 'string', - 'example' => 'error', - ], - 'InstanceId' => [ - 'description' => 'The ID of the instance that triggered the event.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12345', - ], - 'TopicId' => [ - 'description' => 'The event ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '412431', - ], - 'TopicOwner' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the event owner.'."\n", - 'type' => 'string', - 'example' => '9527952795****', - ], - 'NodeId' => [ - 'description' => 'The ID of the node that triggered the event.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'TopicStatus' => [ - 'description' => 'The status of the event. Valid values:'."\n" - ."\n" - .'* IGNORE'."\n" - .'* NEW'."\n" - .'* FIXING'."\n" - .'* RECOVER'."\n", - 'type' => 'string', - 'example' => 'FIXING', - ], - ], - ], - ], - 'Nodes' => [ - 'description' => 'The nodes returned for different alert sources. The nodes that form a loop are returned if the value of the Source parameter is NODE_CYCLE_ALERT. The nodes that are isolated are returned if the value of the Source parameter is NODE_LONELY_ALERT.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the node.'."\n", - 'type' => 'object', - 'properties' => [ - 'Owner' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the node owner.'."\n", - 'type' => 'string', - 'example' => '95279527952****', - ], - 'NodeName' => [ - 'description' => 'The name of the node.'."\n", - 'type' => 'string', - 'example' => 'Node name', - ], - 'NodeId' => [ - 'description' => 'The node ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'ProjectId' => [ - 'description' => 'The ID of the workspace to which the node belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - ], - ], - ], - 'SlaAlert' => [ - 'description' => 'The basic information about the baseline instance that triggered an alert. This parameter is returned if the value of the Source parameter is SLA_ALERT. This parameter is left empty if the value of the Source parameter is not SLA_ALERT.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status of the baseline. Valid values:'."\n" - ."\n" - .'* ERROR'."\n" - .'* SAFE'."\n" - .'* DANGEROUS'."\n" - .'* OVER'."\n", - 'type' => 'string', - 'example' => 'SAFE', - ], - 'BaselineOwner' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the baseline owner. Multiple IDs are separated by commas (,).'."\n", - 'type' => 'string', - 'example' => '952795279****', - ], - 'BaselineId' => [ - 'description' => 'The baseline ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '15142123', - ], - 'BaselineName' => [ - 'description' => 'The name of the baseline.'."\n", - 'type' => 'string', - 'example' => 'Baseline name', - ], - 'Bizdate' => [ - 'description' => 'The data timestamp of the baseline instance.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1553443200000', - ], - 'ProjectId' => [ - 'description' => 'The ID of the workspace to which the baseline belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'InGroupId' => [ - 'description' => 'The ID of the cycle of the baseline instance. Valid values of the ID of an hour-level cycle: \\[1,24]. The ID of a day-level cycle is 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"RemindId\\": 1234,\\n \\"AlertMessageStatus\\": \\"READY_TO_SEND\\",\\n \\"AlertUser\\": \\"9527952795****\\",\\n \\"AlertTime\\": 1553524393000,\\n \\"AlertMethod\\": \\"SMS\\",\\n \\"Source\\": \\"REMIND_ALERT\\",\\n \\"Content\\": \\"Node error\\",\\n \\"RemindName\\": \\"Custom monitoring rule name\\",\\n \\"AlertId\\": 123,\\n \\"Instances\\": [\\n {\\n \\"Status\\": \\"NOT_RUN\\",\\n \\"InstanceId\\": 0,\\n \\"NodeName\\": \\"Node name\\",\\n \\"NodeId\\": 1234,\\n \\"ProjectId\\": 1234\\n }\\n ],\\n \\"Topics\\": [\\n {\\n \\"TopicName\\": \\"error\\",\\n \\"InstanceId\\": 12345,\\n \\"TopicId\\": 412431,\\n \\"TopicOwner\\": \\"9527952795****\\",\\n \\"NodeId\\": 1234,\\n \\"TopicStatus\\": \\"FIXING\\"\\n }\\n ],\\n \\"Nodes\\": [\\n {\\n \\"Owner\\": \\"95279527952****\\",\\n \\"NodeName\\": \\"Node name\\",\\n \\"NodeId\\": 1234,\\n \\"ProjectId\\": 1234\\n }\\n ],\\n \\"SlaAlert\\": {\\n \\"Status\\": \\"SAFE\\",\\n \\"BaselineOwner\\": \\"952795279****\\",\\n \\"BaselineId\\": 15142123,\\n \\"BaselineName\\": \\"Baseline name\\",\\n \\"Bizdate\\": 1553443200000,\\n \\"ProjectId\\": 1234,\\n \\"InGroupId\\": 1\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 0000-ABCD-EFG****\\n 200\\n The specified parameters are invalid.\\n Invalid.Tenant.ConnectionNotExists\\n true\\n \\n 1234\\n READY_TO_SEND\\n 9527952795****\\n 1553524393000\\n SMS\\n REMIND_ALERT\\n 节点出错\\n 自定义监控规则名称\\n 123\\n \\n NOT_RUN\\n 12312312\\n 节点名\\n 1234\\n 1234\\n \\n \\n 9527出错\\n 12345\\n 412431\\n 9527952795****\\n 1234\\n FIXING\\n \\n \\n 95279527952****\\n 节点名\\n 1234\\n 1234\\n \\n \\n SAFE\\n 952795279****\\n 15142123\\n 基线名\\n 1553443200000\\n 1234\\n 1\\n \\n \\n","errorExample":""}]', - 'title' => 'GetAlertMessage', - ], - 'ListAlertMessages' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '78294', - 'abilityTreeNodes' => [ - 'FEATUREdideRJGWWC', - ], - ], - 'parameters' => [ - [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The page number. Default value: 1. Minimum value: 1. Maximum value: 30.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], - ], - [ - 'name' => 'BeginTime', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-dd\'T\'HH:mm:ssZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2020-04-02T00:00:00+0800', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-dd\'T\'HH:mm:ssZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2020-04-04T00:00:00+0800', - ], - ], - [ - 'name' => 'RemindId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The custom alert rule ID. This parameter takes effect if the AlertRuleTypes parameter is set to USER_DEFINE. You can configure either this parameter or the BaselineId parameter.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '9527', - ], - ], - [ - 'name' => 'AlertMethods', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The notification method. Valid values:'."\n" - ."\n" - .'* MAIL'."\n" - .'* SMS Alert notifications can be sent by text message only in the Singapore, Malaysia (Kuala Lumpur), and Germany (Frankfurt) regions.'."\n" - ."\n" - .'You can specify multiple notification methods. Separate them with commas (,).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SMS,MAIL,PHONE', - ], - ], - [ - 'name' => 'AlertUser', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the alert recipient.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123456', - ], - ], - [ - 'name' => 'AlertRuleTypes', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The type of the alert rule. Valid values: GLOBAL, USER_DEFINE, and OTHER. The value GLOBAL indicates that the alert rule is a global alert rule. The value USER_DEFINE indicates that the alert rule is customized by a user. The value OTHER indicates that the alert rule is a rule of another type. You can specify multiple types. Separate them with commas (,).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GLOBAL,USER_DEFINE,OTHER', - ], - ], - [ - 'name' => 'BaselineId', - 'in' => 'formData', - 'schema' => [ - 'title' => '基线ID，当 alertRuleTypes 包含 GLOBAL 时生效，与 RemindId 互斥', - 'description' => 'The baseline ID. This parameter takes effect if the AlertRuleTypes parameter is set to GLOBAL. You can configure either this parameter or the RemindId parameter.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1234', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified parameters are invalid.', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The information about returned alerts.'."\n", - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of alerts returned.'."\n", - 'type' => 'string', - 'example' => '100', - ], - 'AlertMessages' => [ - 'description' => 'The alerts.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'RemindId' => [ - 'description' => 'The ID of the custom alert rule that was triggered. This parameter is returned if the value of the Source parameter is REMIND_ALERT.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'AlertMessageStatus' => [ - 'description' => 'The sending status of the notification. Valid values: READY_TO_SEND, SEND_FAIL, SEND_SUCCESS, and SEND_OVERLIMIT. The value READY_TO_SEND indicates that the notification is waiting to be sent. The value SEND_FAIL indicates that the notification fails to be sent. The value SEND_SUCCESS indicates that the notification is sent. The value SEND_OVERLIMIT indicates that the number of notifications that are sent exceeds the upper limit.'."\n", - 'type' => 'string', - 'example' => 'READY_TO_SEND', - ], - 'AlertUser' => [ - 'description' => 'The ID of the Alibaba Cloud used by the alert recipient.'."\n", - 'type' => 'string', - 'example' => '9527952795****', - ], - 'AlertTime' => [ - 'description' => 'The timestamp when the alert was reported.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1553531401000', - ], - 'AlertMethod' => [ - 'description' => 'The notification method. Valid values: MAIL, SMS, and PHONE. Only DataWorks Professional Edition and more advanced editions support the PHONE notification method.'."\n", - 'type' => 'string', - 'example' => 'SMS', - ], - 'Source' => [ - 'description' => 'The type of the alert. Valid values: REMIND_ALERT, TOPIC_ALERT, SLA_ALERT, NODE_CYCLE_ALERT, and NODE_LONELY_ALERT. The value REMIND_ALERT indicates that the alert is a custom alert. The value TOPIC_ALERT indicates that the alert is an event alert. The value SLA_ALERT indicates that the alert is a baseline alert. The value NODE_CYCLE_ALERT indicates that the alert is reported for a node dependency loop. The value NODE_LONELY_ALERT indicates that the alert is reported for isolated nodes.'."\n", - 'type' => 'string', - 'example' => 'REMIND_ALERT', - ], - 'Content' => [ - 'description' => 'The content of the alert.'."\n", - 'type' => 'string', - 'example' => 'Node error', - ], - 'RemindName' => [ - 'description' => 'The name of the custom alert rule that was triggered. This parameter is returned if the value of the Source parameter is REMIND_ALERT.'."\n", - 'type' => 'string', - 'example' => 'Custom monitoring rule name', - ], - 'AlertId' => [ - 'description' => 'The alert ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'Instances' => [ - 'description' => 'The instances that triggered the custom alert rule. This parameter is returned if the value of the Source parameter is REMIND_ALERT. This parameter is left empty if the value of the Source parameter is not REMIND_ALERT.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the instance.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status of the instance. Valid values: NOT_RUN, WAIT_TIME, WAIT_RESOURCE, RUNNING, CHECKING, CHECKING_CONDITION, FAILURE, and SUCCESS. The value NOT_RUN indicates that the instance is not run. The value WAIT_TIME indicates that the instance is waiting to be run. The value WAIT_RESOURCE indicates that the instance is waiting for resources. The value RUNNING indicates that the instance is running. The value CHECKING indicates that data quality is being checked for the node for which the instance is generated. The value CHECKING_CONDITION indicates that branch conditions are being checked for the node for which the instance is generated. The value FAILURE indicates that the instance fails to run. The value SUCCESS indicates that the instance is successfully run.'."\n", - 'type' => 'string', - 'example' => 'NOT_RUN', - ], - 'InstanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12345', - ], - 'NodeName' => [ - 'description' => 'The name of the node.'."\n", - 'type' => 'string', - 'example' => 'Node name', - ], - 'NodeId' => [ - 'description' => 'The node ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'ProjectId' => [ - 'description' => 'The ID of the workspace to which the node belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - ], - ], - ], - 'Topics' => [ - 'description' => 'The events that triggered alerts. This parameter is returned if the value of the Source parameter is TOPIC_ALERT. This parameter is left empty if the value of the Source parameter is not TOPIC_ALERT.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the event.'."\n", - 'type' => 'object', - 'properties' => [ - 'TopicName' => [ - 'description' => 'The name of the event.'."\n", - 'type' => 'string', - 'example' => '9527 error', - ], - 'InstanceId' => [ - 'description' => 'The ID of the instance that triggered the event.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12345', - ], - 'TopicId' => [ - 'description' => 'The event ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'TopicOwner' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the event owner.'."\n", - 'type' => 'string', - 'example' => '9527952795****', - ], - 'NodeId' => [ - 'description' => 'The ID of the node that triggered the event.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'TopicStatus' => [ - 'description' => 'The status of the event. Valid values: IGNORE, NEW, FIXING, and RECOVER. The value IGNORE indicates that the event is ignored. The value NEW indicates that the event is a new event. The value FIXING indicates that the event is being handled. The value RECOVER indicates that the event is handled.'."\n", - 'type' => 'string', - 'example' => 'FIXING', - ], - ], - ], - ], - 'Nodes' => [ - 'description' => 'The nodes returned for different alert sources.'."\n" - ."\n" - .'* The nodes that form a loop are returned if the value of the Source parameter is NODE_CYCLE_ALERT.'."\n" - .'* The nodes that are isolated are returned if the value of the Source parameter is NODE_LONELY_ALERT.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the node.'."\n", - 'type' => 'object', - 'properties' => [ - 'Owner' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the node owner.'."\n", - 'type' => 'string', - 'example' => '95279527952****', - ], - 'NodeName' => [ - 'description' => 'The name of the node.'."\n", - 'type' => 'string', - 'example' => 'Node name', - ], - 'NodeId' => [ - 'description' => 'The node ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'ProjectId' => [ - 'description' => 'The ID of the workspace to which the node belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - ], - ], - ], - 'SlaAlert' => [ - 'description' => 'The basic information about the baseline instance that triggered an alert. This parameter is returned if the value of the Source parameter is SLA_ALERT. This parameter is left empty if the value of the Source parameter is not SLA_ALERT.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status of the baseline. Valid values: ERROR, SAFE, DANGEROUS, and OVER. The value ERROR indicates that no nodes are associated with the baseline, or all nodes associated with the baseline are suspended. The value SAFE indicates that nodes are run before the alert duration begins. The value DANGEROUS indicates that nodes are still running after the alert duration ends but the committed completion time does not arrive. The value OVER indicates that nodes are still running after the committed completion time.'."\n", - 'type' => 'string', - 'example' => 'SAFE', - ], - 'BaselineOwner' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the baseline owner. Multiple IDs are separated by commas (,).'."\n", - 'type' => 'string', - 'example' => '952795279****', - ], - 'BaselineId' => [ - 'description' => 'The baseline ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'BaselineName' => [ - 'description' => 'The name of the baseline.'."\n", - 'type' => 'string', - 'example' => 'Baseline name', - ], - 'Bizdate' => [ - 'description' => 'The data timestamp of the baseline instance.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1553443200000', - ], - 'ProjectId' => [ - 'description' => 'The ID of the workspace to which the baseline belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'InGroupId' => [ - 'description' => 'The ID of the cycle of the baseline instance. Valid values of the ID of an hour-level cycle: \\[1,24]. The ID of a day-level cycle is 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.Resource', - 'errorMessage' => 'You have reached the limit for the resource. Please contact us by submitting a ticket.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'Forbidden.Not.Server', - 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.', - ], - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": \\"1\\",\\n \\"PageSize\\": \\"10\\",\\n \\"TotalCount\\": \\"100\\",\\n \\"AlertMessages\\": [\\n {\\n \\"RemindId\\": 1234,\\n \\"AlertMessageStatus\\": \\"READY_TO_SEND\\",\\n \\"AlertUser\\": \\"9527952795****\\",\\n \\"AlertTime\\": 1553531401000,\\n \\"AlertMethod\\": \\"SMS\\",\\n \\"Source\\": \\"REMIND_ALERT\\",\\n \\"Content\\": \\"Node error\\",\\n \\"RemindName\\": \\"Custom monitoring rule name\\",\\n \\"AlertId\\": 1234,\\n \\"Instances\\": [\\n {\\n \\"Status\\": \\"NOT_RUN\\",\\n \\"InstanceId\\": 12345,\\n \\"NodeName\\": \\"Node name\\",\\n \\"NodeId\\": 1234,\\n \\"ProjectId\\": 1234\\n }\\n ],\\n \\"Topics\\": [\\n {\\n \\"TopicName\\": \\"9527 error\\",\\n \\"InstanceId\\": 12345,\\n \\"TopicId\\": 1234,\\n \\"TopicOwner\\": \\"9527952795****\\",\\n \\"NodeId\\": 1234,\\n \\"TopicStatus\\": \\"FIXING\\"\\n }\\n ],\\n \\"Nodes\\": [\\n {\\n \\"Owner\\": \\"95279527952****\\",\\n \\"NodeName\\": \\"Node name\\",\\n \\"NodeId\\": 1234,\\n \\"ProjectId\\": 1234\\n }\\n ],\\n \\"SlaAlert\\": {\\n \\"Status\\": \\"SAFE\\",\\n \\"BaselineOwner\\": \\"952795279****\\",\\n \\"BaselineId\\": 1234,\\n \\"BaselineName\\": \\"Baseline name\\",\\n \\"Bizdate\\": 1553443200000,\\n \\"ProjectId\\": 1234,\\n \\"InGroupId\\": 1\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 0000-ABCD-EFG****\\n The specified parameters are invalid.\\n Invalid.Tenant.ConnectionNotExists\\n true\\n \\n 1\\n 10\\n 100\\n \\n 1234\\n READY_TO_SEND\\n 9527952795****\\n 1553531401000\\n SMS\\n REMIND_ALERT\\n 节点出错\\n 自定义监控规则名称\\n 1234\\n \\n NOT_RUN\\n 12345\\n 节点名称\\n 1234\\n 1234\\n \\n \\n 9527出错\\n 12345\\n 1234\\n 9527952795****\\n 1234\\n FIXING\\n \\n \\n 95279527952****\\n 节点名称\\n 1234\\n 1234\\n \\n \\n SAFE\\n 952795279****\\n 1234\\n 基线名称\\n 1553443200000\\n 1234\\n 1\\n \\n \\n \\n","errorExample":""}]', - 'title' => 'ListAlertMessages', - 'summary' => 'Queries a list of alerts.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'GetBaselineConfig' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '78229', - 'abilityTreeNodes' => [ - 'FEATUREdideSFSFU4', - ], - ], - 'parameters' => [ - [ - 'name' => 'BaselineId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The baseline ID. You can call the [GetNode](~~173977~~) operation to query the baseline ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1234', - ], - ], - ], - 'responses' => [ - 200 => [ - 'headers' => [], - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '401', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ecb967ec-c137-48a5-860****', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified parameters are invalid.', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '1031203110005', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The details of the baseline.'."\n", - 'type' => 'object', - 'properties' => [ - 'HourSlaDetail' => [ - 'description' => 'The committed completion time of the hour-level baseline. This parameter is presented as key-value pairs in the JSON format. The key indicates the ID of the cycle, and the value is presented in the hh:mm format. Valid values of hh: \\[0,47]. Valid values of mm: \\[0,59].'."\n", - 'type' => 'string', - 'example' => '{"1":"03:58","2":"04:58","3":"05:58","4":"06:58","5":"07:58","6":"08:58","7":"09:58","8":"10:58","9":"11:58","10":"12:58","11":"13:58","12":"14:58","13":"15:58","14":"16:58","15":"17:58","16":"18:58","17":"19:58","18":"20:58","19":"21:58","20":"22:58","21":"23:58","22":"24:58","23":"25:58","24":"26:58"}', - ], - 'IsDefault' => [ - 'description' => 'Indicates whether the baseline is a default baseline of the workspace. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Owner' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the baseline owner. Multiple IDs can be specified. The IDs are separated by commas (,).'."\n", - 'type' => 'string', - 'example' => '9527952****', - ], - 'ProjectId' => [ - 'description' => 'The ID of the workspace.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'Priority' => [ - 'description' => 'The priority of the baseline. Valid values: {1,3,5,7,8}.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'SlaMinu' => [ - 'description' => 'The minute in the committed completion time of the day-level baseline. Valid values: \\[0, 59].'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'SlaHour' => [ - 'description' => 'The hour in the committed completion time of the day-level baseline. Valid values: \\[0, 47].'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '9', - ], - 'BaselineId' => [ - 'description' => 'The baseline ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'BaselineName' => [ - 'description' => 'The name of the baseline.'."\n", - 'type' => 'string', - 'example' => 'Baseline name'."\n", - ], - 'HourExpDetail' => [ - 'description' => 'The alerting time of the hour-level baseline. This parameter is presented as key-value pairs in the JSON format. The key indicates the ID of the cycle, and the value is presented in the hh:mm format. Valid values of hh: \\[0,47]. Valid values of mm: \\[0,59].'."\n", - 'type' => 'string', - 'example' => '{"1":"03:28","2":"04:28","3":"05:28","4":"06:28","5":"07:28","6":"08:28","7":"09:28","8":"10:28","9":"11:28","10":"12:28","11":"13:28","12":"14:28","13":"15:28","14":"16:28","15":"17:28","16":"18:28","17":"19:28","18":"20:28","19":"21:28","20":"22:28","21":"23:28","22":"24:28","23":"25:28","24":"26:28"}', - ], - 'UseFlag' => [ - 'description' => 'Indicates whether the baseline is enabled. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ExpHour' => [ - 'description' => 'The hour in the alerting time of the day-level baseline. Valid values: \\[0, 47].'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - ], - 'BaselineType' => [ - 'description' => 'The type of the baseline. Valid values: DAILY and HOURLY.'."\n", - 'type' => 'string', - 'example' => 'DAILY', - ], - 'ExpMinu' => [ - 'description' => 'The minute in the alerting time of the day-level baseline. Valid values: \\[0, 59].'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - ], - ], - ], - 'description' => '', - ], - ], - ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'Forbidden.Not.Server', - 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.', - ], - [ - 'errorCode' => 'Forbidden.Wkbench.BaselineNoPermission', - 'errorMessage' => 'You are not authorized to access the baseline.', - ], - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.Wkbench.ServiceError', - 'errorMessage' => 'An internal error occurred.', - ], - [ - 'errorCode' => 'Invalid.Wkbench.Parameter', - 'errorMessage' => 'The specified parameters are invalid.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 401,\\n \\"RequestId\\": \\"ecb967ec-c137-48a5-860****\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"HourSlaDetail\\": \\"{\\\\\\"1\\\\\\":\\\\\\"03:58\\\\\\",\\\\\\"2\\\\\\":\\\\\\"04:58\\\\\\",\\\\\\"3\\\\\\":\\\\\\"05:58\\\\\\",\\\\\\"4\\\\\\":\\\\\\"06:58\\\\\\",\\\\\\"5\\\\\\":\\\\\\"07:58\\\\\\",\\\\\\"6\\\\\\":\\\\\\"08:58\\\\\\",\\\\\\"7\\\\\\":\\\\\\"09:58\\\\\\",\\\\\\"8\\\\\\":\\\\\\"10:58\\\\\\",\\\\\\"9\\\\\\":\\\\\\"11:58\\\\\\",\\\\\\"10\\\\\\":\\\\\\"12:58\\\\\\",\\\\\\"11\\\\\\":\\\\\\"13:58\\\\\\",\\\\\\"12\\\\\\":\\\\\\"14:58\\\\\\",\\\\\\"13\\\\\\":\\\\\\"15:58\\\\\\",\\\\\\"14\\\\\\":\\\\\\"16:58\\\\\\",\\\\\\"15\\\\\\":\\\\\\"17:58\\\\\\",\\\\\\"16\\\\\\":\\\\\\"18:58\\\\\\",\\\\\\"17\\\\\\":\\\\\\"19:58\\\\\\",\\\\\\"18\\\\\\":\\\\\\"20:58\\\\\\",\\\\\\"19\\\\\\":\\\\\\"21:58\\\\\\",\\\\\\"20\\\\\\":\\\\\\"22:58\\\\\\",\\\\\\"21\\\\\\":\\\\\\"23:58\\\\\\",\\\\\\"22\\\\\\":\\\\\\"24:58\\\\\\",\\\\\\"23\\\\\\":\\\\\\"25:58\\\\\\",\\\\\\"24\\\\\\":\\\\\\"26:58\\\\\\"}\\",\\n \\"IsDefault\\": true,\\n \\"Owner\\": \\"9527952****\\",\\n \\"ProjectId\\": 123456,\\n \\"Priority\\": 1,\\n \\"SlaMinu\\": 30,\\n \\"SlaHour\\": 9,\\n \\"BaselineId\\": 1234,\\n \\"BaselineName\\": \\"Baseline name\\\\n\\",\\n \\"HourExpDetail\\": \\"{\\\\\\"1\\\\\\":\\\\\\"03:28\\\\\\",\\\\\\"2\\\\\\":\\\\\\"04:28\\\\\\",\\\\\\"3\\\\\\":\\\\\\"05:28\\\\\\",\\\\\\"4\\\\\\":\\\\\\"06:28\\\\\\",\\\\\\"5\\\\\\":\\\\\\"07:28\\\\\\",\\\\\\"6\\\\\\":\\\\\\"08:28\\\\\\",\\\\\\"7\\\\\\":\\\\\\"09:28\\\\\\",\\\\\\"8\\\\\\":\\\\\\"10:28\\\\\\",\\\\\\"9\\\\\\":\\\\\\"11:28\\\\\\",\\\\\\"10\\\\\\":\\\\\\"12:28\\\\\\",\\\\\\"11\\\\\\":\\\\\\"13:28\\\\\\",\\\\\\"12\\\\\\":\\\\\\"14:28\\\\\\",\\\\\\"13\\\\\\":\\\\\\"15:28\\\\\\",\\\\\\"14\\\\\\":\\\\\\"16:28\\\\\\",\\\\\\"15\\\\\\":\\\\\\"17:28\\\\\\",\\\\\\"16\\\\\\":\\\\\\"18:28\\\\\\",\\\\\\"17\\\\\\":\\\\\\"19:28\\\\\\",\\\\\\"18\\\\\\":\\\\\\"20:28\\\\\\",\\\\\\"19\\\\\\":\\\\\\"21:28\\\\\\",\\\\\\"20\\\\\\":\\\\\\"22:28\\\\\\",\\\\\\"21\\\\\\":\\\\\\"23:28\\\\\\",\\\\\\"22\\\\\\":\\\\\\"24:28\\\\\\",\\\\\\"23\\\\\\":\\\\\\"25:28\\\\\\",\\\\\\"24\\\\\\":\\\\\\"26:28\\\\\\"}\\",\\n \\"UseFlag\\": true,\\n \\"ExpHour\\": 7,\\n \\"BaselineType\\": \\"DAILY\\",\\n \\"ExpMinu\\": 30\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 401\\n ecb967ec-c137-48a5-860****\\n The specified parameters are invalid.\\n 1031203110005\\n true\\n \\n {\\"1\\":\\"03:58\\",\\"2\\":\\"04:58\\",\\"3\\":\\"05:58\\",\\"4\\":\\"06:58\\",\\"5\\":\\"07:58\\",\\"6\\":\\"08:58\\",\\"7\\":\\"09:58\\",\\"8\\":\\"10:58\\",\\"9\\":\\"11:58\\",\\"10\\":\\"12:58\\",\\"11\\":\\"13:58\\",\\"12\\":\\"14:58\\",\\"13\\":\\"15:58\\",\\"14\\":\\"16:58\\",\\"15\\":\\"17:58\\",\\"16\\":\\"18:58\\",\\"17\\":\\"19:58\\",\\"18\\":\\"20:58\\",\\"19\\":\\"21:58\\",\\"20\\":\\"22:58\\",\\"21\\":\\"23:58\\",\\"22\\":\\"24:58\\",\\"23\\":\\"25:58\\",\\"24\\":\\"26:58\\"}\\n true\\n 9527952****\\n 1234\\n 1\\n 30\\n 9\\n 1234\\n 基线名称\\n {\\"1\\":\\"03:28\\",\\"2\\":\\"04:28\\",\\"3\\":\\"05:28\\",\\"4\\":\\"06:28\\",\\"5\\":\\"07:28\\",\\"6\\":\\"08:28\\",\\"7\\":\\"09:28\\",\\"8\\":\\"10:28\\",\\"9\\":\\"11:28\\",\\"10\\":\\"12:28\\",\\"11\\":\\"13:28\\",\\"12\\":\\"14:28\\",\\"13\\":\\"15:28\\",\\"14\\":\\"16:28\\",\\"15\\":\\"17:28\\",\\"16\\":\\"18:28\\",\\"17\\":\\"19:28\\",\\"18\\":\\"20:28\\",\\"19\\":\\"21:28\\",\\"20\\":\\"22:28\\",\\"21\\":\\"23:28\\",\\"22\\":\\"24:28\\",\\"23\\":\\"25:28\\",\\"24\\":\\"26:28\\"}\\n true\\n 7\\n DAILY\\n 30\\n \\n","errorExample":""}]', - 'title' => 'GetBaselineConfig', - 'summary' => 'Queries the configurations of a baseline.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListNodesByBaseline' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '78321', - 'abilityTreeNodes' => [ - 'FEATUREdideSFSFU4', - ], - ], - 'parameters' => [ - [ - 'name' => 'BaselineId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The baseline ID. You can call the [ListBaselineConfigs](~~173964~~) operation to query the baseline ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1234', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can use the ID to troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-E****', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified parameters are invalid.', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '1031203110005', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The nodes in the baseline.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Owner' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the node owner.'."\n", - 'type' => 'string', - 'example' => '9527952****', - ], - 'NodeName' => [ - 'description' => 'The name of the node.'."\n", - 'type' => 'string', - 'example' => 'Node name', - ], - 'NodeId' => [ - 'description' => 'The node ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'ProjectId' => [ - 'description' => 'The ID of the workspace to which the node belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - ], - 'description' => '', - ], - ], - ], - 'description' => '', - ], - ], - ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.Resource', - 'errorMessage' => 'You have reached the limit for the resource. Please contact us by submitting a ticket.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'Forbidden.Not.Server', - 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.', - ], - [ - 'errorCode' => 'Forbidden.Wkbench.BaselineNoPermission', - 'errorMessage' => 'You are not authorized to access the baseline.', - ], - [ - 'errorCode' => 'Forbidden.Wkbench.ProjectNoPermission', - 'errorMessage' => 'You are not authorized to access the workspace.', - ], - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.Wkbench.ServiceError', - 'errorMessage' => 'An internal error occurred.', - ], - [ - 'errorCode' => 'Invalid.Wkbench.Parameter', - 'errorMessage' => 'The specified parameters are invalid.', - ], - [ - 'errorCode' => 'Invalid.Wkbench.BaselineNotExist', - 'errorMessage' => 'The baseline does not exist.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-E****\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": [\\n {\\n \\"Owner\\": \\"9527952****\\",\\n \\"NodeName\\": \\"Node name\\",\\n \\"NodeId\\": 12345,\\n \\"ProjectId\\": 12345\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 0000-ABCD-E****\\n The specified parameters are invalid.\\n 1031203110005\\n true\\n \\n 9527952****\\n 节点名称\\n 1234\\n 1234\\n \\n","errorExample":""}]', - 'title' => 'ListNodesByBaseline', - 'summary' => 'Queries nodes in a baseline.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListBaselineConfigs' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '78295', - 'abilityTreeNodes' => [ - 'FEATUREdideSFSFU4', - ], - ], - 'parameters' => [ - [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The page number. Valid values: 1 to 30. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], - ], - [ - 'name' => 'Owner', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the baseline owner.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '95279527****', - ], - ], - [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The workspace ID. You can call the ListProjects operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1234', - ], - ], - [ - 'name' => 'Priority', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The priority of the baseline. Valid values: {1,3,5,7,8}. Separate multiple priorities with commas (,).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1,3,5,7,8', - ], - ], - [ - 'name' => 'Useflag', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether to enable the baseline. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'BaselineTypes', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The type of the baseline. Valid values: DAILY and HOURLY. Separate multiple baseline types with commas (,).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'DAILY,HOURLY', - ], - ], - [ - 'name' => 'SearchText', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The keyword in the baseline name, which is used to search for the baseline.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Baseline name search keywords', - ], - ], - ], - 'responses' => [ - 200 => [ - 'headers' => [], - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified parameters are invalid.', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '1031203110005', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of baselines returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'Baselines' => [ - 'description' => 'The baselines.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The returned result.'."\n", - 'type' => 'object', - 'properties' => [ - 'HourSlaDetail' => [ - 'description' => 'The committed completion time of the hour-level baseline. This parameter is presented as key-value pairs in the JSON format. The key indicates the ID of the cycle, and the value is presented in the hh:mm format. Valid values of hh: \\[0,47]. Valid values of mm: \\[0,59].'."\n", - 'type' => 'string', - 'example' => '{"1":"03:58","2":"04:58","3":"05:58","4":"06:58","5":"07:58","6":"08:58","7":"09:58","8":"10:58","9":"11:58","10":"12:58","11":"13:58","12":"14:58","13":"15:58","14":"16:58","15":"17:58","16":"18:58","17":"19:58","18":"20:58","19":"21:58","20":"22:58","21":"23:58","22":"24:58","23":"25:58","24":"26:58"}', - ], - 'IsDefault' => [ - 'description' => 'Indicates whether the baseline is a default baseline of the workspace. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Owner' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the baseline owner. Multiple IDs can be specified. The IDs are separated by commas (,).'."\n", - 'type' => 'string', - 'example' => '952795****', - ], - 'ProjectId' => [ - 'description' => 'The ID of the workspace to which the baseline belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '9527', - ], - 'Priority' => [ - 'description' => 'The priority of the baseline. Valid values: {1,3,5,7,8}.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'SlaMinu' => [ - 'description' => 'The minute in the alerting time of the day-level baseline. Valid values: \\[0, 59].'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'SlaHour' => [ - 'description' => 'The hour in the committed completion time of the day-level baseline. Valid values: \\[0, 47].'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '9', - ], - 'BaselineId' => [ - 'description' => 'The baseline ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'BaselineName' => [ - 'description' => 'The name of the baseline.'."\n", - 'type' => 'string', - 'example' => 'Baseline name', - ], - 'HourExpDetail' => [ - 'description' => 'The alerting time of the hour-level baseline. This parameter is presented as key-value pairs in the JSON format. The key indicates the ID of the cycle, and the value is presented in the hh:mm format. Valid values of hh: \\[0,47]. Valid values of mm: \\[0,59].'."\n", - 'type' => 'string', - 'example' => '{"1":"03:28","2":"04:28","3":"05:28","4":"06:28","5":"07:28","6":"08:28","7":"09:28","8":"10:28","9":"11:28","10":"12:28","11":"13:28","12":"14:28","13":"15:28","14":"16:28","15":"17:28","16":"18:28","17":"19:28","18":"20:28","19":"21:28","20":"22:28","21":"23:28","22":"24:28","23":"25:28","24":"26:28"}', - ], - 'UseFlag' => [ - 'description' => 'Indicates whether the baseline is enabled. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ExpHour' => [ - 'description' => 'The hour in the alerting time of the day-level baseline. Valid values: \\[0, 47].'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - ], - 'BaselineType' => [ - 'description' => 'The type of the baseline. Valid values: DAILY and HOURLY.'."\n", - 'type' => 'string', - 'example' => 'DAILY', - ], - 'ExpMinu' => [ - 'description' => 'The minute in the alerting time of the day-level baseline. Valid values: \\[0, 59].'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'Forbidden.Not.Server', - 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.', - ], - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Baselines\\": [\\n {\\n \\"HourSlaDetail\\": \\"{\\\\\\"1\\\\\\":\\\\\\"03:58\\\\\\",\\\\\\"2\\\\\\":\\\\\\"04:58\\\\\\",\\\\\\"3\\\\\\":\\\\\\"05:58\\\\\\",\\\\\\"4\\\\\\":\\\\\\"06:58\\\\\\",\\\\\\"5\\\\\\":\\\\\\"07:58\\\\\\",\\\\\\"6\\\\\\":\\\\\\"08:58\\\\\\",\\\\\\"7\\\\\\":\\\\\\"09:58\\\\\\",\\\\\\"8\\\\\\":\\\\\\"10:58\\\\\\",\\\\\\"9\\\\\\":\\\\\\"11:58\\\\\\",\\\\\\"10\\\\\\":\\\\\\"12:58\\\\\\",\\\\\\"11\\\\\\":\\\\\\"13:58\\\\\\",\\\\\\"12\\\\\\":\\\\\\"14:58\\\\\\",\\\\\\"13\\\\\\":\\\\\\"15:58\\\\\\",\\\\\\"14\\\\\\":\\\\\\"16:58\\\\\\",\\\\\\"15\\\\\\":\\\\\\"17:58\\\\\\",\\\\\\"16\\\\\\":\\\\\\"18:58\\\\\\",\\\\\\"17\\\\\\":\\\\\\"19:58\\\\\\",\\\\\\"18\\\\\\":\\\\\\"20:58\\\\\\",\\\\\\"19\\\\\\":\\\\\\"21:58\\\\\\",\\\\\\"20\\\\\\":\\\\\\"22:58\\\\\\",\\\\\\"21\\\\\\":\\\\\\"23:58\\\\\\",\\\\\\"22\\\\\\":\\\\\\"24:58\\\\\\",\\\\\\"23\\\\\\":\\\\\\"25:58\\\\\\",\\\\\\"24\\\\\\":\\\\\\"26:58\\\\\\"}\\",\\n \\"IsDefault\\": true,\\n \\"Owner\\": \\"952795****\\",\\n \\"ProjectId\\": 100001,\\n \\"Priority\\": 1,\\n \\"SlaMinu\\": 30,\\n \\"SlaHour\\": 9,\\n \\"BaselineId\\": 1234,\\n \\"BaselineName\\": \\"Baseline name\\",\\n \\"HourExpDetail\\": \\"{\\\\\\"1\\\\\\":\\\\\\"03:28\\\\\\",\\\\\\"2\\\\\\":\\\\\\"04:28\\\\\\",\\\\\\"3\\\\\\":\\\\\\"05:28\\\\\\",\\\\\\"4\\\\\\":\\\\\\"06:28\\\\\\",\\\\\\"5\\\\\\":\\\\\\"07:28\\\\\\",\\\\\\"6\\\\\\":\\\\\\"08:28\\\\\\",\\\\\\"7\\\\\\":\\\\\\"09:28\\\\\\",\\\\\\"8\\\\\\":\\\\\\"10:28\\\\\\",\\\\\\"9\\\\\\":\\\\\\"11:28\\\\\\",\\\\\\"10\\\\\\":\\\\\\"12:28\\\\\\",\\\\\\"11\\\\\\":\\\\\\"13:28\\\\\\",\\\\\\"12\\\\\\":\\\\\\"14:28\\\\\\",\\\\\\"13\\\\\\":\\\\\\"15:28\\\\\\",\\\\\\"14\\\\\\":\\\\\\"16:28\\\\\\",\\\\\\"15\\\\\\":\\\\\\"17:28\\\\\\",\\\\\\"16\\\\\\":\\\\\\"18:28\\\\\\",\\\\\\"17\\\\\\":\\\\\\"19:28\\\\\\",\\\\\\"18\\\\\\":\\\\\\"20:28\\\\\\",\\\\\\"19\\\\\\":\\\\\\"21:28\\\\\\",\\\\\\"20\\\\\\":\\\\\\"22:28\\\\\\",\\\\\\"21\\\\\\":\\\\\\"23:28\\\\\\",\\\\\\"22\\\\\\":\\\\\\"24:28\\\\\\",\\\\\\"23\\\\\\":\\\\\\"25:28\\\\\\",\\\\\\"24\\\\\\":\\\\\\"26:28\\\\\\"}\\",\\n \\"UseFlag\\": true,\\n \\"ExpHour\\": 7,\\n \\"BaselineType\\": \\"DAILY\\",\\n \\"ExpMinu\\": 30\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 0000-ABCD-EFG****\\n The specified parameters are invalid.\\n 1031203110005\\n true\\n \\n 1\\n 10\\n 100\\n \\n {\\"1\\":\\"03:58\\",\\"2\\":\\"04:58\\",\\"3\\":\\"05:58\\",\\"4\\":\\"06:58\\",\\"5\\":\\"07:58\\",\\"6\\":\\"08:58\\",\\"7\\":\\"09:58\\",\\"8\\":\\"10:58\\",\\"9\\":\\"11:58\\",\\"10\\":\\"12:58\\",\\"11\\":\\"13:58\\",\\"12\\":\\"14:58\\",\\"13\\":\\"15:58\\",\\"14\\":\\"16:58\\",\\"15\\":\\"17:58\\",\\"16\\":\\"18:58\\",\\"17\\":\\"19:58\\",\\"18\\":\\"20:58\\",\\"19\\":\\"21:58\\",\\"20\\":\\"22:58\\",\\"21\\":\\"23:58\\",\\"22\\":\\"24:58\\",\\"23\\":\\"25:58\\",\\"24\\":\\"26:58\\"}\\n true\\n 952795****\\n 9527\\n 1\\n 30\\n 9\\n 1234\\n 基线名称\\n {\\"1\\":\\"03:28\\",\\"2\\":\\"04:28\\",\\"3\\":\\"05:28\\",\\"4\\":\\"06:28\\",\\"5\\":\\"07:28\\",\\"6\\":\\"08:28\\",\\"7\\":\\"09:28\\",\\"8\\":\\"10:28\\",\\"9\\":\\"11:28\\",\\"10\\":\\"12:28\\",\\"11\\":\\"13:28\\",\\"12\\":\\"14:28\\",\\"13\\":\\"15:28\\",\\"14\\":\\"16:28\\",\\"15\\":\\"17:28\\",\\"16\\":\\"18:28\\",\\"17\\":\\"19:28\\",\\"18\\":\\"20:28\\",\\"19\\":\\"21:28\\",\\"20\\":\\"22:28\\",\\"21\\":\\"23:28\\",\\"22\\":\\"24:28\\",\\"23\\":\\"25:28\\",\\"24\\":\\"26:28\\"}\\n true\\n 7\\n DAILY\\n 30\\n \\n \\n","errorExample":""}]', - 'title' => 'ListBaselineConfigs', - 'summary' => 'Queries a list of baselines.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'GetBaselineKeyPath' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '78230', - 'abilityTreeNodes' => [ - 'FEATUREdideSFSFU4', - ], - ], - 'parameters' => [ - [ - 'name' => 'BaselineId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the event.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1234', - ], - ], - [ - 'name' => 'Bizdate', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2020-07-07T00:00:00+0800', - ], - ], - [ - 'name' => 'InGroupId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the event.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The timestamp when the event was found.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The unique ID of the call. After an error occurs, you can troubleshoot the problem based on the ID.', - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'ErrorMessage' => [ - 'description' => 'Error message', - 'type' => 'string', - 'example' => 'The specified parameters are invalid.', - ], - 'ErrorCode' => [ - 'description' => 'Error code', - 'type' => 'string', - 'example' => '1031203110005', - ], - 'Success' => [ - 'description' => 'Whether the call is successful.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The information about the key path.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Owner' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the node owner.'."\n", - 'type' => 'string', - 'example' => '9527952****', - ], - 'NodeName' => [ - 'description' => 'The name of the node.'."\n", - 'type' => 'string', - 'example' => 'Node name', - ], - 'Bizdate' => [ - 'description' => 'The data timestamp of the instance.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1553443200000', - ], - 'ProjectId' => [ - 'description' => 'The ID of the workspace to which the node belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'InstanceId' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12345', - ], - 'PrgType' => [ - 'description' => 'The type of the node. Valid values: 23, 10, 6, and 99. The value 23 indicates that the node is a Data Integration node. The value 10 indicates that the node is a MaxCompute SQL node. The value 6 indicates that the node is a Shell node. The value 99 indicates that the node is a zero load node.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'NodeId' => [ - 'description' => 'The node ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'InGroupId' => [ - 'description' => 'The ID of the scheduling cycle of the instance. Valid values: 1 to 288.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Runs' => [ - 'description' => 'The running records of the instance.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status of the instance. Valid values: NOT_RUN, WAIT_TIME, WAIT_RESOURCE, RUNNING, CHECKING, CHECKING_CONDITION, FAILURE, and SUCCESS. The value NOT_RUN indicates that the instance is not run. The value WAIT_TIME indicates that the instance is waiting to be run. The value WAIT_RESOURCE indicates that the instance is waiting for resources. The value RUNNING indicates that the instance is running. The value CHECKING indicates that data quality is being checked for the instance. The value CHECKING_CONDITION indicates that branch conditions are being checked for the instance. The value FAILURE indicates that the instance fails to run. The value SUCCESS indicates that the instance is run.'."\n", - 'type' => 'string', - 'example' => 'SUCCESS', - ], - 'AbsTime' => [ - 'description' => 'The timestamp obtained by adding the predicted time when the instance started to run to the historical average running duration of the instance.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1553531402000', - ], - 'BeginRunningTime' => [ - 'description' => 'The timestamp of the actual time when the instance started to run.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1553531401000', - ], - 'FinishTime' => [ - 'description' => 'The timestamp of the actual time when the instance finished running.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1553531401000', - ], - 'BeginCast' => [ - 'description' => 'The timestamp of the predicted time when the instance started to run.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1553531686000', - ], - 'EndCast' => [ - 'description' => 'The timestamp of the predicted time when the instance finished running.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1553531687000', - ], - 'BeginWaitResTime' => [ - 'description' => 'The timestamp when the instance started to wait for resources.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1553531401000', - ], - 'BeginWaitTimeTime' => [ - 'description' => 'The timestamp when the instance started to wait for the scheduling time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1553531400000', - ], - ], - ], - ], - 'Topics' => [ - 'description' => 'The information about the events that are associated with the instance.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'TopicName' => [ - 'description' => 'The name of the event.'."\n", - 'type' => 'string', - 'example' => '1234', - ], - 'InstanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'TopicId' => [ - 'description' => 'The event ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'AddTime' => [ - 'description' => 'The timestamp when the event was found.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1553531401000', - ], - ], - ], - ], - ], - 'description' => '', - ], - ], - ], - 'description' => '', - ], - ], - ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'Forbidden.Wkbench.BaselineNoPermission', - 'errorMessage' => 'You are not authorized to access the baseline.', - ], - [ - 'errorCode' => 'Forbidden.Wkbench.ProjectNoPermission', - 'errorMessage' => 'You are not authorized to access the workspace.', - ], - [ - 'errorCode' => 'Forbidden.Not.Server', - 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.', - ], - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'Invalid.Wkbench.BaselineStatusNotExist', - 'errorMessage' => 'The BaselineStatus does not exist.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Owner\\": \\"9527952****\\",\\n \\"NodeName\\": \\"Node name\\",\\n \\"Bizdate\\": 1553443200000,\\n \\"ProjectId\\": 1234,\\n \\"InstanceId\\": 123456,\\n \\"PrgType\\": 10,\\n \\"NodeId\\": 1234,\\n \\"InGroupId\\": 1,\\n \\"Runs\\": [\\n {\\n \\"Status\\": \\"SUCCESS\\",\\n \\"AbsTime\\": 1553531402000,\\n \\"BeginRunningTime\\": 1553531401000,\\n \\"FinishTime\\": 1553531401000,\\n \\"BeginCast\\": 1553531686000,\\n \\"EndCast\\": 1553531687000,\\n \\"BeginWaitResTime\\": 1553531401000,\\n \\"BeginWaitTimeTime\\": 1553531400000\\n }\\n ],\\n \\"Topics\\": [\\n {\\n \\"TopicName\\": \\"1234\\",\\n \\"InstanceId\\": 1234,\\n \\"TopicId\\": 1234,\\n \\"AddTime\\": 1553531401000\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 0000-ABCD-EFG****\\n The specified parameters are invalid.\\n 1031203110005\\n true\\n \\n 9527952****\\n 节点名称\\n 1553443200000\\n 1234\\n 12345\\n 10\\n 1234\\n 1\\n \\n SUCCESS\\n 1553531402000\\n 1553531401000\\n 1553443200000\\n 9527952****\\n 1553531401000\\n 1234\\n 1553531686000\\n 1234\\n 1553531687000\\n 1553531401000\\n 1\\n 节点名称\\n 1553443200000\\n 1553531400000\\n 1234\\n \\n \\n 1234\\n 1234\\n 1234\\n 1553531401000\\n \\n \\n","errorExample":""}]', - 'title' => 'GetBaselineKeyPath', - 'summary' => 'The information about the events that are associated with the instance.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'GetBaselineStatus' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '78231', - 'abilityTreeNodes' => [ - 'FEATUREdideSFSFU4', - ], - ], - 'parameters' => [ - [ - 'name' => 'BaselineId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the baseline.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1234', - ], - ], - [ - 'name' => 'Bizdate', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The data timestamp of the baseline instance. Specify the time in the ISO 8601 standard in the yyyy-MM-dd\'T\'HH:mm:ssZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2020-07-07T00:00:00+0800', - ], - ], - [ - 'name' => 'InGroupId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the scheduling cycle of the baseline instance. For a baseline instance that is scheduled by day, the value of this parameter is 1. For a baseline instance that is scheduled by hour, the value of this parameter ranges from 1 to 24.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], - ], - ], - 'responses' => [ - 200 => [ - 'headers' => [], - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The ID of the request. You can use the ID to troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'The specified parameters are invalid.', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'example' => '1031203110005', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The details of the baseline instance.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status of the baseline. Valid values: ERROR, SAFE, DANGEROUS, and OVER. The value ERROR indicates that no nodes are associated with the baseline, or all nodes associated with the baseline are suspended. The value SAFE indicates that nodes finish running before the alerting time. The value DANGEROUS indicates that nodes are still running after the alerting time but before the committed completion time. The value OVER indicates that nodes are still running after the committed completion time.'."\n", - 'type' => 'string', - 'example' => 'SAFE', - ], - 'Owner' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the baseline owner. Multiple IDs are separated by commas (,).'."\n", - 'type' => 'string', - 'example' => '9527952795****', - ], - 'FinishTime' => [ - 'description' => 'The timestamp of the actual time when the baseline instance finished running. This parameter is returned if the value of the FinishStatus parameter is FINISH.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1553443200000', - ], - 'ProjectId' => [ - 'description' => 'The ID of the workspace to which the baseline belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'Priority' => [ - 'description' => 'The priority of the baseline. Valid values: 1, 2, 5, 7, and 8.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'EndCast' => [ - 'description' => 'The timestamp of the predicted time when the baseline instance finished running.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1553443200000', - ], - 'InGroupId' => [ - 'description' => 'The ID of the scheduling cycle of the baseline instance. For a baseline instance that is scheduled by day, the value of this parameter is 1. For a baseline instance that is scheduled by hour, the value of this parameter ranges from 1 to 24.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'BaselineName' => [ - 'description' => 'The name of the baseline.'."\n", - 'type' => 'string', - 'example' => 'Baseline name'."\n", - ], - 'BaselineId' => [ - 'description' => 'The ID of the baseline.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'FinishStatus' => [ - 'description' => 'The status of the baseline instance. Valid values: UNFINISH and FINISH. The value UNFINISH indicates that the baseline instance is still running. The value FINISH indicates that the baseline instance finishes running.'."\n", - 'type' => 'string', - 'example' => 'UNFINISH', - ], - 'Bizdate' => [ - 'description' => 'The data timestamp of the baseline instance.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1553443200000', - ], - 'Buffer' => [ - 'description' => 'The margin of the baseline instance. Unit: seconds.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '1200', - ], - 'SlaTime' => [ - 'description' => 'The timestamp of the committed completion time of the baseline instance.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1553443200000', - ], - 'ExpTime' => [ - 'description' => 'The timestamp of the alerting time of the baseline instance.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1553443200000', - ], - 'LastInstance' => [ - 'description' => 'The information about the last generated instance.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status of the instance. Valid values: NOT_RUN, WAIT_TIME, WAIT_RESOURCE, RUNNING, CHECKING, CHECKING_CONDITION, FAILURE, and SUCCESS. The value NOT_RUN indicates that the instance is not run. The value WAIT_TIME indicates that the instance is waiting to be run. The value WAIT_RESOURCE indicates that the instance is waiting for resources. The value RUNNING indicates that the instance is running. The value CHECKING indicates that data quality is being checked for the instance. The value CHECKING_CONDITION indicates that branch conditions are being checked for the instance. The value FAILURE indicates that the instance fails to run. The value SUCCESS indicates that the instance is run.'."\n", - 'type' => 'string', - 'example' => 'SUCCESS', - ], - 'Owner' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the node owner.'."\n", - 'type' => 'string', - 'example' => '9527952795****', - ], - 'FinishTime' => [ - 'description' => 'The timestamp of the actual time when the instance finished running.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1553443200000', - ], - 'NodeName' => [ - 'description' => 'The name of the node.'."\n", - 'type' => 'string', - 'example' => 'Node name'."\n", - ], - 'ProjectId' => [ - 'description' => 'The ID of the workspace to which the node belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'InstanceId' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12345', - ], - 'EndCast' => [ - 'description' => 'The timestamp of the predicted time when the instance finished running.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1553443200000', - ], - 'NodeId' => [ - 'description' => 'The ID of the node.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - ], - ], - 'BlockInstance' => [ - 'description' => 'The information about the key instance.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status of the instance. Valid values: NOT_RUN, WAIT_TIME, WAIT_RESOURCE, RUNNING, CHECKING, CHECKING_CONDITION, FAILURE, and SUCCESS. The value NOT_RUN indicates that the instance is not run. The value WAIT_TIME indicates that the instance is waiting to be run. The value WAIT_RESOURCE indicates that the instance is waiting for resources. The value RUNNING indicates that the instance is running. The value CHECKING indicates that data quality is being checked for the instance. The value CHECKING_CONDITION indicates that branch conditions are being checked for the instance. The value FAILURE indicates that the instance fails to run. The value SUCCESS indicates that the instance is run.'."\n", - 'type' => 'string', - 'example' => 'SUCCESS', - ], - 'Owner' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the node owner.'."\n", - 'type' => 'string', - 'example' => '9527952795****', - ], - 'FinishTime' => [ - 'description' => 'The timestamp of the actual time when the instance finished running.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1553443200000', - ], - 'NodeName' => [ - 'description' => 'The name of the node.'."\n", - 'type' => 'string', - 'example' => 'Node name'."\n", - ], - 'ProjectId' => [ - 'description' => 'The ID of the workspace to which the node belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'InstanceId' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12345', - ], - 'EndCast' => [ - 'description' => 'The timestamp of the predicted time when the instance finished running.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1553443200000', - ], - 'NodeId' => [ - 'description' => 'The ID of the node.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'Forbidden.Not.Server', - 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.', - ], - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Status\\": \\"SAFE\\",\\n \\"Owner\\": \\"9527952795****\\",\\n \\"FinishTime\\": 1553443200000,\\n \\"ProjectId\\": 1234,\\n \\"Priority\\": 1,\\n \\"EndCast\\": 1553443200000,\\n \\"InGroupId\\": 1,\\n \\"BaselineName\\": \\"基线名称\\",\\n \\"BaselineId\\": 1234,\\n \\"FinishStatus\\": \\"UNFINISH\\",\\n \\"Bizdate\\": 1553443200000,\\n \\"Buffer\\": 1200,\\n \\"SlaTime\\": 1553443200000,\\n \\"ExpTime\\": 1553443200000,\\n \\"LastInstance\\": {\\n \\"Status\\": \\"SUCCESS\\",\\n \\"Owner\\": \\"9527952795****\\",\\n \\"FinishTime\\": 1553443200000,\\n \\"NodeName\\": \\"节点名称\\",\\n \\"ProjectId\\": 1234,\\n \\"InstanceId\\": 12345,\\n \\"EndCast\\": 1553443200000,\\n \\"NodeId\\": 1234\\n },\\n \\"BlockInstance\\": {\\n \\"Status\\": \\"SUCCESS\\",\\n \\"Owner\\": \\"9527952795****\\",\\n \\"FinishTime\\": 1553443200000,\\n \\"NodeName\\": \\"节点名称\\",\\n \\"ProjectId\\": 1234,\\n \\"InstanceId\\": 12345,\\n \\"EndCast\\": 1553443200000,\\n \\"NodeId\\": 1234\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 0000-ABCD-EFG****\\n The specified parameters are invalid.\\n 1031203110005\\n true\\n \\n SAFE\\n 9527952795****\\n 1553443200000\\n 1234\\n 1\\n 1553443200000\\n 1\\n 基线名称\\n 1234\\n UNFINISH\\n 1553443200000\\n 1200\\n 1553443200000\\n 1553443200000\\n \\n SUCCESS\\n 9527952795****\\n 1553443200000\\n 节点名称\\n 1234\\n 12345\\n 1553443200000\\n 1234\\n \\n \\n SUCCESS\\n 9527952795****\\n 1553443200000\\n 节点名称\\n 1234\\n 12345\\n 1553443200000\\n 1234\\n \\n \\n","errorExample":""}]', - 'title' => 'GetBaselineStatus', - 'summary' => 'Queries the details of a baseline instance.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListBaselineStatuses' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '78296', - 'abilityTreeNodes' => [ - 'FEATUREdideSFSFU4', - ], - ], - 'parameters' => [ - [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of the page to return. Valid values: 1 to 30. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], - ], - [ - 'name' => 'Bizdate', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The data timestamp of the baseline instance. Specify the time in the ISO 8601 standard in the yyyy-MM-dd\'T\'HH:mm:ssZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2020-07-07T00:00:00+0800', - ], - ], - [ - 'name' => 'Priority', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The priority of the baseline. Valid values: 1, 3, 5, 7, and 8. Multiple priorities are separated by commas (,).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1,3,5,7,8', - ], - ], - [ - 'name' => 'SearchText', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The keyword of the baseline name used to search for the baseline.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Keyword of the baseline name'."\n", - ], - ], - [ - 'name' => 'Owner', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the baseline owner.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '9527952795****', - ], - ], - [ - 'name' => 'TopicId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the event.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1234', - ], - ], - [ - 'name' => 'FinishStatus', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The status of the baseline instance. Valid values: UNFINISH and FINISH. The value UNFINISH indicates that the baseline instance is still running. The value FINISH indicates that the baseline instance finishes running. Multiple states are separated by commas (,).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'FINISH,UNFINISH', - ], - ], - [ - 'name' => 'Status', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The status of the baseline. Valid values: ERROR, SAFE, DANGEROUS, and OVER. The value ERROR indicates that no nodes are associated with the baseline, or all nodes associated with the baseline are suspended. The value SAFE indicates that nodes finish running before the alerting time. The value DANGEROUS indicates that nodes are still running after the alerting time but before the committed completion time. The value OVER indicates that nodes are still running after the committed completion time. Multiple states are separated by commas (,).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SAFE,DANGROUS,OVER', - ], - ], - [ - 'name' => 'BaselineTypes', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The type of the baseline. Valid values: DAILY and HOURLY. The value DAILY indicates that the baseline is scheduled by day. The value HOURLY indicates that the baseline is scheduled by hour. Multiple types are separated by commas (,).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'DAILY,HOURLY', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The ID of the request. You can use the ID to troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'The specified parameters are invalid.', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of baseline instances.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'BaselineStatuses' => [ - 'description' => 'The list of baseline instances.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the baseline instances.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status of the baseline. Valid values: ERROR, SAFE, DANGEROUS, and OVER. The value ERROR indicates that no nodes are associated with the baseline, or all nodes associated with the baseline are suspended. The value SAFE indicates that nodes are run before the alert duration begins. The value DANGEROUS indicates that nodes are still running after the alert duration ends but the committed completion time does not arrive. The value OVER indicates that nodes are still running after the committed completion time.'."\n", - 'type' => 'string', - 'example' => 'SAFE', - ], - 'Owner' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the baseline owner. Multiple IDs are separated by commas (,).'."\n", - 'type' => 'string', - 'example' => '9527952795****', - ], - 'FinishTime' => [ - 'description' => 'The timestamp of the actual time when the baseline instance finished running. This parameter is returned if the value of the FinishStatus parameter is FINISH.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1553531400000', - ], - 'ProjectId' => [ - 'description' => 'The ID of the workspace to which the baseline belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'Priority' => [ - 'description' => 'The priority of the baseline. Valid values: {1,3,5,7,8}.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'EndCast' => [ - 'description' => 'The timestamp of the predicted time when the baseline instance finished running.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1553531400000', - ], - 'InGroupId' => [ - 'description' => 'The ID of the cycle of the baseline instance. Valid values of the ID of an hour-level cycle: \\[1,24]. The ID of a day-level cycle is 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'BaselineName' => [ - 'description' => 'The name of the baseline.'."\n", - 'type' => 'string', - 'example' => 'Baseline name'."\n", - ], - 'BaselineId' => [ - 'description' => 'The baseline ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'FinishStatus' => [ - 'description' => 'The status of the baseline instance. Valid values: UNFINISH and FINISH.'."\n", - 'type' => 'string', - 'example' => 'UNFINISH', - ], - 'Bizdate' => [ - 'description' => 'The data timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1553443200000', - ], - 'Buffer' => [ - 'description' => 'The margin of the baseline instance. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1800', - ], - 'SlaTime' => [ - 'description' => 'The timestamp of the actual time when the baseline instance finished running.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1553531400000', - ], - 'ExpTime' => [ - 'description' => 'The timestamp of the alerting time of the baseline instance.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1553531400000', - ], - 'BaselineType' => [ - 'description' => 'The type of the baseline, including DAILY and HOURLY. Separate multiple types with commas (,).', - 'type' => 'string', - 'example' => 'DAILY,HOURLY', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'Forbidden.Not.Server', - 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.', - ], - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"BaselineStatuses\\": [\\n {\\n \\"Status\\": \\"SAFE\\",\\n \\"Owner\\": \\"9527952795****\\",\\n \\"FinishTime\\": 1553531400000,\\n \\"ProjectId\\": 1234,\\n \\"Priority\\": 1,\\n \\"EndCast\\": 1553531400000,\\n \\"InGroupId\\": 1,\\n \\"BaselineName\\": \\"基线名称\\",\\n \\"BaselineId\\": 1234,\\n \\"FinishStatus\\": \\"UNFINISH\\",\\n \\"Bizdate\\": 1553443200000,\\n \\"Buffer\\": 1800,\\n \\"SlaTime\\": 1553531400000,\\n \\"ExpTime\\": 1553531400000,\\n \\"BaselineType\\": \\"基线类型\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 0000-ABCD-EFG****\\n The specified parameters are invalid.\\n Invalid.Tenant.ConnectionNotExists\\n true\\n \\n 1\\n 10\\n 100\\n \\n SAFE\\n 9527952795****\\n 1553531400000\\n 1234\\n 1\\n 1553531400000\\n 1\\n 基线名称\\n 1234\\n UNFINISH\\n 1553443200000\\n 1800\\n 1553531400000\\n 1553531400000\\n \\n \\n","errorExample":""}]', - 'title' => 'ListBaselineStatuses', - 'summary' => 'Queries a list of baseline instances.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DeleteRemind' => [ - 'summary' => 'Deletes a custom alert rule.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '78217', - 'abilityTreeNodes' => [ - 'FEATUREdideRJGWWC', - ], - ], - 'parameters' => [ - [ - 'name' => 'RemindId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the custom alert rule.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1234', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'Indicates whether the custom alert rule is deleted. Valid values: true and false. The value true indicates that the custom alert rule is deleted. The value false indicates that the custom alert rule fails to be deleted.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'The specified parameters are invalid.', - ], - 'RequestId' => [ - 'description' => 'The ID of the request. You can use the ID to troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'example' => '1031203110005', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - ], - 500 => [ - [ - 'errorCode' => 'Forbidden.Not.Server', - 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.', - ], - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1031203110005\\"\\n}","errorExample":""},{"type":"xml","example":"0000-ABCD-EFG****\\n200\\ntrue\\n1031203110005\\nThe specified parameters are invalid.\\ntrue","errorExample":""}]', - 'title' => 'DeleteRemind', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'UpdateRemind' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '78381', - 'abilityTreeNodes' => [ - 'FEATUREdideRJGWWC', - ], - ], - 'parameters' => [ - [ - 'name' => 'RemindId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The custom alert rule ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1234', - ], - ], - [ - 'name' => 'RemindName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the custom alert rule. The name cannot exceed 128 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'update_remindname', - ], - ], - [ - 'name' => 'DndEnd', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The end of the period during which no alert notifications are sent. Specify the time in the hh:mm format. Valid values of hh: \\[0,23]. Valid values of mm: \\[0,59].'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '08:00', - ], - ], - [ - 'name' => 'RemindUnit', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The type of the object to which the custom alert rule is applied. Valid values:'."\n" - ."\n" - .'* NODE'."\n" - .'* BASELINE'."\n" - .'* PROJECT'."\n" - .'* BIZPROCESS'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'NODE', - 'enum' => [ - 'NODE', - 'BASELINE', - 'PROJECT', - 'BIZPROCESS', - ], - ], - ], - [ - 'name' => 'NodeIds', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the node to which the custom alert rule is applied. A maximum of 50 nodes can be specified for a custom alert rule. You can specify multiple IDs. Separate multiple IDs with commas (,). This parameter takes effect when you set the RemindUnit parameter to NODE.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1,2,3', - ], - ], - [ - 'name' => 'BaselineIds', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the baseline to which the custom alert rule is applied. A maximum of 5 baselines can be specified for a custom alert rule. You can specify multiple IDs. Separate multiple IDs with commas (,). This parameter takes effect when you set the RemindUnit parameter to BASELINE.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1,2,3', - ], - ], - [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the workspace to which the custom alert rule is applied. You can specify only one workspace for a custom alert rule. This parameter takes effect when you set the RemindUnit parameter to PROJECT.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1234', - ], - ], - [ - 'name' => 'BizProcessIds', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the workflow to which the custom alert rule is applied. A maximum of 5 workflows can be specified for a custom alert rule. You can specify multiple IDs. Separate multiple IDs with commas (,). This parameter takes effect when you set the RemindUnit parameter to BIZPROCESS.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1,2,3', - ], - ], - [ - 'name' => 'RemindType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The condition that triggers the alert rule. Valid values:'."\n" - ."\n" - .'* FINISHED: The system monitors an instance when it starts to run and sends an alert notification after the running of the instance is complete.'."\n" - .'* UNFINISHED: The system monitors an instance when it starts to run and sends an alert notification if the instance is still running at the specified point in time.'."\n" - .'* ERROR: The system monitors an instance when it starts to run and sends an alert notification if an error occurs.'."\n" - .'* CYCLE_UNFINISHED: The system sends an alert notification if a monitored instance is still running at the end of the specified cycle. In most cases, you can configure this trigger condition for node instances that are scheduled to run by hour.'."\n" - .'* TIMEOUT: The system monitors an instance when it starts to run and sends an alert notification if the instance is still running after the specified period ends. In most cases, you can configure this trigger condition to monitor the running duration of node instances.'."\n" - ."\n" - .'For more information, see [Manage custom alert rules](~~138172~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'FINISHED', - 'enum' => [ - 'FINISHED', - 'UNFINISHED', - 'ERROR', - 'CYCLE_UNFINISHED', - 'TIMEOUT', - 'EXHAUSTED_ERROR', - ], - ], - ], - [ - 'name' => 'MaxAlertTimes', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The maximum number of alerts. Valid values: 1 to 10. Default value: 3.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '10', - 'minimum' => '1', - 'example' => '3', - 'default' => '3', - ], - ], - [ - 'name' => 'AlertInterval', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The intervals at which alert notifications are sent. Unit: seconds. Minimum value: 1200. Default value: 1800.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'maximum' => '1800', - 'minimum' => '1200', - 'example' => '1800', - 'default' => '1800', - ], - ], - [ - 'name' => 'Detail', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The details of the conditions that trigger an alert.'."\n" - ."\n" - .'* If the RemindType parameter is set to FINISHED, leave this parameter empty.'."\n" - .'* If the RemindType parameter is set to UNFINISHED, set this parameter to key-value pairs. Example: {"hour":23,"minu":59}. Valid values of hour: \\[0,47]. Valid values of minu: \\[0,59].'."\n" - .'* If the RemindType parameter is set to ERROR, leave this parameter empty.'."\n" - .'* If the RemindType parameter is set to CYCLE_UNFINISHED, set this parameter to key-value pairs in the JSON format. Example: {"1":"05:50","2":"06:50","3":"07:50","4":"08:50","5":"09:50","6":"10:50","7":"11:50","8":"12:50","9":"13:50","10":"14:50","11":"15:50","12":"16:50","13":"17:50","14":"18:50","15":"19:50","16":"20:50","17":"21:50","18":"22:50","19":"23:50","20":"24:50","21":"25:50"}. A key in the JSON string indicates the sequence number of a cycle. Valid values of keys: 1 to 288. A value in the JSON string indicates the time in point when a monitored instance times out in the relevant cycle. Values must be in the format of hh:mm. Valid values of hh: \\[0,47]. Valid values of mm: \\[0,59].'."\n" - .'* If the RemindType parameter is set to TIMEOUT, set this parameter to the timeout period. Unit: seconds. Example: 1800. This indicates that an alert notification is sent if the running duration of a monitored instance exceeds 30 minutes.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"hour":23,"minu":59}', - ], - ], - [ - 'name' => 'AlertUnit', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The recipient to whom alert notifications are sent. Valid values: OWNER and OTHER. The value OWNER indicates that alert notifications are sent to the object owner. The value OTHER indicates that alert notifications are sent to a specified user.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'OWNER', - 'default' => '', - 'enum' => [ - 'OTHER', - 'OWNER', - ], - ], - ], - [ - 'name' => 'AlertMethods', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The notification method. Valid values:'."\n" - ."\n" - .'* MAIL: Alert notifications are sent by email.'."\n" - .'* SMS: Alert notifications are sent by text message.'."\n" - .'* PHONE: Alert notifications are sent by phone call. You can use this notification method only in DataWorks Professional Edition or more advanced editions.'."\n" - .'* DINGROBOTS: Alert notifications are sent by DingTalk message. You can use this notification method only if the RobotUrls parameter is configured.'."\n" - .'* WEBHOOKS (WeCom or Lark chatbot): Alert notifications are sent by WeCom or Lark message. You can use this notification method only if the Webhooks parameter is configured.'."\n" - ."\n" - .'Multiple notification methods are separated by commas (,).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SMS,MAIL', - 'default' => '', - 'enum' => [], - ], - ], - [ - 'name' => 'AlertTargets', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The value format required by this parameter varies based on the value that you specify for the AlertUnit parameter. Take note of the following items:'."\n" - ."\n" - .'* If the AlertUnit parameter is set to OWNER, leave this parameter empty.'."\n" - .'* If the AlertUnit parameter is set to OTHER, set this parameter to the unique ID (UID) of the specified user. You can specify multiple UIDs. Separate them with commas (,). A maximum of 10 UIDs can be specified for receiving alert notifications.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '9527952795279527', - ], - ], - [ - 'name' => 'UseFlag', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether to enable the alert rule. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'RobotUrls', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The webhook URL of the DingTalk chatbot. You can specify multiple webhook URLs. Separate multiple webhook URLs with commas (,). If this parameter is set to undefined, the specified webhook URLs are cleared.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=******************************', - ], - ], - [ - 'name' => 'Webhooks', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The webhook URL of the WeCom or Lark chatbot. You can specify multiple webhook URLs. Separate multiple webhook URLs with commas (,). The value of AlertMethods must include WEBHOOKS. If this parameter is set to undefined, the specified webhook URLs are cleared.'."\n" - ."\n" - .'Only DataWorks Enterprise Edition supports this parameter. The webhook URL-based alerting feature is supported in the following regions: China (Shanghai), China (Chengdu), China (Zhangjiakou), China (Beijing), China (Hangzhou), China (Shenzhen), China (Hong Kong), Germany (Frankfurt), and Singapore.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://open.feishu.cn/open-apis/bot/v2/hook/*******'."\n", - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'Indicates whether the modification to the custom alert rule succeeds.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified parameters are invalid.', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can use the ID to troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '1031203110005', - ], - ], - 'description' => '', - ], - ], - ], - 'errorCodes' => [ - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.Resource', - 'errorMessage' => 'You have reached the limit for the resource. Please contact us by submitting a ticket.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'Forbidden.Not.Server', - 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.', - ], - [ - 'errorCode' => 'Forbidden.Wkbench.BaselineNoPermission', - 'errorMessage' => 'You are not authorized to access the baseline.', - ], - [ - 'errorCode' => 'Forbidden.Wkbench.ProjectNoPermission', - 'errorMessage' => 'You are not authorized to access the workspace.', - ], - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'Forbidden.Wkbench.RemindNoPermission', - 'errorMessage' => 'You are not authorized to modify the reminder.', - ], - [ - 'errorCode' => 'Invalid.Wkbench.RemindNotExist', - 'errorMessage' => 'The reminder does not exist.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1031203110005\\"\\n}","errorExample":""},{"type":"xml","example":"0000-ABCD-EFG****\\n200\\ntrue\\n1031203110005\\nThe specified parameters are invalid.\\ntrue","errorExample":""}]', - 'title' => 'UpdateRemind', - 'summary' => 'Modifies a custom alert rule.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'CreateRemind' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '78196', - 'abilityTreeNodes' => [ - 'FEATUREdideRJGWWC', - ], - ], - 'parameters' => [ - [ - 'name' => 'RemindName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the custom alert rule. The name cannot exceed 128 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test_error_remind', - ], - ], - [ - 'name' => 'DndEnd', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The end time of the quiet hours. Specify the time in the hh:mm format. Valid values of hh: \\[0,23]. Valid values of mm: \\[0,59].'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '08:00', - ], - ], - [ - 'name' => 'RemindUnit', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The type of the object to which the custom alert rule is applied. Valid values: NODE, BASELINE, PROJECT, and BIZPROCESS. The value NODE indicates a node. The value BASELINE indicates a baseline. The value PROJECT indicates a workspace. The value BIZPROCESS indicates a workflow.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'NODE', - 'enum' => [ - 'NODE', - 'BASELINE', - 'PROJECT', - 'BIZPROCESS', - ], - ], - ], - [ - 'name' => 'NodeIds', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the node to which the custom alert rule is applied. This parameter takes effect when the RemindUnit parameter is set to NODE. You can specify multiple IDs. Separate multiple IDs with commas (,). A maximum of 50 nodes can be specified for a custom alert rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1,2,3', - ], - ], - [ - 'name' => 'BaselineIds', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the baseline to which the custom alert rule is applied. This parameter takes effect when the RemindUnit parameter is set to BASELINE. You can specify multiple IDs. Separate multiple IDs with commas (,). A maximum of five baselines can be specified for a custom alert rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1,2,3', - ], - ], - [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the workspace to which the custom alert rule is applied. This parameter takes effect when the RemindUnit parameter is set to PROJECT. You can specify only one workspace for a custom alert rule.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '9527', - ], - ], - [ - 'name' => 'BizProcessIds', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the workflow to which the custom alert rule is applied. This parameter takes effect when the RemindUnit parameter is set to BIZPROCESS. You can specify multiple IDs. Separate multiple IDs with commas (,). A maximum of five workflows can be specified for a custom alert rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1,2,3', - ], - ], - [ - 'name' => 'RemindType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The conditions that trigger an alert. Valid values: FINISHED, UNFINISHED, ERROR, CYCLE_UNFINISHED, and TIMEOUT.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'FINISHED', - 'enum' => [ - 'FINISHED', - 'UNFINISHED', - 'ERROR', - 'CYCLE_UNFINISHED', - 'TIMEOUT', - 'EXHAUSTED_ERROR', - ], - ], - ], - [ - 'name' => 'MaxAlertTimes', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The maximum number of alerts. Valid values: 1 to 10. Default value: 3.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '10', - 'minimum' => '1', - 'example' => '2', - 'default' => '3', - ], - ], - [ - 'name' => 'AlertInterval', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The minimum interval at which alerts are reported. Unit: seconds. Minimum value: 1200. Default value: 1800.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1200', - 'example' => '1800', - 'default' => '1800', - ], - ], - [ - 'name' => 'Detail', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The details of the conditions that trigger an alert.'."\n" - ."\n" - .'* If the RemindType parameter is set to FINISHED, leave this parameter empty.'."\n" - .'* If the RemindType parameter is set to UNFINISHED, configure this parameter as key-value pairs. Example: {"hour":23,"minu":59}. Valid values of hour: \\[0,47]. Valid values of minu: \\[0,59].'."\n" - .'* If the RemindType parameter is set to ERROR, leave this parameter empty.'."\n" - .'* If the RemindType parameter is set to CYCLE_UNFINISHED, configure this parameter as key-value pairs. Example: {"1":"05:50","2":"06:50","3":"07:50","4":"08:50","5":"09:50","6":"10:50","7":"11:50","8":"12:50","9":"13:50","10":"14:50","11":"15:50","12":"16:50","13":"17:50","14":"18:50","15":"19:50","16":"20:50","17":"21:50","18":"22:50","19":"23:50","20":"24:50","21":"25:50"}. The key indicates the ID of the cycle. Valid values: \\[1,288]. The value indicates the timeout period of the node that is running in the cycle. Specify the value in the hh:mm format. Valid values of hh: \\[0,47]. Valid values of mm: \\[0,59].'."\n" - .'* If the RemindType parameter is set to TIMEOUT, set this parameter to the timeout period. Unit: seconds. Example: 1800. This value indicates that an alert is reported if the node has run for more than 30 minutes.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"hour":23,"minu":59}', - ], - ], - [ - 'name' => 'AlertUnit', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The recipient of the alert. Valid values: OWNER and OTHER. The value OWNER indicates the node owner. The value OTHER indicates a specified user.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'OWNER', - 'default' => '', - 'enum' => [ - 'OTHER', - 'OWNER', - ], - ], - ], - [ - 'name' => 'AlertMethods', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The notification method. Valid values:'."\n" - ."\n" - .'* MAIL: Alert notifications are sent by email.'."\n" - .'* SMS: Alert notifications are sent by text message. Alert notifications can be sent by text message only in the Singapore, Malaysia (Kuala Lumpur), and Germany (Frankfurt) regions.'."\n" - .'* WEBHOOKS (WeCom or Lark chatbot): Alert notifications are sent by WeCom or Lark message. If you want to use this notification method, you must configure the Webhooks parameter.'."\n" - .'* DINGROBOTS: Alert notifications are sent by DingTalk chatbot.'."\n" - ."\n" - .'You can specify multiple notification methods. Separate them with commas (,).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'SMS,MAIL', - ], - ], - [ - 'name' => 'AlertTargets', - 'in' => 'formData', - 'schema' => [ - 'description' => '* If the AlertUnit parameter is set to OWNER, leave this parameter empty.'."\n" - .'* If the AlertUnit parameter is set to OTHER, set this parameter to the ID of the Alibaba Cloud account used by the specified user. You can specify multiple IDs. Separate multiple IDs with commas (,). You can specify a maximum of 10 IDs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '9527952795279527', - ], - ], - [ - 'name' => 'RobotUrls', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The webhook URL of the DingTalk chatbot. You can specify multiple webhook URLs. Separate multiple webhook URLs with commas (,).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=******************************', - ], - ], - [ - 'name' => 'Webhooks', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The webhook URL of the WeCom or Lark chatbot. You can specify multiple webhook URLs. Separate multiple webhook URLs with commas (,). You must specify WEBHOOKS for AlertMethods.'."\n" - ."\n" - .'Only DataWorks Enterprise Edition supports this parameter. The webhook URL-based alerting feature is supported in the following regions: China (Shanghai), China (Chengdu), China (Zhangjiakou), China (Beijing), China (Hangzhou), China (Shenzhen), China (Hong Kong), Germany (Frankfurt), and Singapore.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://open.feishu.cn/open-apis/bot/v2/hook/*******', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The ID of the custom alert rule.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified parameters are invalid.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '1031203110005', - ], - ], - ], - ], - ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.Resource', - 'errorMessage' => 'You have reached the limit for the resource. Please contact us by submitting a ticket.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'Forbidden.Not.Server', - 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.', - ], - [ - 'errorCode' => 'Forbidden.Wkbench.BaselineNoPermission', - 'errorMessage' => 'You are not authorized to access the baseline.', - ], - [ - 'errorCode' => 'Forbidden.Wkbench.ProjectNoPermission', - 'errorMessage' => 'You are not authorized to access the workspace.', - ], - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'Forbidden.Wkbench.NoProject', - 'errorMessage' => 'You have not joined any project.', - ], - [ - 'errorCode' => 'Invalid.Wkbench.NodeNotExist', - 'errorMessage' => 'The node does not exist.', - ], - [ - 'errorCode' => 'Invalid.Wkbench.BaselineNotExist', - 'errorMessage' => 'The baseline does not exist.', - ], - [ - 'errorCode' => 'Forbidden.Wkbench.RemindOverlimit', - 'errorMessage' => 'The maximum number of reminders is exceeded.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 1234,\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1031203110005\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 1234\\n The specified parameters are invalid.\\n 0000-ABCD-EFG****\\n true\\n 1031203110005\\n","errorExample":""}]', - 'title' => 'CreateRemind', - 'summary' => 'Creates a custom alert rule.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'GetRemind' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '78286', - 'abilityTreeNodes' => [ - 'FEATUREdideRJGWWC', - ], - ], - 'parameters' => [ - [ - 'name' => 'RemindId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The custom alert rule ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1234', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFGH-IJKLMNOPQ', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified parameters are invalid.', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '1031203110005', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The details of the custom alert rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'MaxAlertTimes' => [ - 'description' => 'The maximum number of alerts.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'RemindUnit' => [ - 'description' => 'The type of the object to which the custom alert rule is applied. Valid values: NODE, BASELINE, PROJECT, and BIZPROCESS. The value NODE indicates a node. The value BASELINE indicates a baseline. The value PROJECT indicates a workspace. The value BIZPROCESS indicates a workflow.'."\n", - 'type' => 'string', - 'example' => 'NODE', - ], - 'AlertInterval' => [ - 'description' => 'The minimum interval at which alerts are reported. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1800', - ], - 'Useflag' => [ - 'description' => 'Indicates whether the custom alert rule is enabled. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Founder' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the creator of the custom alert rule.'."\n", - 'type' => 'string', - 'example' => '9527951795****', - ], - 'RemindId' => [ - 'description' => 'The custom alert rule ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'DndEnd' => [ - 'description' => 'The end time of the quiet hours. The value is in the hh:mm format. Valid values of hh: \\[0,23]. Valid values of mm: \\[0,59].'."\n", - 'type' => 'string', - 'example' => '08:00', - ], - 'RemindType' => [ - 'description' => 'The conditions that trigger an alert. Valid values: FINISHED, UNFINISHED, ERROR, CYCLE_UNFINISHED, and TIMEOUT.'."\n", - 'type' => 'string', - 'example' => 'FINISHED', - ], - 'AlertUnit' => [ - 'description' => 'The type of the alert recipient. For more information about alert recipient types, see the Receivers parameter. Valid values:'."\n" - ."\n" - .'* OWNER: the task owner'."\n" - .'* OTHER: specified personnel'."\n" - .'* SHIFT_SCHEDULE: personnel in a shift schedule'."\n", - 'type' => 'string', - 'example' => 'OWNER', - ], - 'DndStart' => [ - 'description' => 'The start time of the quiet hours. The value is in the hh:mm format. Valid values of hh: \\[0,23]. Valid values of mm: \\[0,59].'."\n", - 'type' => 'string', - 'example' => '00:00', - ], - 'RemindName' => [ - 'description' => 'The name of the rule.'."\n", - 'type' => 'string', - 'example' => 'Rule name', - ], - 'Detail' => [ - 'description' => '* If the value of the RemindType parameter is FINISHED, this parameter is left empty.'."\n" - .'* If the value of the RemindType parameter is UNFINISHED, the trigger conditions are returned as key-value pairs. Example: {"hour":23,"minu":59}. Valid values of hour: \\[0,47]. Valid values of minu: \\[0,59].'."\n" - .'* If the value of the RemindType parameter is ERROR, this parameter is left empty.'."\n" - .'* If the value of the RemindType parameter is CYCLE_UNFINISHED, the trigger conditions are returned as key-value pairs. Example: {"1":"05:50","2":"06:50","3":"07:50","4":"08:50","5":"09:50","6":"10:50","7":"11:50","8":"12:50","9":"13:50","10":"14:50","11":"15:50","12":"16:50","13":"17:50","14":"18:50","15":"19:50","16":"20:50","17":"21:50","18":"22:50","19":"23:50","20":"24:50","21":"25:50"}. The key indicates the ID of the cycle. Valid values: \\[1,288]. The value indicates the timeout period of the node that is running in the cycle. Specify the value in the hh:mm format. Valid values of hh: \\[0,47]. Valid values of mm: \\[0,59].'."\n" - .'* If the value of the RemindType parameter is TIMEOUT, the timeout period is returned. Unit: seconds. Example: 1800. This value indicates that an alert is reported if the node has run for more than 30 minutes.'."\n", - 'type' => 'string', - 'example' => '{"hour":23,"minu":59}', - ], - 'Robots' => [ - 'description' => 'The webhook URLs of the DingTalk chatbots.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'WebUrl' => [ - 'description' => 'The webhook URL of the DingTalk chatbot.'."\n", - 'type' => 'string', - 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=******************************', - ], - 'AtAll' => [ - 'description' => 'Indicates whether all group members are notified when the alert notification is sent to a DingTalk group. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], - 'Nodes' => [ - 'description' => 'The nodes to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is NODE.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Owner' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the node owner.'."\n", - 'type' => 'string', - 'example' => '9527951795****', - ], - 'NodeName' => [ - 'description' => 'The name of the node.'."\n", - 'type' => 'string', - 'example' => 'Node name', - ], - 'NodeId' => [ - 'description' => 'The node ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'ProjectId' => [ - 'description' => 'The ID of the workspace to which the node belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - ], - ], - ], - 'Baselines' => [ - 'description' => 'The baselines to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is BASELINE.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'BaselineName' => [ - 'description' => 'The name of the baseline.'."\n", - 'type' => 'string', - 'example' => 'Baseline name', - ], - 'BaselineId' => [ - 'description' => 'The baseline ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - ], - ], - ], - 'Projects' => [ - 'description' => 'The workspaces to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is PROJECT.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ProjectId' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - ], - ], - ], - 'BizProcesses' => [ - 'description' => 'The workflows to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is BIZPROCESS.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'BizProcessName' => [ - 'description' => 'The name of the workflow.'."\n", - 'type' => 'string', - 'example' => 'Business process name', - ], - 'BizId' => [ - 'description' => 'The ID of the workflow.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '9527', - ], - ], - ], - ], - 'AlertTargets' => [ - 'description' => 'The description of the alert recipient. For more information about alert recipients, see the Receivers parameter.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '* If the value of the AlertUnit parameter is OWNER, this parameter is left empty.'."\n" - .'* If the value of the AlertUnit parameter is OTHER, the ID of the Alibaba Cloud account used by the specified user is returned.'."\n" - .'* If the value of the AlertUnit parameter is SHIFT_SCHEDULE, the shift schedule ID is returned.'."\n", - 'type' => 'string', - 'example' => '9527952795279527', - ], - ], - 'AlertMethods' => [ - 'description' => 'The notification method.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The notification method. Valid values:'."\n" - ."\n" - .'* MAIL'."\n" - .'* SMS'."\n" - .'* Alert notifications can be sent by text message only in the Singapore, Malaysia (Kuala Lumpur), and Germany (Frankfurt) regions.'."\n", - 'type' => 'string', - 'example' => 'SMS,MAIL', - ], - ], - 'Webhooks' => [ - 'description' => 'WebHook URL'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The webhook URL of the WeCom or Lark chatbot. You must specify Webhooks for AlertMethods. Only DataWorks Enterprise Edition supports this parameter.'."\n", - 'type' => 'string', - 'example' => 'https://open.feishu.cn/open-apis/bot/v2/hook/*******', - ], - ], - 'Receivers' => [ - 'description' => 'The information about the alert recipients.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the alert recipient.'."\n", - 'type' => 'object', - 'properties' => [ - 'AlertUnit' => [ - 'description' => 'The type of the alert recipient. For more information about alert recipients, see the Receivers parameter. Valid values:'."\n" - ."\n" - .'* OWNER: indicate the task owner.'."\n" - .'* OTHER: indicates specified personnel.'."\n" - .'* SHIFT_SCHEDULE: indicates personnel in a shift schedule.'."\n", - 'type' => 'string', - 'example' => 'OWNER', - ], - 'AlertTargets' => [ - 'description' => 'The alert recipient.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '* If the value of the AlertUnit parameter is OWNER, this parameter is left empty.'."\n" - .'* If the value of the AlertUnit parameter is OTHER, the ID of the Alibaba Cloud account used by the specified user is returned.'."\n" - .'* If the value of the AlertUnit parameter is SHIFT_SCHEDULE, the shift schedule ID is returned.'."\n", - 'type' => 'string', - 'example' => '9527952795279527', - ], - ], - ], - ], - ], - 'AllowNodes' => [ - 'description' => 'The IDs of the nodes that are added to a whitelist.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the node that is added to a whitelist. The nodes that you add to the whitelist are not monitored.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.Resource', - 'errorMessage' => 'You have reached the limit for the resource. Please contact us by submitting a ticket.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'Forbidden.Not.Server', - 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.', - ], - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - ], - ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFGH-IJK****\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"MaxAlertTimes\\": 3,\\n \\"RemindUnit\\": \\"NODE\\",\\n \\"AlertInterval\\": 1800,\\n \\"Useflag\\": true,\\n \\"Founder\\": \\"9527951795****\\",\\n \\"RemindId\\": 1234,\\n \\"DndEnd\\": \\"08:00\\",\\n \\"RemindType\\": \\"FINISHED\\",\\n \\"AlertUnit\\": \\"OWNER\\",\\n \\"DndStart\\": \\"00:00\\",\\n \\"RemindName\\": \\"Rule name\\",\\n \\"Detail\\": \\"{\\\\\\"hour\\\\\\":23,\\\\\\"minu\\\\\\":59}\\",\\n \\"Robots\\": [\\n {\\n \\"WebUrl\\": \\"https://oapi.dingtalk.com/robot/send?access_token=******************************\\",\\n \\"AtAll\\": true\\n }\\n ],\\n \\"Nodes\\": [\\n {\\n \\"Owner\\": \\"9527951795****\\",\\n \\"NodeName\\": \\"Node name\\",\\n \\"NodeId\\": 1234,\\n \\"ProjectId\\": 1234\\n }\\n ],\\n \\"Baselines\\": [\\n {\\n \\"BaselineName\\": \\"Baseline name\\",\\n \\"BaselineId\\": 1234\\n }\\n ],\\n \\"Projects\\": [\\n {\\n \\"ProjectId\\": 1234\\n }\\n ],\\n \\"BizProcesses\\": [\\n {\\n \\"BizProcessName\\": \\"Business process name\\",\\n \\"BizId\\": 9527\\n }\\n ],\\n \\"AlertTargets\\": [\\n \\"9527952795279527\\"\\n ],\\n \\"AlertMethods\\": [\\n \\"SMS,MAIL\\"\\n ],\\n \\"Webhooks\\": [\\n \\"https://open.feishu.cn/open-apis/bot/v2/hook/*******\\"\\n ],\\n \\"Receivers\\": [\\n {\\n \\"AlertUnit\\": \\"OWNER\\",\\n \\"AlertTargets\\": [\\n \\"9527952795279527\\"\\n ]\\n }\\n ],\\n \\"AllowNodes\\": [\\n 123\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 0000-ABCD-EFGH-IJKLMNOPQ\\n The specified parameters are invalid.\\n 1031203110005\\n true\\n \\n 3\\n NODE\\n 1800\\n true\\n 9527951795****\\n 1234\\n 08:00\\n FINISHED\\n OWNER\\n 00:00\\n 规则名称\\n {\\"hour\\":23,\\"minu\\":59}\\n \\n https://oapi.dingtalk.com/robot/send?access_token=******************************\\n true\\n \\n \\n 9527951795****\\n 节点名称\\n 1234\\n 1234\\n \\n \\n 基线名称\\n 1234\\n \\n \\n 1234\\n \\n \\n 业务流程名称\\n 9527\\n \\n 9527952795279527\\n SMS,MAIL\\n https://open.feishu.cn/open-apis/bot/v2/hook/*******\\n \\n","errorExample":""}]', - 'title' => 'GetRemind', - 'summary' => 'Queries the information about a custom alert rule.', - 'description' => '## Debugging'."\n" - ."\n" - .'[OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.](https://api.aliyun.com/#product=dataworks-public\\&api=GetRemind\\&type=RPC\\&version=2020-05-18)'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListReminds' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '78333', - 'abilityTreeNodes' => [ - 'FEATUREdideRJGWWC', - ], - ], - 'parameters' => [ - [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of the page to return. Valid values: 1 to 30. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], - ], - [ - 'name' => 'Founder', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the Alibaba Cloud account that is used to create the custom alert rules.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '9527952795****', - ], - ], - [ - 'name' => 'NodeId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the node to which the custom alert rules are applied. You can use the ID to search for the custom alert rules that are applied to the node.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1234', - ], - ], - [ - 'name' => 'RemindTypes', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The conditions that trigger an alert for the node. Valid values: FINISHED, UNFINISHED, ERROR, CYCLE_UNFINISHED, and TIMEOUT. The value FINISHED indicates that the node finishes running. The value UNFINISHED indicates that the node is still running at the specified point in time. The value ERROR indicates that an error occurs when the node is running. The value CYCLE_UNFINISHED indicates that the node does not finish running in the specified scheduling cycle. The value TIMEOUT indicates that the node times out. You can specify multiple conditions for a custom alert rule. If you specify multiple condition, separate them with commas (,).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'FINISHED,ERROR', - ], - ], - [ - 'name' => 'AlertTarget', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the Alibaba Cloud account that is used to receive alert notifications.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '9527952795****', - ], - ], - [ - 'name' => 'SearchText', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The keyword in a rule name that is used to search for the rule. Fuzzy search is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Keyword', - ], - ], - ], - 'responses' => [ - 200 => [ - 'headers' => [], - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The ID of the request. You can use the ID to troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'The specified parameters are invalid.', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'example' => '1031203110005', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of custom alert rules returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'Reminds' => [ - 'description' => 'The list of custom alert rules.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Founder' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the rule creator.'."\n", - 'type' => 'string', - 'example' => '952795****', - ], - 'RemindId' => [ - 'description' => 'The custom alert rule ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'AlertUnit' => [ - 'description' => 'The alert recipient. Valid values: OWNER and OTHER. The value OWNER indicates the node owner. The value OTHER indicates a specified user.'."\n", - 'type' => 'string', - 'example' => 'OWNER', - ], - 'RemindType' => [ - 'description' => 'The condition that triggers an alert. Valid values: FINISHED, UNFINISHED, ERROR, CYCLE_UNFINISHED, and TIMEOUT.'."\n", - 'type' => 'string', - 'example' => 'FINISHED', - ], - 'DndEnd' => [ - 'description' => 'The end time of the quiet hours. The time is in the hh:mm format. Valid values of hh: \\[0,23]. Valid values of mm: \\[0,59].'."\n", - 'type' => 'string', - 'example' => '08:00', - ], - 'DndStart' => [ - 'description' => 'The start time of the quiet hours. The time is in the hh:mm format. Valid values of hh: \\[0,23]. Valid values of mm: \\[0,59].'."\n", - 'type' => 'string', - 'example' => '00:00', - ], - 'RemindUnit' => [ - 'description' => 'The type of the object to which the custom alert rule is applied. Valid values: NODE, BASELINE, PROJECT, and BIZPROCESS. The value NODE indicates a node. The value BASELINE indicates a baseline. The value PROJECT indicates a workspace. The value BIZPROCESS indicates a workflow.'."\n", - 'type' => 'string', - 'example' => 'NODE', - ], - 'Useflag' => [ - 'description' => 'Indicates whether the custom alert rule is enabled. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RemindName' => [ - 'description' => 'The name of the custom alert rule.'."\n", - 'type' => 'string', - 'example' => 'Alert Rule', - ], - 'AlertTargets' => [ - 'description' => 'The IDs of the Alibaba Cloud accounts used by alert recipients.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the alert recipient.'."\n", - 'type' => 'string', - 'example' => '952795****', - ], - ], - 'NodeIds' => [ - 'description' => 'The IDs of the nodes to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is NODE.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the node to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is NODE.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - ], - 'BizProcessIds' => [ - 'description' => 'The IDs of the workflows to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is BIZPROCESS.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the workflow to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is BIZPROCESS.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '9527', - ], - ], - 'ProjectIds' => [ - 'description' => 'The IDs of the workspaces to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is PROJECT.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the workspace to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is PROJECT.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - ], - 'BaselineIds' => [ - 'description' => 'The IDs of the baselines to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is BASELINE.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the baseline to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is BASELINE.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '9527', - ], - ], - 'AlertMethods' => [ - 'description' => 'The notification method. Valid values: MAIL, SMS, and PHONE. The value MAIL indicates that the notification is sent by email. Only DataWorks Professional Edition and more advanced editions support the PHONE notification method.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The notification method. Valid values: MAIL, SMS, and PHONE. The value MAIL indicates that the notification is sent by email. Only DataWorks Professional Edition and more advanced editions support the PHONE notification method.'."\n", - 'type' => 'string', - 'example' => 'SMS', - ], - ], - ], - ], - ], - ], - ], - ], - 'description' => '', - ], - ], - ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'Forbidden.Not.Server', - 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.', - ], - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Reminds\\": [\\n {\\n \\"Founder\\": \\"952795****\\",\\n \\"RemindId\\": 1234,\\n \\"AlertUnit\\": \\"OWNER\\",\\n \\"RemindType\\": \\"FINISHED\\",\\n \\"DndEnd\\": \\"08:00\\",\\n \\"DndStart\\": \\"00:00\\",\\n \\"RemindUnit\\": \\"NODE\\",\\n \\"Useflag\\": true,\\n \\"RemindName\\": \\"规则名称\\",\\n \\"AlertTargets\\": [\\n \\"952795****\\"\\n ],\\n \\"NodeIds\\": [\\n 1234\\n ],\\n \\"BizProcessIds\\": [\\n 9527\\n ],\\n \\"ProjectIds\\": [\\n 1234\\n ],\\n \\"BaselineIds\\": [\\n 9527\\n ],\\n \\"AlertMethods\\": [\\n \\"SMS\\"\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 0000-ABCD-EFG****\\n The specified parameters are invalid.\\n 1031203110005\\n true\\n \\n 1\\n 10\\n 100\\n \\n 952795****\\n 1234\\n OWNER\\n FINISHED\\n 08:00\\n 00:00\\n NODE\\n true\\n 规则名称\\n 952795****\\n 1234\\n 9527\\n 1234\\n 9527\\n SMS\\n \\n \\n","errorExample":""}]', - 'title' => 'ListReminds', - 'summary' => 'Queries a list of custom alert rules.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListTopics' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '78338', - 'abilityTreeNodes' => [ - 'FEATUREdideSFSFU4', - ], - ], - 'parameters' => [ - [ - 'name' => 'BeginTime', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-dd\'T\'HH:mm:ssZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2019-03-24T00:00:00+0800', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-dd\'T\'HH:mm:ssZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2019-03-25T23:00:00+0800', - ], - ], - [ - 'name' => 'TopicTypes', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The types of the events. Valid values: SLOW and ERROR. The value SLOW indicates that the running duration of the node in the current scheduling cycle is significantly longer than the average running duration of the node in previous scheduling cycles. The value ERROR indicates that the node fails to run. You can specify multiple types. Separate them with commas (,).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ERROR,SLOW', - ], - ], - [ - 'name' => 'TopicStatuses', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The status of the events. Valid values: IGNORE, NEW, FIXING, and RECOVER. The value IGNORE indicates that the events are ignored. The value NEW indicates that the events are new events. The value FIXING indicates that the events are being processed. The value RECOVER indicates that the events are processed. You can specify multiple states. Separate them with commas (,).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'IGNORE,NEW,FIXING,RECOVER', - ], - ], - [ - 'name' => 'NodeId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the node that triggers the events. You can configure either this parameter or the InstanceId parameter.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1234', - ], - ], - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the node instance that triggers the events. You can configure either this parameter or the NodeId parameter.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '12345', - ], - ], - [ - 'name' => 'Owner', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the owner of the events.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '952795****', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of the page to return. Valid values: 1 to 30. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '30', - 'minimum' => '1', - 'example' => '1', - 'default' => '', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - 'default' => '', - ], - ], - ], - 'responses' => [ - 200 => [ - 'headers' => [], - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The ID of the request. You can use the ID to troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'The specified parameters are invalid.', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'example' => '1031203110005', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The information about the events returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of the events returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'Topics' => [ - 'description' => 'The events returned.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'TopicName' => [ - 'description' => 'The name of the event.'."\n", - 'type' => 'string', - 'example' => '1234 Error', - ], - 'ProjectId' => [ - 'description' => 'The ID of the workspace to which the node belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'NodeOwner' => [ - 'description' => 'The ID of the Alibaba Cloud account that is used by the node owner.'."\n", - 'type' => 'string', - 'example' => '952795****', - ], - 'InstanceId' => [ - 'description' => 'The ID of the node instance that triggers the event.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12345', - ], - 'FixTime' => [ - 'description' => 'The timestamp when the event was processed.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1553508465000', - ], - 'TopicType' => [ - 'description' => 'The type of the event. Valid values: SLOW and ERROR. The value SLOW indicates that the running duration of the node in the current scheduling cycle is significantly longer than the average running duration of the node in previous scheduling cycles. The value ERROR indicates that the node fails to run.'."\n", - 'type' => 'string', - 'example' => 'ERROR', - ], - 'TopicStatus' => [ - 'description' => 'The status of the event. Valid values: IGNORE, NEW, FIXING, and RECOVER. The value IGNORE indicates that the event is ignored. The value NEW indicates that the event is a new event. The value FIXING indicates that the event is being processed. The value RECOVER indicates that the event is processed.'."\n", - 'type' => 'string', - 'example' => 'NEW', - ], - 'HappenTime' => [ - 'description' => 'The timestamp when the event occurred. A time difference may exist between the time when the event occurred and the time when the event was found.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1553508465000', - ], - 'NodeName' => [ - 'description' => 'The name of the node.'."\n", - 'type' => 'string', - 'example' => 'Node Name'."\n", - ], - 'TopicId' => [ - 'description' => 'The ID of the event.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'AddTime' => [ - 'description' => 'The timestamp when the event was found.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1553524393000', - ], - 'NodeId' => [ - 'description' => 'The ID of the node that triggers the event.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'Forbidden.Not.Server', - 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.', - ], - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Topics\\": [\\n {\\n \\"TopicName\\": \\"1234出错\\",\\n \\"ProjectId\\": 1234,\\n \\"NodeOwner\\": \\"952795****\\",\\n \\"InstanceId\\": 12345,\\n \\"FixTime\\": 1553508465000,\\n \\"TopicType\\": \\"ERROR\\",\\n \\"TopicStatus\\": \\"NEW\\",\\n \\"HappenTime\\": 1553508465000,\\n \\"NodeName\\": \\"节点名称\\",\\n \\"TopicId\\": 1234,\\n \\"AddTime\\": 1553524393000,\\n \\"NodeId\\": 1234\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 0000-ABCD-EFG****\\n The specified parameters are invalid.\\n 1031203110005\\n true\\n \\n 1\\n 10\\n 100\\n \\n 1234出错\\n 1234\\n 952795****\\n 12345\\n 1553508465000\\n ERROR\\n NEW\\n 1553508465000\\n 节点名称\\n 1234\\n 1553524393000\\n 1234\\n \\n \\n","errorExample":""}]', - 'title' => 'ListTopics', - 'summary' => 'Queries events.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'GetTopic' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '78289', - 'abilityTreeNodes' => [ - 'FEATUREdideSFSFU4', - ], - ], - 'parameters' => [ - [ - 'name' => 'TopicId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The event ID. You can call the [ListTopics](~~173973~~) operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1234', - ], - ], - ], - 'responses' => [ - 200 => [ - 'headers' => [], - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFGH-IJKLMNOPQ', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified parameters are invalid.', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '1031203110005', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The details of the event.'."\n", - 'type' => 'object', - 'properties' => [ - 'Owner' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the event owner.'."\n", - 'type' => 'string', - 'example' => '952795****', - ], - 'TopicName' => [ - 'description' => 'The name of the event.'."\n", - 'type' => 'string', - 'example' => '1234 error', - ], - 'BaselineStatus' => [ - 'description' => 'The status of the baseline. Valid values: ERROR, SAFE, DANGROUS, and OVER. The value ERROR indicates that no nodes are associated with the baseline, or all nodes associated with the baseline are suspended. The value SAFE indicates that nodes are run before the alert duration begins. The value DANGROUS indicates that nodes are still running after the alert duration ends but the committed completion time does not arrive. The value OVER indicates that nodes are still running after the committed completion time.'."\n", - 'type' => 'string', - 'example' => 'SAFE', - ], - 'ProjectId' => [ - 'description' => 'The ID of the workspace to which the node that triggered the event belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'NextAlertTime' => [ - 'description' => 'The timestamp when the system reports the next alert.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1553524393000', - ], - 'InstanceId' => [ - 'description' => 'The ID of the instance that triggered the event.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12345', - ], - 'FixTime' => [ - 'description' => 'The timestamp when the event was processed.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1553524393000', - ], - 'BaselineInGroupId' => [ - 'description' => 'The ID of the cycle of the worst baseline instance.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'BaselineBuffer' => [ - 'description' => 'The margin of the worst baseline instance. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3600', - ], - 'TopicType' => [ - 'description' => 'The type of the event. Valid values: SLOW and ERROR. The value SLOW indicates that the duration of the task is significantly longer than the average duration of the task in previous cycles. The value ERROR indicates that the task fails to run.'."\n", - 'type' => 'string', - 'example' => 'ERROR', - ], - 'TopicStatus' => [ - 'description' => 'The status of the event. Valid values: IGNORE, NEW, FIXING, and RECOVER.'."\n", - 'type' => 'string', - 'example' => 'FIXING', - ], - 'HappenTime' => [ - 'description' => 'The timestamp when the event occurred. A time difference may exist between the time when the event occurred and the time when the event was found.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1553524393000', - ], - 'DealTime' => [ - 'description' => 'The timestamp when the event was last processed.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1553524393000', - ], - 'DealUser' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the user who last processed the event.'."\n", - 'type' => 'string', - 'example' => '952795****', - ], - 'BaselineName' => [ - 'description' => 'The name of the baseline to which the worst baseline instance belongs.'."\n", - 'type' => 'string', - 'example' => 'Baseline name', - ], - 'BaselineId' => [ - 'description' => 'The ID of the baseline to which the worst baseline instance belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'NodeName' => [ - 'description' => 'The name of the node that triggered the event.'."\n", - 'type' => 'string', - 'example' => 'Node name', - ], - 'AlertTime' => [ - 'description' => 'The timestamp when the first alert was reported.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1553524393000', - ], - 'Buffer' => [ - 'description' => 'The margin of the event. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1200', - ], - 'Assigner' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the alert recipient.'."\n", - 'type' => 'string', - 'example' => '952795****', - ], - 'TopicId' => [ - 'description' => 'The event ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'AddTime' => [ - 'description' => 'The timestamp when the event was found.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1553524393000', - ], - 'NodeId' => [ - 'description' => 'The ID of the node that triggered the event.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - ], - ], - ], - 'description' => '', - ], - ], - ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'Forbidden.Not.Server', - 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.', - ], - [ - 'errorCode' => 'Invalid.Wkbench.Parameter', - 'errorMessage' => 'The specified parameters are invalid.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.Wkbench.ServiceError', - 'errorMessage' => 'An internal error occurred.', - ], - [ - 'errorCode' => 'Invalid.Wkbench.TopicNotExist', - 'errorMessage' => 'The topic does not exist.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFGH-IJKLMNOPQ\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Owner\\": \\"952795****\\",\\n \\"TopicName\\": \\"1234 error\\",\\n \\"BaselineStatus\\": \\"SAFE\\",\\n \\"ProjectId\\": 123456,\\n \\"NextAlertTime\\": 1553524393000,\\n \\"InstanceId\\": 12345,\\n \\"FixTime\\": 1553524393000,\\n \\"BaselineInGroupId\\": 1,\\n \\"BaselineBuffer\\": 3600,\\n \\"TopicType\\": \\"ERROR\\",\\n \\"TopicStatus\\": \\"FIXING\\",\\n \\"HappenTime\\": 1553524393000,\\n \\"DealTime\\": 1553524393000,\\n \\"DealUser\\": \\"952795****\\",\\n \\"BaselineName\\": \\"Baseline name\\",\\n \\"BaselineId\\": 1234,\\n \\"NodeName\\": \\"Node name\\",\\n \\"AlertTime\\": 1553524393000,\\n \\"Buffer\\": 1200,\\n \\"Assigner\\": \\"952795****\\",\\n \\"TopicId\\": 1234,\\n \\"AddTime\\": 1553524393000,\\n \\"NodeId\\": 1234\\n }\\n}","errorExample":""},{"type":"xml","example":"0000-ABCD-EFG****\\n200\\n\\n 1234\\n 1200\\n 1553524393000\\n 952795****\\n 12345\\n 节点名称\\n SAFE\\n 1234\\n FIXING\\n 1553524393000\\n 1553524393000\\n 1553524393000\\n 1\\n 1234出错\\n ERROR\\n 9527952795279528\\n 9527952795279528\\n 1553524393000\\n 基线名称\\n 1234\\n 1234\\n 3600\\n 1553524393000\\n\\n1031203110005\\nThe specified parameters are invalid.\\ntrue","errorExample":""}]', - 'title' => 'GetTopic', - 'summary' => 'Queries the information about an event.', - 'description' => '****', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'GetTopicInfluence' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '78290', - 'abilityTreeNodes' => [ - 'FEATUREdideSFSFU4', - ], - ], - 'parameters' => [ - [ - 'name' => 'TopicId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the event.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1234', - ], - ], - ], - 'responses' => [ - 200 => [ - 'headers' => [], - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The ID of the request. You can use the ID to troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'The specified parameters are invalid.', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'example' => '1031203110005', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'TopicId' => [ - 'description' => 'The ID of the event.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'Influences' => [ - 'description' => 'The affected baseline instances.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status of the baseline. Valid values: ERROR, SAFE, DANGROUS, and OVER. The value ERROR indicates that no nodes are associated with the baseline, or all nodes associated with the baseline are suspended. The value SAFE indicates that nodes are run before the alert duration begins. The value DANGROUS indicates that nodes are still running after the alert duration ends but the committed time does not arrive. The value OVER indicates that nodes are still running after the committed time.'."\n", - 'type' => 'string', - 'example' => 'SAFE', - ], - 'Owner' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the baseline owner. Multiple IDs are separated by commas (,).'."\n", - 'type' => 'string', - 'example' => '952795****', - ], - 'BaselineName' => [ - 'description' => 'The name of the baseline.'."\n", - 'type' => 'string', - 'example' => 'Baseline name', - ], - 'BaselineId' => [ - 'description' => 'The ID of the baseline.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12345', - ], - 'Bizdate' => [ - 'description' => 'The data timestamp of the baseline instance.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1553356800000', - ], - 'Buffer' => [ - 'description' => 'The margin of the baseline instance. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '360', - ], - 'ProjectId' => [ - 'description' => 'The ID of the workspace to which the baseline belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'Priority' => [ - 'description' => 'The priority of the baseline. Valid values: 1, 2, 5, 7, and 8.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'InGroupId' => [ - 'description' => 'The ID of the cycle of the baseline instance. For a baseline instance that is scheduled by day, the field value is 1. For a baseline instance that is scheduled by hour, the field value ranges from 1 to 24.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - ], - 'description' => '', - ], - ], - ], - ], - ], - 'description' => '', - ], - ], - ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'Forbidden.Not.Server', - 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.', - ], - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.Wkbench.ServiceError', - 'errorMessage' => 'An internal error occurred.', - ], - [ - 'errorCode' => 'Invalid.Wkbench.Parameter', - 'errorMessage' => 'The specified parameters are invalid.', - ], - [ - 'errorCode' => 'Invalid.Wkbench.TopicNotExist', - 'errorMessage' => 'The topic does not exist.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TopicId\\": 1234,\\n \\"Influences\\": [\\n {\\n \\"Status\\": \\"SAFE\\",\\n \\"Owner\\": \\"952795****\\",\\n \\"BaselineName\\": \\"Baseline name\\",\\n \\"BaselineId\\": 12345,\\n \\"Bizdate\\": 1553356800000,\\n \\"Buffer\\": 360,\\n \\"ProjectId\\": 1234,\\n \\"Priority\\": 1,\\n \\"InGroupId\\": 1\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 0000-ABCD-EFG****\\n The specified parameters are invalid.\\n 1031203110005\\n true\\n \\n 1234\\n \\n SAFE\\n 952795****\\n 基线名称\\n 1234\\n 1553356800000\\n 360\\n 1234\\n 1\\n 1\\n \\n \\n","errorExample":""}]', - 'title' => 'GetTopicInfluence', - 'summary' => 'Queries baseline instances affected by an event.', - 'description' => '## Debugging'."\n" - ."\n" - .'[OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.](https://api.aliyun.com/#product=dataworks-public\\&api=GetTopicInfluence\\&type=RPC\\&version=2020-05-18)'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'GetNode' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '78272', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - 'FEATUREdideVFMENL', - ], - ], - 'parameters' => [ - [ - 'name' => 'NodeId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The interval at which the node is rerun after the node fails to run.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'minimum' => '2', - 'example' => '1234', - 'isFileTransferUrl' => false, - ], - ], - [ - 'name' => 'ProjectEnv', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The environment of the workspace. Valid values: PROD and DEV.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [], - 'example' => 'PROD', - 'isFileTransferUrl' => false, - 'enum' => [ - 'PROD', - 'DEV', - ], - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The operation that you want to perform. Set the value to **GetNode**.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'Other parameters.'."\n", - 'type' => 'string', - 'example' => 'E6F0DBDD-5AD****', - ], - 'ErrorMessage' => [ - 'description' => 'The connection string.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'ErrorCode' => [ - 'description' => 'The ID of the node. You can call the [ListNodes](~~173979~~) operation to query the node ID.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Success' => [ - 'description' => 'The ID of the workflow.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The details of the node.'."\n", - 'type' => 'object', - 'properties' => [ - 'SchedulerType' => [ - 'description' => 'The ID of the workspace.'."\n", - 'type' => 'string', - 'example' => 'NORMAL', - ], - 'RepeatInterval' => [ - 'description' => 'The ID of the workflow to which the node belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '60', - ], - 'Repeatability' => [ - 'description' => 'The type of the node.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'RepeatMode' => [ - 'description' => 'Rerun mode. 0 indicates that you can rerun only if you fail, 1 indicates that you can rerun in all cases, and 2 indicates that you cannot rerun in all cases.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ProjectId' => [ - 'description' => 'Indicates whether the node can be rerun.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'ProgramType' => [ - 'description' => 'The ID of the owner of the node.'."\n", - 'type' => 'string', - 'example' => 'ODPS_SQL', - ], - 'Priority' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'OwnerId' => [ - 'description' => 'The ID of the node.'."\n", - 'type' => 'string', - 'example' => '17366294****', - ], - 'Connection' => [ - 'description' => 'The environment of the workspace. Valid values: PROD and DEV.'."\n", - 'type' => 'string', - 'example' => 'odps_first_dev', - ], - 'ParamValues' => [ - 'description' => 'The CRON expression returned.'."\n", - 'type' => 'string', - 'example' => 'a=b', - ], - 'RelatedFlowId' => [ - 'description' => 'Indicates whether the node is associated with Data Quality. Valid values: 0 and 1. A value of 0 indicates that the node is associated with Data Quality. A value of 1 indicates that the node is not associated with Data Quality.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'DqcType' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'BaselineId' => [ - 'description' => 'The description of the node.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456', - ], - 'Description' => [ - 'description' => 'The name of the resource group.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'NodeName' => [ - 'description' => 'The scheduling type of the node. Valid values:'."\n" - ."\n" - .'* NORMAL: The node is an auto triggered node.'."\n" - .'* MANUAL: The node is a manually triggered node. Manually triggered nodes cannot be automatically triggered.'."\n" - .'* PAUSE: The node is a paused node.'."\n" - .'* SKIP: The node is a dry-run node. Dry-run nodes are started as scheduled but the system sets the status of the nodes to successful when it starts to run them.'."\n", - 'type' => 'string', - 'example' => 'The ID of the baseline.'."\n", - ], - 'ResGroupName' => [ - 'description' => 'The ID of the request. You can use the ID to locate logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => 'The table and partition filter expression in Data Quality that are associated with the node.'."\n", - ], - 'BusinessId' => [ - 'description' => 'The operation that you want to perform. Set the value to **GetNode**.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'DqcDescription' => [ - 'description' => 'The ID of the node. You can call the [ListNodes](~~173979~~) operation to query the node ID.'."\n", - 'type' => 'string', - 'example' => '[{"projectName":"test_0923001","tableName":"test_table_001","partition":"ds\\u003d$[yyyymmdd]"},{"projectName":"test_0923001","tableName":"test_table_002","partition":"NOTAPARTITIONTABLE"}]', - ], - 'CronExpress' => [ - 'description' => 'The environment of the workspace. Valid values: PROD and DEV.'."\n", - 'type' => 'string', - 'example' => '00 00 00 * * ?', - ], - 'NodeId' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'ResGroupIdentifier' => [ - 'description' => 'The unique identifier of the resource group.', - 'type' => 'string', - 'example' => 'group_123', - ], - 'FileType' => [ - 'description' => 'The file type. Different file types have different codes. For more information, see [DataWorks node collection](~~600169~~).', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'FileId' => [ - 'description' => 'The file ID.'."\n" - ."\n" - .'**'."\n" - ."\n" - .'**Warning** The field is deprecated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'FileVersion' => [ - 'description' => 'The version of the file.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'DeployDate' => [ - 'description' => 'The deployment date.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1727280000000', - ], - 'CreateTime' => [ - 'description' => 'The creation time.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1727280000000', - ], - 'ModifyTime' => [ - 'description' => 'The modification time.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1727280000000', - ], - ], - ], - ], - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"SchedulerType\\": \\"NORMAL\\",\\n \\"RepeatInterval\\": 60,\\n \\"Repeatability\\": \\"true\\",\\n \\"RepeatMode\\": 1,\\n \\"ProjectId\\": 1234,\\n \\"ProgramType\\": \\"ODPS_SQL\\",\\n \\"Priority\\": 1,\\n \\"OwnerId\\": \\"17366294****\\",\\n \\"Connection\\": \\"odps_source_dev\\",\\n \\"ParamValues\\": \\"a=b\\",\\n \\"RelatedFlowId\\": 123,\\n \\"DqcType\\": 1,\\n \\"BaselineId\\": 123456,\\n \\"Description\\": \\"test\\",\\n \\"NodeName\\": \\"sql节点\\",\\n \\"ResGroupName\\": \\"默认资源组\\",\\n \\"BusinessId\\": 123,\\n \\"DqcDescription\\": \\"[{\\\\\\"projectName\\\\\\":\\\\\\"test_0923001\\\\\\",\\\\\\"tableName\\\\\\":\\\\\\"test_table_001\\\\\\",\\\\\\"partition\\\\\\":\\\\\\"ds\\\\\\\\u003d$[yyyymmdd]\\\\\\"},{\\\\\\"projectName\\\\\\":\\\\\\"test_0923001\\\\\\",\\\\\\"tableName\\\\\\":\\\\\\"test_table_002\\\\\\",\\\\\\"partition\\\\\\":\\\\\\"NOTAPARTITIONTABLE\\\\\\"}]\\",\\n \\"CronExpress\\": \\"00 00 00 * * ?\\",\\n \\"NodeId\\": 1234,\\n \\"ResGroupIdentifier\\": \\"group_123\\",\\n \\"FileType\\": 10,\\n \\"FileId\\": 123,\\n \\"FileVersion\\": 1,\\n \\"DeployDate\\": 1727280000000,\\n \\"CreateTime\\": 1727280000000,\\n \\"ModifyTime\\": 1727280000000\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n E6F0DBDD-5AD****\\n The connection does not exist.\\n Invalid.Tenant.ConnectionNotExists\\n true\\n \\n NORMAL\\n 60\\n true\\n 1234\\n ODPS_SQL\\n 1\\n 17366294****\\n odps_source_dev\\n a=b\\n 123\\n 1\\n 123456\\n test\\n sql节点\\n 默认资源组\\n 123\\n [{\\"projectName\\":\\"test_0923001\\",\\"tableName\\":\\"test_table_001\\",\\"partition\\":\\"ds\\\\u003d$[yyyymmdd]\\"},{\\"projectName\\":\\"test_0923001\\",\\"tableName\\":\\"test_table_002\\",\\"partition\\":\\"NOTAPARTITIONTABLE\\"}]\\n 00 00 00 * * ?\\n 1234\\n group_123\\n 10\\n \\n","errorExample":""}]', - 'title' => 'GetNode', - 'summary' => 'Indicates whether the request is successful.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListNodeInputOrOutput' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '78318', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - ], - ], - 'parameters' => [ - [ - 'name' => 'NodeId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The node ID. You can call the [ListNodes](~~173979~~) operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'minimum' => '2', - 'example' => '12314567', - 'isFileTransferUrl' => false, - ], - ], - [ - 'name' => 'ProjectEnv', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The environment of the workspace. Valid values: DEV and PROD.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'PROD', - 'isFileTransferUrl' => false, - 'enum' => [ - 'PROD', - 'DEV', - ], - ], - ], - [ - 'name' => 'IoType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The type of node that you want to query. Valid values:'."\n" - ."\n" - .'* input: ancestor node'."\n" - .'* output: descendant node'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'output', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'E6F0DBDD-5AD****', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The project does not exist.', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ProjectNotExists', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The ancestor or descendant nodes.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ancestor or descendant node.'."\n", - 'type' => 'object', - 'properties' => [ - 'TableName' => [ - 'description' => 'This parameter does not take effect. You cannot obtain the parameter settings.'."\n", - 'type' => 'string', - 'example' => 'dwd_xxx_table', - ], - 'Data' => [ - 'description' => 'The name of the ancestor or descendant node.'."\n", - 'type' => 'string', - 'example' => 'xxxx.123141254_out', - ], - 'NodeId' => [ - 'description' => 'The node ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234667', - ], - ], - ], - ], - ], - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"ErrorMessage\\": \\"The project does not exist.\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ProjectNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"TableName\\": \\"dwd_xxx_table\\",\\n \\"Data\\": \\"xxxx.123141254_out\\",\\n \\"NodeId\\": 12314567\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n E6F0DBDD-5AD****\\n The project does not exist.\\n Invalid.Tenant.ProjectNotExists\\n true\\n \\n dwd_xxx_table\\n xxxx.123141254_out\\n 1234667\\n \\n","errorExample":""}]', - 'title' => 'ListNodeInputOrOutput', - 'summary' => 'Queries the input and output information about a node. Only the ancestor or descendant nodes at the nearest level can be queried each time.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListNodes' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '78320', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - ], - ], - 'parameters' => [ - [ - 'name' => 'Owner', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The description of the node.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '193379****', - ], - ], - [ - 'name' => 'BizName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'test_bizName', - ], - ], - [ - 'name' => 'ProgramType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The operation that you want to perform. Set the value to **ListNodes**.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'ODPS_SQL', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The page number. Minimum value: 1. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], - ], - [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the owner.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1234', - ], - ], - [ - 'name' => 'ProjectEnv', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The environment in which the node runs. Valid values: DEV and PROD.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'PROD', - 'enum' => [ - 'PROD', - 'DEV', - ], - ], - ], - [ - 'name' => 'NodeName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the baseline with which the node is associated.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'liux_test_n****', - ], - ], - [ - 'name' => 'SchedulerType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The scheduling type. Valid values:'."\n" - ."\n" - .'* NORMAL: Nodes are scheduled as expected.'."\n" - .'* PAUSE: Nodes are paused.'."\n" - .'* SKIP: Nodes are dry-run. Dry-run nodes are started as scheduled, but the system sets the status of the nodes to successful when it starts to run them.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'NORMAL', - 'enum' => [ - 'NORMAL', - 'MANUAL', - 'PAUSE', - 'SKIP', - ], - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The returned result.'."\n", - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The interval at which the node is rerun after the node fails to run.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The list of nodes.'."\n", - 'type' => 'string', - 'example' => 'E6F0DBDD-5AD****', - ], - 'ErrorMessage' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'ErrorCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Success' => [ - 'description' => 'Indicates whether the node can be rerun.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The nodes.'."\n", - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => 'The name of the node.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The cron expression returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The name of the workflow.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '66', - ], - 'Nodes' => [ - 'description' => 'The information about the nodes.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The returned result.'."\n", - 'type' => 'object', - 'properties' => [ - 'SchedulerType' => [ - 'description' => 'The types of the nodes. You can call the [ListNodes](~~173979~~) operation to query the type of the node.'."\n", - 'type' => 'string', - 'example' => 'NORMAL', - ], - 'RepeatInterval' => [ - 'description' => 'The environment of the workspace. Valid values: PROD and DEV.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '60', - ], - 'Repeatability' => [ - 'description' => 'The name of the node.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RepeatMode' => [ - 'description' => 'The rerun mode. The value 0 indicates that rerun can be performed only if a failure occurs. The value 1 indicates that rerun can be performed in all cases. The value 2 indicates that rerun cannot be performed in all cases.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ProjectId' => [ - 'description' => 'The information about the nodes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '33671', - ], - 'ProgramType' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'ODPS_SQL', - ], - 'Priority' => [ - 'description' => 'The ID of the owner.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'OwnerId' => [ - 'description' => 'The additional parameters.'."\n", - 'type' => 'string', - 'example' => '19337906836551', - ], - 'Connection' => [ - 'description' => 'The name of the resource group.'."\n", - 'type' => 'string', - 'example' => 'odps_first', - ], - 'ParamValues' => [ - 'description' => 'The type of the node.'."\n", - 'type' => 'string', - 'example' => 'a=b', - ], - 'RelatedFlowId' => [ - 'description' => 'The table and partition filter expression in Data Quality that are associated with the node.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1231123', - ], - 'DqcType' => [ - 'description' => 'The connection string.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'BaselineId' => [ - 'description' => 'The number of the page to return. Minimum value: 1. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456', - ], - 'Description' => [ - 'description' => 'The priority for running the node. Valid values: 1, 3, 5, 7, and 8.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'NodeName' => [ - 'description' => 'The total number of nodes returned.'."\n", - 'type' => 'string', - 'example' => 'liux_test_n****', - ], - 'ResGroupName' => [ - 'description' => 'The ID of the workflow.'."\n", - 'type' => 'string', - 'example' => 'The ID of the request. You can use the ID to query logs and troubleshoot issues.'."\n", - ], - 'BusinessId' => [ - 'description' => 'The operation that you want to perform. Set the value to **ListNodes**.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'DqcDescription' => [ - 'description' => 'The ID of the owner.'."\n", - 'type' => 'string', - 'example' => '[{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\\u003d$[yyyy-mm-dd-1]"}]', - ], - 'CronExpress' => [ - 'description' => 'The name of the workflow.'."\n", - 'type' => 'string', - 'example' => '00 00 00 * * ?', - ], - 'NodeId' => [ - 'description' => 'The types of the nodes. You can call the [ListNodes](~~173979~~) operation to query the type of the node.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'ResGroupIdentifier' => [ - 'description' => 'The identifier of the resource group.'."\n", - 'type' => 'string', - 'example' => 'group_123', - ], - 'FileType' => [ - 'description' => 'Different file types have different codes. For more information, see [DataWorks node collection](~~600169~~).'."\n" - .'You can also call the [ListFileType](~~212428~~) interface to query the code type of the file.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'FileId' => [ - 'description' => 'The file ID. You can call the ListFiles operation to query the ID.'."\n" - ."\n" - .'**'."\n" - ."\n" - .'**Warning** This field is deprecated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'FileVersion' => [ - 'description' => 'The latest version number of the file.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'DeployDate' => [ - 'description' => 'The timestamp when the node was deployed. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1734537600000', - ], - 'CreateTime' => [ - 'description' => 'The timestamp when the node was created. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1593879116000', - ], - 'ModifyTime' => [ - 'description' => 'The timestamp when the node was modified. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1593879116000', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 66,\\n \\"Nodes\\": [\\n {\\n \\"SchedulerType\\": \\"NORMAL\\",\\n \\"RepeatInterval\\": 60,\\n \\"Repeatability\\": true,\\n \\"RepeatMode\\": 1,\\n \\"ProjectId\\": 33671,\\n \\"ProgramType\\": \\"ODPS_SQL\\",\\n \\"Priority\\": 1,\\n \\"OwnerId\\": \\"19337906836551\\",\\n \\"Connection\\": \\"odps_source\\",\\n \\"ParamValues\\": \\"a=b\\",\\n \\"RelatedFlowId\\": 1231123,\\n \\"DqcType\\": 1,\\n \\"BaselineId\\": 123456,\\n \\"Description\\": \\"test\\",\\n \\"NodeName\\": \\"liux_test_n****\\",\\n \\"ResGroupName\\": \\"默认资源组\\",\\n \\"BusinessId\\": 123,\\n \\"DqcDescription\\": \\"[{\\\\\\"projectName\\\\\\":\\\\\\"ztjy_dim\\\\\\",\\\\\\"tableName\\\\\\":\\\\\\"dim_user_agent_manage_area_a\\\\\\",\\\\\\"partition\\\\\\":\\\\\\"ds\\\\\\\\u003d$[yyyy-mm-dd-1]\\\\\\"}]\\",\\n \\"CronExpress\\": \\"00 00 00 * * ?\\",\\n \\"NodeId\\": 1234,\\n \\"ResGroupIdentifier\\": \\"group_123\\",\\n \\"FileType\\": 10,\\n \\"FileId\\": 20,\\n \\"FileVersion\\": 3,\\n \\"DeployDate\\": 1734537600000,\\n \\"CreateTime\\": 1593879116000,\\n \\"ModifyTime\\": 1593879116000\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n E6F0DBDD-5AD****\\n The connection does not exist.\\n Invalid.Tenant.ConnectionNotExists\\n true\\n \\n 1\\n 10\\n 66\\n \\n NORMAL\\n 60\\n true\\n 33671\\n ODPS_SQL\\n 1\\n 19337906836551\\n odps_source\\n a=b\\n 1231123\\n 1\\n 123456\\n test\\n liux_test_n****\\n 默认资源组\\n 123\\n [{\\"projectName\\":\\"ztjy_dim\\",\\"tableName\\":\\"dim_user_agent_manage_area_a\\",\\"partition\\":\\"ds\\\\u003d$[yyyy-mm-dd-1]\\"}]\\n 00 00 00 * * ?\\n 1234\\n group_123\\n 10\\n \\n \\n","errorExample":""}]', - 'title' => 'ListNodes', - 'summary' => 'The ID of the workspace.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'GetNodeCode' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '78274', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - 'FEATUREdideVFMENL', - ], - ], - 'parameters' => [ - [ - 'name' => 'NodeId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the node.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'minimum' => '2', - 'example' => '1234', - 'isFileTransferUrl' => false, - ], - ], - [ - 'name' => 'ProjectEnv', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The environment of the workspace. Valid values: PROD and DEV.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'PROD', - 'isFileTransferUrl' => false, - 'enum' => [ - 'PROD', - 'DEV', - ], - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The code of the node.'."\n", - 'type' => 'string', - 'example' => 'select a;', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can use the ID to locate logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => 'E6F0DBDD-5AD****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"select a;\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n select a;\\n The connection does not exist.\\n E6F0DBDD-5AD****\\n true\\n Invalid.Tenant.ConnectionNotExists\\n","errorExample":""}]', - 'title' => 'GetNodeCode', - 'summary' => 'Queries the code of a node.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'GetInstance' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '78249', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - ], - ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The instance ID. You can call the [ListInstances](~~173982~~) operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1234', - ], - ], - [ - 'name' => 'ProjectEnv', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The environment of the workspace. Valid values: PROD and DEV.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'PROD', - 'enum' => [ - 'PROD', - 'DEV', - ], - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'E6F0DBDD-5AD****', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned when the instance fails to be scheduled.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'Data' => [ - 'description' => 'The details of the instance.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status of the node that generates the instance. Valid values:'."\n" - ."\n" - .'* NOT_RUN: The node is not run.'."\n" - .'* WAIT_TIME: The node is waiting for its scheduling time to arrive.'."\n" - .'* WAIT_RESOURCE: The node is waiting for resources.'."\n" - .'* RUNNING: The node is running.'."\n" - .'* CHECKING: Data quality is being checked for the node.'."\n" - .'* CHECKING_CONDITION: Branch conditions are being checked for the node.'."\n" - .'* FAILURE: The node fails to run.'."\n" - .'* SUCCESS: The node is successfully run.'."\n", - 'type' => 'string', - 'example' => 'NOT_RUN', - ], - 'CycTime' => [ - 'description' => 'The scheduling time of the instance.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1590422400000', - ], - 'BeginRunningTime' => [ - 'description' => 'The time when the instance started to run.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1590416703313', - ], - 'FinishTime' => [ - 'description' => 'The time when the running of the instance was complete.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1590416703313', - ], - 'CreateTime' => [ - 'description' => 'The time when the instance was generated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1590416703313', - ], - 'DagId' => [ - 'description' => 'The workflow ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '338450167', - ], - 'Priority' => [ - 'description' => 'The priority of the instance. Valid values: 1, 3, 5, 7, and 8. A greater value indicates a higher priority. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TaskType' => [ - 'description' => 'The scheduling type of the node that generates the instance. Valid values:'."\n" - ."\n" - .'* NORMAL(0): The node is an auto triggered node. The scheduling system regularly runs the node.'."\n" - .'* MANUAL(1): The node is a manually triggered node. The scheduling system does not regularly run the node.'."\n" - .'* PAUSE(2): The node is a frozen node. The scheduling system regularly runs the node but sets the status of the node to failed when the scheduling system starts to run the node.'."\n" - .'* SKIP(3): The node is a dry-run node. The scheduling system regularly runs the node but sets the status of the node to successful when the scheduling system starts to run the node.'."\n" - .'* SKIP_UNCHOOSE(4): The node is an unselected node in a temporary workflow. This type of node exists only in temporary workflows. The scheduling system sets the status of the node to successful when the scheduling system starts to run the node.'."\n" - .'* SKIP_CYCLE(5): The node is a node that is scheduled by the week or month and is waiting for the scheduling time to arrive. The scheduling system regularly runs the node but sets the status of the node to successful when the scheduling system starts to run the node.'."\n" - .'* CONDITION_UNCHOOSE(6): The node is not selected by its ancestor branch node and is run as a dry-run node.'."\n" - .'* REALTIME_DEPRECATED(7): The node has instances that are generated in real time but deprecated. The scheduling system sets the status of the node to successful.'."\n", - 'type' => 'string', - 'example' => 'NORMAL(0)', - ], - 'ParamValues' => [ - 'description' => 'The parameters related to the node.'."\n", - 'type' => 'string', - 'example' => 'bizdate=$bizdate tbods=$tbods tbdw=$tbdw tbpmic=$tbpmic tbpidx=$tbpidx tbptcif=$tbptcif', - ], - 'Connection' => [ - 'description' => 'The connection string.'."\n", - 'type' => 'string', - 'example' => 'odps_first', - ], - 'BaselineId' => [ - 'description' => 'The baseline ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123123', - ], - 'DqcType' => [ - 'description' => 'Indicates whether the instance is associated with a monitoring rule in Data Quality. Valid values:'."\n" - ."\n" - .'* 0: The instance is associated with a monitoring rule in Data Quality.'."\n" - .'* 1: The instance is not associated with a monitoring rule in Data Quality.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'DagType' => [ - 'description' => 'The type of the workflow. Valid values:'."\n" - ."\n" - .'* DAILY: The workflow is used to run auto triggered nodes.'."\n" - .'* MANUAL: The workflow is used to run manually triggered nodes.'."\n" - .'* SMOKE_TEST: The workflow is used to perform smoke testing.'."\n" - .'* SUPPLY_DATA: The workflow is used to backfill data.'."\n", - 'type' => 'string', - 'example' => 'DAILY', - ], - 'BusinessId' => [ - 'description' => 'The workflow ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'TaskRerunTime' => [ - 'description' => 'The number of times the node can be rerun. The value of this parameter can be empty or an integer that is greater than or equal to 0.'."\n" - ."\n" - .'* If the value of this parameter is empty, the number of times that the node can be rerun is not specified.'."\n" - .'* If the value of this parameter is 0, the node cannot be rerun.'."\n" - .'* If the value of this parameter is a positive integer such as n, the node can still be rerun n times. For example, if the value of this parameter is 1, the node can still be rerun once. If the value of this parameter is 2, the node can still be rerun twice.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'PeriodNumber' => [ - 'description' => 'The sequence number of the cycle. This parameter indicates the sequence number of the cycle of the instance on the current day.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ModifyTime' => [ - 'description' => 'The time when the instance was last modified.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1590416703313', - ], - 'Repeatability' => [ - 'description' => 'Indicates whether the node that generates the instance can be rerun.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RepeatInterval' => [ - 'description' => 'The interval at which the node is rerun after the node fails to run. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '60000', - ], - 'InstanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '11713307578', - ], - 'BeginWaitResTime' => [ - 'description' => 'The time when the instance started to wait for resources.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1590416703313', - ], - 'RelatedFlowId' => [ - 'description' => 'The ID of the workflow to which the node belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123123', - ], - 'Bizdate' => [ - 'description' => 'The data timestamp of the instance. In most cases, the value is one day before the time when the instance was run.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1590336000000', - ], - 'NodeName' => [ - 'description' => 'The name of the node.'."\n", - 'type' => 'string', - 'example' => 'kzh', - ], - 'BeginWaitTimeTime' => [ - 'description' => 'The time when the instance started to wait to be scheduled.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1590416703313', - ], - 'DqcDescription' => [ - 'description' => 'The table and partition filter expression in Data Quality that are associated with the node.'."\n", - 'type' => 'string', - 'example' => '[{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\\u003d$[yyyy-mm-dd-1]"}]', - ], - 'NodeId' => [ - 'description' => 'The node ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '33115', - ], - 'CreateUser' => [ - 'description' => 'The creator of the instance.'."\n", - 'type' => 'string', - 'example' => '111', - ], - 'Owner' => [ - 'description' => 'The owner of the instance.'."\n", - 'type' => 'string', - 'example' => '111', - ], - ], - ], - ], - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"ErrorMessage\\": \\"test\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"0\\",\\n \\"Data\\": {\\n \\"Status\\": \\"NOT_RUN\\",\\n \\"CycTime\\": 1590422400000,\\n \\"BeginRunningTime\\": 1590416703313,\\n \\"FinishTime\\": 1590416703313,\\n \\"CreateTime\\": 1590416703313,\\n \\"DagId\\": 338450167,\\n \\"Priority\\": 1,\\n \\"TaskType\\": \\"NORMAL(0)\\",\\n \\"ParamValues\\": \\"bizdate=$bizdate tbods=$tbods tbdw=$tbdw tbpmic=$tbpmic tbpidx=$tbpidx tbptcif=$tbptcif\\",\\n \\"Connection\\": \\"odps_source\\",\\n \\"BaselineId\\": 123123,\\n \\"DqcType\\": 1,\\n \\"DagType\\": \\"DAILY\\",\\n \\"BusinessId\\": 123,\\n \\"TaskRerunTime\\": 0,\\n \\"PeriodNumber\\": 1,\\n \\"ModifyTime\\": 1590416703313,\\n \\"Repeatability\\": true,\\n \\"RepeatInterval\\": 60000,\\n \\"InstanceId\\": 11713307578,\\n \\"BeginWaitResTime\\": 1590416703313,\\n \\"RelatedFlowId\\": 123123,\\n \\"Bizdate\\": 1590336000000,\\n \\"NodeName\\": \\"kzh\\",\\n \\"BeginWaitTimeTime\\": 1590416703313,\\n \\"DqcDescription\\": \\"[{\\\\\\"projectName\\\\\\":\\\\\\"ztjy_dim\\\\\\",\\\\\\"tableName\\\\\\":\\\\\\"dim_user_agent_manage_area_a\\\\\\",\\\\\\"partition\\\\\\":\\\\\\"ds\\\\\\\\u003d$[yyyy-mm-dd-1]\\\\\\"}]\\",\\n \\"NodeId\\": 33115,\\n \\"CreateUser\\": \\"111\\",\\n \\"Owner\\": \\"111\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n E6F0DBDD-5AD****\\n test\\n true\\n 0\\n \\n NOT_RUN\\n 1590422400000\\n 1590416703313\\n 1590416703313\\n 1590416703313\\n 338450167\\n 1\\n NORMAL(0)\\n bizdate=$bizdate tbods=$tbods tbdw=$tbdw tbpmic=$tbpmic tbpidx=$tbpidx tbptcif=$tbptcif\\n odps_source\\n 123123\\n 1\\n DAILY\\n 123\\n 0\\n 1590416703313\\n true\\n 60000\\n 11713307578\\n 1590416703313\\n 123123\\n 1590336000000\\n kzh\\n 1590416703313\\n [{\\"projectName\\":\\"ztjy_dim\\",\\"tableName\\":\\"dim_user_agent_manage_area_a\\",\\"partition\\":\\"ds\\\\u003d$[yyyy-mm-dd-1]\\"}]\\n 33115\\n 111\\n \\n","errorExample":""}]', - 'title' => 'GetInstance', - 'summary' => 'Queries the information about an instance.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListInstances' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '78315', - 'abilityTreeNodes' => [ - 'FEATUREdide4QKMAF', - ], - ], - 'parameters' => [ - [ - 'name' => 'ProjectEnv', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The environment in which the node runs. Valid values: DEV and PROD.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [], - 'example' => 'PROD', - 'enum' => [ - 'PROD', - 'DEV', - ], - ], - ], - [ - 'name' => 'NodeId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Indicates whether the instance is associated with a monitoring rule in Data Quality. Valid values:'."\n" - ."\n" - .'* 0: The instance is associated with a monitoring rule in Data Quality.'."\n" - .'* 1: The instance is not associated with a monitoring rule in Data Quality.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '100000000000', - ], - ], - [ - 'name' => 'NodeName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Indicates whether the node can be rerun.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'openmr_8****', - ], - ], - [ - 'name' => 'Owner', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The connection string.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '193379****', - ], - ], - [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the baseline.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '12345', - ], - ], - [ - 'name' => 'BizName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_bizName', - ], - ], - [ - 'name' => 'ProgramType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ODPS_SQL', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The operation that you want to perform.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the node.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], - ], - [ - 'name' => 'DagId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The environment of the workspace. Valid values: PROD and DEV. The value PROD indicates the production environment. The value DEV indicates the development environment.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '11111', - ], - ], - [ - 'name' => 'Bizdate', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of entries returned per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2020-02-02 00:00:00', - ], - ], - [ - 'name' => 'BeginBizdate', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The parameters related to the node.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2020-02-02 00:00:00', - ], - ], - [ - 'name' => 'EndBizdate', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the workflow.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2020-02-03 00:00:00', - ], - ], - [ - 'name' => 'Status', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The status of the node. Valid values:'."\n" - ."\n" - .'* NOT_RUN: The node is not run.'."\n" - .'* WAIT_TIME: The node is waiting for the scheduling time to arrive.'."\n" - .'* WAIT_RESOURCE: The node is waiting for resources.'."\n" - .'* RUNNING: The node is running.'."\n" - .'* CHECKING: Data quality is being checked for the node.'."\n" - .'* CHECKING_CONDITION: Branch conditions are being checked for the node.'."\n" - .'* FAILURE: The node fails to run.'."\n" - .'* SUCCESS: The node is successfully run.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'NOT_RUN', - 'enum' => [ - 'SUCCESS', - 'FAILURE', - 'WAIT_TRIGGER', - 'CHECKING', - 'RUNNING', - 'WAIT_RESOURCE', - 'WAIT_TIME', - 'NOT_RUN', - ], - ], - ], - [ - 'name' => 'OrderBy', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The sorting rule of the instances to be returned. Valid values:'."\n" - ."\n" - .'* CREATE_TIME_DESC: The instances are sorted in descending order of their creation time.'."\n" - .'* INSTANCE_ID_DESC (default): The instances are sorted in descending order of their IDs.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'INSTANCE_ID_DESC', - 'enum' => [ - 'INSTANCE_ID_DESC', - 'CREATE_TIME_DESC', - ], - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The instances returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The error message that is returned for the instance.'."\n" - ."\n" - .'This parameter is deprecated. You can call the [GetInstanceLog](~~173983~~) operation to query the error information related to the node.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The name of the node.'."\n", - 'type' => 'string', - 'example' => 'E6F0DBDD-5AD****', - ], - 'ErrorMessage' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'string', - 'example' => 'The project does not exist.', - ], - 'ErrorCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ProjectNotExists', - ], - 'Success' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the yyyy-MM-dd HH:mm:ss format.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The ID of the node. You can call the [ListNodes](~~173979~~) operation to query the ID of the node.'."\n", - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => 'The time when the node was scheduled to run.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The end of the time range to query. Specify the time in the yyyy-MM-dd HH:mm:ss format.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The priority of the instance. Valid values: 1, 3, 5, 7, and 8.'."\n" - ."\n" - .'A greater value indicates a higher priority. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '66', - ], - 'Instances' => [ - 'description' => 'The name of the node. You can call the [ListNodes](~~173979~~) operation to query the name of the node.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The time when the instance was generated.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The data timestamp of the instances that you want to query. Specify the timestamp in the yyyy-MM-dd HH:mm:ss format.'."\n", - 'type' => 'string', - 'example' => 'NOT_RUN', - ], - 'CycTime' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1590422400000', - ], - 'BeginRunningTime' => [ - 'description' => 'The time when the instance started to run.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1590416703313', - ], - 'FinishTime' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the workspace administrator. You can log on to the Alibaba Cloud Management Console and view the ID on the Security Settings page of the Account Center console.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1590416703313', - ], - 'ErrorMessage' => [ - 'description' => 'The name of the account that is used to run the instance. For example, if an account named Test was used to run the instance to backfill data, the value of this parameter is Test.'."\n", - 'type' => 'string', - 'example' => 'error message', - ], - 'CreateTime' => [ - 'description' => 'The interval at which the node is rerun after the node fails to run. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1590416703313', - ], - 'DagId' => [ - 'description' => 'The time when the instance started to wait for resources.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '33845', - ], - 'Priority' => [ - 'description' => 'The total number of instances.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TaskType' => [ - 'description' => 'The information about the instances.'."\n", - 'type' => 'string', - 'example' => 'NORMAL(0)', - ], - 'ParamValues' => [ - 'description' => 'The table and partition filter expression in Data Quality that are associated with the node.'."\n", - 'type' => 'string', - 'example' => 'bizdate=$bizdate tbods=$tbods', - ], - 'Connection' => [ - 'description' => 'The number of times the node can be rerun. The value of this parameter can be empty or an integer that is greater than or equal to 0.'."\n" - ."\n" - .'* If the value of this parameter is empty, the number of times that the node can be rerun is not specified.'."\n" - .'* If the value of this parameter is 0, the node cannot be rerun.'."\n" - .'* If the value of this parameter is a positive integer such as n, the node can be rerun n times. For example, if the value of this parameter is 1, the node can be rerun once. If the value of this parameter is 2, the node can be rerun twice.'."\n", - 'type' => 'string', - 'example' => 'odps_first', - ], - 'BaselineId' => [ - 'description' => 'The type of the workflow. Valid values:'."\n" - ."\n" - .'* DAILY: The workflow is used to run auto triggered nodes.'."\n" - .'* MANUAL: The workflow is used to run manually triggered nodes.'."\n" - .'* SMOKE_TEST: The workflow is used to perform smoke testing.'."\n" - .'* SUPPLY_DATA: The workflow is used to backfill data.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123123', - ], - 'DqcType' => [ - 'description' => 'The status of the node. Valid values:'."\n" - ."\n" - .'* NOT_RUN: The node is not run.'."\n" - .'* WAIT_TIME: The node is waiting for the scheduling time to arrive.'."\n" - .'* WAIT_RESOURCE: The node is waiting for resources.'."\n" - .'* RUNNING: The node is running.'."\n" - .'* CHECKING: Data quality is being checked for the node.'."\n" - .'* CHECKING_CONDITION: Branch conditions are being checked for the node.'."\n" - .'* FAILURE: The node fails to run.'."\n" - .'* SUCCESS: The node is successfully run.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'DagType' => [ - 'description' => 'The data timestamp of the instance. In most cases, the value is one day before the time when the instance was run.'."\n", - 'type' => 'string', - 'example' => 'DAILY', - ], - 'BusinessId' => [ - 'description' => 'The ID of the workflow to which the node belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'TaskRerunTime' => [ - 'description' => 'The ID of the workspace. You can call the [ListProjects](~~178393~~) operation to query the ID of the workspace.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ModifyTime' => [ - 'description' => 'The name of the workflow. You can call the [ListBusiness](~~173945~~) operation to query the name of the workflow.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1590416703313', - ], - 'Repeatability' => [ - 'description' => 'The status of the node. Valid values:'."\n" - ."\n" - .'* NOT_RUN: The node is not run.'."\n" - .'* WAIT_TIME: The node is waiting for the scheduling time to arrive.'."\n" - .'* WAIT_RESOURCE: The node is waiting for resources.'."\n" - .'* RUNNING: The node is running.'."\n" - .'* CHECKING: Data quality is being checked for the node.'."\n" - .'* CHECKING_CONDITION: Branch conditions are being checked for the node.'."\n" - .'* FAILURE: The node fails to run.'."\n" - .'* SUCCESS: The node is successfully run.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RepeatInterval' => [ - 'description' => 'The scheduling type of the node. Valid values:'."\n" - ."\n" - .'* NORMAL(0): The node is an auto triggered node. The scheduling system regularly runs the node.'."\n" - ."\n" - .'* MANUAL(1): The node is a manually triggered node. The scheduling system does not regularly run the node.'."\n" - ."\n" - .'* PAUSE(2): The node is a frozen node. The scheduling system regularly runs the node but sets the status of the node to failed when the scheduling system starts to run the node.'."\n" - ."\n" - .'* SKIP(3): The node is a dry-run node. The scheduling system regularly runs the node but sets the status of the node to succeeded when the scheduling system starts to run the node.'."\n" - ."\n" - .'* SKIP_UNCHOOSE(4): The node is an unselected node in a temporary workflow. This type of node exists only in temporary workflows. The scheduling system sets the status of the node to succeeded when the scheduling system starts to run the node.'."\n" - ."\n" - .'* SKIP_CYCLE(5): The node is a node that is scheduled by week or month and is waiting for the scheduling time to arrive. The scheduling system regularly runs the node but sets the status of the node to succeeded when the scheduling system starts to run the node.'."\n" - ."\n" - .'* CONDITION_UNCHOOSE(6): The node is not selected by its ancestor branch node and is run as a dry-run node.'."\n" - ."\n" - .' REALTIME_DEPRECATED(7): The node has instances that are generated in real time but deprecated. The scheduling system sets the status of the node to succeeded.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '60000', - ], - 'InstanceId' => [ - 'description' => 'The number of the page to return. Minimum value:1. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'BeginWaitResTime' => [ - 'description' => 'The time when the node stopped running.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1590416703313', - ], - 'RelatedFlowId' => [ - 'description' => 'The type of the node. You can call the [ListNodes](~~173979~~) operation to query the type of the node.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456', - ], - 'Bizdate' => [ - 'description' => 'The number of entries to return on each page. Default value: 10. Maximum value: 100.'."\n" - ."\n" - .'You cannot specify the sorting method for the instances to be returned by this operation. By default, the instances are sorted in descending order of the time when the instances were created.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1590336000000', - ], - 'NodeName' => [ - 'description' => 'The ID of the workflow.'."\n", - 'type' => 'string', - 'example' => 'kzh', - ], - 'BeginWaitTimeTime' => [ - 'description' => 'The ID of the request. You can use the ID to locate logs and troubleshoot issues.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1590416703313', - ], - 'DqcDescription' => [ - 'description' => 'The operation that you want to perform.'."\n", - 'type' => 'string', - 'example' => '[{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\\u003d$[yyyy-mm-dd-1]"}]', - ], - 'NodeId' => [ - 'description' => 'The environment of the workspace. Valid values: PROD and DEV. The value PROD indicates the production environment. The value DEV indicates the development environment.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '33115', - ], - 'CreateUser' => [ - 'description' => 'The ID of the node. You can call the [ListNodes](~~173979~~) operation to query the ID of the node.'."\n", - 'type' => 'string', - 'example' => 'Test', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"ErrorMessage\\": \\"The project does not exist.\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ProjectNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 66,\\n \\"Instances\\": [\\n {\\n \\"Status\\": \\"NOT_RUN\\",\\n \\"CycTime\\": 1590422400000,\\n \\"BeginRunningTime\\": 1590416703313,\\n \\"FinishTime\\": 1590416703313,\\n \\"ErrorMessage\\": \\"error message\\",\\n \\"CreateTime\\": 1590416703313,\\n \\"DagId\\": 33845,\\n \\"Priority\\": 1,\\n \\"TaskType\\": \\"NORMAL(0)\\",\\n \\"ParamValues\\": \\"bizdate=$bizdate tbods=$tbods\\",\\n \\"Connection\\": \\"odps_source\\",\\n \\"BaselineId\\": 123123,\\n \\"DqcType\\": 1,\\n \\"DagType\\": \\"DAILY\\",\\n \\"BusinessId\\": 123,\\n \\"TaskRerunTime\\": 0,\\n \\"ModifyTime\\": 1590416703313,\\n \\"Repeatability\\": true,\\n \\"RepeatInterval\\": 60000,\\n \\"InstanceId\\": 1234,\\n \\"BeginWaitResTime\\": 1590416703313,\\n \\"RelatedFlowId\\": 123456,\\n \\"Bizdate\\": 1590336000000,\\n \\"NodeName\\": \\"kzh\\",\\n \\"BeginWaitTimeTime\\": 1590416703313,\\n \\"DqcDescription\\": \\"[{\\\\\\"projectName\\\\\\":\\\\\\"ztjy_dim\\\\\\",\\\\\\"tableName\\\\\\":\\\\\\"dim_user_agent_manage_area_a\\\\\\",\\\\\\"partition\\\\\\":\\\\\\"ds\\\\\\\\u003d$[yyyy-mm-dd-1]\\\\\\"}]\\",\\n \\"NodeId\\": 33115,\\n \\"CreateUser\\": \\"Test\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n E6F0DBDD-5AD****\\n The project does not exist.\\n Invalid.Tenant.ProjectNotExists\\n true\\n \\n 1\\n 10\\n 66\\n \\n NOT_RUN\\n 1590422400000\\n 1590416703313\\n 1590416703313\\n error message\\n 1590416703313\\n 33845\\n 1\\n NORMAL(0)\\n bizdate=$bizdate tbods=$tbods\\n odps_source\\n 123123\\n 1\\n DAILY\\n 123\\n 0\\n 1590416703313\\n true\\n 60000\\n 1234\\n 1590416703313\\n 123456\\n 1590336000000\\n kzh\\n 1590416703313\\n [{\\"projectName\\":\\"ztjy_dim\\",\\"tableName\\":\\"dim_user_agent_manage_area_a\\",\\"partition\\":\\"ds\\\\u003d$[yyyy-mm-dd-1]\\"}]\\n 33115\\n Test\\n \\n \\n","errorExample":""}]', - 'title' => 'ListInstances', - 'summary' => 'Queries a list of instances.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'GetInstanceLog' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '78253', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - ], - ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1234', - ], - ], - [ - 'name' => 'ProjectEnv', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The environment of the workspace. Valid values: PROD and DEV.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'PROD', - 'enum' => [ - 'PROD', - 'DEV', - ], - ], - ], - [ - 'name' => 'InstanceHistoryId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The historical record number of the instance. You can call the ListInstanceHistory operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The content of the logs.'."\n", - 'type' => 'string', - 'example' => 'log_content', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'RequestId' => [ - 'description' => 'The ID of the request. You can locate logs and troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => 'E6F0DBDD-5AD****', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"log_content\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n log_content\\n The connection does not exist.\\n E6F0DBDD-5AD****\\n Invalid.Tenant.ConnectionNotExists\\n true\\n","errorExample":""}]', - 'title' => 'GetInstanceLog', - 'summary' => 'Queries the logs of an instance. ', - 'description' => 'You may not obtain the instance logs that were generated more than seven days ago.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'StopInstance' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '78359', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - ], - ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The instance ID. You can call the [ListInstances](~~173982~~) operation to obtain the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1234', - ], - ], - [ - 'name' => 'ProjectEnv', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The environment of the workspace. Valid values: PROD and DEV.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'PROD', - 'enum' => [ - 'PROD', - 'DEV', - ], - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The result returned.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'E6F0DBDD-5AD****', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - 'description' => '', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n E6F0DBDD-5AD****\\n 200\\n true\\n Invalid.Tenant.ConnectionNotExists\\n The connection does not exist.\\n true\\n","errorExample":""}]', - 'title' => 'StopInstance', - 'summary' => 'Terminates an instance.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'RestartInstance' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '78342', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - ], - ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1234', - ], - ], - [ - 'name' => 'ProjectEnv', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The environment of the workspace. Valid values: PROD and DEV.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'PROD', - 'enum' => [ - 'PROD', - 'DEV', - ], - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'q32ety****', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - 'description' => '', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"q32ety****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"q32ety****\\n200\\ntrue\\nInvalid.Tenant.ConnectionNotExists\\nThe connection does not exist.\\ntrue","errorExample":""}]', - 'title' => 'RestartInstance', - 'summary' => 'Restarts an instance.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'SetSuccessInstance' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '78355', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - ], - ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1234', - ], - ], - [ - 'name' => 'ProjectEnv', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The environment of the workspace. Valid values: PROD and DEV.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'PROD', - 'enum' => [ - 'PROD', - 'DEV', - ], - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'Indicates whether result details are returned.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'E6F0DBDD-5AD****', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n true\\n The connection does not exist.\\n E6F0DBDD-5AD****\\n Invalid.Tenant.ConnectionNotExists\\n true\\n","errorExample":""}]', - 'title' => 'SetSuccessInstance', - 'summary' => 'Sets the state of a failed instance to successful.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'SuspendInstance' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '78361', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - ], - ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1234', - ], - ], - [ - 'name' => 'ProjectEnv', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The environment of the workspace. Valid values: PROD and DEV.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'PROD', - 'enum' => [ - 'PROD', - 'DEV', - ], - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can use the ID to locate logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '0baf87f0159376****', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ProjectNotExists', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - 'description' => '', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0baf87f0159376****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ProjectNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"0baf87f0159376****\\n200\\ntrue\\nInvalid.Tenant.ProjectNotExists\\nThe connection does not exist.\\ntrue","errorExample":""}]', - 'title' => 'SuspendInstance', - 'summary' => 'Suspends an instance.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ResumeInstance' => [ - 'summary' => 'Calls the ResumeInstance operation to resume a suspended instance.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '78343', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - ], - ], - 'parameters' => [ - [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1234', - ], - ], - [ - 'name' => 'ProjectEnv', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The environment of the workspace. Valid values: PROD and DEV.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'PROD', - 'enum' => [ - 'PROD', - 'DEV', - ], - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The result returned.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'E6F0DBDD-5AD****', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n true\\n The connection does not exist.\\n E6F0DBDD-5AD****\\n Invalid.Tenant.ConnectionNotExists\\n true\\n","errorExample":""}]', - 'title' => 'ResumeInstance', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'RunCycleDagNodes' => [ - 'summary' => 'Creates a workflow to backfill data.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '78346', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - ], - ], - 'parameters' => [ - [ - 'name' => 'ProjectEnv', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The environment of the workspace. Valid values: PROD and DEV. The value PROD indicates the production environment, and the value DEV indicates the development environment.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'PROD', - 'enum' => [ - 'PROD', - 'DEV', - ], - ], - ], - [ - 'name' => 'StartBizDate', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The data timestamp at which data starts to be backfilled. Specify the value in the yyyy-MM-dd 00:00:00 format.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2020-05-20 00:00:00', - ], - ], - [ - 'name' => 'Name', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the workflow.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'xm_test', - 'maxLength' => 128, - ], - ], - [ - 'name' => 'RootNodeId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the node for which data is first backfilled. You can call the [ListNodes](~~173979~~) operation to obtain the node ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1234', - ], - ], - [ - 'name' => 'ExcludeNodeIds', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The IDs of the nodes for which no data needs to be backfilled. The system generates dry-run instances for all these nodes. After these dry-run instances are scheduled, the statuses of these instances are directly set to successful, but the script is not run.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '1234,123465', - ], - ], - [ - 'name' => 'BizBeginTime', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The time when the node starts to run. This parameter is required only for auto triggered nodes that are scheduled by hour. Specify the value in the HH:mm:ss format. Valid values: 00:00:00 to 23:59:59.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '00:00:00', - ], - ], - [ - 'name' => 'BizEndTime', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The time when the node stops running. This parameter is required only for auto triggered nodes that are scheduled by hour. Specify the value in the HH:mm:ss format. Valid values: 00:00:00 to 23:59:59.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '01:00:00', - ], - ], - [ - 'name' => 'Parallelism', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether data can be backfilled for multiple nodes at the same time.'."\n", - 'type' => 'boolean', - 'required' => true, - 'docRequired' => true, - 'example' => 'false', - ], - ], - [ - 'name' => 'EndBizDate', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The data timestamp at which data is no longer backfilled. Specify the value in the yyyy-MM-dd 00:00:00 format.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2020-05-21 00:00:00', - ], - ], - [ - 'name' => 'NodeParams', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The parameters that need to be configured for the node. Set this parameter to a JSON string. The key indicates the ID of the node, and the value indicates the actual values of the parameters.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '{74324:"a=123 b=456"}', - ], - ], - [ - 'name' => 'IncludeNodeIds', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the node for which you want to backfill data. If you want to backfill data for multiple nodes, separate the IDs of the nodes with commas (,). You can call the [ListNodes](~~173979~~) operation to obtain the node ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '74324,74325', - ], - ], - [ - 'name' => 'StartFutureInstanceImmediately', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether to immediately run an instance that is scheduled to run in the future. If you set this parameter to true, the instance that is scheduled to run in the future is run immediately. Otherwise, the instance is run as scheduled.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], - ], - [ - 'name' => 'ConcurrentRuns', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of nodes that can run in parallel. Valid values: 2 to 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '10', - 'minimum' => '2', - 'example' => '5', - ], - ], - [ - 'name' => 'AlertType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The alert type. Valid values:'."\n" - ."\n" - .'* SUCCESS: An alert is generated when data backfill succeeds.'."\n" - .'* FAILURE: An alert is generated when data backfill fails.'."\n" - .'* SUCCESS_FAILURE: An alert is generated regardless of whether data backfill succeeds or fails.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'FAILURE', - 'enum' => [ - 'SUCCESS', - 'FAILURE', - 'SUCCESS_FAILURE', - ], - ], - ], - [ - 'name' => 'AlertNoticeType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The alert notification method. Valid values:'."\n" - ."\n" - .'* SMS'."\n" - .'* MAIL'."\n" - .'* SMS_MAIL'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'SMS', - 'enum' => [ - 'SMS', - 'MAIL', - 'SMS_MAIL', - ], - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can use the request ID to query logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '>E6F0DBDD-5AD****', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Data' => [ - 'description' => 'The IDs of the nodes in the workflow. You can query instances based on the IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the node in the workflow.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '111', - ], - ], - ], - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\">E6F0DBDD-5AD****\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Data\\": [\\n 111\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n >E6F0DBDD-5AD****\\n The connection does not exist.\\n true\\n Invalid.Tenant.ConnectionNotExists\\n 111\\n","errorExample":""}]', - 'title' => 'RunCycleDagNodes', - 'description' => 'For more information about data backfill, see [Backfill data](~~137937~~).'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'RunSmokeTest' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '78348', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - ], - ], - 'parameters' => [ - [ - 'name' => 'ProjectEnv', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The environment of the workspace. Valid values: PROD and DEV. The value PROD indicates the production environment, and the value DEV indicates the development environment. A workspace in basic mode does not have a development environment. For more information, see [Differences between workspaces in basic mode and workspaces in standard mode](~~85772~~).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'PROD', - 'enum' => [ - 'PROD', - 'DEV', - ], - ], - ], - [ - 'name' => 'Bizdate', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The data timestamp.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2020-05-26 00:00:00', - ], - ], - [ - 'name' => 'Name', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the workflow.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'xm_create_test', - 'maxLength' => 128, - ], - ], - [ - 'name' => 'NodeId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The node ID. You can call the [ListNodes](~~173979~~) operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1234', - ], - ], - [ - 'name' => 'NodeParams', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The parameters related to the node. Set this parameter to a JSON string. A key in the string indicates a parameter, and a value in the string indicates the value of the related parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'bizdate=$bizdate tbods=$tbods', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The workflow ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3333333', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can use the ID to locate logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => 'E6F0DBDD-5AD****', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 3333333,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": false\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 3333333\\n The connection does not exist.\\n E6F0DBDD-5AD****\\n Invalid.Tenant.ConnectionNotExists\\n false\\n","errorExample":""}]', - 'title' => 'RunSmokeTest', - 'summary' => 'Creates a workflow to perform smoke testing.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListSuccessInstanceAmount' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '78335', - 'abilityTreeNodes' => [ - 'FEATUREdideXLVI81', - ], - ], - 'parameters' => [ - [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to obtain the workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '99999999999', - 'minimum' => '2', - 'example' => '9527', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '952795279527ab****', - ], - 'InstanceStatusTrend' => [ - 'description' => 'Indicates the trend of the number of auto triggered node instances that are successfully run every hour on the hour of the current day.'."\n", - 'type' => 'object', - 'properties' => [ - 'TodayTrend' => [ - 'description' => 'The trend of the number of auto triggered node instances that are successfully run on the current day.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TimePoint' => [ - 'description' => 'The point in time. The value is an exact hour that ranges from 00:00 to 23:00, such as 00:00, 01:00, or 02:00.'."\n", - 'type' => 'string', - 'example' => '01:00', - ], - 'Count' => [ - 'description' => 'The number of instances that are successfully run.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - ], - ], - ], - 'YesterdayTrend' => [ - 'description' => 'The trend of the number of auto triggered node instances that are successfully run one day earlier than the current day.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TimePoint' => [ - 'description' => 'The point in time. The value is an exact hour that ranges from 00:00 to 23:00, such as 00:00, 01:00, or 02:00.'."\n", - 'type' => 'string', - 'example' => '01:00', - ], - 'Count' => [ - 'description' => 'The number of instances that are successfully run.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - ], - ], - ], - 'AvgTrend' => [ - 'description' => 'The average trend.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TimePoint' => [ - 'description' => 'The point in time. The value is an exact hour that ranges from 00:00 to 23:00, such as 00:00, 01:00, or 02:00.'."\n", - 'type' => 'string', - 'example' => '01:00', - ], - 'Count' => [ - 'description' => 'The number of instances that are successfully run.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'ResourceNotAuthorized.Api', - 'errorMessage' => 'You are not authorized to access the resources.', - ], - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.Resource', - 'errorMessage' => 'You have reached the limit for the resource. Please contact us by submitting a ticket.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'Forbidden.Not.Server', - 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.', - ], - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'Forbidden.Wkbench.ProjectNoPermission', - 'errorMessage' => 'You are not authorized to access the workspace.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"952795279527ab****\\",\\n \\"InstanceStatusTrend\\": {\\n \\"TodayTrend\\": [\\n {\\n \\"TimePoint\\": \\"01:00\\",\\n \\"Count\\": 10\\n }\\n ],\\n \\"YesterdayTrend\\": [\\n {\\n \\"TimePoint\\": \\"01:00\\",\\n \\"Count\\": 10\\n }\\n ],\\n \\"AvgTrend\\": [\\n {\\n \\"TimePoint\\": \\"01:00\\",\\n \\"Count\\": 10\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 952795279527ab****\\n \\n \\n 01:00\\n 10\\n \\n \\n 01:00\\n 10\\n \\n \\n 01:00\\n 10\\n \\n \\n","errorExample":""}]', - 'title' => 'ListSuccessInstanceAmount', - 'summary' => 'Queries the trend of the number of auto triggered node instances that are successfully run every hour on the hour of the current day.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListInstanceAmount' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '78314', - 'abilityTreeNodes' => [ - 'FEATUREdideXLVI81', - ], - ], - 'parameters' => [ - [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The DataWorks workspace ID. You can log on to the DataWorks console and go to the Work space page to obtain the workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '99999999999', - 'minimum' => '2', - 'example' => '10000', - ], - ], - [ - 'name' => 'BeginDate', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The beginning of the time range to query, accurate to the day. Specify the time in the ISO 8601 standard in the yyyy-MM-dd\'T\'HH:mm:ssZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2021-06-13T00:00:00+0800', - ], - ], - [ - 'name' => 'EndDate', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The end of the time range to query, accurate to the day. Specify the time in the ISO 8601 standard in the yyyy-MM-dd\'T\'HH:mm:ssZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2021-06-16T00:00:00+0800', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '95279527adhfj****', - ], - 'InstanceCounts' => [ - 'description' => 'The trend of the number of auto triggered node instances within the specified period of time.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Date' => [ - 'description' => 'The data timestamp at which the number of auto triggered node instances was obtained. This value is a UNIX timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1623772800000', - ], - 'Count' => [ - 'description' => 'The number of auto triggered node instances.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '9527', - ], - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'ResourceNotAuthorized.Api', - 'errorMessage' => 'You are not authorized to access the resources.', - ], - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.Resource', - 'errorMessage' => 'You have reached the limit for the resource. Please contact us by submitting a ticket.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'Forbidden.Not.Server', - 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.', - ], - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'Forbidden.Wkbench.NoProject', - 'errorMessage' => 'You have not joined any project.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"95279527adhfj****\\",\\n \\"InstanceCounts\\": [\\n {\\n \\"Date\\": 1623772800000,\\n \\"Count\\": 9527\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 95279527adhfj****\\n \\n 1623772800000\\n 9527\\n \\n","errorExample":""}]', - 'title' => 'ListInstanceAmount', - 'summary' => 'Queries the trend of the number of auto triggered node instances within a specified period of time.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'TopTenElapsedTimeInstance' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '78364', - 'abilityTreeNodes' => [ - 'FEATUREdideXLVI81', - ], - ], - 'parameters' => [ - [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '99999999999', - 'minimum' => '2', - 'example' => '100000', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '6347364dadsfadf****', - ], - 'InstanceConsumeTimeRank' => [ - 'description' => 'The ranking record of the running durations of the instances.'."\n", - 'type' => 'object', - 'properties' => [ - 'UpdateTime' => [ - 'description' => 'The timestamp at which the ranking of the running durations of the instances was updated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1600963200000', - ], - 'ConsumeTimeRank' => [ - 'description' => 'The ranking data of the running durations of the instances.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'Owner' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the node owner.'."\n", - 'type' => 'string', - 'example' => '952795279527', - ], - 'NodeName' => [ - 'description' => 'The name of the node.'."\n", - 'type' => 'string', - 'example' => 'Node name', - ], - 'BusinessDate' => [ - 'description' => 'The data timestamp of the instance.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1600963200000', - ], - 'ProgramType' => [ - 'description' => 'The type of the node. Valid values: 6 (Shell), 10 (ODPS SQL), 11 (ODPS MR), 23 (Data Integration), 24 (ODPS Script), 99 (zero load), 221 (PyODPS 2), 225 (ODPS Spark), 227 (EMR Hive), 228 (EMR Spark), 229 (EMR Spark SQL), 230 (EMR MR), 239 (OSS object inspection), 257 (EMR Shell), 258 (EMR Spark Shell), 259 (EMR Presto), 260 (EMR Impala), 900 (real-time synchronization), 1089 (cross-tenant collaboration), 1091 (Hologres development), 1093 (Hologres SQL), 1100 (assignment), and 1221 (PyODPS 3)'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'InstanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '95279527', - ], - 'NodeId' => [ - 'description' => 'The node ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '9527', - ], - 'Consumed' => [ - 'description' => 'The run time length of the instance. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'ResourceNotAuthorized.Api', - 'errorMessage' => 'You are not authorized to access the resources.', - ], - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.Resource', - 'errorMessage' => 'You have reached the limit for the resource. Please contact us by submitting a ticket.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'Forbidden.Not.Server', - 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.', - ], - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'Forbidden.Wkbench.ProjectNoPermission', - 'errorMessage' => 'You are not authorized to access the workspace.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6347364dadsfadf****\\",\\n \\"InstanceConsumeTimeRank\\": {\\n \\"UpdateTime\\": 1600963200000,\\n \\"ConsumeTimeRank\\": [\\n {\\n \\"Owner\\": \\"952795279527\\",\\n \\"NodeName\\": \\"Node name\\",\\n \\"BusinessDate\\": 1600963200000,\\n \\"ProgramType\\": 10,\\n \\"InstanceId\\": 95279527,\\n \\"NodeId\\": 9527,\\n \\"Consumed\\": 1000\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 6347364dadsfadf****\\n \\n 1600963200000\\n \\n 952795279527\\n 节点名称\\n 1600963200000\\n 10\\n 95279527\\n 9527\\n 1000\\n \\n \\n","errorExample":""}]', - 'title' => 'TopTenElapsedTimeInstance', - 'summary' => 'Queries the ranking of the running durations of instances.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'TopTenErrorTimesInstance' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '78365', - 'abilityTreeNodes' => [ - 'FEATUREdideXLVI81', - ], - ], - 'parameters' => [ - [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '99999999999', - 'minimum' => '2', - 'example' => '9527', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '952795279527****', - ], - 'InstanceErrorRank' => [ - 'description' => 'The ranking data of nodes on which errors occurred.'."\n", - 'type' => 'object', - 'properties' => [ - 'UpdateTime' => [ - 'description' => 'The timestamp at which the rankings were updated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1600963200000', - ], - 'ErrorRank' => [ - 'description' => 'The ranking data of nodes on which errors occurred within the last month.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'Owner' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the node owner.'."\n", - 'type' => 'string', - 'example' => '952795279527', - ], - 'NodeName' => [ - 'description' => 'The name of the node.'."\n", - 'type' => 'string', - 'example' => 'Node name', - ], - 'ProjectId' => [ - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '9527', - ], - 'ProgramType' => [ - 'description' => 'The type of the node. Valid values: 6 (Shell), 10 (ODPS SQL), 11 (ODPS MR), 23 (Data Integration), 24 (ODPS Script), 99 (zero load), 221 (PyODPS 2), 225 (ODPS Spark), 227 (EMR Hive), 228 (EMR Spark), 229 (EMR Spark SQL), 230 (EMR MR), 239 (OSS object inspection), 257 (EMR Shell), 258 (EMR Spark Shell), 259 (EMR Presto), 260 (EMR Impala), 900 (real-time synchronization), 1089 (cross-tenant collaboration), 1091 (Hologres development), 1093 (Hologres SQL), 1100 (assignment), and 1221 (PyODPS 3)'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'NodeId' => [ - 'description' => 'The node ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '9527', - ], - 'Count' => [ - 'description' => 'The number of errors that occurred on the node.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'ResourceNotAuthorized.Api', - 'errorMessage' => 'You are not authorized to access the resources.', - ], - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.Resource', - 'errorMessage' => 'You have reached the limit for the resource. Please contact us by submitting a ticket.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'Forbidden.Not.Server', - 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.', - ], - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'Forbidden.Wkbench.ProjectNoPermission', - 'errorMessage' => 'You are not authorized to access the workspace.', - ], - [ - 'errorCode' => 'Invalid.Wkbench.Parameter', - 'errorMessage' => 'The specified parameters are invalid.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"952795279527****\\",\\n \\"InstanceErrorRank\\": {\\n \\"UpdateTime\\": 1600963200000,\\n \\"ErrorRank\\": [\\n {\\n \\"Owner\\": \\"952795279527\\",\\n \\"NodeName\\": \\"Node name\\",\\n \\"ProjectId\\": 9527,\\n \\"ProgramType\\": 10,\\n \\"NodeId\\": 9527,\\n \\"Count\\": 5\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 952795279527****\\n \\n 1600963200000\\n \\n 952795279527\\n 节点名称\\n 9527\\n 10\\n 9527\\n 5\\n \\n \\n","errorExample":""}]', - 'title' => 'TopTenErrorTimesInstance', - 'summary' => 'Queries the ranking of nodes on which errors occur within the previous month.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'GetFileTypeStatistic' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '78246', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - ], - ], - 'parameters' => [ - [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Management page to obtain the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '123465', - 'isFileTransferUrl' => false, - ], - ], - [ - 'name' => 'ProjectEnv', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The environment of the workspace. Valid values: PROD and DEV. The value PROD indicates the production environment. The value DEV indicates the development environment.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'PROD', - 'isFileTransferUrl' => false, - 'enum' => [ - 'PROD', - 'DEV', - ], - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request. You can use the ID to locate logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => 'SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF', - ], - 'ProgramTypeAndCounts' => [ - 'description' => 'An array of node types and quantity.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Count' => [ - 'description' => 'The number of nodes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ProgramType' => [ - 'description' => 'The type of the node.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'6 (Shell node), 10 (ODPS SQL node), 11 (ODPS MR node), 23 (Data Integration node), 24 (ODPS Script node), 99 (zero load node), 221 (PyODPS 2 node), 225 (ODPS Spark node), 227 (EMR Hive node), 228 (EMR Spark node), 229 (EMR Spark SQL node), 230 (EMR MR node), 239 (OSS object inspection node), 257 (EMR Shell node), 258 (EMR Spark Shell node), 259 (EMR Presto node), 260 (EMR Impala node), 900 (real-time data synchronization node), 1089 (cross-tenant collaboration node), 1091 (Hologres development node), 1093 (Hologres SQL node), 1100 (assignment node), and 1221 (PyODPS 3 node).'."\n", - 'type' => 'string', - 'example' => 'ODPS_SQL', - ], - ], - ], - ], - ], - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF\\",\\n \\"ProgramTypeAndCounts\\": [\\n {\\n \\"Count\\": 1,\\n \\"ProgramType\\": \\"ODPS_SQL\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF\\n\\n 1\\n ODPS_SQL\\n","errorExample":""}]', - 'title' => 'GetFileTypeStatistic', - 'summary' => 'Queries the distribution of node types.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'GetInstanceStatusStatistic' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '78255', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - ], - ], - 'parameters' => [ - [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '1234', - 'isFileTransferUrl' => false, - ], - ], - [ - 'name' => 'ProjectEnv', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The runtime environment. Valid values: PROD and DEV.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [], - 'example' => 'PROD', - 'isFileTransferUrl' => false, - 'enum' => [ - 'PROD', - 'DEV', - ], - ], - ], - [ - 'name' => 'BizDate', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The date on which the numbers of instances in different states are obtained. Specify the date in the yyyy-MM-dd format.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2020-01-01', - 'maxLength' => 10, - 'minLength' => 10, - 'isFileTransferUrl' => false, - ], - ], - [ - 'name' => 'SchedulerType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The scheduling type of the node. Valid values:'."\n" - ."\n" - .'* NORMAL: auto triggered node'."\n" - .'* MANUAL: manually triggered node'."\n" - .'* PAUSE: paused node'."\n" - .'* SKIP: dry-run node'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'NORMAL', - 'enum' => [ - 'NORMAL', - 'MANUAL', - 'PAUSE', - 'SKIP', - ], - ], - ], - [ - 'name' => 'DagType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The type of the directed acyclic graph (DAG). Valid values:'."\n" - ."\n" - .'* MANUAL: DAG for a manually triggered workflow'."\n" - .'* SMOKE_TEST: DAG for a smoke testing workflow'."\n" - .'* SUPPLY_DATA: DAG for a data backfill instance'."\n" - .'* BUSINESS_PROCESS_DAG: DAG for a one-time workflow'."\n" - ."\n" - .''."\n" - ."\n" - .'* DAILY'."\n" - .'* MANUAL'."\n" - .'* SMOKE_TEST'."\n" - .'* SUPPLY_DATA'."\n" - .'* BUSINESS_PROCESS_DAG'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'MANUAL', - 'enum' => [ - 'DAILY', - 'MANUAL', - 'SMOKE_TEST', - 'SUPPLY_DATA', - 'BUSINESS_PROCESS_DAG', - ], - ], - ], - [ - 'name' => 'SchedulerPeriod', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The scheduling cycle. Valid values:'."\n" - ."\n" - .'* MINUTE'."\n" - .'* HOUR'."\n" - .'* DAY'."\n" - .'* WEEK'."\n" - .'* MONTH'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'DAY', - 'enum' => [ - 'MINUTE', - 'HOUR', - 'DAY', - 'WEEK', - 'MONTH', - ], - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'StatusCount' => [ - 'description' => 'The numbers of instances in different states.'."\n", - 'type' => 'object', - 'properties' => [ - 'FailureCount' => [ - 'description' => 'The number of instances that failed to run.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'WaitTimeCount' => [ - 'description' => 'The number of instances that are waiting to run.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RunningCount' => [ - 'description' => 'The number of instances that are running.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'SuccessCount' => [ - 'description' => 'The number of instances that are successfully run.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TotalCount' => [ - 'description' => 'The total number of instances returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'NotRunCount' => [ - 'description' => 'The number of instances that are not run.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'WaitResCount' => [ - 'description' => 'The number of instances that are waiting for resources.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - ], - ], - ], - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"StatusCount\\": {\\n \\"FailureCount\\": 1,\\n \\"WaitTimeCount\\": 1,\\n \\"RunningCount\\": 1,\\n \\"SuccessCount\\": 1,\\n \\"TotalCount\\": 1,\\n \\"NotRunCount\\": 1,\\n \\"WaitResCount\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 0000-ABCD-EFG****\\n \\n 1\\n 1\\n 1\\n 1\\n 1\\n 1\\n 1\\n \\n","errorExample":""}]', - 'title' => 'GetInstanceStatusStatistic', - 'summary' => 'Queries the number of instances that are in each state.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListFileType' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], - 'parameters' => [ - [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to view the workspace ID. You must configure either this parameter or the ProjectIdentifier parameter to determine the DataWorks workspace to which the operation is applied.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10000', - ], - ], - [ - 'name' => 'ProjectIdentifier', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace page to view the workspace name. You must configure either this parameter or the ProjectId parameter to determine the DataWorks workspace to which the operation is applied.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dw_project', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of entries per page. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '50', - ], - ], - [ - 'name' => 'Keyword', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the node type. You can log on to the DataWorks console, go to the DataStudio page, and then view the name of a specific node type on the left side of the page. Take note of the following items when you configure this parameter:'."\n" - ."\n" - .'* You can view the name of a specific node type, but the language specified by this parameter to present the name must be the same as the language specified by the Locale parameter.'."\n" - .'* Fuzzy match is supported.'."\n" - .'* If this parameter is not configured, the names of all node types are returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ODPS SQL', - ], - ], - [ - 'name' => 'Locale', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The language that you use for the query. Valid values: zh-CN and en-US.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh-CN', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'NodeTypeInfoList' => [ - 'description' => 'The information about node types.'."\n", - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '127', - ], - 'NodeTypeInfo' => [ - 'description' => 'The information about the node type.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'NodeTypeName' => [ - 'description' => 'The name of the node type. The codes and names of node types have the following mappings: 6 (Shell), 10 (ODPS SQL), 11 (ODPS MR), 23 (Data Integration), 24 (ODPS Script), 99 (zero load), 221 (PyODPS 2), 225 (ODPS Spark), 227 (EMR Hive), 228 (EMR Spark), 229 (EMR Spark SQL), 230 (EMR MR), 239 (OSS object inspection), 257 (EMR Shell), 258 (EMR Spark Shell), 259 (EMR Presto), 260 (EMR Impala), 900 (real-time synchronization), 1089 (cross-tenant collaboration), 1091 (Hologres development), 1093 (Hologres SQL), 1100 (assignment), and 1221 (PyODPS 3)'."\n", - 'type' => 'string', - 'example' => 'ODPS SQL', - ], - 'NodeType' => [ - 'description' => 'The code of the node type. The codes and names of node types have the following mappings: 6 (Shell), 10 (ODPS SQL), 11 (ODPS MR), 23 (Data Integration), 24 (ODPS Script), 99 (zero load), 221 (PyODPS 2), 225 (ODPS Spark), 227 (EMR Hive), 228 (EMR Spark), 229 (EMR Spark SQL), 230 (EMR MR), 239 (OSS object inspection), 257 (EMR Shell), 258 (EMR Spark Shell), 259 (EMR Presto), 260 (EMR Impala), 900 (real-time synchronization), 1089 (cross-tenant collaboration), 1091 (Hologres development), 1093 (Hologres SQL), 1100 (assignment), and 1221 (PyODPS 3)'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - ], - ], - ], - ], - ], - ], - 'description' => '', - ], - ], - ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"NodeTypeInfoList\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 50,\\n \\"TotalCount\\": 127,\\n \\"NodeTypeInfo\\": [\\n {\\n \\"NodeTypeName\\": \\"ODPS SQL\\",\\n \\"NodeType\\": 10\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 0000-ABCD-EFG****\\n \\n 1\\n 50\\n 127\\n \\n ODPS SQL\\n 10\\n \\n \\n","errorExample":""}]', - 'title' => 'ListFileType', - 'summary' => 'Queries the information about node types, such as the code and name.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'RunManualDagNodes' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '78347', - 'abilityTreeNodes' => [ - 'FEATUREdideD0YY7B', - ], - ], - 'parameters' => [ - [ - 'name' => 'ProjectEnv', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The environment type of Operation Center. Valid values: PROD and DEV. The value PROD indicates the production environment. The value DEV indicates the development environment.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [], - 'example' => 'PROD or DEV', - 'enum' => [ - 'PROD', - 'DEV', - ], - ], - ], - [ - 'name' => 'ProjectName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the workspace to which the manually triggered workflow belongs.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test_workspace', - 'pattern' => '^([^\\x00-\\xff]|[\\w.,;/@\\n-])+$', - ], - ], - [ - 'name' => 'FlowName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the manually triggered workflow.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test_workflow', - 'pattern' => '^([^\\x00-\\xff]|[\\w.,;/@\\n-])+$', - ], - ], - [ - 'name' => 'BizDate', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The data timestamp. The value of the data timestamp must be one or more days before the current date. For example, if the current date is November 11, 2020, set the value to 2020-11-10 00:00:00 or earlier. Configure this parameter in the YYYY-MM-DD 00:00:00 format. The StartBizDate parameter is used together with the EndBizDate parameter. You can configure only the BizDate parameter or the StartBizDate and EndBizDate parameters.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '2020-11-11 00:00:00', - ], - ], - [ - 'name' => 'NodeParameters', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The scheduling parameters of nodes in the manually triggered workflow. Configure NodeParameters in the following JSON format: {"\\": "Scheduling parameter settings of the node, which are in the same format as the parameter settings in the Scheduling Parameter section of the Properties tab on the DataStudio page", "\\": "Scheduling parameter settings of the node, which are in the same format as the parameter settings in the Scheduling Parameter section of the Properties tab on the DataStudio page"}.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '{"20000123121": "key1=val2 key2=val2", "20000123124": "kkkk=vvvvv aaaa=bbbb"}', - ], - ], - [ - 'name' => 'DagParameters', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The parameters are synchronized to all the instances in the directed acyclic graph (DAG) of the workflow. If a workflow parameter specified in DagParameters is referenced as a scheduling parameter of a [node](~~147245~~), the value of the scheduling parameter is replaced with the value of the workflow parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '{"kaaaa": "vaaaaa", "kbbbb": "vbbbbb"}', - ], - ], - [ - 'name' => 'IncludeNodeIds', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The IDs of the nodes that you need to run in the manually triggered workflow. Separate multiple node IDs with commas (,).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '74324,74325', - ], - ], - [ - 'name' => 'ExcludeNodeIds', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The IDs of the nodes that you do not need to run in the manually triggered workflow. DataWorks generates dry-run instances for all these nodes. After the dry-run instances are scheduled, the states of these instances are directly set to successful, but the scripts are not run. Separate multiple node IDs with commas (,). The ExcludeNodeIds parameter must be used together with the IncludeNodeIds parameter. This way, the settings of the ExcludeNodeIds parameter can take effect.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123,456', - ], - ], - [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the workspace to which the manually triggered workflow belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123', - ], - ], - [ - 'name' => 'StartBizDate', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The beginning of the time range in which data generated needs to be processed. Configure this parameter in the yyyy-MM-dd HH:mm:ss format. The StartBizDate parameter is used together with the EndBizDate parameter. You can configure only the BizDate parameter or the StartBizDate and EndBizDate parameters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2020-02-02 00:00:00', - ], - ], - [ - 'name' => 'EndBizDate', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The end of the time range in which data generated needs to be processed. Configure this parameter in the yyyy-MM-dd HH:mm:ss format. The StartBizDate parameter is used together with the EndBizDate parameter. You can configure only the BizDate parameter or the StartBizDate and EndBizDate parameters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2020-02-03 00:00:00', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'DagId' => [ - 'description' => 'The ID of the DAG for the manually triggered workflow. You can call an operation with this parameter as a request parameter to query the details and states of the nodes in the manually triggered workflow.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '700000123123141', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'AASFDFSDFG-DFSDF-DFSDFD-SDFSDF', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"DagId\\": 700000123123141,\\n \\"RequestId\\": \\"AASFDFSDFG-DFSDF-DFSDFD-SDFSDF\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 700000123123141\\n AASFDFSDFG-DFSDF-DFSDFD-SDFSDF\\n","errorExample":""}]', - 'title' => 'RunManualDagNodes', - 'summary' => 'Runs nodes in a manually triggered workflow. Before you call this operation, make sure that the manually triggered workflow is committed and deployed. You can find a manually triggered workflow in Operation Center only after the manually triggered workflow is committed and deployed.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListManualDagInstances' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '78316', - 'abilityTreeNodes' => [ - 'FEATUREdideVFMENL', - ], - ], - 'parameters' => [ - [ - 'name' => 'ProjectEnv', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The environment of Operation Center. Valid values: PROD and DEV.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'RPOD', - 'enum' => [ - 'PROD', - 'DEV', - ], - ], - ], - [ - 'name' => 'ProjectName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the workspace to which the manually triggered workflow belongs. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the name.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test_workspace', - ], - ], - [ - 'name' => 'DagId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the directed acyclic graph (DAG) for the manually triggered workflow. You can call the [RunManualDagNodes](~~212830~~) operation to obtain the ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '7000001231241', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF', - ], - 'Instances' => [ - 'description' => 'The instances in the manually triggered workflow.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status of the instance. Valid values:'."\n" - ."\n" - .'* NOT_RUN: The instance is not run.'."\n" - .'* WAIT_TIME: The instance is waiting for its scheduling time to arrive.'."\n" - .'* WAIT_RESOURCE: The instance is waiting for resources.'."\n" - .'* RUNNING: The instance is running.'."\n" - .'* CHECKING: Data quality is being checked for the instance.'."\n" - .'* CHECKING_CONDITION: Branch conditions are being checked for the instance.'."\n" - .'* FAILURE: The instance fails to be run.'."\n" - .'* SUCCESS: The instance is successfully run.'."\n", - 'type' => 'string', - 'example' => 'SUCCESS', - ], - 'BeginRunningTime' => [ - 'description' => 'The time when the instance started to run.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1605178414676', - ], - 'BizDate' => [ - 'description' => 'The data timestamp of the instance. In most cases, the value is one day before the time when the instance was run.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1605178414676', - ], - 'CycTime' => [ - 'description' => 'The time when the instance was scheduled to run.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1605178414676', - ], - 'FinishTime' => [ - 'description' => 'The time when the instance finished running.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1605178414676', - ], - 'CreateTime' => [ - 'description' => 'The time when the instance was generated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1605178414676', - ], - 'DagId' => [ - 'description' => 'The ID of the DAG for the instance in the manually triggered workflow.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '350850491', - ], - 'InstanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '11726873619', - ], - 'BeginWaitResTime' => [ - 'description' => 'The time when the instance started to wait for resources.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1605178414676', - ], - 'TaskType' => [ - 'description' => 'The scheduling type of the node. Valid values:'."\n" - ."\n" - .'* NORMAL(0): The node is an auto triggered node. The scheduling system regularly runs the node.'."\n" - .'* MANUAL(1): The node is a manually triggered node. The scheduling system does not regularly run the node.'."\n" - .'* PAUSE(2): The node is a frozen node. The scheduling system regularly runs the node but sets the status of the node to failed when the scheduling system starts to run the node.'."\n" - .'* SKIP(3): The node is a dry-run node. The scheduling system regularly runs the node but sets the status of the node to successful when the scheduling system starts to run the node.'."\n" - .'* SKIP_UNCHOOSE(4): The node is an unselected node in a temporary workflow. This type of node exists only in temporary workflows. The scheduling system sets the status of the node to successful when the scheduling system starts to run the node.'."\n" - .'* SKIP_CYCLE(5): The node is a node that is scheduled by week or month and is waiting for the scheduling time to arrive. The scheduling system regularly runs the node but sets the status of the node to successful when the scheduling system starts to run the node.'."\n" - .'* CONDITION_UNCHOOSE(6): The node is not selected by its ancestor branch node and is run as a dry-run node.'."\n" - .'* REALTIME_DEPRECATED(7): The node has instances that are generated in real time but deprecated. The scheduling system sets the status of the node to successful.'."\n", - 'type' => 'string', - 'example' => 'MANUAL', - ], - 'ParamValues' => [ - 'description' => 'The parameters related to the instance.'."\n", - 'type' => 'string', - 'example' => 'xxx=yyy', - ], - 'DagType' => [ - 'description' => 'The type of the manually triggered workflow.'."\n", - 'type' => 'string', - 'example' => '5', - ], - 'NodeName' => [ - 'description' => 'The name of the node.'."\n", - 'type' => 'string', - 'example' => 'test2', - ], - 'BeginWaitTimeTime' => [ - 'description' => 'The time when the instance started to wait to be scheduled.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1605178414676', - ], - 'NodeId' => [ - 'description' => 'The ID of the node in the manually triggered workflow.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '37851', - ], - 'ModifyTime' => [ - 'description' => 'The time when the instance was last modified.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1605178414676', - ], - 'CreateUser' => [ - 'description' => 'The name of the account that is used to run the instance. For example, if you use an account named Test to run the instance, the value of this parameter is Test.'."\n", - 'type' => 'string', - 'example' => 'Test', - ], - ], - ], - ], - ], - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF\\",\\n \\"Instances\\": [\\n {\\n \\"Status\\": \\"SUCCESS\\",\\n \\"BeginRunningTime\\": 1605178414676,\\n \\"BizDate\\": 1605178414676,\\n \\"CycTime\\": 1605178414676,\\n \\"FinishTime\\": 1605178414676,\\n \\"CreateTime\\": 1605178414676,\\n \\"DagId\\": 350850491,\\n \\"InstanceId\\": 11726873619,\\n \\"BeginWaitResTime\\": 1605178414676,\\n \\"TaskType\\": \\"MANUAL\\",\\n \\"ParamValues\\": \\"xxx=yyy\\",\\n \\"DagType\\": \\"5\\",\\n \\"NodeName\\": \\"test2\\",\\n \\"BeginWaitTimeTime\\": 1605178414676,\\n \\"NodeId\\": 37851,\\n \\"ModifyTime\\": 1605178414676,\\n \\"CreateUser\\": \\"Test\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF\\n \\n SUCCESS\\n 1605178414676\\n 1605178414676\\n 1605178414676\\n 1605178414676\\n 1605178414676\\n 350850491\\n 11726873619\\n 1605178414676\\n MANUAL\\n xxx=yyy\\n 5\\n test2\\n 1605178414676\\n 37851\\n 1605178414676\\n Test\\n \\n","errorExample":""}]', - 'title' => 'ListManualDagInstances', - 'summary' => 'Queries the information about instances in a manually triggered workflow.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'GetDag' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '78234', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - ], - ], - 'parameters' => [ - [ - 'name' => 'DagId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the DAG. You can use one of the following method to obtain the ID:'."\n" - ."\n" - .'* Call the [RunCycleDagNodes](~~2780209~~) operation and obtain the value of the **Data** response parameter.'."\n" - .'* Call the [RunSmokeTest](~~2780210~~) operation and obtain the value of the **Data** response parameter.'."\n" - .'* Call the [RunManualDagNodes](~~2780218~~) operation and obtain the value of the **DagId** response parameter.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'minimum' => '2', - 'example' => '123141452344525', - ], - ], - [ - 'name' => 'ProjectEnv', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The environment of the workspace. Valid values: PROD and DEV.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'PROD', - 'enum' => [ - 'PROD', - 'DEV', - ], - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '7782a299-b291-4fee-8424-cf8058efa8e8', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The details of the DAG.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the DAG. Valid values: MANUAL, SMOKE_TEST, SUPPLY_DATA, and BUSINESS_PROCESS_DAG. The value MANUAL indicates the DAG for a manually triggered workflow. The value SMOKE_TEST indicates the DAG for a smoke testing workflow. The value SUPPLY_DATA indicates the DAG for a data backfill instance. The value BUSINESS_PROCESS_DAG indicates the DAG for a one-time workflow.'."\n", - 'type' => 'string', - 'example' => 'MANUAL_FLOW', - ], - 'Status' => [ - 'description' => 'The status of the DAG. Valid values: CREATED, RUNNING, FAILURE, and SUCCESS.'."\n", - 'type' => 'string', - 'example' => 'FAILURE', - ], - 'FinishTime' => [ - 'description' => 'The time when the DAG finished running.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1605052800000', - ], - 'CreateTime' => [ - 'description' => 'The time when the DAG was created.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1605052800000', - ], - 'ProjectId' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '112345', - ], - 'DagId' => [ - 'description' => 'The DAG ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '351249682', - ], - 'Gmtdate' => [ - 'description' => 'The time when the DAG was scheduled to run.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1605052800000', - ], - 'StartTime' => [ - 'description' => 'The time when the DAG started to run.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1605052800000', - ], - 'CreateUser' => [ - 'description' => 'The creator.'."\n", - 'type' => 'string', - 'example' => '1736629400048545', - ], - 'Bizdate' => [ - 'description' => 'The data timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1605052800000', - ], - 'Name' => [ - 'description' => 'The name of the DAG.'."\n", - 'type' => 'string', - 'example' => 'test_dag', - ], - 'ModifyTime' => [ - 'description' => 'The time when the DAG was last modified.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1605052800000', - ], - 'OpSeq' => [ - 'description' => 'The sequence number of the operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - ], - ], - ], - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"7782a299-b291-4fee-8424-cf8058efa8e8\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Type\\": \\"MANUAL_FLOW\\",\\n \\"Status\\": \\"FAILURE\\",\\n \\"FinishTime\\": 1605052800000,\\n \\"CreateTime\\": 1605052800000,\\n \\"ProjectId\\": 112345,\\n \\"DagId\\": 351249682,\\n \\"Gmtdate\\": 1605052800000,\\n \\"StartTime\\": 1605052800000,\\n \\"CreateUser\\": \\"1736629400048545\\",\\n \\"Bizdate\\": 1605052800000,\\n \\"Name\\": \\"test_dag\\",\\n \\"ModifyTime\\": 1605052800000,\\n \\"OpSeq\\": 123\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 7782a299-b291-4fee-8424-cf8058efa8e8\\n The connection does not exist.\\n Invalid.Tenant.ConnectionNotExists\\n true\\n \\n MANUAL_FLOW\\n FAILURE\\n 1605052800000\\n 1605052800000\\n 112345\\n 351249682\\n 1605052800000\\n 1605052800000\\n 1736629400048545\\n 1605052800000\\n test_dag\\n 1605052800000\\n 123\\n \\n","errorExample":""}]', - 'title' => 'GetDag', - 'summary' => 'Queries the information about a directed acyclic graph (DAG). You can call the GetDag operation to query the information about the DAG for a manually triggered workflow, a manually triggered node, or a data backfill instance. However, you cannot query the information about the DAG for an auto triggered node or an auto triggered workflow.', - 'description' => 'Supported DAG types:'."\n" - ."\n" - .'* MANUAL: DAG for a manually triggered workflow'."\n" - .'* SMOKE_TEST: DAG for a smoke testing workflow'."\n" - .'* SUPPLY_DATA: DAG for a data backfill instance'."\n" - .'* BUSINESS_PROCESS_DAG: DAG for a one-time workflow'."\n" - ."\n" - .'Supported DAG states:'."\n" - ."\n" - .'* CREATED'."\n" - .'* RUNNING'."\n" - .'* FAILURE'."\n" - .'* SUCCESS'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListDags' => [ - 'summary' => 'Queries the details of directed acyclic graphs (DAGs) for a single data backfill instance based on OpSeq.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '99773', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - ], - ], - 'parameters' => [ - [ - 'name' => 'OpSeq', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The sequence number that uniquely identifies the data backfill operation. You can call the [GetDag](~~189753~~) operation to query the sequence number.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'minimum' => '2', - 'example' => '123', - ], - ], - [ - 'name' => 'ProjectEnv', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The environment of the workspace. Valid values: PROD and DEV. The value PROD indicates the production environment, and the value DEV indicates the development environment.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'PROD', - 'enum' => [ - 'PROD', - 'DEV', - ], - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The returned result.'."\n", - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can use the ID to locate logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '7782a299-b291-4fee-8424-cf8058efa8e8', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The details of DAGs.'."\n", - 'type' => 'object', - 'properties' => [ - 'Dags' => [ - 'description' => 'The entities returned.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the DAG. Valid values:'."\n" - ."\n" - .'* MANUAL: DAG for a manually triggered workflow'."\n" - .'* SMOKE_TEST: DAG for a smoke testing workflow'."\n" - .'* SUPPLY_DATA: DAG for a data backfill instance'."\n" - .'* BUSINESS_PROCESS_DAG: DAG for a one-time workflow'."\n", - 'type' => 'string', - 'example' => 'MANUAL_FLOW', - ], - 'Status' => [ - 'description' => 'The status of the DAG. Valid values:'."\n" - ."\n" - .'* CREATED'."\n" - .'* RUNNING'."\n" - .'* FAILURE'."\n" - .'* SUCCESS'."\n", - 'type' => 'string', - 'example' => 'FAILURE', - ], - 'FinishTime' => [ - 'description' => 'The end time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1605052800000', - ], - 'CreateTime' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1605052800000', - ], - 'ProjectId' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '112345', - ], - 'DagId' => [ - 'description' => 'The DAG ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '351249682', - ], - 'Gmtdate' => [ - 'description' => 'The actual running time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1605052800000', - ], - 'StartTime' => [ - 'description' => 'The start time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1605052800000', - ], - 'CreateUser' => [ - 'description' => 'The creator.'."\n", - 'type' => 'string', - 'example' => '1736629400048545', - ], - 'Bizdate' => [ - 'description' => 'The data timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1605052800000', - ], - 'Name' => [ - 'description' => 'The name of the DAG.'."\n", - 'type' => 'string', - 'example' => 'test_dag', - ], - 'ModifyTime' => [ - 'description' => 'The modification time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1605052800000', - ], - 'OpSeq' => [ - 'description' => 'The sequence number of the operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - ], + 'Depth' => ['description' => 'The number of category levels.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Comment' => ['description' => 'The remarks of the category.'."\n", 'type' => 'string', 'example' => 'category 1', 'title' => ''], + 'ModifiedTime' => ['description' => 'The time when the category was last modified.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1541576644000', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the category was created.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1541576644000', 'title' => ''], + 'CategoryId' => ['description' => 'The category ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '133', 'title' => ''], + 'LastOperatorId' => ['description' => 'The ID of the user that performed the last operation.'."\n", 'type' => 'string', 'example' => '12345', 'title' => ''], + 'Name' => ['description' => 'The name of the category.'."\n", 'type' => 'string', 'example' => 'category 1', 'title' => ''], + 'ParentCategoryId' => ['description' => 'The parent category ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''], + 'OwnerId' => ['description' => 'The category owner ID.'."\n", 'type' => 'string', 'example' => '123', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"7782a299-b291-4fee-8424-cf8058efa8e8\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Dags\\": [\\n {\\n \\"Type\\": \\"MANUAL_FLOW\\",\\n \\"Status\\": \\"FAILURE\\",\\n \\"FinishTime\\": 1605052800000,\\n \\"CreateTime\\": 1605052800000,\\n \\"ProjectId\\": 112345,\\n \\"DagId\\": 351249682,\\n \\"Gmtdate\\": 1605052800000,\\n \\"StartTime\\": 1605052800000,\\n \\"CreateUser\\": \\"1736629400048545\\",\\n \\"Bizdate\\": 1605052800000,\\n \\"Name\\": \\"test_dag\\",\\n \\"ModifyTime\\": 1605052800000,\\n \\"OpSeq\\": 123\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 7782a299-b291-4fee-8424-cf8058efa8e8\\n The connection does not exist.\\n Invalid.Tenant.ConnectionNotExists\\n true\\n \\n \\n MANUAL_FLOW\\n FAILURE\\n 1605052800000\\n 1605052800000\\n 112345\\n 351249682\\n 1605052800000\\n 1605052800000\\n 1736629400048545\\n 1605052800000\\n test_dag\\n 1605052800000\\n 123\\n \\n \\n","errorExample":""}]', - 'title' => 'ListDags', - 'description' => 'Supported DAG types:'."\n" - ."\n" - .'* MANUAL: DAG for a manually triggered workflow'."\n" - .'* SMOKE_TEST: DAG for a smoke testing workflow'."\n" - .'* SUPPLY_DATA: DAG for a data backfill instance'."\n" - .'* BUSINESS_PROCESS_DAG: DAG for a one-time workflow'."\n" - ."\n" - .'Supported DAG states:'."\n" - ."\n" - .'* CREATED: The DAG is created.'."\n" - .'* RUNNING: The DAG is running.'."\n" - .'* FAILURE: The DAG fails to run.'."\n" - .'* SUCCESS: The DAG is successfully run.'."\n", - ], - 'ListNodesByOutput' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '78322', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Invalid.Meta.CategoryIllegalDepth', 'errorMessage' => 'A category can contain a maximum of 4 levels.', 'description' => 'A category can contain a maximum of 4 levels.'], + ['errorCode' => 'Invalid.Meta.CategoryNameDuplicate', 'errorMessage' => 'The category name is duplicated at this level.', 'description' => 'The category name is duplicated at this level.'], + ['errorCode' => 'Invalid.Meta.TableNotExist', 'errorMessage' => 'The table does not exist.', 'description' => 'The table does not exist.'], + ['errorCode' => 'InvalidParameter.Meta.CommonError', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The request parameter is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.Illegal', 'errorMessage' => 'The app guid parameter is invalid.', 'description' => 'The app guid parameter is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.IllegalDate', 'errorMessage' => 'The date format is invalid.', 'description' => 'The date format is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.IllegalPageError', 'errorMessage' => 'The parameter for paging is invalid.', 'description' => 'The parameter for paging is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.NotExist', 'errorMessage' => 'The object does not exist.', 'description' => ''], ], - ], - 'parameters' => [ - [ - 'name' => 'ProjectEnv', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The environment of Operation Center. Valid values: PROD and DEV. The value PROD indicates the production environment, and the value DEV indicates the development environment.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [], - 'example' => 'PROD', - 'enum' => [ - 'PROD', - 'DEV', - ], - ], + 403 => [ + ['errorCode' => 'Forbidden.Meta.NoTenant', 'errorMessage' => 'The user is not the owner of any tenants.', 'description' => 'The user is not the owner of any tenants.'], + ['errorCode' => 'Invalid.Meta.CategoryForbidden', 'errorMessage' => 'Failed to delete the category. The current category is associated with a table and cannot be operated.', 'description' => 'Failed to delete the category because the table associated with the category does not exist.'], + ['errorCode' => 'Invalid.Meta.CategoryIllegalTenant', 'errorMessage' => 'The tenant ID is different in the parent and child categories.', 'description' => 'The tenant ID is different in the parent and child categories.'], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], ], - [ - 'name' => 'Outputs', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The output name of the node. You can specify multiple output names. Separate them with commas (,).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'aaaaa.1231412_out,bbbb.12313123_out', - ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'SDFSDFSDF-asdfDFSDF-SDFSDf-SDfSFD', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The nodes returned.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Output' => [ - 'description' => 'The output name of the current node.'."\n", - 'type' => 'string', - 'example' => 'test_0709_1.630003556_out', - ], - 'NodeList' => [ - 'description' => 'The information about the nodes returned.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'SchedulerType' => [ - 'description' => 'The scheduling type of the node. Valid values:'."\n" - ."\n" - .'* NORMAL: The node is an auto triggered node. The scheduling system regularly runs the node.'."\n" - .'* MANUAL: The node is a manually triggered node. The scheduling system does not regularly run the node.'."\n" - .'* PAUSE: The node is a frozen node. The scheduling system regularly runs the node but sets the status of the node to failed when the scheduling system starts to run the node.'."\n" - .'* SKIP: The node is a dry-run node. The scheduling system regularly runs the node but sets the status of the node to successful when the scheduling system starts to run the node.'."\n", - 'type' => 'string', - 'example' => 'NORMAL', - ], - 'RepeatInterval' => [ - 'description' => 'The interval at which the node is rerun after the node fails to run.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - ], - 'Repeatability' => [ - 'description' => 'Indicates whether the node can be rerun.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'FileType' => [ - 'description' => 'The node type. Valid values:'."\n" - ."\n" - .'6 (Shell), 10 (ODPS SQL), 11 (ODPS MR), 23 (Data Integration), 24 (ODPS Script), 99 (zero load), 221 (PyODPS 2), 225 (ODPS Spark), 227 (EMR Hive), 228 (EMR Spark), 229 (EMR Spark SQL), 230 (EMR MR), 239 (OSS object inspection), 257 (EMR Shell), 258 (EMR Spark Shell), 259 (EMR Presto), 260 (EMR Impala), 900 (real-time synchronization), 1089 (cross-tenant collaboration), 1091 (Hologres development), 1093 (Hologres SQL), 1100 (assignment), and 1221 (PyODPS 3)'."\n", - 'type' => 'string', - 'example' => 'ODPS_SQL', - ], - 'ProjectId' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '33671', - ], - 'ProgramType' => [ - 'description' => 'The node type. This parameter is deprecated. For more information about node types, see valid values of the FileType parameter.'."\n", - 'type' => 'string', - 'example' => 'ODPS_SQL', - ], - 'Priority' => [ - 'description' => 'The priority of the node. Valid values: 1, 3, 5, 7, and 8. A greater value indicates a higher priority. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'OwnerId' => [ - 'description' => 'The owner ID.'."\n", - 'type' => 'string', - 'example' => '19337906836551', - ], - 'Connection' => [ - 'description' => 'The name of the data source.'."\n", - 'type' => 'string', - 'example' => 'odps_first', - ], - 'ParamValues' => [ - 'description' => 'The scheduling parameters of the node.'."\n", - 'type' => 'string', - 'example' => 'a=b', - ], - 'RelatedFlowId' => [ - 'description' => 'The ID of the workflow to which the node belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1235655464', - ], - 'DqcType' => [ - 'description' => 'Indicates whether the node is associated with a monitoring rule in Data Quality. Valid values: 0 and 1. The value 0 indicates that the node is associated with a monitoring rule in Data Quality. The value 1 indicates that the node is not associated with a monitoring rule in Data Quality.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'BaselineId' => [ - 'description' => 'The baseline ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1235667', - ], - 'Description' => [ - 'description' => 'The description of the node.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'NodeName' => [ - 'description' => 'The name of the node.'."\n", - 'type' => 'string', - 'example' => 'liux_test_n****', - ], - 'ResGroupName' => [ - 'description' => 'The name of the resource group.'."\n", - 'type' => 'string', - 'example' => 'Default Resource Group', - ], - 'DqcDescription' => [ - 'description' => 'The table and partition filter expression in Data Quality that are associated with the node.'."\n", - 'type' => 'string', - 'example' => '[{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\\u003d$[yyyy-mm-dd-1]"}]', - ], - 'CronExpress' => [ - 'description' => 'The CRON expression.'."\n", - 'type' => 'string', - 'example' => '00 00 00 * * ?', - ], - 'NodeId' => [ - 'description' => 'The node ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '125677', - ], - ], - 'description' => '', - ], - ], - ], - 'description' => '', - ], - ], - ], - 'description' => '', - ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.Meta.NoCalcEngine', 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.', 'description' => ''], + ['errorCode' => 'InternalError.Meta.TenantTimeOut', 'errorMessage' => 'Failed to connect to the interface network.', 'description' => 'Failed to connect to the interface network.'], + ['errorCode' => 'InternalError.Meta.Unknown', 'errorMessage' => 'An unknown error occurred while processing your request.', 'description' => 'An unknown error occurred while processing your request.'], + ['errorCode' => 'Invalid.Meta.CategoryRelationDuplicate"', 'errorMessage' => 'The table is already bound to the category.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"SDFSDFSDF-asdfDFSDF-SDFSDf-SDfSFD\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Output\\": \\"test_0709_1.630003556_out\\",\\n \\"NodeList\\": [\\n {\\n \\"SchedulerType\\": \\"NORMAL\\",\\n \\"RepeatInterval\\": 60,\\n \\"Repeatability\\": true,\\n \\"FileType\\": \\"ODPS_SQL\\",\\n \\"ProjectId\\": 33671,\\n \\"ProgramType\\": \\"ODPS_SQL\\",\\n \\"Priority\\": 1,\\n \\"OwnerId\\": \\"19337906836551\\",\\n \\"Connection\\": \\"odps_source\\",\\n \\"ParamValues\\": \\"a=b\\",\\n \\"RelatedFlowId\\": 1235655464,\\n \\"DqcType\\": 1,\\n \\"BaselineId\\": 1235667,\\n \\"Description\\": \\"test\\",\\n \\"NodeName\\": \\"liux_test_n****\\",\\n \\"ResGroupName\\": \\"Default Resource Group\\",\\n \\"DqcDescription\\": \\"[{\\\\\\"projectName\\\\\\":\\\\\\"ztjy_dim\\\\\\",\\\\\\"tableName\\\\\\":\\\\\\"dim_user_agent_manage_area_a\\\\\\",\\\\\\"partition\\\\\\":\\\\\\"ds\\\\\\\\u003d$[yyyy-mm-dd-1]\\\\\\"}]\\",\\n \\"CronExpress\\": \\"00 00 00 * * ?\\",\\n \\"NodeId\\": 125677\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n SDFSDFSDF-asdfDFSDF-SDFSDf-SDfSFD\\n 200\\n \\n test_0709_1.630003556_out\\n \\n 1235667\\n 默认资源组\\n test\\n liux_test_n****\\n 1\\n 1\\n a=b\\n odps_source\\n 33671\\n 1235655464\\n NORMAL\\n 00 00 00 * * ?\\n true\\n 19337906836551\\n ODPS_SQL\\n [{\\"projectName\\":\\"ztjy_dim\\",\\"tableName\\":\\"dim_user_agent_manage_area_a\\",\\"partition\\":\\"ds\\\\u003d$[yyyy-mm-dd-1]\\"}]\\n 125677\\n ODPS_SQL\\n 60\\n \\n \\n Invalid.Tenant.ConnectionNotExists\\n The connection does not exist.\\n true\\n","errorExample":""}]', - 'title' => 'ListNodesByOutput', - 'summary' => 'Queries nodes based on the output of the nodes.', + 'title' => 'GetMetaCategory', + 'summary' => 'Queries the information about a category tree.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'RunTriggerNode' => [ - 'methods' => [ - 'post', - 'get', - 'put', - ], - 'schemes' => [ - 'http', - 'https', + 'extraInfo' => ' GetMetaCategory接口的使用示例Demo请参见[DataWorks OpenAPI示例](https://developer.aliyun.com/article/780879?groupCode=dataworks)。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10,\\n \\"DataEntityList\\": [\\n {\\n \\"Depth\\": 1,\\n \\"Comment\\": \\"category 1\\",\\n \\"ModifiedTime\\": 1541576644000,\\n \\"CreateTime\\": 1541576644000,\\n \\"CategoryId\\": 133,\\n \\"LastOperatorId\\": \\"12345\\",\\n \\"Name\\": \\"category 1\\",\\n \\"ParentCategoryId\\": 12,\\n \\"OwnerId\\": \\"123\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'GetMetaCollectionDetail' => [ + 'summary' => 'Queries the information about a collection.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '78349', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - 'FEATUREdideVFMENL', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '163136', + 'abilityTreeNodes' => ['FEATUREdideE9XYA6'], ], 'parameters' => [ - [ - 'name' => 'NodeId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the manually triggered node. You can call the [ListNodes](~~173979~~) operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '-9223372036854775808', - 'example' => '10000011', - ], - ], - [ - 'name' => 'CycleTime', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The scheduling time to run the manually triggered node. Set the value to a 13-digit timestamp in milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '-9223372036854775808', - 'example' => '1606200230105', - ], - ], - [ - 'name' => 'BizDate', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The data timestamp of the instance that is generated for the manually triggered node.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '-9223372036854775808', - 'example' => '1606200230105', - ], - ], - [ - 'name' => 'AppId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the DataWorks workspace to which the manually triggered node belongs. You can call the [ListProjects](~~178393~~) operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '-9223372036854775808', - 'example' => '10001', - ], + [ + 'name' => 'QualifiedName', + 'in' => 'query', + 'schema' => ['description' => 'The unique identifier of the collection.'."\n", 'type' => 'string', 'required' => true, 'example' => 'album.12345', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned result.'."\n", 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '9BA675F1-F848-4752-A6E3-92ABA0616005', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", 'type' => 'string', 'example' => '0000-ABCD-E****'], + 'Collection' => ['description' => 'The information about the collection.'."\n", '$ref' => '#/components/schemas/Collection', 'title' => '', 'example' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'true'."\n" + ."\n" + .'false'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '9999', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'album.xxxx does not exist.', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], ], - 'description' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'ResourceNotAuthorized.Api', - 'errorMessage' => 'You are not authorized to access the resources.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'Forbidden.Not.Server', - 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.', - ], - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], + 'title' => 'GetMetaCollectionDetail', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMetaCollectionDetail'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"9BA675F1-F848-4752-A6E3-92ABA0616005\\"\\n}","errorExample":""},{"type":"xml","example":"9BA675F1-F848-4752-A6E3-92ABA0616005\\ntrue","errorExample":""}]', - 'title' => 'RunTriggerNode', - 'summary' => 'Runs a manually triggered node.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0000-ABCD-E****\\",\\n \\"Collection\\": {\\n \\"QualifiedName\\": \\"album.12334\\",\\n \\"CollectionType\\": \\"album\\",\\n \\"Name\\": \\"collectionName\\",\\n \\"Comment\\": \\"comment\\",\\n \\"OwnerId\\": \\"1234444\\",\\n \\"OwnerName\\": \\"owner\\",\\n \\"CreateTime\\": 1668600147617,\\n \\"UpdateTime\\": 1668600148617,\\n \\"Level\\": 1\\n },\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"9999\\",\\n \\"ErrorMessage\\": \\"album.xxxx does not exist.\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', ], - 'GetNodeParents' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetMetaColumnLineage' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -37167,178 +17752,145 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '78276', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - 'FEATUREdideVFMENL', - ], + 'abilityTreeCode' => '78258', + 'abilityTreeNodes' => ['FEATUREdideSYOMAV'], ], 'parameters' => [ [ - 'name' => 'ProjectEnv', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The environment type of Operation Center. Valid values: PROD and DEV. The value PROD indicates the production environment, and the value DEV indicates the development environment.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'PROD', - 'enum' => [ - 'PROD', - 'DEV', - ], - ], + 'name' => 'ColumnGuid', + 'in' => 'query', + 'schema' => ['description' => 'The unique identifier of the field.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'odps.engine_name.table_name.column_name', 'title' => ''], ], [ - 'name' => 'NodeId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The node ID. You can go to the Operation Center page in the DataWorks console to query the node ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '12345456211234', - ], + 'name' => 'Direction', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to query the ancestor or descendant lineage of the field. The value up indicates the ancestor lineage. The value down indicates the descendant lineage.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'up', 'title' => ''], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => ['description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page. Default value: 10. Maximum value: 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the E-MapReduce (EMR) cluster. Configure this parameter only when you query data in an EMR compute engine instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''], + ], + [ + 'name' => 'DatabaseName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the metatable.'."\n", 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''], + ], + [ + 'name' => 'ColumnName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the field.'."\n", 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''], + ], + [ + 'name' => 'DataSourceType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the data source. Valid values: odps and emr.'."\n", 'type' => 'string', 'required' => false, 'example' => 'emr', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The returned result.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => 'asfasdfs-adfasdf-asfas-dfasdf-asdf', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'err', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '1060010000000', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The connection does not exist.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0bc1ec92159376', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], 'Data' => [ - 'description' => 'The ancestor nodes.'."\n", + 'description' => 'The business data.'."\n", 'type' => 'object', 'properties' => [ - 'Nodes' => [ - 'description' => 'The ancestor nodes.'."\n", + 'PageNum' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of fields.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'DataEntityList' => [ + 'description' => 'The returned result.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'The returned result.'."\n", 'type' => 'object', 'properties' => [ - 'SchedulerType' => [ - 'description' => 'The scheduling type of the node. Valid values:'."\n" - ."\n" - .'* NORMAL: The node is an auto triggered node.'."\n" - .'* MANUAL: The node is a manually triggered node. Manually triggered nodes cannot be automatically triggered.'."\n" - .'* PAUSE: The node is a paused node. Paused nodes are started as scheduled but the system sets the status of the nodes to failed when it starts to run them.'."\n" - .'* SKIP: The node is a dry-run node. Dry-run nodes are started as scheduled but the system sets the status of the nodes to successful when it starts to run them.'."\n", - 'type' => 'string', - 'example' => 'NORMAL', - ], - 'BaselineId' => [ - 'description' => 'The baseline ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1244564565', - ], - 'Repeatability' => [ - 'description' => 'Indicates whether the node can be rerun if the node fails to run. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'NodeName' => [ - 'description' => 'The name of the node.'."\n", - 'type' => 'string', - 'example' => 'test_Node', - ], - 'ProjectId' => [ - 'description' => 'The ID of the workspace to which the node belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12315412412', - ], - 'ProgramType' => [ - 'description' => 'The type of the node.'."\n", - 'type' => 'string', - 'example' => 'ODPS_SQL', - ], - 'Priority' => [ - 'description' => 'The priority. Valid values: 1 to 8. A large value indicates a high priority.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'OwnerId' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the node owner.'."\n", - 'type' => 'string', - 'example' => '123124561341251321', - ], - 'CronExpress' => [ - 'description' => 'The CRON expression. CRON expressions are used to run auto triggered nodes.'."\n", - 'type' => 'string', - 'example' => '00 00 * * * *', - ], - 'NodeId' => [ - 'description' => 'The node ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1244564565', - ], - 'StepType' => [ - 'description' => 'The scheduling dependency type.'."\n" - ."\n" - .'* **0**: same-cycle scheduling dependency'."\n" - .'* **3**: cross-cycle scheduling dependency'."\n", - 'type' => 'string', - 'example' => '0', - ], + 'ColumnGuid' => ['description' => 'The unique identifier of the field.'."\n", 'type' => 'string', 'example' => 'odps.engine_name.table_name.1', 'title' => ''], + 'ColumnName' => ['description' => 'The name of the field.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'TableName' => ['description' => 'The name of the table.'."\n", 'type' => 'string', 'example' => 'abc', 'title' => ''], + 'DatabaseName' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'abc', 'title' => ''], + 'ClusterId' => ['description' => 'The EMR cluster ID.'."\n", 'type' => 'string', 'example' => 'abc', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"asfsdfas-adfasdf-asfas-dfasdf-asdf\\",\\n \\"ErrorMessage\\": \\"err\\",\\n \\"ErrorCode\\": \\"1060010000000\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Nodes\\": [\\n {\\n \\"SchedulerType\\": \\"NORMAL\\",\\n \\"BaselineId\\": 1244564565,\\n \\"Repeatability\\": true,\\n \\"NodeName\\": \\"test_Node\\",\\n \\"ProjectId\\": 12315412412,\\n \\"ProgramType\\": \\"ODPS_SQL\\",\\n \\"Priority\\": 3,\\n \\"OwnerId\\": \\"123124561341251321\\",\\n \\"CronExpress\\": \\"00 00 * * * *\\",\\n \\"NodeId\\": 1244564565,\\n \\"StepType\\": \\"0\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n asdfasdfas-adfasdf-asfas-dfasdf-asdf\\n err\\n 1060010000000\\n true\\n \\n \\n NORMAL\\n 1244564565\\n true\\n test_Node\\n 12315412412\\n ODPS_SQL\\n 3\\n 123124561341251321\\n 00 00 * * * *\\n 1244564565\\n \\n \\n","errorExample":""}]', - 'title' => 'GetNodeParents', - 'summary' => 'Queries a list of ancestor nodes of a node.', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Invalid.Meta.TableNotExist', 'errorMessage' => 'The table does not exist.', 'description' => 'The table does not exist.'], + ['errorCode' => 'InvalidParameter.Meta.CommonError', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The request parameter is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.Illegal', 'errorMessage' => 'The app guid parameter is invalid.', 'description' => 'The app guid parameter is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.IllegalDate', 'errorMessage' => 'The date format is invalid.', 'description' => 'The date format is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.IllegalPageError', 'errorMessage' => 'The parameter for paging is invalid.', 'description' => 'The parameter for paging is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.NotExist', 'errorMessage' => 'The object does not exist.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'Forbidden.Meta.NoTenant', 'errorMessage' => 'The user is not the owner of any tenants.', 'description' => 'The user is not the owner of any tenants.'], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.Meta.NoCalcEngine', 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.', 'description' => ''], + ['errorCode' => 'InternalError.Meta.TenantTimeOut', 'errorMessage' => 'Failed to connect to the interface network.', 'description' => 'Failed to connect to the interface network.'], + ['errorCode' => 'InternalError.Meta.Unknown', 'errorMessage' => 'An unknown error occurred while processing your request.', 'description' => 'An unknown error occurred while processing your request.'], + ], + ], + 'title' => 'GetMetaColumnLineage', + 'summary' => 'Queries the lineage of a field in a metatable.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'GetNodeChildren' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'extraInfo' => 'For information about the example on how to use the GetMetaColumnLineage operation, see [Examples of DataWorks API operations](https://developer.aliyun.com/article/780879?groupCode=dataworks).'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 20,\\n \\"DataEntityList\\": [\\n {\\n \\"ColumnGuid\\": \\"odps.engine_name.table_name.1\\",\\n \\"ColumnName\\": \\"1\\",\\n \\"TableName\\": \\"abc\\",\\n \\"DatabaseName\\": \\"abc\\",\\n \\"ClusterId\\": \\"abc\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"0bc1ec92159376\\n200\\n\\n 20\\n 1\\n 10\\n \\n 1\\n abc\\n odps.engine_name.table_name.1\\n abc\\n abc\\n \\n\\nInvalid.Tenant.ConnectionNotExists\\nThe connection does not exist.\\ntrue","errorExample":""}]', + ], + 'GetMetaDBInfo' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -37348,479 +17900,644 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '78273', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - 'FEATUREdideVFMENL', - ], + 'abilityTreeCode' => '78259', + 'abilityTreeNodes' => ['FEATUREdideE9XYA6'], ], 'parameters' => [ [ - 'name' => 'ProjectEnv', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The environment type of Operation Center. Valid values: PROD and DEV. The value PROD indicates the production environment, and the value DEV indicates the development environment.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [], - 'example' => 'PROD', - 'enum' => [ - 'PROD', - 'DEV', - ], - ], + 'name' => 'AppGuid', + 'in' => 'query', + 'schema' => ['description' => 'The compute engine instance ID. Specify the ID in the `Engine type.Engine name` format.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'odps.some_engine_name', 'title' => ''], ], [ - 'name' => 'NodeId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The node ID. You can go to the Operation Center page in the DataWorks console to query the node ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '123456878', - ], + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The E-MapReduce (EMR) cluster ID.', 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''], + ], + [ + 'name' => 'DatabaseName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the metadatabase of the EMR cluster.', 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''], + ], + [ + 'name' => 'DataSourceType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the data source. Valid values: odps and emr.', 'type' => 'string', 'required' => false, 'example' => 'emr', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can use the ID to troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => 'adsfasdf-adf-asdf-asdf-asdfadfasdd', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'err', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '1060010000000', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0bc1411515937****', 'title' => ''], 'Data' => [ - 'description' => 'The information about the descendant nodes.'."\n", + 'description' => 'The basic metadata information.', 'type' => 'object', 'properties' => [ - 'Nodes' => [ - 'description' => 'The descendant nodes.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The descendant node.'."\n", - 'type' => 'object', - 'properties' => [ - 'SchedulerType' => [ - 'description' => 'The scheduling type of the node. Valid values:'."\n" - ."\n" - .'* NORMAL: The node is an auto triggered node.'."\n" - .'* MANUAL: The node is a manually triggered node. Manually triggered nodes cannot be automatically triggered.'."\n" - .'* PAUSE: The node is a paused node. Paused nodes are started as scheduled but the system sets the status of the nodes to failed when it starts to run them.'."\n" - .'* SKIP: The node is a dry-run node. Dry-run nodes are started as scheduled but the system sets the status of the nodes to successful when it starts to run them.'."\n", - 'type' => 'string', - 'example' => 'NORMAL', - ], - 'BaselineId' => [ - 'description' => 'The baseline ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12345656', - ], - 'Repeatability' => [ - 'description' => 'Indicates whether the node can be rerun if the node fails to run. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'NodeName' => [ - 'description' => 'The name of the node.'."\n", - 'type' => 'string', - 'example' => 'test_Node', - ], - 'ProjectId' => [ - 'description' => 'The ID of the workspace to which the node belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12315412412', - ], - 'ProgramType' => [ - 'description' => 'The type of the node.'."\n", - 'type' => 'string', - 'example' => 'ODPS_SQL', - ], - 'Priority' => [ - 'description' => 'The priority. Valid values: 1 to 8. A large value indicates a high priority.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'OwnerId' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the node owner.'."\n", - 'type' => 'string', - 'example' => '123124561341251321', - ], - 'CronExpress' => [ - 'description' => 'The CRON expression. CRON expressions are used to run auto triggered nodes.'."\n", - 'type' => 'string', - 'example' => '00 00 * * * * ', - ], - 'NodeId' => [ - 'description' => 'The node ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1244564565', - ], - 'StepType' => [ - 'description' => 'The scheduling dependency type. Valid values:'."\n" - ."\n" - .'* **0**: same-cycle scheduling dependency'."\n" - .'* **3**: cross-cycle scheduling dependency'."\n", - 'type' => 'string', - 'example' => '0', - ], - ], - ], - ], - ], + 'Type' => ['description' => 'The type of the metadatabase.', 'type' => 'string', 'example' => 'hive', 'title' => ''], + 'Comment' => ['description' => 'The comment.', 'type' => 'string', 'example' => 'Remarks', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the compute engine instance was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1541576644000', 'title' => ''], + 'ProjectId' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '22', 'title' => ''], + 'ProjectName' => ['description' => 'The name of the workspace.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'AppGuid' => ['description' => 'The compute engine instance ID. Specify the ID in the `Engine type.Engine name` format.', 'type' => 'string', 'example' => 'odps.engine_name', 'title' => ''], + 'OwnerName' => ['description' => 'The name of the workspace owner.', 'type' => 'string', 'example' => 'my_name', 'title' => ''], + 'OwnerId' => ['description' => 'The ID of the Alibaba Cloud account used by the workspace owner.', 'type' => 'string', 'example' => 'userId', 'title' => ''], + 'EnvType' => ['description' => 'The type of the environment. Valid values: 0 and 1. The value 0 indicates the development environment. The value 1 indicates the production environment.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ProjectNameCn' => ['description' => 'The display name of the workspace.', 'type' => 'string', 'example' => '测试项目', 'title' => ''], + 'Endpoint' => ['description' => 'The endpoint of the service.', 'type' => 'string', 'example' => 'http://service.odpsstg.aliyun-inc.com/', 'title' => ''], + 'ClusterBizId' => ['description' => 'The EMR cluster ID.', 'type' => 'string', 'example' => 'abc', 'title' => ''], + 'Name' => ['description' => 'The name of the database.', 'type' => 'string', 'example' => 'abc', 'title' => ''], + 'Location' => ['description' => 'The storage path of the metadatabase of the EMR cluster.', 'type' => 'string', 'example' => 'hdfs://', 'title' => ''], + 'TenantId' => ['description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '233', 'title' => ''], + 'ModifyTime' => ['description' => 'The time when the compute engine instance was modified.', 'type' => 'integer', 'format' => 'int64', 'example' => '1541576644000', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"adsfasdf-adf-asdf-asdf-asdfadfasdd\\",\\n \\"ErrorMessage\\": \\"err\\",\\n \\"ErrorCode\\": \\"1060010000000\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Nodes\\": [\\n {\\n \\"SchedulerType\\": \\"NORMAL\\",\\n \\"BaselineId\\": 12345656,\\n \\"Repeatability\\": true,\\n \\"NodeName\\": \\"test_Node\\",\\n \\"ProjectId\\": 12315412412,\\n \\"ProgramType\\": \\"ODPS_SQL\\",\\n \\"Priority\\": 3,\\n \\"OwnerId\\": \\"123124561341251321\\",\\n \\"CronExpress\\": \\"00 00 * * * * \\",\\n \\"NodeId\\": 1244564565,\\n \\"StepType\\": \\"0\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n adsfasdf-adf-asdf-asdf-asdfadfasdd\\n err\\n 1060010000000\\n true\\n \\n \\n NORMAL\\n 12345656\\n true\\n test_Node\\n 12315412412\\n ODPS_SQL\\n 3\\n 123124561341251321\\n 00 00 * * * * \\n 1244564565\\n \\n \\n","errorExample":""}]', - 'title' => 'GetNodeChildren', - 'summary' => 'Queries a list of instances.', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Invalid.Meta.AppNotExist', 'errorMessage' => 'The MaxCompute project does not exist.', 'description' => 'The MaxCompute project does not exist.'], + ['errorCode' => 'InvalidParameter.Meta.CommonError', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The request parameter is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.Illegal', 'errorMessage' => 'The app guid parameter is invalid.', 'description' => 'The app guid parameter is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.IllegalDate', 'errorMessage' => 'The date format is invalid.', 'description' => 'The date format is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.IllegalPageError', 'errorMessage' => 'The parameter for paging is invalid.', 'description' => 'The parameter for paging is invalid.'], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.Meta.NoCalcEngine', 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.', 'description' => 'Incorrect project entered by user'], + ['errorCode' => 'InvalidParameter.Meta.NotExist', 'errorMessage' => 'The data does not exist.', 'description' => 'No data is available.'], + ], + 403 => [ + ['errorCode' => 'Forbidden.Meta.NoTenant', 'errorMessage' => 'The user is not the owner of any tenants.', 'description' => 'The user is not the owner of any tenants.'], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.Meta.TenantTimeOut', 'errorMessage' => 'Failed to connect to the interface network.', 'description' => 'Failed to connect to the interface network.'], + ['errorCode' => 'InternalError.Meta.Unknown', 'errorMessage' => 'An unknown error occurred while processing your request.', 'description' => 'An unknown error occurred while processing your request.'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc1411515937****\\",\\n \\"Data\\": {\\n \\"Type\\": \\"hive\\",\\n \\"Comment\\": \\"Remarks\\",\\n \\"CreateTime\\": 1541576644000,\\n \\"ProjectId\\": 22,\\n \\"ProjectName\\": \\"test\\",\\n \\"AppGuid\\": \\"odps.engine_name\\",\\n \\"OwnerName\\": \\"my_name\\",\\n \\"OwnerId\\": \\"userId\\",\\n \\"EnvType\\": 1,\\n \\"ProjectNameCn\\": \\"测试项目\\",\\n \\"Endpoint\\": \\"http://service.odpsstg.aliyun-inc.com/\\",\\n \\"ClusterBizId\\": \\"abc\\",\\n \\"Name\\": \\"abc\\",\\n \\"Location\\": \\"hdfs://\\",\\n \\"TenantId\\": 233,\\n \\"ModifyTime\\": 1541576644000\\n }\\n}","type":"json"}]', + 'title' => 'GetMetaDBInfo', + 'summary' => 'Queries the basic metadata information about a compute engine instance.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'UpdateNodeRunMode' => [ - 'methods' => [ - 'post', + 'extraInfo' => ' GetMetaDBInfo接口的使用示例Demo请参见[DataWorks OpenAPI示例](https://developer.aliyun.com/article/780879?groupCode=dataworks)。', + 'changeSet' => [ + ['createdAt' => '2023-05-12T08:28:34.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-08-11T02:23:22.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-12-20T08:05:19.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'GetMetaDBTableList' => [ + 'summary' => 'Retrieves all tables in the specified Engine Instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '78378', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '78260', + 'abilityTreeNodes' => ['FEATUREdideE9XYA6'], ], 'parameters' => [ [ - 'name' => 'ProjectEnv', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The environment in which the node runs. Valid values: DEV and PROD. The value DEV indicates the development environment, and the value PROD indicates the production environment.'."\n" - ."\n" - .'* PROD'."\n" - .'* DEV'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'PROD', - 'enum' => [ - 'PROD', - 'DEV', - ], - ], + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number to return.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'NodeId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The node ID. You can call the [ListNodes](~~173979~~) operation to query the node ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1234', - ], + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 1,000.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '1000', 'minimum' => '1', 'exclusiveMinimum' => false, 'required' => false, 'example' => '100', 'title' => ''], ], [ - 'name' => 'SchedulerType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The operation that you want to perform on the node. Valid values:'."\n" - ."\n" - .'* 0: indicates that you want to unfreeze the node.'."\n" - .'* 2: indicates that you want to freeze the node.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '0', - 'enum' => [ - '0', - '2', - ], - ], + 'name' => 'AppGuid', + 'in' => 'query', + 'schema' => ['description' => 'The unique identifier for the project, in the format `odps.{projectName}`. This parameter is required only if the `DataSourceType` is set to `odps`.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => 'odps.testProjectName', 'title' => ''], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the E-MapReduce (EMR) cluster. This parameter is required only if the `DataSourceType` is set to `emr`.', 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''], + ], + [ + 'name' => 'DatabaseName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the database.', 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''], + ], + [ + 'name' => 'DataSourceType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the data source. Valid values: `odps` and `emr`.', 'type' => 'string', 'required' => false, 'example' => 'odps', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'E6F0DBDD-5AD****', + 'RequestId' => ['description' => 'The unique ID for this request.', 'type' => 'string', 'example' => '0bc1ec92159376', 'title' => ''], + 'Data' => [ + 'description' => 'Information about the tables in the engine instance.', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of tables.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'TableEntityList' => [ + 'description' => 'A list of table details.', + 'type' => 'array', + 'items' => [ + 'description' => 'A table object.', + 'type' => 'object', + 'properties' => [ + 'TableName' => ['description' => 'The name of the table.', 'type' => 'string', 'example' => 'tname', 'title' => ''], + 'TableGuid' => ['description' => 'The unique identifier of the table.', 'type' => 'string', 'example' => 'odps.engine_name.tname', 'title' => ''], + 'DatabaseName' => ['description' => 'The name of the database.', 'type' => 'string', 'example' => 'abc', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n E6F0DBDD-5AD****\\n","errorExample":""}]', - 'title' => 'UpdateNodeRunMode', - 'summary' => 'Freezes or unfreezes a node.', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Invalid.Meta.AppNotExist', 'errorMessage' => 'The MaxCompute project does not exist.', 'description' => 'The MaxCompute project does not exist.'], + ['errorCode' => 'InvalidParameter.Meta.CommonError', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The request parameter is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.Illegal', 'errorMessage' => 'The app guid parameter is invalid.', 'description' => 'The app guid parameter is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.IllegalPageError', 'errorMessage' => 'The parameter for paging is invalid.', 'description' => 'The parameter for paging is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.NotExist', 'errorMessage' => 'The object does not exist.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.Meta.NoCalcEngine', 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.', 'description' => 'Incorrect project entered by user'], + ], + 403 => [ + ['errorCode' => 'Forbidden.Meta.NoTenant', 'errorMessage' => 'The user is not the owner of any tenants.', 'description' => 'The user is not the owner of any tenants.'], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.Meta.TenantTimeOut', 'errorMessage' => 'Failed to connect to the interface network.', 'description' => 'Failed to connect to the interface network.'], + ['errorCode' => 'InternalError.Meta.Unknown', 'errorMessage' => 'An unknown error occurred while processing your request.', 'description' => 'An unknown error occurred while processing your request.'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 20,\\n \\"TableEntityList\\": [\\n {\\n \\"TableName\\": \\"tname\\",\\n \\"TableGuid\\": \\"odps.engine_name.tname\\",\\n \\"DatabaseName\\": \\"abc\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'GetMetaDBTableList', 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'UpdateNodeOwner' => [ - 'methods' => [ - 'post', + 'responseParamsDescription' => '# Create a database instance'."\n" + ."\n" + .'This document shows how to create a database instance.'."\n" + ."\n" + .'## Configuration'."\n" + ."\n" + .'After you log in, navigate to the "Settings" page, then select "Monitoring".'."\n" + ."\n" + .'If the basic settings have been configured, you can skip to the "Advanced" section.'."\n" + ."\n" + .'1. On the configuration page, enter the following information:'."\n" + ."\n" + .' - Instance Name: Enter a descriptive name for your instance.'."\n" + .' - Database Type: Select a database engine, such as MySQL.'."\n" + .' - Region: Select the region for the instance.'."\n" + ."\n" + .'2. Once you have completed the configuration, read the terms of service carefully.'."\n" + ."\n" + .'3. Click Buy Now, then click Go to Pay.'."\n" + ."\n" + .'4. Once the instance is created, it will appear in the instance list. Click the Manage link to open the details page. If you encounter problems, click View Documentation.'."\n" + ."\n" + .'## Additional information'."\n" + ."\n" + .'The system will check the agent environment.'."\n" + ."\n" + .'> Collecting more data requires more storage.'."\n" + ."\n" + .'We recommend starting with a smaller dataset then expanding as needed.', + 'extraInfo' => ' GetMetaDBTableList接口的使用示例Demo请参见[DataWorks OpenAPI示例](https://developer.aliyun.com/article/780879?groupCode=dataworks)。'."\n", + 'changeSet' => [ + ['createdAt' => '2021-12-14T08:21:06.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-12-14T08:21:06.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetMetaTableBasicInfo' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '78377', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - ], + 'abilityTreeCode' => '78261', + 'abilityTreeNodes' => ['FEATUREdideRZEBFC'], ], 'parameters' => [ [ - 'name' => 'ProjectEnv', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The environment in which the node runs. Valid values: DEV and PROD. The value DEV indicates the development environment, and the value PROD indicates the production environment.'."\n" - ."\n" - .'* PROD'."\n" - .'* DEV'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'PROD', - 'enum' => [ - 'PROD', - 'DEV', - ], - ], + 'name' => 'TableGuid', + 'in' => 'query', + 'schema' => ['description' => 'The GUID of the MaxCompute table. Specify the GUID in the odps.projectName.tableName format.'."\n" + ."\n" + .'> This parameter is optional for E-MapReduce (EMR) tables.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'odps.engine_name.table_name', 'title' => ''], ], [ - 'name' => 'NodeId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The node ID. You can call the [ListNodes](~~173979~~) operation to query the node ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1234', - ], + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the EMR cluster. This parameter is required only if you set the DataSourceType parameter to emr.'."\n" + ."\n" + .'You can log on to the [EMR console](https://emr.console.aliyun.com/?spm=a2c4g.11186623.0.0.965cc5c2GeiHet#/cn-hangzhou) to query the ID.', 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''], ], [ - 'name' => 'UserId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the node owner. You can log on to the DataWorks console and move the pointer over the profile picture in the upper-right corner to view the ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '19337906836551', - 'maxLength' => 64, - ], + 'name' => 'DatabaseName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the metadatabase. This parameter is required only if you set the DataSourceType parameter to emr.'."\n" + ."\n" + .'You can call the [ListMetaDB](~~2780105~~) operation to query the name.', 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the metatable in the EMR cluster. This parameter is required only if you set the DataSourceType parameter to emr.'."\n" + ."\n" + .'You can call the [GetMetaDBTableList](~~2780086~~) operation to query the name.', 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''], + ], + [ + 'name' => 'DataSourceType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the data source. Valid values: odps and emr.', 'type' => 'string', 'required' => false, 'example' => 'emr', 'title' => ''], + ], + [ + 'name' => 'Extension', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to include extended fields in query results. The extended fields include ReadCount, FavoriteCount, and ViewCount. This parameter takes effect only if you set the DataSourceType parameter to odps.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can use the request ID to query logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => 'E6F0DBDD-5AD****', + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The connection does not exist.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0bc1411515937', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], + 'Data' => [ + 'description' => 'The business data.', + 'type' => 'object', + 'properties' => [ + 'TableName' => ['description' => 'The name of the metatable.', 'type' => 'string', 'example' => 'table_name', 'title' => ''], + 'FavoriteCount' => ['description' => 'The number of times the metatable was added to a favorite list. This parameter is returned only if you set the Extension parameter to true and takes effect only if you set the DataSourceType parameter to odps.', 'type' => 'integer', 'format' => 'int64', 'example' => '6', 'title' => ''], + 'Comment' => ['description' => 'The comment of the metatable.', 'type' => 'string', 'example' => 'test table', 'title' => ''], + 'ColumnCount' => ['description' => 'The number of fields.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the metatable was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1589870294000', 'title' => ''], + 'ProjectId' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '232', 'title' => ''], + 'OwnerId' => ['description' => 'The ID of the metatable owner.', 'type' => 'string', 'example' => '123', 'title' => ''], + 'EnvType' => ['description' => 'The type of the environment. Valid values:'."\n" + ."\n" + .'- 0: development environment'."\n" + ."\n" + .'- 1: production environment', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'DatabaseName' => ['description' => 'The name of the metadatabase.', 'type' => 'string', 'example' => 'abc', 'title' => ''], + 'IsVisible' => ['description' => 'The scope in which the metatable is visible. Valid values:'."\n" + ."\n" + .'- 0: The metatable is visible to workspace members.'."\n" + ."\n" + .'- 1: The metatable is visible to users within the tenant.'."\n" + ."\n" + .'- 2: The metatable is visible to all tenants.'."\n" + ."\n" + .'- 3: The metatable is visible only to the metatable owner.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'TableGuid' => ['description' => 'The GUID of the metatable.', 'type' => 'string', 'example' => 'odps.engine_name.table_name', 'title' => ''], + 'ReadCount' => ['description' => 'The number of times the metatable was read. This parameter is returned only if you set the Extension parameter to true and takes effect only if you set the DataSourceType parameter to odps.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'ClusterId' => ['description' => 'The ID of the EMR cluster.', 'type' => 'string', 'example' => 'abc', 'title' => ''], + 'IsPartitionTable' => ['description' => 'Indicates whether the metatable is a partitioned table. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'IsView' => ['description' => 'Indicates whether the metatable is a view. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'LifeCycle' => ['description' => 'The lifecycle of the table. Unit: day.'."\n" + ."\n" + .'> If the lifecycle is not set for a MaxCompute table, the return value is 0, indicating that the table is permanently valid.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'ProjectName' => ['description' => 'The name of the workspace.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'ViewCount' => ['description' => 'The number of times the metatable was viewed. This parameter is returned only if you set the Extension parameter to true and takes effect only if you set the DataSourceType parameter to odps.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'LastAccessTime' => ['description' => 'The time when the metatable was last accessed.', 'type' => 'integer', 'format' => 'int64', 'example' => '1589870294000', 'title' => ''], + 'DataSize' => ['description' => 'The size of storage space that is occupied by the metatable. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'LastModifyTime' => ['description' => 'The time when the metatable was last updated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1589870294000', 'title' => ''], + 'LastDdlTime' => ['description' => 'The time when the schema of the metatable was last changed.', 'type' => 'integer', 'format' => 'int64', 'example' => '1589870294000', 'title' => ''], + 'PartitionKeys' => ['description' => 'The partition key of the Hive metatable.', 'type' => 'string', 'example' => 'ab', 'title' => ''], + 'Location' => ['description' => 'The storage path of the Hive metadatabase.', 'type' => 'string', 'example' => 'hdfs://', 'title' => ''], + 'Caption' => ['description' => 'The display name of the metatable.', 'type' => 'string', 'example' => '中文名', 'title' => ''], + 'TenantId' => ['description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '12345', 'title' => ''], + 'Schema' => ['description' => 'The schema information of the metatable. This parameter is returned if the three-layer model of MaxCompute is enabled.', 'type' => 'string', 'example' => 'default', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n E6F0DBDD-5AD****\\n","errorExample":""}]', - 'title' => 'UpdateNodeOwner', - 'summary' => 'Changes the owner of a node.', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Invalid.Meta.TableNotExist', 'errorMessage' => 'The table does not exist.', 'description' => 'The table does not exist.'], + ['errorCode' => 'InvalidParameter.Meta.CommonError', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The request parameter is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.Illegal', 'errorMessage' => 'The app guid parameter is invalid.', 'description' => 'The app guid parameter is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.IllegalDate', 'errorMessage' => 'The date format is invalid.', 'description' => 'The date format is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.IllegalPageError', 'errorMessage' => 'The parameter for paging is invalid.', 'description' => 'The parameter for paging is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.NotExist', 'errorMessage' => 'The object does not exist.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.Meta.NoCalcEngine', 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.', 'description' => 'Incorrect project entered by user'], + ], + 403 => [ + ['errorCode' => 'Forbidden.Meta.NoTenant', 'errorMessage' => 'The user is not the owner of any tenants.', 'description' => 'The user is not the owner of any tenants.'], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.Meta.TenantTimeOut', 'errorMessage' => 'Failed to connect to the interface network.', 'description' => 'Failed to connect to the interface network.'], + ['errorCode' => 'InternalError.Meta.Unknown', 'errorMessage' => 'An unknown error occurred while processing your request.', 'description' => 'An unknown error occurred while processing your request.'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0bc1411515937\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Data\\": {\\n \\"TableName\\": \\"table_name\\",\\n \\"FavoriteCount\\": 6,\\n \\"Comment\\": \\"test table\\",\\n \\"ColumnCount\\": 3,\\n \\"CreateTime\\": 1589870294000,\\n \\"ProjectId\\": 232,\\n \\"OwnerId\\": \\"123\\",\\n \\"EnvType\\": 1,\\n \\"DatabaseName\\": \\"abc\\",\\n \\"IsVisible\\": 1,\\n \\"TableGuid\\": \\"odps.engine_name.table_name\\",\\n \\"ReadCount\\": 3,\\n \\"ClusterId\\": \\"abc\\",\\n \\"IsPartitionTable\\": true,\\n \\"IsView\\": false,\\n \\"LifeCycle\\": 5,\\n \\"ProjectName\\": \\"test\\",\\n \\"ViewCount\\": 2,\\n \\"LastAccessTime\\": 1589870294000,\\n \\"DataSize\\": 10,\\n \\"LastModifyTime\\": 1589870294000,\\n \\"LastDdlTime\\": 1589870294000,\\n \\"PartitionKeys\\": \\"ab\\",\\n \\"Location\\": \\"hdfs://\\",\\n \\"Caption\\": \\"中文名\\",\\n \\"TenantId\\": 12345,\\n \\"Schema\\": \\"default\\"\\n }\\n}","type":"json"}]', + 'title' => 'GetMetaTableBasicInfo', + 'summary' => 'Queries the basic information about a metatable.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'UpdateWorkbenchEventResult' => [ - 'summary' => 'Returns the processing result sent by an extension after a process in Operation Center is blocked by the extension.', - 'methods' => [ - 'post', + 'extraInfo' => ' GetMetaTableBasicInfo接口的使用示例Demo请参见[DataWorks OpenAPI示例](https://developer.aliyun.com/article/780879?groupCode=dataworks)。', + 'changeSet' => [ + ['createdAt' => '2022-07-19T06:35:48.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-12-20T08:05:19.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetMetaTableChangeLog' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '103198', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '78262', + 'abilityTreeNodes' => ['FEATUREdideE9XYA6'], ], 'parameters' => [ [ - 'name' => 'MessageId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the message received when the related extension point event is triggered after you enable message subscription by using the OpenEvent module.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '03400b03-b721-4c34-8727-2d6884077091', - ], + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'TableGuid', + 'in' => 'formData', + 'schema' => ['description' => 'The GUID of the table. Specify the GUID in the odps.projectName.tableName format. You can call the [GetMetaDBTableList](~~2780086~~) operation to query the GUID.'."\n" + ."\n" + .'> To query the change logs of a MaxCompute table, you must call the [GetMetaTableChangeLog](~~2780094~~) operation.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'odps.engine_name.table_name', 'title' => ''], ], [ - 'name' => 'ExtensionCode', - 'in' => 'query', - 'schema' => [ - 'description' => 'The code of the extension.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '58e95e2acd6f408e8707f1bf2591f9e9', - ], + 'name' => 'ChangeType', + 'in' => 'formData', + 'schema' => ['description' => 'The type of the change. Valid values: CREATE\\_TABLE, ALTER\\_TABLE, DROP\\_TABLE, ADD\\_PARTITION, and DROP\\_PARTITION.', 'type' => 'string', 'required' => false, 'example' => 'ALTER_TABLE', 'title' => ''], ], [ - 'name' => 'CheckResult', - 'in' => 'query', - 'schema' => [ - 'description' => 'The check result of the extension point event. Valid values: OK and Fail.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'FAIL', - 'enum' => [ - 'OK', - 'FAIL', - 'WARN', - ], - ], + 'name' => 'ObjectType', + 'in' => 'formData', + 'schema' => ['description' => 'The entity on which the change is made. Valid values: TABLE and PARTITION.', 'type' => 'string', 'required' => false, 'example' => 'TABLE', 'title' => ''], ], [ - 'name' => 'CheckResultTip', - 'in' => 'query', - 'schema' => [ - 'description' => 'The cause of the check failure.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SQL is too long', - ], + 'name' => 'StartDate', + 'in' => 'formData', + 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in the yyyy-MM-dd HH:mm:ss format.'."\n" + ."\n" + .'- By default, the system uses the current time as the value of this parameter if the time that you specify is invalid.'."\n" + ."\n" + .'- If both the values of the StartDate and EndDate parameters are invalid, the system automatically queries the change logs that are generated within the last 30 days.', 'type' => 'string', 'required' => false, 'example' => '2020-06-01 00:00:00', 'title' => ''], + ], + [ + 'name' => 'EndDate', + 'in' => 'formData', + 'schema' => ['description' => 'The end of the time range to query. Specify the time in the yyyy-MM-dd HH:mm:ss format.'."\n" + ."\n" + .'- By default, the system uses the current time as the value of this parameter if the time that you specify is invalid.'."\n" + ."\n" + .'- If both the values of the StartDate and EndDate parameters are invalid, the system automatically queries the change logs that are generated within the last 30 days.', 'type' => 'string', 'required' => false, 'example' => '2020-06-02 00:00:00', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0bc1ec92159376****', - ], - 'Success' => [ - 'title' => '成功标识', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The connection does not exist.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0bc1ec92159376', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], + 'Data' => [ + 'description' => 'The business data.', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of metatables.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'DataEntityList' => [ + 'description' => 'The list of instances.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ObjectType' => ['description' => 'The entity on which the change was made. Valid values: TABLE and PARTITION.', 'type' => 'string', 'example' => 'TABLE', 'title' => ''], + 'ModifiedTime' => ['description' => 'The time when the metatable was modified.', 'type' => 'integer', 'format' => 'int64', 'example' => '1590722845000', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the metatable was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1590722845000', 'title' => ''], + 'ChangeContent' => ['description' => 'The content of the change.', 'type' => 'string', 'example' => '"[{\\"action\\":\\"ADD_COLUMN\\",\\"value\\":[{\\"originName\\":\\"\\",\\"originType\\":\\"\\",\\"originComment\\":\\"\\",\\"name\\":\\"id\\",\\"type\\":\\"struct\\",\\"comment\\":\\"\\"}]}]",', 'title' => ''], + 'Operator' => ['description' => 'The name of the operator.', 'type' => 'string', 'example' => 'abc', 'title' => ''], + 'ChangeType' => ['description' => 'The type of the change.', 'type' => 'string', 'example' => 'CREATE_TABLE', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0bc1ec92159376****\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 0bc1ec92159376****\\n true\\n","errorExample":""}]', - 'title' => 'UpdateWorkbenchEventResult', - ], - 'ListShiftPersonnels' => [ - 'summary' => 'Queries a list of on-duty engineers in a shift schedule.', - 'methods' => [ - 'get', - 'post', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter.Meta.CommonError', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The request parameter is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.Illegal', 'errorMessage' => 'The app guid parameter is invalid.', 'description' => 'The app guid parameter is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.IllegalDate', 'errorMessage' => 'The date format is invalid.', 'description' => 'The date format is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.IllegalPageError', 'errorMessage' => 'The parameter for paging is invalid.', 'description' => 'The parameter for paging is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.NotExist', 'errorMessage' => 'The object does not exist.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'Forbidden.Meta.NoTenant', 'errorMessage' => 'The user is not the owner of any tenants.', 'description' => 'The user is not the owner of any tenants.'], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.Meta.NoCalcEngine', 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.', 'description' => ''], + ['errorCode' => 'InternalError.Meta.TenantTimeOut', 'errorMessage' => 'Failed to connect to the interface network.', 'description' => 'Failed to connect to the interface network.'], + ['errorCode' => 'InternalError.Meta.Unknown', 'errorMessage' => 'An unknown error occurred while processing your request.', 'description' => 'An unknown error occurred while processing your request.'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 10,\\n \\"PageSize\\": 1,\\n \\"TotalCount\\": 10,\\n \\"DataEntityList\\": [\\n {\\n \\"ObjectType\\": \\"TABLE\\",\\n \\"ModifiedTime\\": 1590722845000,\\n \\"CreateTime\\": 1590722845000,\\n \\"ChangeContent\\": \\"\\\\\\"[{\\\\\\\\\\\\\\"action\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ADD_COLUMN\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"originName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"originType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"originComment\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"id\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"struct\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"comment\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\"}]}]\\\\\\",\\",\\n \\"Operator\\": \\"abc\\",\\n \\"ChangeType\\": \\"CREATE_TABLE\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'GetMetaTableChangeLog', + 'summary' => 'Queries the change logs of a metatable.', + 'description' => '> This API operation is not recommended. A new API operation that provides the same capability will be released soon.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' GetMetaTableChangeLog接口的使用示例Demo请参见[DataWorks OpenAPI示例](https://developer.aliyun.com/article/780879?groupCode=dataworks)。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMetaTableChangeLog'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetMetaTableColumn' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -37829,299 +18546,349 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '140337', - 'abilityTreeNodes' => [ - 'FEATUREdideRJGWWC', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '78263', + 'abilityTreeNodes' => ['FEATUREdideE9XYA6'], ], 'parameters' => [ [ - 'name' => 'ShiftScheduleIdentifier', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The unique identifier of the shift schedule.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '2ab6456ada634b2f938ee******9b45b', - ], + 'name' => 'TableGuid', + 'in' => 'query', + 'schema' => ['description' => 'The GUID of the metatable. You can call the [GetMetaDBTableList](~~2780086~~) operation to query the GUID.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'odps.engine_name.table_name', 'title' => ''], ], [ - 'name' => 'UserType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The type of the on-duty engineer that you want to query. Valid values: ALL, PRIMARY, BACKUP, and DESIGNATED_USER.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'ALL', - 'default' => 'ALL', - 'enum' => [ - 'ALL', - 'PRIMARY', - 'BACKUP', - 'DESIGNATED_USER', - ], - ], + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'ShiftPersonUID', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the Alibaba Cloud account. You can log on to the DataWorks console and move the pointer over the profile picture in the upper-right corner to view the ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1933790****551', - ], + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'BeginTime', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The time when the on-duty engineer starts a shift. Set the value to a UNIX timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1593950832000', - ], + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the E-MapReduce (EMR) cluster. You can log on to the EMR console to obtain the ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'C-010A704DA760****', 'title' => ''], ], [ - 'name' => 'EndTime', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The time when the on-duty engineer ends a shift. Set the value to a UNIX timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1593950832000', - ], + 'name' => 'DatabaseName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the metadatabase of the EMR cluster. You can call the [ListMetaDB](~~2780105~~) operation to query the name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the metatable in the EMR cluster. You can call the [GetMetaDBTableList](~~2780086~~) operation to query the name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''], + ], + [ + 'name' => 'DataSourceType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the data source. Set the value to emr.'."\n", 'type' => 'string', 'required' => false, 'example' => 'emr', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID. You can use the ID to troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG', - ], - 'Paging' => [ - 'description' => 'The pagination information.'."\n", + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The connection does not exist.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", 'type' => 'string', 'example' => '0bc1ec92159376', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], + 'Data' => [ + 'description' => 'The business data.'."\n", 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number. Valid values: 1 to 100. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'ShiftPersons' => [ - 'description' => 'The on-duty engineers in the shift schedule.'."\n", + 'PageNum' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of fields.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'ColumnList' => [ + 'description' => 'The information about fields.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'The on-duty engineer in the shift schedule.'."\n", + 'description' => '', 'type' => 'object', 'properties' => [ - 'ShiftPersonUID' => [ - 'description' => 'The UID of the on-duty engineer.'."\n", - 'type' => 'string', - 'example' => '3726346****', - ], - 'ShiftPersonName' => [ - 'description' => 'The name of the on-duty engineer.'."\n", - 'type' => 'string', - 'example' => 'Zhang San', - ], - 'BeginTime' => [ - 'description' => 'The time when the on-duty engineer starts the shift.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1593950832000', - ], - 'EndTime' => [ - 'description' => 'The time when the on-duty engineer ends the shift.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1593950832000', - ], + 'ColumnGuid' => ['description' => 'The GUID of the field.'."\n", 'type' => 'string', 'example' => 'odps.engine_name.table_name.name', 'title' => ''], + 'ColumnName' => ['description' => 'The name of the field.'."\n", 'type' => 'string', 'example' => 'name', 'title' => ''], + 'IsPartitionColumn' => ['description' => 'Indicates whether the field is a partition field. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Comment' => ['description' => 'The remarks of the field.'."\n", 'type' => 'string', 'example' => 'comment ', 'title' => ''], + 'ColumnType' => ['description' => 'The data type of the field.'."\n", 'type' => 'string', 'example' => 'string', 'title' => ''], + 'IsPrimaryKey' => ['description' => 'Indicates whether the field is a primary key. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Position' => ['description' => 'The sequence number of the field.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Caption' => ['description' => 'The description of the field.'."\n", 'type' => 'string', 'example' => 'data column', 'title' => ''], + 'IsForeignKey' => ['description' => 'Indicates whether the field is a foreign key. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RelationCount' => ['description' => 'The number of times the field is read.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG\\",\\n \\"Paging\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"ShiftPersons\\": [\\n {\\n \\"ShiftPersonUID\\": \\"3726346****\\",\\n \\"ShiftPersonName\\": \\"Zhang San\\",\\n \\"BeginTime\\": 1593950832000,\\n \\"EndTime\\": 1593950832000\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 0000-ABCD-EFG\\n \\n 1\\n 10\\n 100\\n \\n 3726346****\\n 张三\\n 1593950832000\\n 1593950832000\\n \\n \\n","errorExample":""}]', - 'title' => 'ListShiftPersonnels', - ], - 'ListShiftSchedules' => [ - 'summary' => 'Queries a list of shift schedules in Operation Center.', - 'methods' => [ - 'get', - 'post', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter.Meta.CommonError', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The request parameter is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.GuidFormat', 'errorMessage' => 'The GUID format is invalid.', 'description' => 'The GUID format is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.Illegal', 'errorMessage' => 'The app guid parameter is invalid.', 'description' => 'The app guid parameter is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.IllegalDate', 'errorMessage' => 'The date format is invalid.', 'description' => 'The date format is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.IllegalPageError', 'errorMessage' => 'The parameter for paging is invalid.', 'description' => 'The parameter for paging is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.NotExist', 'errorMessage' => 'The object does not exist.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.Meta.NoCalcEngine', 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.', 'description' => 'Incorrect project entered by user'], + ], + 403 => [ + ['errorCode' => 'Forbidden.Meta.NoTenant', 'errorMessage' => 'The user is not the owner of any tenants.', 'description' => 'The user is not the owner of any tenants.'], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.Meta.TenantTimeOut', 'errorMessage' => 'Failed to connect to the interface network.', 'description' => 'Failed to connect to the interface network.'], + ['errorCode' => 'InternalError.Meta.Unknown', 'errorMessage' => 'An unknown error occurred while processing your request.', 'description' => 'An unknown error occurred while processing your request.'], + ], + ], + 'title' => 'GetMetaTableColumn', + 'summary' => 'Queries the field information of a metatable.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' GetMetaTableColumn接口的使用示例Demo请参见[DataWorks OpenAPI示例](https://developer.aliyun.com/article/780879?groupCode=dataworks)。', + 'changeSet' => [ + ['createdAt' => '2021-12-06T06:24:36.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-12-06T06:24:36.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Data\\": {\\n \\"PageNum\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"ColumnList\\": [\\n {\\n \\"ColumnGuid\\": \\"odps.engine_name.table_name.name\\",\\n \\"ColumnName\\": \\"name\\",\\n \\"IsPartitionColumn\\": false,\\n \\"Comment\\": \\"comment \\",\\n \\"ColumnType\\": \\"string\\",\\n \\"IsPrimaryKey\\": false,\\n \\"Position\\": 1,\\n \\"Caption\\": \\"data column\\",\\n \\"IsForeignKey\\": true,\\n \\"RelationCount\\": 2\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'GetMetaTableFullInfo' => [ + 'summary' => 'Retrieves complete metadata for a table, including field details.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'deprecated' => false, + 'deprecated' => true, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '140315', - 'abilityTreeNodes' => [ - 'FEATUREdideRJGWWC', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '78264', + 'abilityTreeNodes' => ['FEATUREdideRZEBFC'], ], 'parameters' => [ [ - 'name' => 'ShiftScheduleName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The keyword used to perform a fuzzy search on shift schedules.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Duty table name keyword', - ], + 'name' => 'TableGuid', + 'in' => 'query', + 'schema' => ['description' => 'The unique identifier of the table. You can call the [GetMetaDBTableList](~~173916~~) operation to query the unique identifier of the table.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'odps.engine_name.table_name', 'title' => ''], ], [ - 'name' => 'Owner', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The Alibaba Cloud account ID. You can log on to the DataWorks console and move the pointer over the profile picture in the upper-right corner to view the ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1933790683****', - ], + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => ['description' => 'The page number requested for pagination.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '10', - 'example' => '10', - 'default' => '10', - ], + 'in' => 'query', + 'schema' => ['description' => 'The number of items per page, with a default of 10 and a maximum of 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The page number. Minimum value:1. Maximum value: 100. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the EMR cluster. This parameter is required only if you set the DataSourceType parameter to emr.'."\n" + ."\n" + .'You can log on to the [EMR console](https://emr.console.aliyun.com/?spm=a2c4g.11186623.0.0.965cc5c2GeiHet#/cn-hangzhou) to query the ID.', 'type' => 'string', 'required' => false, 'example' => 'C-010A704DA760****', 'title' => ''], + ], + [ + 'name' => 'DatabaseName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the database. This parameter is required only if you set the DataSourceType parameter to emr.'."\n" + ."\n" + .'You can call the [ListMetaDB](~~185662~~) operation to query the database name.', 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the table in the EMR cluster. This parameter is required only if you set the DataSourceType parameter to emr.'."\n" + ."\n" + .'You can call the [GetMetaDBTableList](~~173916~~) operation to query the table name.', 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''], + ], + [ + 'name' => 'DataSourceType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the data source. Set the value to emr.', 'type' => 'string', 'required' => false, 'example' => 'emr', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'E6F0DBDD-5AD****', - ], - 'Paging' => [ - 'description' => 'The pagination information.'."\n", - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number. Minimum value: 1. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'ShiftSchedules' => [ - 'description' => 'The shift schedules.'."\n", + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified parameters are invalid.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0bc1411515937****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '1031203110005', 'title' => ''], + 'Data' => [ + 'description' => 'The business data.', + 'type' => 'object', + 'properties' => [ + 'TableName' => ['description' => 'The name of the table.', 'type' => 'string', 'example' => 'table_name', 'title' => ''], + 'Comment' => ['description' => 'The comment on the table.', 'type' => 'string', 'example' => 'comment', 'title' => ''], + 'LifeCycle' => ['description' => 'The lifecycle of the table. Unit: days.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the table was created. A timestamp is returned for this parameter. You can convert the timestamp to the related date based on the time zone that you use.', 'type' => 'integer', 'format' => 'int64', 'example' => '1589870293000', 'title' => ''], + 'ProjectName' => ['description' => 'The name of the workspace to which the table belongs.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'ProjectId' => ['description' => 'The ID of the workspace to which the table belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '22', 'title' => ''], + 'OwnerId' => ['description' => 'The ID of the table owner.', 'type' => 'string', 'example' => '123', 'title' => ''], + 'EnvType' => ['description' => 'The type of the environment. Valid values:'."\n" + ."\n" + .'- 0: indicates that the table resides in the development environment.'."\n" + ."\n" + .'- 1: indicates that the table resides in the production environment.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'LastAccessTime' => ['description' => 'The time when the table was last accessed. A timestamp is returned for this parameter. You can convert the timestamp to the related date based on the time zone that you use.', 'type' => 'integer', 'format' => 'int64', 'example' => '1589870294000', 'title' => ''], + 'DataSize' => ['description' => 'The size of the storage space that is consumed by the table. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'LastModifyTime' => ['description' => 'The time when the table was last updated. A timestamp is returned for this parameter. You can convert the timestamp to the related date based on the time zone that you use.', 'type' => 'integer', 'format' => 'int64', 'example' => '1589870294000', 'title' => ''], + 'DatabaseName' => ['description' => 'The name of the database.', 'type' => 'string', 'example' => 'abc', 'title' => ''], + 'IsVisible' => ['description' => 'The scope in which the table is visible. Valid values:'."\n" + ."\n" + .'- 0: indicates that the table is visible to workspace members.'."\n" + ."\n" + .'- 1: indicates that the table is visible to users within a tenant.'."\n" + ."\n" + .'- 2: indicates that the table is visible to all tenants.'."\n" + ."\n" + .'- 3: indicates that the table is visible only to the table owner.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'TotalColumnCount' => ['description' => 'The total number of fields.', 'type' => 'integer', 'format' => 'int64', 'example' => '22', 'title' => ''], + 'TableGuid' => ['description' => 'The unique identifier of the table.', 'type' => 'string', 'example' => 'odps.engine_name.table_name', 'title' => ''], + 'PartitionKeys' => ['description' => 'The partition key column.', 'type' => 'string', 'example' => 'abc', 'title' => ''], + 'LastDdlTime' => ['description' => 'The time when the schema of the table was last changed. A timestamp is returned for this parameter. You can convert the timestamp to the related date based on the time zone that you use.', 'type' => 'integer', 'format' => 'int64', 'example' => '1589870294000', 'title' => ''], + 'Location' => ['description' => 'The storage path of the Hive table.', 'type' => 'string', 'example' => 'hdfs://localhost:777/user/hadoop/test.txt', 'title' => ''], + 'ClusterId' => ['description' => 'The EMR cluster ID.', 'type' => 'string', 'example' => 'C-010A704DA760****', 'title' => ''], + 'TenantId' => ['description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '12345', 'title' => ''], + 'Schema' => ['description' => 'The schema information of the table.', 'type' => 'string', 'example' => 'default', 'title' => ''], + 'ColumnList' => [ + 'description' => 'The fields in the table.', 'type' => 'array', 'items' => [ - 'description' => 'The shift schedule.'."\n", + 'description' => 'The field in the table.', 'type' => 'object', 'properties' => [ - 'ShiftScheduleIdentifier' => [ - 'description' => 'The unique identifier of the shift schedule. You can use the identifier to query the on-duty engineers in the shift schedule.'."\n", - 'type' => 'string', - 'example' => '2ab6456ada634b2f938ee******9b45b', - ], - 'ShiftScheduleName' => [ - 'description' => 'The name of the shift schedule.'."\n", - 'type' => 'string', - 'example' => 'Duty table name', - ], + 'ColumnName' => ['description' => 'The name of the field.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'ColumnGuid' => ['description' => 'The unique identifier of the field.', 'type' => 'string', 'example' => 'odps.engine_name.table_name.1', 'title' => ''], + 'IsPartitionColumn' => ['description' => 'Indicates whether the field is a partition field. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Comment' => ['description' => 'The remarks of the field.', 'type' => 'string', 'example' => 'comment', 'title' => ''], + 'ColumnType' => ['description' => 'The data type of the field.', 'type' => 'string', 'example' => 'string', 'title' => ''], + 'IsPrimaryKey' => ['description' => 'Indicates whether the field is a primary key. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Position' => ['description' => 'The sequence number of the field.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Caption' => ['description' => 'The description of the field.', 'type' => 'string', 'example' => 'data comment', 'title' => ''], + 'IsForeignKey' => ['description' => 'Indicates whether the field is a foreign key. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"Paging\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"ShiftSchedules\\": [\\n {\\n \\"ShiftScheduleIdentifier\\": \\"2ab6456ada634b2f938ee******9b45b\\",\\n \\"ShiftScheduleName\\": \\"Duty table name\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n E6F0DBDD-5AD****\\n \\n 1\\n 10\\n 100\\n \\n 2ab6456ada634b2f938ee******9b45b\\n 值班表名称\\n \\n \\n","errorExample":""}]', - 'title' => 'ListShiftSchedules', - ], - 'ListInstanceHistory' => [ - 'summary' => 'Queries information about the historical records of all instances. One historical record is generated if an instance is rerun once.', - 'methods' => [ - 'post', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter.Meta.CommonError', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The request parameter is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.Illegal', 'errorMessage' => 'The app guid parameter is invalid.', 'description' => 'The app guid parameter is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.IllegalDate', 'errorMessage' => 'The date format is invalid.', 'description' => 'The date format is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.IllegalPageError', 'errorMessage' => 'The parameter for paging is invalid.', 'description' => 'The parameter for paging is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.NotExist', 'errorMessage' => 'The object does not exist.', 'description' => ''], + ['errorCode' => 'InternalError.Meta.NoCalcEngine', 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.', 'description' => 'Incorrect project entered by user'], + ], + 403 => [ + ['errorCode' => 'Forbidden.Meta.NoTenant', 'errorMessage' => 'The user is not the owner of any tenants.', 'description' => 'The user is not the owner of any tenants.'], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.Meta.TenantTimeOut', 'errorMessage' => 'Failed to connect to the interface network.', 'description' => 'Failed to connect to the interface network.'], + ['errorCode' => 'InternalError.Meta.Unknown', 'errorMessage' => 'An unknown error occurred while processing your request.', 'description' => 'An unknown error occurred while processing your request.'], + ], + ], + 'staticInfo' => ['noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。'], + 'title' => 'GetMetaTableFullInfo', + 'description' => 'You can call this operation to query only the information about a table of the E-MapReduce (EMR) compute engine type.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' GetMetaTableFullInfo接口的使用示例Demo请参见[DataWorks OpenAPI示例](https://developer.aliyun.com/article/780879?groupCode=dataworks)。', + 'changeSet' => [ + ['createdAt' => '2024-01-19T11:59:05.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-07-19T06:35:48.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"RequestId\\": \\"0bc1411515937****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Data\\": {\\n \\"TableName\\": \\"table_name\\",\\n \\"Comment\\": \\"comment\\",\\n \\"LifeCycle\\": 5,\\n \\"CreateTime\\": 1589870293000,\\n \\"ProjectName\\": \\"test\\",\\n \\"ProjectId\\": 22,\\n \\"OwnerId\\": \\"123\\",\\n \\"EnvType\\": 1,\\n \\"LastAccessTime\\": 1589870294000,\\n \\"DataSize\\": 10,\\n \\"LastModifyTime\\": 1589870294000,\\n \\"DatabaseName\\": \\"abc\\",\\n \\"IsVisible\\": 1,\\n \\"TotalColumnCount\\": 22,\\n \\"TableGuid\\": \\"odps.engine_name.table_name\\",\\n \\"PartitionKeys\\": \\"abc\\",\\n \\"LastDdlTime\\": 1589870294000,\\n \\"Location\\": \\"hdfs://localhost:777/user/hadoop/test.txt\\",\\n \\"ClusterId\\": \\"C-010A704DA760****\\",\\n \\"TenantId\\": 12345,\\n \\"Schema\\": \\"default\\",\\n \\"ColumnList\\": [\\n {\\n \\"ColumnName\\": \\"1\\",\\n \\"ColumnGuid\\": \\"odps.engine_name.table_name.1\\",\\n \\"IsPartitionColumn\\": true,\\n \\"Comment\\": \\"comment\\",\\n \\"ColumnType\\": \\"string\\",\\n \\"IsPrimaryKey\\": false,\\n \\"Position\\": 1,\\n \\"Caption\\": \\"data comment\\",\\n \\"IsForeignKey\\": true\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'GetMetaTableIntroWiki' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -38131,202 +18898,94 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '146270', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - ], + 'abilityTreeCode' => '78265', + 'abilityTreeNodes' => ['FEATUREdideE9XYA6'], ], 'parameters' => [ [ - 'name' => 'InstanceId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The instance ID. You can call the ListInstances operation to query the instance ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1234', - ], + 'name' => 'TableGuid', + 'in' => 'query', + 'schema' => ['description' => 'The GUID of the metatable.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'odps.engine_name.table_name', 'title' => ''], ], [ - 'name' => 'ProjectEnv', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The environment of the workspace. Valid values: PROD and DEV. By default, data of instances in the production environment is queried.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'PROD', - 'default' => 'PROD', - ], + 'name' => 'WikiVersion', + 'in' => 'query', + 'schema' => ['description' => 'The version of the instructions.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'E6F0DBDD-5AD****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Instances' => [ - 'description' => 'The instances.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status of the node that generates the instance. Valid values:'."\n" - ."\n" - .'* NOT_RUN: The node is not run.'."\n" - .'* WAIT_TIME: The node is waiting for the scheduling time to arrive.'."\n" - .'* WAIT_RESOURCE: The node is waiting for resources.'."\n" - .'* RUNNING: The node is running.'."\n" - .'* CHECKING: Data quality is being checked for the node.'."\n" - .'* CHECKING_CONDITION: Branch conditions are being checked for the node.'."\n" - .'* FAILURE: The node fails to be run.'."\n" - .'* SUCCESS: The node is successfully run.'."\n", - 'type' => 'string', - 'example' => 'NOT_RUN', - ], - 'CycTime' => [ - 'description' => 'The time when the node started to be run. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1590422400000', - ], - 'BeginRunningTime' => [ - 'description' => 'The time when the instance started to be run. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1590416703313', - ], - 'FinishTime' => [ - 'description' => 'The time when the running of the node was complete. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1590416703313', - ], - 'ErrorMessage' => [ - 'description' => 'The error message. This parameter is deprecated. You can call the GetInstanceLog operation to query the error information related to the node.'."\n", - 'type' => 'string', - 'example' => 'error message', - ], - 'CreateTime' => [ - 'description' => 'The time when the instance was generated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1590416703313', - ], - 'DagId' => [ - 'description' => 'The workflow ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '33845', - ], - 'TaskType' => [ - 'description' => 'The scheduling type of the node. Valid values:'."\n" - ."\n" - .'* NORMAL(0): The node is an auto triggered node. The scheduling system regularly runs the node.'."\n" - .'* MANUAL(1): The node is a manually triggered node. The scheduling system does not regularly run the node.'."\n" - .'* PAUSE(2): The node is a frozen node. The scheduling system regularly runs the node but sets the status of the node to failed when the scheduling system starts to run the node.'."\n" - .'* SKIP(3): The node is a dry-run node. The scheduling system regularly runs the node but sets the status of the node to successful when the scheduling system starts to run the node.'."\n" - .'* SKIP_UNCHOOSE(4): The node is an unselected node in a temporary workflow. This type of node exists only in temporary workflows. The scheduling system sets the status of the node to successful when the scheduling system starts to run the node.'."\n" - .'* SKIP_CYCLE(5): The node is a node that is scheduled by the week or month and is waiting for the scheduling time to arrive. The scheduling system regularly runs the node but sets the status of the node to successful when the scheduling system starts to run the node.'."\n" - .'* CONDITION_UNCHOOSE(6): The node is not selected by its ancestor branch node and is run as a dry-run node.'."\n" - .'* REALTIME_DEPRECATED(7): The node has instances that are generated in real time but deprecated. The scheduling system sets the status of the node to successful.'."\n", - 'type' => 'string', - 'example' => 'NORMAL(0)', - ], - 'DagType' => [ - 'description' => 'Indicates whether the instance is associated with a monitoring rule in Data Quality. Valid values:'."\n" - ."\n" - .'* 0: The instance is associated with a monitoring rule in Data Quality.'."\n" - .'* 1: The instance is not associated with a monitoring rule in Data Quality.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'ModifyTime' => [ - 'description' => 'The time when the node was last modified.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1590416703313', - ], - 'InstanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'BeginWaitResTime' => [ - 'description' => 'The time when the instance started to wait for resources.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1590416703313', - ], - 'Bizdate' => [ - 'description' => 'The data timestamp of the instance. In most cases, the value is one day before the time when the instance was run.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1590336000000', - ], - 'NodeName' => [ - 'description' => 'The name of the node.'."\n", - 'type' => 'string', - 'example' => 'kzh', - ], - 'BeginWaitTimeTime' => [ - 'description' => 'The time when the instance started to wait to be scheduled.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1590416703313', - ], - 'NodeId' => [ - 'description' => 'The node ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '33115', - ], - 'InstanceHistoryId' => [ - 'description' => 'The historical record number of the instance.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - ], - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The connection does not exist.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0bc1ec92159376', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], + 'Data' => [ + 'description' => 'The business data.', + 'type' => 'object', + 'properties' => [ + 'ModifiedTime' => ['description' => 'The time when the metatable was last modified.', 'type' => 'integer', 'format' => 'int64', 'example' => '1584444247000', 'title' => ''], + 'Version' => ['description' => 'The version number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the metatable was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1584444247000', 'title' => ''], + 'CreatorName' => ['description' => 'The name of the user who creates the metatable.', 'type' => 'string', 'example' => 'abc', 'title' => ''], + 'Content' => ['description' => 'The description of the metatable.', 'type' => 'string', 'example' => '# Business requirements\\n\\n<a name="xiw5n"', 'title' => ''], + 'Creator' => ['description' => 'The creator of the metatable.', 'type' => 'string', 'example' => 'abc', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"Success\\": true,\\n \\"Instances\\": [\\n {\\n \\"Status\\": \\"NOT_RUN\\",\\n \\"CycTime\\": 1590422400000,\\n \\"BeginRunningTime\\": 1590416703313,\\n \\"FinishTime\\": 1590416703313,\\n \\"ErrorMessage\\": \\"error message\\",\\n \\"CreateTime\\": 1590416703313,\\n \\"DagId\\": 33845,\\n \\"TaskType\\": \\"NORMAL(0)\\",\\n \\"DagType\\": \\"1\\",\\n \\"ModifyTime\\": 1590416703313,\\n \\"InstanceId\\": 1234,\\n \\"BeginWaitResTime\\": 1590416703313,\\n \\"Bizdate\\": 1590336000000,\\n \\"NodeName\\": \\"kzh\\",\\n \\"BeginWaitTimeTime\\": 1590416703313,\\n \\"NodeId\\": 33115,\\n \\"InstanceHistoryId\\": 1\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n E6F0DBDD-5AD****\\n true\\n \\n NOT_RUN\\n 1590422400000\\n 1590416703313\\n 1590416703313\\n error message\\n 1590416703313\\n 33845\\n NORMAL(0)\\n 1\\n 1590416703313\\n 1234\\n 1590416703313\\n 1590336000000\\n kzh\\n 1590416703313\\n 33115\\n 1\\n \\n","errorExample":""}]', - 'title' => 'ListInstanceHistory', - ], - 'ListInnerNodes' => [ - 'summary' => 'Queries information about inner nodes. For example, you can call this operation to query the inner nodes of a node group or a do-while node. You cannot call this operation to query the inner nodes of a PAI node.', - 'methods' => [ - 'get', - 'post', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter.Meta.CommonError', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The request parameter is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.Illegal', 'errorMessage' => 'The app guid parameter is invalid.', 'description' => 'The app guid parameter is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.IllegalDate', 'errorMessage' => 'The date format is invalid.', 'description' => 'The date format is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.IllegalPageError', 'errorMessage' => 'The parameter for paging is invalid.', 'description' => 'The parameter for paging is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.NotExist', 'errorMessage' => 'The object does not exist.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'Forbidden.Meta.NoTenant', 'errorMessage' => 'The user is not the owner of any tenants.', 'description' => 'The user is not the owner of any tenants.'], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.Meta.NoCalcEngine', 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.', 'description' => ''], + ['errorCode' => 'InternalError.Meta.TenantTimeOut', 'errorMessage' => 'Failed to connect to the interface network.', 'description' => 'Failed to connect to the interface network.'], + ['errorCode' => 'InternalError.Meta.Unknown', 'errorMessage' => 'An unknown error occurred while processing your request.', 'description' => 'An unknown error occurred while processing your request.'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Data\\": {\\n \\"ModifiedTime\\": 1584444247000,\\n \\"Version\\": 1,\\n \\"CreateTime\\": 1584444247000,\\n \\"CreatorName\\": \\"abc\\",\\n \\"Content\\": \\"# Business requirements\\\\\\\\n\\\\\\\\n<a name="xiw5n"\\",\\n \\"Creator\\": \\"abc\\"\\n }\\n}","type":"json"}]', + 'title' => 'GetMetaTableIntroWiki', + 'summary' => 'Queries the instructions on how to use a table.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' GetMetaTableIntroWiki接口的使用示例Demo请参见[DataWorks OpenAPI示例](https://developer.aliyun.com/article/780879?groupCode=dataworks)。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'translator' => 'manual', + ], + 'GetMetaTableLineage' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -38335,340 +18994,257 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '146118', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '78266', + 'abilityTreeNodes' => ['FEATUREdideSYOMAV'], ], 'parameters' => [ [ - 'name' => 'ProgramType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The type of the node to which the inner nodes belong.'."\n" - ."\n" - .'Valid values: 6 (Shell), 10 (ODPS SQL), 11 (ODPS MR), 23 (Data Integration), 24 (ODPS Script), 97 (PAI), 98 (node group), 99 (zero load), 221 (PyODPS 2), 225 (ODPS Spark), 227 (EMR Hive), 228 (EMR Spark), 229 (EMR Spark SQL), 230 (EMR MR), 239 (OSS object inspection), 257 (EMR Shell), 258 (EMR Spark Shell), 259 (EMR Presto), 260 (EMR Impala), 900 (real-time synchronization), 1002 (PAI inner node), 1089 (cross-tenant collaboration), 1091 (Hologres development), 1093 (Hologres SQL), 1100 (assignment), 1106 (for-each), and 1221 (PyODPS 3). You can call the ListNodes operation to query the type of the node.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ODPS_SQL', - ], + 'name' => 'TableGuid', + 'in' => 'query', + 'schema' => ['description' => 'The unique identifier of the table.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'odps.engine_name.table_name', 'title' => ''], ], [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The page number. Valid values: 1 to 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'name' => 'Direction', + 'in' => 'query', + 'schema' => ['description' => 'Specifies the ancestor or descendant lineage that you want to query for a field. Valid values: up and down. The value up indicates the ancestor lineage. The value down indicates the descendant lineage.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'up', 'title' => ''], + ], + [ + 'name' => 'NextPrimaryKey', + 'in' => 'query', + 'schema' => ['description' => 'The logic of paging. Configure this parameter based on the value of the response parameter NextPrimaryKey when the value of the response parameter HasNext is true in the previous request.'."\n", 'type' => 'string', 'required' => false, 'example' => 'next_primary_key', 'title' => ''], ], [ 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '10', - 'example' => '10', - 'default' => '10', - ], + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1234', - ], + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the E-MapReduce (EMR) cluster. Configure this parameter only if you want to query the lineage of an EMR table.'."\n", 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''], ], [ - 'name' => 'ProjectEnv', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The environment in which the node is run. Valid values: DEV and PROD. Default value: PROD.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'PROD', - 'default' => 'PROD', - ], + 'name' => 'DatabaseName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''], ], [ - 'name' => 'NodeName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the node to which the inner nodes belong.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'liux_test_n****', - ], + 'name' => 'TableName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the table.'."\n", 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''], ], [ - 'name' => 'OuterNodeId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the node group to which the inner nodes belong.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1234', - ], + 'name' => 'DataSourceType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the data source. Valid values: odps and emr.'."\n", 'type' => 'string', 'required' => false, 'example' => 'emr', 'title' => ''], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ - 'title' => 'Schema of Response', 'description' => 'The returned result.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'E6F0DBDD-5AD****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Paging' => [ - 'description' => 'The pagination information.'."\n", - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of inner nodes returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'Nodes' => [ - 'description' => 'The list of inner nodes.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The inner node.'."\n", - 'type' => 'object', - 'properties' => [ - 'SchedulerType' => [ - 'description' => 'The scheduling type of the inner node. Valid values:'."\n" - ."\n" - .'* NORMAL: The inner node is an auto triggered node.'."\n" - .'* MANUAL: The inner node is a manually triggered node. The scheduling system does not run the node on a regular basis.'."\n" - .'* PAUSE: The inner node is a paused node.'."\n" - .'* SKIP: The inner node is a dry-run node. Dry-run nodes are started as scheduled, but the scheduling system sets the status of the nodes to successful when it starts to run them.'."\n", - 'type' => 'string', - 'example' => 'NORMAL', - ], - 'RepeatInterval' => [ - 'description' => 'The interval at which the inner node is rerun after the inner node fails to run.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '60', - ], - 'Repeatability' => [ - 'description' => 'Indicates whether the inner node can be rerun.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ProjectId' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'ProgramType' => [ - 'description' => 'The type of the inner node.'."\n", - 'type' => 'string', - 'example' => 'ODPS_SQL', - ], - 'Priority' => [ - 'description' => 'The priority of the inner node. Valid values: 1, 3, 5, 7, and 8.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'OwnerId' => [ - 'description' => 'The owner ID.'."\n", - 'type' => 'string', - 'example' => '1933****36551', - ], - 'Connection' => [ - 'description' => 'The connection string.'."\n", - 'type' => 'string', - 'example' => 'odps_first', - ], - 'ParamValues' => [ - 'description' => 'The additional parameters.'."\n", - 'type' => 'string', - 'example' => 'a=b', - ], - 'DqcType' => [ - 'description' => 'Indicates whether the inner node is associated with a monitoring rule in Data Quality. Valid values: 0 and 1. The value 0 indicates that the inner node is associated with a monitoring rule in Data Quality. The value 1 indicates that the inner node is not associated with a monitoring rule in Data Quality.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'BaselineId' => [ - 'description' => 'The baseline ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'Description' => [ - 'description' => 'The description of the inner node.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'NodeName' => [ - 'description' => 'The name of the inner node.'."\n", - 'type' => 'string', - 'example' => 'liux_test_n****', - ], - 'ResGroupName' => [ - 'description' => 'The name of the resource group.'."\n", - 'type' => 'string', - 'example' => 'Default Resource Group', - ], - 'BusinessId' => [ - 'description' => 'The workflow ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'DqcDescription' => [ - 'description' => 'The table and partition filter expression in Data Quality that are associated with the inner node.'."\n", - 'type' => 'string', - 'example' => '[{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\\u003d$[yyyy-mm-dd-1]"}]', - ], - 'CronExpress' => [ - 'description' => 'The CRON expression.'."\n", - 'type' => 'string', - 'example' => '00 00 00 * * ?', - ], - 'NodeId' => [ - 'description' => 'The inner node ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The connection does not exist.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0bc1ec92159376', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], + 'Data' => [ + 'description' => 'The business data.'."\n", + 'type' => 'object', + 'properties' => [ + 'NextPrimaryKey' => ['description' => 'The logic of paging. If the value true is returned for the HasNext parameter and a value is returned for the NextPrimaryKey parameter in the response of the previous request, you must use the value of the NextPrimaryKey parameter for the next request.'."\n", 'type' => 'string', 'example' => 'odps.tt.2', 'title' => ''], + 'HasNext' => ['description' => 'Indicates whether the next page exists.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'DataEntityList' => [ + 'description' => 'The information about the table.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TableName' => ['description' => 'The name of the table.'."\n", 'type' => 'string', 'example' => 'name', 'title' => ''], + 'TableGuid' => ['description' => 'The unique identifier of the table.'."\n", 'type' => 'string', 'example' => 'odps.tt.name', 'title' => ''], + 'CreateTimestamp' => ['description' => 'The time when the table was created.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1638720736000', 'title' => ''], + 'DatabaseName' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'example' => 'db1', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"Success\\": true,\\n \\"Paging\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Nodes\\": [\\n {\\n \\"SchedulerType\\": \\"NORMAL\\",\\n \\"RepeatInterval\\": 60,\\n \\"Repeatability\\": true,\\n \\"ProjectId\\": 123,\\n \\"ProgramType\\": \\"ODPS_SQL\\",\\n \\"Priority\\": 1,\\n \\"OwnerId\\": \\"1933****36551\\",\\n \\"Connection\\": \\"odps_source\\",\\n \\"ParamValues\\": \\"a=b\\",\\n \\"DqcType\\": \\"1\\",\\n \\"BaselineId\\": 1234,\\n \\"Description\\": \\"test\\",\\n \\"NodeName\\": \\"liux_test_n****\\",\\n \\"ResGroupName\\": \\"Default Resource Group\\",\\n \\"BusinessId\\": 123,\\n \\"DqcDescription\\": \\"[{\\\\\\"projectName\\\\\\":\\\\\\"ztjy_dim\\\\\\",\\\\\\"tableName\\\\\\":\\\\\\"dim_user_agent_manage_area_a\\\\\\",\\\\\\"partition\\\\\\":\\\\\\"ds\\\\\\\\u003d$[yyyy-mm-dd-1]\\\\\\"}]\\",\\n \\"CronExpress\\": \\"00 00 00 * * ?\\",\\n \\"NodeId\\": 12\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n E6F0DBDD-5AD****\\n true\\n \\n 1\\n 10\\n 100\\n \\n NORMAL\\n 60\\n true\\n 123\\n ODPS_SQL\\n 1\\n 19337906836551\\n odps_source\\n a=b\\n 1\\n 1234\\n test\\n liux_test_n****\\n 默认资源组\\n 123\\n [{\\"projectName\\":\\"ztjy_dim\\",\\"tableName\\":\\"dim_user_agent_manage_area_a\\",\\"partition\\":\\"ds\\\\u003d$[yyyy-mm-dd-1]\\"}]\\n 00 00 00 * * ?\\n 12\\n \\n \\n","errorExample":""}]', - 'title' => 'ListInnerNodes', - ], - 'OfflineNode' => [ - 'summary' => 'Undeploys a node.', - 'methods' => [ - 'post', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Invalid.Meta.TableNotExist', 'errorMessage' => 'The table does not exist.', 'description' => 'The table does not exist.'], + ['errorCode' => 'InvalidParameter.Meta.CommonError', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The request parameter is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.GuidFormat', 'errorMessage' => 'The GUID format is invalid.', 'description' => 'The GUID format is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.Illegal', 'errorMessage' => 'The app guid parameter is invalid.', 'description' => 'The app guid parameter is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.IllegalDate', 'errorMessage' => 'The date format is invalid.', 'description' => 'The date format is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.IllegalPageError', 'errorMessage' => 'The parameter for paging is invalid.', 'description' => 'The parameter for paging is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.NotExist', 'errorMessage' => 'The object does not exist.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.Meta.NoCalcEngine', 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.', 'description' => 'Incorrect project entered by user'], + ], + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Activate DataWorks first.', 'description' => ''], + ['errorCode' => 'ResourceNotAuthorized.Api', 'errorMessage' => 'You are not authorized to access the resources.', 'description' => ''], + ['errorCode' => 'Forbidden.Meta.NoTenant', 'errorMessage' => 'The user is not the owner of any tenants.', 'description' => 'The user is not the owner of any tenants.'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.Meta.TenantTimeOut', 'errorMessage' => 'Failed to connect to the interface network.', 'description' => 'Failed to connect to the interface network.'], + ['errorCode' => 'InternalError.Meta.Unknown', 'errorMessage' => 'An unknown error occurred while processing your request.', 'description' => 'An unknown error occurred while processing your request.'], + ], + ], + 'title' => 'GetMetaTableLineage', + 'summary' => 'Queries the lineage of a metatable.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => 'GetMetaTableLineage接口的使用示例Demo请参见[DataWorks OpenAPI示例](https://developer.aliyun.com/article/780879?groupCode=dataworks)。', + 'changeSet' => [ + ['createdAt' => '2023-03-02T06:42:56.000Z', 'description' => 'Response parameters changed, Response parameters changed'], + ['createdAt' => '2021-12-06T06:24:36.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-12-06T06:24:36.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Data\\": {\\n \\"NextPrimaryKey\\": \\"odps.tt.2\\",\\n \\"HasNext\\": true,\\n \\"DataEntityList\\": [\\n {\\n \\"TableName\\": \\"name\\",\\n \\"TableGuid\\": \\"odps.tt.name\\",\\n \\"CreateTimestamp\\": 1638720736000,\\n \\"DatabaseName\\": \\"db1\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n The connection does not exist.\\n 0bc1ec92159376\\n true\\n Invalid.Tenant.ConnectionNotExists\\n \\n odps | retail_e_commerce_2 | retail_e_commerce_2 | dws_ec_trd__cate_commodity_gmv_kpy_fy\\n true\\n \\n name\\n odps.tt.name\\n 1638720736000\\n \\n \\n","errorExample":""}]', + ], + 'GetMetaTableListByCategory' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', + 'abilityTreeCode' => '78267', + 'abilityTreeNodes' => ['FEATUREdideE9XYA6'], ], 'parameters' => [ [ - 'name' => 'NodeId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The node ID. You can call the [ListNodes](~~173979~~) operation to obtain the node ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'minimum' => '2', - 'example' => '1234', - ], + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The DataWorks workspace ID. You can call the [ListProjects](~~178393~~) operation to obtain the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'minimum' => '1', - 'example' => '9527', - ], + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page. Default value: 10. Maximum value: 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'CategoryId', + 'in' => 'query', + 'schema' => ['description' => 'The category ID. You can call the [GetMetaCategory](~~2780099~~) operation to obtain the ID of the category. Categories allow you to efficiently organize and manage tables by category. You can search for the desired table by category.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '1', 'example' => '23', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The returned result.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID. You can use the request ID to query logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => 'E6F0DBDD-5AD****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'string', - 'example' => 'true', + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'The connection does not exist.', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '0bc1ec92159376', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned.'."\n", 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], + 'Data' => [ + 'description' => 'The business data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page. Default value: 10. Maximum value: 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of metatables.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'TableGuidList' => [ + 'description' => 'The returned result.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The list of metatables.'."\n", 'type' => 'string', 'example' => 'odps.engine_name.table_name', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"\\n E6F0DBDD-5AD****\\n true\\n","errorExample":""}]', - 'title' => 'OfflineNode', - ], - 'GetBaseline' => [ - 'summary' => 'Queries the information about a baseline based on its ID.', - 'methods' => [ - 'post', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Invalid.Meta.CategoryIllegalDepth', 'errorMessage' => 'A category can contain a maximum of 4 levels.', 'description' => 'A category can contain a maximum of 4 levels.'], + ['errorCode' => 'Invalid.Meta.CategoryNameDuplicate', 'errorMessage' => 'The category name is duplicated at this level.', 'description' => 'The category name is duplicated at this level.'], + ['errorCode' => 'Invalid.Meta.TableNotExist', 'errorMessage' => 'The table does not exist.', 'description' => 'The table does not exist.'], + ['errorCode' => 'InvalidParameter.Meta.CommonError', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The request parameter is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.Illegal', 'errorMessage' => 'The app guid parameter is invalid.', 'description' => 'The app guid parameter is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.IllegalDate', 'errorMessage' => 'The date format is invalid.', 'description' => 'The date format is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.IllegalPageError', 'errorMessage' => 'The parameter for paging is invalid.', 'description' => 'The parameter for paging is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.NotExist', 'errorMessage' => 'The object does not exist.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'Forbidden.Meta.NoTenant', 'errorMessage' => 'The user is not the owner of any tenants.', 'description' => 'The user is not the owner of any tenants.'], + ['errorCode' => 'Invalid.Meta.CategoryForbidden', 'errorMessage' => 'Failed to delete the category. The current category is associated with a table and cannot be operated.', 'description' => 'Failed to delete the category because the table associated with the category does not exist.'], + ['errorCode' => 'Invalid.Meta.CategoryIllegalTenant', 'errorMessage' => 'The tenant ID is different in the parent and child categories.', 'description' => 'The tenant ID is different in the parent and child categories.'], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.Meta.NoCalcEngine', 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.', 'description' => ''], + ['errorCode' => 'InternalError.Meta.TenantTimeOut', 'errorMessage' => 'Failed to connect to the interface network.', 'description' => 'Failed to connect to the interface network.'], + ['errorCode' => 'InternalError.Meta.Unknown', 'errorMessage' => 'An unknown error occurred while processing your request.', 'description' => 'An unknown error occurred while processing your request.'], + ['errorCode' => 'Invalid.Meta.CategoryRelationDuplicate"', 'errorMessage' => 'The table is already bound to the category.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'GetMetaTableListByCategory', + 'summary' => 'Queries metatables in a specified category.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' GetMetaTableListByCategory接口的使用示例Demo请参见[DataWorks OpenAPI示例](https://developer.aliyun.com/article/780879?groupCode=dataworks)。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 20,\\n \\"TableGuidList\\": [\\n \\"odps.engine_name.table_name\\"\\n ]\\n }\\n}","type":"json"}]', + ], + 'GetMetaTableOutput' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -38678,1324 +19254,1080 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '158223', - 'abilityTreeNodes' => [ - 'FEATUREdideSFSFU4', - ], + 'abilityTreeCode' => '78268', + 'abilityTreeNodes' => ['FEATUREdideE9XYA6'], ], 'parameters' => [ [ - 'name' => 'BaselineId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The baseline ID. You can call the [ListBaselines](~~2261507~~) operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456', - ], + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Valid values: 1 to 30. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the workspace to which the baseline belongs. You can call the [ListBaselines](~~2261507~~) operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10000', - ], + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'TableGuid', + 'in' => 'query', + 'schema' => ['description' => 'The GUID of the metatable.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'odps.engine_name.table_name', 'title' => ''], + ], + [ + 'name' => 'StartDate', + 'in' => 'query', + 'schema' => ['description' => 'The start date.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-06-27', 'title' => ''], + ], + [ + 'name' => 'EndDate', + 'in' => 'query', + 'schema' => ['description' => 'The end date.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-05-27', 'title' => ''], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => ['description' => 'The task ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '1048576', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'OpenApiResultModel', - 'description' => 'OpenApiResultModel'."\n", 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '1031203110005', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified parameters are invalid', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The specified parameters are invalid.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0bc1ec92159376****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '1031203110005', 'title' => ''], 'Data' => [ - 'description' => 'The data returned.'."\n", + 'description' => 'The business data.'."\n", 'type' => 'object', 'properties' => [ - 'BaselineId' => [ - 'title' => '基线id', - 'description' => 'The baseline ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1001', - ], - 'BaselineName' => [ - 'title' => '基线名', - 'description' => 'The name of the baseline.'."\n", - 'type' => 'string', - 'example' => 'Test baseline', - ], - 'ProjectId' => [ - 'title' => '项目id', - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000', - ], - 'Owner' => [ - 'title' => '责任人', - 'description' => 'The owner.'."\n", - 'type' => 'string', - 'example' => '9527952****', - ], - 'Priority' => [ - 'title' => '优先级', - 'description' => 'The priority of the baseline. Valid values: 1, 3, 5, 7, and 8.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'BaselineType' => [ - 'title' => '基线类型 (DAILY, HOURLY)', - 'description' => 'The type of the baseline. Valid values:'."\n" - ."\n" - .'* DAILY'."\n" - .'* HOURLY'."\n", - 'type' => 'string', - 'example' => 'DAILY', - ], - 'OverTimeSettings' => [ - 'title' => '基线承诺时间设置', - 'description' => 'The settings of the committed completion time of the baseline.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Cycle' => [ - 'title' => '周期，取值范围 [1,24]', - 'description' => 'The period corresponding to the commitment time. The space-based line is 1, and the hourly baseline can be configured for up to 24 cycles.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Time' => [ - 'title' => '承诺时间，hh:mm格式，hh的取值范围为[0,47]，mm的取值范围为[0,59]', - 'description' => 'Commitment time, hh:mm format, hh value range is [0,47],mm value range is [0,59].', - 'type' => 'string', - 'example' => '00:00', - ], - ], - ], - ], - 'Enabled' => [ - 'title' => '是否开启基线', - 'description' => 'Indicates whether the baseline is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'NodeIds' => [ - 'title' => '基线节点列表', - 'description' => 'The node IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Node ID.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '700003****', - ], - ], - 'AlertEnabled' => [ - 'title' => '是否开启告警', - 'description' => 'Indicates whether the alerting feature is enabled. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'AlertMarginThreshold' => [ - 'title' => '预警余量，单位为分钟', - 'description' => 'The alert margin threshold. Unit: minutes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - ], - 'AlertSettings' => [ - 'title' => '告警设置', - 'description' => 'The alert settings.'."\n", + 'PageNumber' => ['description' => 'The page number. Valid values: 1 to 30. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'DataEntityList' => [ + 'description' => 'The partitions.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'Baseline alert configuration', 'type' => 'object', 'properties' => [ - 'AlertType' => [ - 'title' => '告警类型，BASELINE / TOPIC', - 'description' => 'Alert type'."\n" - ."\n" - .'- BASELINE: baseline'."\n" - .'- TOPIC: event', - 'type' => 'string', - 'example' => 'BASELINE', - ], - 'AlertMethods' => [ - 'title' => '告警方式', - 'description' => 'Alert method list', - 'type' => 'array', - 'items' => [ - 'description' => 'The alert method. The values are as follows:'."\n" - ."\n" - .'- MAIL: MAIL'."\n" - .'- SMS: SMS'."\n" - .'- PHONE: voice'."\n" - .'- DINGROBOTS: DingTalk robot'."\n" - .'- WEBHOOKS: Webhook', - 'type' => 'string', - 'example' => 'MAIL', - ], - ], - 'SilenceStartTime' => [ - 'title' => '静默开始时间', - 'description' => 'The start time of the silence. Format: HH:mm:ss', - 'type' => 'string', - 'example' => '00:00:00', - ], - 'SilenceEndTime' => [ - 'title' => '静默结束时间', - 'description' => 'The end time of the silence. The format is HH:mm:ss.', - 'type' => 'string', - 'example' => '00:00:00', - ], - 'AlertInterval' => [ - 'title' => '事件告警间隔', - 'description' => 'The event alert interval, in seconds.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '900', - ], - 'AlertMaximum' => [ - 'title' => '事件告警最大次数', - 'description' => 'The maximum number of event alerts.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'DingRobots' => [ - 'title' => '钉钉机器人列表', - 'description' => 'DingTalk robot list.', - 'type' => 'array', - 'items' => [ - 'description' => 'DingTalk robot configuration.', - 'type' => 'object', - 'properties' => [ - 'WebUrl' => [ - 'description' => 'DingTalk robot address', - 'type' => 'string', - 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=xxx', - ], - 'AtAll' => [ - 'description' => 'Whether @ everyone.', - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], - 'Webhooks' => [ - 'title' => 'webhook 列表', - 'description' => 'webhook list.', - 'type' => 'array', - 'items' => [ - 'description' => 'The webhook addresses of the Enterprise WeChat or flying book Robot. Separate multiple webhook addresses with commas (,). alertMethods must include WEBHOOKS alert methods. Only DataWorks Enterprise Edition is supported.'."\n" - ."\n" - .'Available regions: China(Shanghai), China(Chengdu), China(Zhangjiakou), China(Beijing), China(Hangzhou), China(Shenzhen), China (Hong Kong), Central Europe 1 (Frankfurt), and Southeast Asia Pacific 1 (Singapore).', - 'type' => 'string', - 'example' => 'https://open.feishu.cn/open-apis/bot/v2/hook/xxx', - ], - ], - 'TopicTypes' => [ - 'title' => '事件告警类型，事件特有配置', - 'description' => 'The list of Event Alert types.', - 'type' => 'array', - 'items' => [ - 'description' => 'The type of the event alert.'."\n" - ."\n" - .'- SLOW'."\n" - .'- ERROR', - 'type' => 'string', - 'example' => 'SLOW', - ], - ], - 'BaselineAlertEnabled' => [ - 'title' => '基线告警开关，基线特有配置', - 'description' => 'The baseline alarm switch.'."\n" - ."\n" - .'- true'."\n" - .'- false', - 'type' => 'boolean', - 'example' => 'false', - ], - 'AlertRecipientType' => [ - 'title' => '告警接收人类型', - 'description' => 'The type of alert recipient.'."\n" - ."\n" - .'- OWNER: task owner'."\n" - .'- OTHER: designated person'."\n" - .'- SHIFT: SCHEDULE-duty table', - 'type' => 'string', - 'example' => 'OWNER', - ], - 'AlertRecipient' => [ - 'title' => '告警接收人详情', - 'description' => 'Alert recipient details.'."\n" - ."\n" - .'AlertRecipientType is OWNER: empty'."\n" - .'AlertRecipientType is SHIFT_SCHEDULE: duty table uid'."\n" - .'AlertRecipientType is OTHER: uid list, multiple UIDs are in English, split', - 'type' => 'string', - 'example' => '123123', - ], + 'EndTime' => ['description' => 'The end time.'."\n", 'type' => 'string', 'example' => '2020-01-01 00:01:00', 'title' => ''], + 'TaskInstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '3521', 'title' => ''], + 'StartTime' => ['description' => 'The start time.'."\n", 'type' => 'string', 'example' => '2020-01-01 00:00:00', 'title' => ''], + 'ProjectId' => ['description' => 'The workspace ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '333', 'title' => ''], + 'WaitTime' => ['description' => 'The waiting time.'."\n", 'type' => 'string', 'example' => '323', 'title' => ''], + 'TableGuid' => ['description' => 'The GUID of the MaxCompute table.'."\n", 'type' => 'string', 'example' => 'odps.engine_name.table_name', 'title' => ''], + 'TaskId' => ['description' => 'The task ID.'."\n", 'type' => 'string', 'example' => '1048576', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ecb967ec-c137-48a5-860****', - ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter.Meta.CommonError', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The request parameter is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.Illegal', 'errorMessage' => 'The app guid parameter is invalid.', 'description' => 'The app guid parameter is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.IllegalDate', 'errorMessage' => 'The date format is invalid.', 'description' => 'The date format is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.IllegalPageError', 'errorMessage' => 'The parameter for paging is invalid.', 'description' => 'The parameter for paging is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.NotExist', 'errorMessage' => 'The object does not exist.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'Forbidden.Meta.NoTenant', 'errorMessage' => 'The user is not the owner of any tenants.', 'description' => 'The user is not the owner of any tenants.'], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.Meta.NoCalcEngine', 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.', 'description' => ''], + ['errorCode' => 'InternalError.Meta.TenantTimeOut', 'errorMessage' => 'Failed to connect to the interface network.', 'description' => 'Failed to connect to the interface network.'], + ['errorCode' => 'InternalError.Meta.Unknown', 'errorMessage' => 'An unknown error occurred while processing your request.', 'description' => 'An unknown error occurred while processing your request.'], + ], + ], + 'title' => 'GetMetaTableOutput', + 'summary' => 'Queries the output information of a metatable.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' GetMetaTableOutput接口的使用示例Demo请参见[DataWorks OpenAPI示例](https://developer.aliyun.com/article/780879?groupCode=dataworks)。', + 'changeSet' => [ + ['createdAt' => '2022-12-14T06:10:43.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"BaselineId\\": 1001,\\n \\"BaselineName\\": \\"Test baseline\\",\\n \\"ProjectId\\": 10000,\\n \\"Owner\\": \\"9527952****\\",\\n \\"Priority\\": 1,\\n \\"BaselineType\\": \\"DAILY\\",\\n \\"OverTimeSettings\\": [\\n {\\n \\"Cycle\\": 1,\\n \\"Time\\": \\"00:00\\"\\n }\\n ],\\n \\"Enabled\\": true,\\n \\"NodeIds\\": [\\n 0\\n ],\\n \\"AlertEnabled\\": true,\\n \\"AlertMarginThreshold\\": 60,\\n \\"AlertSettings\\": [\\n {\\n \\"AlertType\\": \\"BASELINE\\",\\n \\"AlertMethods\\": [\\n \\"MAIL\\"\\n ],\\n \\"SilenceStartTime\\": \\"00:00:00\\",\\n \\"SilenceEndTime\\": \\"00:00:00\\",\\n \\"AlertInterval\\": 900,\\n \\"AlertMaximum\\": 1,\\n \\"DingRobots\\": [\\n {\\n \\"WebUrl\\": \\"https://oapi.dingtalk.com/robot/send?access_token=xxx\\",\\n \\"AtAll\\": true\\n }\\n ],\\n \\"Webhooks\\": [\\n \\"https://open.feishu.cn/open-apis/bot/v2/hook/xxx\\"\\n ],\\n \\"TopicTypes\\": [\\n \\"SLOW\\"\\n ],\\n \\"BaselineAlertEnabled\\": false,\\n \\"AlertRecipientType\\": \\"OWNER\\",\\n \\"AlertRecipient\\": \\"123123\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"ecb967ec-c137-48a5-860****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 1031203110005\\n The specified parameters are invalid\\n 200\\n \\n 1001\\n 测试基线\\n 10000\\n 9527952****\\n 1\\n DAILY\\n \\n 1\\n \\n \\n true\\n 123123\\n true\\n 60\\n \\n BASELINE\\n MAIL\\n 00:00:00\\n 00:00:00\\n 900\\n 1\\n \\n https://oapi.dingtalk.com/robot/send?access_token=xxx\\n true\\n \\n https://open.feishu.cn/open-apis/bot/v2/hook/xxx\\n SLOW\\n false\\n OWNER\\n 123123\\n \\n \\n ecb967ec-c137-48a5-860****\\n","errorExample":""}]', - 'title' => 'GetBaseline', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"RequestId\\": \\"0bc1ec92159376****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"DataEntityList\\": [\\n {\\n \\"EndTime\\": \\"2020-01-01 00:01:00\\",\\n \\"TaskInstanceId\\": 3521,\\n \\"StartTime\\": \\"2020-01-01 00:00:00\\",\\n \\"ProjectId\\": 333,\\n \\"WaitTime\\": \\"323\\",\\n \\"TableGuid\\": \\"odps.engine_name.table_name\\",\\n \\"TaskId\\": \\"1048576\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], - 'DeleteBaseline' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetMetaTablePartition' => [ + 'summary' => 'Retrieves a list of partitions for a table.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '158727', - 'abilityTreeNodes' => [ - 'FEATUREdideSFSFU4', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '78269', + 'abilityTreeNodes' => ['FEATUREdideE9XYA6'], ], 'parameters' => [ [ - 'name' => 'BaselineId', - 'in' => 'formData', - 'schema' => [ - 'title' => '基线Id', - 'description' => 'The baseline ID. You can call the [ListBaselines](~~2261507~~) operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234', - ], + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'ProjectId', - 'in' => 'formData', + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'TableGuid', + 'in' => 'query', + 'schema' => ['description' => 'The unique identifier of the table.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'odps.engine_name.table_name', 'title' => ''], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the EMR cluster. Required only if **DataSourceType** is **EMR**.'."\n" + ."\n" + .'Log on to the [EMR console](https://emr.console.aliyun.com/?spm=a2c4g.11186623.0.0.965cc5c2GeiHet#/cn-hangzhou) to obtain the cluster ID.', 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''], + ], + [ + 'name' => 'DatabaseName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the database. Required only if **DataSourceType** is **EMR**.'."\n" + ."\n" + .'Call the [ListMetaDB](~~2780105~~) operation to query the database name.', 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the EMR table. Required only if **DataSourceType** is **EMR**.'."\n" + ."\n" + .'Call the [GetMetaDBTableList](~~2780086~~) operation to query the table name.', 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''], + ], + [ + 'name' => 'DataSourceType', + 'in' => 'query', + 'schema' => ['description' => 'The data source type. Valid values: ODPS and EMR.', 'type' => 'string', 'required' => false, 'example' => 'emr', 'title' => ''], + ], + [ + 'name' => 'SortCriterion', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '项目空间ID', - 'description' => 'The ID of the workspace to which the baseline belongs. You can call the ListBaselines operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10000', + 'description' => 'The partition sorting logic.', + 'type' => 'object', + 'properties' => [ + 'SortField' => ['description' => 'The field used to sort the partitions. Valid values: **name** and **modify\\_time**. Default value: the creation time of the partition.', 'type' => 'string', 'required' => false, 'example' => 'name', 'title' => ''], + 'Order' => ['description' => 'The sort order. Valid values: **asc** and **desc**. Default value: **desc**.', 'type' => 'string', 'required' => false, 'example' => 'desc', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'OpenApiResultModel', - 'description' => 'The response parameters.'."\n", + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '1031203110000', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Baseline deletion failed with nodes dependent on baseline', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The connection does not exist.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0bc1ec92159376', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], 'Data' => [ - 'description' => 'Indicates whether the deletion was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EF****', + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of partitions.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'DataEntityList' => [ + 'description' => 'The list of partitions.', + 'type' => 'array', + 'items' => [ + 'description' => 'The structure of the data.', + 'type' => 'object', + 'properties' => [ + 'PartitionPath' => ['description' => 'The directory of the partition.', 'type' => 'string', 'example' => 'abc', 'title' => ''], + 'DataSize' => ['description' => 'The partition size. Unit: bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '19', 'title' => ''], + 'PartitionName' => ['description' => 'The name of the partition.', 'type' => 'string', 'example' => 'pt=20170614', 'title' => ''], + 'Comment' => ['description' => 'The remarks.', 'type' => 'string', 'example' => 'Remarks', 'title' => ''], + 'ModifiedTime' => ['description' => 'The modification time. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1590032868000', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1590032868000', 'title' => ''], + 'RecordCount' => ['description' => 'The record count.', 'type' => 'integer', 'format' => 'int64', 'example' => '233', 'title' => ''], + 'PartitionType' => ['description' => 'The type of the partition.', 'type' => 'string', 'example' => 'abc', 'title' => ''], + 'PartitionGuid' => ['description' => 'The unique identifier of the partition.', 'type' => 'string', 'example' => 'odps.engine_name.table_name.pt=20170614', 'title' => ''], + 'PartitionLocation' => ['description' => 'The location of the Hive partition.', 'type' => 'string', 'example' => 'abc', 'title' => ''], + 'TableGuid' => ['description' => 'The unique identifier of the table.', 'type' => 'string', 'example' => 'odps.engine_name.table_name', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1031203110000\\",\\n \\"ErrorMessage\\": \\"Baseline deletion failed with nodes dependent on baseline\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"0000-ABCD-EF****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 1031203110000\\n Baseline deletion failed with nodes dependent on baseline\\n 200\\n true\\n 0000-ABCD-EF****\\n","errorExample":""}]', - 'title' => 'DeleteBaseline', - 'summary' => 'Deletes a baseline based on its ID. You can delete a baseline only if the nodes in the baseline does not have ancestor nodes. You can call the UpdateBaseline operation to delete the relationships between the nodes and their ancestor nodes.', - ], - 'ListBaselines' => [ - 'summary' => 'Obtains a list of baselines.', - 'methods' => [ - 'post', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InvalidParameter.Meta.CommonError', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The request parameter is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.Illegal', 'errorMessage' => 'The app guid parameter is invalid.', 'description' => 'The app guid parameter is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.IllegalDate', 'errorMessage' => 'The date format is invalid.', 'description' => 'The date format is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.IllegalPageError', 'errorMessage' => 'The parameter for paging is invalid.', 'description' => 'The parameter for paging is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.NotExist', 'errorMessage' => 'The object does not exist.', 'description' => ''], + ['errorCode' => 'InternalError.Meta.NoCalcEngine', 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.', 'description' => 'Incorrect project entered by user'], + ], + 403 => [ + ['errorCode' => 'Forbidden.Meta.NoTenant', 'errorMessage' => 'The user is not the owner of any tenants.', 'description' => 'The user is not the owner of any tenants.'], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.Meta.TenantTimeOut', 'errorMessage' => 'Failed to connect to the interface network.', 'description' => 'Failed to connect to the interface network.'], + ['errorCode' => 'InternalError.Meta.Unknown', 'errorMessage' => 'An unknown error occurred while processing your request.', 'description' => 'An unknown error occurred while processing your request.'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"DataEntityList\\": [\\n {\\n \\"PartitionPath\\": \\"abc\\",\\n \\"DataSize\\": 19,\\n \\"PartitionName\\": \\"pt=20170614\\",\\n \\"Comment\\": \\"Remarks\\",\\n \\"ModifiedTime\\": 1590032868000,\\n \\"CreateTime\\": 1590032868000,\\n \\"RecordCount\\": 233,\\n \\"PartitionType\\": \\"abc\\",\\n \\"PartitionGuid\\": \\"odps.engine_name.table_name.pt=20170614\\",\\n \\"PartitionLocation\\": \\"abc\\",\\n \\"TableGuid\\": \\"odps.engine_name.table_name\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'GetMetaTablePartition', + 'description' => 'This operation supports only MaxCompute and E-MapReduce (EMR) tables. For EMR, supported cluster types include new data lake clusters that use Data Lake Formation (DLF) for metadata management, and Hadoop clusters with versions earlier than V3.41.0 or V5.7.0.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' GetMetaTablePartition接口的使用示例Demo请参见[DataWorks OpenAPI示例](https://developer.aliyun.com/article/780879?groupCode=dataworks)。', + 'changeSet' => [ + ['createdAt' => '2024-02-22T06:36:38.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-08-11T02:23:22.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'GetMetaTableThemeLevel' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '158237', - 'abilityTreeNodes' => [ - 'FEATUREdideSFSFU4', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '78270', + 'abilityTreeNodes' => ['FEATUREdideRZEBFC'], ], 'parameters' => [ [ - 'name' => 'Owner', - 'in' => 'formData', - 'schema' => [ - 'title' => '责任人', - 'description' => 'The owner.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '3726346****', - ], - ], - [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'title' => '项目空间id', - 'description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456', - ], - ], - [ - 'name' => 'Priority', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The priority of the baseline. Valid values: {1,3,5,7,8}.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'Enable', - 'in' => 'formData', - 'schema' => [ - 'title' => '是否开启基线', - 'description' => 'Specifies whether to enable the baseline. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'BaselineTypes', - 'in' => 'formData', - 'schema' => [ - 'title' => '基线类型', - 'description' => 'The type of the baseline. Valid values: DAILY and HOURLY. You can specify multiple types. Separate multiple types with commas (,).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'DAILY', - ], - ], - [ - 'name' => 'SearchText', - 'in' => 'formData', - 'schema' => [ - 'title' => '基线名模糊查询', - 'description' => 'The keyword in the baseline name, which is used to search for the baseline.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'baselineName', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The page number. Pages start from page 1. Default value: 1. Maximum value: 30.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'name' => 'TableGuid', + 'in' => 'query', + 'schema' => ['description' => 'The GUID of the metatable. Specify the GUID in the format of odps.${projectName}.${tableName}.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'odps.project1.name1', 'title' => ''], ], [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '100', - ], + 'name' => 'DataSourceType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the data source. Set the value to odps.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'odps', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'OpenApiResultModel', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '103630001', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'The user does not exist. 276571706358178756', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The data returned.'."\n", + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. You can troubleshoot issues based on the ID.', 'type' => 'string', 'example' => '1324afdsfde', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'Entity' => [ + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of baselines returned.'."\n", - 'type' => 'string', - 'example' => '100', - ], - 'Baselines' => [ - 'description' => 'The baselines.'."\n", + 'Theme' => [ + 'description' => 'The information about the themes of the metatable.', 'type' => 'array', 'items' => [ 'description' => '', - 'type' => 'object', - 'properties' => [ - 'BaselineId' => [ - 'description' => 'The baseline ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'ProjectId' => [ - 'description' => 'The ID of the workspace to which the baseline belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '9527', - ], - 'BaselineType' => [ - 'description' => 'The type of the baseline. Valid values: DAILY and HOURLY.'."\n", - 'type' => 'string', - 'example' => 'DAILY', - ], - 'Priority' => [ - 'description' => 'The priority of the baseline. Valid values: {1,2,5,7,8}.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Owner' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the baseline owner. Multiple IDs can be specified. The IDs are separated by commas (,).'."\n", - 'type' => 'string', - 'example' => '952795****', - ], - 'BaselineName' => [ - 'description' => 'The name of the baseline.'."\n", - 'type' => 'string', - 'example' => 'BaselineName', - ], - 'Enabled' => [ - 'description' => 'Indicates whether the baseline is enabled. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'AlertEnabled' => [ - 'description' => 'Indicates whether the alerting feature is enabled. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'AlertMarginThreshold' => [ - 'description' => 'The alert margin threshold for the baseline instance. Unit: minutes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'OverTimeSettings' => [ - 'description' => 'The settings of the committed completion time of the baseline.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Cycle' => [ - 'description' => 'The cycle that corresponds to the committed completion time. For a day-level baseline, the value of this parameter is 1. For an hour-level baseline, the value of this parameter cannot exceed 24.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Time' => [ - 'description' => 'The committed completion time in the hh:mm format. Valid values of hh: \\[0,47]. Valid values of mm: \\[0,59].'."\n", - 'type' => 'string', - 'example' => '00:00', - ], - ], - ], - ], + 'type' => 'object', + 'properties' => [ + 'ParentId' => ['description' => 'The ID of the parent theme.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Name' => ['description' => 'The name of the theme.', 'type' => 'string', 'example' => 'theme1', 'title' => ''], + 'ThemeId' => ['description' => 'The ID of the theme.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'Level' => ['description' => 'The level of the theme. Valid values:'."\n" + ."\n" + .'- 1'."\n" + ."\n" + .'- 2', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Level' => [ + 'description' => 'The information about the levels of the metatable.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The type of the level. Valid values:'."\n" + ."\n" + .'- 1: indicates the logical level.'."\n" + ."\n" + .'- 2: indicates the physical level.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Description' => ['description' => 'The description of the level.', 'type' => 'string', 'example' => 'Description', 'title' => ''], + 'Name' => ['description' => 'The name of the level.', 'type' => 'string', 'example' => 'level1', 'title' => ''], + 'LevelId' => ['description' => 'The ID of the level.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '952795279527ab****', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"103630001\\",\\n \\"ErrorMessage\\": \\"The user does not exist. 276571706358178756\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"PageNumber\\": \\"1\\",\\n \\"PageSize\\": \\"10\\",\\n \\"TotalCount\\": \\"100\\",\\n \\"Baselines\\": [\\n {\\n \\"BaselineId\\": 1234,\\n \\"ProjectId\\": 9527,\\n \\"BaselineType\\": \\"DAILY\\",\\n \\"Priority\\": 1,\\n \\"Owner\\": \\"952795****\\",\\n \\"BaselineName\\": \\"BaselineName\\",\\n \\"Enabled\\": true,\\n \\"AlertEnabled\\": true,\\n \\"AlertMarginThreshold\\": 30,\\n \\"OverTimeSettings\\": [\\n {\\n \\"Cycle\\": 1,\\n \\"Time\\": \\"00:00\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"RequestId\\": \\"952795279527ab****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 103630001\\n The user does not exist. 276571706358178756\\n 200\\n \\n 1\\n 10\\n 100\\n \\n 1234\\n 9527\\n DAILY\\n 1\\n 952795****\\n BaselineName\\n true\\n true\\n 30\\n \\n 1\\n \\n \\n \\n \\n 952795279527ab****\\n","errorExample":""}]', - 'title' => 'ListBaselines', - ], - 'CreateBaseline' => [ - 'summary' => 'Creates a baseline.', - 'methods' => [ - 'post', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Invalid.Meta.TableNotExist', 'errorMessage' => 'The table does not exist.', 'description' => 'The table does not exist.'], + ['errorCode' => 'InvalidParameter.Meta.CommonError', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The request parameter is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.Illegal', 'errorMessage' => 'The app guid parameter is invalid.', 'description' => 'The app guid parameter is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.IllegalDate', 'errorMessage' => 'The date format is invalid.', 'description' => 'The date format is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.IllegalPageError', 'errorMessage' => 'The parameter for paging is invalid.', 'description' => 'The parameter for paging is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.NotExist', 'errorMessage' => 'The object does not exist.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'Forbidden.Meta.NoTenant', 'errorMessage' => 'The user is not the owner of any tenants.', 'description' => 'The user is not the owner of any tenants.'], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.Meta.NoCalcEngine', 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.', 'description' => ''], + ['errorCode' => 'InternalError.Meta.TenantTimeOut', 'errorMessage' => 'Failed to connect to the interface network.', 'description' => 'Failed to connect to the interface network.'], + ['errorCode' => 'InternalError.Meta.Unknown', 'errorMessage' => 'An unknown error occurred while processing your request.', 'description' => 'An unknown error occurred while processing your request.'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"success\\",\\n \\"RequestId\\": \\"1324afdsfde\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"0\\",\\n \\"Entity\\": {\\n \\"Theme\\": [\\n {\\n \\"ParentId\\": 0,\\n \\"Name\\": \\"theme1\\",\\n \\"ThemeId\\": 123,\\n \\"Level\\": 1\\n }\\n ],\\n \\"Level\\": [\\n {\\n \\"Type\\": 1,\\n \\"Description\\": \\"Description\\",\\n \\"Name\\": \\"level1\\",\\n \\"LevelId\\": 1\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'GetMetaTableThemeLevel', + 'summary' => 'Fetches topics and hierarchy metadata for tables', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'GetMigrationProcess' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '158238', - 'abilityTreeNodes' => [ - 'FEATUREdideSFSFU4', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '78271', + 'abilityTreeNodes' => ['FEATUREdide8FM783'], ], 'parameters' => [ - [ - 'name' => 'BaselineName', - 'in' => 'formData', - 'schema' => [ - 'title' => '基线名', - 'description' => 'The name of the baseline.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'BaselineName', - ], - ], [ 'name' => 'ProjectId', 'in' => 'formData', - 'schema' => [ - 'title' => '项目id', - 'description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10000', - ], - ], - [ - 'name' => 'Owner', - 'in' => 'formData', - 'schema' => [ - 'title' => '责任人', - 'description' => 'The ID of the Alibaba Cloud account used by the baseline owner.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1000000000001', - ], - ], - [ - 'name' => 'Priority', - 'in' => 'formData', - 'schema' => [ - 'title' => '基线优先级', - 'description' => 'The priority of the baseline. Valid values: {1,3,5,7,8}.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1,3,5,7,8', - ], + 'schema' => ['description' => 'The workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '2', 'example' => '123456'], ], [ - 'name' => 'NodeIds', + 'name' => 'MigrationId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ancestor nodes of nodes in the baseline.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '210001233239,210001236482', - ], + 'schema' => ['description' => 'The migration package ID. You can call the CreateImportMigration operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '1', 'example' => '123456'], ], - [ - 'name' => 'OvertimeSettings', - 'in' => 'formData', - 'style' => 'repeatList', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '基线承诺时间', - 'description' => 'The settings of the committed completion time of the baseline.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The cycle.'."\n", - 'type' => 'object', - 'properties' => [ - 'Cycle' => [ - 'title' => '周期，取值范围 [1,24]', - 'description' => 'The cycle that corresponds to the committed completion time. For a day-level baseline, set this parameter to 1. For an hour-level baseline, set this parameter to a value that is no more than 24.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'Time' => [ - 'title' => '承诺时间，hh:mm格式，hh的取值范围为[0,47]，mm的取值范围为[0,59]', - 'description' => 'The committed completion time in the hh:mm format. Valid values of hh: \\[0,47]. Valid values of mm: \\[0,59].'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '00:00', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'SADFSDFSD-SDFSDF-XDXCVX-ESWW'], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'test error msg'], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '110001123456'], + 'Data' => [ + 'description' => 'The progress information of the migration task, including the names of all steps in and status of the migration task.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TaskStatus' => ['description' => 'The running status of the step in the migration task. Valid values:'."\n" + ."\n" + .'* INIT'."\n" + .'* RUNNING'."\n" + .'* FAILURE'."\n" + .'* SUCCESS'."\n", 'type' => 'string', 'example' => 'SUCCESS'], + 'TaskName' => ['description' => 'The name of the step in the migration task.'."\n", 'type' => 'string', 'example' => 'IMPORE_PREPARE'], + ], ], ], - 'required' => false, ], - 'required' => true, - 'maxItems' => 144, - 'minItems' => 1, ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"SADFSDFSD-SDFSDF-XDXCVX-ESWW\\",\\n \\"ErrorMessage\\": \\"test error msg\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"110001123456\\",\\n \\"Data\\": [\\n {\\n \\"TaskStatus\\": \\"SUCCESS\\",\\n \\"TaskName\\": \\"IMPORE_PREPARE\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n SADFSDFSD-SDFSDF-XDXCVX-ESWW\\n test error msg\\n true\\n 110001123456\\n \\n SUCCESS\\n IMPORE_PREPARE\\n \\n","errorExample":""}]', + 'title' => 'GetMigrationProcess', + 'summary' => 'Queries the progress of a migration task.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'GetMigrationSummary' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '86668', + 'abilityTreeNodes' => ['FEATUREdide8FM783'], + ], + 'parameters' => [ [ - 'name' => 'AlertMarginThreshold', + 'name' => 'ProjectId', 'in' => 'formData', - 'schema' => [ - 'title' => '基线预警余量', - 'description' => 'The alert margin threshold of the baseline. Unit: minutes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], + 'schema' => ['description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the workspace ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '2', 'example' => '12345'], ], [ - 'name' => 'BaselineType', + 'name' => 'MigrationId', 'in' => 'formData', - 'schema' => [ - 'title' => '基线类型 (DAILY, HOURLY)', - 'description' => 'The type of the baseline. Valid values: DAILY and HOURLY.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'DAILY', - ], + 'schema' => ['description' => 'The migration task ID.'."\n" + ."\n" + .'You can call the [CreateImportMigration](~~2780280~~) operation to obtain the ID of the import task and call the [CreateExportMigration](~~2780281~~) operation to obtain the ID of the export task.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '1', 'example' => '1234'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'OpenApiResultModel', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '401', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified parameters are invalid.', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'RequestId' => ['description' => 'The request ID. You can use the request ID to query logs and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '19999A96-71BA-2845-B455-ED620EF4E37F'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], 'Data' => [ - 'description' => 'The baseline ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100003', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'F05080B0-CCE6-5D22-B284-34A51C5D4E28', + 'description' => 'The details of the migration task.'."\n", + 'type' => 'object', + 'properties' => [ + 'MigrationId' => ['description' => 'The task ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234'], + 'Name' => ['description' => 'The task name.'."\n", 'type' => 'string', 'example' => 'test_export_01'], + 'GmtCreate' => ['description' => 'The time when the task was created.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1589904000000'], + 'GmtModified' => ['description' => 'The time when the task was modified.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1589904000000'], + 'CreateUser' => ['description' => 'The ID of the user who created the task.'."\n", 'type' => 'string', 'example' => '982293332403****'], + 'OpUser' => ['description' => 'The ID of the user who managed the task.'."\n", 'type' => 'string', 'example' => '982293332403****'], + 'Status' => ['description' => 'The status of the migration task. Valid values:'."\n" + ."\n" + .'* INIT'."\n" + .'* EDITING'."\n" + .'* IMPORTING'."\n" + .'* IMPORT_ERROR'."\n" + .'* IMPORT_SUCCESS'."\n" + .'* EXPORTING'."\n" + .'* EXPORT_ERROR'."\n" + .'* EXPORT_SUCCESS'."\n" + .'* REVOKED'."\n" + .'* PARTIAL_SUCCESS'."\n", 'type' => 'string', 'example' => 'EXPORT_SUCCESS'], + 'ProjectId' => ['description' => 'The ID of the DataWorks workspace to which the migration task belongs.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '12345'], + 'DownloadUrl' => ['description' => 'The URL that is used to download the package of the export task. You can use the URL to download the package of the export task.'."\n", 'type' => 'string', 'example' => 'https://shanghai-xxx-oss.oss-cn-shanghai.aliyuncs.com/pre/store/f10_bf47_b4fa7df0860f.zip?Expires=1639540903&OSSAccessKeyId=XXXXXXeF4Lv5j&Signature=qxxxxx'], + ], ], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"401\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 100003,\\n \\"RequestId\\": \\"F05080B0-CCE6-5D22-B284-34A51C5D4E28\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 401\\n The specified parameters are invalid.\\n 200\\n 100003\\n F05080B0-CCE6-5D22-B284-34A51C5D4E28\\n","errorExample":""}]', - 'title' => 'CreateBaseline', - ], - 'UpdateBaseline' => [ - 'summary' => 'Updates a baseline.', - 'methods' => [ - 'post', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"19999A96-71BA-1845-B455-ED620EF4E37F\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"MigrationId\\": 1234,\\n \\"Name\\": \\"test_export_01\\",\\n \\"GmtCreate\\": 1589904000000,\\n \\"GmtModified\\": 1589904000000,\\n \\"CreateUser\\": \\"982293332403****\\",\\n \\"OpUser\\": \\"982293332403****\\",\\n \\"Status\\": \\"EXPORT_SUCCESS\\",\\n \\"ProjectId\\": 12345,\\n \\"DownloadUrl\\": \\"https://shanghai-xxx-oss.oss-cn-shanghai.aliyuncs.com/pre/store/f10_bf47_b4fa7df0860f.zip?Expires=1639540903&OSSAccessKeyId=****&Signature=qxxxxx\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 19999A96-71BA-1845-B455-ED620EF4E37F\\n true\\n \\n 1234\\n test_export_01\\n 1589904000000\\n 1589904000000\\n 982293332403****\\n 982293332403****\\n EXPORT_SUCCESS\\n 12345\\n https://shanghai-xxx-oss.oss-cn-shanghai.aliyuncs.com/pre/store/f10_bf47_b4fa7df0860f.zip?Expires=1639540903&OSSAccessKeyId=XXXXXXeF4Lv5j&Signature=qxxxxx\\n \\n","errorExample":""}]', + 'title' => 'GetMigrationSummary', + 'summary' => 'Queries the information about a migration task.', + 'changeSet' => [ + ['createdAt' => '2021-11-16T06:51:50.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'GetNode' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '158726', - 'abilityTreeNodes' => [ - 'FEATUREdideSFSFU4', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '78272', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB', 'FEATUREdideVFMENL'], ], 'parameters' => [ [ - 'name' => 'BaselineId', + 'name' => 'NodeId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The baseline ID. You can call the [ListBaselines](~~2261507~~) operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1000010800007', - ], + 'schema' => ['description' => 'The interval at which the node is rerun after the node fails to run.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '2', 'isFileTransferUrl' => false, 'example' => '1234', 'title' => ''], ], [ - 'name' => 'ProjectId', + 'name' => 'ProjectEnv', 'in' => 'formData', 'schema' => [ - 'description' => 'The workspace ID. You can call the [ListBaselines](~~2261507~~) operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The environment of the workspace. Valid values: PROD and DEV.', + 'enumValueTitles' => [], + 'type' => 'string', 'required' => true, - 'example' => '2043', + 'docRequired' => true, + 'isFileTransferUrl' => false, + 'enum' => ['PROD', 'DEV'], + 'example' => 'PROD', + 'title' => '', ], ], - [ - 'name' => 'BaselineName', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '基线名', - 'description' => 'The name of the baseline.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'BaselineName', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'The operation that you want to perform. Set the value to **GetNode**.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'Other parameters.', 'type' => 'string', 'example' => 'E6F0DBDD-5AD****', 'title' => ''], + 'ErrorMessage' => ['description' => 'The connection string.', 'type' => 'string', 'example' => 'The connection does not exist.', 'title' => ''], + 'ErrorCode' => ['description' => 'The ID of the node. You can call the [ListNodes](~~173979~~) operation to query the node ID.', 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], + 'Success' => ['description' => 'The ID of the workflow.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The details of the node.', + 'type' => 'object', + 'properties' => [ + 'SchedulerType' => ['description' => 'The ID of the workspace.', 'type' => 'string', 'example' => 'NORMAL', 'title' => ''], + 'RepeatInterval' => ['description' => 'The ID of the workflow to which the node belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '60', 'title' => ''], + 'Repeatability' => ['description' => 'The type of the node.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'RepeatMode' => ['description' => 'Rerun mode. 0 indicates that you can rerun only if you fail, 1 indicates that you can rerun in all cases, and 2 indicates that you cannot rerun in all cases.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ProjectId' => ['description' => 'Indicates whether the node can be rerun.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'ProgramType' => ['description' => 'The ID of the owner of the node.', 'type' => 'string', 'example' => 'ODPS_SQL', 'title' => ''], + 'Priority' => ['description' => 'The HTTP status code returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'OwnerId' => ['description' => 'The ID of the node.', 'type' => 'string', 'example' => '17366294****', 'title' => ''], + 'Connection' => ['description' => 'The environment of the workspace. Valid values: PROD and DEV.', 'type' => 'string', 'example' => 'odps_source_dev', 'title' => ''], + 'ParamValues' => ['description' => 'The CRON expression returned.', 'type' => 'string', 'example' => 'a=b', 'title' => ''], + 'RelatedFlowId' => ['description' => 'Indicates whether the node is associated with Data Quality. Valid values: 0 and 1. A value of 0 indicates that the node is associated with Data Quality. A value of 1 indicates that the node is not associated with Data Quality.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'DqcType' => ['description' => 'The error message returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'BaselineId' => ['description' => 'The description of the node.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', 'title' => ''], + 'Description' => ['description' => 'The name of the resource group.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'NodeName' => ['description' => 'The scheduling type of the node. Valid values:'."\n" + ."\n" + .'- NORMAL: The node is an auto triggered node.'."\n" + ."\n" + .'- MANUAL: The node is a manually triggered node. Manually triggered nodes cannot be automatically triggered.'."\n" + ."\n" + .'- PAUSE: The node is a paused node.'."\n" + ."\n" + .'- SKIP: The node is a dry-run node. Dry-run nodes are started as scheduled but the system sets the status of the nodes to successful when it starts to run them.', 'type' => 'string', 'example' => 'Sql node', 'title' => ''], + 'ResGroupName' => ['description' => 'The ID of the request. You can use the ID to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => 'Default resource group', 'title' => ''], + 'BusinessId' => ['description' => 'The operation that you want to perform. Set the value to **GetNode**.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'DqcDescription' => ['description' => 'The ID of the node. You can call the [ListNodes](~~173979~~) operation to query the node ID.', 'type' => 'string', 'example' => '[{"projectName":"test_0923001","tableName":"test_table_001","partition":"ds\\u003d$[yyyymmdd]"},{"projectName":"test_0923001","tableName":"test_table_002","partition":"NOTAPARTITIONTABLE"}]', 'title' => ''], + 'CronExpress' => ['description' => 'The environment of the workspace. Valid values: PROD and DEV.', 'type' => 'string', 'example' => '00 00 00 * * ?', 'title' => ''], + 'NodeId' => ['description' => 'The HTTP status code returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'ResGroupIdentifier' => ['description' => 'The unique identifier of the resource group.', 'type' => 'string', 'example' => 'group_123', 'title' => ''], + 'FileType' => ['description' => 'The file type. Different file types have different codes. For more information, see [DataWorks node collection](~~600169~~).', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'FileId' => ['description' => 'The file ID.'."\n" + ."\n" + .'\\*\\*'."\n" + ."\n" + .'**Warning** The field is deprecated.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'FileVersion' => ['description' => 'The version of the file.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'DeployDate' => ['description' => 'The deployment date.', 'type' => 'integer', 'format' => 'int64', 'example' => '1727280000000', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1727280000000', 'title' => ''], + 'ModifyTime' => ['description' => 'The modification time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1727280000000', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"SchedulerType\\": \\"NORMAL\\",\\n \\"RepeatInterval\\": 60,\\n \\"Repeatability\\": \\"true\\",\\n \\"RepeatMode\\": 1,\\n \\"ProjectId\\": 1234,\\n \\"ProgramType\\": \\"ODPS_SQL\\",\\n \\"Priority\\": 1,\\n \\"OwnerId\\": \\"17366294****\\",\\n \\"Connection\\": \\"odps_source_dev\\",\\n \\"ParamValues\\": \\"a=b\\",\\n \\"RelatedFlowId\\": 123,\\n \\"DqcType\\": 1,\\n \\"BaselineId\\": 123456,\\n \\"Description\\": \\"test\\",\\n \\"NodeName\\": \\"Sql node\\",\\n \\"ResGroupName\\": \\"Default resource group\\",\\n \\"BusinessId\\": 123,\\n \\"DqcDescription\\": \\"[{\\\\\\"projectName\\\\\\":\\\\\\"test_0923001\\\\\\",\\\\\\"tableName\\\\\\":\\\\\\"test_table_001\\\\\\",\\\\\\"partition\\\\\\":\\\\\\"ds\\\\\\\\u003d$[yyyymmdd]\\\\\\"},{\\\\\\"projectName\\\\\\":\\\\\\"test_0923001\\\\\\",\\\\\\"tableName\\\\\\":\\\\\\"test_table_002\\\\\\",\\\\\\"partition\\\\\\":\\\\\\"NOTAPARTITIONTABLE\\\\\\"}]\\",\\n \\"CronExpress\\": \\"00 00 00 * * ?\\",\\n \\"NodeId\\": 1234,\\n \\"ResGroupIdentifier\\": \\"group_123\\",\\n \\"FileType\\": 10,\\n \\"FileId\\": 123,\\n \\"FileVersion\\": 1,\\n \\"DeployDate\\": 1727280000000,\\n \\"CreateTime\\": 1727280000000,\\n \\"ModifyTime\\": 1727280000000\\n }\\n}","type":"json"}]', + 'title' => 'GetNode', + 'summary' => 'Indicates whether the request is successful.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-09-26T12:05:38.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-05-30T14:18:43.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-06-05T03:55:01.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-08-12T08:47:00.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-08-12T08:47:00.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-08-12T08:47:00.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'Owner', - 'in' => 'formData', - 'schema' => [ - 'title' => '责任人', - 'description' => 'The ID of the Alibaba Cloud account used by the baseline owner.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '3726346****', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'translator' => 'manual', + ], + 'GetNodeChildren' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Priority', - 'in' => 'formData', - 'schema' => [ - 'title' => '基线优先级', - 'description' => 'The priority of the baseline. Valid values: {1,3,5,7,8}.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '7', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '78273', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB', 'FEATUREdideVFMENL'], + ], + 'parameters' => [ [ - 'name' => 'NodeIds', + 'name' => 'ProjectEnv', 'in' => 'formData', 'schema' => [ - 'description' => 'The ancestor nodes of nodes in the baseline. Separate the ancestor nodes with commas (,). If a large number of ancestor nodes exist, we recommend that you create a zero load node and configure the zero load node as the descendant node of nodes in the baseline to facilitate node management.'."\n", + 'description' => 'The environment type of Operation Center. Valid values: PROD and DEV. The value PROD indicates the production environment, and the value DEV indicates the development environment.'."\n", + 'enumValueTitles' => [], 'type' => 'string', - 'required' => false, - 'example' => '1,2,3', + 'required' => true, + 'docRequired' => true, + 'enum' => ['PROD', 'DEV'], + 'example' => 'PROD', + 'title' => '', ], ], [ - 'name' => 'OvertimeSettings', + 'name' => 'NodeId', 'in' => 'formData', - 'style' => 'json', + 'schema' => ['description' => 'The node ID. You can go to the Operation Center page in the DataWorks console to query the node ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '123456878', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '基线承诺时间', - 'description' => 'The settings of the committed completion time of the baseline.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The cycle.'."\n", - 'type' => 'object', - 'properties' => [ - 'Cycle' => [ - 'title' => '周期，取值范围 [1,24]', - 'description' => 'The cycle that corresponds to the committed completion time. For a day-level baseline, set this parameter to 1. For an hour-level baseline, set this parameter to a value that is no more than 24.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'Time' => [ - 'title' => '承诺时间，hh:mm格式，hh的取值范围为[0,47]，mm的取值范围为[0,59]', - 'description' => 'The committed completion time in the hh:mm format. Valid values of hh: \\[0,47]. Valid values of mm: \\[0,59].'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '00:00', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. You can use the ID to troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'adsfasdf-adf-asdf-asdf-asdfadfasdd', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'err', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '1060010000000', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The information about the descendant nodes.'."\n", + 'type' => 'object', + 'properties' => [ + 'Nodes' => [ + 'description' => 'The descendant nodes.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The descendant node.'."\n", + 'type' => 'object', + 'properties' => [ + 'SchedulerType' => ['description' => 'The scheduling type of the node. Valid values:'."\n" + ."\n" + .'* NORMAL: The node is an auto triggered node.'."\n" + .'* MANUAL: The node is a manually triggered node. Manually triggered nodes cannot be automatically triggered.'."\n" + .'* PAUSE: The node is a paused node. Paused nodes are started as scheduled but the system sets the status of the nodes to failed when it starts to run them.'."\n" + .'* SKIP: The node is a dry-run node. Dry-run nodes are started as scheduled but the system sets the status of the nodes to successful when it starts to run them.'."\n", 'type' => 'string', 'example' => 'NORMAL', 'title' => ''], + 'BaselineId' => ['description' => 'The baseline ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '12345656', 'title' => ''], + 'Repeatability' => ['description' => 'Indicates whether the node can be rerun if the node fails to run. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'NodeName' => ['description' => 'The name of the node.'."\n", 'type' => 'string', 'example' => 'test_Node', 'title' => ''], + 'ProjectId' => ['description' => 'The ID of the workspace to which the node belongs.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '12315412412', 'title' => ''], + 'ProgramType' => ['description' => 'The type of the node.'."\n", 'type' => 'string', 'example' => 'ODPS_SQL', 'title' => ''], + 'Priority' => ['description' => 'The priority. Valid values: 1 to 8. A large value indicates a high priority.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'OwnerId' => ['description' => 'The ID of the Alibaba Cloud account used by the node owner.'."\n", 'type' => 'string', 'example' => '123124561341251321', 'title' => ''], + 'CronExpress' => ['description' => 'The CRON expression. CRON expressions are used to run auto triggered nodes.'."\n", 'type' => 'string', 'example' => '00 00 * * * * ', 'title' => ''], + 'NodeId' => ['description' => 'The node ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1244564565', 'title' => ''], + 'StepType' => ['description' => 'The scheduling dependency type. Valid values:'."\n" + ."\n" + .'* **0**: same-cycle scheduling dependency'."\n" + .'* **3**: cross-cycle scheduling dependency'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], ], + 'title' => '', + 'example' => '', ], - 'required' => false, ], - 'required' => false, - 'maxItems' => 144, + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'GetNodeChildren', + 'summary' => 'Queries a list of instances.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-05-30T14:08:36.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'AlertMarginThreshold', - 'in' => 'formData', - 'schema' => [ - 'title' => '基线预警余量', - 'description' => 'The alert margin threshold of the baseline. Unit: minutes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"adsfasdf-adf-asdf-asdf-asdfadfasdd\\",\\n \\"ErrorMessage\\": \\"err\\",\\n \\"ErrorCode\\": \\"1060010000000\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Nodes\\": [\\n {\\n \\"SchedulerType\\": \\"NORMAL\\",\\n \\"BaselineId\\": 12345656,\\n \\"Repeatability\\": true,\\n \\"NodeName\\": \\"test_Node\\",\\n \\"ProjectId\\": 12315412412,\\n \\"ProgramType\\": \\"ODPS_SQL\\",\\n \\"Priority\\": 3,\\n \\"OwnerId\\": \\"123124561341251321\\",\\n \\"CronExpress\\": \\"00 00 * * * * \\",\\n \\"NodeId\\": 1244564565,\\n \\"StepType\\": \\"0\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'GetNodeCode' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '78274', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB', 'FEATUREdideVFMENL'], + ], + 'parameters' => [ [ - 'name' => 'BaselineType', + 'name' => 'NodeId', 'in' => 'formData', - 'schema' => [ - 'title' => '基线类型 (DAILY, HOURLY)', - 'description' => 'The type of the baseline. Valid values: DAILY and HOURLY.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'DAILY', - ], + 'schema' => ['description' => 'The ID of the node.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '2', 'example' => '1234', 'isFileTransferUrl' => false], ], [ - 'name' => 'Enabled', + 'name' => 'ProjectEnv', 'in' => 'formData', 'schema' => [ - 'title' => '是否开启基线', - 'description' => 'Specifies whether to enable the baseline. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + 'description' => 'The environment of the workspace. Valid values: PROD and DEV.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'PROD', + 'isFileTransferUrl' => false, + 'enum' => ['PROD', 'DEV'], ], ], - [ - 'name' => 'AlertEnabled', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '是否开启告警', - 'description' => 'Specifies whether to enable the alerting feature. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Data' => ['description' => 'The code of the node.'."\n", 'type' => 'string', 'example' => 'select a;'], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The connection does not exist.'], + 'RequestId' => ['description' => 'The request ID. You can use the ID to locate logs and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'E6F0DBDD-5AD****'], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists'], + ], ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"select a;\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n select a;\\n The connection does not exist.\\n E6F0DBDD-5AD****\\n true\\n Invalid.Tenant.ConnectionNotExists\\n","errorExample":""}]', + 'title' => 'GetNodeCode', + 'summary' => 'Queries the code of a node.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-08-12T08:47:00.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-08-12T08:47:00.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-08-12T08:47:00.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetNodeCode'], + ], + ], + 'ramActions' => [ [ - 'name' => 'AlertSettings', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '告警配置', - 'description' => 'The alert settings of the baseline.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The alert setting of the baseline.'."\n", - 'type' => 'object', - 'properties' => [ - 'AlertType' => [ - 'title' => '告警类型，BASELINE / TOPIC', - 'description' => 'The type of the alert. Valid values: BASELINE and TOPIC. The value BASELINE indicates a baseline alert. The value TOPIC indicates an event alert.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'BASELINE', - ], - 'AlertMethods' => [ - 'title' => '告警方式', - 'description' => 'The alert notification methods. Valid values: MAIL, SMS, PHONE, DINGROBOTS, and Webhooks. The value MAIL indicates that alert notifications are sent by email. The value SMS indicates that alert notifications are sent by text message. The value PHONE indicates that alert notifications are sent by phone call. You can use this notification method only in DataWorks Professional Edition or a more advanced edition. The value DINGROBOTS indicates that alert notifications are sent by using a DingTalk chatbot. You can use this notification method only if the RobotUrls parameter is configured. The value Webhooks indicates that alert notifications are sent by WeCom or Lark. You can use this notification method only if the Webhooks parameter is configured.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The alert notification method.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SMS', - ], - 'required' => false, - ], - 'SilenceStartTime' => [ - 'title' => '静默开始时间', - 'description' => 'The start time of silence.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '00:00:00', - ], - 'SilenceEndTime' => [ - 'title' => '静默结束时间', - 'description' => 'The end time of silence.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '00:00:00', - ], - 'AlertInterval' => [ - 'title' => '事件告警间隔', - 'description' => 'The interval at which an event alert notification is sent. Unit: minutes. Minimum value: 5. Maximum value: 1,440.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '1440', - 'minimum' => '5', - 'example' => '1800', - ], - 'AlertMaximum' => [ - 'title' => '事件告警最大次数', - 'description' => 'The maximum number of times an event alert notification is sent. Maximum value: 24.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '288', - 'minimum' => '1', - 'example' => '1', - ], - 'DingRobots' => [ - 'title' => '钉钉机器人列表', - 'description' => 'The DingTalk chatbots.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The configuration of the DingTalk chatbot.'."\n", - 'type' => 'object', - 'properties' => [ - 'WebUrl' => [ - 'description' => 'The webhook URL of the DingTalk chatbot.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=xxx ', - ], - 'AtAll' => [ - 'description' => 'Specifies whether to remind all members by using the at sign (@). Valid values: true and false.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 10, - ], - 'Webhooks' => [ - 'title' => 'webhook 列表', - 'description' => 'The webhook URLs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The webhook URL of the WeCom or Lark chatbot. You can specify multiple webhook URLs. Separate multiple webhook URLs with commas (,). You must specify WEBHOOKS for AlertMethods. If this parameter is set to undefined, the specified webhook URLs are cleared.'."\n" - ."\n" - .'Only DataWorks Enterprise Edition supports this parameter. The webhook URL-based alerting feature is supported in the following regions: China (Shanghai), China (Chengdu), China (Zhangjiakou), China (Beijing), China (Hangzhou), China (Shenzhen), China (Hong Kong), Germany (Frankfurt), and Singapore.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://open.feishu.cn/open-apis/bot/v2/hook/xxx ', - ], - 'required' => false, - 'maxItems' => 10, - ], - 'TopicTypes' => [ - 'title' => '事件告警类型，事件特有配置', - 'description' => 'The types of event alerts, which are event-specific configurations.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The type of the event. Valid values: SLOW and ERROR. The value SLOW indicates that the running duration of a specific node in the current scheduling cycle is significantly longer than the average running duration of the node in previous scheduling cycles. The value ERROR indicates that a specific node fails to run. You can specify multiple event types. Separate multiple event types with commas (,).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SLOW', - ], - 'required' => false, - 'maxItems' => 10, - ], - 'BaselineAlertEnabled' => [ - 'title' => '基线告警开关，基线特有配置', - 'description' => 'Specifies whether to enable the baseline alerting feature. This feature is specific to baselines. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'AlertRecipientType' => [ - 'title' => '告警接收人类型', - 'description' => 'The type of the alert recipient. Valid values: OWNER, OTHER, and SHIFT_SCHEDULE. The value OWNER indicates the node owner. The value OTHER indicates specified personnel. The value SHIFT_SCHEDULE indicates personnel in a shift schedule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'OWNER', - ], - 'AlertRecipient' => [ - 'title' => '告警接收人详情', - 'description' => 'The details of the alert recipient. If you set AlertRecipientType to OWNER, leave this parameter empty. If you set AlertRecipientType to SHIFT_SCHEDULE, set this parameter to the name of the shift schedule. If you set AlertRecipientType to OTHER, set this parameter to the employee IDs of specified personnel.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123123', - ], - ], - 'required' => false, + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'required' => false, ], ], + ], + ], + 'GetNodeOnBaseline' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'RemoveNodeIds', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'BaselineId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the node that you want to disassociate from the baseline. You can specify multiple node IDs. Separate multiple node IDs with commas (,).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123,456', - ], + 'schema' => ['description' => 'The ID of the baseline.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1234', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'OpenApiResultModel', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '401', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified parameters are invalid.', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The unique ID of the request. You can use the ID to troubleshoot issues.'."\n", 'type' => 'string', 'example' => '0000-ABCD-E****', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The specified parameters are invalid.', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '1031203110005', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'string', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'Indicates whether the baseline was updated.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '6E07E90B-D9BC-5D6B-896A-82BA41A34AE1', + 'description' => 'The list of nodes on the baseline.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Owner' => ['description' => 'The Alibaba Cloud UID of the node owner.', 'type' => 'string', 'example' => '9527952****', 'title' => ''], + 'NodeName' => ['description' => 'The name of the node.', 'type' => 'string', 'example' => 'Node name', 'title' => ''], + 'NodeId' => ['description' => 'The ID of the node.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'ProjectId' => ['description' => 'The ID of the workspace to which the node belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"401\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"6E07E90B-D9BC-5D6B-896A-82BA41A34AE1\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 401\\n The specified parameters are invalid.\\n 200\\n true\\n 6E07E90B-D9BC-5D6B-896A-82BA41A34AE1\\n","errorExample":""}]', - 'title' => 'UpdateBaseline', + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Resource', 'errorMessage' => 'You have reached the limit for the resource. Please contact us by submitting a ticket.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'Forbidden.Not.Server', 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.', 'description' => ''], + ['errorCode' => 'Forbidden.Wkbench.BaselineNoPermission', 'errorMessage' => 'You are not authorized to access the baseline.', 'description' => ''], + ['errorCode' => 'Forbidden.Wkbench.ProjectNoPermission', 'errorMessage' => 'You are not authorized to access the workspace.', 'description' => ''], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.Wkbench.ServiceError', 'errorMessage' => 'An internal error occurred.', 'description' => 'An internal error occurred.'], + ['errorCode' => 'Invalid.Wkbench.Parameter', 'errorMessage' => 'The specified parameters are invalid.', 'description' => ''], + ['errorCode' => 'Invalid.Wkbench.BaselineNotExist', 'errorMessage' => 'The baseline does not exist.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-E****\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": [\\n {\\n \\"Owner\\": \\"9527952****\\",\\n \\"NodeName\\": \\"Node name\\",\\n \\"NodeId\\": 1234,\\n \\"ProjectId\\": 1234\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Query the nodes on a baseline', + 'summary' => 'Calls the GetNodeOnBaseline operation to query the nodes on a baseline.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], ], - 'UpdateQualityFollower' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetNodeParents' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '78379', - 'abilityTreeNodes' => [ - 'FEATUREdideGJ7UNJ', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '78276', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB', 'FEATUREdideVFMENL'], ], 'parameters' => [ [ - 'name' => 'ProjectName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the compute engine or data source.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'autotest', - ], - ], - [ - 'name' => 'FollowerId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the subscription relationship.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1234', - ], - ], - [ - 'name' => 'Follower', + 'name' => 'ProjectEnv', 'in' => 'formData', 'schema' => [ - 'description' => 'The name of the subscriber.'."\n", + 'description' => 'The environment type of Operation Center. Valid values: PROD and DEV. The value PROD indicates the production environment, and the value DEV indicates the development environment.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, - 'example' => '1912232****', - ], - ], - [ - 'name' => 'AlarmMode', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The notification method. Valid values: 1, 2, 4, 5, 6, 7, 8, and 9. The value 1 indicates that the notification is sent by email. The value 2 indicates that the notification is sent by email and text message. The value 4 indicates that the notification is sent by a DingTalk chatbot. The value 5 indicates that the notification is sent by a DingTalk chatbot to all members in a DingTalk group. The value 6 indicates that the notification is sent by Lark. The value 7 indicates that the notification is sent by WeCom. The value 8 indicates that the notification is sent by webhook. The value 9 indicates that the notification is sent by phone call.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '99', - 'minimum' => '0', - 'example' => '2', - 'enum' => [ - '1', - '2', - '4', - '5', - '6', - '7', - '8', - '9', - ], + 'enum' => ['PROD', 'DEV'], + 'example' => 'PROD', + 'title' => '', ], ], [ - 'name' => 'ProjectId', + 'name' => 'NodeId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The DataWorks workspace ID. You can log on to the DataWorks console to obtain the workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'example' => '123', - ], + 'schema' => ['description' => 'The node ID. You can go to the Operation Center page in the DataWorks console to query the node ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '12345456211234', 'title' => ''], ], ], 'responses' => [ @@ -40004,406 +20336,635 @@ 'description' => 'The returned result.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. You can troubleshoot issues based on the ID.'."\n", 'type' => 'string', 'example' => 'asfsdfas-adfasdf-asfas-dfasdf-asdf', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'err', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '1060010000000', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'Indicates whether the update is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'You have no permission', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '576b9457-2cf5-4****', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '401', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'description' => 'The ancestor nodes.'."\n", + 'type' => 'object', + 'properties' => [ + 'Nodes' => [ + 'description' => 'The ancestor nodes.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'SchedulerType' => ['description' => 'The scheduling type of the node. Valid values:'."\n" + ."\n" + .'* NORMAL: The node is an auto triggered node.'."\n" + .'* MANUAL: The node is a manually triggered node. Manually triggered nodes cannot be automatically triggered.'."\n" + .'* PAUSE: The node is a paused node. Paused nodes are started as scheduled but the system sets the status of the nodes to failed when it starts to run them.'."\n" + .'* SKIP: The node is a dry-run node. Dry-run nodes are started as scheduled but the system sets the status of the nodes to successful when it starts to run them.'."\n", 'type' => 'string', 'example' => 'NORMAL', 'title' => ''], + 'BaselineId' => ['description' => 'The baseline ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1244564565', 'title' => ''], + 'Repeatability' => ['description' => 'Indicates whether the node can be rerun if the node fails to run. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'NodeName' => ['description' => 'The name of the node.'."\n", 'type' => 'string', 'example' => 'test_Node', 'title' => ''], + 'ProjectId' => ['description' => 'The ID of the workspace to which the node belongs.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '12315412412', 'title' => ''], + 'ProgramType' => ['description' => 'The type of the node.'."\n", 'type' => 'string', 'example' => 'ODPS_SQL', 'title' => ''], + 'Priority' => ['description' => 'The priority. Valid values: 1 to 8. A large value indicates a high priority.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'OwnerId' => ['description' => 'The ID of the Alibaba Cloud account used by the node owner.'."\n", 'type' => 'string', 'example' => '123124561341251321', 'title' => ''], + 'CronExpress' => ['description' => 'The CRON expression. CRON expressions are used to run auto triggered nodes.'."\n", 'type' => 'string', 'example' => '00 00 * * * *', 'title' => ''], + 'NodeId' => ['description' => 'The node ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1244564565', 'title' => ''], + 'StepType' => ['description' => 'The scheduling dependency type.'."\n" + ."\n" + .'* **0**: same-cycle scheduling dependency'."\n" + .'* **3**: cross-cycle scheduling dependency'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"You have no permission\\",\\n \\"RequestId\\": \\"576b9457-2cf5-4****\\",\\n \\"ErrorCode\\": \\"401\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n true\\n You have no permission\\n 576b9457-2cf5-4****\\n 401\\n true\\n","errorExample":""}]', - 'title' => 'UpdateQualityFollower', - 'summary' => 'Updates a subscription relationship.', + 'title' => 'GetNodeParents', + 'summary' => 'Queries a list of ancestor nodes of a node.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateQualityRule' => [ - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2024-05-30T14:02:56.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetNodeParents'], + ], ], - 'security' => [ + 'ramActions' => [ [ - 'AK' => [], + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '78380', - 'abilityTreeNodes' => [ - 'FEATUREdide3WJOKE', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"asfsdfas-adfasdf-asfas-dfasdf-asdf\\",\\n \\"ErrorMessage\\": \\"err\\",\\n \\"ErrorCode\\": \\"1060010000000\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Nodes\\": [\\n {\\n \\"SchedulerType\\": \\"NORMAL\\",\\n \\"BaselineId\\": 1244564565,\\n \\"Repeatability\\": true,\\n \\"NodeName\\": \\"test_Node\\",\\n \\"ProjectId\\": 12315412412,\\n \\"ProgramType\\": \\"ODPS_SQL\\",\\n \\"Priority\\": 3,\\n \\"OwnerId\\": \\"123124561341251321\\",\\n \\"CronExpress\\": \\"00 00 * * * *\\",\\n \\"NodeId\\": 1244564565,\\n \\"StepType\\": \\"0\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'GetNodeTypeListInfo' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], ], ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'BlockType', + 'name' => 'ProjectId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The strength of the monitoring rule. The strength of a monitoring rule indicates the importance of the rule. Valid values:'."\n" - ."\n" - .'* 1: indicates that the monitoring rule is a strong rule.'."\n" - .'* 0: indicates that the monitoring rule is a weak rule. You can specify whether a monitoring rule is a strong rule based on your business requirements. If a monitoring rule is a strong rule and the critical threshold is exceeded, a critical alert is reported and nodes that are associated with the rule are blocked from running.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '1', - 'minimum' => '0', - 'enumValueTitles' => [], - 'example' => '0', - 'enum' => [ - '0', - '1', - ], - ], + 'schema' => ['description' => 'The DataWorks workspace ID. You can click the Workspace Manage icon in the upper-right corner of the DataStudio page to go to the Workspace page and query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '10000'], ], [ - 'name' => 'EntityId', + 'name' => 'ProjectIdentifier', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the partition filter expression. You can call the [ListQualityRules](~~173995~~) operation to obtain the ID of the partition filter expression.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123', - ], + 'schema' => ['description' => 'The unique identifier of the DataWorks workspace. You can view the identifier in the upper part of the DataStudio page. You can also select another identifier to switch to another workspace. You must configure either this parameter or the ProjectId parameter to determine the DataWorks workspace to which the operation is applied.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dw_project'], ], [ - 'name' => 'Comment', + 'name' => 'PageNumber', 'in' => 'formData', - 'schema' => [ - 'description' => 'The description of the monitoring rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Verify the number of table rows', - 'maxLength' => 512, - ], + 'schema' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1', 'example' => '1'], ], [ - 'name' => 'Checker', + 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => 'The checker ID. Valid values: 2: indicates that the current value is compared with the average value of the previous 7 days. 3: indicates that the current value is compared with the average value of the previous 30 days. 4: indicates that the current value is compared with the value 1 day earlier. 5: indicates that the current value is compared with the value 7 days earlier. 6: indicates that the current value is compared with the value 30 days earlier. 7: indicates the variance between the current value and the value 7 days earlier. 8: indicates the variance between the current value and the value 30 days earlier. 9: indicates that the current value is compared with a fixed value. 10: indicates that the current value is compared with the value 1, 7, or 30 days earlier. 11: indicates that the current value is compared with the value of the previous cycle. You can call the [ListQualityRules](~~173995~~) operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '9', - ], + 'schema' => ['description' => 'The number of entries per page. Maximum value: 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '0', 'example' => '50'], ], [ - 'name' => 'ExpectValue', + 'name' => 'Keyword', 'in' => 'formData', - 'schema' => [ - 'description' => 'The expected value of the monitoring rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '300', - 'maxLength' => 128, - ], + 'schema' => ['description' => 'The name of the node type. You can log on to the DataWorks console, go to the DataStudio page, and then view the name of a specific node type on the left side of the page. You can view the English or Chinese name of a specific node type, but the language specified to present the name must be the same as the language specified by the Locale parameter. Fuzzy match is supported. If this parameter is not configured, the names of all node types are returned.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ODPS SQ'], ], [ - 'name' => 'Id', + 'name' => 'Locale', 'in' => 'formData', + 'schema' => ['description' => 'The language that you use for the query. Valid values: zh-CN and en-US.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh-CN'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The monitoring rule ID. You can call the [ListQualityRules](~~173995~~) operation to query the ID of the monitoring rule.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1234', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0000-ABCD-EFG****'], + 'NodeTypeInfoList' => [ + 'description' => 'The list of node types.'."\n", + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '50'], + 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '127'], + 'NodeTypeInfo' => [ + 'description' => 'The information about a node type.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NodeTypeName' => ['description' => 'The name of the node type.'."\n", 'type' => 'string', 'example' => 'ODPS SQL'], + 'NodeType' => ['description' => 'The type of the node, which is specified by a number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + ], + ], + ], + ], + ], + ], + 'description' => '', ], ], + ], + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"NodeTypeInfoList\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 50,\\n \\"TotalCount\\": 127,\\n \\"NodeTypeInfo\\": [\\n {\\n \\"NodeTypeName\\": \\"ODPS SQL\\",\\n \\"NodeType\\": 10\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"0000-ABCD-EFG****\\n\\n 127\\n 50\\n 1\\n \\n ODPS SQL\\n 10\\n \\n","errorExample":""}]', + 'title' => 'GetNodeTypeListInfo', + 'summary' => 'Queries the information about node types, including the code and name of a node type.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'GetOpRiskData' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Trend', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The trend of the monitoring result. Valid values:'."\n" - ."\n" - .'* up: increasing'."\n" - .'* down: decreasing'."\n" - .'* abs: absolute value'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'up', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'MethodName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The method that is used to collect sample data, such as avg, count, sum, min, max, count_distinct, user_defined, table_count, table_size, table_dt_load_count, table_dt_refuseload_count, null_value, null_value/table_count, (table_count-count_distinct)/table_count, or table_count-count_distinct.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'table_count', - ], + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Maximum value: 1000.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '1000', 'minimum' => '1', 'example' => '100'], ], [ - 'name' => 'Operator', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The comparison operator, such as >, >=, =, ≠, <, or <=.'."\n" - ."\n" - .'> If you set the Checker parameter to 9, you must configure the Operator parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '>', - 'maxLength' => 128, - ], + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Pages start from 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '1000', 'minimum' => '1', 'example' => '1'], ], [ - 'name' => 'ProjectName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the compute engine or data source. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the name of the compute engine or data source.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'autotest', - ], + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The parameters that you can configure to query the access records. Valid values:'."\n" + ."\n" + .'* dbType'."\n" + .'* instanceName'."\n" + .'* databaseName'."\n" + .'* projectName'."\n" + .'* clusterName'."\n" + ."\n" + .'The following example shows the parameters configured to query the access records of the sensitive data in the abc database of the Hologres instance ABC: \\[ {"dbType":"hologres","instanceName":"ABC","databaseName":"abc"} ]'."\n" + ."\n" + .'You must configure the parameters based on the compute engine that you use in your business.'."\n", 'type' => 'string', 'required' => false, 'example' => '[ {"dbType":"hologres","instanceName":"ABC","databaseName":"abc"}, {"dbType":"ODPS.ODPS","projectName":"adbc"} ]'], ], [ - 'name' => 'Property', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the field.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'id', - 'maxLength' => 128, - 'minLength' => 1, - ], + 'name' => 'Date', + 'in' => 'query', + 'schema' => ['description' => 'The date on which access records were generated. Specify the value in the yyyyMMdd format.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '20210221'], ], [ - 'name' => 'PropertyType', - 'in' => 'formData', + 'name' => 'RiskType', + 'in' => 'query', + 'schema' => ['description' => 'The method that you use to identify risks.'."\n" + ."\n" + .'* You can manually identify risks.'."\n" + .'* You can also use a sensitive data identification rule to identify risks. You can log on to the DataWorks console and go to the Risk Identification Rules page in Data Security Guard to obtain the name of the rule.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Manual identification'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The data type of the field.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'bigint', - 'maxLength' => 128, + 'description' => 'The returned results.'."\n", + 'type' => 'object', + 'properties' => [ + 'RiskData' => ['description' => 'The information about the high-risk sensitive data. The information includes totalCount and opRiskDatas. opRiskDatas includes the following parameters:'."\n" + ."\n" + .'* sensType: the type of the sensitive data'."\n" + .'* sensLevel: the sensitivity level of the sensitive data'."\n" + .'* opType: the type of the operation'."\n" + .'* sql: the SQL statement that is executed'."\n" + .'* opAccount: the account that is used to perform the operation'."\n" + .'* opTime: the time when the operation was performed'."\n", 'type' => 'string', 'example' => '{'."\n" + .' "opRiskDatas": ['."\n" + .' {'."\n" + .' "riskType": "Hierarchical dimension, EMR engine dimension and project dimension, EMR engine project dimension operation data, export method dimension, EMR engine",'."\n" + .' "opTime": "2021-01-04 23:39:13",'."\n" + .' "opType": "SQL_SELECT",'."\n" + .' "opAccount": "user",'."\n" + .' "sensType": "Email/name/mobile phone number",'."\n" + .' "sql": "SELECT * FROM default.jiade_1219_test_create LIMIT 20"'."\n" + .' }'."\n" + .' ],'."\n" + .' "totalCount": 499'."\n" + .'}'], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0000-ABCD-EFG****'], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Invalid.Param', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'Forbidden.NoTenant', 'errorMessage' => 'The tenant information cannot be obtained using user ID.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.DQC.BizError', 'errorMessage' => 'An internal error occurred.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RiskData\\": \\"{ \\\\\\"opRiskDatas\\\\\\": [ { \\\\\\"riskType\\\\\\": \\\\\\"Hierarchical dimension, EMR engine dimension and project dimension, EMR engine project dimension operation data, export method dimension, EMR engine\\\\\\", \\\\\\"opTime\\\\\\": \\\\\\"2021-01-04 23:39:13\\\\\\", \\\\\\"opType\\\\\\": \\\\\\"SQL_SELECT\\\\\\", \\\\\\"opAccount\\\\\\": \\\\\\"user\\\\\\", \\\\\\"sensType\\\\\\": \\\\\\"Email/name/mobile phone number\\\\\\", \\\\\\"sql\\\\\\": \\\\\\"SELECT * FROM default.jiade_1219_test_create LIMIT 20\\\\\\" } ], \\\\\\"totalCount\\\\\\": 499 }\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 0000-ABCD-EFG****\\n { \\"opRiskDatas\\": [ { \\"riskType\\": \\"分级维度,EMR引擎维度and项目维度,EMR引擎项目维度的操作数据,导出方式维度,EMR引擎\\", \\"opTime\\": \\"2021-01-04 23:39:13\\", \\"opType\\": \\"SQL_SELECT\\", \\"opAccount\\": \\"user\\", \\"sensType\\": \\"邮箱/姓名/手机号\\", \\"sql\\": \\"SELECT * FROM default.jiade_1219_test_create LIMIT 20\\" } ], \\"totalCount\\": 499 }\\n","errorExample":""}]', + 'title' => 'GetOpRiskData', + 'summary' => 'Queries the records that are generated on a specified date for access to the high-risk sensitive data in all the DataWorks workspaces of a tenant.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetOpRiskData'], + ], + ], + 'ramActions' => [], + ], + 'GetOpSensitiveData' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'RuleType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Rule type:'."\n" - ."\n" - .'* 0: System template rule'."\n" - .'* 1: Custom SQL rule'."\n" - .'* 4: Custom template rule'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '99', - 'minimum' => '0', - 'example' => '0', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'WhereCondition', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The filter condition or custom SQL statement that is used for monitoring.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dt=$[yyyymmdd]', - ], + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The parameters that you can configure to query the access records. Valid values:'."\n" + ."\n" + .'* dbType'."\n" + .'* instanceName'."\n" + .'* databaseName'."\n" + .'* projectName'."\n" + .'* clusterName'."\n" + ."\n" + .'The following example shows the parameters configured to query the access records of the sensitive data in the abc database of the Hologres instance ABC: \\[ {"dbType":"hologres","instanceName":"ABC","databaseName":"abc"} ]'."\n" + ."\n" + .'You must configure the parameters based on the compute engine that you use in your business.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[ {"dbType":"hologres","instanceName":"ABC","databaseName":"abc"}, {"dbType":"ODPS.ODPS","projectName":"adbc"} ]'], ], [ - 'name' => 'CriticalThreshold', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The threshold for a critical alert. The threshold indicates the deviation of the monitoring result from the expected value. You can specify a custom value for the threshold based on your business requirements. If a monitoring rule is a strong rule and the critical threshold is exceeded, a critical alert is reported and tasks that are associated with the rule are blocked from running.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Minimum value: 1. Maximum value: 1000.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '1000', 'minimum' => '1', 'example' => '1'], ], [ - 'name' => 'WarningThreshold', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The threshold for a warning alert. The threshold specifies the deviation of the monitoring result from the expected value. You can specify a custom value for the threshold based on your business requirements.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5', - ], + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Valid values: 1 to 1000.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '1000', 'minimum' => '1', 'example' => '100'], ], [ - 'name' => 'TemplateId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the monitoring template. You can call the [ListQualityRules](~~173995~~) operation to obtain the ID of the monitoring template.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '7', - ], + 'name' => 'Date', + 'in' => 'query', + 'schema' => ['description' => 'The date on which access records were generated. Specify the value in the yyyyMMdd format.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '20210116'], ], [ - 'name' => 'RuleName', - 'in' => 'formData', + 'name' => 'OpType', + 'in' => 'query', + 'schema' => ['description' => 'The operation that is performed on the data. Valid values:'."\n" + ."\n" + .'* SQL_SELECT: specifies the data access operation. For example, execute a SELECT statement to query data.'."\n" + .'* TUNNEL_DOWNLOAD: specifies the data download operation. For example, run a Tunnel command to download data.'."\n", 'type' => 'string', 'required' => false, 'example' => 'SQL_SELECT'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The name of the monitoring rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123', - 'maxLength' => 255, - 'minLength' => 1, + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'OpSensitiveData' => ['description' => 'The information about the access records of the sensitive data. The information includes totalCount and opRiskDatas. opRiskDatas includes the following parameters:'."\n" + ."\n" + .'* sensType: the type of the sensitive data.'."\n" + .'* sensLevel: the sensitivity level of the sensitive data. A larger value indicates a higher sensitivity level.'."\n" + .'* opType: the type of the operation.'."\n" + .'* sql: the SQL statement that is executed.'."\n" + .'* opAccount: the account that is used to perform the operation.'."\n" + .'* opTime: the time when the operation was performed.'."\n", 'type' => 'string', 'example' => '"opSensDatas": [ { "sensLevel": "L4", "opTime": "2021-02-07 00:14:51", "opAccount": "ALIYUN$dsg_test", "sensType": "Mobile phone number", "sql": "select * from dsg_demo.tbl_phonebook where phone_no = '1331111****';" } ], "totalCount": 6'], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0000-ABCD-EFG****'], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Invalid.Param', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'Forbidden.NoTenant', 'errorMessage' => 'The tenant information cannot be obtained using user ID.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.DQC.BizError', 'errorMessage' => 'An internal error occurred.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"OpSensitiveData\\": \\"\\\\\\"opSensDatas\\\\\\": [ { \\\\\\"sensLevel\\\\\\": \\\\\\"L4\\\\\\", \\\\\\"opTime\\\\\\": \\\\\\"2021-02-07 00:14:51\\\\\\", \\\\\\"opAccount\\\\\\": \\\\\\"ALIYUN$dsg_test\\\\\\", \\\\\\"sensType\\\\\\": \\\\\\"Mobile phone number\\\\\\", \\\\\\"sql\\\\\\": \\\\\\"select * from dsg_demo.tbl_phonebook where phone_no = '1331111****';\\\\\\" } ], \\\\\\"totalCount\\\\\\": 6\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\"opSensDatas\\": [ { \\"sensLevel\\": \\"L4\\", \\"opTime\\": \\"2021-02-07 00:14:51\\", \\"opAccount\\": \\"ALIYUN$dsg_test\\", \\"sensType\\": \\"手机号\\", \\"sql\\": \\"select * from dsg_demo.tbl_phonebook where phone_no = &#39;1331111****&#39;;\\" } ], \\"totalCount\\": 6\\n 0000-ABCD-EFG****\\n","errorExample":""}]', + 'title' => 'GetOpSensitiveData', + 'summary' => 'Queries the records that are generated on a specified date for access to sensitive data in all the DataWorks workspaces of a tenant.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetOpSensitiveData'], + ], + ], + 'ramActions' => [], + ], + 'GetOptionValueForProject' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'PredictType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether the threshold is a dynamic threshold. Valid values:'."\n" - ."\n" - .'* 0: The threshold is not a dynamic threshold.'."\n" - .'* 2: The threshold is a dynamic threshold.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '99', - 'minimum' => '0', - 'example' => '0', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'OpenSwitch', + 'name' => 'ExtensionCode', 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether to enable the monitoring rule in the production environment. Valid values:'."\n" - ."\n" - .'* true: The monitoring rule is triggered when the associated auto triggered node that generates the output data starts to run.'."\n" - .'* false: The monitoring rule is not triggered when the associated auto triggered node that generates the output data starts to run.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'true', - ], + 'schema' => ['description' => 'The unique code of the extension.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ce4*********086da5'], ], [ 'name' => 'ProjectId', 'in' => 'formData', + 'schema' => ['description' => 'The workspace ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '234'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '26', + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'E6F0DBDD-5AD****'], + 'OptionValue' => ['description' => 'The data returned In the example, cuNumber is a custom key.'."\n", 'type' => 'string', 'example' => '{"cuNumber":"0"}'], + ], ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"OptionValue\\": \\"{\\\\\\"cuNumber\\\\\\":\\\\\\"0\\\\\\"}\\"\\n}","errorExample":""},{"type":"xml","example":"\\n E6F0DBDD-5AD****\\n {\\"cuNumber\\":\\"0\\"}\\n","errorExample":""}]', + 'title' => 'GetOptionValueForProject', + 'summary' => 'Queries the option settings of an extension in a workspace.', + 'changeSet' => [ + ['createdAt' => '2022-04-26T08:35:01.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetOptionValueForProject'], + ], + ], + 'ramActions' => [], + ], + 'GetPermissionApplyOrderDetail' => [ + 'summary' => 'Queries the details of a permission request order.'."\n" + ."\n" + .'Note: The 2020 version of OpenAPI will be discontinued. Please migrate to the 2024 version of OpenAPI as soon as possible — GetApplicationContents/GetProcessInstance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '78280', + 'abilityTreeNodes' => ['FEATUREdideGWNJ45'], + ], + 'parameters' => [ [ - 'name' => 'TaskSetting', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The variable settings inserted before the custom rule. Format: x=a,y=b.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'x=a,y=b', - ], + 'name' => 'FlowId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the permission request order. You can call the [ListPermissionApplyOrders](~~211008~~) operation to obtain the ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '48f36729-05f9-4a40-9286-933fd940****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The returned result.'."\n", + 'description' => 'The response structure.', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'Indicates whether the monitoring rule is updated.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'You have no permission.', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => '576b9457-2cf5-4****', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0bc1ec92159376****', 'title' => ''], + 'ApplyOrderDetail' => [ + 'description' => 'The details of the request order.', + 'type' => 'object', + 'properties' => [ + 'ApplyBaseId' => ['description' => 'The UID of the Alibaba Cloud account that submitted the request order.', 'type' => 'string', 'example' => '26784260040899****', 'title' => ''], + 'ApplyTimestamp' => ['description' => 'The time when the request order was submitted, displayed as a UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1615284086000', 'title' => ''], + 'FlowId' => ['description' => 'The ID of the request order.', 'type' => 'string', 'example' => 'ad8da78d-8135-455e-9486-27cf213f****', 'title' => ''], + 'FlowStatus' => ['description' => 'The status of the request order. Valid values:'."\n" + .'- 1: Pending approval.'."\n" + .'- 2: Approved and authorization succeeded.'."\n" + .'- 3: Approved but authorization failed.'."\n" + .'- 4: Rejected.'."\n" + .'- 5: Withdrawn.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'ApproveAccountList' => [ + 'description' => 'The list of Alibaba Cloud accounts that approved the request order.', + 'type' => 'array', + 'items' => [ + 'description' => 'The response structure.', + 'type' => 'object', + 'properties' => [ + 'BaseId' => ['description' => 'The UID of the Alibaba Cloud account that approved the request order.', 'type' => 'string', 'example' => '182293110403****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'GranteeObjectList' => [ + 'description' => 'The information about the accounts that requested permissions.', + 'type' => 'array', + 'items' => [ + 'description' => 'The response structure.', + 'type' => 'object', + 'properties' => [ + 'GranteeType' => ['description' => 'The type of the entity that requested permissions. Currently, only 1 (user) is supported.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'GranteeTypeSub' => ['description' => 'The subtype of the entity that requested permissions. Valid values:'."\n" + .'- 101: Production Alibaba Cloud account.'."\n" + .'- 103: Personal Alibaba Cloud account.'."\n" + .'- 105: Alibaba Cloud account applied on behalf of another user.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '103', 'title' => ''], + 'GranteeName' => ['description' => 'The name of the Alibaba Cloud account that requested permissions. The format is consistent with the MaxCompute account format.'."\n" + .'- Primary account: ALIYUN$+account name.'."\n" + .'- RAM user: RAM$+account name.', 'type' => 'string', 'example' => 'RAM$dataworks_3h1_1:StsRamUser(StsRamUser)', 'title' => ''], + 'GranteeId' => ['description' => 'The UID of the Alibaba Cloud account that requested permissions.', 'type' => 'string', 'example' => '26784260040899****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'ApproveContent' => [ + 'description' => 'The specific content of the request.', + 'type' => 'object', + 'properties' => [ + 'ApplyReason' => ['description' => 'The reason for the request, used as a reference for the administrator during approval.', 'type' => 'string', 'example' => 'I need to use this table', 'title' => ''], + 'Deadline' => ['description' => 'The expiration time of the requested permissions, displayed as a UNIX timestamp.'."\n" + .'If the MaxCompute project does not have LabelSecurity enabled, or the security level of the requested table field is 0 or less than or equal to the security level of the requesting account, only permanent permissions can be requested.', 'type' => 'integer', 'format' => 'int64', 'example' => '1617115071885', 'title' => ''], + 'OrderType' => ['description' => 'The type of the request order. Currently, only the value 1 is supported, indicating an object ACL permission request.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ProjectMeta' => [ + 'description' => 'The information about the project and workspace to which the requested object belongs.', + 'type' => 'object', + 'properties' => [ + 'MaxComputeProjectName' => ['description' => 'The MaxCompute project in which the requested object resides.', 'type' => 'string', 'example' => 'aMaxComputeProject', 'title' => ''], + 'WorkspaceId' => ['description' => 'The ID of the DataWorks workspace in which the requested object resides.', 'type' => 'integer', 'format' => 'int32', 'example' => '123456', 'title' => ''], + 'ObjectMetaList' => [ + 'description' => 'The detailed information about the requested objects.', + 'type' => 'array', + 'items' => [ + 'description' => 'The response structure.', + 'type' => 'object', + 'properties' => [ + 'ObjectName' => ['description' => 'The name of the requested table.', 'type' => 'string', 'example' => 'aTableName', 'title' => ''], + 'ColumnMetaList' => [ + 'description' => 'The column field information of the requested object.', + 'type' => 'array', + 'items' => [ + 'description' => 'The response structure.', + 'type' => 'object', + 'properties' => [ + 'ColumnName' => ['description' => 'The name of the requested column.', 'type' => 'string', 'example' => 'aColumnName', 'title' => ''], + 'ColumnComment' => ['description' => 'The description of the requested column.', 'type' => 'string', 'example' => 'Field description', 'title' => ''], + 'SecurityLevel' => ['description' => 'The security level of the requested column. Valid values: 0 to 9.', 'type' => 'string', 'example' => '9', 'title' => ''], + 'ColumnActions' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Actions' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'FinishAapprovalTimestamp' => ['description' => 'The time when the final approval was completed, displayed as a UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1757496687000', 'title' => ''], + 'FinishApprovalComment' => ['description' => 'The final approval comment.', 'type' => 'string', 'example' => 'agree', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"You have no permission.\\",\\n \\"RequestId\\": \\"576b9457-2cf5-4****\\",\\n \\"ErrorCode\\": \\"0\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n true\\n You have no permission.\\n 576b9457-2cf5-4****\\n 0\\n true\\n","errorExample":""}]', - 'title' => 'UpdateQualityRule', - 'summary' => 'Updates a monitoring rule.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc1ec92159376****\\",\\n \\"ApplyOrderDetail\\": {\\n \\"ApplyBaseId\\": \\"26784260040899****\\",\\n \\"ApplyTimestamp\\": 1615284086000,\\n \\"FlowId\\": \\"ad8da78d-8135-455e-9486-27cf213f****\\",\\n \\"FlowStatus\\": 2,\\n \\"ApproveAccountList\\": [\\n {\\n \\"BaseId\\": \\"182293110403****\\"\\n }\\n ],\\n \\"GranteeObjectList\\": [\\n {\\n \\"GranteeType\\": 1,\\n \\"GranteeTypeSub\\": 103,\\n \\"GranteeName\\": \\"RAM$dataworks_3h1_1:StsRamUser(StsRamUser)\\",\\n \\"GranteeId\\": \\"26784260040899****\\"\\n }\\n ],\\n \\"ApproveContent\\": {\\n \\"ApplyReason\\": \\"I need to use this table\\",\\n \\"Deadline\\": 1617115071885,\\n \\"OrderType\\": 1,\\n \\"ProjectMeta\\": {\\n \\"MaxComputeProjectName\\": \\"aMaxComputeProject\\",\\n \\"WorkspaceId\\": 123456,\\n \\"ObjectMetaList\\": [\\n {\\n \\"ObjectName\\": \\"aTableName\\",\\n \\"ColumnMetaList\\": [\\n {\\n \\"ColumnName\\": \\"aColumnName\\",\\n \\"ColumnComment\\": \\"Field description\\",\\n \\"SecurityLevel\\": \\"9\\",\\n \\"ColumnActions\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"Actions\\": [\\n \\"\\"\\n ]\\n }\\n ]\\n }\\n },\\n \\"FinishAapprovalTimestamp\\": 1757496687000,\\n \\"FinishApprovalComment\\": \\"agree\\"\\n }\\n}","type":"json"}]', + 'title' => 'Query the details of a permission request order', + 'description' => '**Note: The 2020 version of OpenAPI will be discontinued. Please migrate to the 2024 version of OpenAPI as soon as possible — [GetApplicationContents](https://help.aliyun.com/zh/dataworks/developer-reference/api-dataworks-public-2024-05-18-getapplicationcontents?spm=a2c4g.11186623.help-menu-72772.d_1_1_3_12_0_3.75985eba2pEw9l&scm=20140722.H_3040926._.OR_help-T_cn~zh-V_1)/[GetProcessInstance](https://help.aliyun.com/zh/dataworks/developer-reference/api-dataworks-public-2024-05-18-getprocessinstance?spm=a2c4g.11186623.help-menu-72772.d_1_1_3_12_0_4.64e62414k6cKri&scm=20140722.H_3040933._.OR_help-T_cn~zh-V_1).**', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'GetQualityRule' => [ - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2025-03-27T11:02:04.000Z', 'description' => 'Response parameters changed, Response parameters changed'], + ['createdAt' => '2022-04-28T07:44:35.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetProject' => [ + 'summary' => 'Queries the information about a DataWorks workspace.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -40411,50 +20972,17 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '78285', - 'abilityTreeNodes' => [ - 'FEATUREdide3WJOKE', - ], - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'RuleId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The monitoring rule ID. You can call the [ListQualityRules](~~173995~~) operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '1234', - ], - ], - [ - 'name' => 'ProjectName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the compute engine or data source.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'autotest', - ], + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the DataWorks workspace. You can call the [ListProjects](~~2780068~~) operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '466230', 'title' => ''], ], [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'example' => '12345', - ], + 'name' => 'ProjectIdentifier', + 'in' => 'query', + 'schema' => ['description' => 'The name of the DataWorks workspace. You can call the [ListProjects](~~2780068~~) operation to query the name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test_project', 'title' => ''], ], ], 'responses' => [ @@ -40463,1047 +20991,669 @@ 'description' => 'The returned result.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '576b9457-2cf5-4****', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'You have no permission.', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '401', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AFAE64E-D1BE-432B-A9****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'Information about the retrieved rule.'."\n", + 'description' => 'The information about the workspace.'."\n", 'type' => 'object', 'properties' => [ - 'BlockType' => [ - 'description' => 'The strength of the monitoring rule. The strength of a monitoring rule indicates the importance of the rule. Valid values:'."\n" - ."\n" - .'* 1: the monitoring rule is a strong rule.'."\n" - .'* 0: the monitoring rule is a weak rule. You can specify whether a monitoring rule is a strong rule based on your business requirements. If a monitoring rule is a strong rule and the critical threshold is exceeded, a critical alert is reported and tasks that are associated with the rule are blocked from running.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'OnDutyAccountName' => [ - 'description' => 'The name of the Alibaba Cloud account that is used to configure the monitoring rule.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'WarningThreshold' => [ - 'description' => 'The threshold for a warning alert. The threshold indicates the deviation of the check result from the expected value. You can customize this threshold based on your business requirements.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'Property' => [ - 'description' => 'The field whose data quality is checked based on the monitoring rule. This field is a column in the data source table that is monitored.'."\n", - 'type' => 'string', - 'example' => 'id', - ], - 'RuleType' => [ - 'description' => 'Rule type:'."\n" - ."\n" - .'* 0: System template rule'."\n" - .'* 1: Custom SQL rule'."\n" - .'* 4: Custom template rule'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Comment' => [ - 'description' => 'The description of the monitoring rule.'."\n", - 'type' => 'string', - 'example' => 'Verify that the primary key is unique', - ], - 'OnDuty' => [ - 'description' => 'The ID of the Alibaba Cloud account that is used to configure the monitoring rule.'."\n", - 'type' => 'string', - 'example' => '1822931****', - ], - 'Checker' => [ - 'description' => 'The checker ID. The value of this parameter corresponds to the ID at the frontend and is converted from the ID of the primary key.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '9', - ], - 'FixCheck' => [ - 'description' => 'Indicates whether the monitoring is performed based on a fixed value.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'MethodId' => [ - 'description' => 'The ID of the task that is associated with the partition filter expression.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8', - ], - 'CriticalThreshold' => [ - 'description' => 'The threshold for a critical alert. The threshold indicates the deviation of the check result from the expected value. You can specify a value for the threshold based on your business requirements. If a monitoring rule is a strong rule and the critical threshold is exceeded, a critical alert is reported and tasks that are associated with the rule are blocked from running.'."\n", - 'type' => 'string', - 'example' => '20', - ], - 'PredictType' => [ - 'description' => 'Indicates whether the threshold is a dynamic threshold. Valid values:'."\n" + 'Status' => ['description' => 'The status of the workspace. Valid values:'."\n" + ."\n" + .'* **0**: AVAILABLE, which indicates that the workspace runs as expected.'."\n" + .'* **1**: DELETED, which indicates that the workspace is deleted.'."\n" + .'* **2**: INITIALIZING, which indicates that the workspace is being initialized.'."\n" + .'* **3**: INIT_FAILED, which indicates that the workspace fails to be initialized.'."\n" + .'* **4**: FORBIDDEN, which indicates that the workspace is manually disabled.'."\n" + .'* **5**: DELETING, which indicates that the workspace is being deleted.'."\n" + .'* **6**: DEL_FAILED, which indicates that the workspace fails to be deleted.'."\n" + .'* **7**: FROZEN, which indicates that the workspace is frozen due to overdue payments.'."\n" + .'* **8**: UPDATING, which indicates that the workspace is being updated. The workspace enters this state after you associate a new compute engine with the workspace and the compute engine is initialized.'."\n" + .'* **9**: UPDATE_FAILED, which indicates that the workspace fails to be updated.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'MaxFlowNode' => ['description' => 'This parameter is deprecated.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ProjectId' => ['description' => 'The ID of the workspace.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '466230', 'title' => ''], + 'IsAllowDownload' => ['description' => 'Indicates whether you are allowed to download the query result from DataStudio. Valid values:'."\n" + ."\n" + .'* **1**: You are allowed to download the query result from DataStudio.'."\n" + .'* **0**: You are not allowed to download the query result from DataStudio.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ProjectMode' => ['description' => 'The mode of the workspace. Valid values:'."\n" + ."\n" + .'* **2**: The workspace is in basic mode.'."\n" + .'* **3**: The workspace is in standard mode.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'GmtModified' => ['description' => 'The time when the workspace was last modified. Example: `Dec 3, 2019 9:12:20 PM`.'."\n", 'type' => 'string', 'example' => 'Dec 3, 2019 9:12:20 PM', 'title' => ''], + 'ProdStorageQuota' => ['description' => 'This parameter is deprecated.'."\n", 'type' => 'string', 'example' => ' 1', 'title' => ''], + 'ProjectDescription' => ['description' => 'The description of the workspace.'."\n", 'type' => 'string', 'example' => 'test_describe', 'title' => ''], + 'DevelopmentType' => ['description' => 'This parameter is deprecated.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], + 'TablePrivacyMode' => ['description' => 'Indicates whether the MaxCompute tables in the workspace are visible to the users within a tenant. Valid values:'."\n" + ."\n" + .'* **0**: invisible'."\n" + .'* **1**: visible'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'DefaultDiResourceGroupIdentifier' => ['description' => 'The ID of the resource group that was allocated by default when you purchased an exclusive resource group for MaxCompute.'."\n", 'type' => 'string', 'example' => 'group_280749521****', 'title' => ''], + 'SchedulerMaxRetryTimes' => ['description' => 'The default maximum number of automatic reruns that are allowed after an error occurs.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'ProtectedMode' => ['description' => 'Indicates whether the workspace protection feature is enabled. Valid values:'."\n" + ."\n" + .'* **1**: enabled'."\n" + .'* **0**: disabled'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'SchedulerRetryInterval' => ['description' => 'The default interval between automatic reruns after an error occurs. Unit: milliseconds. The maximum interval is 30 minutes. You must pay attention to the conversion between units.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '120000', 'title' => ''], + 'Appkey' => ['description' => 'This parameter is deprecated.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], + 'DevStorageQuota' => ['description' => 'This parameter is deprecated.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], + 'ResidentArea' => ['description' => 'The type of the workspace. Valid values:'."\n" + ."\n" + .'* **private**'."\n" + .'* **swap**'."\n", 'type' => 'string', 'example' => 'private', 'title' => ''], + 'IsDefault' => ['description' => 'Indicates whether the workspace is a default workspace. Valid values:'."\n" + ."\n" + .'* **1**: The workspace is a default workspace.'."\n" + .'* **0**: The workspace is not a default workspace.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Destination' => ['description' => 'This parameter is deprecated.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ProjectName' => ['description' => 'The display name of the workspace.'."\n", 'type' => 'string', 'example' => 'test_project', 'title' => ''], + 'ProjectIdentifier' => ['description' => 'The name of the workspace.'."\n", 'type' => 'string', 'example' => 'test_project', 'title' => ''], + 'DisableDevelopment' => ['description' => 'Indicates whether the Develop role is disabled. Valid values:'."\n" + ."\n" + .'* **false** (default)'."\n" + .'* **true**'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ProjectOwnerBaseId' => ['description' => 'The ID of the Alibaba Cloud account used by the workspace owner.'."\n", 'type' => 'string', 'example' => '18229311****', 'title' => ''], + 'BaseProject' => ['description' => 'This parameter is deprecated.'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'UseProxyOdpsAccount' => ['description' => 'Indicates whether a proxy account is used to access the MaxCompute compute engine associated with the workspace.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'GmtCreate' => ['description' => 'The time when the workspace was created. Example: `Dec 3, 2019 9:12:20 PM`.'."\n", 'type' => 'string', 'example' => 'Oct 10, 2019 3:42:53 PM', 'title' => ''], + 'TenantId' => ['description' => 'The tenant ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '280749521', 'title' => ''], + 'EnvTypes' => [ + 'description' => 'The environment information of the workspace.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The environment of the workspace. Valid values: PROD and DEV.'."\n" ."\n" - .'* 0: The threshold is not a dynamic threshold.'."\n" - .'* 1: The threshold is a dynamic threshold.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'TemplateName' => [ - 'description' => 'The name of the monitoring template.'."\n", - 'type' => 'string', - 'example' => 'SQL task table rows, 1,7, 30 days fluctuation test', - ], - 'CheckerName' => [ - 'description' => 'The name of the checker.'."\n", - 'type' => 'string', - 'example' => 'compared with a fixed value', - ], - 'RuleName' => [ - 'description' => 'The name of the monitoring rule.'."\n", - 'type' => 'string', - 'example' => 'View table fluctuations', - ], - 'MethodName' => [ - 'description' => 'The method that is used to collect sample data, such as avg, count, sum, min, max, count_distinct, user_defined, table_count, table_size, table_dt_load_count, table_dt_refuseload_count, null_value, null_value/table_count, (table_count-count_distinct)/table_count, or table_count-count_distinct.'."\n", - 'type' => 'string', - 'example' => 'table_count', - ], - 'EntityId' => [ - 'description' => 'The ID of the partition filter expression.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '165523', - ], - 'WhereCondition' => [ - 'description' => 'The filter condition or custom SQL statement that is used for monitoring.'."\n", - 'type' => 'string', - 'example' => 'id>10', - ], - 'Operator' => [ - 'description' => 'The comparison operator of the monitoring rule.'."\n", - 'type' => 'string', - 'example' => '>=', - ], - 'ExpectValue' => [ - 'description' => 'The expected value.'."\n", - 'type' => 'string', - 'example' => '30', - ], - 'Trend' => [ - 'description' => 'The trend of the check result.'."\n", - 'type' => 'string', - 'example' => 'abs', - ], - 'TemplateId' => [ - 'description' => 'The ID of the monitoring template.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - ], - 'Id' => [ - 'description' => 'The monitoring rule ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123232', - ], - 'OpenSwitch' => [ - 'description' => 'Indicates whether the monitoring rule is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', + .'* The value **PROD** indicates the production environment. Workspaces in basic mode provide only the production environment.'."\n" + .'* The value **DEV** indicates the development environment. Workspaces in standard mode provide both the development environment and the production environment.'."\n", 'type' => 'string', 'example' => '["PROD"]', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'TaskSetting' => [ - 'description' => 'The variable settings inserted before the custom rule. Format: x=a,y=b.'."\n", - 'type' => 'string', - 'example' => 'x=a,y=b'."\n", + 'ResourceManagerResourceGroupId' => ['description' => 'The resource group ID.'."\n", 'type' => 'string', 'example' => 'rg-acfmzbn7****', 'title' => ''], + 'Tags' => [ + 'description' => 'The tags added to the workspace.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.'."\n", 'type' => 'string', 'example' => 'key', 'title' => ''], + 'Value' => ['description' => 'The tag value.'."\n", 'type' => 'string', 'example' => 'value', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"576b9457-2cf5-4****\\",\\n \\"ErrorMessage\\": \\"You have no permission.\\",\\n \\"ErrorCode\\": \\"401\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"BlockType\\": 1,\\n \\"OnDutyAccountName\\": \\"test\\",\\n \\"WarningThreshold\\": \\"10\\",\\n \\"Property\\": \\"id\\",\\n \\"RuleType\\": 0,\\n \\"Comment\\": \\"Verify that the primary key is unique\\",\\n \\"OnDuty\\": \\"1822931****\\",\\n \\"Checker\\": 9,\\n \\"FixCheck\\": true,\\n \\"MethodId\\": 8,\\n \\"CriticalThreshold\\": \\"20\\",\\n \\"PredictType\\": 0,\\n \\"TemplateName\\": \\"SQL task table rows, 1,7, 30 days fluctuation test\\",\\n \\"CheckerName\\": \\"compared with a fixed value\\",\\n \\"RuleName\\": \\"View table fluctuations\\",\\n \\"MethodName\\": \\"table_count\\",\\n \\"EntityId\\": 165523,\\n \\"WhereCondition\\": \\"id>10\\",\\n \\"Operator\\": \\">=\\",\\n \\"ExpectValue\\": \\"30\\",\\n \\"Trend\\": \\"abs\\",\\n \\"TemplateId\\": 7,\\n \\"Id\\": 123232,\\n \\"OpenSwitch\\": true,\\n \\"TaskSetting\\": \\"x=a,y=b\\\\n\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 576b9457-2cf5-4****\\n You have no permission.\\n 401\\n true\\n \\n 1\\n test\\n 10\\n id\\n 0\\n 校验主键唯一\\n 1822931****\\n 9\\n true\\n 8\\n 20\\n 0\\n SQL task table rows, 1,7, 30 days fluctuation test\\n compared with a fixed value\\n 查看表波动\\n table_count\\n 165523\\n id>10\\n >=\\n 30\\n abs\\n 7\\n 123232\\n true\\n \\n","errorExample":""}]', - 'title' => 'GetQualityRule', - 'summary' => 'Queries the information about a monitoring rule.', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Invalid.Tenant.ProjectNotExists', 'errorMessage' => 'The project does not exist.', 'description' => 'The project does not exist.'], + ['errorCode' => 'Invalid.Tenant.UserNotInProject', 'errorMessage' => 'The user is not in the project.', 'description' => 'The user is not in the project.'], + ], + 403 => [ + ['errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin', 'errorMessage' => 'The user is not a project administrator or owner.', 'description' => 'The user is not a project administrator or owner.'], + ['errorCode' => 'Invalid.Tenant.UserNotInTenant', 'errorMessage' => 'The user is not in tenant.', 'description' => 'The user is not in tenant.'], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetProject', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListQualityRules' => [ - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2023-09-19T03:31:49.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-11-07T02:16:27.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-10-31T02:42:13.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetProject'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"1AFAE64E-D1BE-432B-A9****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Status\\": 0,\\n \\"MaxFlowNode\\": 1,\\n \\"ProjectId\\": 466230,\\n \\"IsAllowDownload\\": 1,\\n \\"ProjectMode\\": 2,\\n \\"GmtModified\\": \\"Dec 3, 2019 9:12:20 PM\\",\\n \\"ProdStorageQuota\\": \\" 1\\",\\n \\"ProjectDescription\\": \\"test_describe\\",\\n \\"DevelopmentType\\": 4,\\n \\"TablePrivacyMode\\": 1,\\n \\"DefaultDiResourceGroupIdentifier\\": \\"group_280749521****\\",\\n \\"SchedulerMaxRetryTimes\\": 3,\\n \\"ProtectedMode\\": 1,\\n \\"SchedulerRetryInterval\\": 120000,\\n \\"Appkey\\": \\"0\\",\\n \\"DevStorageQuota\\": \\"0\\",\\n \\"ResidentArea\\": \\"private\\",\\n \\"IsDefault\\": 1,\\n \\"Destination\\": 0,\\n \\"ProjectName\\": \\"test_project\\",\\n \\"ProjectIdentifier\\": \\"test_project\\",\\n \\"DisableDevelopment\\": true,\\n \\"ProjectOwnerBaseId\\": \\"18229311****\\",\\n \\"BaseProject\\": false,\\n \\"UseProxyOdpsAccount\\": true,\\n \\"GmtCreate\\": \\"Oct 10, 2019 3:42:53 PM\\",\\n \\"TenantId\\": 280749521,\\n \\"EnvTypes\\": [\\n \\"[\\\\\\"PROD\\\\\\"]\\"\\n ],\\n \\"ResourceManagerResourceGroupId\\": \\"rg-acfmzbn7****\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"key\\",\\n \\"Value\\": \\"value\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'GetProjectDetail' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '78331', - 'abilityTreeNodes' => [ - 'FEATUREdide3WJOKE', - ], - ], + 'deprecated' => true, + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ - [ - 'name' => 'ProjectName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the compute engine or data source. You can obtain the name from data source configurations.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'autotest', - ], - ], - [ - 'name' => 'EntityId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the partition filter expression. You can call the [GetQualityEntity](~~174003~~) operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1234', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'minimum' => '1', - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 20.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '20', - 'minimum' => '1', - 'example' => '20', - ], - ], [ 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '12345', - ], + 'in' => 'query', + 'schema' => ['description' => 'The DataWorks workspace ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '27'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The returned result.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can troubleshoot errors based on the ID.'."\n", - 'type' => 'string', - 'example' => '38cbdef0-f6cf-49****', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'You have no permission.', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0bc1411515937635973****'], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true'], 'Data' => [ - 'description' => 'The list of retrieved rules.'."\n", + 'description' => 'The information about the workspace.'."\n", 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '400', - ], - 'Rules' => [ - 'description' => 'The details of the validation rule.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The returned result.'."\n", - 'type' => 'object', - 'properties' => [ - 'BlockType' => [ - 'description' => 'The strength of the monitoring rule. The strength of a monitoring rule indicates the importance of the rule. Valid values:'."\n" - ."\n" - .'* 1: The monitoring rule is a strong rule.'."\n" - .'* 0: The monitoring rule is a weak rule. You can specify the strength of a monitoring rule based on your business requirements. If a monitoring rule is a strong rule and the critical threshold is exceeded, a critical alert is reported and tasks that are associated with the rule are blocked from running.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'OnDutyAccountName' => [ - 'description' => 'The name of the Alibaba Cloud account that is used to configure the monitoring rule.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'Property' => [ - 'description' => 'The name of the field.'."\n", - 'type' => 'string', - 'example' => 'id', - ], - 'WarningThreshold' => [ - 'description' => 'The threshold for a warning alert. The threshold specifies the deviation of the monitoring result from the expected value. You can specify a custom value for the threshold based on your business requirements.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'TableName' => [ - 'description' => 'The name of the table.'."\n", - 'type' => 'string', - 'example' => 'dual', - ], - 'OnDuty' => [ - 'description' => 'The name of the Alibaba Cloud account that is used to configure the monitoring rule.'."\n", - 'type' => 'string', - 'example' => '1912****', - ], - 'Comment' => [ - 'description' => 'The description of the monitoring rule.'."\n", - 'type' => 'string', - 'example' => 'Verify table rules', - ], - 'RuleCheckerRelationId' => [ - 'description' => 'The ID of the task that is associated with the partition filter expression.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '132323', - ], - 'FixCheck' => [ - 'description' => 'Indicates whether the monitoring is performed based on a fixed value.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'MethodId' => [ - 'description' => 'The ID of the task that is associated with the partition filter expression.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '21', - ], - 'TemplateName' => [ - 'description' => 'The name of the monitoring template.'."\n", - 'type' => 'string', - 'example' => 'Number of SQL task table rows, 1, 7, and 30 days wave detection', - ], - 'Trend' => [ - 'description' => 'The trend of the monitoring result.'."\n", - 'type' => 'string', - 'example' => 'abs', - ], - 'HistoryWarningThreshold' => [ - 'description' => 'The historical threshold for a warning alert.'."\n", - 'type' => 'string', - 'example' => 'history max:40%,history min:10%', - ], - 'RuleType' => [ - 'description' => 'Rule type:'."\n" - ."\n" - .'* 0: System template rule'."\n" - .'* 1: Custom SQL rule'."\n" - .'* 1: Custom template rule'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'MatchExpression' => [ - 'description' => 'The partition filter expression.'."\n", - 'type' => 'string', - 'example' => 'dt=$[yyyymmdd]', - ], - 'ProjectName' => [ - 'description' => 'The name of the compute engine or data source.'."\n", - 'type' => 'string', - 'example' => 'autotest', - ], - 'PropertyKey' => [ - 'description' => 'The field that is used to associate with monitoring rules at the frontend. This parameter can be ignored.'."\n", - 'type' => 'string', - 'example' => 'table_count', - ], - 'CriticalThreshold' => [ - 'description' => 'The threshold for a critical alert. The threshold indicates the deviation of the monitoring result from the expected value. You can specify a custom value for the threshold based on your business requirements. If a monitoring rule is a strong rule and the critical threshold is exceeded, a critical alert is reported and tasks that are associated with the rule are blocked from running.'."\n", - 'type' => 'string', - 'example' => '40', - ], - 'HistoryCriticalThreshold' => [ - 'description' => 'The historical threshold for a critical alert.'."\n", - 'type' => 'string', - 'example' => 'history max:80%,history min:50%', - ], - 'MethodName' => [ - 'description' => 'The method that is used to collect sample data, such as avg, count, sum, min, max, count_distinct, user_defined, table_count, table_size, table_dt_load_count, table_dt_refuseload_count, null_value, null_value/table_count, (table_count-count_distinct)/table_count, or table_count-count_distinct.'."\n", - 'type' => 'string', - 'example' => 'count/table_count', - ], - 'CheckerId' => [ - 'description' => 'The checker ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - ], - 'EntityId' => [ - 'description' => 'The ID of the partition filter expression.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'ExpectValue' => [ - 'description' => 'The expected value.'."\n", - 'type' => 'string', - 'example' => '1000', - ], - 'TemplateId' => [ - 'description' => 'The ID of the monitoring template.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - ], - 'Id' => [ - 'description' => 'The monitoring rule ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'RuleName' => [ - 'title' => '规则名称', - 'description' => 'The name of the monitoring rule.'."\n", - 'type' => 'string', - 'example' => 'test', - ], + 'Status' => ['description' => 'The status of the workspace.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'ResidentArea' => ['description' => 'The type of the workspace. Valid values: private and swap.'."\n", 'type' => 'string', 'example' => 'private'], + 'ProjectId' => ['description' => 'The workspace ID.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '27'], + 'ProjectIdentifier' => ['description' => 'The unique identifier of the workspace.'."\n", 'type' => 'string', 'example' => 'abc'], + 'ProjectName' => ['description' => 'The display name of the workspace.'."\n", 'type' => 'string', 'example' => 'abc'], + 'IsAllowDownload' => ['description' => 'Indicates whether the download operation is allowed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ProjectMode' => ['description' => 'The mode of the workspace. The value 2 indicates that the workspace is in basic mode. The value 3 indicates that the workspace is in standard mode.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ProjectDescription' => ['description' => 'The description of the workspace.'."\n", 'type' => 'string', 'example' => 'abc'], + 'GmtModified' => ['description' => 'The time when the workspace was last modified.'."\n", 'type' => 'string', 'example' => 'Dec 3, 2019 9:12:20 PM'], + 'ProjectOwnerBaseId' => ['description' => 'The ID of the Alibaba Cloud account used by the workspace owner.'."\n", 'type' => 'string', 'example' => '18229311****'], + 'DevelopmentType' => ['description' => 'The development type of the workspace. The value is fixed to 4.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '4'], + 'DefaultDiResourceGroupIdentifier' => ['description' => 'The identifier of the shared resource group for Data Integration on which nodes are run.'."\n", 'type' => 'string', 'example' => 'group_280749521****'], + 'GmtCreate' => ['description' => 'The time when the workspace was created.'."\n", 'type' => 'string', 'example' => 'Oct 10, 2019 3:42:53 PM'], + 'SchedulerMaxRetryTimes' => ['description' => 'The default maximum number of automatic reruns that are allowed after an error occurs.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'ProtectedMode' => ['description' => 'Indicates whether the workspace protection feature is enabled.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'TenantId' => ['description' => 'The tenant ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '280749521950784'], + 'SchedulerRetryInterval' => ['description' => 'The interval between automatic reruns after an error occurs.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '120000'], + 'EnvTypes' => [ + 'description' => 'The environments of workspaces in different modes. Workspaces in basic mode provide only the production environment. Workspaces in standard mode provide both the development environment and the production environment.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The environment of the workspace in a different mode. Workspaces in basic mode provide only the production environment. Workspaces in standard mode provide both the development environment and the production environment.'."\n", 'type' => 'string', 'example' => '["PROD"]'], + ], + 'ResourceManagerResourceGroupId' => ['description' => 'The resource group ID.'."\n", 'type' => 'string', 'example' => 'rg-acfmzbn7pti3zfa'], + 'Tags' => [ + 'description' => 'The tag information.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.'."\n", 'type' => 'string', 'example' => 'Env'], + 'Value' => ['description' => 'The tag value.'."\n", 'type' => 'string', 'example' => 'Test'], ], ], ], + 'DisableDevelopment' => ['description' => 'Indicates whether the Develop role is disabled. Valid values:'."\n" + ."\n" + .'* **false** (default)'."\n" + .'* **true**'."\n", 'type' => 'boolean', 'example' => 'true'], + 'UseProxyOdpsAccount' => ['description' => 'Indicates whether a proxy account is used to access the MaxCompute compute engine.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'TablePrivacyMode' => ['description' => 'Indicates whether the MaxCompute tables in the workspace are visible to the users within a tenant. Valid values:'."\n" + ."\n" + .'* 0: The MaxCompute tables in the workspace are not visible to the users within a tenant.'."\n" + .'* 1: The MaxCompute tables in the workspace are visible to the users within a tenant.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'IsDefault' => ['description' => 'Indicates whether the workspace is a default workspace. Valid values:'."\n" + ."\n" + .'* 1: The workspace is a default workspace.'."\n" + .'* 0: The workspace is not a default workspace.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], ], ], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"38cbdef0-f6cf-49****\\",\\n \\"ErrorMessage\\": \\"You have no permission.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 400,\\n \\"Rules\\": [\\n {\\n \\"BlockType\\": 0,\\n \\"OnDutyAccountName\\": \\"test\\",\\n \\"Property\\": \\"id\\",\\n \\"WarningThreshold\\": \\"10\\",\\n \\"TableName\\": \\"dual\\",\\n \\"OnDuty\\": \\"1912****\\",\\n \\"Comment\\": \\"Verify table rules\\",\\n \\"RuleCheckerRelationId\\": 132323,\\n \\"FixCheck\\": true,\\n \\"MethodId\\": 21,\\n \\"TemplateName\\": \\"Number of SQL task table rows, 1, 7, and 30 days wave detection\\",\\n \\"Trend\\": \\"abs\\",\\n \\"HistoryWarningThreshold\\": \\"history max:40%,history min:10%\\",\\n \\"RuleType\\": 0,\\n \\"MatchExpression\\": \\"dt=$[yyyymmdd]\\",\\n \\"ProjectName\\": \\"autotest\\",\\n \\"PropertyKey\\": \\"table_count\\",\\n \\"CriticalThreshold\\": \\"40\\",\\n \\"HistoryCriticalThreshold\\": \\"history max:80%,history min:50%\\",\\n \\"MethodName\\": \\"count/table_count\\",\\n \\"CheckerId\\": 7,\\n \\"EntityId\\": 1234,\\n \\"ExpectValue\\": \\"1000\\",\\n \\"TemplateId\\": 7,\\n \\"Id\\": 1234,\\n \\"RuleName\\": \\"test\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 38cbdef0-f6cf-49****\\n You have no permission.\\n true\\n Invalid.Tenant.ConnectionNotExists\\n \\n 1\\n 20\\n 400\\n \\n 0\\n test\\n id\\n 10\\n dual\\n 1912****\\n 校验表规则\\n 132323\\n true\\n 21\\n sql任务表行数，1、7、30天波动检测\\n abs\\n history max:40%,history min:10%\\n 0\\n dt=$[yyyymmdd]\\n autotest\\n table_count\\n 40\\n history max:80%,history min:50%\\n count/table_count\\n 7\\n 1234\\n 1000\\n 7\\n 1234\\n test\\n \\n \\n","errorExample":""}]', - 'title' => 'ListQualityRules', - 'summary' => 'Queries monitoring rules based on a partition filter expression.', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Invalid.Tenant.ConnectionNotExists', 'errorMessage' => 'The connection does not exist.', 'description' => 'The connection does not exist.'], + ['errorCode' => 'Invalid.Tenant.ProjectNotExists', 'errorMessage' => 'The project does not exist.', 'description' => 'The project does not exist.'], + ['errorCode' => 'Invalid.Tenant.UserNotInProject', 'errorMessage' => 'The user is not in the project.', 'description' => 'The user is not in the project.'], + ], + 403 => [ + ['errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin', 'errorMessage' => 'The user is not a project administrator or owner.', 'description' => 'The user is not a project administrator or owner.'], + ['errorCode' => 'Invalid.Tenant.UserNotInTenant', 'errorMessage' => 'The user is not in tenant.', 'description' => 'The user is not in tenant.'], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0bc1411515937635973****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Status\\": 0,\\n \\"ResidentArea\\": \\"private\\",\\n \\"ProjectId\\": 27,\\n \\"ProjectIdentifier\\": \\"abc\\",\\n \\"ProjectName\\": \\"abc\\",\\n \\"IsAllowDownload\\": 1,\\n \\"ProjectMode\\": 1,\\n \\"ProjectDescription\\": \\"abc\\",\\n \\"GmtModified\\": \\"Dec 3, 2019 9:12:20 PM\\",\\n \\"ProjectOwnerBaseId\\": \\"18229311****\\",\\n \\"DevelopmentType\\": 4,\\n \\"DefaultDiResourceGroupIdentifier\\": \\"group_280749521****\\",\\n \\"GmtCreate\\": \\"Oct 10, 2019 3:42:53 PM\\",\\n \\"SchedulerMaxRetryTimes\\": 3,\\n \\"ProtectedMode\\": 1,\\n \\"TenantId\\": 280749521950784,\\n \\"SchedulerRetryInterval\\": 120000,\\n \\"EnvTypes\\": [\\n \\"[\\\\\\"PROD\\\\\\"]\\"\\n ],\\n \\"ResourceManagerResourceGroupId\\": \\"rg-acfmzbn7pti3zfa\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"Env\\",\\n \\"Value\\": \\"Test\\"\\n }\\n ],\\n \\"DisableDevelopment\\": true,\\n \\"UseProxyOdpsAccount\\": true,\\n \\"TablePrivacyMode\\": 1,\\n \\"IsDefault\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n \\n false\\n group_280749521****\\n 28\\n 64\\n 4\\n false\\n PROD\\n Oct 10, 2019 3:42:53 PM\\n Dec 3, 2019 9:12:20 PM\\n 1\\n 0\\n 30\\n 64\\n 27\\n abc\\n 2\\n abc\\n 18229311****\\n 1\\n private\\n 3\\n 120000\\n 0\\n 0\\n 280749521950784\\n false\\n\\n200\\n0bc1ec9b15973****\\ntrue","errorExample":""}]', + 'title' => 'GetProjectDetail', + 'summary' => 'Queries the information about a DataWorks workspace.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateQualityRule' => [ - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2022-10-31T02:41:28.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetProjectDetail'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetProjectDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'DataWorks', 'resourceType' => 'Project', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:workspace/{#ProjectIdentifier}'], + ], + ], + ], ], + ], + 'GetQualityEntity' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, + 'operationType' => 'read', + 'deprecated' => true, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '78195', - 'abilityTreeNodes' => [ - 'FEATUREdide3WJOKE', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '78283', + 'abilityTreeNodes' => ['FEATUREdide3WJOKE'], ], 'parameters' => [ [ - 'name' => 'BlockType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The strength type of the monitoring rule. Valid values:'."\n" - ."\n" - .'* 0: The monitoring rule is a weak rule.'."\n" - .'* 1: The monitoring rule is a strong rule.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '1', - 'minimum' => '0', - 'example' => '0', - ], - ], - [ - 'name' => 'EntityId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the partition filter expression.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '15224', - ], - ], - [ - 'name' => 'Comment', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The description of the rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Verification', - 'maxLength' => 128, - 'minLength' => 1, - ], - ], - [ - 'name' => 'Checker', + 'name' => 'ProjectName', 'in' => 'formData', - 'schema' => [ - 'description' => 'The checker ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'minimum' => '1', - 'example' => '9', - ], + 'schema' => ['description' => 'The name of the engine or data source. You can find this name on the Data Source Configuration page.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'maxLength' => 1024, 'minLength' => 1, 'example' => 'autotest', 'title' => ''], ], [ - 'name' => 'ExpectValue', + 'name' => 'TableName', 'in' => 'formData', - 'schema' => [ - 'description' => 'The expected value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => 'The name of the partitioned table. You can call the [GetMetaTablePartition](~~173923~~) operation to get the table name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'maxLength' => 128, 'minLength' => 1, 'example' => 'dual', 'title' => ''], ], [ - 'name' => 'Trend', + 'name' => 'EnvType', 'in' => 'formData', 'schema' => [ - 'description' => 'The trend of the monitoring result. Valid values:'."\n" + 'description' => 'The type of the engine or data source. Valid values:'."\n" ."\n" - .'* up: increasing'."\n" - .'* down: decreasing'."\n" - .'* abs: absolute value'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abs', - ], - ], - [ - 'name' => 'MethodName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The method used to collect sample data. If you want to use a custom SQL statement as a sampling method, set this parameter to user_defined.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'count/table_count', - ], - ], - [ - 'name' => 'Operator', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The comparison operator, such as >, >=, =, ≠, <, or <=.'."\n" + .'- `cdh`'."\n" ."\n" - .'> If you set the Checker parameter to 9, you must configure the Operator parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '>', - ], - ], - [ - 'name' => 'ProjectName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the compute engine or data source.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'autotest', - ], - ], - [ - 'name' => 'Property', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The fields that you want to monitor. If you want to monitor all fields in a table and check the table rows, set this parameter to table_count. If you want to monitor all fields in a table and check the table size, set this parameter to table_size.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'table_id', - 'maxLength' => 128, - ], - ], - [ - 'name' => 'PropertyType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The data type of the fields that you want to monitor. If you want to monitor all fields in a table, set this parameter to table. If you want to monitor only a specific field, set this parameter to bigint.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'bigint', - ], - ], - [ - 'name' => 'RuleType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Rule type:'."\n" + .'- `analyticdb_for_mysql`'."\n" ."\n" - .'* 0: System template rule'."\n" - .'* 1: Custom SQL rule'."\n" - .'* 4: Custom template rule'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '99', - 'minimum' => '0', - 'example' => '0', - ], - ], - [ - 'name' => 'WhereCondition', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The filter condition or custom SQL statement.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'table_id>1', - ], - ], - [ - 'name' => 'CriticalThreshold', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The threshold for a critical alert. The threshold indicates the deviation of the monitoring result from the expected value. You can customize this threshold based on your business requirements. If a strong rule is used and a critical alert is triggered, nodes are blocked.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '20', - ], - ], - [ - 'name' => 'WarningThreshold', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The threshold for a warning alert. The threshold indicates the deviation of the monitoring result from the expected value. You can customize this threshold based on your business requirements.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'TemplateId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The template ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '7', - ], - ], - [ - 'name' => 'RuleName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the monitoring rule.'."\n", + .'- `odps`'."\n" + ."\n" + .'- `emr`'."\n" + ."\n" + .'- `hadoop`'."\n" + ."\n" + .'- `holodb`'."\n" + ."\n" + .'- `hybriddb_for_postgresql`', + 'enumValueTitles' => [], 'type' => 'string', 'required' => true, 'docRequired' => true, - 'example' => '1234', - 'maxLength' => 128, + 'maxLength' => 64, + 'minLength' => 1, + 'example' => 'odps', + 'title' => '', ], ], [ - 'name' => 'PredictType', + 'name' => 'MatchExpression', 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether the monitoring rule is a dynamic threshold rule. Valid values: 0 and 2. The value 0 indicates that the monitoring rule is not a dynamic threshold rule. The value 2 indicates that the monitoring rule is a dynamic threshold rule.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '99', - 'minimum' => '0', - 'example' => '0', - ], + 'schema' => ['description' => 'The partition expression.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'maxLength' => 128, 'minLength' => 1, 'example' => 'dt=$[yyyymmdd]', 'title' => ''], ], [ 'name' => 'ProjectId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '10000', - ], - ], - [ - 'name' => 'TaskSetting', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The variable settings inserted before the custom rule. Format: x=a,y=b.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'x=a,y=b', - ], + 'schema' => ['description' => 'The ID of the DataWorks workspace. To find the workspace ID, log in to the [DataWorks Console](https://workbench.data.aliyun.com/console) and go to the Workspace Configurations page.', 'type' => 'integer', 'format' => 'int64', 'docRequired' => true, 'required' => true, 'example' => '123456', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6d739ef6-098a-47****', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'You have no permission.', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '401', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request succeeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'The ID of the monitoring rule that you created.'."\n", - 'type' => 'string', - 'example' => '12345', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'You have no permission.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ecb967ec-c137-48****', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '401', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'description' => 'The data returned.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the data.', + 'type' => 'object', + 'properties' => [ + 'RelativeNode' => ['description' => 'The scheduling node that is associated with the partition filter expression. This parameter includes the following sub-parameters:'."\n" + ."\n" + .'- ProjectName: The name of the workspace to which the scheduling node belongs.'."\n" + ."\n" + .'- NodeID: The ID of the scheduling node.', 'type' => 'string', 'example' => '[{"projectName":"xc_DP****","nodeId":7000026****}]', 'title' => ''], + 'OnDutyAccountName' => ['description' => 'The name of the Alibaba Cloud account of the owner.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'Task' => ['description' => 'The task node.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'TableName' => ['description' => 'The name of the partitioned table.', 'type' => 'string', 'example' => 'test_dqc_de****', 'title' => ''], + 'Followers' => ['description' => 'The subscribers who receive alert notifications. The value is the ID of an Alibaba Cloud account.', 'type' => 'string', 'example' => '1822931****', 'title' => ''], + 'OnDuty' => ['description' => 'The owner who configures the partition filter expression. The value is the ID of an Alibaba Cloud account.', 'type' => 'string', 'example' => '1822931****', 'title' => ''], + 'MatchExpression' => ['description' => 'The partition filter expression.', 'type' => 'string', 'example' => 'dt=$[yyyymmdd-1]', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the partition filter expression was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1593964800000', 'title' => ''], + 'ProjectName' => ['description' => 'The name of the engine or data source.', 'type' => 'string', 'example' => 'autotest', 'title' => ''], + 'HasRelativeNode' => ['description' => 'Indicates whether the partition filter expression is associated with a scheduling node. Valid values:'."\n" + ."\n" + .'- true: The partition filter expression is associated with a scheduling node.'."\n" + ."\n" + .'- false: The partition filter expression is not associated with a scheduling node.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'EnvType' => ['description' => 'The type of the engine or data source.', 'type' => 'string', 'example' => 'odps', 'title' => ''], + 'EntityLevel' => ['description' => 'The level of the partition filter expression. Valid values:'."\n" + ."\n" + .'- 0 (SQL-level): A data quality check is triggered after each SQL statement is run.'."\n" + ."\n" + .'- 1 (Task-level): A data quality check is triggered after all SQL statements are run.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ModifyUser' => ['description' => 'The user who updates the partition filter expression. The value is the ID of an Alibaba Cloud account.', 'type' => 'string', 'example' => '1822931****', 'title' => ''], + 'Sql' => ['description' => 'The SQL-level partition filter expression.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Id' => ['description' => 'The ID of the partition filter expression.', 'type' => 'integer', 'format' => 'int64', 'example' => '4003918', 'title' => ''], + 'ModifyTime' => ['description' => 'The time when the partition filter expression was last updated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1593964800000', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"12345\\",\\n \\"ErrorMessage\\": \\"You have no permission.\\",\\n \\"RequestId\\": \\"ecb967ec-c137-48****\\",\\n \\"ErrorCode\\": \\"401\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 12345\\n You have no permission.\\n ecb967ec-c137-48****\\n 401\\n true\\n","errorExample":""}]', - 'title' => 'CreateQualityRule', - 'summary' => 'Creates a monitoring rule.', + 'staticInfo' => [ + 'substitutions' => ['dataworks-public::2024-05-18::GetDataQualityScan'], + ], + 'title' => 'GetQualityEntity', + 'summary' => 'Call `GetQualityEntity` to retrieve the partition expression.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteQualityFollower' => [ - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2024-01-22T02:34:47.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-07-11T08:00:39.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-03-08T07:46:00.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2021-11-23T03:58:45.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"6d739ef6-098a-47****\\",\\n \\"ErrorMessage\\": \\"You have no permission.\\",\\n \\"ErrorCode\\": \\"401\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"RelativeNode\\": \\"[{\\\\\\"projectName\\\\\\":\\\\\\"xc_DP****\\\\\\",\\\\\\"nodeId\\\\\\":7000026****}]\\",\\n \\"OnDutyAccountName\\": \\"test\\",\\n \\"Task\\": 0,\\n \\"TableName\\": \\"test_dqc_de****\\",\\n \\"Followers\\": \\"1822931****\\",\\n \\"OnDuty\\": \\"1822931****\\",\\n \\"MatchExpression\\": \\"dt=$[yyyymmdd-1]\\",\\n \\"CreateTime\\": 1593964800000,\\n \\"ProjectName\\": \\"autotest\\",\\n \\"HasRelativeNode\\": true,\\n \\"EnvType\\": \\"odps\\",\\n \\"EntityLevel\\": 0,\\n \\"ModifyUser\\": \\"1822931****\\",\\n \\"Sql\\": 0,\\n \\"Id\\": 4003918,\\n \\"ModifyTime\\": 1593964800000\\n }\\n ]\\n}","type":"json"}]', + ], + 'GetQualityFollower' => [ + 'summary' => 'Retrieves the followers of a Partition Expression.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, + 'operationType' => 'read', + 'deprecated' => true, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '78214', - 'abilityTreeNodes' => [ - 'FEATUREdideGJ7UNJ', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '78284', + 'abilityTreeNodes' => ['FEATUREdideGJ7UNJ'], ], 'parameters' => [ [ 'name' => 'ProjectName', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the compute engine or data source for which the partition filter expression is configured. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the rule configuration page of Data Quality page to obtain the name.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'autotest', - ], + 'schema' => ['description' => 'The name of the engine or data source.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'autotest', 'title' => ''], ], [ - 'name' => 'FollowerId', + 'name' => 'EntityId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the subscription relationship between the partition filter expression and the subscriber. You can call the [GetQualityFollower](~~174000~~) operation to obtain the ID of the subscription relationship.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1234', - ], + 'schema' => ['description' => 'The ID of the partition expression.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '12345', 'title' => ''], ], [ 'name' => 'ProjectId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to obtain the workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10000', - ], + 'schema' => ['description' => 'The ID of the DataWorks workspace.', 'type' => 'integer', 'format' => 'int64', 'docRequired' => true, 'required' => true, 'example' => '27', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The returned result.'."\n", + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '38cbdef0-f6cf-49', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'You have no permission.', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], 'Data' => [ - 'description' => 'Indicates whether the subscriber was successfully deleted. Valid values:'."\n" - ."\n" - .'* true: The subscriber was successfully deleted.'."\n" - .'* false: The subscriber failed to be deleted. You can troubleshoot errors based on the error message returned.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned when the subscriber failed to be deleted.'."\n", - 'type' => 'string', - 'example' => 'You have no permission.', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can troubleshoot errors based on the ID.'."\n", - 'type' => 'string', - 'example' => '6d739ef6-098a-47****', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '401', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'description' => 'An array of follower objects.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of a follower.', + 'type' => 'object', + 'properties' => [ + 'FollowerAccountName' => ['description' => 'The Alibaba Cloud account name of the follower.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'TableName' => ['description' => 'The name of the partitioned table.', 'type' => 'string', 'example' => 'dual', 'title' => ''], + 'AlarmMode' => ['description' => 'The alarm notification method. Valid values:'."\n" + ."\n" + .'- 1: by email'."\n" + ."\n" + .'- 2: by email and SMS'."\n" + ."\n" + .'- 4: by DingTalk chatbot or webhook'."\n" + ."\n" + .'- 5: by DingTalk chatbot with the @all keyword', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'EntityId' => ['description' => 'The ID of the partition expression.', 'type' => 'string', 'example' => '1234', 'title' => ''], + 'ProjectName' => ['description' => 'The name of the engine or data source.', 'type' => 'string', 'example' => 'autotest', 'title' => ''], + 'Id' => ['description' => 'The subscription ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'Follower' => ['description' => 'The follower who receives alarm notifications.', 'type' => 'string', 'example' => '1234', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the subscription was created. This value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1541576644000', 'title' => ''], + 'ModifyTime' => ['description' => 'The time when the subscription was last updated. This value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1541576644000', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"You have no permission.\\",\\n \\"RequestId\\": \\"6d739ef6-098a-47****\\",\\n \\"ErrorCode\\": \\"401\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n true\\n You have no permission.\\n 6d739ef6-098a-47****\\n 401\\n true\\n","errorExample":""}]', - 'title' => 'DeleteQualityFollower', - 'summary' => 'Deletes a subscriber of a partition filter expression.', - 'description' => 'In Data Quality, you must configure monitoring rules based on a partition filter expression. Data Quality uses these rules to detect changes in source data and dirty data generated during the process of extract, transform, and load (ETL). This way, you can prevent tasks from producing unexpected dirty data that affects the smooth running of tasks and business decision-making. You can go to the Manage Subscriptions page to add subscribers for a partition filter expression. When the monitoring rule that is created based on the partition filter expression is triggered, the subscribers can receive notifications and troubleshoot errors at the earliest opportunity. For more information, see [Configure monitoring rules](~~73690~~).'."\n", + 'staticInfo' => [ + 'substitutions' => ['dataworks-public::2024-05-18::GetDataQualityAlertRule'], + ], + 'title' => 'GetQualityFollower', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteQualityRule' => [ - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2024-01-22T02:34:47.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-07-11T11:40:27.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-03-08T07:46:00.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-03-15T06:07:23.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"38cbdef0-f6cf-49\\",\\n \\"ErrorMessage\\": \\"You have no permission.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Data\\": [\\n {\\n \\"FollowerAccountName\\": \\"test\\",\\n \\"TableName\\": \\"dual\\",\\n \\"AlarmMode\\": 1,\\n \\"EntityId\\": \\"1234\\",\\n \\"ProjectName\\": \\"autotest\\",\\n \\"Id\\": 123,\\n \\"Follower\\": \\"1234\\",\\n \\"CreateTime\\": 1541576644000,\\n \\"ModifyTime\\": 1541576644000\\n }\\n ]\\n}","type":"json"}]', + ], + 'GetQualityRule' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, + 'operationType' => 'read', + 'deprecated' => true, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '78216', - 'abilityTreeNodes' => [ - 'FEATUREdide3WJOKE', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '78285', + 'abilityTreeNodes' => ['FEATUREdide3WJOKE'], ], 'parameters' => [ [ - 'name' => 'ProjectName', + 'name' => 'RuleId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the compute engine or data source.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'autotest', - ], + 'schema' => ['description' => 'The ID of the quality rule. You can call the [ListQualityRules](~~173995~~) operation to obtain the ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1234', 'title' => ''], ], [ - 'name' => 'RuleId', + 'name' => 'ProjectName', 'in' => 'formData', - 'schema' => [ - 'description' => 'The monitoring rule ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1234', - ], + 'schema' => ['description' => 'The name of the engine or data source.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'autotest', 'title' => ''], ], [ 'name' => 'ProjectId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '10000', - ], + 'schema' => ['description' => 'The ID of the DataWorks workspace.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '12345', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'description' => 'The response data structure.', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '576b9457-2cf5-4****', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'You have no permission.', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '401', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'Indicates whether the monitoring rule was deleted.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'You have no permission.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '6d739ef6-098a-47****', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '401', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'description' => 'The quality rule details.', + 'type' => 'object', + 'properties' => [ + 'BlockType' => ['description' => 'The severity of the quality rule. Valid values:'."\n" + ."\n" + .'- `1`: Strong Rule. If a Strong Rule triggers a critical Alert, the associated Scheduling Task is blocked.'."\n" + ."\n" + .'- `0`: Weak Rule.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'OnDutyAccountName' => ['description' => 'The name of the Alibaba Cloud account that configured the rule.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'WarningThreshold' => ['description' => 'The threshold for a warning Alert. This value specifies the acceptable deviation from the Expected Value and can be customized.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'Property' => ['description' => 'The column in the data source table to which the rule applies.', 'type' => 'string', 'example' => 'id', 'title' => ''], + 'RuleType' => ['description' => 'The type of the quality rule. Valid values:'."\n" + ."\n" + .'- `0`: A rule based on a system template.'."\n" + ."\n" + .'- `1`: A rule based on a custom SQL statement.'."\n" + ."\n" + .'- `4`: A rule based on a custom template.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Comment' => ['description' => 'The comment for the rule.', 'type' => 'string', 'example' => 'Verify that the primary key is unique', 'title' => ''], + 'OnDuty' => ['description' => 'The ID of the Alibaba Cloud account that configured the rule.', 'type' => 'string', 'example' => '1822931****', 'title' => ''], + 'Checker' => ['description' => 'The checker ID, which is derived from a primary key and used for front-end identification.', 'type' => 'integer', 'format' => 'int32', 'example' => '9', 'title' => ''], + 'FixCheck' => ['description' => 'Indicates whether to validate against a fixed value.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'MethodId' => ['description' => 'The ID of the method used to collect sample data.', 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'title' => ''], + 'CriticalThreshold' => ['description' => 'The threshold for a critical Alert, which defines the maximum acceptable deviation from the Expected Value. If this threshold is met for a Strong Rule, the associated Scheduling Task is blocked.', 'type' => 'string', 'example' => '20', 'title' => ''], + 'PredictType' => ['description' => 'Indicates whether the threshold is dynamic. Valid values:'."\n" + ."\n" + .'- `0`: The threshold is static.'."\n" + ."\n" + .'- `1`: The threshold is dynamic.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'TemplateName' => ['description' => 'The name of the template used.', 'type' => 'string', 'example' => 'SQL task table rows, 1,7, 30 days fluctuation test', 'title' => ''], + 'CheckerName' => ['description' => 'The name of the checker.', 'type' => 'string', 'example' => 'compared with a fixed value', 'title' => ''], + 'RuleName' => ['description' => 'The name of the rule.', 'type' => 'string', 'example' => 'View table fluctuations', 'title' => ''], + 'MethodName' => ['description' => 'The name of the method used to collect sample data. Valid values include `avg`, `count`, `sum`, `min`, `max`, `count_distinct`, `user_defined`, `table_count`, `table_size`, `table_dt_load_count`, `table_dt_refuseload_count`, `null_value`, `null_value/table_count`, `(table_count-count_distinct)/table_count`, and `table_count-count_distinct`.', 'type' => 'string', 'example' => 'table_count', 'title' => ''], + 'EntityId' => ['description' => 'The ID of the partition expression.', 'type' => 'integer', 'format' => 'int64', 'example' => '165523', 'title' => ''], + 'WhereCondition' => ['description' => 'The filter condition or custom SQL statement used for validation.', 'type' => 'string', 'example' => 'id>10', 'title' => ''], + 'Operator' => ['description' => 'The comparison operator.', 'type' => 'string', 'example' => '>=', 'title' => ''], + 'ExpectValue' => ['description' => 'The expected value.', 'type' => 'string', 'example' => '30', 'title' => ''], + 'Trend' => ['description' => 'The trend of the validation result.', 'type' => 'string', 'example' => 'abs', 'title' => ''], + 'TemplateId' => ['description' => 'The ID of the template used.', 'type' => 'integer', 'format' => 'int32', 'example' => '7', 'title' => ''], + 'Id' => ['description' => 'The ID of the rule.', 'type' => 'integer', 'format' => 'int64', 'example' => '123232', 'title' => ''], + 'OpenSwitch' => ['description' => 'Indicates whether the rule is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'TaskSetting' => ['description' => 'The variable settings inserted before a custom rule. The format is x=a,y=b.', 'type' => 'string', 'example' => 'x=a,y=b'."\n", 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"You have no permission.\\",\\n \\"RequestId\\": \\"6d739ef6-098a-47****\\",\\n \\"ErrorCode\\": \\"401\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n true\\n You have no permission.\\n 6d739ef6-098a-47****\\n 401\\n true\\n","errorExample":""}]', - 'title' => 'DeleteQualityRule', - 'summary' => 'Deletes a monitoring rule.', + 'staticInfo' => [ + 'substitutions' => ['dataworks-public::2024-05-18::GetDataQualityScan'], + ], + 'title' => 'GetQualityRule', + 'summary' => 'Gets information about a quality rule.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'GetQualityFollower' => [ - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2024-06-18T06:52:24.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-08-29T02:36:21.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-03-08T07:46:00.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"576b9457-2cf5-4****\\",\\n \\"ErrorMessage\\": \\"You have no permission.\\",\\n \\"ErrorCode\\": \\"401\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"BlockType\\": 1,\\n \\"OnDutyAccountName\\": \\"test\\",\\n \\"WarningThreshold\\": \\"10\\",\\n \\"Property\\": \\"id\\",\\n \\"RuleType\\": 0,\\n \\"Comment\\": \\"Verify that the primary key is unique\\",\\n \\"OnDuty\\": \\"1822931****\\",\\n \\"Checker\\": 9,\\n \\"FixCheck\\": true,\\n \\"MethodId\\": 8,\\n \\"CriticalThreshold\\": \\"20\\",\\n \\"PredictType\\": 0,\\n \\"TemplateName\\": \\"SQL task table rows, 1,7, 30 days fluctuation test\\",\\n \\"CheckerName\\": \\"compared with a fixed value\\",\\n \\"RuleName\\": \\"View table fluctuations\\",\\n \\"MethodName\\": \\"table_count\\",\\n \\"EntityId\\": 165523,\\n \\"WhereCondition\\": \\"id>10\\",\\n \\"Operator\\": \\">=\\",\\n \\"ExpectValue\\": \\"30\\",\\n \\"Trend\\": \\"abs\\",\\n \\"TemplateId\\": 7,\\n \\"Id\\": 123232,\\n \\"OpenSwitch\\": true,\\n \\"TaskSetting\\": \\"x=a,y=b\\\\n\\"\\n }\\n}","type":"json"}]', + ], + 'GetRemind' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -41513,441 +21663,528 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '78284', - 'abilityTreeNodes' => [ - 'FEATUREdideGJ7UNJ', - ], + 'abilityTreeCode' => '78286', + 'abilityTreeNodes' => ['FEATUREdideRJGWWC'], ], 'parameters' => [ [ - 'name' => 'ProjectName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the engine or data source.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'autotest', - ], - ], - [ - 'name' => 'EntityId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the partition filter expression.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1234', - ], - ], - [ - 'name' => 'ProjectId', + 'name' => 'RemindId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the DataWorks workspace.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '27', - ], + 'schema' => ['description' => 'The custom alert rule ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1234', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Returns the data structure.', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP return code.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => '38cbdef0-f6cf-49', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.', - 'type' => 'string', - 'example' => 'You have no permission.', - ], - 'Success' => [ - 'description' => 'Whether the call is successful.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.', - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0000-ABCD-EFGH-IJK****', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The specified parameters are invalid.', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '1031203110005', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'The information about the subscription relationship.', - 'type' => 'array', - 'items' => [ - 'description' => 'Returns the data structure.', - 'type' => 'object', - 'properties' => [ - 'FollowerAccountName' => [ - 'description' => 'The Alibaba Cloud account name of the subscriber.', - 'type' => 'string', - 'example' => 'test', - ], - 'TableName' => [ - 'description' => 'The name of the partitioned table.', - 'type' => 'string', - 'example' => 'dual', - ], - 'AlarmMode' => [ - 'description' => 'The alert mode. The value is as follows:'."\n" - ."\n" - .'- 1 (Mail)'."\n" - .'- 2 (email and SMS)'."\n" - .'- 4 (DingTalk groups of robots or hook)'."\n" - .'- 5 (DingTalk groups of robots @ ALL)', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'EntityId' => [ - 'description' => 'The ID of the partition expression.', - 'type' => 'string', - 'example' => '1234', + 'description' => 'The details of the custom alert rule.'."\n", + 'type' => 'object', + 'properties' => [ + 'MaxAlertTimes' => ['description' => 'The maximum number of alerts.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'RemindUnit' => ['description' => 'The type of the object to which the custom alert rule is applied. Valid values: NODE, BASELINE, PROJECT, and BIZPROCESS. The value NODE indicates a node. The value BASELINE indicates a baseline. The value PROJECT indicates a workspace. The value BIZPROCESS indicates a workflow.'."\n", 'type' => 'string', 'example' => 'NODE', 'title' => ''], + 'AlertInterval' => ['description' => 'The minimum interval at which alerts are reported. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1800', 'title' => ''], + 'Useflag' => ['description' => 'Indicates whether the custom alert rule is enabled. Valid values: true and false.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Founder' => ['description' => 'The ID of the Alibaba Cloud account used by the creator of the custom alert rule.'."\n", 'type' => 'string', 'example' => '9527951795****', 'title' => ''], + 'RemindId' => ['description' => 'The custom alert rule ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'DndEnd' => ['description' => 'The end time of the quiet hours. The value is in the hh:mm format. Valid values of hh: \\[0,23]. Valid values of mm: \\[0,59].'."\n", 'type' => 'string', 'example' => '08:00', 'title' => ''], + 'RemindType' => ['description' => 'The conditions that trigger an alert. Valid values: FINISHED, UNFINISHED, ERROR, CYCLE_UNFINISHED, and TIMEOUT.'."\n", 'type' => 'string', 'example' => 'FINISHED', 'title' => ''], + 'AlertUnit' => ['description' => 'The type of the alert recipient. For more information about alert recipient types, see the Receivers parameter. Valid values:'."\n" + ."\n" + .'* OWNER: the task owner'."\n" + .'* OTHER: specified personnel'."\n" + .'* SHIFT_SCHEDULE: personnel in a shift schedule'."\n", 'type' => 'string', 'example' => 'OWNER', 'title' => ''], + 'DndStart' => ['description' => 'The start time of the quiet hours. The value is in the hh:mm format. Valid values of hh: \\[0,23]. Valid values of mm: \\[0,59].'."\n", 'type' => 'string', 'example' => '00:00', 'title' => ''], + 'RemindName' => ['description' => 'The name of the rule.'."\n", 'type' => 'string', 'example' => 'Rule name', 'title' => ''], + 'Detail' => ['description' => '* If the value of the RemindType parameter is FINISHED, this parameter is left empty.'."\n" + .'* If the value of the RemindType parameter is UNFINISHED, the trigger conditions are returned as key-value pairs. Example: {"hour":23,"minu":59}. Valid values of hour: \\[0,47]. Valid values of minu: \\[0,59].'."\n" + .'* If the value of the RemindType parameter is ERROR, this parameter is left empty.'."\n" + .'* If the value of the RemindType parameter is CYCLE_UNFINISHED, the trigger conditions are returned as key-value pairs. Example: {"1":"05:50","2":"06:50","3":"07:50","4":"08:50","5":"09:50","6":"10:50","7":"11:50","8":"12:50","9":"13:50","10":"14:50","11":"15:50","12":"16:50","13":"17:50","14":"18:50","15":"19:50","16":"20:50","17":"21:50","18":"22:50","19":"23:50","20":"24:50","21":"25:50"}. The key indicates the ID of the cycle. Valid values: \\[1,288]. The value indicates the timeout period of the node that is running in the cycle. Specify the value in the hh:mm format. Valid values of hh: \\[0,47]. Valid values of mm: \\[0,59].'."\n" + .'* If the value of the RemindType parameter is TIMEOUT, the timeout period is returned. Unit: seconds. Example: 1800. This value indicates that an alert is reported if the node has run for more than 30 minutes.'."\n", 'type' => 'string', 'example' => '{"hour":23,"minu":59}', 'title' => ''], + 'Robots' => [ + 'description' => 'The webhook URLs of the DingTalk chatbots.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'WebUrl' => ['description' => 'The webhook URL of the DingTalk chatbot.'."\n", 'type' => 'string', 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=******************************', 'title' => ''], + 'AtAll' => ['description' => 'Indicates whether all group members are notified when the alert notification is sent to a DingTalk group. Valid values: true and false.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'ProjectName' => [ - 'description' => 'The name of the engine or data source.', - 'type' => 'string', - 'example' => 'autotest', + 'title' => '', + 'example' => '', + ], + 'Nodes' => [ + 'description' => 'The nodes to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is NODE.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Owner' => ['description' => 'The ID of the Alibaba Cloud account used by the node owner.'."\n", 'type' => 'string', 'example' => '9527951795****', 'title' => ''], + 'NodeName' => ['description' => 'The name of the node.'."\n", 'type' => 'string', 'example' => 'Node name', 'title' => ''], + 'NodeId' => ['description' => 'The node ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'ProjectId' => ['description' => 'The ID of the workspace to which the node belongs.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'Id' => [ - 'description' => 'The ID of the subscription relationship.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', + 'title' => '', + 'example' => '', + ], + 'Baselines' => [ + 'description' => 'The baselines to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is BASELINE.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'BaselineName' => ['description' => 'The name of the baseline.'."\n", 'type' => 'string', 'example' => 'Baseline name', 'title' => ''], + 'BaselineId' => ['description' => 'The baseline ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'Follower' => [ - 'description' => 'The subscriber to receive alert information.', - 'type' => 'string', - 'example' => '1234', + 'title' => '', + 'example' => '', + ], + 'Projects' => [ + 'description' => 'The workspaces to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is PROJECT.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ProjectId' => ['description' => 'The workspace ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'CreateTime' => [ - 'description' => 'The time when the data quality rule subscription configuration was created.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1541576644000', + 'title' => '', + 'example' => '', + ], + 'BizProcesses' => [ + 'description' => 'The workflows to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is BIZPROCESS.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'BizProcessName' => ['description' => 'The name of the workflow.'."\n", 'type' => 'string', 'example' => 'Business process name', 'title' => ''], + 'BizId' => ['description' => 'The ID of the workflow.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '9527', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'ModifyTime' => [ - 'description' => 'The update time of the data quality rule subscription configuration.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1541576644000', + 'title' => '', + 'example' => '', + ], + 'AlertTargets' => [ + 'description' => 'The description of the alert recipient. For more information about alert recipients, see the Receivers parameter.'."\n", + 'type' => 'array', + 'items' => ['description' => '* If the value of the AlertUnit parameter is OWNER, this parameter is left empty.'."\n" + .'* If the value of the AlertUnit parameter is OTHER, the ID of the Alibaba Cloud account used by the specified user is returned.'."\n" + .'* If the value of the AlertUnit parameter is SHIFT_SCHEDULE, the shift schedule ID is returned.'."\n", 'type' => 'string', 'example' => '9527952795279527', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'AlertMethods' => [ + 'description' => 'The notification method.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The notification method. Valid values:'."\n" + ."\n" + .'* MAIL'."\n" + .'* SMS'."\n" + .'* Alert notifications can be sent by text message only in the Singapore, Malaysia (Kuala Lumpur), and Germany (Frankfurt) regions.'."\n", 'type' => 'string', 'example' => 'SMS,MAIL', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Webhooks' => [ + 'description' => 'WebHook URL'."\n", + 'type' => 'array', + 'items' => ['description' => 'The webhook URL of the WeCom or Lark chatbot. You must specify Webhooks for AlertMethods. Only DataWorks Enterprise Edition supports this parameter.'."\n", 'type' => 'string', 'example' => 'https://open.feishu.cn/open-apis/bot/v2/hook/*******', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Receivers' => [ + 'description' => 'The information about the alert recipients.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the alert recipient.'."\n", + 'type' => 'object', + 'properties' => [ + 'AlertUnit' => ['description' => 'The type of the alert recipient. For more information about alert recipients, see the Receivers parameter. Valid values:'."\n" + ."\n" + .'* OWNER: indicate the task owner.'."\n" + .'* OTHER: indicates specified personnel.'."\n" + .'* SHIFT_SCHEDULE: indicates personnel in a shift schedule.'."\n", 'type' => 'string', 'example' => 'OWNER', 'title' => ''], + 'AlertTargets' => [ + 'description' => 'The alert recipient.'."\n", + 'type' => 'array', + 'items' => ['description' => '* If the value of the AlertUnit parameter is OWNER, this parameter is left empty.'."\n" + .'* If the value of the AlertUnit parameter is OTHER, the ID of the Alibaba Cloud account used by the specified user is returned.'."\n" + .'* If the value of the AlertUnit parameter is SHIFT_SCHEDULE, the shift schedule ID is returned.'."\n", 'type' => 'string', 'example' => '9527952795279527', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', + ], + 'AllowNodes' => [ + 'description' => 'The IDs of the nodes that are added to a whitelist.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The ID of the node that is added to a whitelist. The nodes that you add to the whitelist are not monitored.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"38cbdef0-f6cf-49\\",\\n \\"ErrorMessage\\": \\"You have no permission.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Data\\": [\\n {\\n \\"FollowerAccountName\\": \\"test\\",\\n \\"TableName\\": \\"dual\\",\\n \\"AlarmMode\\": 1,\\n \\"EntityId\\": \\"1234\\",\\n \\"ProjectName\\": \\"autotest\\",\\n \\"Id\\": 123,\\n \\"Follower\\": \\"1234\\",\\n \\"CreateTime\\": 1541576644000,\\n \\"ModifyTime\\": 1541576644000\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 38cbdef0-f6cf-49\\n You have no permission.\\n true\\n Invalid.Tenant.ConnectionNotExists\\n \\n test\\n dual\\n 1\\n 1234\\n autotest\\n 123\\n 1234\\n 1541576644000\\n 1541576644000\\n \\n","errorExample":""}]', - 'title' => 'GetQualityFollower', - 'summary' => 'Queries the subscribers of a partition filter expression.', + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Resource', 'errorMessage' => 'You have reached the limit for the resource. Please contact us by submitting a ticket.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'Forbidden.Not.Server', 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.', 'description' => ''], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'title' => 'GetRemind', + 'summary' => 'Queries the information about a custom alert rule.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateQualityFollower' => [ - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2024-09-18T07:11:33.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-11-16T09:08:09.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '99', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRemind'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFGH-IJK****\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"MaxAlertTimes\\": 3,\\n \\"RemindUnit\\": \\"NODE\\",\\n \\"AlertInterval\\": 1800,\\n \\"Useflag\\": true,\\n \\"Founder\\": \\"9527951795****\\",\\n \\"RemindId\\": 1234,\\n \\"DndEnd\\": \\"08:00\\",\\n \\"RemindType\\": \\"FINISHED\\",\\n \\"AlertUnit\\": \\"OWNER\\",\\n \\"DndStart\\": \\"00:00\\",\\n \\"RemindName\\": \\"Rule name\\",\\n \\"Detail\\": \\"{\\\\\\"hour\\\\\\":23,\\\\\\"minu\\\\\\":59}\\",\\n \\"Robots\\": [\\n {\\n \\"WebUrl\\": \\"https://oapi.dingtalk.com/robot/send?access_token=******************************\\",\\n \\"AtAll\\": true\\n }\\n ],\\n \\"Nodes\\": [\\n {\\n \\"Owner\\": \\"9527951795****\\",\\n \\"NodeName\\": \\"Node name\\",\\n \\"NodeId\\": 1234,\\n \\"ProjectId\\": 1234\\n }\\n ],\\n \\"Baselines\\": [\\n {\\n \\"BaselineName\\": \\"Baseline name\\",\\n \\"BaselineId\\": 1234\\n }\\n ],\\n \\"Projects\\": [\\n {\\n \\"ProjectId\\": 1234\\n }\\n ],\\n \\"BizProcesses\\": [\\n {\\n \\"BizProcessName\\": \\"Business process name\\",\\n \\"BizId\\": 9527\\n }\\n ],\\n \\"AlertTargets\\": [\\n \\"9527952795279527\\"\\n ],\\n \\"AlertMethods\\": [\\n \\"SMS,MAIL\\"\\n ],\\n \\"Webhooks\\": [\\n \\"https://open.feishu.cn/open-apis/bot/v2/hook/*******\\"\\n ],\\n \\"Receivers\\": [\\n {\\n \\"AlertUnit\\": \\"OWNER\\",\\n \\"AlertTargets\\": [\\n \\"9527952795279527\\"\\n ]\\n }\\n ],\\n \\"AllowNodes\\": [\\n 123\\n ]\\n }\\n}","type":"json"}]', + ], + 'GetSensitiveData' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '78193', - 'abilityTreeNodes' => [ - 'FEATUREdideGJ7UNJ', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'ProjectName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the compute engine or data source.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'autotest', - ], + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Maximum value: 1000.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '1000', 'minimum' => '1', 'example' => '1000', 'title' => ''], ], [ - 'name' => 'Follower', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The account ID of the subscriber.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '123', - ], + 'name' => 'PageNo', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Pages start from page 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '1000', 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ - 'name' => 'AlarmMode', - 'in' => 'formData', + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The parameters that you can configure to query the access records. Valid values:'."\n" + ."\n" + .'* dbType'."\n" + .'* instanceName'."\n" + .'* databaseName'."\n" + .'* projectName'."\n" + .'* clusterName'."\n" + ."\n" + .'The sample value shows the parameters configured to query the access records of the sensitive data in the abc database of the Hologres instance ABC. You must configure the parameters based on the compute engine that you use in your business.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[ {"dbType":"hologres","instanceName":"ABC","databaseName":"abc"}, {"dbType":"ODPS.ODPS","projectName":"adbc"} ]', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The notification method. Valid values: 1, 2, 4, 5, 6, 7, 8, and 9. The value 1 indicates that the notification is sent by email. The value 2 indicates that the notification is sent by email and text message. The value 4 indicates that the notification is sent by a DingTalk chatbot. The value 5 indicates that the notification is sent by a DingTalk chatbot to all members in a DingTalk group. The value 6 indicates that the notification is sent by Lark. The value 7 indicates that the notification is sent by WeCom. The value 8 indicates that the notification is sent by webhook. The value 9 indicates that the notification is sent by phone call.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - 'enum' => [ - '1', - '2', - '4', - '5', - '6', - '7', - '8', - '9', + 'description' => 'Response parameters'."\n", + 'type' => 'object', + 'properties' => [ + 'SensitiveData' => ['description' => 'The information about the sensitive data returned. The information includes totalCount and sensDatas. sensDatas includes the following parameters:'."\n" + ."\n" + .'* guid: the ID of the metadata of the tenant. For example, the ID of the metadata in the MaxCompute compute engine is in the Project name.Table name.Column name format.'."\n" + .'* sensType: the type of the sensitive data.'."\n" + .'* sensLevel: the sensitivity level of the sensitive data'."\n", 'type' => 'object', 'example' => '{      "sensDatas": [       {         "sensLevel": "L1",         "guid": "dsg_demo.animal.dog",         "sensType": " Name"       }      ],     "totalCount": 2171 }', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0000-ABCD-EFG****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Invalid.Param', 'errorMessage' => 'The request parameter is invalid.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'Forbidden.NoTenant', 'errorMessage' => 'The tenant information cannot be obtained using user ID.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.DQC.BizError', 'errorMessage' => 'An internal error occurred.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"SensitiveData\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 0000-ABCD-EFG****\\n","errorExample":""}]', + 'title' => 'GetSensitiveData', + 'summary' => 'Queries the latest sensitive data in all the DataWorks workspaces of a tenant.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSensitiveData'], + ], + ], + 'ramActions' => [], + ], + 'GetSuccessInstanceTrend' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'EntityId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the partition filter expression.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '12345', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The DataWorks workspace ID. You can log on to the DataWorks console to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '123', - ], + 'schema' => ['description' => 'The DataWorks workspace ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '99999999999', 'minimum' => '2', 'example' => '9527'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The ID of the subscription relationship.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '12345', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'You have no permission.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ecb967ec-c137-48****', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '401', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '952795279527ab****'], + 'InstanceStatusTrend' => [ + 'description' => 'The trend of statistics on the instance status in different time periods.'."\n", + 'type' => 'object', + 'properties' => [ + 'TodayTrend' => [ + 'description' => 'The trend on the current day.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TimePoint' => ['description' => 'The point in time. Valid values: 00:00 to 23:00.'."\n", 'type' => 'string', 'example' => '01:00'], + 'Count' => ['description' => 'The number of instances.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + ], + ], + ], + 'YesterdayTrend' => [ + 'description' => 'The trend on the previous day.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TimePoint' => ['description' => 'The point in time. Valid values: 00:00 to 23:00.'."\n", 'type' => 'string', 'example' => '01:00'], + 'Count' => ['description' => 'The number of instances.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + ], + ], + ], + 'AvgTrend' => [ + 'description' => 'The average trend.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TimePoint' => ['description' => 'The point in time. Valid values: 00:00 to 23:00.'."\n", 'type' => 'string', 'example' => '01:00'], + 'Count' => ['description' => 'The number of instances.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + ], + ], + ], + ], ], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 12345,\\n \\"ErrorMessage\\": \\"You have no permission.\\",\\n \\"RequestId\\": \\"ecb967ec-c137-48****\\",\\n \\"ErrorCode\\": \\"401\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 12345\\n You have no permission.\\n ecb967ec-c137-48****\\n 401\\n true\\n","errorExample":""}]', - 'title' => 'CreateQualityFollower', - 'summary' => 'Creates a subscriber for a partition filter expression.', + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'ResourceNotAuthorized.Api', 'errorMessage' => 'You are not authorized to access the resources.', 'description' => ''], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Resource', 'errorMessage' => 'You have reached the limit for the resource. Please contact us by submitting a ticket.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'Forbidden.Not.Server', 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.', 'description' => ''], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'Forbidden.Wkbench.ProjectNoPermission', 'errorMessage' => 'You are not authorized to access the workspace.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"952795279527ab****\\",\\n \\"InstanceStatusTrend\\": {\\n \\"TodayTrend\\": [\\n {\\n \\"TimePoint\\": \\"01:00\\",\\n \\"Count\\": 10\\n }\\n ],\\n \\"YesterdayTrend\\": [\\n {\\n \\"TimePoint\\": \\"01:00\\",\\n \\"Count\\": 10\\n }\\n ],\\n \\"AvgTrend\\": [\\n {\\n \\"TimePoint\\": \\"01:00\\",\\n \\"Count\\": 10\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"952795279527ab****\\n\\n \\n 01:00\\n 10\\n \\n \\n 01:00\\n 10\\n \\n \\n 01:00\\n 10\\n \\n \\n 01:00\\n 10\\n \\n \\n 01:00\\n 10\\n \\n \\n 01:00\\n 10\\n \\n \\n 01:00\\n 10\\n \\n \\n 01:00\\n 10\\n \\n \\n 01:00\\n 10\\n \\n","errorExample":""}]', + 'title' => 'GetSuccessInstanceTrend', + 'summary' => 'Queries the statistics of instances in different periods of a day.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteQualityEntity' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'GetTopic' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '78213', - 'abilityTreeNodes' => [ - 'FEATUREdide3WJOKE', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '78289', + 'abilityTreeNodes' => ['FEATUREdideSFSFU4'], ], 'parameters' => [ [ - 'name' => 'EntityId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the partition filter expression.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '1234', - ], - ], - [ - 'name' => 'ProjectName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the compute engine or data source.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'autotest', - ], - ], - [ - 'name' => 'EnvType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The type of the compute engine or data source. The following types are supported: E-MapReduce (EMR), Hologres, AnalyticDB for PostgreSQL, CDH, MaxCompute, Kafka, and DataHub.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* odps'."\n" - .'* emr'."\n" - .'* hadoop'."\n" - .'* cdh'."\n" - .'* hybriddb_for_postgresql'."\n" - .'* holodb'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ODPS', - 'enum' => [ - 'odps', - 'emr', - 'hadoop', - 'cdh', - 'hybriddb_for_postgresql', - 'holodb', - ], - ], - ], - [ - 'name' => 'ProjectId', + 'name' => 'TopicId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '12345', - ], + 'schema' => ['description' => 'The event ID. You can call the [ListTopics](~~173973~~) operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1234', 'title' => ''], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0000-ABCD-EFGH-IJKLMNOPQ', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The specified parameters are invalid.', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '1031203110005', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'The returned result.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'You have no permission.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ecb967ec-c137-48****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '401', + 'description' => 'The details of the event.'."\n", + 'type' => 'object', + 'properties' => [ + 'Owner' => ['description' => 'The ID of the Alibaba Cloud account used by the event owner.'."\n", 'type' => 'string', 'example' => '952795****', 'title' => ''], + 'TopicName' => ['description' => 'The name of the event.'."\n", 'type' => 'string', 'example' => '1234 error', 'title' => ''], + 'BaselineStatus' => ['description' => 'The status of the baseline. Valid values: ERROR, SAFE, DANGROUS, and OVER. The value ERROR indicates that no nodes are associated with the baseline, or all nodes associated with the baseline are suspended. The value SAFE indicates that nodes are run before the alert duration begins. The value DANGROUS indicates that nodes are still running after the alert duration ends but the committed completion time does not arrive. The value OVER indicates that nodes are still running after the committed completion time.'."\n", 'type' => 'string', 'example' => 'SAFE', 'title' => ''], + 'ProjectId' => ['description' => 'The ID of the workspace to which the node that triggered the event belongs.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123456', 'title' => ''], + 'NextAlertTime' => ['description' => 'The timestamp when the system reports the next alert.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1553524393000', 'title' => ''], + 'InstanceId' => ['description' => 'The ID of the instance that triggered the event.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '12345', 'title' => ''], + 'FixTime' => ['description' => 'The timestamp when the event was processed.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1553524393000', 'title' => ''], + 'BaselineInGroupId' => ['description' => 'The ID of the cycle of the worst baseline instance.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'BaselineBuffer' => ['description' => 'The margin of the worst baseline instance. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '3600', 'title' => ''], + 'TopicType' => ['description' => 'The type of the event. Valid values: SLOW and ERROR. The value SLOW indicates that the duration of the task is significantly longer than the average duration of the task in previous cycles. The value ERROR indicates that the task fails to run.'."\n", 'type' => 'string', 'example' => 'ERROR', 'title' => ''], + 'TopicStatus' => ['description' => 'The status of the event. Valid values: IGNORE, NEW, FIXING, and RECOVER.'."\n", 'type' => 'string', 'example' => 'FIXING', 'title' => ''], + 'HappenTime' => ['description' => 'The timestamp when the event occurred. A time difference may exist between the time when the event occurred and the time when the event was found.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1553524393000', 'title' => ''], + 'DealTime' => ['description' => 'The timestamp when the event was last processed.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1553524393000', 'title' => ''], + 'DealUser' => ['description' => 'The ID of the Alibaba Cloud account used by the user who last processed the event.'."\n", 'type' => 'string', 'example' => '952795****', 'title' => ''], + 'BaselineName' => ['description' => 'The name of the baseline to which the worst baseline instance belongs.'."\n", 'type' => 'string', 'example' => 'Baseline name', 'title' => ''], + 'BaselineId' => ['description' => 'The ID of the baseline to which the worst baseline instance belongs.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'NodeName' => ['description' => 'The name of the node that triggered the event.'."\n", 'type' => 'string', 'example' => 'Node name', 'title' => ''], + 'AlertTime' => ['description' => 'The timestamp when the first alert was reported.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1553524393000', 'title' => ''], + 'Buffer' => ['description' => 'The margin of the event. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1200', 'title' => ''], + 'Assigner' => ['description' => 'The ID of the Alibaba Cloud account used by the alert recipient.'."\n", 'type' => 'string', 'example' => '952795****', 'title' => ''], + 'TopicId' => ['description' => 'The event ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'AddTime' => ['description' => 'The timestamp when the event was found.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1553524393000', 'title' => ''], + 'NodeId' => ['description' => 'The ID of the node that triggered the event.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"You have no permission.\\",\\n \\"RequestId\\": \\"ecb967ec-c137-48****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"401\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n true\\n You have no permission.\\n ecb967ec-c137-48****\\n true\\n 401\\n","errorExample":""}]', - 'title' => 'DeleteQualityEntity', - 'summary' => 'Deletes a partition filter expression.', + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'Forbidden.Not.Server', 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.', 'description' => ''], + ['errorCode' => 'Invalid.Wkbench.Parameter', 'errorMessage' => 'The specified parameters are invalid.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.Wkbench.ServiceError', 'errorMessage' => 'An internal error occurred.', 'description' => 'An internal error occurred.'], + ['errorCode' => 'Invalid.Wkbench.TopicNotExist', 'errorMessage' => 'The topic does not exist.', 'description' => ''], + ], + ], + 'title' => 'GetTopic', + 'summary' => 'Queries the information about an event.', + 'description' => '****', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'GetQualityEntity' => [ - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2023-01-10T12:27:18.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '499', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTopic'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFGH-IJKLMNOPQ\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Owner\\": \\"952795****\\",\\n \\"TopicName\\": \\"1234 error\\",\\n \\"BaselineStatus\\": \\"SAFE\\",\\n \\"ProjectId\\": 123456,\\n \\"NextAlertTime\\": 1553524393000,\\n \\"InstanceId\\": 12345,\\n \\"FixTime\\": 1553524393000,\\n \\"BaselineInGroupId\\": 1,\\n \\"BaselineBuffer\\": 3600,\\n \\"TopicType\\": \\"ERROR\\",\\n \\"TopicStatus\\": \\"FIXING\\",\\n \\"HappenTime\\": 1553524393000,\\n \\"DealTime\\": 1553524393000,\\n \\"DealUser\\": \\"952795****\\",\\n \\"BaselineName\\": \\"Baseline name\\",\\n \\"BaselineId\\": 1234,\\n \\"NodeName\\": \\"Node name\\",\\n \\"AlertTime\\": 1553524393000,\\n \\"Buffer\\": 1200,\\n \\"Assigner\\": \\"952795****\\",\\n \\"TopicId\\": 1234,\\n \\"AddTime\\": 1553524393000,\\n \\"NodeId\\": 1234\\n }\\n}","type":"json"}]', + ], + 'GetTopicInfluence' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -41957,538 +22194,248 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '78283', - 'abilityTreeNodes' => [ - 'FEATUREdide3WJOKE', - ], + 'abilityTreeCode' => '78290', + 'abilityTreeNodes' => ['FEATUREdideSFSFU4'], ], 'parameters' => [ [ - 'name' => 'ProjectName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the compute engine instance or data source. You can obtain the name from data source configurations.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'autotest', - 'maxLength' => 1024, - 'minLength' => 1, - ], - ], - [ - 'name' => 'TableName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the partitioned table. You can call the [GetMetaTablePartition](~~173923~~) operation to obtain the name.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'dual', - 'maxLength' => 128, - 'minLength' => 1, - ], - ], - [ - 'name' => 'EnvType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The type of the compute engine or data source. Valid values:'."\n" - ."\n" - .'* cdh'."\n" - .'* analyticdb_for_mysql'."\n" - .'* odps'."\n" - .'* emr'."\n" - .'* hadoop'."\n" - .'* holodb'."\n" - .'* hybriddb_for_postgresql'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [], - 'example' => 'odps', - 'maxLength' => 64, - 'minLength' => 1, - ], - ], - [ - 'name' => 'MatchExpression', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The partition filter expression.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'dt=$[yyyymmdd]', - 'maxLength' => 128, - 'minLength' => 1, - ], - ], - [ - 'name' => 'ProjectId', + 'name' => 'TopicId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '12345', - ], + 'schema' => ['description' => 'The ID of the event.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1234', 'title' => ''], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '6d739ef6-098a-47****', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'You have no permission.', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'example' => '401', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request. You can use the ID to troubleshoot issues.'."\n", 'type' => 'string', 'example' => '0000-ABCD-EFG****', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'The specified parameters are invalid.', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned.'."\n", 'type' => 'string', 'example' => '1031203110005', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'The information about the partition filter expression.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RelativeNode' => [ - 'description' => 'The information about the node with which the partition filter expression is associated. The information includes the following items:'."\n" - ."\n" - .'* ProjectName: the name of the workspace to which the node belongs.'."\n" - .'* NodeID: the ID of the node.'."\n", - 'type' => 'string', - 'example' => '[{"projectName":"xc_DP****","nodeId":7000026****}]', - ], - 'OnDutyAccountName' => [ - 'description' => 'The name of the Alibaba Cloud account that is used to configure the partition filter expression.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'Task' => [ - 'description' => 'The node.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'TableName' => [ - 'description' => 'The name of the partitioned table.'."\n", - 'type' => 'string', - 'example' => 'test_dqc_de****', - ], - 'Followers' => [ - 'description' => 'The ID of the Alibaba Cloud account that is used to receive alert notifications.'."\n", - 'type' => 'string', - 'example' => '1822931****', - ], - 'OnDuty' => [ - 'description' => 'The ID of the Alibaba Cloud account that is used to configure the partition filter expression.'."\n", - 'type' => 'string', - 'example' => '1822931****', - ], - 'MatchExpression' => [ - 'description' => 'The partition filter expression.'."\n", - 'type' => 'string', - 'example' => 'dt=$[yyyymmdd-1]', - ], - 'CreateTime' => [ - 'description' => 'The time when the partition filter expression was created.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1593964800000', - ], - 'ProjectName' => [ - 'description' => 'The name of the compute engine instance or data source.'."\n", - 'type' => 'string', - 'example' => 'autotest', - ], - 'HasRelativeNode' => [ - 'description' => 'Indicates whether the partition filter expression is associated with a node. Valid values:'."\n" - ."\n" - .'* true: The partition filter expression is associated with a node.'."\n" - .'* false: The partition filter expression is not associated with a node.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'EnvType' => [ - 'description' => 'The type of the compute engine instance or data source.'."\n", - 'type' => 'string', - 'example' => 'odps', - ], - 'EntityLevel' => [ - 'description' => 'The level of the partition filter expression. Valid values:'."\n" - ."\n" - .'* 0: The partition filter expression is at the SQL level. This indicates that the system checks data quality after each SQL statement is executed.'."\n" - .'* 1: The partition filter expression is at the node level. This indicates that the system checks data quality after all the SQL statements for a node are executed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ModifyUser' => [ - 'description' => 'The ID of the Alibaba Cloud account that is used to modify the partition filter expression.'."\n", - 'type' => 'string', - 'example' => '1822931****', - ], - 'Sql' => [ - 'description' => 'Indicates that the partition filter expression is at the SQL level.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Id' => [ - 'description' => 'The ID of the partition filter expression.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4003918', - ], - 'ModifyTime' => [ - 'description' => 'The time when the partition filter expression was modified.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1593964800000', + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'TopicId' => ['description' => 'The ID of the event.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'Influences' => [ + 'description' => 'The affected baseline instances.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status of the baseline. Valid values: ERROR, SAFE, DANGROUS, and OVER. The value ERROR indicates that no nodes are associated with the baseline, or all nodes associated with the baseline are suspended. The value SAFE indicates that nodes are run before the alert duration begins. The value DANGROUS indicates that nodes are still running after the alert duration ends but the committed time does not arrive. The value OVER indicates that nodes are still running after the committed time.'."\n", 'type' => 'string', 'example' => 'SAFE', 'title' => ''], + 'Owner' => ['description' => 'The ID of the Alibaba Cloud account used by the baseline owner. Multiple IDs are separated by commas (,).'."\n", 'type' => 'string', 'example' => '952795****', 'title' => ''], + 'BaselineName' => ['description' => 'The name of the baseline.'."\n", 'type' => 'string', 'example' => 'Baseline name', 'title' => ''], + 'BaselineId' => ['description' => 'The ID of the baseline.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '12345', 'title' => ''], + 'Bizdate' => ['description' => 'The data timestamp of the baseline instance.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1553356800000', 'title' => ''], + 'Buffer' => ['description' => 'The margin of the baseline instance. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '360', 'title' => ''], + 'ProjectId' => ['description' => 'The ID of the workspace to which the baseline belongs.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'Priority' => ['description' => 'The priority of the baseline. Valid values: 1, 2, 5, 7, and 8.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'InGroupId' => ['description' => 'The ID of the cycle of the baseline instance. For a baseline instance that is scheduled by day, the field value is 1. For a baseline instance that is scheduled by hour, the field value ranges from 1 to 24.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"6d739ef6-098a-47****\\",\\n \\"ErrorMessage\\": \\"You have no permission.\\",\\n \\"ErrorCode\\": \\"401\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"RelativeNode\\": \\"[{\\\\\\"projectName\\\\\\":\\\\\\"xc_DP****\\\\\\",\\\\\\"nodeId\\\\\\":7000026****}]\\",\\n \\"OnDutyAccountName\\": \\"test\\",\\n \\"Task\\": 0,\\n \\"TableName\\": \\"test_dqc_de****\\",\\n \\"Followers\\": \\"1822931****\\",\\n \\"OnDuty\\": \\"1822931****\\",\\n \\"MatchExpression\\": \\"dt=$[yyyymmdd-1]\\",\\n \\"CreateTime\\": 1593964800000,\\n \\"ProjectName\\": \\"autotest\\",\\n \\"HasRelativeNode\\": true,\\n \\"EnvType\\": \\"odps\\",\\n \\"EntityLevel\\": 0,\\n \\"ModifyUser\\": \\"1822931****\\",\\n \\"Sql\\": 0,\\n \\"Id\\": 4003918,\\n \\"ModifyTime\\": 1593964800000\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 6d739ef6-098a-47****\\n You have no permission.\\n 401\\n true\\n \\n [{\\"projectName\\":\\"xc_DP****\\",\\"nodeId\\":7000026****}]\\n test\\n 0\\n test_dqc_de****\\n 1822931****\\n 1822931****\\n dt=$[yyyymmdd-1]\\n 1593964800000\\n autotest\\n true\\n odps\\n 0\\n 1822931****\\n 0\\n 4003918\\n 1593964800000\\n \\n","errorExample":""}]', - 'title' => 'GetQualityEntity', - 'summary' => 'Queries the information about a partition filter expression.', + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'Forbidden.Not.Server', 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.', 'description' => ''], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.Wkbench.ServiceError', 'errorMessage' => 'An internal error occurred.', 'description' => 'An internal error occurred.'], + ['errorCode' => 'Invalid.Wkbench.Parameter', 'errorMessage' => 'The specified parameters are invalid.', 'description' => ''], + ['errorCode' => 'Invalid.Wkbench.TopicNotExist', 'errorMessage' => 'The topic does not exist.', 'description' => ''], + ], + ], + 'title' => 'GetTopicInfluence', + 'summary' => 'Queries baseline instances affected by an event.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateQualityEntity' => [ - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2023-01-10T12:27:18.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '199', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTopicInfluence'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"TopicId\\": 1234,\\n \\"Influences\\": [\\n {\\n \\"Status\\": \\"SAFE\\",\\n \\"Owner\\": \\"952795****\\",\\n \\"BaselineName\\": \\"Baseline name\\",\\n \\"BaselineId\\": 12345,\\n \\"Bizdate\\": 1553356800000,\\n \\"Buffer\\": 360,\\n \\"ProjectId\\": 1234,\\n \\"Priority\\": 1,\\n \\"InGroupId\\": 1\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ImportDataSources' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '78192', - 'abilityTreeNodes' => [ - 'FEATUREdide3WJOKE', - ], - ], - 'parameters' => [ - [ - 'name' => 'ProjectName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the compute engine or data source.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'autotest', - ], - ], - [ - 'name' => 'TableName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the table.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'dual', - 'maxLength' => 128, - 'minLength' => 1, - ], - ], [ - 'name' => 'EnvType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The type of the compute engine or data source.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* odps'."\n" - .'* emr'."\n" - .'* hadoop'."\n" - .'* cdh'."\n" - .'* analyticdb_for_mysql'."\n" - .'* hybriddb_for_postgresql'."\n" - .'* holodb'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ODPS', - 'maxLength' => 64, - 'minLength' => 1, - 'enum' => [ - 'odps', - 'emr', - 'hadoop', - 'cdh', - 'analyticdb_for_mysql', - 'hybriddb_for_postgresql', - 'holodb', - ], - ], + 'APP' => [], ], [ - 'name' => 'MatchExpression', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The partition filter expression.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'dt=$[yyyymmdd]', - 'maxLength' => 128, - 'minLength' => 1, - ], + 'PrivateKey' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], + 'parameters' => [ [ - 'name' => 'EntityLevel', - 'in' => 'formData', - 'schema' => [ - 'description' => 'This parameter is deprecated.'."\n" - ."\n" - .'The value 0 indicates that the partition filter expression is at the SQL level, and the system checks data quality after each SQL statement is executed.'."\n" - ."\n" - .'* 0'."\n" - .'* 1', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'maximum' => '99', - 'minimum' => '0', - 'enumValueTitles' => [ - '0', - '1', - ], - 'example' => '0', - 'enum' => [ - '0', - '1', - ], - ], + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '10000000000', 'minimum' => '1', 'example' => '10000'], ], [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The DataWorks workspace ID. You can log on to the DataWorks console to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '123', - ], + 'name' => 'DataSources', + 'in' => 'query', + 'schema' => ['description' => 'The configurations of the data sources that you want to import. The Name, DataSourceType, SubType, Description, Content, and EnvType parameters are required. For more information about the parameters, see [CreateDataSource](~~211429~~).'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[{"SubType":"","DataSourceType":"mysql","EnvType":1,"Name":"mysql_dms2","Description":"aaa","Content":"{\\"database\\":\\"mysql_chengdu_old\\",\\"password\\":\\"***\\",\\"instanceName\\":\\"rm-2vcrckb37163g7l3w\\",\\"regionId\\":\\"cn-chengdu\\",\\"tag\\":\\"rds\\",\\"rdsOwnerId\\":\\"333\\",\\"username\\":\\"mysql_chengdu2\\"}"},{"SubType":"","DataSourceType":"mysql","EnvType":1,"Name":"mysql_dms2","Description":"aaa","Content":"{\\"database\\":\\"mysql_chengdu_old\\",\\"password\\":\\"***\\",\\"instanceName\\":\\"rm-2vcrckb37163g7l3w\\",\\"regionId\\":\\"cn-chengdu\\",\\"tag\\":\\"rds\\",\\"rdsOwnerId\\":\\"143\\",\\"username\\":\\"mysql_chengdu2\\"}"}]'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], + 'RequestId' => ['description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", 'type' => 'string', 'example' => '0bc1411515937635973****'], 'Data' => [ - 'description' => 'The partition filter expression ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '12345', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Your project is not relative with your account.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '011e1231u3****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '401', + 'description' => 'The information about the imported data sources.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'Indicates whether the data sources were imported. Valid values:'."\n" + ."\n" + .'* true: All data sources were imported.'."\n" + .'* false: Specific data sources failed to be imported. You can troubleshoot issues based on the Message parameter.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'Message' => ['description' => 'The reason why the data sources failed to be imported. If the data sources were imported, this parameter is left empty.'."\n", 'type' => 'string', 'example' => ' Data source DEV XXX already exists'], + ], ], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 12345,\\n \\"ErrorMessage\\": \\"Your project is not relative with your account.\\",\\n \\"RequestId\\": \\"011e1231u3****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"401\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 12345\\n Your project is not relative with your account.\\n 011e1231u3****\\n true\\n 401\\n","errorExample":""}]', - 'title' => 'CreateQualityEntity', - 'summary' => 'Creates a partition filter expression.', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Invalid.DI.Parameter', 'errorMessage' => 'The parameter is invalid.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'Forbidden.DI.NoPrivilege', 'errorMessage' => 'No access.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.DI.Parameter', 'errorMessage' => 'A DI internal error occurred.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0bc1411515937635973****\\",\\n \\"Data\\": {\\n \\"Status\\": true,\\n \\"Message\\": \\" Data source DEV XXX already exists\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"0bc1411515937635973****\\n\\n true\\n Data source DEV XXX already exists\\n\\ntrue","errorExample":""}]', + 'title' => 'ImportDataSources', + 'summary' => 'Imports data sources from your on-premises machine to a specific DataWorks workspace.', + 'description' => 'You can import self-managed data sources or data sources that are exported from other DataWorks workspaces to a specific DataWorks workspace.'."\n" + ."\n" + .'* To import a self-managed data source to a DataWorks workspace, the data source type must be supported by DataWorks. For more information about the types of data sources supported by DataWorks, see [Supported data stores](~~181656~~).'."\n" + .'* For more information about how to export data sources from DataWorks workspaces to your on-premises machine, see [ExportDataSources](~~279570~~).'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateQualityRelativeNode' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'ListAlertMessages' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '78194', - 'abilityTreeNodes' => [ - 'FEATUREdide3WJOKE', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '78294', + 'abilityTreeNodes' => ['FEATUREdideRJGWWC'], ], 'parameters' => [ [ - 'name' => 'EnvType', + 'name' => 'PageNumber', 'in' => 'formData', - 'schema' => [ - 'description' => 'The type of the compute engine or data source.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ODPS', - 'maxLength' => 40, - 'minLength' => 1, - ], + 'schema' => ['description' => 'The page number. Default value: 1. Minimum value: 1. Maximum value: 30.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'MatchExpression', + 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => 'The partition filter expression.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'dt=$[yyyymmdd]', - 'maxLength' => 80, - 'minLength' => 1, - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''], ], [ - 'name' => 'NodeId', + 'name' => 'BeginTime', 'in' => 'formData', - 'schema' => [ - 'description' => 'The node ID. You can call the [ListNodes](~~173979~~) operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '12321', - ], + 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-dd\'T\'HH:mm:ssZ format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-04-02T00:00:00+0800', 'title' => ''], ], [ - 'name' => 'ProjectId', + 'name' => 'EndTime', 'in' => 'formData', - 'schema' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '123', - ], + 'schema' => ['description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-dd\'T\'HH:mm:ssZ format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-04-04T00:00:00+0800', 'title' => ''], ], [ - 'name' => 'TargetNodeProjectName', + 'name' => 'RemindId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the workspace to which the node to be associated with the partition filter expression belongs.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'autotest', - 'maxLength' => 128, - 'minLength' => 1, - ], + 'schema' => ['description' => 'The custom alert rule ID. This parameter takes effect if the AlertRuleTypes parameter is set to USER_DEFINE. You can configure either this parameter or the BaselineId parameter.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '9527', 'title' => ''], ], [ - 'name' => 'ProjectName', + 'name' => 'AlertMethods', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the compute engine or data source.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'autotest', - 'maxLength' => 128, - 'minLength' => 1, - ], + 'schema' => ['description' => 'The notification method. Valid values:'."\n" + ."\n" + .'* MAIL'."\n" + .'* SMS Alert notifications can be sent by text message only in the Singapore, Malaysia (Kuala Lumpur), and Germany (Frankfurt) regions.'."\n" + ."\n" + .'You can specify multiple notification methods. Separate them with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => 'SMS,MAIL,PHONE', 'title' => ''], ], [ - 'name' => 'TableName', + 'name' => 'AlertUser', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the table.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'dual', - 'maxLength' => 128, - 'minLength' => 1, - ], + 'schema' => ['description' => 'The ID of the Alibaba Cloud account used by the alert recipient.'."\n", 'type' => 'string', 'required' => false, 'example' => '12345', 'title' => ''], ], [ - 'name' => 'TargetNodeProjectId', + 'name' => 'AlertRuleTypes', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the workspace to which the node belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1234', - ], + 'schema' => ['description' => 'The type of the alert rule. Valid values: GLOBAL, USER_DEFINE, and OTHER. The value GLOBAL indicates that the alert rule is a global alert rule. The value USER_DEFINE indicates that the alert rule is customized by a user. The value OTHER indicates that the alert rule is a rule of another type. You can specify multiple types. Separate them with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => 'GLOBAL,USER_DEFINE,OTHER', 'title' => ''], + ], + [ + 'name' => 'BaselineId', + 'in' => 'formData', + 'schema' => ['description' => 'The baseline ID. This parameter takes effect if the AlertRuleTypes parameter is set to GLOBAL. You can configure either this parameter or the RemindId parameter.'."\n", 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '1234'], ], ], 'responses' => [ @@ -42497,231 +22444,305 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0000-ABCD-EFG****', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The specified parameters are invalid.', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'Indicates whether the node is associated with the partition filter expression.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'You have no permission.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ecb967ec-c137-48****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '401', + 'description' => 'The information about returned alerts.'."\n", + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'string', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of alerts returned.'."\n", 'type' => 'string', 'example' => '100', 'title' => ''], + 'AlertMessages' => [ + 'description' => 'The alerts.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RemindId' => ['description' => 'The ID of the custom alert rule that was triggered. This parameter is returned if the value of the Source parameter is REMIND_ALERT.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'AlertMessageStatus' => ['description' => 'The sending status of the notification. Valid values: READY_TO_SEND, SEND_FAIL, SEND_SUCCESS, and SEND_OVERLIMIT. The value READY_TO_SEND indicates that the notification is waiting to be sent. The value SEND_FAIL indicates that the notification fails to be sent. The value SEND_SUCCESS indicates that the notification is sent. The value SEND_OVERLIMIT indicates that the number of notifications that are sent exceeds the upper limit.'."\n", 'type' => 'string', 'example' => 'READY_TO_SEND', 'title' => ''], + 'AlertUser' => ['description' => 'The ID of the Alibaba Cloud used by the alert recipient.'."\n", 'type' => 'string', 'example' => '9527952795****', 'title' => ''], + 'AlertTime' => ['description' => 'The timestamp when the alert was reported.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1553531401000', 'title' => ''], + 'AlertMethod' => ['description' => 'The notification method. Valid values: MAIL, SMS, and PHONE. Only DataWorks Professional Edition and more advanced editions support the PHONE notification method.'."\n", 'type' => 'string', 'example' => 'SMS', 'title' => ''], + 'Source' => ['description' => 'The type of the alert. Valid values: REMIND_ALERT, TOPIC_ALERT, SLA_ALERT, NODE_CYCLE_ALERT, and NODE_LONELY_ALERT. The value REMIND_ALERT indicates that the alert is a custom alert. The value TOPIC_ALERT indicates that the alert is an event alert. The value SLA_ALERT indicates that the alert is a baseline alert. The value NODE_CYCLE_ALERT indicates that the alert is reported for a node dependency loop. The value NODE_LONELY_ALERT indicates that the alert is reported for isolated nodes.'."\n", 'type' => 'string', 'example' => 'REMIND_ALERT', 'title' => ''], + 'Content' => ['description' => 'The content of the alert.'."\n", 'type' => 'string', 'example' => 'Node error', 'title' => ''], + 'RemindName' => ['description' => 'The name of the custom alert rule that was triggered. This parameter is returned if the value of the Source parameter is REMIND_ALERT.'."\n", 'type' => 'string', 'example' => 'Custom monitoring rule name', 'title' => ''], + 'AlertId' => ['description' => 'The alert ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'Instances' => [ + 'description' => 'The instances that triggered the custom alert rule. This parameter is returned if the value of the Source parameter is REMIND_ALERT. This parameter is left empty if the value of the Source parameter is not REMIND_ALERT.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the instance.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status of the instance. Valid values: NOT_RUN, WAIT_TIME, WAIT_RESOURCE, RUNNING, CHECKING, CHECKING_CONDITION, FAILURE, and SUCCESS. The value NOT_RUN indicates that the instance is not run. The value WAIT_TIME indicates that the instance is waiting to be run. The value WAIT_RESOURCE indicates that the instance is waiting for resources. The value RUNNING indicates that the instance is running. The value CHECKING indicates that data quality is being checked for the node for which the instance is generated. The value CHECKING_CONDITION indicates that branch conditions are being checked for the node for which the instance is generated. The value FAILURE indicates that the instance fails to run. The value SUCCESS indicates that the instance is successfully run.'."\n", 'type' => 'string', 'example' => 'NOT_RUN', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '12345', 'title' => ''], + 'NodeName' => ['description' => 'The name of the node.'."\n", 'type' => 'string', 'example' => 'Node name', 'title' => ''], + 'NodeId' => ['description' => 'The node ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'ProjectId' => ['description' => 'The ID of the workspace to which the node belongs.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Topics' => [ + 'description' => 'The events that triggered alerts. This parameter is returned if the value of the Source parameter is TOPIC_ALERT. This parameter is left empty if the value of the Source parameter is not TOPIC_ALERT.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the event.'."\n", + 'type' => 'object', + 'properties' => [ + 'TopicName' => ['description' => 'The name of the event.'."\n", 'type' => 'string', 'example' => '9527 error', 'title' => ''], + 'InstanceId' => ['description' => 'The ID of the instance that triggered the event.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '12345', 'title' => ''], + 'TopicId' => ['description' => 'The event ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'TopicOwner' => ['description' => 'The ID of the Alibaba Cloud account used by the event owner.'."\n", 'type' => 'string', 'example' => '9527952795****', 'title' => ''], + 'NodeId' => ['description' => 'The ID of the node that triggered the event.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'TopicStatus' => ['description' => 'The status of the event. Valid values: IGNORE, NEW, FIXING, and RECOVER. The value IGNORE indicates that the event is ignored. The value NEW indicates that the event is a new event. The value FIXING indicates that the event is being handled. The value RECOVER indicates that the event is handled.'."\n", 'type' => 'string', 'example' => 'FIXING', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Nodes' => [ + 'description' => 'The nodes returned for different alert sources.'."\n" + ."\n" + .'* The nodes that form a loop are returned if the value of the Source parameter is NODE_CYCLE_ALERT.'."\n" + .'* The nodes that are isolated are returned if the value of the Source parameter is NODE_LONELY_ALERT.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the node.'."\n", + 'type' => 'object', + 'properties' => [ + 'Owner' => ['description' => 'The ID of the Alibaba Cloud account used by the node owner.'."\n", 'type' => 'string', 'example' => '95279527952****', 'title' => ''], + 'NodeName' => ['description' => 'The name of the node.'."\n", 'type' => 'string', 'example' => 'Node name', 'title' => ''], + 'NodeId' => ['description' => 'The node ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'ProjectId' => ['description' => 'The ID of the workspace to which the node belongs.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'SlaAlert' => [ + 'description' => 'The basic information about the baseline instance that triggered an alert. This parameter is returned if the value of the Source parameter is SLA_ALERT. This parameter is left empty if the value of the Source parameter is not SLA_ALERT.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status of the baseline. Valid values: ERROR, SAFE, DANGEROUS, and OVER. The value ERROR indicates that no nodes are associated with the baseline, or all nodes associated with the baseline are suspended. The value SAFE indicates that nodes are run before the alert duration begins. The value DANGEROUS indicates that nodes are still running after the alert duration ends but the committed completion time does not arrive. The value OVER indicates that nodes are still running after the committed completion time.'."\n", 'type' => 'string', 'example' => 'SAFE', 'title' => ''], + 'BaselineOwner' => ['description' => 'The ID of the Alibaba Cloud account used by the baseline owner. Multiple IDs are separated by commas (,).'."\n", 'type' => 'string', 'example' => '952795279****', 'title' => ''], + 'BaselineId' => ['description' => 'The baseline ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'BaselineName' => ['description' => 'The name of the baseline.'."\n", 'type' => 'string', 'example' => 'Baseline name', 'title' => ''], + 'Bizdate' => ['description' => 'The data timestamp of the baseline instance.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1553443200000', 'title' => ''], + 'ProjectId' => ['description' => 'The ID of the workspace to which the baseline belongs.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'InGroupId' => ['description' => 'The ID of the cycle of the baseline instance. Valid values of the ID of an hour-level cycle: \\[1,24]. The ID of a day-level cycle is 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"You have no permission.\\",\\n \\"RequestId\\": \\"ecb967ec-c137-48****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"401\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n true\\n You have no permission.\\n ecb967ec-c137-48****\\n true\\n 401\\n","errorExample":""}]', - 'title' => 'CreateQualityRelativeNode', - 'summary' => 'Associates a node with a partition filter expression.', + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Resource', 'errorMessage' => 'You have reached the limit for the resource. Please contact us by submitting a ticket.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'Forbidden.Not.Server', 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.', 'description' => ''], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ], + ], + 'title' => 'ListAlertMessages', + 'summary' => 'Queries a list of alerts.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteQualityRelativeNode' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '299', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAlertMessages'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": \\"1\\",\\n \\"PageSize\\": \\"10\\",\\n \\"TotalCount\\": \\"100\\",\\n \\"AlertMessages\\": [\\n {\\n \\"RemindId\\": 1234,\\n \\"AlertMessageStatus\\": \\"READY_TO_SEND\\",\\n \\"AlertUser\\": \\"9527952795****\\",\\n \\"AlertTime\\": 1553531401000,\\n \\"AlertMethod\\": \\"SMS\\",\\n \\"Source\\": \\"REMIND_ALERT\\",\\n \\"Content\\": \\"Node error\\",\\n \\"RemindName\\": \\"Custom monitoring rule name\\",\\n \\"AlertId\\": 1234,\\n \\"Instances\\": [\\n {\\n \\"Status\\": \\"NOT_RUN\\",\\n \\"InstanceId\\": 12345,\\n \\"NodeName\\": \\"Node name\\",\\n \\"NodeId\\": 1234,\\n \\"ProjectId\\": 1234\\n }\\n ],\\n \\"Topics\\": [\\n {\\n \\"TopicName\\": \\"9527 error\\",\\n \\"InstanceId\\": 12345,\\n \\"TopicId\\": 1234,\\n \\"TopicOwner\\": \\"9527952795****\\",\\n \\"NodeId\\": 1234,\\n \\"TopicStatus\\": \\"FIXING\\"\\n }\\n ],\\n \\"Nodes\\": [\\n {\\n \\"Owner\\": \\"95279527952****\\",\\n \\"NodeName\\": \\"Node name\\",\\n \\"NodeId\\": 1234,\\n \\"ProjectId\\": 1234\\n }\\n ],\\n \\"SlaAlert\\": {\\n \\"Status\\": \\"SAFE\\",\\n \\"BaselineOwner\\": \\"952795279****\\",\\n \\"BaselineId\\": 1234,\\n \\"BaselineName\\": \\"Baseline name\\",\\n \\"Bizdate\\": 1553443200000,\\n \\"ProjectId\\": 1234,\\n \\"InGroupId\\": 1\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListBaselineConfigs' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'list', + 'abilityTreeCode' => '78295', + 'abilityTreeNodes' => ['FEATUREdideSFSFU4'], ], 'parameters' => [ [ - 'name' => 'EnvType', + 'name' => 'PageNumber', 'in' => 'formData', - 'schema' => [ - 'description' => 'The type of the compute engine or data source. Valid values:'."\n" - ."\n" - .'* cdh'."\n" - .'* analyticdb_for_mysql'."\n" - .'* odps'."\n" - .'* emr'."\n" - .'* hadoop'."\n" - .'* holodb'."\n" - .'* hybriddb_for_postgresql'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ODPS', - 'maxLength' => 40, - 'minLength' => 1, - ], + 'schema' => ['description' => 'The page number. Valid values: 1 to 30. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'MatchExpression', + 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => 'The partition filter expression.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'dt=$[yyyymmdd]', - 'maxLength' => 80, - 'minLength' => 1, - ], + 'schema' => ['description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 10.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''], ], [ - 'name' => 'NodeId', + 'name' => 'Owner', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the node.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '156234', - ], + 'schema' => ['description' => 'The ID of the Alibaba Cloud account used by the baseline owner.'."\n", 'type' => 'string', 'required' => false, 'example' => '95279527****', 'title' => ''], ], [ 'name' => 'ProjectId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the workspace.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '12345', - ], + 'schema' => ['description' => 'The workspace ID. You can call the ListProjects operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1234', 'title' => ''], ], [ - 'name' => 'TargetNodeProjectName', + 'name' => 'Priority', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the workspace to which the node associated with the partition filter expression belongs.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'autotest', - 'maxLength' => 512, - 'minLength' => 1, - ], + 'schema' => ['description' => 'The priority of the baseline. Valid values: {1,3,5,7,8}. Separate multiple priorities with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => '1,3,5,7,8', 'title' => ''], ], [ - 'name' => 'ProjectName', + 'name' => 'Useflag', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the compute engine instance or data source.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'autotest', - ], + 'schema' => ['description' => 'Specifies whether to enable the baseline. Valid values: true and false.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'TableName', + 'name' => 'BaselineTypes', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the table that is generated by the node.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'dual', - 'maxLength' => 128, - 'minLength' => 1, - ], + 'schema' => ['description' => 'The type of the baseline. Valid values: DAILY and HOURLY. Separate multiple baseline types with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => 'DAILY,HOURLY', 'title' => ''], ], [ - 'name' => 'TargetNodeProjectId', + 'name' => 'SearchText', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the workspace to which the node associated with the partition filter expression belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '12345', - ], + 'schema' => ['description' => 'The keyword in the baseline name, which is used to search for the baseline.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Baseline name search keywords', 'title' => ''], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'Indicates whether the node is disassociated from the partition filter expression.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'You have no permission.', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '6d739ef6-098a-47****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'example' => '401', + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0000-ABCD-EFG****', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The specified parameters are invalid.', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '1031203110005', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of baselines returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'Baselines' => [ + 'description' => 'The baselines.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'HourSlaDetail' => ['description' => 'The committed completion time of the hour-level baseline. This parameter is presented as key-value pairs in the JSON format. The key indicates the ID of the cycle, and the value is presented in the hh:mm format. Valid values of hh: \\[0,47]. Valid values of mm: \\[0,59].'."\n", 'type' => 'string', 'example' => '{"1":"03:58","2":"04:58","3":"05:58","4":"06:58","5":"07:58","6":"08:58","7":"09:58","8":"10:58","9":"11:58","10":"12:58","11":"13:58","12":"14:58","13":"15:58","14":"16:58","15":"17:58","16":"18:58","17":"19:58","18":"20:58","19":"21:58","20":"22:58","21":"23:58","22":"24:58","23":"25:58","24":"26:58"}', 'title' => ''], + 'IsDefault' => ['description' => 'Indicates whether the baseline is a default baseline of the workspace. Valid values: true and false.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Owner' => ['description' => 'The ID of the Alibaba Cloud account used by the baseline owner. Multiple IDs can be specified. The IDs are separated by commas (,).'."\n", 'type' => 'string', 'example' => '952795****', 'title' => ''], + 'ProjectId' => ['description' => 'The ID of the workspace to which the baseline belongs.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100001', 'title' => ''], + 'Priority' => ['description' => 'The priority of the baseline. Valid values: {1,3,5,7,8}.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'SlaMinu' => ['description' => 'The minute in the alerting time of the day-level baseline. Valid values: \\[0, 59].'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'SlaHour' => ['description' => 'The hour in the committed completion time of the day-level baseline. Valid values: \\[0, 47].'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '9', 'title' => ''], + 'BaselineId' => ['description' => 'The baseline ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'BaselineName' => ['description' => 'The name of the baseline.'."\n", 'type' => 'string', 'example' => 'Baseline name', 'title' => ''], + 'HourExpDetail' => ['description' => 'The alerting time of the hour-level baseline. This parameter is presented as key-value pairs in the JSON format. The key indicates the ID of the cycle, and the value is presented in the hh:mm format. Valid values of hh: \\[0,47]. Valid values of mm: \\[0,59].'."\n", 'type' => 'string', 'example' => '{"1":"03:28","2":"04:28","3":"05:28","4":"06:28","5":"07:28","6":"08:28","7":"09:28","8":"10:28","9":"11:28","10":"12:28","11":"13:28","12":"14:28","13":"15:28","14":"16:28","15":"17:28","16":"18:28","17":"19:28","18":"20:28","19":"21:28","20":"22:28","21":"23:28","22":"24:28","23":"25:28","24":"26:28"}', 'title' => ''], + 'UseFlag' => ['description' => 'Indicates whether the baseline is enabled. Valid values: true and false.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ExpHour' => ['description' => 'The hour in the alerting time of the day-level baseline. Valid values: \\[0, 47].'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '7', 'title' => ''], + 'BaselineType' => ['description' => 'The type of the baseline. Valid values: DAILY and HOURLY.'."\n", 'type' => 'string', 'example' => 'DAILY', 'title' => ''], + 'ExpMinu' => ['description' => 'The minute in the alerting time of the day-level baseline. Valid values: \\[0, 59].'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"You have no permission.\\",\\n \\"RequestId\\": \\"6d739ef6-098a-47****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"401\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n true\\n You have no permission.\\n 6d739ef6-098a-47****\\n true\\n 401\\n","errorExample":""}]', - 'title' => 'DeleteQualityRelativeNode', - 'summary' => 'Disassociates a node from a partition filter expression.', + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'Forbidden.Not.Server', 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.', 'description' => ''], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ], + ], + 'title' => 'ListBaselineConfigs', + 'summary' => 'Queries a list of baselines.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListQualityResultsByEntity' => [ - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2023-01-10T12:27:18.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '99', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListBaselineConfigs'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Baselines\\": [\\n {\\n \\"HourSlaDetail\\": \\"{\\\\\\"1\\\\\\":\\\\\\"03:58\\\\\\",\\\\\\"2\\\\\\":\\\\\\"04:58\\\\\\",\\\\\\"3\\\\\\":\\\\\\"05:58\\\\\\",\\\\\\"4\\\\\\":\\\\\\"06:58\\\\\\",\\\\\\"5\\\\\\":\\\\\\"07:58\\\\\\",\\\\\\"6\\\\\\":\\\\\\"08:58\\\\\\",\\\\\\"7\\\\\\":\\\\\\"09:58\\\\\\",\\\\\\"8\\\\\\":\\\\\\"10:58\\\\\\",\\\\\\"9\\\\\\":\\\\\\"11:58\\\\\\",\\\\\\"10\\\\\\":\\\\\\"12:58\\\\\\",\\\\\\"11\\\\\\":\\\\\\"13:58\\\\\\",\\\\\\"12\\\\\\":\\\\\\"14:58\\\\\\",\\\\\\"13\\\\\\":\\\\\\"15:58\\\\\\",\\\\\\"14\\\\\\":\\\\\\"16:58\\\\\\",\\\\\\"15\\\\\\":\\\\\\"17:58\\\\\\",\\\\\\"16\\\\\\":\\\\\\"18:58\\\\\\",\\\\\\"17\\\\\\":\\\\\\"19:58\\\\\\",\\\\\\"18\\\\\\":\\\\\\"20:58\\\\\\",\\\\\\"19\\\\\\":\\\\\\"21:58\\\\\\",\\\\\\"20\\\\\\":\\\\\\"22:58\\\\\\",\\\\\\"21\\\\\\":\\\\\\"23:58\\\\\\",\\\\\\"22\\\\\\":\\\\\\"24:58\\\\\\",\\\\\\"23\\\\\\":\\\\\\"25:58\\\\\\",\\\\\\"24\\\\\\":\\\\\\"26:58\\\\\\"}\\",\\n \\"IsDefault\\": true,\\n \\"Owner\\": \\"952795****\\",\\n \\"ProjectId\\": 100001,\\n \\"Priority\\": 1,\\n \\"SlaMinu\\": 30,\\n \\"SlaHour\\": 9,\\n \\"BaselineId\\": 1234,\\n \\"BaselineName\\": \\"Baseline name\\",\\n \\"HourExpDetail\\": \\"{\\\\\\"1\\\\\\":\\\\\\"03:28\\\\\\",\\\\\\"2\\\\\\":\\\\\\"04:28\\\\\\",\\\\\\"3\\\\\\":\\\\\\"05:28\\\\\\",\\\\\\"4\\\\\\":\\\\\\"06:28\\\\\\",\\\\\\"5\\\\\\":\\\\\\"07:28\\\\\\",\\\\\\"6\\\\\\":\\\\\\"08:28\\\\\\",\\\\\\"7\\\\\\":\\\\\\"09:28\\\\\\",\\\\\\"8\\\\\\":\\\\\\"10:28\\\\\\",\\\\\\"9\\\\\\":\\\\\\"11:28\\\\\\",\\\\\\"10\\\\\\":\\\\\\"12:28\\\\\\",\\\\\\"11\\\\\\":\\\\\\"13:28\\\\\\",\\\\\\"12\\\\\\":\\\\\\"14:28\\\\\\",\\\\\\"13\\\\\\":\\\\\\"15:28\\\\\\",\\\\\\"14\\\\\\":\\\\\\"16:28\\\\\\",\\\\\\"15\\\\\\":\\\\\\"17:28\\\\\\",\\\\\\"16\\\\\\":\\\\\\"18:28\\\\\\",\\\\\\"17\\\\\\":\\\\\\"19:28\\\\\\",\\\\\\"18\\\\\\":\\\\\\"20:28\\\\\\",\\\\\\"19\\\\\\":\\\\\\"21:28\\\\\\",\\\\\\"20\\\\\\":\\\\\\"22:28\\\\\\",\\\\\\"21\\\\\\":\\\\\\"23:28\\\\\\",\\\\\\"22\\\\\\":\\\\\\"24:28\\\\\\",\\\\\\"23\\\\\\":\\\\\\"25:28\\\\\\",\\\\\\"24\\\\\\":\\\\\\"26:28\\\\\\"}\\",\\n \\"UseFlag\\": true,\\n \\"ExpHour\\": 7,\\n \\"BaselineType\\": \\"DAILY\\",\\n \\"ExpMinu\\": 30\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListBaselineStatuses' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -42730,487 +22751,293 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '78329', - 'abilityTreeNodes' => [ - 'FEATUREdideGK4B66', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '78296', + 'abilityTreeNodes' => ['FEATUREdideSFSFU4'], ], 'parameters' => [ [ - 'name' => 'EntityId', + 'name' => 'PageNumber', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the partition filter expression. You can call the [GetQualityEntity](~~174003~~) operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '152322134', - ], + 'schema' => ['description' => 'The number of the page to return. Valid values: 1 to 30. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'StartDate', + 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the yyyy-MM-dd HH:mm:ss format.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2020-09-20 00:00:00', - ], + 'schema' => ['description' => 'The number of entries to return on each page. Default value: 10. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''], ], [ - 'name' => 'EndDate', + 'name' => 'Bizdate', 'in' => 'formData', - 'schema' => [ - 'description' => 'The end of the time range to query. Specify the time in the yyyy-MM-dd HH:mm:ss format.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2020-09-21 00:00:00', - ], + 'schema' => ['description' => 'The data timestamp of the baseline instance. Specify the time in the ISO 8601 standard in the yyyy-MM-dd\'T\'HH:mm:ssZ format. The time must be in UTC.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-07-07T00:00:00+0800', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'Priority', 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 20.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '20', - 'minimum' => '1', - 'example' => '10', - ], + 'schema' => ['description' => 'The priority of the baseline. Valid values: 1, 3, 5, 7, and 8. Multiple priorities are separated by commas (,).', 'type' => 'string', 'required' => false, 'example' => '1,3,5,7,8', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'SearchText', 'in' => 'formData', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '1', - ], + 'schema' => ['description' => 'The keyword of the baseline name used to search for the baseline.', 'type' => 'string', 'example' => 'Keyword', 'required' => false, 'title' => ''], ], [ - 'name' => 'ProjectName', + 'name' => 'Owner', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the compute engine or data source. You can obtain the name from data source configurations.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'autotest', - ], + 'schema' => ['description' => 'The ID of the Alibaba Cloud account used by the baseline owner.', 'type' => 'string', 'required' => false, 'example' => '9527952795****', 'title' => ''], ], [ - 'name' => 'ProjectId', + 'name' => 'TopicId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '12345', - ], + 'schema' => ['description' => 'The ID of the event.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234', 'title' => ''], + ], + [ + 'name' => 'FinishStatus', + 'in' => 'formData', + 'schema' => ['description' => 'The status of the baseline instance. Valid values: UNFINISH and FINISH. The value UNFINISH indicates that the baseline instance is still running. The value FINISH indicates that the baseline instance finishes running. Multiple states are separated by commas (,).', 'type' => 'string', 'required' => false, 'example' => 'FINISH,UNFINISH', 'title' => ''], + ], + [ + 'name' => 'Status', + 'in' => 'formData', + 'schema' => ['description' => 'The status of the baseline. Valid values: ERROR, SAFE, DANGEROUS, and OVER. The value ERROR indicates that no nodes are associated with the baseline, or all nodes associated with the baseline are suspended. The value SAFE indicates that nodes finish running before the alerting time. The value DANGEROUS indicates that nodes are still running after the alerting time but before the committed completion time. The value OVER indicates that nodes are still running after the committed completion time. Multiple states are separated by commas (,).', 'type' => 'string', 'required' => false, 'example' => 'SAFE,DANGROUS,OVER', 'title' => ''], + ], + [ + 'name' => 'BaselineTypes', + 'in' => 'formData', + 'schema' => ['description' => 'The type of the baseline. Valid values: DAILY and HOURLY. The value DAILY indicates that the baseline is scheduled by day. The value HOURLY indicates that the baseline is scheduled by hour. Multiple types are separated by commas (,).', 'type' => 'string', 'required' => false, 'example' => 'DAILY,HOURLY', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The returned result.'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'You have no permission.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'CBA58543-00D4-41****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '401', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request. You can use the ID to troubleshoot issues.', 'type' => 'string', 'example' => '0000-ABCD-EFG****', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned.', 'type' => 'string', 'example' => 'The specified parameters are invalid.', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned.', 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'The data structure of the check results.'."\n", + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '50', - ], - 'RuleChecks' => [ - 'description' => 'The returned check results.'."\n", + 'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of baseline instances.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'BaselineStatuses' => [ + 'description' => 'The list of baseline instances.', 'type' => 'array', 'items' => [ - 'description' => 'The returned check result.'."\n", + 'description' => 'The information about the baseline instances.', 'type' => 'object', 'properties' => [ - 'BlockType' => [ - 'description' => 'The strength of the monitoring rule. The strength of a monitoring rule indicates the importance of the rule. Valid values:'."\n" - ."\n" - .'* 1: the monitoring rule is a strong rule.'."\n" - .'* 0: the monitoring rule is a weak rule. You can specify whether a monitoring rule is a strong rule based on your business requirements. If a monitoring rule is a strong rule and the critical threshold is exceeded, a critical alert is reported and tasks that are associated with the rule are blocked from running.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'WarningThreshold' => [ - 'description' => 'The threshold for a warning alert. The threshold indicates the deviation of the check result from the expected value. You can customize this threshold based on your business requirements.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0.1', - ], - 'Property' => [ - 'description' => 'The field whose data quality is checked based on the monitoring rule. This field is a column in the data source table that is monitored.'."\n", - 'type' => 'string', - 'example' => 'type', - ], - 'TableName' => [ - 'description' => 'The name of the table that is monitored.'."\n", - 'type' => 'string', - 'example' => 'dual', - ], - 'Comment' => [ - 'description' => 'The description of the monitoring rule.'."\n", - 'type' => 'string', - 'example' => 'The description of the rule.', - ], - 'CheckResultStatus' => [ - 'description' => 'The check result of the monitoring rule. Valid values:'."\n" - ."\n" - .'* 0: indicates that the data source table is normal.'."\n" - .'* 1: indicates that a warning alert is reported.'."\n" - .'* 2: indicates that a critical alert is reported.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'TemplateName' => [ - 'description' => 'The name of the monitoring template.'."\n", - 'type' => 'string', - 'example' => 'Expected value verification', - ], - 'CheckerName' => [ - 'description' => 'The name of the checker.'."\n", - 'type' => 'string', - 'example' => 'fulx', - ], - 'RuleId' => [ - 'description' => 'The ID of the monitoring rule.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123123232', - ], - 'FixedCheck' => [ - 'description' => 'Indicates whether the monitoring is performed based on a fixed value. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'Op' => [ - 'description' => 'The comparison operator.'."\n", - 'type' => 'string', - 'example' => '>', - ], - 'UpperValue' => [ - 'description' => 'The upper limit of the predicted result. The value of this parameter is automatically generated based on the threshold that you specify.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '25555', - ], - 'ActualExpression' => [ - 'description' => 'The monitored partition in the data source table.'."\n", - 'type' => 'string', - 'example' => 'ds=20200912', - ], - 'ExternalId' => [ - 'description' => 'The node ID.'."\n", - 'type' => 'string', - 'example' => '1112323123', - ], - 'TimeCost' => [ - 'description' => 'The time that was taken to run the monitoring task. Unit: seconds.'."\n", - 'type' => 'string', - 'example' => '202', - ], - 'Trend' => [ - 'description' => 'The trend of the check result.'."\n", - 'type' => 'string', - 'example' => 'abs', - ], - 'ExternalType' => [ - 'description' => 'The type of the scheduling system. Only CWF scheduling systems are supported.'."\n", - 'type' => 'string', - 'example' => 'CWF2', - ], - 'BizDate' => [ - 'description' => 'The data timestamp. In most cases, if the monitored business entity is offline data, the value is one day before the monitoring is performed.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1600704000000', - ], - 'CheckResult' => [ - 'description' => 'The check result. The value of this parameter is the same as the value of the CheckResultStatus parameter. Valid values:'."\n" - ."\n" - .'* 0: indicates that the data source table is normal.'."\n" - .'* 1: indicates that a warning alert is reported.'."\n" - .'* 2: indicates that a critical alert is reported.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ResultString' => [ - 'description' => 'The string of the check result.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'MatchExpression' => [ - 'description' => 'The partition filter expression.'."\n", - 'type' => 'string', - 'example' => 'ds=$[yyyymmdd]', - ], - 'CheckerType' => [ - 'description' => 'The check type. Valid values:'."\n" - ."\n" - .'* 0: indicates that the monitoring is performed based on a fixed value.'."\n" - .'* 1: indicates that the monitoring is performed based on a non-fixed value.'."\n" - .'* 2: indicates that the monitoring is performed based on a dynamic threshold.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ProjectName' => [ - 'description' => 'The name of the compute engine or data source for which data quality is monitored.'."\n", - 'type' => 'string', - 'example' => 'autotest', - ], - 'BeginTime' => [ - 'description' => 'The time when the monitoring started.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1600704000000', - ], - 'DateType' => [ - 'description' => 'The scheduling frequency. In most cases, the value of this parameter is YMD. This value indicates year, month, and day.'."\n", - 'type' => 'string', - 'example' => 'YMD', - ], - 'CriticalThreshold' => [ - 'description' => 'The threshold for a critical alert. The threshold indicates the deviation of the check result from the expected value. You can specify a value for the threshold based on your business requirements. If a monitoring rule is a strong rule and the critical threshold is exceeded, a critical alert is reported and tasks that are associated with the rule are blocked from running.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0.5', - ], - 'IsPrediction' => [ - 'description' => 'Indicates whether the check result is the same as the predicted result. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RuleName' => [ - 'description' => 'The name of the monitoring rule.'."\n", - 'type' => 'string', - 'example' => 'The name of the rule.', - ], - 'CheckerId' => [ - 'description' => 'The checker ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - ], - 'DiscreteCheck' => [ - 'description' => 'Indicates whether the monitoring is discrete monitoring. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'EndTime' => [ - 'description' => 'The deadline for querying the check result.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1600704000000', - ], - 'MethodName' => [ - 'description' => 'The method used to collect sample data, such as such as avg, count, sum, min, max, count_distinct, user_defined, table_count, table_size, table_dt_load_count, table_dt_refuseload_count, null_value, null_value/table_count, (table_count-count_distinct)/table_count, or table_count-count_distinct.'."\n", - 'type' => 'string', - 'example' => 'count_distinct', - ], - 'LowerValue' => [ - 'description' => 'The lower limit of the predicted result. The value of this parameter is automatically generated based on the threshold that you specify.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '2344', - ], - 'EntityId' => [ - 'description' => 'The ID of the partition filter expression.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '15432322', - ], - 'WhereCondition' => [ - 'description' => 'The filter condition of the monitoring rule.'."\n", - 'type' => 'string', - 'example' => 'id>0', - ], - 'ExpectValue' => [ - 'description' => 'The expected value.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '200', - ], - 'TemplateId' => [ - 'description' => 'The ID of the monitoring template.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'TaskId' => [ - 'description' => 'The monitoring task ID.'."\n", - 'type' => 'string', - 'example' => '16008552981681a0d6****', - ], - 'Id' => [ - 'description' => 'The primary key ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '121212121', - ], - 'ReferenceValue' => [ - 'description' => 'The historical sample values.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'DiscreteProperty' => [ - 'description' => 'The values of the sample field that are grouped by using the GROUP BY clause. For example, the values of the Gender field are grouped by using the GROUP BY clause. In this case, the values of the DiscreteProperty parameter are Male, Female, and null.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'Value' => [ - 'description' => 'The check value.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '19', - ], - 'BizDate' => [ - 'description' => 'The data timestamp. In most cases, if the monitored business entity is offline data, the value is one day before the monitoring is performed.'."\n", - 'type' => 'string', - 'example' => '2020-12-03', - ], - 'SingleCheckResult' => [ - 'description' => 'The check result.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Threshold' => [ - 'description' => 'The threshold.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0.5', - ], - ], - ], - ], - 'SampleValue' => [ - 'description' => 'The current sample value.'."\n", + 'Status' => ['description' => 'The status of the baseline. Valid values: ERROR, SAFE, DANGEROUS, and OVER. The value ERROR indicates that no nodes are associated with the baseline, or all nodes associated with the baseline are suspended. The value SAFE indicates that nodes are run before the alert duration begins. The value DANGEROUS indicates that nodes are still running after the alert duration ends but the committed completion time does not arrive. The value OVER indicates that nodes are still running after the committed completion time.', 'type' => 'string', 'example' => 'SAFE', 'title' => ''], + 'Owner' => ['description' => 'The ID of the Alibaba Cloud account used by the baseline owner. Multiple IDs are separated by commas (,).', 'type' => 'string', 'example' => '9527952795****', 'title' => ''], + 'FinishTime' => ['description' => 'The timestamp of the actual time when the baseline instance finished running. This parameter is returned if the value of the FinishStatus parameter is FINISH.', 'type' => 'integer', 'format' => 'int64', 'example' => '1553531400000', 'title' => ''], + 'ProjectId' => ['description' => 'The ID of the workspace to which the baseline belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'Priority' => ['description' => 'The priority of the baseline. Valid values: {1,3,5,7,8}.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'EndCast' => ['description' => 'The timestamp of the predicted time when the baseline instance finished running.', 'type' => 'integer', 'format' => 'int64', 'example' => '1553531400000', 'title' => ''], + 'InGroupId' => ['description' => 'The ID of the cycle of the baseline instance. Valid values of the ID of an hour-level cycle: \\[1,24]. The ID of a day-level cycle is 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'BaselineName' => ['description' => 'The name of the baseline.', 'type' => 'string', 'example' => 'Baseline name', 'title' => ''], + 'BaselineId' => ['description' => 'The baseline ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'FinishStatus' => ['description' => 'The status of the baseline instance. Valid values: UNFINISH and FINISH.', 'type' => 'string', 'example' => 'UNFINISH', 'title' => ''], + 'Bizdate' => ['description' => 'The data timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1553443200000', 'title' => ''], + 'Buffer' => ['description' => 'The margin of the baseline instance. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1800', 'title' => ''], + 'SlaTime' => ['description' => 'The timestamp of the actual time when the baseline instance finished running.', 'type' => 'integer', 'format' => 'int64', 'example' => '1553531400000', 'title' => ''], + 'ExpTime' => ['description' => 'The timestamp of the alerting time of the baseline instance.', 'type' => 'integer', 'format' => 'int64', 'example' => '1553531400000', 'title' => ''], + 'BaselineType' => ['description' => 'The type of the baseline, including DAILY and HOURLY. Separate multiple types with commas (,).', 'type' => 'string', 'example' => 'Baseline type', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'Forbidden.Not.Server', 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.', 'description' => ''], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"BaselineStatuses\\": [\\n {\\n \\"Status\\": \\"SAFE\\",\\n \\"Owner\\": \\"9527952795****\\",\\n \\"FinishTime\\": 1553531400000,\\n \\"ProjectId\\": 1234,\\n \\"Priority\\": 1,\\n \\"EndCast\\": 1553531400000,\\n \\"InGroupId\\": 1,\\n \\"BaselineName\\": \\"Baseline name\\",\\n \\"BaselineId\\": 1234,\\n \\"FinishStatus\\": \\"UNFINISH\\",\\n \\"Bizdate\\": 1553443200000,\\n \\"Buffer\\": 1800,\\n \\"SlaTime\\": 1553531400000,\\n \\"ExpTime\\": 1553531400000,\\n \\"BaselineType\\": \\"Baseline type\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListBaselineStatuses', + 'summary' => 'Queries a list of baseline instances.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-02-20T11:27:26.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '99', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListBaselineStatuses'], + ], + ], + 'ramActions' => [], + 'translator' => 'manual', + ], + 'ListBaselines' => [ + 'summary' => 'Obtains a list of baselines.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '158237', + 'abilityTreeNodes' => ['FEATUREdideSFSFU4'], + ], + 'parameters' => [ + [ + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => ['description' => 'The owner.'."\n", 'type' => 'string', 'title' => '', 'required' => false, 'example' => '3726346****'], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '123456'], + ], + [ + 'name' => 'Priority', + 'in' => 'formData', + 'schema' => ['description' => 'The priority of the baseline. Valid values: {1,3,5,7,8}.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Enable', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to enable the baseline. Valid values: true and false.'."\n", 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'BaselineTypes', + 'in' => 'formData', + 'schema' => ['description' => 'The type of the baseline. Valid values: DAILY and HOURLY. You can specify multiple types. Separate multiple types with commas (,).'."\n", 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'DAILY'], + ], + [ + 'name' => 'SearchText', + 'in' => 'formData', + 'schema' => ['description' => 'The keyword in the baseline name, which is used to search for the baseline.'."\n", 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'baselineName'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => ['description' => 'The page number. Pages start from page 1. Default value: 1. Maximum value: 30.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '100', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiResultModel', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '103630001', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned if the request failed.'."\n", 'type' => 'string', 'example' => 'The user does not exist. 276571706358178756', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'string', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of baselines returned.'."\n", 'type' => 'string', 'example' => '100', 'title' => ''], + 'Baselines' => [ + 'description' => 'The baselines.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'BaselineId' => ['description' => 'The baseline ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'ProjectId' => ['description' => 'The ID of the workspace to which the baseline belongs.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '9527', 'title' => ''], + 'BaselineType' => ['description' => 'The type of the baseline. Valid values: DAILY and HOURLY.'."\n", 'type' => 'string', 'example' => 'DAILY', 'title' => ''], + 'Priority' => ['description' => 'The priority of the baseline. Valid values: {1,2,5,7,8}.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Owner' => ['description' => 'The ID of the Alibaba Cloud account used by the baseline owner. Multiple IDs can be specified. The IDs are separated by commas (,).'."\n", 'type' => 'string', 'example' => '952795****', 'title' => ''], + 'BaselineName' => ['description' => 'The name of the baseline.'."\n", 'type' => 'string', 'example' => 'BaselineName', 'title' => ''], + 'Enabled' => ['description' => 'Indicates whether the baseline is enabled. Valid values: true and false.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'AlertEnabled' => ['description' => 'Indicates whether the alerting feature is enabled. Valid values: true and false.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'AlertMarginThreshold' => ['description' => 'The alert margin threshold for the baseline instance. Unit: minutes.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'OverTimeSettings' => [ + 'description' => 'The settings of the committed completion time of the baseline.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ - 'DiscreteProperty' => [ - 'description' => 'The values of the sample field that are grouped by using the GROUP BY clause. For example, the values of the Gender field are grouped by using the GROUP BY clause. In this case, the values of the DiscreteProperty parameter are Male, Female, and null.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'BizDate' => [ - 'description' => 'The data timestamp. In most cases, if the monitored business entity is offline data, the value is one day before the monitoring is performed.'."\n", - 'type' => 'string', - 'example' => '2020-12-03', - ], - 'Value' => [ - 'description' => 'The current sample value.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '19', - ], + 'Cycle' => ['description' => 'The cycle that corresponds to the committed completion time. For a day-level baseline, the value of this parameter is 1. For an hour-level baseline, the value of this parameter cannot exceed 24.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Time' => ['description' => 'The committed completion time in the hh:mm format. Valid values of hh: \\[0,47]. Valid values of mm: \\[0,59].'."\n", 'type' => 'string', 'example' => '00:00', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '952795279527ab****', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"You have no permission.\\",\\n \\"RequestId\\": \\"CBA58543-00D4-41****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"401\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 50,\\n \\"RuleChecks\\": [\\n {\\n \\"BlockType\\": 0,\\n \\"WarningThreshold\\": 0.1,\\n \\"Property\\": \\"type\\",\\n \\"TableName\\": \\"dual\\",\\n \\"Comment\\": \\"The description of the rule.\\",\\n \\"CheckResultStatus\\": 0,\\n \\"TemplateName\\": \\"Expected value verification\\",\\n \\"CheckerName\\": \\"fulx\\",\\n \\"RuleId\\": 123123232,\\n \\"FixedCheck\\": false,\\n \\"Op\\": \\">\\",\\n \\"UpperValue\\": 25555,\\n \\"ActualExpression\\": \\"ds=20200912\\",\\n \\"ExternalId\\": \\"1112323123\\",\\n \\"TimeCost\\": \\"202\\",\\n \\"Trend\\": \\"abs\\",\\n \\"ExternalType\\": \\"CWF2\\",\\n \\"BizDate\\": 1600704000000,\\n \\"CheckResult\\": 0,\\n \\"ResultString\\": \\"test\\",\\n \\"MatchExpression\\": \\"ds=$[yyyymmdd]\\",\\n \\"CheckerType\\": 1,\\n \\"ProjectName\\": \\"autotest\\",\\n \\"BeginTime\\": 1600704000000,\\n \\"DateType\\": \\"YMD\\",\\n \\"CriticalThreshold\\": 0.5,\\n \\"IsPrediction\\": true,\\n \\"RuleName\\": \\"The name of the rule.\\",\\n \\"CheckerId\\": 7,\\n \\"DiscreteCheck\\": true,\\n \\"EndTime\\": 1600704000000,\\n \\"MethodName\\": \\"count_distinct\\",\\n \\"LowerValue\\": 2344,\\n \\"EntityId\\": 15432322,\\n \\"WhereCondition\\": \\"id>0\\",\\n \\"ExpectValue\\": 200,\\n \\"TemplateId\\": 5,\\n \\"TaskId\\": \\"16008552981681a0d6****\\",\\n \\"Id\\": 121212121,\\n \\"ReferenceValue\\": [\\n {\\n \\"DiscreteProperty\\": \\"0\\",\\n \\"Value\\": 19,\\n \\"BizDate\\": \\"2020-12-03\\",\\n \\"SingleCheckResult\\": 0,\\n \\"Threshold\\": 0.5\\n }\\n ],\\n \\"SampleValue\\": [\\n {\\n \\"DiscreteProperty\\": \\"0\\",\\n \\"BizDate\\": \\"2020-12-03\\",\\n \\"Value\\": 19\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n You have no permission.\\n CBA58543-00D4-41****\\n true\\n 401\\n \\n 1\\n 10\\n 50\\n \\n 0\\n 0.1\\n type\\n dual\\n 规则的描述信息。\\n 0\\n 字段唯一值个数期望值校验\\n fulx\\n 123123232\\n false\\n >\\n 25555\\n ds=20200912\\n 1112323123\\n 202\\n abs\\n CWF2\\n 1600704000000\\n 0\\n test\\n ds=$[yyyymmdd]\\n 1\\n autotest\\n 1600704000000\\n YMD\\n 0.5\\n true\\n 规则的名称。\\n 7\\n true\\n 1600704000000\\n count_distinct\\n 2344\\n 15432322\\n id>0\\n 200\\n 5\\n 16008552981681a0d6****\\n 121212121\\n \\n 0\\n 19\\n 2020-12-03\\n 0\\n 0.5\\n \\n \\n 0\\n 2020-12-03\\n 19\\n \\n \\n \\n","errorExample":""}]', - 'title' => 'ListQualityResultsByEntity', - 'summary' => 'Queries a list of historical check results based on a partition filter expression.', - 'description' => '****', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListQualityResultsByRule' => [ - 'methods' => [ - 'post', + 'title' => 'ListBaselines', + 'changeSet' => [ + ['createdAt' => '2022-12-02T06:25:11.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-11-16T09:08:31.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"103630001\\",\\n \\"ErrorMessage\\": \\"The user does not exist. 276571706358178756\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"PageNumber\\": \\"1\\",\\n \\"PageSize\\": \\"10\\",\\n \\"TotalCount\\": \\"100\\",\\n \\"Baselines\\": [\\n {\\n \\"BaselineId\\": 1234,\\n \\"ProjectId\\": 9527,\\n \\"BaselineType\\": \\"DAILY\\",\\n \\"Priority\\": 1,\\n \\"Owner\\": \\"952795****\\",\\n \\"BaselineName\\": \\"BaselineName\\",\\n \\"Enabled\\": true,\\n \\"AlertEnabled\\": true,\\n \\"AlertMarginThreshold\\": 30,\\n \\"OverTimeSettings\\": [\\n {\\n \\"Cycle\\": 1,\\n \\"Time\\": \\"00:00\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"RequestId\\": \\"952795279527ab****\\"\\n}","type":"json"}]', + ], + 'ListBusiness' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -43220,2794 +23047,1900 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', + 'abilityTreeCode' => '78297', + 'abilityTreeNodes' => ['FEATUREdide8FM783'], ], 'parameters' => [ [ - 'name' => 'RuleId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The monitoring rule ID. You can use the ID and information such as a partition filter expression to perform a joint query.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '152322134', - ], - ], - [ - 'name' => 'StartDate', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Specify the time in the yyyy-MM-dd HH:mm:ss format.'."\n" - ."\n" - .'This parameter is used together with the EndDate parameter. The interval between the time specified by this parameter and the time specified by the EndDate parameter cannot exceed 7 days.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2020-09-20 00:00:00', - ], - ], - [ - 'name' => 'EndDate', + 'name' => 'ProjectId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The end of the time range to query. Specify the time in the yyyy-MM-dd HH:mm:ss format.'."\n" - ."\n" - .'This parameter is used together with the StartDate parameter. The interval between the time specified by this parameter and the time specified by the StartDate parameter cannot exceed 7 days.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2020-09-22 00:00:00', - ], + 'schema' => ['description' => 'The ID of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Management page to obtain the workspace ID. You must configure either this parameter or the ProjectIdentifier parameter to determine the DataWorks workspace to which the operation is applied.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10000', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'ProjectIdentifier', 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '20', - 'minimum' => '1', - 'example' => '10', - ], + 'schema' => ['description' => 'The name of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Management page to obtain the workspace name. You must configure either this parameter or ProjectId parameter to determine the DataWorks workspace to which the operation is applied.', 'type' => 'string', 'required' => false, 'example' => 'dw_project', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'formData', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '1', - ], + 'schema' => ['description' => 'The number of the page to return.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ - 'name' => 'ProjectName', + 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the compute engine or data source for which data quality is monitored.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'autotest', - ], + 'schema' => ['description' => 'The number of entries to return on each page. Default value: 10. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '0', 'example' => '10', 'title' => ''], ], [ - 'name' => 'ProjectId', + 'name' => 'Keyword', 'in' => 'formData', - 'schema' => [ - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '12345', - ], + 'schema' => ['description' => 'The keyword that is used to perform a fuzzy match.', 'type' => 'string', 'required' => false, 'example' => 'my', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The returned result.'."\n", + 'description' => '', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'You have no permission.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'CBA58543-00D4-41****', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '401', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned.', 'type' => 'string', 'example' => 'The connection does not exist.', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request. You can use the ID to troubleshoot issues.', 'type' => 'string', 'example' => '0000-ABCD-EFG****', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned.', 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'The data structure of the monitoring results returned.'."\n", + 'description' => 'The information about the workflows returned.', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'RuleChecks' => [ - 'description' => 'The returned monitoring results.'."\n", + 'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '13', 'title' => ''], + 'Business' => [ + 'description' => 'The details of the workflow.', 'type' => 'array', 'items' => [ - 'description' => 'The returned result.'."\n", + 'description' => '', 'type' => 'object', 'properties' => [ - 'BlockType' => [ - 'description' => 'The strength of the monitoring rule. The strength of a monitoring rule indicates the importance of the rule. Valid values:'."\n" - ."\n" - .'* 1: indicates that the monitoring rule is a strong rule.'."\n" - .'* 0: indicates that the monitoring rule is a weak rule. You can specify the strength of a monitoring rule based on your business requirements. If a monitoring rule is a strong rule and the critical threshold is exceeded, a critical alert is reported and tasks that are associated with the rule are blocked from running.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'WarningThreshold' => [ - 'description' => 'The threshold for a warning alert. The threshold specifies the deviation of the monitoring result from the expected value. You can specify a custom value for the threshold based on your business requirements.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0.1', - ], - 'Property' => [ - 'description' => 'The field whose data quality is checked based on the monitoring rule. This field is a column in the data source table that is monitored.'."\n", - 'type' => 'string', - 'example' => 'type', - ], - 'TableName' => [ - 'description' => 'The name of the table that is monitored.'."\n", - 'type' => 'string', - 'example' => 'dual', - ], - 'Comment' => [ - 'description' => 'The description of the monitoring rule.'."\n", - 'type' => 'string', - 'example' => 'The description of the rule.', - ], - 'CheckResultStatus' => [ - 'description' => 'The status of the monitoring result.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'TemplateName' => [ - 'description' => 'The name of the monitoring template.'."\n", - 'type' => 'string', - 'example' => 'Expected value verification', - ], - 'CheckerName' => [ - 'description' => 'The name of the checker.'."\n", - 'type' => 'string', - 'example' => 'fulx', - ], - 'RuleId' => [ - 'description' => 'The ID of the monitoring rule.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123421', - ], - 'FixedCheck' => [ - 'description' => 'Indicates whether the monitoring is performed based on a fixed value. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'Op' => [ - 'description' => 'The comparison operator.'."\n", - 'type' => 'string', - 'example' => '>', - ], - 'UpperValue' => [ - 'description' => 'The upper limit of the predicted result. The value of this parameter is automatically generated based on the threshold that you specify.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '22200', - ], - 'ActualExpression' => [ - 'description' => 'The partition in the monitored data source table.'."\n", - 'type' => 'string', - 'example' => 'ds=20200925', - ], - 'ExternalId' => [ - 'description' => 'The node ID.'."\n", - 'type' => 'string', - 'example' => '123112232', - ], - 'TimeCost' => [ - 'description' => 'The time that was taken to run the monitoring task.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'Trend' => [ - 'description' => 'The trend of the monitoring result.'."\n", - 'type' => 'string', - 'example' => 'up', - ], - 'ExternalType' => [ - 'description' => 'The type of the scheduling system. Only CWF scheduling systems are supported.'."\n", - 'type' => 'string', - 'example' => 'CWF2', - ], - 'BizDate' => [ - 'description' => 'The data timestamp. If the monitored business entity is offline data, the value is usually one day before the monitoring is performed.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1600704000000', - ], - 'CheckResult' => [ - 'description' => 'The monitoring result.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'ResultString' => [ - 'description' => 'The string of the monitoring result.'."\n", - 'type' => 'string', - 'example' => 'ResultString', - ], - 'MatchExpression' => [ - 'description' => 'The partition filter expression.'."\n", - 'type' => 'string', - 'example' => 'ds=$[yyyymmdd]', - ], - 'CheckerType' => [ - 'description' => 'The type of the checker.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ProjectName' => [ - 'description' => 'The name of the compute engine or data source for which data quality is monitored.'."\n", - 'type' => 'string', - 'example' => 'autotest', - ], - 'BeginTime' => [ - 'description' => 'The time when the monitoring started.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1600704000000', - ], - 'DateType' => [ - 'description' => 'The scheduling frequency. In most cases, the value of this parameter is YMD. This value indicates year, month, and day.'."\n", - 'type' => 'string', - 'example' => 'YMD', - ], - 'CriticalThreshold' => [ - 'description' => 'The threshold for a critical alert. The threshold indicates the deviation of the monitoring result from the expected value. You can specify a custom value for the threshold based on your business requirements. If a monitoring rule is a strong rule and the critical threshold is exceeded, a critical alert is reported and tasks that are associated with the rule are blocked from running.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0.6', - ], - 'IsPrediction' => [ - 'description' => 'Indicates whether the monitoring result is the same as the predicted result. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'RuleName' => [ - 'description' => 'The name of the monitoring rule.'."\n", - 'type' => 'string', - 'example' => 'The name of the rule.', - ], - 'CheckerId' => [ - 'description' => 'The checker ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - ], - 'DiscreteCheck' => [ - 'description' => 'Indicates whether the monitoring is discrete monitoring. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'EndTime' => [ - 'description' => 'The time when the monitoring ended.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1600704000000', - ], - 'MethodName' => [ - 'description' => 'The method used to collect sample data, such as such as avg, count, sum, min, max, count_distinct, user_defined, table_count, table_size, table_dt_load_count, table_dt_refuseload_count, null_value, null_value/table_count, (table_count-count_distinct)/table_count, or table_count-count_distinct.'."\n", - 'type' => 'string', - 'example' => 'max', - ], - 'LowerValue' => [ - 'description' => 'The lower limit of the predicted result. The value of this parameter is automatically generated based on the threshold that you specify.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '2344', - ], - 'EntityId' => [ - 'description' => 'The ID of the partition filter expression.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '14534343', - ], - 'WhereCondition' => [ - 'description' => 'The filter condition of the monitoring task.'."\n", - 'type' => 'string', - 'example' => 'type!=\'type2\'', - ], - 'ExpectValue' => [ - 'description' => 'The expected value.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '90', - ], - 'TemplateId' => [ - 'description' => 'The ID of the monitoring template.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'TaskId' => [ - 'description' => 'The monitoring task ID.'."\n", - 'type' => 'string', - 'example' => '16008552981681a0d6****', - ], - 'Id' => [ - 'description' => 'The primary key ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2231123', - ], - 'ReferenceValue' => [ - 'description' => 'The historical sample values.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'DiscreteProperty' => [ - 'description' => 'The values of the sample field that are grouped by using the GROUP BY clause. For example, the values of the Gender field are grouped by using the GROUP BY clause. In this case, the values of DiscreteProperty are Male, Female, and null.'."\n", - 'type' => 'string', - 'example' => 'type1', - ], - 'Value' => [ - 'description' => 'The sample value.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '20', - ], - 'BizDate' => [ - 'description' => 'The data timestamp. If the monitored business entity is offline data, the value is usually one day before the monitoring is performed.'."\n", - 'type' => 'string', - 'example' => '1600704000000', - ], - 'SingleCheckResult' => [ - 'description' => 'The string of the monitoring result.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'Threshold' => [ - 'description' => 'The threshold.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0.2', - ], - ], - ], - ], - 'SampleValue' => [ - 'description' => 'The current sample values.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'DiscreteProperty' => [ - 'description' => 'The values of the sample field that are grouped by using the GROUP BY clause. For example, the values of the Gender field are grouped by using the GROUP BY clause. In this case, the values of DiscreteProperty are Male, Female, and null.'."\n", - 'type' => 'string', - 'example' => 'type2', - ], - 'BizDate' => [ - 'description' => 'The data timestamp. If the monitored business entity is offline data, the value is usually one day before the monitoring is performed.'."\n", - 'type' => 'string', - 'example' => '1600704000000', - ], - 'Value' => [ - 'description' => 'The sample value.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '23', - ], - ], - ], - ], - 'Open' => [ - 'description' => 'Indicates whether the monitoring rule is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], + 'Owner' => ['description' => 'The owner of the workflow.', 'type' => 'string', 'example' => '34824327****', 'title' => ''], + 'Description' => ['description' => 'The description of the workflow.', 'type' => 'string', 'example' => 'My first workflow', 'title' => ''], + 'ProjectId' => ['description' => 'The ID of the workspace to which the workflow belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'title' => ''], + 'BusinessId' => ['description' => 'The ID of the workflow.', 'type' => 'integer', 'format' => 'int64', 'example' => '3000001', 'title' => ''], + 'BusinessName' => ['description' => 'The name of the workflow.', 'type' => 'string', 'example' => 'My first workflow', 'title' => ''], + 'UseType' => ['description' => 'The module to which the workflow belongs. Valid values: NORMAL and MANUAL\\_BIZ. The value NORMAL indicates that the workflow belongs to auto triggered workflows. The value MANUAL\\_BIZ indicates that the workflow belongs to manually triggered workflows.', 'type' => 'string', 'example' => 'NORMAL', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"You have no permission.\\",\\n \\"RequestId\\": \\"CBA58543-00D4-41****\\",\\n \\"ErrorCode\\": \\"401\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 200,\\n \\"RuleChecks\\": [\\n {\\n \\"BlockType\\": 1,\\n \\"WarningThreshold\\": 0.1,\\n \\"Property\\": \\"type\\",\\n \\"TableName\\": \\"dual\\",\\n \\"Comment\\": \\"The description of the rule.\\",\\n \\"CheckResultStatus\\": 2,\\n \\"TemplateName\\": \\"Expected value verification\\",\\n \\"CheckerName\\": \\"fulx\\",\\n \\"RuleId\\": 123421,\\n \\"FixedCheck\\": false,\\n \\"Op\\": \\">\\",\\n \\"UpperValue\\": 22200,\\n \\"ActualExpression\\": \\"ds=20200925\\",\\n \\"ExternalId\\": \\"123112232\\",\\n \\"TimeCost\\": \\"10\\",\\n \\"Trend\\": \\"up\\",\\n \\"ExternalType\\": \\"CWF2\\",\\n \\"BizDate\\": 1600704000000,\\n \\"CheckResult\\": 2,\\n \\"ResultString\\": \\"ResultString\\",\\n \\"MatchExpression\\": \\"ds=$[yyyymmdd]\\",\\n \\"CheckerType\\": 0,\\n \\"ProjectName\\": \\"autotest\\",\\n \\"BeginTime\\": 1600704000000,\\n \\"DateType\\": \\"YMD\\",\\n \\"CriticalThreshold\\": 0.6,\\n \\"IsPrediction\\": false,\\n \\"RuleName\\": \\"The name of the rule.\\",\\n \\"CheckerId\\": 7,\\n \\"DiscreteCheck\\": true,\\n \\"EndTime\\": 1600704000000,\\n \\"MethodName\\": \\"max\\",\\n \\"LowerValue\\": 2344,\\n \\"EntityId\\": 14534343,\\n \\"WhereCondition\\": \\"type!=\'type2\'\\",\\n \\"ExpectValue\\": 90,\\n \\"TemplateId\\": 5,\\n \\"TaskId\\": \\"16008552981681a0d6****\\",\\n \\"Id\\": 2231123,\\n \\"ReferenceValue\\": [\\n {\\n \\"DiscreteProperty\\": \\"type1\\",\\n \\"Value\\": 20,\\n \\"BizDate\\": \\"1600704000000\\",\\n \\"SingleCheckResult\\": 2,\\n \\"Threshold\\": 0.2\\n }\\n ],\\n \\"SampleValue\\": [\\n {\\n \\"DiscreteProperty\\": \\"type2\\",\\n \\"BizDate\\": \\"1600704000000\\",\\n \\"Value\\": 23\\n }\\n ],\\n \\"Open\\": true\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n CBA58543-00D4-41****\\n \\n 200\\n 10\\n 1\\n \\n &gt;\\n 16008552981681a0d6****\\n 1600704000000\\n true\\n fulx\\n 90\\n autotest\\n 123421\\n 0.1\\n type!=\'type2\'\\n 1600704000000\\n 2\\n ds=$[yyyymmdd]\\n 22200\\n false\\n 2\\n 字段唯一值个数期望值校验\\n 10\\n false\\n max\\n ResultString\\n type\\n YMD\\n 1600704000000\\n 5\\n 这里是规则名称\\n 这里是规则描述信息\\n 0.6\\n 123112232\\n up\\n 0\\n CWF2\\n 7\\n 14534343\\n dual\\n 1\\n 2231123\\n ds=20200925\\n 2344\\n \\n \\n \\n 2\\n 20\\n 1600704000000\\n type1\\n 0.2\\n \\n \\n 23\\n 1600704000000\\n type2\\n \\n \\n 2\\n 20\\n 1600704000000\\n type1\\n 0.2\\n \\n \\n 23\\n 1600704000000\\n type2\\n \\n \\n \\n","errorExample":""}]', - 'title' => 'ListQualityResultsByRule', - 'summary' => 'Queries monitoring results after the data quality of a data source or a compute engine is monitored based on monitoring rules.', + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 13,\\n \\"Business\\": [\\n {\\n \\"Owner\\": \\"34824327****\\",\\n \\"Description\\": \\"My first workflow\\",\\n \\"ProjectId\\": 10000,\\n \\"BusinessId\\": 3000001,\\n \\"BusinessName\\": \\"My first workflow\\",\\n \\"UseType\\": \\"NORMAL\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListBusiness', + 'summary' => 'Queries a list of workflows.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateDataServiceApi' => [ - 'methods' => [ - 'post', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'ListCalcEngines' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '78179', - 'abilityTreeNodes' => [ - 'FEATUREdideZZ63WZ', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ - [ - 'name' => 'TenantId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The tenant ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '10001', - ], - ], [ 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '10000', - ], + 'in' => 'query', + 'schema' => ['description' => 'The ID of the DataWorks workspace with which the compute engine is associated.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '27'], ], [ - 'name' => 'ApiName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the API. The name must be 4 to 50 characters in length. The name can contain letters, digits, and underscores (\\_) and must start with a letter.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Test API name'."\n", - ], + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the compute engine, which must be exactly matched.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'abc'], ], [ - 'name' => 'GroupId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The business process ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Business process ID', - ], + 'name' => 'CalcEngineType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the compute engine. The value of this parameter is not case-sensitive. Valid values:'."\n" + ."\n" + .'* **ODPS**'."\n" + .'* **EMR**'."\n" + .'* **BLINK**'."\n" + .'* **HOLO**'."\n" + .'* **MaxGraph**'."\n" + .'* **HYBRIDDB_FOR_POSTGRESQL**'."\n" + .'* **ADB_MYSQL**'."\n" + .'* **HADOOP_CDH**'."\n" + .'* **CLICKHOUSE**'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ODPS'], ], [ - 'name' => 'ApiMode', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The type of the API. Valid values: 0, 1, and 2. The value 0 indicates that the API is generated in wizard mode. The value 1 indicates that the API is generated in script mode. The value 2 indicates that the API is generated by registration.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '0', - ], + 'name' => 'EnvType', + 'in' => 'query', + 'schema' => ['description' => 'The environment in which the compute engine is used. Valid values:'."\n" + ."\n" + .'* **DEV**'."\n" + .'* **PRD**'."\n", 'type' => 'string', 'required' => false, 'example' => 'PRD'], ], [ - 'name' => 'RequestMethod', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The request method of the API. Valid values: 0, 1, 2, and 3. The value 0 indicates the GET method. The value 1 indicates the POST method. The value 2 indicates the PUT method. The value 3 indicates the DELETE method. APIs generated in wizard or script mode support the GET and POST methods. APIs generated by registration support the GET, POST, PUT, and DELETE methods.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '0', - ], + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ - 'name' => 'ResponseContentType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The format in which the response of the API request is returned. Valid values: 0 and 1. The value 0 indicates the JSON format. The value 1 indicates the XML format. APIs generated in wizard or script mode support the JSON format. APIs generated by registration support the JSON and XML formats.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '0', - ], + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], - [ - 'name' => 'Timeout', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The timeout period of the API request. Unit: milliseconds. Valid values: (0,30000].'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10000', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0bc1ec92159376****'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true'], + 'Data' => [ + 'description' => 'The query results for compute engines that are returned on multiple pages.'."\n", + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + 'TotalCount' => ['description' => 'The total number of compute engine instances.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'CalcEngines' => [ + 'description' => 'The compute engines.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'BindingProjectName' => ['description' => 'The name of the workspace with which the compute engine is associated.'."\n", 'type' => 'string', 'example' => 'abc'], + 'IsDefault' => ['description' => 'Indicates whether the compute engine is the default engine of the current type.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'EngineId' => ['description' => 'The compute engine ID.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '35'], + 'DwRegion' => ['description' => 'The region where the DataWorks workspace with which the compute engine is associated resides.'."\n", 'type' => 'string', 'example' => 'cn-zhangjiakou'], + 'TaskAuthType' => ['description' => 'The identity that is used to access the compute engine. Valid values:'."\n" + ."\n" + .'* **USER**: the current user'."\n" + .'* **PROJECT**: the workspace executor'."\n" + .'* **SUBACCOUNT**: a RAM user'."\n" + .'* **STS_ROLE**: the Security Token Service (STS) role'."\n", 'type' => 'string', 'example' => 'PROJECT'], + 'CalcEngineType' => ['description' => 'The type of the compute engine.'."\n", 'type' => 'string', 'example' => 'ODPS'], + 'EngineInfo' => ['description' => 'The details of the compute engine.'."\n" + ."\n" + .'* ODPS'."\n" + ."\n" + .' {'."\n" + .' "pubEndpoint": "service.cn.maxcompute.aliyun.com/api",'."\n" + .' "endpoint": "service.cn.maxcompute.aliyun-inc.com/api",'."\n" + .' "initProperties": " '."\n" + .' {\\"odpsTypeMode\\":\\"STANDARD\\",\\"openPai\\":false,\\"openPaiGpu\\":false}",'."\n" + .' "resourceGroupType": "ODPS",'."\n" + .' "resourceGroupId": "361826516****",'."\n" + .' "vpcEndpoint": "service.cn.maxcompute.aliyun-inc.com/api",'."\n" + .' "projectName": "onefall_test_zjk",'."\n" + .' "taskSameAsOwner": "true"'."\n" + .' }'."\n" + ."\n" + .'* EMR'."\n" + ."\n" + .' {'."\n" + .' "emrClusterId": "C-xxx",'."\n" + .' "specs": "{\\"emrClusterId\\":\\"C-xxx\\",\\"emrAccessMode\\":\\"simple\\",\\"emrResourceQueueName\\":\\"default\\",\\"emrProjectId\\":\\"FP-xxx\\"}",'."\n" + .' "endpoint": "emr.aliyuncs.com",'."\n" + .' "emrResourceQueueName": "default",'."\n" + .' "emrAccessMode": "simple",'."\n" + .' "resourceGroupType": "DW",'."\n" + .' "projectName": "xx-xxxx",'."\n" + .' "emrProjectId": "FP-xxxx",'."\n" + .' "taskSameAsOwner": "false"'."\n" + .' } '."\n" + ."\n" + .'* BLINK'."\n" + ."\n" + .' {'."\n" + .' "bayesProjectId": "xxxx",'."\n" + .' "bayesProjectName": "xc_blxxixxxnk_1",'."\n" + .' "cluster": "xxxssxsx",'."\n" + .' "endpoint": "https://stream.console.aliyun.com",'."\n" + .' "engineType": "BLINK",'."\n" + .' "name": "xsxsxxxxx",'."\n" + .' "projectName": "xc_blxxxsxink_1",'."\n" + .' "queue": "root.xc_blxsxxxxxxink_1",'."\n" + .' "resourceGroupType": "DW",'."\n" + .' "specs": "{\\"cluster\\":\\"xxxxxx\\",\\"bayesProjectName\\":\\"xc_blxxixxxnk_1\\",\\"bayesProjectId\\":\\"ssxxxsa\\",\\"name\\":\\"sxsxsxxx\\",\\"queue\\":\\"root.sxxsxxsx\\"}",'."\n" + .' "taskSameAsOwner": false'."\n" + .' }'."\n" + ."\n" + .'* HOLO'."\n" + ."\n" + .' {'."\n" + .' "endpoint": "hgprecn-cn-xsxssxsx-cn-shanghai-internal.hologres.aliyuncs.com:80",'."\n" + .' "engineType": "ODPS",'."\n" + .' "odpsEndpoint": "hgprecn-cn-xsxssxxs-cn-shanghai-internal.hologres.aliyuncs.com:80",'."\n" + .' "odpsProjectName": "xsxssxsxsx",'."\n" + .' "projectName": "xsxssxsxsx",'."\n" + .' "resourceGroupType": "DW",'."\n" + .' "specs": "{\\"pubEndpoint\\":\\"hgprecn-cn-xsxssxsxs-cn-shanghai.hologres.aliyuncs.com:80\\",\\"commonBuyInstanceId\\":\\"hgprecn-cn-xsxsxsxs\\",\\"project\\":\\"holo_upxsxgrade1\\",\\"common_buy_instance_id\\":\\"hgprecn-cn-xsxsxs\\",\\"endpoint\\":\\"hgprecn-cn-xsxxsxs-cn-shanghai-internal.hologres.aliyuncs.com:80\\",\\"port\\":\\"80\\",\\"host\\":\\"hgprecn-cn-xsxsxsxs-cn-shanghai-internal.hologres.aliyuncs.com\\",\\"vpcEndpoint\\":\\"hgprecn-cn-xsxsxsxs-cn-shanghai-vpc.hologres.aliyuncs.com:80\\",\\"authType\\":2,\\"region\\":\\"cn-shanghai\\"}",'."\n" + .' "taskSameAsOwner": false'."\n" + .' }'."\n" + ."\n" + .'* MaxGraph'."\n" + ."\n" + .' {'."\n" + .' "endpoint": "http://pre-graphcompute.aliyuncs.com",'."\n" + .' "engineType": "ODPS",'."\n" + .' "odpsEndpoint": "http://pre-graphcompute.aliyuncs.com",'."\n" + .' "odpsProjectName": "xsxsxsxs",'."\n" + .' "projectName": "xsxsxsxs",'."\n" + .' "resourceGroupType": "DW",'."\n" + .' "taskSameAsOwner": false'."\n" + .' }'."\n" + ."\n" + .'* HYBRIDDB_FOR_POSTGRESQL'."\n" + ."\n" + .' {'."\n" + .' "endpoint": "hybriddb_for_postgresql_mo12121ck_endpoint",'."\n" + .' "engineType": "ODPS",'."\n" + .' "odpsEndpoint": "hybriddb_for_postgresql_m121212ock_endpoint",'."\n" + .' "odpsProjectName": "sxasaxsaxaxas",'."\n" + .' "projectName": "sxasaxsaxaxas",'."\n" + .' "resourceGroupType": "DW",'."\n" + .' "specs": "{\\"connectionString\\":\\"gp-xsxsxsxxs.gpdb.rds.aliyuncs.com\\",\\"database\\":\\"xsxsxxsxs\\",\\"password\\":\\"xxxxxxx\\",\\"instanceId\\":\\"gp-cdcdacdacda\\",\\"port\\":\\"3432\\",\\"ownerId\\":\\"12121212\\",\\"username\\":\\"sdasaddsa\\"}",'."\n" + .' "taskSameAsOwner": false'."\n" + .' }'."\n" + ."\n" + .'* ADB_MYSQL'."\n" + ."\n" + .' {'."\n" + .' "endpoint": "adb_mysql_mock_endpoint",'."\n" + .' "engineType": "ODPS",'."\n" + .' "odpsEndpoint": "adb_mysql_mock_endpoint",'."\n" + .' "odpsProjectName": "am-xsaxaxa",'."\n" + .' "projectName": "am-xsxsaxa",'."\n" + .' "resourceGroupType": "DW",'."\n" + .' "specs": "{\\"connectionString\\":\\"am-xsaxsa.ads.aliyuncs.com:3306\\",\\"database\\":\\"xsaxsaxa\\",\\"password\\":\\"xsaxsaxassxsa\\",\\"instanceId\\":\\"am-xsaxsasx\\",\\"username\\":\\"xsaxsadsd\\"}",'."\n" + .' "taskSameAsOwner": false'."\n" + .' }'."\n" + ."\n" + .'* HADOOP_CDH'."\n" + ."\n" + .' {'."\n" + .' "bindingBaseId": "xsaxsaxs",'."\n" + .' "endpoint": "xsaaaaa",'."\n" + .' "engineType": "ODPS",'."\n" + .' "odpsEndpoint": "axsxaxssxs",'."\n" + .' "odpsProjectName": "ssxxax",'."\n" + .' "projectName": "xsaxsaxsa",'."\n" + .' "resourceGroupId": 45208xxxxxx,'."\n" + .' "resourceGroupType": "GATEWAY",'."\n" + .' "specs": "{\\"cluster\\":{\\"hive\\":{\\"hiveServer2Url\\":\\"jdbc:hive2://xxxxxxer-1-cn-shanghai-pre-kerberos-1:10000\\",\\"hiveMetastore\\":\\"thrift://xxxxxxxr-1-cn-shanghai-pre-kerberos-1:9083\\",\\"version\\":\\"2.1.1\\"},\\"configFiles\\":{\\"coreSite\\":\\"4534574xxxxxx\\",\\"hdfsSite\\":\\"453457919xxxxxxx\\",\\"mapredSite\\":\\"45345750xxxxxx\\",\\"yarnSite\\":\\"4534575xxxxx\\",\\"krb5Conf\\":\\"4534576xxxxx1\\",\\"hiveSite\\":\\"453457xxxxx20\\"},\\"spark\\":{\\"version\\":\\"2.4.0\\"},\\"cdh\\":{\\"version\\":\\"6.3.2\\"},\\"hdfs\\":{\\"version\\":\\"3.0.0\\"},\\"impala\\":{\\"impalaUrl\\":\\"jdbc:impala://cdh-xsxssxxsx-1-cn-shanghai-pre-kerberos-1:21050\\",\\"version\\":\\"3.2.0\\"},\\"yarn\\":{\\"YarnUrl\\":\\"http://cdh-xsxsxsxsxs-1-cn-shanghai-pre-kerberos-1:8032\\",\\"webUrl\\":\\"http://cdh-xsxsxssxxssx-1-cn-shanghai-pre-kerberos-1:8088\\",\\"version\\":\\"3.0.0\\"},\\"presto\\":{\\"prestoUrl\\":\\"jdbc:presto://cdh-xssxsxxsxsxs-1-cn-shanghai-pre-kerberos-1:8080/hive/default\\",\\"version\\":\\"0.244.1\\"}},\\"instanceId\\":161sdads733,\\"authDetail\\":{\\"principal\\":\\"hive@HADOOP.COM\\",\\"keytabFileId\\":\\"45345815xsxsxs3\\",\\"type\\":\\"kerberos\\",\\"username\\":\\"xsxsxsxsa@HADOOP.COM\\"},\\"resGroupStatus\\":\\"\\",\\"hadoopAuthType\\":\\"kerberos\\",\\"clusterIdentifier\\":\\"xssxsxsxsx\\",\\"clusterId\\":xsxsx,\\"resGroupId\\":4520870619xsxssxxs,\\"accessMode\\":\\"security\\",\\"authType\\":2}",'."\n" + .' "taskSameAsOwner": false'."\n" + .' }'."\n", 'type' => 'object', 'example' => '{"pubEndpoint":"http://service.cn.maxcompute.aliyun.com/api","endpoint":"http://service.cn.maxcompute.aliyun-inc.com/api","resourceGroupType":"ODPS","resourceGroupId":"361826516****","vpcEndpoint":"http://service.cn.maxcompute.aliyun-inc.com/api","projectName":"onefall_test_zjk","taskSameAsOwner":"true"}'], + 'EnvType' => ['description' => 'The environment in which the compute engine is used. Valid values:'."\n" + ."\n" + .'* **DEV**'."\n" + .'* **PRD**'."\n", 'type' => 'string', 'example' => 'PRD'], + 'Region' => ['description' => 'The region where the compute engine resides.'."\n", 'type' => 'string', 'example' => 'cn-zhangjiakou'], + 'GmtCreate' => ['description' => 'The time when the compute engine was created.'."\n", 'type' => 'string', 'example' => 'Oct 10, 2019 3:42:44 PM'], + 'BindingProjectId' => ['description' => 'The ID of the workspace with which the compute engine is associated.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '27'], + 'Name' => ['description' => 'The display name of the compute engine.'."\n", 'type' => 'string', 'example' => 'abc'], + 'TenantId' => ['description' => 'The tenant ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234567'], + ], + ], + ], + ], + ], + ], ], ], - [ - 'name' => 'VisibleRange', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The scope in which the API is visible. Valid values: 0 and 1. The value 0 indicates that the API is visible to all members in the workspace. The value 1 indicates that the API is visible only to its owner.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '0', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Invalid.Tenant.ConnectionNotExists', 'errorMessage' => 'The connection does not exist.', 'description' => 'The connection does not exist.'], + ['errorCode' => 'Invalid.Tenant.ProjectNotExists', 'errorMessage' => 'The project does not exist.', 'description' => 'The project does not exist.'], + ['errorCode' => 'Invalid.Tenant.UserNotInProject', 'errorMessage' => 'The user is not in the project.', 'description' => 'The user is not in the project.'], + ['errorCode' => 'Invalid.CalcEngineEnvType', 'errorMessage' => 'The specified envType %s is invalid.', 'description' => 'The specify env type %s invalid'], + ['errorCode' => 'Invalid.CalcEngineType', 'errorMessage' => 'The specified calcEngineType %s is invalid.', 'description' => 'The specify calc engine type %s invalid.'], ], - [ - 'name' => 'Protocols', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The protocol used by the API. Valid values: 0 and 1. The value 0 indicates HTTP. The value 1 indicates HTTPS. You can specify multiple protocols. Separate them with commas (,).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '0,1', - ], + 403 => [ + ['errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin', 'errorMessage' => 'The user is not a project administrator or owner.', 'description' => 'The user is not a project administrator or owner.'], + ['errorCode' => 'Invalid.Tenant.UserNotInTenant', 'errorMessage' => 'The user is not in tenant.', 'description' => 'The user is not in tenant.'], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"1AFAE64E-D1BE-432B-A9****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 1,\\n \\"CalcEngines\\": [\\n {\\n \\"BindingProjectName\\": \\"test_project\\",\\n \\"IsDefault\\": true,\\n \\"EngineId\\": 35,\\n \\"DwRegion\\": \\"cn-zhangjiakou\\",\\n \\"TaskAuthType\\": \\"PROJECT\\",\\n \\"CalcEngineType\\": \\"ODPS\\",\\n \\"EngineInfo\\": {\\n \\"pubEndpoint\\": \\"service.cn.maxcompute.aliyun.com/api\\",\\n \\"endpoint\\": \\"service.cn.maxcompute.aliyun-inc.com/api\\",\\n \\"initProperties\\": \\" {\\\\\\"odpsTypeMode\\\\\\":\\\\\\"STANDARD\\\\\\",\\\\\\"openPai\\\\\\":false,\\\\\\"openPaiGpu\\\\\\":false}\\",\\n \\"resourceGroupType\\": \\"ODPS\\",\\n \\"resourceGroupId\\": \\"361826516****\\",\\n \\"vpcEndpoint\\": \\"service.cn.maxcompute.aliyun-inc.com/api\\",\\n \\"projectName\\": \\"onefall_test_zjk\\",\\n \\"taskSameAsOwner\\": \\"true\\"\\n },\\n \\"EnvType\\": \\"PRD\\",\\n \\"Region\\": \\"cn-zhangjiakou\\",\\n \\"GmtCreate\\": \\"Oct 10, 2019 3:42:44 PM\\",\\n \\"BindingProjectId\\": 466230,\\n \\"Name\\": \\"test_mc\\",\\n \\"TenantId\\": 1234567\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 0bc1ec92159376****\\n true\\n \\n 1\\n 20\\n 1\\n \\n abc\\n true\\n 35\\n cn-zhangjiakou\\n PROJECT\\n ODPS\\n PRD\\n cn-zhangjiakou\\n Oct 10, 2019 3:42:44 PM\\n 27\\n abc\\n 1234567\\n \\n \\n","errorExample":""}]', + 'title' => 'ListCalcEngines', + 'summary' => 'Queries a list of compute engines that are associated with a DataWorks workspace.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-03-17T03:46:07.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'WizardDetails', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The details of the API generated in wizard mode. For more information, see the WizardDetails parameter returned by the [GetDataServiceApi](~~174013~~) operation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"isPagedResponse":true,"wizardConnection":{"connectionId":122786,"tableName":"person"},"wizardRequestParameters":[{"columnName":"id","defaultValue":"","exampleValue":"1","isRequiredParameter":true,"parameterDataType":2,"parameterDescription":"","parameterName":"id","parameterOperator":0,"parameterPosition":0}],"wizardResponseParameters":[{"columnName":"id","exampleValue":"11","parameterDataType":2,"parameterDescription":"","parameterName":"id"}]}', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'ListCheckProcesses' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'ScriptDetails', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The details of the API generated in script mode. For more information, see the scriptDetails parameter returned by the [GetDataServiceApi](~~174013~~) operation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"isPagedResponse":false,"script":"select id as id1, name as name1 from person where id=${inputid}","scriptConnection":{"connectionId":122786,"tableName":"person"},"scriptRequestParameters":[{"defaultValue":"","exampleValue":"","isRequiredParameter":true,"parameterDataType":0,"parameterDescription":"","parameterName":"inputid","parameterOperator":0,"parameterPosition":1}],"scriptResponseParameters":[{"exampleValue":"","parameterDataType":0,"parameterDescription":"","parameterName":"id1"},{"exampleValue":"","parameterDataType":0,"parameterDescription":"","parameterName":"name1"}]}', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '240968', + 'abilityTreeNodes' => ['FEATUREdide63BO88'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ [ - 'name' => 'RegistrationDetails', + 'name' => 'ProjectId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The details of the API generated by registration. For more information, see the registrationDetails parameter returned by the [GetDataServiceApi](~~174013~~) operation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"failedResultSample":"fail","registrationErrorCodes":[{"errorCode":"e1","errorMessage":"msg1","errorSolution":"sol1"},{"errorCode":"e2","errorMessage":"msg2","errorSolution":"sol2"}],"registrationRequestParameters":[{"columnName":"","defaultValue":"","exampleValue":"","isRequiredParameter":true,"parameterDataType":0,"parameterDescription":"","parameterName":"id","parameterOperator":0,"parameterPosition":1},{"columnName":"","defaultValue":"xx","exampleValue":"","isRequiredParameter":true,"parameterDataType":0,"parameterDescription":"","parameterName":"cc","parameterOperator":2,"parameterPosition":2}],"serviceContentType":1,"serviceHost":"http://www.baidu.com","servicePath":"/[uid]","serviceRequestBodyDescription":"body","successfulResultSample":"success"}', - ], + 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123465'], ], [ - 'name' => 'ApiPath', + 'name' => 'EventCode', 'in' => 'formData', - 'schema' => [ - 'description' => 'The path of the API. The path cannot exceed 200 characters in length. The path can contain letters, digits, underscores (\\_), and hyphens (-) and must start with a forward slash (/).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '/test/1', - ], + 'schema' => ['description' => 'Extension point event encoding.', 'type' => 'string', 'required' => true, 'example' => 'commit-file'], ], [ - 'name' => 'ApiDescription', + 'name' => 'Operator', 'in' => 'formData', - 'schema' => [ - 'description' => 'The description of the API.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Test API description', - ], + 'schema' => ['description' => 'The operator ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '123333232'], ], [ - 'name' => 'FolderId', + 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the folder used to store the API. The ID of the root folder in a business process is 0. The ID of the folder created by a user must be greater than 0.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '0', - ], + 'schema' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '10', 'example' => '10', 'default' => '10'], ], [ - 'name' => 'SqlMode', + 'name' => 'PageNumber', 'in' => 'formData', - 'schema' => [ - 'description' => '* The SQL mode. Valid values: 0: The basic mode is used.'."\n" - .'* 1: Mybatis is used.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => 'The page number. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'default' => '1'], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'Status', 'in' => 'formData', 'schema' => [ - 'description' => 'The ID of the exclusive resource group.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The check status of the extension. Valid values:'."\n" + ."\n" + .'* CHECKING'."\n" + .'* PASSED'."\n" + .'* BLOCKED'."\n", + 'type' => 'string', 'required' => false, - 'example' => '3242432423', + 'example' => 'True', + 'enum' => ['CHECKING', 'PASSED', 'BLOCKED'], ], ], [ - 'name' => 'RequestContentType', + 'name' => 'MessageId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The format of the data to be requested. Valid values:'."\n" - ."\n" - .'* 0: XML format'."\n" - .'* 1: JSON format'."\n" - .'* 2: form format'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'enumValueTitles' => [], - 'example' => '0', - 'enum' => [ - '0', - '1', - '2', - ], - ], + 'schema' => ['description' => 'The message ID in DataWorks OpenEvent. You can obtain the ID from a received message when an extension point event is triggered.'."\n", 'type' => 'string', 'required' => false, 'example' => '03400b03-b721-4c34-8727-2****1'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The ID of the API.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100003', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '0000-ABCD-EF****'], + 'PagingInfo' => [ + 'description' => 'The pagination information.'."\n", + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => 'The number of entries displayed on each page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '12'], + 'CheckProcesses' => [ + 'description' => 'The check details of the extension.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ProjectId' => ['description' => 'The ID of the DataWorks workspace.', 'type' => 'integer', 'format' => 'int64', 'example' => '32563'], + 'Status' => ['description' => 'The status of the extender check.'."\n" + .'- CHECKING CHECKING'."\n" + .'- PASSED the pass check'."\n" + .'- BLOCKED check failed', 'type' => 'string', 'example' => 'CHECKING'], + 'EventCode' => ['description' => 'Extension point event encoding.', 'type' => 'string', 'example' => 'commit-file'], + 'EventName' => ['description' => 'The name of the extension point event.', 'type' => 'string', 'example' => 'DnsEvent'], + 'EventNameEn' => ['description' => 'The English name of the event.', 'type' => 'string', 'example' => 'Pre-event for Node Commit'], + 'ProcessName' => ['description' => 'The name of the check object, such as the file name or node name.'."\n", 'type' => 'string', 'example' => 'odps_sql_test'], + 'MessageId' => ['description' => 'DataWorks the message ID of the open message. After an extended point event is triggered, you can obtain the message ID from the received event message.', 'type' => 'string', 'example' => 'b824a5de-4223-4315-af3e-c4449d236db4'], + 'ProcessId' => ['description' => 'The ID of the process instance.', 'type' => 'string', 'example' => 'rdk_generate_d395da25-b0d3-4114-b2a5-d0247444a661_none_3496903_365203'], + 'Operator' => ['description' => 'The operator ID.'."\n", 'type' => 'string', 'example' => '297635'], + ], + 'description' => '', + ], + ], + ], ], ], - 'description' => '', - ], - ], - ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 100003,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 100003\\n The connection does not exist.\\n 0000-ABCD-EFG****\\n Invalid.Tenant.ConnectionNotExists\\n true\\n","errorExample":""}]', - 'title' => 'CreateDataServiceApi', - 'summary' => 'Creates an API.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'PublishDataServiceApi' => [ - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EF****\\",\\n \\"PagingInfo\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 12,\\n \\"CheckProcesses\\": [\\n {\\n \\"ProjectId\\": 32563,\\n \\"Status\\": \\"CHECKING\\",\\n \\"EventCode\\": \\"commit-file\\",\\n \\"EventName\\": \\"DnsEvent\\",\\n \\"EventNameEn\\": \\"Pre-event for Node Commit\\",\\n \\"ProcessName\\": \\"odps_sql_test\\",\\n \\"MessageId\\": \\"b824a5de-4223-4315-af3e-c4449d236db4\\",\\n \\"ProcessId\\": \\"rdk_generate_d395da25-b0d3-4114-b2a5-d0247444a661_none_3496903_365203\\",\\n \\"Operator\\": \\"297635\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListCheckProcesses', + 'summary' => 'Queries the check results of extension point events.', + 'changeSet' => [ + ['createdAt' => '2025-01-23T02:48:41.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'ListClusterConfigs' => [ + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '78339', - 'abilityTreeNodes' => [ - 'FEATUREdideZZ63WZ', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '231400', + 'abilityTreeNodes' => ['FEATUREdideDGBIGO'], ], 'parameters' => [ [ - 'name' => 'TenantId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '10002', - ], + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the cluster generated by DataWorks.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234'], ], [ 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '10001', - ], + 'in' => 'query', + 'schema' => ['description' => 'The ID of the DataWorks workspace.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '5678'], ], [ - 'name' => 'ApiId', - 'in' => 'formData', + 'name' => 'ConfigType', + 'in' => 'query', 'schema' => [ - 'description' => 'The API ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The configuration type of the cluster. Valid values:'."\n" + ."\n" + .'* SPARK_CONF: SPARK parameters.'."\n", + 'type' => 'string', 'required' => true, - 'docRequired' => true, - 'example' => '10000', + 'enumValueTitles' => [], + 'example' => 'SPARK_CONF', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'Indicates whether the API was published.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', + 'ClusterConfigs' => [ + 'description' => 'A list of configurations of cluster modules.', + 'type' => 'array', + 'items' => ['description' => 'The configuration information of a cluster on a module.', '$ref' => '#/components/schemas/ClusterConfig'], ], + 'RequestId' => ['description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", 'type' => 'string', 'example' => '0000-ABCD-E****'], 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', + 'enumValueTitles' => [], 'example' => 'true', ], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '101011005'], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'Invalid.Cluster.ClusterNotFound'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], ], - 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n true\\n The connection does not exist.\\n 0000-ABCD-EFG****\\n Invalid.Tenant.ConnectionNotExists\\n true\\n","errorExample":""}]', - 'title' => 'PublishDataServiceApi', - 'summary' => 'Publishes an API.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DeleteDataServiceApi' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ClusterConfigs\\": [\\n {\\n \\"ModuleName\\": \\"ide\\",\\n \\"ConfigValue\\": \\"{\\\\\\"spark.driver.memory\\\\\\":\\\\\\"1g\\\\\\"}\\",\\n \\"EnableOverwrite\\": false\\n }\\n ],\\n \\"RequestId\\": \\"0000-ABCD-*****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"101011005\\",\\n \\"ErrorMessage\\": \\"Invalid.Cluster.ClusterNotFound\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => 'ListClusterConfigs', + 'summary' => 'Queries the configurations of submodules in a workspace. You can query information about SPARK parameters.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'ListClusters' => [ + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', + 'abilityTreeCode' => '231398', + 'abilityTreeNodes' => ['FEATUREdideDGBIGO'], ], 'parameters' => [ [ - 'name' => 'TenantId', - 'in' => 'formData', + 'name' => 'ClusterType', + 'in' => 'query', 'schema' => [ - 'description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '10002', + 'description' => 'The type of the cluster. Valid values:'."\n" + ."\n" + .'* CDH: CDH cluster'."\n" + .'* EMR: EMR cluster'."\n", + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'EMR', ], ], [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the workspace.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '10001', - ], + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Pages start from page 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], [ - 'name' => 'ApiId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the API in DataService Studio.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '10000', - ], + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], 'Data' => [ - 'description' => 'Indicates whether the API was deleted.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', + 'description' => 'The returns data.', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100'], + 'Clusters' => [ + 'description' => 'List of cluster information.', + 'type' => 'array', + 'items' => ['description' => 'Cluster information', '$ref' => '#/components/schemas/Cluster'], + ], + ], ], + 'RequestId' => ['description' => 'The request ID. You can use the request ID to query logs and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '0000-ABCD-E****'], 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', + 'enumValueTitles' => [], 'example' => 'true', ], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '101011005'], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'Invalid.Cluster.ClusterNotFound'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], ], - 'description' => '', ], ], ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Clusters\\": [\\n {\\n \\"ClusterId\\": 1234,\\n \\"ClusterBizId\\": \\"c-d8a7523****\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"0000-ABCD-E****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"101011005\\",\\n \\"ErrorMessage\\": \\"Invalid.Cluster.ClusterNotFound\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => 'ListClusters', + 'summary' => 'Queries clusters that are registered in DataWorks. E-MapReduce (EMR) clusters and Cloudera\'s Distribution Including Apache Hadoop (CDH) clusters are supported.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n true\\n The connection does not exist.\\n 0000-ABCD-EFG****\\n Invalid.Tenant.ConnectionNotExists\\n true\\n","errorExample":""}]', - 'title' => 'DeleteDataServiceApi', - 'summary' => 'Deletes an API in DataService Studio.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'ramActions' => [], ], - 'ListDataServiceApis' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListConnections' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '78301', - 'abilityTreeNodes' => [ - 'FEATUREdide7T0EJX', - ], - ], + 'deprecated' => true, + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the workspace to which the data source belongs. You can call the [ListProjects](~~178393~~) operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '76086'], ], [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 10.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'maximum' => '50', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the data source that you want to query.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'abc'], ], [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '10000', - ], + 'name' => 'ConnectionType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the data source. Valid values:'."\n" + ."\n" + .'* odps'."\n" + .'* mysql'."\n" + .'* rds'."\n" + .'* oss'."\n" + .'* sqlserver'."\n" + .'* polardb'."\n" + .'* oracle'."\n" + .'* mongodb'."\n" + .'* emr'."\n" + .'* postgresql'."\n" + .'* analyticdb_for_mysql'."\n" + .'* hybriddb_for_postgresql'."\n" + .'* holo'."\n", 'type' => 'string', 'required' => false, 'example' => 'rds'], ], [ - 'name' => 'TenantId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '10001', - ], + 'name' => 'SubType', + 'in' => 'query', + 'schema' => ['description' => 'The subtype of the data source. This parameter is used in scenarios where a type includes subtypes. The following type and subtypes are supported:'."\n" + ."\n" + .'* Type: `rds`'."\n" + .'* Subtypes: `mysql`, `sqlserver`, and `postgresql`'."\n", 'type' => 'string', 'required' => false, 'example' => 'mysql'], ], [ - 'name' => 'ApiNameKeyword', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The keyword in API names. The keyword is used to search for the APIs whose names contain the keyword.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'My API name', - ], + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => 'The status of the data source. Valid values:'."\n" + ."\n" + .'* ENABLED'."\n" + .'* DISABLED'."\n", 'type' => 'string', 'required' => false, 'example' => '1'], ], [ - 'name' => 'ApiPathKeyword', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The keyword in API paths. The keyword is used to search for the APIs whose paths contain the keyword.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '/test/', - ], + 'name' => 'EnvType', + 'in' => 'query', + 'schema' => ['description' => 'The environment in which the data source is used. Valid values: 0 and 1. The value 0 indicates the development environment. The value 1 indicates the production environment.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], [ - 'name' => 'CreatorId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the creator of the APIs. The ID is used to search for the APIs created by the creator.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '12345', - ], + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Pages start from page 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0bc14115159376359****'], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true'], 'Data' => [ - 'description' => 'The data returned.'."\n", + 'description' => 'The query results for data sources that are returned on multiple pages.'."\n", 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number. The value of this parameter is the same as that of the PageNumber parameter in the request.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. Valid values: 1 to 50. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'Apis' => [ - 'description' => 'The list of APIs in the development state.'."\n", + 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20'], + 'TotalCount' => ['description' => 'The total number of data sources returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'Connections' => [ + 'description' => 'The data sources.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'The returned result.'."\n", 'type' => 'object', 'properties' => [ - 'Timeout' => [ - 'description' => 'The timeout period of the API request. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10000', - ], - 'Status' => [ - 'description' => 'The status of the API. Valid values: 0 and 1. The value 0 indicates that the API is not published. The value 1 indicates that the API is published.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ApiId' => [ - 'description' => 'The API ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10002', - ], - 'ApiMode' => [ - 'description' => 'The type of the API. Valid values: 0, 1, and 2. The value 0 indicates that the API is generated in wizard mode. The value 1 indicates that the API is generated in script mode. The value 2 indicates that the API is generated by registration.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ProjectId' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000', - ], - 'ResponseContentType' => [ - 'description' => 'The format in which the response of the API request is returned. Valid values: 0 and 1. The value 0 indicates the JSON format. The value 1 indicates the XML format. APIs generated in wizard or script mode support the JSON format. APIs generated by registration support the JSON and XML formats.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'CreatorId' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the creator of the API.'."\n", - 'type' => 'string', - 'example' => '1234567', - ], - 'VisibleRange' => [ - 'description' => 'The scope in which the API is visible. Valid values: 0 and 1. The value 0 indicates that the API is visible within the workspace. The value 1 indicates that the API is visible only to its owner.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ModifiedTime' => [ - 'description' => 'The time when the API was last modified.'."\n", - 'type' => 'string', - 'example' => '2020-06-23T00:21:01+0800', - ], - 'OperatorId' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the user who last modified the API.'."\n", - 'type' => 'string', - 'example' => '2345678', - ], - 'GroupId' => [ - 'description' => 'The group ID.'."\n", - 'type' => 'string', - 'example' => 'abcde123456789', - ], - 'Description' => [ - 'description' => 'The description of the API.'."\n", - 'type' => 'string', - 'example' => 'Test API description', - ], - 'FolderId' => [ - 'description' => 'The folder ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'RequestMethod' => [ - 'description' => 'The request method of the API. Valid values: 0, 1, 2, and 3. The value 0 indicates the GET method. The value 1 indicates the POST method. The value 2 indicates the PUT method. The value 3 indicates the DELETE method. APIs generated in wizard or script mode support the GET and POST methods. APIs generated by registration support the GET, POST, PUT, and DELETE methods.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'CreatedTime' => [ - 'description' => 'The time when the API was created.'."\n", - 'type' => 'string', - 'example' => '2020-06-23T00:21:01+0800', - ], - 'ApiName' => [ - 'description' => 'The name of the API.'."\n", - 'type' => 'string', - 'example' => 'My API name', - ], - 'TenantId' => [ - 'description' => 'The tenant ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000', - ], - 'ApiPath' => [ - 'description' => 'The path of the API.'."\n", - 'type' => 'string', - 'example' => '/test/1', - ], - 'Protocols' => [ - 'description' => 'The list of fields.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The protocol used by the API. Valid values: 0 and 1. The value 0 indicates HTTP. The value 1 indicates HTTPS. Multiple protocols are presented in a list.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - ], - 'RegistrationDetails' => [ - 'description' => 'The details of the API generated by registration. This parameter is returned only if the API is generated by registration.'."\n", - 'type' => 'object', - 'properties' => [ - 'ServiceHost' => [ - 'description' => 'The URL of the backend service.'."\n", - 'type' => 'string', - 'example' => 'http://example.aliyundoc.com', - ], - 'ServiceContentType' => [ - 'description' => 'The format in which the response of the API request is returned. Valid values: 0 and 1. The value 0 indicates the JSON format. The value 1 indicates the XML format. APIs generated in wizard or script mode support the JSON format. APIs generated by registration support the JSON and XML formats.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ServicePath' => [ - 'description' => 'The path of the backend service.'."\n", - 'type' => 'string', - 'example' => '/index', - ], - 'SuccessfulResultSample' => [ - 'description' => 'The sample success response of the API.'."\n", - 'type' => 'string', - 'example' => '{"success": true}', - ], - 'FailedResultSample' => [ - 'description' => 'The sample error response of the API.'."\n", - 'type' => 'string', - 'example' => '{"success": false}', - ], - 'ServiceRequestBodyDescription' => [ - 'description' => 'The description of the request body initiated to call the backend service.'."\n", - 'type' => 'string', - 'example' => '{"abc":1}', - ], - 'RegistrationErrorCodes' => [ - 'description' => 'The error codes returned for the API generated by registration.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'fail to call', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '1001', - ], - 'ErrorSolution' => [ - 'description' => 'The solution used to fix the error.'."\n", - 'type' => 'string', - 'example' => 'retry', - ], - ], - ], - ], - 'RegistrationRequestParameters' => [ - 'description' => 'The request parameters of the API generated by registration.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ColumnName' => [ - 'description' => 'The name of the associated field. This parameter is supported only if the API is generated in wizard mode.'."\n", - 'type' => 'string', - 'example' => 'column1', - ], - 'ParameterName' => [ - 'description' => 'The name of the parameter.'."\n", - 'type' => 'string', - 'example' => 'name1', - ], - 'ParameterPosition' => [ - 'description' => 'The position of the parameter. Valid values: 0, 1, 2, and 3. The value 0 indicates that the parameter is in the URL path of the request. The value 1 indicates that the parameter is in the Query parameter of the request URL. The value 2 indicates that the parameter is in the request header. The value 3 indicates that the parameter is in the request body. APIs generated in wizard or script mode support only the Query position. APIs generated by registration whose request method is GET or DELETE support the Query and Head positions. APIs generated by registration whose request method is PUT or POST support the Query, Head, and Body positions.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ParameterDescription' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'description1', - ], - 'DefaultValue' => [ - 'description' => 'The default value.'."\n", - 'type' => 'string', - 'example' => 'default1', - ], - 'ParameterOperator' => [ - 'description' => 'The operator used for the value of the parameter. Valid values: 0, 1, 2, and 3. The value 0 indicates the Equal operator. The value 1 indicates the Like operator. The value 2 indicates the Const operator. The value 3 indicates the In operator. APIs generated in wizard mode support the Equal, Like, and In operators. APIs generated in script mode support the Equal operator. APIs generated by registration support the Equal and Const operators.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ParameterDataType' => [ - 'description' => 'The data type of the parameter. Valid values:'."\n" - ."\n" - .'* 0: String'."\n" - .'* 1: Int'."\n" - .'* 2: Long'."\n" - .'* 3: Float'."\n" - .'* 4: Double'."\n" - .'* 5: Boolean'."\n" - .'* 6: StringList'."\n" - .'* 7: IntList'."\n" - .'* 8: LongList'."\n" - .'* 9: FloatList'."\n" - .'* 10: DoubleList'."\n" - .'* 11: BooleanList'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ExampleValue' => [ - 'description' => 'The sample value.'."\n", - 'type' => 'string', - 'example' => 'example1', - ], - 'IsRequiredParameter' => [ - 'description' => 'Indicates whether the parameter is required.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], - ], - ], - 'ScriptDetails' => [ - 'description' => 'The details of the API generated in script mode. This parameter is returned only if the API is generated in script mode.'."\n", - 'type' => 'object', - 'properties' => [ - 'Script' => [ - 'description' => 'The SQL script.'."\n", - 'type' => 'string', - 'example' => 'select a from t', - ], - 'IsPagedResponse' => [ - 'description' => 'Indicates whether the entries are returned by page.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ScriptRequestParameters' => [ - 'description' => 'The request parameters of the API generated in script mode.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ColumnName' => [ - 'description' => 'The name of the associated field. This parameter is supported only if the API is generated in wizard mode.'."\n", - 'type' => 'string', - 'example' => 'column1', - ], - 'ParameterName' => [ - 'description' => 'The name of the parameter.'."\n", - 'type' => 'string', - 'example' => 'param1', - ], - 'ParameterPosition' => [ - 'description' => 'The position of the parameter. Valid values:'."\n" - ."\n" - .'* 0: indicates that the parameter is in the URL path of the request.'."\n" - .'* 1: indicates that the parameter is in the Query parameter of the request URL.'."\n" - .'* 2: indicates that the parameter is in the request header.'."\n" - .'* 3: indicates that the parameter is in the request body.'."\n" - ."\n" - .'APIs generated in wizard or script mode support only the Query position. APIs generated by registration whose request method is GET or DELETE support the Query and Head positions. APIs generated by registration whose request method is PUT or POST support the Query, Head, and Body positions.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ParameterDescription' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'description1', - ], - 'DefaultValue' => [ - 'description' => 'The default value.'."\n", - 'type' => 'string', - 'example' => 'default1', - ], - 'ParameterOperator' => [ - 'description' => 'The operator used for the value of the parameter. Valid values:'."\n" - ."\n" - .'* 0: Equal'."\n" - .'* 1: Like'."\n" - .'* 2: Const'."\n" - .'* 3: In'."\n" - ."\n" - .'APIs generated in wizard mode support the Equal, Like, and In operators. APIs generated in script mode support the Equal operator. APIs generated by registration support the Equal and Const operators.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ParameterDataType' => [ - 'description' => 'The data type of the parameter. Valid values:'."\n" - ."\n" - .'* 0: String'."\n" - .'* 1: Int'."\n" - .'* 2: Long'."\n" - .'* 3: Float'."\n" - .'* 4: Double'."\n" - .'* 5: Boolean'."\n" - .'* 6: StringList'."\n" - .'* 7: IntList'."\n" - .'* 8: LongList'."\n" - .'* 9: FloatList'."\n" - .'* 10: DoubleList'."\n" - .'* 11: BooleanList'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ExampleValue' => [ - 'description' => 'The sample value.'."\n", - 'type' => 'string', - 'example' => 'example1', - ], - 'IsRequiredParameter' => [ - 'description' => 'Indicates whether the parameter is required.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], - 'ScriptResponseParameters' => [ - 'description' => 'The response parameters of the API generated in script mode.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ParameterDescription' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'description2', - ], - 'ColumnName' => [ - 'description' => 'The name of the associated field. This parameter is supported only if the API is generated in wizard mode.'."\n", - 'type' => 'string', - 'example' => 'column2', - ], - 'ParameterName' => [ - 'description' => 'The name of the parameter.'."\n", - 'type' => 'string', - 'example' => 'param2', - ], - 'ParameterDataType' => [ - 'description' => 'The data type of the parameter. Valid values:'."\n" - ."\n" - .'* 0: String'."\n" - .'* 1: Int'."\n" - .'* 2: Long'."\n" - .'* 3: Float'."\n" - .'* 4: Double'."\n" - .'* 5: Boolean'."\n" - .'* 6: StringList'."\n" - .'* 7: IntList'."\n" - .'* 8: LongList'."\n" - .'* 9: FloatList'."\n" - .'* 10: DoubleList'."\n" - .'* 11: BooleanList'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ExampleValue' => [ - 'description' => 'The sample value.'."\n", - 'type' => 'string', - 'example' => 'example2', - ], - ], - ], - ], - 'ScriptConnection' => [ - 'description' => 'The data source information about the API generated in script mode.'."\n", - 'type' => 'object', - 'properties' => [ - 'TableName' => [ - 'description' => 'The name of the table in the data source.'."\n", - 'type' => 'string', - 'example' => 't', - ], - 'ConnectionId' => [ - 'description' => 'The data source ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], + 'Status' => ['description' => 'The status of the data source. Valid values:'."\n" + ."\n" + .'* 1: The data source is normal.'."\n" + .'* 2: The data source is disabled.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ConnectionType' => ['description' => 'The type of the data source. Valid values:'."\n" + ."\n" + .'* odps'."\n" + .'* mysql'."\n" + .'* rds'."\n" + .'* oss'."\n" + .'* sqlserver'."\n" + .'* polardb'."\n" + .'* oracle'."\n" + .'* mongodb'."\n" + .'* emr'."\n" + .'* postgresql'."\n" + .'* analyticdb_for_mysql'."\n" + .'* hybriddb_for_postgresql'."\n" + .'* holo'."\n", 'type' => 'string', 'example' => 'mysql'], + 'ProjectId' => ['description' => 'The ID of the workspace with which the data source is associated.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '123'], + 'SubType' => ['description' => 'The subtype of the data source. This parameter is used in scenarios where a type includes subtypes. The following type and subtypes are supported:'."\n" + ."\n" + .'* Type: `rds`'."\n" + .'* Subtypes: `mysql`, `sqlserver`, and `postgresql`.'."\n", 'type' => 'string', 'example' => 'mysql'], + 'GmtModified' => ['description' => 'The time when the data source was last modified. Example: Mar 17, 2021 4:09:32 PM.'."\n", 'type' => 'string', 'example' => 'Mar 17, 2021 4:09:32 PM'], + 'EnvType' => ['description' => 'The environment in which the data source is used. Valid values:'."\n" + ."\n" + .'* 0: development environment'."\n" + .'* 1: production environment'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ConnectStatus' => ['description' => 'The status of the data source. Valid values:'."\n" + ."\n" + .'* 1: The data source is normal.'."\n" + .'* 2: The data source is disabled.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Sequence' => ['description' => 'The field that is used to sort data sources. Data sources are sorted in descending order based on the value of this parameter.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '300'], + 'Description' => ['description' => 'The description of the data source.'."\n", 'type' => 'string', 'example' => 'a connection'], + 'GmtCreate' => ['description' => 'The time when the data source was created. Example: Mar 17, 2021 4:09:32 PM.'."\n", 'type' => 'string', 'example' => 'Mar 17, 2021 4:09:32 PM'], + 'DefaultEngine' => ['description' => 'Indicates whether the compute engine that is associated with the data source is the default compute engine used by data sources of the same type.'."\n", 'type' => 'boolean', 'example' => 'false'], + 'Shared' => ['description' => 'Indicates whether the data source is a shared data source.'."\n", 'type' => 'boolean', 'example' => 'false'], + 'Operator' => ['description' => 'The ID of the Alibaba Cloud account that is used to last modify the data source.'."\n", 'type' => 'string', 'example' => '193543050****'], + 'Name' => ['description' => 'The name of the data source.'."\n", 'type' => 'string', 'example' => 'abc'], + 'Content' => ['description' => 'The details of the data source. Examples of details of some common data sources:'."\n" + ."\n" + .'* odps'."\n" + ."\n" + .''."\n" + ."\n" + .' {'."\n" + .' "accessId": "xssssss",'."\n" + .' "accessKey": "xsaxsaxsa",'."\n" + .' "authType": 2,'."\n" + .' "endpoint": "http://service.odps.aliyun.com/api",'."\n" + .' "project": "xsaxsax",'."\n" + .' "tag": "public"'."\n" + .' }'."\n" + ."\n" + .'* mysql'."\n" + ."\n" + .''."\n" + ."\n" + .' {'."\n" + .' "database": "xsaxsa",'."\n" + .' "instanceName": "rm-xsaxsa",'."\n" + .' "password": "xsaxsa",'."\n" + .' "rdsOwnerId": "xasxsa",'."\n" + .' "regionId": "cn-shanghai",'."\n" + .' "tag": "rds",'."\n" + .' "username": "xsaxsa"'."\n" + .' }'."\n" + ."\n" + .'* rds'."\n" + ."\n" + .''."\n" + ."\n" + .' {'."\n" + .' "configType": 1,'."\n" + .' "tag": "rds",'."\n" + .' "database": "xsaxsa",'."\n" + .' "username": "xsaxsa",'."\n" + .' "password": "xssaxsa$32050",'."\n" + .' "instanceName": "rm-xsaxs",'."\n" + .' "rdsOwnerId": "11111111"'."\n" + .' }'."\n" + ."\n" + .'* oss'."\n" + ."\n" + .''."\n" + ."\n" + .' {'."\n" + .' "accessId": "sssssxx",'."\n" + .' "accessKey": "xsaxaxsaxs",'."\n" + .' "bucket": "xsa-xs-xs",'."\n" + .' "endpoint": "http://oss-cn-shanghai.aliyuncs.com",'."\n" + .' "tag": "public"'."\n" + .' }'."\n" + ."\n" + .'* sqlserver'."\n" + ."\n" + .''."\n" + ."\n" + .' {'."\n" + .' "jdbcUrl": "jdbc:sqlserver://xsaxsa-xsaxsa.database.xxx.cn:123;DatabaseName=xsxs-xsxs",'."\n" + .' "password": "sdasda$fs",'."\n" + .' "tag": "public",'."\n" + .' "username": "sxaxacdacdd"'."\n" + .' }'."\n" + ."\n" + .'* polardb'."\n" + ."\n" + .''."\n" + ."\n" + .' {'."\n" + .' "clusterId": "pc-sdadsadsa",'."\n" + .' "database": "dsadsadsa",'."\n" + .' "ownerId": "121212122",'."\n" + .' "password": "sdasdafssa",'."\n" + .' "region": "cn-shanghai",'."\n" + .' "tag": "polardb",'."\n" + .' "username": "asdadsads"'."\n" + .' }'."\n" + ."\n" + .'* oracle'."\n" + ."\n" + .''."\n" + ."\n" + .' {'."\n" + .' "jdbcUrl": "jdbc:oracle:saaa:@xxxxx:1521:PROD",'."\n" + .' "password": "sxasaxsa",'."\n" + .' "tag": "public",'."\n" + .' "username": "sasfadfa"'."\n" + .' }'."\n" + ."\n" + .'* mongodb'."\n" + ."\n" + .''."\n" + ."\n" + .' {'."\n" + .' "address": "[\\"xsaxxsa.mongodb.rds.aliyuncs.com:3717\\"]",'."\n" + .' "database": "admin",'."\n" + .' "password": "sadsda@",'."\n" + .' "tag": "public",'."\n" + .' "username": "dsadsadas"'."\n" + .' }'."\n" + ."\n" + .'* emr'."\n" + ."\n" + .''."\n" + ."\n" + .' {'."\n" + .' "accessId": "xsaxsa",'."\n" + .' "emrClusterId": "C-dsads",'."\n" + .' "emrResourceQueueName": "default",'."\n" + .' "emrEndpoint": "emr.aliyuncs.com",'."\n" + .' "accessKey": "dsadsad",'."\n" + .' "emrUserId": "224833315798889783",'."\n" + .' "name": "sasdsadsa",'."\n" + .' "emrAccessMode": "simple",'."\n" + .' "region": "cn-shanghai",'."\n" + .' "authType": "2",'."\n" + .' "emrProjectId": "FP-sdadsad"'."\n" + .' }'."\n" + ."\n" + .'* postgresql'."\n" + ."\n" + .''."\n" + ."\n" + .' {'."\n" + .' "jdbcUrl": "jdbc:postgresql://xxxx:1921/ssss",'."\n" + .' "password": "sdadsads",'."\n" + .' "tag": "public",'."\n" + .' "username": "sdsasda"'."\n" + .' }'."\n" + ."\n" + .'* analyticdb_for_mysql'."\n" + ."\n" + .''."\n" + ."\n" + .' {'."\n" + .' "instanceId": "am-sadsada",'."\n" + .' "database": "xsxsx",'."\n" + .' "username": "xsxsa",'."\n" + .' "password": "asdadsa",'."\n" + .' "connectionString": "am-xssxsxs.ads.aliyuncs.com:3306"'."\n" + .' }'."\n" + ."\n" + .'* hybriddb_for_postgresql'."\n" + ."\n" + .''."\n" + ."\n" + .' {'."\n" + .' "connectionString": "gp-xsaxsaxa-master.gpdbmaster.rds.aliyuncs.com",'."\n" + .' "database": "xsaxsaxas",'."\n" + .' "password": "xsaxsaxsa@11",'."\n" + .' "instanceId": "gp-xsaxsaxsa",'."\n" + .' "port": "541132",'."\n" + .' "ownerId": "xsaxsaxsas",'."\n" + .' "username": "sadsad"'."\n" + .' }'."\n" + ."\n" + .'* holo'."\n" + ."\n" + .''."\n" + ."\n" + .' {'."\n" + .' "accessId": "xsaxsaxs",'."\n" + .' "accessKey": "xsaxsaxsa",'."\n" + .' "database": "xsaxsaxsa",'."\n" + .' "instanceId": "xsaxa",'."\n" + .' "tag": "aliyun"'."\n" + .' }'."\n" + ."\n" + .'* kafka'."\n" + ."\n" + .''."\n" + ."\n" + .' {'."\n" + .' "instanceId": "xsax-cn-xsaxsa",'."\n" + .' "regionId": "cn-shanghai",'."\n" + .' "tag": "aliyun",'."\n" + .' "ownerId": "1212121212112"'."\n" + .' }'."\n", 'type' => 'string', 'example' => '{\\"database\\":\\"xxx\\",\\"instanceName\\":\\"xxx\\",\\"password\\":\\"xxx\\",\\"rdsOwnerId\\":\\"xxx\\",\\"tag\\":\\"rds\\",\\"username\\":\\"xxx\\"}'], + 'Id' => ['description' => 'The data source ID.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'BindingCalcEngineId' => ['description' => 'The ID of the compute engine with which the data source is associated.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '123'], + 'TenantId' => ['description' => 'The tenant ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234567'], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Invalid.Tenant.ConnectionNotExists', 'errorMessage' => 'The connection does not exist.', 'description' => 'The connection does not exist.'], + ['errorCode' => 'Invalid.Tenant.ProjectNotExists', 'errorMessage' => 'The project does not exist.', 'description' => 'The project does not exist.'], + ['errorCode' => 'Invalid.Tenant.UserNotInProject', 'errorMessage' => 'The user is not in the project.', 'description' => 'The user is not in the project.'], + ], + 403 => [ + ['errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin', 'errorMessage' => 'The user is not a project administrator or owner.', 'description' => 'The user is not a project administrator or owner.'], + ['errorCode' => 'Invalid.Tenant.UserNotInTenant', 'errorMessage' => 'The user is not in tenant.', 'description' => 'The user is not in tenant.'], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0bc14115159376359****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 3,\\n \\"Connections\\": [\\n {\\n \\"Status\\": 1,\\n \\"ConnectionType\\": \\"mysql\\",\\n \\"ProjectId\\": 123,\\n \\"SubType\\": \\"mysql\\",\\n \\"GmtModified\\": \\"Mar 17, 2021 4:09:32 PM\\",\\n \\"EnvType\\": 1,\\n \\"ConnectStatus\\": 1,\\n \\"Sequence\\": 300,\\n \\"Description\\": \\"a connection\\",\\n \\"GmtCreate\\": \\"Mar 17, 2021 4:09:32 PM\\",\\n \\"DefaultEngine\\": false,\\n \\"Shared\\": false,\\n \\"Operator\\": \\"193543050****\\",\\n \\"Name\\": \\"abc\\",\\n \\"Content\\": \\"{\\\\\\\\\\\\\\"database\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"instanceName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"password\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"rdsOwnerId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"tag\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"rds\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"username\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\"}\\",\\n \\"Id\\": 1,\\n \\"BindingCalcEngineId\\": 123,\\n \\"TenantId\\": 1234567\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"0bc14115159****\\n200\\n\\n \\n 193543050****\\n 1\\n 1\\n a connection\\n mysql\\n 123\\n mysql\\n Oct 10, 2019 3:42:53 PM\\n 123\\n 300\\n false\\n 1\\n false\\n abc\\n Oct 10, 2019 3:42:53 PM\\n 1234567\\n {\\\\\\"database\\\\\\":\\\\\\"xxx\\\\\\",\\\\\\"instanceName\\\\\\":\\\\\\"xxx\\\\\\",\\\\\\"password\\\\\\":\\\\\\"xxx\\\\\\",\\\\\\"rdsOwnerId\\\\\\":\\\\\\"xxx\\\\\\",\\\\\\"tag\\\\\\":\\\\\\"rds\\\\\\",\\\\\\"username\\\\\\":\\\\\\"xxx\\\\\\"}\\n 1\\n \\n 3\\n 20\\n 1\\n\\ntrue","errorExample":""}]', + 'title' => 'ListConnections', + 'summary' => 'Queries a list of data sources.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'ListDIAlarmRules' => [ + 'summary' => 'Retrieves a list of alert rules configured for a synchronization task.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '154898', + 'abilityTreeNodes' => ['FEATUREdideTG7EYI'], + ], + 'parameters' => [ + [ + 'name' => 'DIJobId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the task with which the alert rules are associated.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11260', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'default' => '10', 'example' => '10', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '74C2FECD-5B3A-554A-BCF5-35****'], + 'DIAlarmRulePaging' => [ + 'description' => 'The pagination information.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'DIJobAlarmRules' => [ + 'description' => 'The alert rules.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the alert rule.', + 'type' => 'object', + 'properties' => [ + 'DIAlarmRuleId' => ['description' => 'The alert rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '41998', 'title' => ''], + 'DIJobId' => ['description' => 'The ID of the task with which the alert rule is associated.', 'type' => 'integer', 'format' => 'int64', 'example' => '11260', 'title' => ''], + 'Description' => ['description' => 'The description of the alert rule.', 'type' => 'string', 'example' => 'mysql synchronizes to hologres heartbeat alert', 'title' => ''], + 'MetricType' => [ + 'description' => 'The metric type in the alert rule. Valid values:'."\n" + ."\n" + .'- Heartbeat'."\n" + ."\n" + .'- FailoverCount'."\n" + ."\n" + .'- Delay', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'Heartbeat', + 'title' => '', + ], + 'Enabled' => ['description' => 'Indicates whether the alert rule is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'TriggerConditions' => [ + 'description' => 'The conditions that are used to trigger the alert rule.', + 'type' => 'array', + 'items' => [ + 'description' => 'The condition that is used to trigger the alert rule.', + 'type' => 'object', + 'properties' => [ + 'Severity' => [ + 'description' => 'The severity level. Valid values:'."\n" + ."\n" + .'- Warning'."\n" + ."\n" + .'- Critical', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'Warning', + 'title' => '', ], + 'Duration' => ['description' => 'The time interval for alert calculation. Unit: minutes.', 'type' => 'integer', 'format' => 'int64', 'example' => '15', 'title' => ''], + 'Threshold' => ['description' => 'The alert threshold.'."\n" + ."\n" + .'- If the alert rule is for task status, no threshold is used.'."\n" + ."\n" + .'- If the alert rule is for failovers, the threshold is the number of failovers.'."\n" + ."\n" + .'- If the alert rule is for latency, the threshold is the latency duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'WizardDetails' => [ - 'description' => 'The details of the API generated in wizard mode. This parameter is returned only if the API is generated in wizard mode.'."\n", + 'NotificationSettings' => [ + 'description' => 'The alert notification settings.', 'type' => 'object', 'properties' => [ - 'IsPagedResponse' => [ - 'description' => 'Indicates whether the entries are returned by page.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'WizardRequestParameters' => [ - 'description' => 'The request parameters of the API generated in wizard mode.'."\n", + 'NotificationChannels' => [ + 'description' => 'The alert notification methods.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The alert notification method.', 'type' => 'object', 'properties' => [ - 'ColumnName' => [ - 'description' => 'The name of the associated field. This parameter is supported only if the API is generated in wizard mode.'."\n", - 'type' => 'string', - 'example' => 'column1', - ], - 'ParameterName' => [ - 'description' => 'The name of the parameter.'."\n", - 'type' => 'string', - 'example' => 'param1', - ], - 'ParameterPosition' => [ - 'description' => 'The position of the parameter. Valid values: 0, 1, 2, and 3. The value 0 indicates that the parameter is in the URL path of the request. The value 1 indicates that the parameter is in the Query parameter of the request URL. The value 2 indicates that the parameter is in the request header. The value 3 indicates that the parameter is in the request body. APIs generated in wizard or script mode support only the Query position. APIs generated by registration whose request method is GET or DELETE support the Query and Head positions. APIs generated by registration whose request method is PUT or POST support the Query, Head, and Body positions.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ParameterDescription' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'description1', - ], - 'DefaultValue' => [ - 'description' => 'The default value.'."\n", - 'type' => 'string', - 'example' => 'default1', - ], - 'ParameterOperator' => [ - 'description' => 'The operator used for the value of the parameter. Valid values: 0, 1, 2, and 3. The value 0 indicates the Equal operator. The value 1 indicates the Like operator. The value 2 indicates the Const operator. The value 3 indicates the In operator. APIs generated in wizard mode support the Equal, Like, and In operators. APIs generated in script mode support the Equal operator. APIs generated by registration support the Equal and Const operators.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ParameterDataType' => [ - 'description' => 'The data type of the parameter. Valid values:'."\n" + 'Severity' => [ + 'description' => 'The severity level. Valid values:'."\n" ."\n" - .'* 0: String'."\n" - .'* 1: Int'."\n" - .'* 2: Long'."\n" - .'* 3: Float'."\n" - .'* 4: Double'."\n" - .'* 5: Boolean'."\n" - .'* 6: StringList'."\n" - .'* 7: IntList'."\n" - .'* 8: LongList'."\n" - .'* 9: FloatList'."\n" - .'* 10: DoubleList'."\n" - .'* 11: BooleanList'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ExampleValue' => [ - 'description' => 'The sample value.'."\n", + .'- Warning'."\n" + ."\n" + .'- Critical', + 'enumValueTitles' => [], 'type' => 'string', - 'example' => 'example1', + 'example' => 'Warning', + 'title' => '', ], - 'IsRequiredParameter' => [ - 'description' => 'Indicates whether the parameter is required.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Channels' => [ + 'description' => 'The alert notification methods.', + 'type' => 'array', + 'items' => [ + 'description' => 'The alert notification method. Valid values:'."\n" + ."\n" + .'- Mail: email'."\n" + ."\n" + .'- Phone: phone call'."\n" + ."\n" + .'- Sms: text message'."\n" + ."\n" + .'- Ding: DingTalk chatbot token', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'Ding', + 'title' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'WizardResponseParameters' => [ - 'description' => 'The response parameters of the API generated in wizard mode.'."\n", + 'NotificationReceivers' => [ + 'description' => 'The settings of alert notification recipients.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The setting of an alert notification recipient.', 'type' => 'object', 'properties' => [ - 'ParameterDescription' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'description2', - ], - 'ColumnName' => [ - 'description' => 'The name of the associated field. This parameter is supported only if the API is generated in wizard mode.'."\n", - 'type' => 'string', - 'example' => 'column2', - ], - 'ParameterName' => [ - 'description' => 'The name of the parameter.'."\n", + 'ReceiverType' => [ + 'description' => 'The recipient type. Valid values: AliyunUid and DingToken.'."\n" + ."\n" + .'- If the alert notification method is Mail, Phone, or Sms, the value of this parameter is **AliyunUid**, which indicates the Alibaba Cloud account ID.'."\n" + ."\n" + .'- If the alert notification method is Ding, the value of this parameter is **DingToken**, which indicates the DingTalk chatbot token.', + 'enumValueTitles' => [], 'type' => 'string', - 'example' => 'param2', + 'example' => 'DingToken', + 'title' => '', ], - 'ParameterDataType' => [ - 'description' => 'The data type of the parameter. Valid values:'."\n" + 'ReceiverValues' => [ + 'description' => 'The recipients.', + 'type' => 'array', + 'items' => ['description' => 'The recipient.'."\n" ."\n" - .'* 0: String'."\n" - .'* 1: Int'."\n" - .'* 2: Long'."\n" - .'* 3: Float'."\n" - .'* 4: Double'."\n" - .'* 5: Boolean'."\n" - .'* 6: StringList'."\n" - .'* 7: IntList'."\n" - .'* 8: LongList'."\n" - .'* 9: FloatList'."\n" - .'* 10: DoubleList'."\n" - .'* 11: BooleanList'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ExampleValue' => [ - 'description' => 'The sample value.'."\n", - 'type' => 'string', - 'example' => 'example2', + .'- If the recipient type is Alibaba Cloud account ID, the value of this parameter is the Alibaba Cloud account ID of a user.'."\n" + ."\n" + .'- If the recipient type is DingTalk chatbot token, the value of this parameter is the token of a DingTalk chatbot.', 'type' => 'string', 'example' => 'token1', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'WizardConnection' => [ - 'description' => 'The data source information about the API generated in wizard mode.'."\n", - 'type' => 'object', - 'properties' => [ - 'TableName' => [ - 'description' => 'The name of the table in the data source.'."\n", - 'type' => 'string', - 'example' => 't', - ], - 'ConnectionId' => [ - 'description' => 'The data source ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - ], - ], + 'InhibitionInterval' => ['description' => 'The duration of the alert suppression interval. Unit: minutes.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], ], 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"74C2FECD-5B3A-554A-BCF5-35****\\",\\n \\"DIAlarmRulePaging\\": {\\n \\"TotalCount\\": 2,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"DIJobAlarmRules\\": [\\n {\\n \\"DIAlarmRuleId\\": 41998,\\n \\"DIJobId\\": 11260,\\n \\"Description\\": \\"mysql synchronizes to hologres heartbeat alert\\",\\n \\"MetricType\\": \\"Heartbeat\\",\\n \\"Enabled\\": true,\\n \\"TriggerConditions\\": [\\n {\\n \\"Severity\\": \\"Warning\\",\\n \\"Duration\\": 15,\\n \\"Threshold\\": 5\\n }\\n ],\\n \\"NotificationSettings\\": {\\n \\"NotificationChannels\\": [\\n {\\n \\"Severity\\": \\"Warning\\",\\n \\"Channels\\": [\\n \\"Ding\\"\\n ]\\n }\\n ],\\n \\"NotificationReceivers\\": [\\n {\\n \\"ReceiverType\\": \\"DingToken\\",\\n \\"ReceiverValues\\": [\\n \\"token1\\"\\n ]\\n }\\n ],\\n \\"InhibitionInterval\\": 5\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListDIAlarmRules', + 'description' => 'Alert rules can be configured when your task includes real-time synchronization.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDIAlarmRules'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Apis\\": [\\n {\\n \\"Timeout\\": 10000,\\n \\"Status\\": 0,\\n \\"ApiId\\": 10002,\\n \\"ApiMode\\": 0,\\n \\"ProjectId\\": 10000,\\n \\"ResponseContentType\\": 0,\\n \\"CreatorId\\": \\"1234567\\",\\n \\"VisibleRange\\": 0,\\n \\"ModifiedTime\\": \\"2020-06-23T00:21:01+0800\\",\\n \\"OperatorId\\": \\"2345678\\",\\n \\"GroupId\\": \\"abcde123456789\\",\\n \\"Description\\": \\"Test API description\\",\\n \\"FolderId\\": 0,\\n \\"RequestMethod\\": 0,\\n \\"CreatedTime\\": \\"2020-06-23T00:21:01+0800\\",\\n \\"ApiName\\": \\"My API name\\",\\n \\"TenantId\\": 10000,\\n \\"ApiPath\\": \\"/test/1\\",\\n \\"Protocols\\": [\\n 0\\n ],\\n \\"RegistrationDetails\\": {\\n \\"ServiceHost\\": \\"http://example.aliyundoc.com\\",\\n \\"ServiceContentType\\": 0,\\n \\"ServicePath\\": \\"/index\\",\\n \\"SuccessfulResultSample\\": \\"{\\\\\\"success\\\\\\": true}\\",\\n \\"FailedResultSample\\": \\"{\\\\\\"success\\\\\\": false}\\",\\n \\"ServiceRequestBodyDescription\\": \\"{\\\\\\"abc\\\\\\":1}\\",\\n \\"RegistrationErrorCodes\\": [\\n {\\n \\"ErrorMessage\\": \\"fail to call\\",\\n \\"ErrorCode\\": \\"1001\\",\\n \\"ErrorSolution\\": \\"retry\\"\\n }\\n ],\\n \\"RegistrationRequestParameters\\": [\\n {\\n \\"ColumnName\\": \\"column1\\",\\n \\"ParameterName\\": \\"name1\\",\\n \\"ParameterPosition\\": 0,\\n \\"ParameterDescription\\": \\"description1\\",\\n \\"DefaultValue\\": \\"default1\\",\\n \\"ParameterOperator\\": 0,\\n \\"ParameterDataType\\": 0,\\n \\"ExampleValue\\": \\"example1\\",\\n \\"IsRequiredParameter\\": true\\n }\\n ]\\n },\\n \\"ScriptDetails\\": {\\n \\"Script\\": \\"select a from t\\",\\n \\"IsPagedResponse\\": true,\\n \\"ScriptRequestParameters\\": [\\n {\\n \\"ColumnName\\": \\"column1\\",\\n \\"ParameterName\\": \\"param1\\",\\n \\"ParameterPosition\\": 0,\\n \\"ParameterDescription\\": \\"description1\\",\\n \\"DefaultValue\\": \\"default1\\",\\n \\"ParameterOperator\\": 0,\\n \\"ParameterDataType\\": 0,\\n \\"ExampleValue\\": \\"example1\\",\\n \\"IsRequiredParameter\\": true\\n }\\n ],\\n \\"ScriptResponseParameters\\": [\\n {\\n \\"ParameterDescription\\": \\"description2\\",\\n \\"ColumnName\\": \\"column2\\",\\n \\"ParameterName\\": \\"param2\\",\\n \\"ParameterDataType\\": 0,\\n \\"ExampleValue\\": \\"example2\\"\\n }\\n ],\\n \\"ScriptConnection\\": {\\n \\"TableName\\": \\"t\\",\\n \\"ConnectionId\\": 123\\n }\\n },\\n \\"WizardDetails\\": {\\n \\"IsPagedResponse\\": true,\\n \\"WizardRequestParameters\\": [\\n {\\n \\"ColumnName\\": \\"column1\\",\\n \\"ParameterName\\": \\"param1\\",\\n \\"ParameterPosition\\": 0,\\n \\"ParameterDescription\\": \\"description1\\",\\n \\"DefaultValue\\": \\"default1\\",\\n \\"ParameterOperator\\": 0,\\n \\"ParameterDataType\\": 0,\\n \\"ExampleValue\\": \\"example1\\",\\n \\"IsRequiredParameter\\": true\\n }\\n ],\\n \\"WizardResponseParameters\\": [\\n {\\n \\"ParameterDescription\\": \\"description2\\",\\n \\"ColumnName\\": \\"column2\\",\\n \\"ParameterName\\": \\"param2\\",\\n \\"ParameterDataType\\": 0,\\n \\"ExampleValue\\": \\"example2\\"\\n }\\n ],\\n \\"WizardConnection\\": {\\n \\"TableName\\": \\"t\\",\\n \\"ConnectionId\\": 123\\n }\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 0000-ABCD-EFG****\\n The connection does not exist.\\n true\\n Invalid.Tenant.ConnectionNotExists\\n \\n 1\\n 10\\n 100\\n \\n 10000\\n 0\\n 10002\\n 0\\n 10000\\n 0\\n 1234567\\n 0\\n 2020-06-23T00:21:01+0800\\n 2345678\\n abcde123456789\\n 测试API描述\\n 0\\n 0\\n 2020-06-23T00:21:01+0800\\n 我的API名称\\n 10000\\n /test/1\\n 0\\n \\n http://example.aliyundoc.com\\n 0\\n /index\\n {\\"success\\": true}\\n {\\"success\\": false}\\n {\\"abc\\":1}\\n \\n fail to call\\n 1001\\n retry\\n \\n \\n column1\\n name1\\n 0\\n description1\\n default1\\n 0\\n 0\\n example1\\n true\\n \\n \\n \\n \\n true\\n \\n column1\\n param1\\n 0\\n description1\\n default1\\n 0\\n 0\\n example1\\n true\\n \\n \\n description2\\n column2\\n param2\\n 0\\n example2\\n \\n \\n t\\n 123\\n \\n \\n \\n true\\n \\n column1\\n param1\\n 0\\n description1\\n default1\\n 0\\n 0\\n example1\\n true\\n \\n \\n description2\\n column2\\n param2\\n 0\\n example2\\n \\n \\n t\\n 123\\n \\n \\n \\n \\n","errorExample":""}]', - 'title' => 'ListDataServiceApis', - 'summary' => 'Queries a list of APIs in the development state.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => 'The details of different types of APIs are returned in different parameters. The details of an API generated in wizard mode are returned in the WizardDetails parameter. The details of an API generated in script mode are returned in the ScriptDetails parameter. The details of an API generated by registration are returned in the RegistrationDetails parameter.'."\n", - 'extraInfo' => ' ', ], - 'GetDataServiceApi' => [ - 'methods' => [ - 'post', + 'ListDIJobs' => [ + 'summary' => 'Retrieves a list of synchronization tasks.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '155162', + 'abilityTreeNodes' => ['FEATUREdideQHGTK4'], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1967', 'title' => ''], + ], + [ + 'name' => 'JobName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the task. Fuzzy match is supported. If you do not configure this parameter, no limits are imposed on the tasks.', 'type' => 'string', 'required' => false, 'example' => 'mysql_to_holo_sync_8772', 'title' => ''], + ], + [ + 'name' => 'SourceDataSourceType', + 'in' => 'formData', + 'schema' => ['description' => 'The source type. If you do not configure this parameter, no limits are imposed on the tasks.', 'type' => 'string', 'required' => false, 'example' => 'MySQL', 'title' => ''], + ], + [ + 'name' => 'DestinationDataSourceType', + 'in' => 'formData', + 'schema' => ['description' => 'The destination type. If you do not configure this parameter, no limits are imposed on the tasks.', 'type' => 'string', 'required' => false, 'example' => 'Hologres', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '7263E4AC-9D2E-5B29-B8AF-7C5012E92A41'], + 'DIJobPaging' => [ + 'description' => 'The pagination information.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '6', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'DIJobs' => [ + 'description' => 'The list of tasks.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DIJobId' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '16626', 'title' => ''], + 'ProjectId' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1967', 'title' => ''], + 'JobName' => ['description' => 'The task name.', 'type' => 'string', 'example' => 'mysql_to_holo_sync_8772', 'title' => ''], + 'MigrationType' => [ + 'description' => 'The synchronization type. Valid values:'."\n" + ."\n" + .'- FullAndRealtimeIncremental: one-time full synchronization and real-time incremental synchronization'."\n" + ."\n" + .'- RealtimeIncremental: real-time incremental synchronization'."\n" + ."\n" + .'- Full: one-time full synchronization', + 'enumValueTitles' => ['FullAndRealtimeIncremental' => '', 'RealtimeIncremental' => '', 'Full' => ''], + 'type' => 'string', + 'example' => 'Full', + 'title' => '', + ], + 'SourceDataSourceType' => [ + 'description' => 'The type of the source. The value MySQL is returned.', + 'enumValueTitles' => ['MySQL' => 'MySQL'], + 'type' => 'string', + 'example' => 'MySQL', + 'title' => '', + ], + 'DestinationDataSourceType' => [ + 'description' => 'The type of the destination. The value Hologres is returned.', + 'enumValueTitles' => ['Hologres' => 'Hologres'], + 'type' => 'string', + 'example' => 'Hologres', + 'title' => '', + ], + 'JobStatus' => [ + 'description' => 'The task status. Valid values:'."\n" + ."\n" + .'- Finished'."\n" + ."\n" + .'- Initialized'."\n" + ."\n" + .'- Stopped'."\n" + ."\n" + .'- Failed'."\n" + ."\n" + .'- Running'."\n" + ."\n" + .'- Stopping', + 'enumValueTitles' => ['Finished' => '', 'Initialized' => '', 'Stopped' => '', 'Failed' => '', 'Running' => '', 'Stopping' => ''], + 'type' => 'string', + 'example' => 'Finished', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], ], - 'schemes' => [ - 'http', - 'https', + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7263E4AC-9D2E-5B29-B8AF-7C5012E92A41\\",\\n \\"DIJobPaging\\": {\\n \\"TotalCount\\": 6,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"DIJobs\\": [\\n {\\n \\"DIJobId\\": 16626,\\n \\"ProjectId\\": 1967,\\n \\"JobName\\": \\"mysql_to_holo_sync_8772\\",\\n \\"MigrationType\\": \\"Full\\",\\n \\"SourceDataSourceType\\": \\"MySQL\\",\\n \\"DestinationDataSourceType\\": \\"Hologres\\",\\n \\"JobStatus\\": \\"Finished\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListDIJobs', + 'description' => 'You can call this operation to obtain only the basic information about the tasks. If you want to obtain the details of a task, call the GetDIJob operation.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDIJobs'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListDIProjectConfig' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'PrivateKey' => [], + ], + [ + 'APP' => [], + ], ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '78235', - 'abilityTreeNodes' => [ - 'FEATUREdide7T0EJX', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'TenantId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The tenant ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '10002', - ], + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '10000000000', 'minimum' => '1', 'example' => '1000'], ], [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the workspace.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '10001', - ], + 'name' => 'DestinationType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the destinations of the synchronization solutions. This parameter cannot be left empty. Valid values: analyticdb_for_mysql, odps, elasticsearch, holo, mysql, and polardb.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'elasticsearch'], ], [ - 'name' => 'ApiId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the DataService Studio API.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '10000', - ], + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the sources of the synchronization solutions. Valid values: oracle, mysql, polardb, datahub, drds, and analyticdb_for_mysql. If you do not configure this parameter, DataWorks applies the default global configuration to all sources.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'mysql'], ], ], 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'The specified parameters are invalid.', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'example' => '1031203110005', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'Timeout' => [ - 'description' => 'The timeout period of the API request. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10000', - ], - 'Status' => [ - 'description' => 'The status of the API. Valid values: 0 and 1. The value 0 indicates that the API is not published. The value 1 indicates that the API is published.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ApiId' => [ - 'description' => 'The ID of the DataService Studio API.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000', - ], - 'ApiMode' => [ - 'description' => 'The type of the API. Valid values: 0, 1, and 2. The value 0 indicates that the API is generated in wizard mode. The value 1 indicates that the API is generated in script mode. The value 2 indicates that the API is generated by registration.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ProjectId' => [ - 'description' => 'The ID of the workspace.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10001', - ], - 'ResponseContentType' => [ - 'description' => 'The format in which the response of the API request is returned. Valid values: 0 and 1. The value 0 indicates the JSON format. The value 1 indicates the XML format. APIs generated in wizard or script mode support the JSON format. APIs generated by registration support the JSON and XML formats.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'CreatorId' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the creator of the API.'."\n", - 'type' => 'string', - 'example' => '1234567', - ], - 'VisibleRange' => [ - 'description' => 'The scope in which the API is visible. Valid values: 0 and 1. The value 0 indicates that the API is visible to the members in a specific workspace. The value 1 indicates that the API is visible only to the API creator.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ModifiedTime' => [ - 'description' => 'The time when the API was last modified.'."\n", - 'type' => 'string', - 'example' => '2020-06-23T00:21:01+0800', - ], - 'OperatorId' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the user who last modified the API.'."\n", - 'type' => 'string', - 'example' => '2345678', - ], - 'GroupId' => [ - 'description' => 'The ID of the group.'."\n", - 'type' => 'string', - 'example' => 'ab123****', - ], - 'Description' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'Description of the test API'."\n", - ], - 'FolderId' => [ - 'description' => 'The ID of the folder.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'RequestMethod' => [ - 'description' => 'The request method of the API. Valid values: 0, 1, 2, and 3. The value 0 indicates the GET method. The value 1 indicates the POST method. The value 2 indicates the PUT method. The value 3 indicates the DELETE method. APIs generated in wizard or script mode support the GET and POST methods. APIs generated by registration support the GET, POST, PUT, and DELETE methods.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'CreatedTime' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'string', - 'example' => '2020-06-23T00:21:01+0800', - ], - 'ApiName' => [ - 'description' => 'The name of the API.'."\n", - 'type' => 'string', - 'example' => 'Name of the test API'."\n", - ], - 'TenantId' => [ - 'description' => 'The ID of the tenant.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10002', - ], - 'ApiPath' => [ - 'description' => 'The path of the API.'."\n", - 'type' => 'string', - 'example' => '/test/1', - ], - 'Protocols' => [ - 'description' => 'The list of fields.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The protocol used by the API. Valid values: 0 and 1. The value 0 indicates that the API uses HTTP. The value 1 indicates that the API uses HTTPS. Two protocols are presented in a list.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - ], - 'RegistrationDetails' => [ - 'description' => 'The details of the API generated by registration. This parameter is returned only if the API is generated by registration.'."\n", - 'type' => 'object', - 'properties' => [ - 'ServiceHost' => [ - 'description' => 'The address of the backend service.'."\n", - 'type' => 'string', - 'example' => 'http://example.aliyundoc.com', - ], - 'ServiceContentType' => [ - 'description' => 'The format in which the response of the API request is returned. Valid values:'."\n" - ."\n" - .'* 0: indicates the JSON format.'."\n" - .'* 1: indicates the XML format.'."\n" - ."\n" - .'APIs generated in wizard or script mode support the JSON format. APIs generated by registration support the JSON and XML formats.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ServicePath' => [ - 'description' => 'The path of the backend service.'."\n", - 'type' => 'string', - 'example' => '/index', - ], - 'SuccessfulResultSample' => [ - 'description' => 'Sample success responses'."\n", - 'type' => 'string', - 'example' => '{"success": true}', - ], - 'FailedResultSample' => [ - 'description' => 'The sample error response of the API.'."\n", - 'type' => 'string', - 'example' => '{"success": false}', - ], - 'ServiceRequestBodyDescription' => [ - 'description' => 'The description of the request body initiated to call the backend service.'."\n", - 'type' => 'string', - 'example' => '{"abc":1}', - ], - 'RegistrationErrorCodes' => [ - 'description' => 'The error codes returned for the API generated by registration.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The returned result.'."\n", - 'type' => 'object', - 'properties' => [ - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'fail to call', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '1001', - ], - 'ErrorSolution' => [ - 'description' => 'The solution used to fix the error.'."\n", - 'type' => 'string', - 'example' => 'retry', - ], - ], - ], - ], - 'RegistrationRequestParameters' => [ - 'description' => 'The request parameters of the API generated by registration.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The returned result.'."\n", - 'type' => 'object', - 'properties' => [ - 'ColumnName' => [ - 'description' => 'The name of the associated field. This parameter is supported only if the API is generated in wizard mode.'."\n", - 'type' => 'string', - 'example' => 'column1', - ], - 'ParameterName' => [ - 'description' => 'The name of the parameter.'."\n", - 'type' => 'string', - 'example' => 'name1', - ], - 'ParameterPosition' => [ - 'description' => 'The position of the parameter. Valid values:'."\n" - ."\n" - .'* 0: indicates that the parameter is in the URL path of the request.'."\n" - .'* 1: indicates that the parameter is in the Query parameter of the request URL.'."\n" - .'* 2: indicates that the parameter is in the request header.'."\n" - .'* 3: indicates that the parameter is in the request body.'."\n" - ."\n" - .'APIs generated in wizard or script mode support only the Query position. APIs generated by registration whose request method is GET or DELETE support the Query and Head positions. APIs generated by registration whose request method is PUT or POST support the Query, Head, and Body positions.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ParameterDescription' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'description1', - ], - 'DefaultValue' => [ - 'description' => 'The default value.'."\n", - 'type' => 'string', - 'example' => 'default1', - ], - 'ParameterOperator' => [ - 'description' => 'The operator used for the value of the parameter. Valid values:'."\n" - ."\n" - .'* 0: Equal'."\n" - .'* 1: Like'."\n" - .'* 2: Const'."\n" - .'* 3: In'."\n" - ."\n" - .'APIs generated in wizard mode support the Equal, Like, and In operators. APIs generated in script mode support the Equal operator. APIs generated by registration support the Equal and Const operators.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ParameterDataType' => [ - 'description' => 'The data type of the parameter. Valid values:'."\n" - ."\n" - .'* 0: String'."\n" - .'* 1: Int'."\n" - .'* 2: Long'."\n" - .'* 3: Float'."\n" - .'* 4: Double'."\n" - .'* 5: Boolean'."\n" - .'* 6: StringList'."\n" - .'* 7: IntList'."\n" - .'* 8: LongList'."\n" - .'* 9: FloatList'."\n" - .'* 10: DoubleList'."\n" - .'* 11: BooleanList'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ExampleValue' => [ - 'description' => 'The sample value.'."\n", - 'type' => 'string', - 'example' => 'example1', - ], - 'IsRequiredParameter' => [ - 'description' => 'Indicates whether the parameter is required.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], - ], - ], - 'ScriptDetails' => [ - 'description' => 'The details of the API generated in script mode. This parameter is returned only if the API is generated in script mode.'."\n", - 'type' => 'object', - 'properties' => [ - 'Script' => [ - 'description' => 'The SQL script.'."\n", - 'type' => 'string', - 'example' => 'select a from t', - ], - 'IsPagedResponse' => [ - 'description' => 'Indicates whether the entries were returned by page.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ScriptRequestParameters' => [ - 'description' => 'The request parameters of the API generated in script mode.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The returned result.'."\n", - 'type' => 'object', - 'properties' => [ - 'ColumnName' => [ - 'description' => 'The name of the associated field. This parameter is supported only if the API is generated in wizard mode.'."\n", - 'type' => 'string', - 'example' => 'column1', - ], - 'ParameterName' => [ - 'description' => 'The name of the parameter.'."\n", - 'type' => 'string', - 'example' => 'param1', - ], - 'ParameterPosition' => [ - 'description' => 'The position of the parameter. Valid values: 0, 1, 2, and 3. The value 0 indicates that the parameter is in the URL path of the request. The value 1 indicates that the parameter is in the Query parameter of the request URL. The value 2 indicates that the parameter is in the request header. The value 3 indicates that the parameter is in the request body. APIs generated in wizard or script mode support only the Query position. APIs generated by registration whose request method is GET or DELETE support the Query and Head positions. APIs generated by registration whose request method is PUT or POST support the Query, Head, and Body positions.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ParameterDescription' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'description1', - ], - 'DefaultValue' => [ - 'description' => 'The default value.'."\n", - 'type' => 'string', - 'example' => 'default1', - ], - 'ParameterOperator' => [ - 'description' => 'The operator used for the value of the parameter. Valid values: 0, 1, 2, and 3. The value 0 indicates the Equal operator. The value 1 indicates the Like operator. The value 2 indicates the Const operator. The value 3 indicates the In operator. APIs generated in wizard mode support the Equal, Like, and In operators. APIs generated in script mode support the Equal operator. APIs generated by registration support the Equal and Const operators.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ParameterDataType' => [ - 'description' => 'The data type of the parameter. Valid values:'."\n" - ."\n" - .'* 0: String'."\n" - .'* 1: Int'."\n" - .'* 2: Long'."\n" - .'* 3: Float'."\n" - .'* 4: Double'."\n" - .'* 5: Boolean'."\n" - .'* 6: StringList'."\n" - .'* 7: IntList'."\n" - .'* 8: LongList'."\n" - .'* 9: FloatList'."\n" - .'* 10: DoubleList'."\n" - .'* 11: BooleanList'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ExampleValue' => [ - 'description' => 'The sample value.'."\n", - 'type' => 'string', - 'example' => 'example1', - ], - 'IsRequiredParameter' => [ - 'description' => 'Indicates whether the parameter is required.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], - 'ScriptResponseParameters' => [ - 'description' => 'The response parameters of the API generated in script mode.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The returned result.'."\n", - 'type' => 'object', - 'properties' => [ - 'ParameterDescription' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'description2', - ], - 'ColumnName' => [ - 'description' => 'The name of the associated field. This parameter is supported only if the API is generated in wizard mode.'."\n", - 'type' => 'string', - 'example' => 'column2', - ], - 'ParameterName' => [ - 'description' => 'The name of the parameter.'."\n", - 'type' => 'string', - 'example' => 'param2', - ], - 'ParameterDataType' => [ - 'description' => 'The data type of the parameter. Valid values:'."\n" - ."\n" - .'* 0: String'."\n" - .'* 1: Int'."\n" - .'* 2: Long'."\n" - .'* 3: Float'."\n" - .'* 4: Double'."\n" - .'* 5: Boolean'."\n" - .'* 6: StringList'."\n" - .'* 7: IntList'."\n" - .'* 8: LongList'."\n" - .'* 9: FloatList'."\n" - .'* 10: DoubleList'."\n" - .'* 11: BooleanList'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ExampleValue' => [ - 'description' => 'The sample value.'."\n", - 'type' => 'string', - 'example' => 'example2', - ], - ], - ], - ], - 'ScriptConnection' => [ - 'description' => 'The data source information of the API generated in script mode.'."\n", - 'type' => 'object', - 'properties' => [ - 'TableName' => [ - 'description' => 'The name of the table in the data source.'."\n", - 'type' => 'string', - 'example' => 't', - ], - 'ConnectionId' => [ - 'description' => 'The ID of the data source.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - ], - ], - ], - ], - 'WizardDetails' => [ - 'description' => 'The details of the API generated in wizard mode. This parameter is returned only if the API is generated in wizard mode.'."\n", - 'type' => 'object', - 'properties' => [ - 'IsPagedResponse' => [ - 'description' => 'Indicates whether the entries were returned by page.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'WizardRequestParameters' => [ - 'description' => 'The request parameters of the API generated in wizard mode.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The returned result.'."\n", - 'type' => 'object', - 'properties' => [ - 'ColumnName' => [ - 'description' => 'The name of the associated field. This parameter is supported only if the API is generated in wizard mode.'."\n", - 'type' => 'string', - 'example' => 'column1', - ], - 'ParameterName' => [ - 'description' => 'The name of the parameter.'."\n", - 'type' => 'string', - 'example' => 'param1', - ], - 'ParameterPosition' => [ - 'description' => 'The position of the parameter. Valid values: 0, 1, 2, and 3. The value 0 indicates that the parameter is in the URL path of the request. The value 1 indicates that the parameter is in the Query parameter of the request URL. The value 2 indicates that the parameter is in the request header. The value 3 indicates that the parameter is in the request body. APIs generated in wizard or script mode support only the Query position. APIs generated by registration whose request method is GET or DELETE support the Query and Head positions. APIs generated by registration whose request method is PUT or POST support the Query, Head, and Body positions.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ParameterDescription' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'description1', - ], - 'DefaultValue' => [ - 'description' => 'The default value.'."\n", - 'type' => 'string', - 'example' => 'default1', - ], - 'ParameterOperator' => [ - 'description' => 'The operator used for the value of the parameter. Valid values: 0, 1, 2, and 3. The value 0 indicates the Equal operator. The value 1 indicates the Like operator. The value 2 indicates the Const operator. The value 3 indicates the In operator. APIs generated in wizard mode support the Equal, Like, and In operators. APIs generated in script mode support the Equal operator. APIs generated by registration support the Equal and Const operators.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ParameterDataType' => [ - 'description' => 'The data type of the parameter. Valid values:'."\n" - ."\n" - .'* 0: String'."\n" - .'* 1: Int'."\n" - .'* 2: Long'."\n" - .'* 3: Float'."\n" - .'* 4: Double'."\n" - .'* 5: Boolean'."\n" - .'* 6: StringList'."\n" - .'* 7: IntList'."\n" - .'* 8: LongList'."\n" - .'* 9: FloatList'."\n" - .'* 10: DoubleList'."\n" - .'* 11: BooleanList'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ExampleValue' => [ - 'description' => 'The sample value.'."\n", - 'type' => 'string', - 'example' => 'example1', - ], - 'IsRequiredParameter' => [ - 'description' => 'Indicates whether the parameter is required.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], - 'WizardResponseParameters' => [ - 'description' => 'The response parameters of the API generated in wizard mode.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The returned result.'."\n", - 'type' => 'object', - 'properties' => [ - 'ParameterDescription' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'description2', - ], - 'ColumnName' => [ - 'description' => 'The name of the associated field. This parameter is supported only if the API is generated in wizard mode.'."\n", - 'type' => 'string', - 'example' => 'column2', - ], - 'ParameterName' => [ - 'description' => 'The name of the parameter.'."\n", - 'type' => 'string', - 'example' => 'param2', - ], - 'ParameterDataType' => [ - 'description' => 'The data type of the parameter. Valid values:'."\n" - ."\n" - .'* 0: String'."\n" - .'* 1: Int'."\n" - .'* 2: Long'."\n" - .'* 3: Float'."\n" - .'* 4: Double'."\n" - .'* 5: Boolean'."\n" - .'* 6: StringList'."\n" - .'* 7: IntList'."\n" - .'* 8: LongList'."\n" - .'* 9: FloatList'."\n" - .'* 10: DoubleList'."\n" - .'* 11: BooleanList'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ExampleValue' => [ - 'description' => 'The sample value.'."\n", - 'type' => 'string', - 'example' => 'example2', - ], - ], - ], - ], - 'WizardConnection' => [ - 'description' => 'The data source information of the API generated in wizard mode.'."\n", - 'type' => 'object', - 'properties' => [ - 'TableName' => [ - 'description' => 'The name of the table in the data source.'."\n", - 'type' => 'string', - 'example' => 't', - ], - 'ConnectionId' => [ - 'description' => 'The ID of the data source.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - ], - ], - ], - ], + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0000-ABCD-EFG '], + 'Data' => [ + 'description' => 'The information about the query.'."\n", + 'type' => 'object', + 'properties' => [ + 'Config' => ['description' => 'The default global configuration of synchronization solutions. The value indicates the processing rules of different types of DDL messages. Example: {"RENAMECOLUMN":"WARNING","DROPTABLE":"WARNING","CREATETABLE":"WARNING","MODIFYCOLUMN":"WARNING","TRUNCATETABLE":"WARNING","DROPCOLUMN":"WARNING","ADDCOLUMN":"WARNING","RENAMETABLE":"WARNING"}'."\n" + ."\n" + .'Field description:'."\n" + ."\n" + .'* RENAMECOLUMN: renames a column.'."\n" + .'* DROPTABLE: deletes a table.'."\n" + .'* CREATETABLE: creates a table.'."\n" + .'* MODIFYCOLUMN: changes the data type of a column.'."\n" + .'* TRUNCATETABLE: clears a table.'."\n" + .'* DROPCOLUMN: deletes a column.'."\n" + .'* ADDCOLUMN: creates a column.'."\n" + .'* RENAMETABLE: renames a table.'."\n" + ."\n" + .'DataWorks processes a DDL message of a specific type based on the following rules:'."\n" + ."\n" + .'* WARNING: ignores the message and records an alert in real-time synchronization logs. The alert contains information about the situation that the message is ignored because of an execution error.'."\n" + .'* IGNORE: discards the message and does not send it to the destination.'."\n" + .'* CRITICAL: terminates the real-time synchronization node and sets the node status to Failed.'."\n" + .'* NORMAL: sends the message to the destination to process the message. Each destination processes DDL messages based on its own business logic. If DataWorks adopts the NORMAL policy, DataWorks only forwards DDL messages.'."\n", 'type' => 'string', 'example' => '{"RENAMECOLUMN":"WARNING","DROPTABLE":"WARNING","CREATETABLE":"WARNING","MODIFYCOLUMN":"WARNING","TRUNCATETABLE":"WARNING","DROPCOLUMN":"WARNING","ADDCOLUMN":"WARNING","RENAMETABLE":"WARNING"}'], ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + 400 => [ + ['errorCode' => 'Invalid.DI.Parameter', 'errorMessage' => 'The parameter is invalid.', 'description' => ''], ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + 403 => [ + ['errorCode' => 'Forbidden.DI.NoPrivilege', 'errorMessage' => 'No access.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], + ['errorCode' => 'InternalError.DI.Parameter', 'errorMessage' => 'A DI internal error occurred.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Data\\": {\\n \\"Timeout\\": 10000,\\n \\"Status\\": 0,\\n \\"ApiId\\": 10000,\\n \\"ApiMode\\": 0,\\n \\"ProjectId\\": 10001,\\n \\"ResponseContentType\\": 0,\\n \\"CreatorId\\": \\"1234567\\",\\n \\"VisibleRange\\": 0,\\n \\"ModifiedTime\\": \\"2020-06-23T00:21:01+0800\\",\\n \\"OperatorId\\": \\"2345678\\",\\n \\"GroupId\\": \\"ab123****\\",\\n \\"Description\\": \\"测试API描述\\",\\n \\"FolderId\\": 0,\\n \\"RequestMethod\\": 0,\\n \\"CreatedTime\\": \\"2020-06-23T00:21:01+0800\\",\\n \\"ApiName\\": \\"测试API名称\\",\\n \\"TenantId\\": 10002,\\n \\"ApiPath\\": \\"/test/1\\",\\n \\"Protocols\\": [\\n 0\\n ],\\n \\"RegistrationDetails\\": {\\n \\"ServiceHost\\": \\"http://example.aliyundoc.com\\",\\n \\"ServiceContentType\\": 0,\\n \\"ServicePath\\": \\"/index\\",\\n \\"SuccessfulResultSample\\": \\"{\\\\\\"success\\\\\\": true}\\",\\n \\"FailedResultSample\\": \\"{\\\\\\"success\\\\\\": false}\\",\\n \\"ServiceRequestBodyDescription\\": \\"{\\\\\\"abc\\\\\\":1}\\",\\n \\"RegistrationErrorCodes\\": [\\n {\\n \\"ErrorMessage\\": \\"fail to call\\",\\n \\"ErrorCode\\": \\"1001\\",\\n \\"ErrorSolution\\": \\"retry\\"\\n }\\n ],\\n \\"RegistrationRequestParameters\\": [\\n {\\n \\"ColumnName\\": \\"column1\\",\\n \\"ParameterName\\": \\"name1\\",\\n \\"ParameterPosition\\": 0,\\n \\"ParameterDescription\\": \\"description1\\",\\n \\"DefaultValue\\": \\"default1\\",\\n \\"ParameterOperator\\": 0,\\n \\"ParameterDataType\\": 0,\\n \\"ExampleValue\\": \\"example1\\",\\n \\"IsRequiredParameter\\": true\\n }\\n ]\\n },\\n \\"ScriptDetails\\": {\\n \\"Script\\": \\"select a from t\\",\\n \\"IsPagedResponse\\": true,\\n \\"ScriptRequestParameters\\": [\\n {\\n \\"ColumnName\\": \\"column1\\",\\n \\"ParameterName\\": \\"param1\\",\\n \\"ParameterPosition\\": 0,\\n \\"ParameterDescription\\": \\"description1\\",\\n \\"DefaultValue\\": \\"default1\\",\\n \\"ParameterOperator\\": 0,\\n \\"ParameterDataType\\": 0,\\n \\"ExampleValue\\": \\"example1\\",\\n \\"IsRequiredParameter\\": true\\n }\\n ],\\n \\"ScriptResponseParameters\\": [\\n {\\n \\"ParameterDescription\\": \\"description2\\",\\n \\"ColumnName\\": \\"column2\\",\\n \\"ParameterName\\": \\"param2\\",\\n \\"ParameterDataType\\": 0,\\n \\"ExampleValue\\": \\"example2\\"\\n }\\n ],\\n \\"ScriptConnection\\": {\\n \\"TableName\\": \\"t\\",\\n \\"ConnectionId\\": 123\\n }\\n },\\n \\"WizardDetails\\": {\\n \\"IsPagedResponse\\": true,\\n \\"WizardRequestParameters\\": [\\n {\\n \\"ColumnName\\": \\"column1\\",\\n \\"ParameterName\\": \\"param1\\",\\n \\"ParameterPosition\\": 0,\\n \\"ParameterDescription\\": \\"description1\\",\\n \\"DefaultValue\\": \\"default1\\",\\n \\"ParameterOperator\\": 0,\\n \\"ParameterDataType\\": 0,\\n \\"ExampleValue\\": \\"example1\\",\\n \\"IsRequiredParameter\\": true\\n }\\n ],\\n \\"WizardResponseParameters\\": [\\n {\\n \\"ParameterDescription\\": \\"description2\\",\\n \\"ColumnName\\": \\"column2\\",\\n \\"ParameterName\\": \\"param2\\",\\n \\"ParameterDataType\\": 0,\\n \\"ExampleValue\\": \\"example2\\"\\n }\\n ],\\n \\"WizardConnection\\": {\\n \\"TableName\\": \\"t\\",\\n \\"ConnectionId\\": 123\\n }\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 0000-ABCD-EFG****\\n The specified parameters are invalid.\\n true\\n 1031203110005\\n \\n 10000\\n 0\\n 10000\\n 0\\n 10001\\n 0\\n 1234567\\n 0\\n 2020-06-23T00:21:01+0800\\n 2345678\\n ab123****\\n 测试API描述\\n 0\\n 0\\n 2020-06-23T00:21:01+0800\\n 测试API名称\\n 10002\\n /test/1\\n 0\\n \\n http://example.aliyundoc.com\\n 0\\n /index\\n {\\"success\\": true}\\n {\\"success\\": false}\\n {\\"abc\\":1}\\n \\n fail to call\\n 1001\\n retry\\n \\n \\n column1\\n name1\\n 0\\n description1\\n default1\\n 0\\n 0\\n example1\\n true\\n \\n \\n \\n \\n true\\n \\n column1\\n param1\\n 0\\n description1\\n default1\\n 0\\n 0\\n example1\\n true\\n \\n \\n description2\\n column2\\n param2\\n 0\\n example2\\n \\n \\n t\\n 123\\n \\n \\n \\n true\\n \\n column1\\n param1\\n 0\\n description1\\n default1\\n 0\\n 0\\n example1\\n true\\n \\n \\n description2\\n column2\\n param2\\n 0\\n example2\\n \\n \\n t\\n 123\\n \\n \\n \\n","errorExample":""}]', - 'title' => 'GetDataServiceApi', - 'summary' => 'Queries the details of a DataService Studio API in the development state.', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0000-ABCD-EFG\\\\t\\",\\n \\"Data\\": {\\n \\"Config\\": \\"{\\\\\\"RENAMECOLUMN\\\\\\":\\\\\\"WARNING\\\\\\",\\\\\\"DROPTABLE\\\\\\":\\\\\\"WARNING\\\\\\",\\\\\\"CREATETABLE\\\\\\":\\\\\\"WARNING\\\\\\",\\\\\\"MODIFYCOLUMN\\\\\\":\\\\\\"WARNING\\\\\\",\\\\\\"TRUNCATETABLE\\\\\\":\\\\\\"WARNING\\\\\\",\\\\\\"DROPCOLUMN\\\\\\":\\\\\\"WARNING\\\\\\",\\\\\\"ADDCOLUMN\\\\\\":\\\\\\"WARNING\\\\\\",\\\\\\"RENAMETABLE\\\\\\":\\\\\\"WARNING\\\\\\"}\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"0000-ABCD-EFG\\t\\n\\n {\\"RENAMECOLUMN\\":\\"WARNING\\",\\"DROPTABLE\\":\\"WARNING\\",\\"CREATETABLE\\":\\"WARNING\\",\\"MODIFYCOLUMN\\":\\"WARNING\\",\\"TRUNCATETABLE\\":\\"WARNING\\",\\"DROPCOLUMN\\":\\"WARNING\\",\\"ADDCOLUMN\\":\\"WARNING\\",\\"RENAMETABLE\\":\\"WARNING\\"}\\n\\ntrue","errorExample":""}]', + 'title' => 'ListDIProjectConfig', + 'summary' => 'Queries the default global configurations of synchronization solutions in a specified DataWorks workspace.', + 'description' => 'DataWorks allows you to specify a default global configuration only for the processing rules of DDL messages in synchronization solutions. After you configure the **processing rules of DDL messages** in synchronization solutions, the configuration is used as the default global configuration and applies to all real-time synchronization tasks in the solutions. You can modify the **processing rules of DDL messages** based on your business requirements. For more information about how to configure a synchronization solution, see [Synchronization solutions](~~199008~~).'."\n", 'requestParamsDescription' => ' ', - 'responseParamsDescription' => 'The details about the APIs of different types are returned in different parameters. The details about the API generated in wizard mode are returned in the WizardDetails parameter. The details about the API generated in script mode are returned in the ScriptDetails parameter. The details about the API generated by registration are returned in the RegistrationDetails parameter.'."\n", + 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateDataServiceApi' => [ - 'methods' => [ - 'post', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListDags' => [ + 'summary' => 'Retrieves a list of directed acyclic graphs (DAGs) for a data backfill instance by operation sequence number (OpSeq).', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '78368', - 'abilityTreeNodes' => [ - 'FEATUREdideZZ63WZ', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '99773', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB'], ], 'parameters' => [ [ - 'name' => 'TenantId', + 'name' => 'OpSeq', 'in' => 'formData', - 'schema' => [ - 'description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the username for the logon in the upper-right corner and click User Info in the Menu section.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '10001', - ], + 'schema' => ['description' => 'The sequence number that uniquely identifies the data backfill operation. You can call the [GetDag](~~189753~~) operation to query the sequence number.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'minimum' => '2', 'example' => '123', 'title' => ''], ], [ - 'name' => 'ProjectId', + 'name' => 'ProjectEnv', 'in' => 'formData', 'schema' => [ - 'description' => 'The ID of the workspace.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The environment of the workspace. Valid values: PROD and DEV. The value PROD indicates the production environment, and the value DEV indicates the development environment.', + 'type' => 'string', 'required' => true, - 'docRequired' => true, - 'example' => '10001', + 'enum' => ['PROD', 'DEV'], + 'example' => 'PROD', + 'title' => '', ], ], - [ - 'name' => 'ApiId', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The ID of the API.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '10000', + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. You can use the ID to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => '7782a299-b291-4fee-8424-cf8058efa8e8', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The connection does not exist.', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The details of DAGs.', + 'type' => 'object', + 'properties' => [ + 'Dags' => [ + 'description' => 'The entities returned.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The type of the DAG. Valid values:'."\n" + ."\n" + .'- MANUAL: DAG for a manually triggered workflow'."\n" + ."\n" + .'- SMOKE\\_TEST: DAG for a smoke testing workflow'."\n" + ."\n" + .'- SUPPLY\\_DATA: DAG for a data backfill instance'."\n" + ."\n" + .'- BUSINESS\\_PROCESS\\_DAG: DAG for a one-time workflow', 'type' => 'string', 'example' => 'MANUAL_FLOW', 'title' => ''], + 'Status' => ['description' => 'The status of the DAG. Valid values:'."\n" + ."\n" + .'- CREATED'."\n" + ."\n" + .'- RUNNING'."\n" + ."\n" + .'- FAILURE'."\n" + ."\n" + .'- SUCCESS', 'type' => 'string', 'example' => 'FAILURE', 'title' => ''], + 'FinishTime' => ['description' => 'The end time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1605052800000', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1605052800000', 'title' => ''], + 'ProjectId' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '112345', 'title' => ''], + 'DagId' => ['description' => 'The DAG ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '351249682', 'title' => ''], + 'Gmtdate' => ['description' => 'The actual running time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1605052800000', 'title' => ''], + 'StartTime' => ['description' => 'The start time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1605052800000', 'title' => ''], + 'CreateUser' => ['description' => 'The creator.', 'type' => 'string', 'example' => '1736629400048545', 'title' => ''], + 'Bizdate' => ['description' => 'The data timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1605052800000', 'title' => ''], + 'Name' => ['description' => 'The name of the DAG.', 'type' => 'string', 'example' => 'test_dag', 'title' => ''], + 'ModifyTime' => ['description' => 'The modification time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1605052800000', 'title' => ''], + 'OpSeq' => ['description' => 'The sequence number of the operation.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'RequestMethod', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The request method of the API. Valid values: 0, 1, 2, and 3. The value 0 indicates the GET method. The value 1 indicates the POST method. The value 2 indicates the PUT method. The value 3 indicates the DELETE method. APIs generated in wizard or script mode support the GET and POST methods. APIs generated by registration support the GET, POST, PUT, and DELETE methods.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '0', - ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"7782a299-b291-4fee-8424-cf8058efa8e8\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Dags\\": [\\n {\\n \\"Type\\": \\"MANUAL_FLOW\\",\\n \\"Status\\": \\"FAILURE\\",\\n \\"FinishTime\\": 1605052800000,\\n \\"CreateTime\\": 1605052800000,\\n \\"ProjectId\\": 112345,\\n \\"DagId\\": 351249682,\\n \\"Gmtdate\\": 1605052800000,\\n \\"StartTime\\": 1605052800000,\\n \\"CreateUser\\": \\"1736629400048545\\",\\n \\"Bizdate\\": 1605052800000,\\n \\"Name\\": \\"test_dag\\",\\n \\"ModifyTime\\": 1605052800000,\\n \\"OpSeq\\": 123\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListDags', + 'description' => 'Supported DAG types:'."\n" + ."\n" + .'- MANUAL: DAG for a manually triggered workflow'."\n" + ."\n" + .'- SMOKE\\_TEST: DAG for a smoke testing workflow'."\n" + ."\n" + .'- SUPPLY\\_DATA: DAG for a data backfill instance'."\n" + ."\n" + .'- BUSINESS\\_PROCESS\\_DAG: DAG for a one-time workflow'."\n" + ."\n" + .'Supported DAG states:'."\n" + ."\n" + .'- CREATED: The DAG is created.'."\n" + ."\n" + .'- RUNNING: The DAG is running.'."\n" + ."\n" + .'- FAILURE: The DAG fails to run.'."\n" + ."\n" + .'- SUCCESS: The DAG is successfully run.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDags'], ], + ], + 'ramActions' => [], + ], + 'ListDataServiceApiAuthorities' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ResponseContentType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The format in which the response of the API request is returned. Valid values: 0 and 1. The value 0 indicates the JSON format. The value 1 indicates the XML format. APIs generated in wizard or script mode support the JSON format. APIs generated by registration support the JSON and XML formats.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '0', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '78300', + 'abilityTreeNodes' => ['FEATUREdide7T0EJX'], + ], + 'parameters' => [ [ - 'name' => 'Timeout', + 'name' => 'ProjectId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The timeout period of the API request. Unit: milliseconds. Valid values: (0,30000].'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10000', - ], + 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10000', 'title' => ''], ], [ - 'name' => 'VisibleRange', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The scope in which the API is visible. Valid values: 0 and 1. The value 0 indicates that the API is visible within the workspace. The value 1 indicates that the API is visible only to its owner.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '0', - ], + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''], ], [ - 'name' => 'Protocols', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The protocol used by the API. Valid values: 0 and 1. The value 0 indicates HTTP. The value 1 indicates HTTPS. You can specify multiple protocols. Separate multiple protocols with commas (,).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '0,1', - ], + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '50', 'minimum' => '1', 'default' => '10', 'example' => '10', 'title' => ''], ], [ - 'name' => 'WizardDetails', + 'name' => 'TenantId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The details of the API generated in wizard mode. For more information, see the WizardDetails parameter returned by the [GetDataServiceApi](~~174013~~) operation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"isPagedResponse":true,"wizardConnection":{"connectionId":122786,"tableName":"person"},"wizardRequestParameters":[{"columnName":"id","defaultValue":"","exampleValue":"1","isRequiredParameter":true,"parameterDataType":2,"parameterDescription":"","parameterName":"id","parameterOperator":0,"parameterPosition":0}],"wizardResponseParameters":[{"columnName":"id","exampleValue":"11","parameterDataType":2,"parameterDescription":"","parameterName":"id"}]}', - ], + 'schema' => ['description' => 'The tenant ID. This parameter is deprecated.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10001', 'title' => ''], ], [ - 'name' => 'ScriptDetails', + 'name' => 'ApiNameKeyword', 'in' => 'formData', - 'schema' => [ - 'description' => 'The details of the API generated in script mode. For more information, see the ScriptDetails parameter returned by the [GetDataServiceApi](~~174013~~) operation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"isPagedResponse":false,"script":"select id as id1, name as name1 from person where id=${inputid}","scriptConnection":{"connectionId":122786,"tableName":"person"},"scriptRequestParameters":[{"defaultValue":"","exampleValue":"","isRequiredParameter":true,"parameterDataType":0,"parameterDescription":"","parameterName":"inputid","parameterOperator":0,"parameterPosition":1}],"scriptResponseParameters":[{"exampleValue":"","parameterDataType":0,"parameterDescription":"","parameterName":"id1"},{"exampleValue":"","parameterDataType":0,"parameterDescription":"","parameterName":"name1"}]}', - ], + 'schema' => ['description' => 'The keyword in the name of the API. The keyword can be used to search for the API whose name contains the keyword.', 'type' => 'string', 'example' => 'My API name', 'required' => false, 'title' => ''], ], - [ - 'name' => 'RegistrationDetails', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The details of the API generated by registration. For more information, see the RegistrationDetails parameter returned by the [GetDataServiceApi](~~174013~~) operation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"failedResultSample":"fail","registrationErrorCodes":[{"errorCode":"e1","errorMessage":"msg1","errorSolution":"sol1"},{"errorCode":"e2","errorMessage":"msg2","errorSolution":"sol2"}],"registrationRequestParameters":[{"columnName":"","defaultValue":"","exampleValue":"","isRequiredParameter":true,"parameterDataType":0,"parameterDescription":"","parameterName":"id","parameterOperator":0,"parameterPosition":1},{"columnName":"","defaultValue":"xx","exampleValue":"","isRequiredParameter":true,"parameterDataType":0,"parameterDescription":"","parameterName":"cc","parameterOperator":2,"parameterPosition":2}],"serviceContentType":1,"serviceHost":"http://www.baidu.com","servicePath":"/[uid]","serviceRequestBodyDescription":"body","successfulResultSample":"success"}', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0000-ABCD-EFG****', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Normal', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'Boolean', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'Data' => [ + 'description' => 'The APIs on which other users are granted the access permissions.', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => 'The page number. The value of this parameter is the same as that of the PageNumber parameter in the request.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'ApiAuthorizationList' => [ + 'description' => 'The APIs on which other users are granted the access permissions.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ApiStatus' => ['description' => 'The status of the API. Valid values: 0 and 1. The value 0 indicates that the API is not published. The value 1 indicates that the API is published.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ApiId' => ['description' => 'The API ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10002', 'title' => ''], + 'ModifiedTime' => ['description' => 'The time when the API was last modified.', 'type' => 'string', 'example' => '2020-06-23T00:21:01+0800', 'title' => ''], + 'GroupId' => ['description' => 'The group ID.', 'type' => 'string', 'example' => 'ab123', 'title' => ''], + 'ProjectId' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'title' => ''], + 'CreatorId' => ['description' => 'The ID of the Alibaba Cloud account used by the API owner.', 'type' => 'string', 'example' => '12345', 'title' => ''], + 'CreatedTime' => ['description' => 'The time when the API was created.', 'type' => 'string', 'example' => '2020-06-23T00:21:01+0800', 'title' => ''], + 'ApiName' => ['description' => 'The name of the API.', 'type' => 'string', 'example' => 'My API name', 'title' => ''], + 'TenantId' => ['description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10001', 'title' => ''], + 'ApiPath' => ['description' => 'The path of the API.', 'type' => 'string', 'example' => '/test/1', 'title' => ''], + 'AuthorizationRecords' => [ + 'description' => 'The authorization records.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'EndTime' => ['description' => 'The end time of the validity period of the authorization.', 'type' => 'string', 'example' => '2020-06-24T00:21:01+0800', 'title' => ''], + 'CreatorId' => ['description' => 'The ID of the Alibaba Cloud account used by the API owner.', 'type' => 'string', 'example' => '12345', 'title' => ''], + 'CreatedTime' => ['description' => 'The time when the access permissions on the API were granted to other users.', 'type' => 'string', 'example' => '2020-06-23T00:21:01+0800', 'title' => ''], + 'ProjectId' => ['description' => 'The ID of the workspace to which the access permissions on the API are granted.', 'type' => 'integer', 'format' => 'int64', 'example' => '10004', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"Normal\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"0\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"ApiAuthorizationList\\": [\\n {\\n \\"ApiStatus\\": 0,\\n \\"ApiId\\": 10002,\\n \\"ModifiedTime\\": \\"2020-06-23T00:21:01+0800\\",\\n \\"GroupId\\": \\"ab123\\",\\n \\"ProjectId\\": 10000,\\n \\"CreatorId\\": \\"12345\\",\\n \\"CreatedTime\\": \\"2020-06-23T00:21:01+0800\\",\\n \\"ApiName\\": \\"My API name\\",\\n \\"TenantId\\": 10001,\\n \\"ApiPath\\": \\"/test/1\\",\\n \\"AuthorizationRecords\\": [\\n {\\n \\"EndTime\\": \\"2020-06-24T00:21:01+0800\\",\\n \\"CreatorId\\": \\"12345\\",\\n \\"CreatedTime\\": \\"2020-06-23T00:21:01+0800\\",\\n \\"ProjectId\\": 10004\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListDataServiceApiAuthorities', + 'summary' => 'Retrieves a list of APIs on which other users are granted access permissions.', + 'changeSet' => [ + ['createdAt' => '2023-10-09T11:17:29.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'translator' => 'manual', + ], + 'ListDataServiceApiTest' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ApiPath', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The path of the API.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '/test/2', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'ApiDescription', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The description of the API.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'API description'."\n", - ], + 'name' => 'ApiId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the DataService Studio API on which tests are performed.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '12345'], ], [ - 'name' => 'ResourceGroupId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the exclusive resource group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '3242432423', - ], + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page. Maximum value: 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ + 'description' => 'The returned result.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'ESDAFWEA'], 'Data' => [ - 'description' => 'Indicates whether the information about the API was updated.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'description' => 'The list of test records.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The test record.'."\n", + 'type' => 'object', + 'properties' => [ + 'TestId' => ['description' => 'The ID of the test.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'ApiId' => ['description' => 'The ID of the DataService Studio API on which the test is performed.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2343'], + 'ParamMap' => ['description' => 'The request parameters configured for the test.'."\n", 'type' => 'string', 'example' => '{"name":"test"}'], + 'RetCode' => ['description' => 'The status code returned for the test. If the test is not complete, this parameter is not returned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'RetResult' => ['description' => 'The result returned for the test.'."\n", 'type' => 'string', 'example' => '{"id":2}'], + 'CostTime' => ['description' => 'The time that is consumed to complete the test.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'Status' => ['description' => 'The status of the test. Valid values: RUNNING and FINISHED.'."\n", 'type' => 'string', 'example' => 'FINISHED'], + 'CreateTime' => ['description' => 'The time when the test was initiated.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1651824913000'], + ], + ], ], ], - 'description' => '', ], ], ], 'errorCodes' => [ 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], ], 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n true\\n The connection does not exist.\\n 0000-ABCD-EFG****\\n Invalid.Tenant.ConnectionNotExists\\n true\\n","errorExample":""}]', - 'title' => 'UpdateDataServiceApi', - 'summary' => 'Updates the information about an API in the development state in DataService Studio.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'GetDataServicePublishedApi' => [ - 'summary' => 'Queries the information about a DataService Studio API in the published state.', - 'methods' => [ - 'post', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ESDAFWEA\\",\\n \\"Data\\": [\\n {\\n \\"TestId\\": 123,\\n \\"ApiId\\": 2343,\\n \\"ParamMap\\": \\"{\\\\\\"name\\\\\\":\\\\\\"test\\\\\\"}\\",\\n \\"RetCode\\": 0,\\n \\"RetResult\\": \\"{\\\\\\"id\\\\\\":2}\\",\\n \\"CostTime\\": 10,\\n \\"Status\\": \\"FINISHED\\",\\n \\"CreateTime\\": 1651824913000\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n ESDAFWEA\\n \\n 123\\n 2343\\n {\\"name\\":\\"test\\"}\\n 0\\n {\\"id\\":2}\\n 10\\n FINISHED\\n 1651824913000\\n \\n","errorExample":""}]', + 'title' => 'ListDataServiceApiTest', + 'summary' => 'Queries the test records of a DataService Studio API. This API operation allows you to query only the test records that are generated within the previous month.', + 'changeSet' => [ + ['createdAt' => '2022-05-30T02:35:45.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'ListDataServiceApis' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -46017,749 +24950,872 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '78239', - 'abilityTreeNodes' => [ - 'FEATUREdide7T0EJX', - ], + 'abilityTreeCode' => '78301', + 'abilityTreeNodes' => ['FEATUREdide7T0EJX'], ], 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => ['description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'minimum' => '1', 'example' => '1', 'default' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '50', 'minimum' => '1', 'example' => '10', 'default' => '10', 'title' => ''], + ], [ 'name' => 'ProjectId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the workspace.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '10002', - ], + 'schema' => ['description' => 'The workspace ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10000', 'title' => ''], ], [ 'name' => 'TenantId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '10003', - ], + 'schema' => ['description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10001', 'title' => ''], ], [ - 'name' => 'ApiId', + 'name' => 'ApiNameKeyword', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the API.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '10001', - ], + 'schema' => ['description' => 'The keyword in API names. The keyword is used to search for the APIs whose names contain the keyword.'."\n", 'type' => 'string', 'required' => false, 'example' => 'My API name', 'title' => ''], + ], + [ + 'name' => 'ApiPathKeyword', + 'in' => 'formData', + 'schema' => ['description' => 'The keyword in API paths. The keyword is used to search for the APIs whose paths contain the keyword.'."\n", 'type' => 'string', 'required' => false, 'example' => '/test/', 'title' => ''], + ], + [ + 'name' => 'CreatorId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the Alibaba Cloud account used by the creator of the APIs. The ID is used to search for the APIs created by the creator.'."\n", 'type' => 'string', 'required' => false, 'example' => '123456', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'ErrorMessage' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code returned.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Data' => [ - 'description' => 'Information about published APIs.'."\n", - 'type' => 'object', - 'properties' => [ - 'Timeout' => [ - 'description' => 'The timeout period of the API request. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10000', - ], - 'Status' => [ - 'description' => 'The status of the API. Valid values: 0 and 1. The value 0 indicates that the API is not published. The value 1 indicates that the API is published.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ApiId' => [ - 'description' => 'The ID of the DataService Studio API.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000', - ], - 'ApiMode' => [ - 'description' => 'The type of the API. Valid values: 0, 1, and 2. The value 0 indicates that the API is generated in wizard mode. The value 1 indicates that the API is generated in script mode. The value 2 indicates that the API is generated by registration.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ProjectId' => [ - 'description' => 'The ID of the workspace.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10001', - ], - 'ResponseContentType' => [ - 'description' => 'The format in which the response of the API request is returned. Valid values: 0 and 1. The value 0 indicates the JSON format. The value 1 indicates the XML format. APIs generated in wizard or script mode support the JSON format. APIs generated by registration support the JSON and XML formats.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'CreatorId' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the creator of the API.'."\n", - 'type' => 'string', - 'example' => '1234567', - ], - 'VisibleRange' => [ - 'description' => 'The scope in which the API is visible. Valid values: 0 and 1. The value 0 indicates that the API is visible to the members in a specific workspace. The value 1 indicates that the API is visible only to the API creator.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ModifiedTime' => [ - 'description' => 'The time when the API was last modified.'."\n", - 'type' => 'string', - 'example' => '2020-06-23T00:21:01+0800', - ], - 'OperatorId' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the user who last modified the API.'."\n", - 'type' => 'string', - 'example' => '2345678', - ], - 'GroupId' => [ - 'description' => 'The ID of the group.'."\n", - 'type' => 'string', - 'example' => 'ab12**', - ], - 'Description' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'Description of the test API'."\n", - ], - 'RequestMethod' => [ - 'description' => 'The request method of the API. Valid values: 0, 1, 2, and 3. The value 0 indicates the GET method, the value 1 indicates the POST method, the value 2 indicates the PUT method, and the value 3 indicates the DELETE method. APIs generated in wizard or script mode support the GET and POST methods. APIs generated by registration support the GET, POST, PUT, and DELETE methods.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'CreatedTime' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'string', - 'example' => '2020-06-23T00:21:01+0800', - ], - 'ApiName' => [ - 'description' => 'The name of the API.'."\n", - 'type' => 'string', - 'example' => 'Name of the test API'."\n", - ], - 'TenantId' => [ - 'description' => 'The ID of the tenant.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10001', - ], - 'ApiPath' => [ - 'description' => 'The path of the API.'."\n", - 'type' => 'string', - 'example' => '/test/1', - ], - 'Protocols' => [ - 'description' => 'The protocol used by the API. Valid values: 0 and 1. The value 0 indicates HTTP. The value 1 indicates HTTPS. Multiple protocols are presented in a list.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The protocol used by the API. Valid values: 0 and 1. The value 0 indicates that the API uses HTTP. The value 1 indicates that the API uses HTTPS. Two protocols are presented in a list.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - ], - 'RegistrationDetails' => [ - 'description' => 'Registered API details. Only returned for registered APIs.'."\n", - 'type' => 'object', - 'properties' => [ - 'ServiceHost' => [ - 'description' => 'The URL of the backend service.'."\n", - 'type' => 'string', - 'example' => 'http://example.aliyundoc.com', - ], - 'ServiceContentType' => [ - 'description' => 'The format in which the response of the API request is returned. Valid values: 0 and 1. The value 0 indicates the JSON format. The value 1 indicates the XML format. APIs generated in wizard or script mode support the JSON format. APIs generated by registration support the JSON and XML formats.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ServicePath' => [ - 'description' => 'The path of the backend service.'."\n", - 'type' => 'string', - 'example' => '/index', - ], - 'SuccessfulResultSample' => [ - 'description' => 'The sample success response of the API.'."\n", - 'type' => 'string', - 'example' => '{"success": true}', - ], - 'FailedResultSample' => [ - 'description' => 'The sample error response of the API.'."\n", - 'type' => 'string', - 'example' => '{"success": false}', - ], - 'ServiceRequestBodyDescription' => [ - 'description' => 'The description of the request body initiated to call the backend service.'."\n", - 'type' => 'string', - 'example' => '{"abc":1}', - ], - 'RegistrationErrorCodes' => [ - 'title' => '', - 'description' => 'The list of error codes for the registered API.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ErrorMessage' => [ - 'title' => '', - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'ErrorCode' => [ - 'title' => '', - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'ErrorSolution' => [ - 'title' => '', - 'description' => 'The solution.'."\n", - 'type' => 'string', - 'example' => 'retry', - ], - ], - 'description' => '', - ], - ], - 'RegistrationRequestParameters' => [ - 'title' => '', - 'description' => 'The list of request parameters for the registered API.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ParameterName' => [ - 'description' => 'The name of the parameter.'."\n", - 'type' => 'string', - 'example' => 'name1', - ], - 'ParameterPosition' => [ - 'description' => 'The position of the parameter. Valid values: 0, 1, 2, and 3. The value 0 indicates that the parameter is in the URL path of the request. The value 1 indicates that the parameter is in the Query parameter of the request URL. The value 2 indicates that the parameter is in the request header. The value 3 indicates that the parameter is in the request body. APIs generated in wizard or script mode support only the Query position. APIs generated by registration whose request method is GET or DELETE support the Query and Head positions. APIs generated by registration whose request method is PUT or POST support the Query, Head, and Body positions.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ParameterDescription' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'description1', - ], - 'DefaultValue' => [ - 'description' => 'The default value.'."\n", - 'type' => 'string', - 'example' => 'default1', - ], - 'ParameterOperator' => [ - 'description' => 'The operator used for the value of the parameter. Valid values: 0, 1, 2, and 3. The value 0 indicates the Equal operator. The value 1 indicates the Like operator. The value 2 indicates the Const operator. The value 3 indicates the In operator. APIs generated in wizard mode support the Equal, Like, and In operators. APIs generated in script mode support the Equal operator. APIs generated by registration support the Equal and Const operators.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ExampleValue' => [ - 'description' => 'The sample value.'."\n", - 'type' => 'string', - 'example' => 'example1', - ], - 'ParameterDataType' => [ - 'description' => 'The data type of the parameter. Valid values:'."\n" - ."\n" - .'* 0: String'."\n" - .'* 1: Int'."\n" - .'* 2: Long'."\n" - .'* 3: Float'."\n" - .'* 4: Double'."\n" - .'* 5: Boolean'."\n" - .'* 6: StringList'."\n" - .'* 7: IntList'."\n" - .'* 8: LongList'."\n" - .'* 9: FloatList'."\n" - .'* 10: DoubleList'."\n" - .'* 11: BooleanList'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'IsRequiredParameter' => [ - 'description' => 'Indicates whether the parameter is required.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - 'description' => 'The returned result.'."\n", - ], - ], - ], - ], - 'ScriptDetails' => [ - 'description' => 'The details of the API generated in script mode. This parameter is returned only if the API is generated in script mode.'."\n", - 'type' => 'object', - 'properties' => [ - 'IsPagedResponse' => [ - 'description' => 'Indicates whether the entries were returned by page.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'SuccessfulResultSample' => [ - 'description' => 'The sample success response of the API.'."\n", - 'type' => 'string', - 'example' => '{"success": true}', - ], - 'FailedResultSample' => [ - 'description' => 'The sample error response of the API.'."\n", - 'type' => 'string', - 'example' => '{"success": false}', - ], - 'Script' => [ - 'description' => 'The SQL script.'."\n", - 'type' => 'string', - 'example' => 'select a from t', - ], - 'ScriptErrorCodes' => [ - 'description' => 'The error codes returned for the API generated in script mode.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'fail to call', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '1001', - ], - 'ErrorSolution' => [ - 'description' => 'The solution used to fix the error.'."\n", - 'type' => 'string', - 'example' => 'retry', - ], - ], - 'description' => 'The returned result.'."\n", - ], - ], - 'ScriptRequestParameters' => [ - 'description' => 'The request parameters of the API generated in script mode.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ParameterName' => [ - 'description' => 'The name of the parameter.'."\n", - 'type' => 'string', - 'example' => 'param1', - ], - 'ParameterPosition' => [ - 'description' => 'The position of the parameter. Valid values:'."\n" - ."\n" - .'* 0: indicates that the parameter is in the URL path of the request.'."\n" - .'* 1: indicates that the parameter is in the Query parameter of the request URL.'."\n" - .'* 2: indicates that the parameter is in the request header.'."\n" - .'* 3: indicates that the parameter is in the request body.'."\n" - ."\n" - .'APIs generated in wizard or script mode support only the Query position. APIs generated by registration whose request method is GET or DELETE support the Query and Head positions. APIs generated by registration whose request method is PUT or POST support the Query, Head, and Body positions.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ParameterDescription' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'description1', - ], - 'DefaultValue' => [ - 'description' => 'The default value.'."\n", - 'type' => 'string', - 'example' => 'default1', - ], - 'ParameterOperator' => [ - 'description' => 'The operator used for the value of the parameter. Valid values:'."\n" - ."\n" - .'* 0: Equal'."\n" - .'* 1: Like'."\n" - .'* 2: Const'."\n" - .'* 3: In'."\n" - ."\n" - .'APIs generated in wizard mode support the Equal, Like, and In operators. APIs generated in script mode support the Equal operator. APIs generated by registration support the Equal and Const operators.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ExampleValue' => [ - 'description' => 'The sample value.'."\n", - 'type' => 'string', - 'example' => 'example1', - ], - 'ParameterDataType' => [ - 'description' => 'The data type of the parameter. Valid values:'."\n" - ."\n" - .'* 0: String'."\n" - .'* 1: Int'."\n" - .'* 2: Long'."\n" - .'* 3: Float'."\n" - .'* 4: Double'."\n" - .'* 5: Boolean'."\n" - .'* 6: StringList'."\n" - .'* 7: IntList'."\n" - .'* 8: LongList'."\n" - .'* 9: FloatList'."\n" - .'* 10: DoubleList'."\n" - .'* 11: BooleanList'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'IsRequiredParameter' => [ - 'description' => 'Indicates whether the parameter is required.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - 'description' => 'The returned result.'."\n", - ], - ], - 'ScriptResponseParameters' => [ - 'description' => 'The response parameters of the API generated in script mode.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ParameterDescription' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'description2', - ], - 'ParameterName' => [ - 'description' => 'The name of the parameter.'."\n", - 'type' => 'string', - 'example' => 'param2', - ], - 'ExampleValue' => [ - 'description' => 'The sample value.'."\n", - 'type' => 'string', - 'example' => 'example2', - ], - 'ParameterDataType' => [ - 'description' => 'The data type of the parameter. Valid values:'."\n" - ."\n" - .'* 0: String'."\n" - .'* 1: Int'."\n" - .'* 2: Long'."\n" - .'* 3: Float'."\n" - .'* 4: Double'."\n" - .'* 5: Boolean'."\n" - .'* 6: StringList'."\n" - .'* 7: IntList'."\n" - .'* 8: LongList'."\n" - .'* 9: FloatList'."\n" - .'* 10: DoubleList'."\n" - .'* 11: BooleanList'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - ], - 'description' => 'The returned result.'."\n", - ], - ], - 'ScriptConnection' => [ - 'description' => 'The data source information of the API generated in script mode.'."\n", - 'type' => 'object', - 'properties' => [ - 'TableName' => [ - 'description' => 'The name of the table in the data source.'."\n", - 'type' => 'string', - 'example' => 't', - ], - 'ConnectionId' => [ - 'description' => 'The ID of the data source.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0000-ABCD-EFG****', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The connection does not exist.', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => 'The page number. The value of this parameter is the same as that of the PageNumber parameter in the request.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page. Valid values: 1 to 50. Default value: 10.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'Apis' => [ + 'description' => 'The list of APIs in the development state.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'Timeout' => ['description' => 'The timeout period of the API request. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10000', 'title' => ''], + 'Status' => ['description' => 'The status of the API. Valid values: 0 and 1. The value 0 indicates that the API is not published. The value 1 indicates that the API is published.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ApiId' => ['description' => 'The API ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10002', 'title' => ''], + 'ApiMode' => ['description' => 'The type of the API. Valid values: 0, 1, and 2. The value 0 indicates that the API is generated in wizard mode. The value 1 indicates that the API is generated in script mode. The value 2 indicates that the API is generated by registration.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ProjectId' => ['description' => 'The workspace ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'title' => ''], + 'ResponseContentType' => ['description' => 'The format in which the response of the API request is returned. Valid values: 0 and 1. The value 0 indicates the JSON format. The value 1 indicates the XML format. APIs generated in wizard or script mode support the JSON format. APIs generated by registration support the JSON and XML formats.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'CreatorId' => ['description' => 'The ID of the Alibaba Cloud account used by the creator of the API.'."\n", 'type' => 'string', 'example' => '1234567', 'title' => ''], + 'VisibleRange' => ['description' => 'The scope in which the API is visible. Valid values: 0 and 1. The value 0 indicates that the API is visible within the workspace. The value 1 indicates that the API is visible only to its owner.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ModifiedTime' => ['description' => 'The time when the API was last modified.'."\n", 'type' => 'string', 'example' => '2020-06-23T00:21:01+0800', 'title' => ''], + 'OperatorId' => ['description' => 'The ID of the Alibaba Cloud account used by the user who last modified the API.'."\n", 'type' => 'string', 'example' => '2345678', 'title' => ''], + 'GroupId' => ['description' => 'The group ID.'."\n", 'type' => 'string', 'example' => 'abcde123456789', 'title' => ''], + 'Description' => ['description' => 'The description of the API.'."\n", 'type' => 'string', 'example' => 'Test API description', 'title' => ''], + 'FolderId' => ['description' => 'The folder ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'RequestMethod' => ['description' => 'The request method of the API. Valid values: 0, 1, 2, and 3. The value 0 indicates the GET method. The value 1 indicates the POST method. The value 2 indicates the PUT method. The value 3 indicates the DELETE method. APIs generated in wizard or script mode support the GET and POST methods. APIs generated by registration support the GET, POST, PUT, and DELETE methods.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'CreatedTime' => ['description' => 'The time when the API was created.'."\n", 'type' => 'string', 'example' => '2020-06-23T00:21:01+0800', 'title' => ''], + 'ApiName' => ['description' => 'The name of the API.'."\n", 'type' => 'string', 'example' => 'My API name', 'title' => ''], + 'TenantId' => ['description' => 'The tenant ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'title' => ''], + 'ApiPath' => ['description' => 'The path of the API.'."\n", 'type' => 'string', 'example' => '/test/1', 'title' => ''], + 'Protocols' => [ + 'description' => 'The list of fields.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The protocol used by the API. Valid values: 0 and 1. The value 0 indicates HTTP. The value 1 indicates HTTPS. Multiple protocols are presented in a list.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'title' => '', + 'example' => '', ], - ], - ], - ], - 'WizardDetails' => [ - 'description' => 'The details of the API generated in wizard mode. This parameter is returned only if the API is generated in wizard mode.'."\n", - 'type' => 'object', - 'properties' => [ - 'IsPagedResponse' => [ - 'description' => 'Indicates whether the entries were returned by page.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'SuccessfulResultSample' => [ - 'description' => 'The sample success response of the API.'."\n", - 'type' => 'string', - 'example' => '{"success": true}', - ], - 'FailedResultSample' => [ - 'description' => 'The sample error response of the API.'."\n", - 'type' => 'string', - 'example' => '{"success": false}', - ], - 'WizardErrorCodes' => [ - 'description' => 'The error codes returned for the API generated in wizard mode.'."\n", - 'type' => 'array', - 'items' => [ + 'RegistrationDetails' => [ + 'description' => 'The details of the API generated by registration. This parameter is returned only if the API is generated by registration.'."\n", 'type' => 'object', 'properties' => [ - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'fail to call', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '1001', + 'ServiceHost' => ['description' => 'The URL of the backend service.'."\n", 'type' => 'string', 'example' => 'http://example.aliyundoc.com', 'title' => ''], + 'ServiceContentType' => ['description' => 'The format in which the response of the API request is returned. Valid values: 0 and 1. The value 0 indicates the JSON format. The value 1 indicates the XML format. APIs generated in wizard or script mode support the JSON format. APIs generated by registration support the JSON and XML formats.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ServicePath' => ['description' => 'The path of the backend service.'."\n", 'type' => 'string', 'example' => '/index', 'title' => ''], + 'SuccessfulResultSample' => ['description' => 'The sample success response of the API.'."\n", 'type' => 'string', 'example' => '{"success": true}', 'title' => ''], + 'FailedResultSample' => ['description' => 'The sample error response of the API.'."\n", 'type' => 'string', 'example' => '{"success": false}', 'title' => ''], + 'ServiceRequestBodyDescription' => ['description' => 'The description of the request body initiated to call the backend service.'."\n", 'type' => 'string', 'example' => '{"abc":1}', 'title' => ''], + 'RegistrationErrorCodes' => [ + 'description' => 'The error codes returned for the API generated by registration.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'fail to call', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '1001', 'title' => ''], + 'ErrorSolution' => ['description' => 'The solution used to fix the error.'."\n", 'type' => 'string', 'example' => 'retry', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'ErrorSolution' => [ - 'description' => 'The solution used to fix the error.'."\n", - 'type' => 'string', - 'example' => 'retry', + 'RegistrationRequestParameters' => [ + 'description' => 'The request parameters of the API generated by registration.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ColumnName' => ['description' => 'The name of the associated field. This parameter is supported only if the API is generated in wizard mode.'."\n", 'type' => 'string', 'example' => 'column1', 'title' => ''], + 'ParameterName' => ['description' => 'The name of the parameter.'."\n", 'type' => 'string', 'example' => 'name1', 'title' => ''], + 'ParameterPosition' => ['description' => 'The position of the parameter. Valid values: 0, 1, 2, and 3. The value 0 indicates that the parameter is in the URL path of the request. The value 1 indicates that the parameter is in the Query parameter of the request URL. The value 2 indicates that the parameter is in the request header. The value 3 indicates that the parameter is in the request body. APIs generated in wizard or script mode support only the Query position. APIs generated by registration whose request method is GET or DELETE support the Query and Head positions. APIs generated by registration whose request method is PUT or POST support the Query, Head, and Body positions.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ParameterDescription' => ['description' => 'The description.'."\n", 'type' => 'string', 'example' => 'description1', 'title' => ''], + 'DefaultValue' => ['description' => 'The default value.'."\n", 'type' => 'string', 'example' => 'default1', 'title' => ''], + 'ParameterOperator' => ['description' => 'The operator used for the value of the parameter. Valid values: 0, 1, 2, and 3. The value 0 indicates the Equal operator. The value 1 indicates the Like operator. The value 2 indicates the Const operator. The value 3 indicates the In operator. APIs generated in wizard mode support the Equal, Like, and In operators. APIs generated in script mode support the Equal operator. APIs generated by registration support the Equal and Const operators.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ParameterDataType' => ['description' => 'The data type of the parameter. Valid values:'."\n" + ."\n" + .'* 0: String'."\n" + .'* 1: Int'."\n" + .'* 2: Long'."\n" + .'* 3: Float'."\n" + .'* 4: Double'."\n" + .'* 5: Boolean'."\n" + .'* 6: StringList'."\n" + .'* 7: IntList'."\n" + .'* 8: LongList'."\n" + .'* 9: FloatList'."\n" + .'* 10: DoubleList'."\n" + .'* 11: BooleanList'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ExampleValue' => ['description' => 'The sample value.'."\n", 'type' => 'string', 'example' => 'example1', 'title' => ''], + 'IsRequiredParameter' => ['description' => 'Indicates whether the parameter is required.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], - 'description' => 'The returned result.'."\n", + 'title' => '', + 'example' => '', ], - ], - 'WizardRequestParameters' => [ - 'description' => 'The request parameters of the API generated in wizard mode.'."\n", - 'type' => 'array', - 'items' => [ + 'ScriptDetails' => [ + 'description' => 'The details of the API generated in script mode. This parameter is returned only if the API is generated in script mode.'."\n", 'type' => 'object', 'properties' => [ - 'ParameterName' => [ - 'description' => 'The name of the parameter.'."\n", - 'type' => 'string', - 'example' => 'param1', - ], - 'ParameterPosition' => [ - 'description' => 'The position of the parameter. Valid values: 0, 1, 2, and 3. The value 0 indicates that the parameter is in the URL path of the request. The value 1 indicates that the parameter is in the Query parameter of the request URL. The value 2 indicates that the parameter is in the request header. The value 3 indicates that the parameter is in the request body. APIs generated in wizard or script mode support only the Query position. APIs generated by registration whose request method is GET or DELETE support the Query and Head positions. APIs generated by registration whose request method is PUT or POST support the Query, Head, and Body positions.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ParameterDescription' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'description1', - ], - 'DefaultValue' => [ - 'description' => 'The default value.'."\n", - 'type' => 'string', - 'example' => 'default1', - ], - 'ParameterOperator' => [ - 'description' => 'The operator used for the value of the parameter. Valid values: 0, 1, 2, and 3. The value 0 indicates the Equal operator. The value 1 indicates the Like operator. The value 2 indicates the Const operator. The value 3 indicates the In operator. APIs generated in wizard mode support the Equal, Like, and In operators. APIs generated in script mode support the Equal operator. APIs generated by registration support the Equal and Const operators.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ExampleValue' => [ - 'description' => 'The sample value.'."\n", - 'type' => 'string', - 'example' => 'example1', + 'Script' => ['description' => 'The SQL script.'."\n", 'type' => 'string', 'example' => 'select a from t', 'title' => ''], + 'IsPagedResponse' => ['description' => 'Indicates whether the entries are returned by page.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ScriptRequestParameters' => [ + 'description' => 'The request parameters of the API generated in script mode.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ColumnName' => ['description' => 'The name of the associated field. This parameter is supported only if the API is generated in wizard mode.'."\n", 'type' => 'string', 'example' => 'column1', 'title' => ''], + 'ParameterName' => ['description' => 'The name of the parameter.'."\n", 'type' => 'string', 'example' => 'param1', 'title' => ''], + 'ParameterPosition' => ['description' => 'The position of the parameter. Valid values:'."\n" + ."\n" + .'* 0: indicates that the parameter is in the URL path of the request.'."\n" + .'* 1: indicates that the parameter is in the Query parameter of the request URL.'."\n" + .'* 2: indicates that the parameter is in the request header.'."\n" + .'* 3: indicates that the parameter is in the request body.'."\n" + ."\n" + .'APIs generated in wizard or script mode support only the Query position. APIs generated by registration whose request method is GET or DELETE support the Query and Head positions. APIs generated by registration whose request method is PUT or POST support the Query, Head, and Body positions.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ParameterDescription' => ['description' => 'The description.'."\n", 'type' => 'string', 'example' => 'description1', 'title' => ''], + 'DefaultValue' => ['description' => 'The default value.'."\n", 'type' => 'string', 'example' => 'default1', 'title' => ''], + 'ParameterOperator' => ['description' => 'The operator used for the value of the parameter. Valid values:'."\n" + ."\n" + .'* 0: Equal'."\n" + .'* 1: Like'."\n" + .'* 2: Const'."\n" + .'* 3: In'."\n" + ."\n" + .'APIs generated in wizard mode support the Equal, Like, and In operators. APIs generated in script mode support the Equal operator. APIs generated by registration support the Equal and Const operators.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ParameterDataType' => ['description' => 'The data type of the parameter. Valid values:'."\n" + ."\n" + .'* 0: String'."\n" + .'* 1: Int'."\n" + .'* 2: Long'."\n" + .'* 3: Float'."\n" + .'* 4: Double'."\n" + .'* 5: Boolean'."\n" + .'* 6: StringList'."\n" + .'* 7: IntList'."\n" + .'* 8: LongList'."\n" + .'* 9: FloatList'."\n" + .'* 10: DoubleList'."\n" + .'* 11: BooleanList'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ExampleValue' => ['description' => 'The sample value.'."\n", 'type' => 'string', 'example' => 'example1', 'title' => ''], + 'IsRequiredParameter' => ['description' => 'Indicates whether the parameter is required.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'ParameterDataType' => [ - 'description' => 'The data type of the parameter. Valid values:'."\n" - ."\n" - .'* 0: String'."\n" - .'* 1: Int'."\n" - .'* 2: Long'."\n" - .'* 3: Float'."\n" - .'* 4: Double'."\n" - .'* 5: Boolean'."\n" - .'* 6: StringList'."\n" - .'* 7: IntList'."\n" - .'* 8: LongList'."\n" - .'* 9: FloatList'."\n" - .'* 10: DoubleList'."\n" - .'* 11: BooleanList'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', + 'ScriptResponseParameters' => [ + 'description' => 'The response parameters of the API generated in script mode.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ParameterDescription' => ['description' => 'The description.'."\n", 'type' => 'string', 'example' => 'description2', 'title' => ''], + 'ColumnName' => ['description' => 'The name of the associated field. This parameter is supported only if the API is generated in wizard mode.'."\n", 'type' => 'string', 'example' => 'column2', 'title' => ''], + 'ParameterName' => ['description' => 'The name of the parameter.'."\n", 'type' => 'string', 'example' => 'param2', 'title' => ''], + 'ParameterDataType' => ['description' => 'The data type of the parameter. Valid values:'."\n" + ."\n" + .'* 0: String'."\n" + .'* 1: Int'."\n" + .'* 2: Long'."\n" + .'* 3: Float'."\n" + .'* 4: Double'."\n" + .'* 5: Boolean'."\n" + .'* 6: StringList'."\n" + .'* 7: IntList'."\n" + .'* 8: LongList'."\n" + .'* 9: FloatList'."\n" + .'* 10: DoubleList'."\n" + .'* 11: BooleanList'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ExampleValue' => ['description' => 'The sample value.'."\n", 'type' => 'string', 'example' => 'example2', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'IsRequiredParameter' => [ - 'description' => 'Indicates whether the parameter is required.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'ScriptConnection' => [ + 'description' => 'The data source information about the API generated in script mode.'."\n", + 'type' => 'object', + 'properties' => [ + 'TableName' => ['description' => 'The name of the table in the data source.'."\n", 'type' => 'string', 'example' => 't', 'title' => ''], + 'ConnectionId' => ['description' => 'The data source ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], - 'description' => 'The returned result.'."\n", + 'title' => '', + 'example' => '', ], - ], - 'WizardResponseParameters' => [ - 'description' => 'The response parameters of the API generated in wizard mode.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The returned result.'."\n", + 'WizardDetails' => [ + 'description' => 'The details of the API generated in wizard mode. This parameter is returned only if the API is generated in wizard mode.'."\n", 'type' => 'object', 'properties' => [ - 'ParameterDescription' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'description2', - ], - 'ParameterName' => [ - 'description' => 'The name of the parameter.'."\n", - 'type' => 'string', - 'example' => 'param2', + 'IsPagedResponse' => ['description' => 'Indicates whether the entries are returned by page.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'WizardRequestParameters' => [ + 'description' => 'The request parameters of the API generated in wizard mode.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ColumnName' => ['description' => 'The name of the associated field. This parameter is supported only if the API is generated in wizard mode.'."\n", 'type' => 'string', 'example' => 'column1', 'title' => ''], + 'ParameterName' => ['description' => 'The name of the parameter.'."\n", 'type' => 'string', 'example' => 'param1', 'title' => ''], + 'ParameterPosition' => ['description' => 'The position of the parameter. Valid values: 0, 1, 2, and 3. The value 0 indicates that the parameter is in the URL path of the request. The value 1 indicates that the parameter is in the Query parameter of the request URL. The value 2 indicates that the parameter is in the request header. The value 3 indicates that the parameter is in the request body. APIs generated in wizard or script mode support only the Query position. APIs generated by registration whose request method is GET or DELETE support the Query and Head positions. APIs generated by registration whose request method is PUT or POST support the Query, Head, and Body positions.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ParameterDescription' => ['description' => 'The description.'."\n", 'type' => 'string', 'example' => 'description1', 'title' => ''], + 'DefaultValue' => ['description' => 'The default value.'."\n", 'type' => 'string', 'example' => 'default1', 'title' => ''], + 'ParameterOperator' => ['description' => 'The operator used for the value of the parameter. Valid values: 0, 1, 2, and 3. The value 0 indicates the Equal operator. The value 1 indicates the Like operator. The value 2 indicates the Const operator. The value 3 indicates the In operator. APIs generated in wizard mode support the Equal, Like, and In operators. APIs generated in script mode support the Equal operator. APIs generated by registration support the Equal and Const operators.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ParameterDataType' => ['description' => 'The data type of the parameter. Valid values:'."\n" + ."\n" + .'* 0: String'."\n" + .'* 1: Int'."\n" + .'* 2: Long'."\n" + .'* 3: Float'."\n" + .'* 4: Double'."\n" + .'* 5: Boolean'."\n" + .'* 6: StringList'."\n" + .'* 7: IntList'."\n" + .'* 8: LongList'."\n" + .'* 9: FloatList'."\n" + .'* 10: DoubleList'."\n" + .'* 11: BooleanList'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ExampleValue' => ['description' => 'The sample value.'."\n", 'type' => 'string', 'example' => 'example1', 'title' => ''], + 'IsRequiredParameter' => ['description' => 'Indicates whether the parameter is required.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'ExampleValue' => [ - 'description' => 'The sample value.'."\n", - 'type' => 'string', - 'example' => 'example2', + 'WizardResponseParameters' => [ + 'description' => 'The response parameters of the API generated in wizard mode.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ParameterDescription' => ['description' => 'The description.'."\n", 'type' => 'string', 'example' => 'description2', 'title' => ''], + 'ColumnName' => ['description' => 'The name of the associated field. This parameter is supported only if the API is generated in wizard mode.'."\n", 'type' => 'string', 'example' => 'column2', 'title' => ''], + 'ParameterName' => ['description' => 'The name of the parameter.'."\n", 'type' => 'string', 'example' => 'param2', 'title' => ''], + 'ParameterDataType' => ['description' => 'The data type of the parameter. Valid values:'."\n" + ."\n" + .'* 0: String'."\n" + .'* 1: Int'."\n" + .'* 2: Long'."\n" + .'* 3: Float'."\n" + .'* 4: Double'."\n" + .'* 5: Boolean'."\n" + .'* 6: StringList'."\n" + .'* 7: IntList'."\n" + .'* 8: LongList'."\n" + .'* 9: FloatList'."\n" + .'* 10: DoubleList'."\n" + .'* 11: BooleanList'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ExampleValue' => ['description' => 'The sample value.'."\n", 'type' => 'string', 'example' => 'example2', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'ParameterDataType' => [ - 'description' => 'The data type of the parameter. Valid values:'."\n" - ."\n" - .'* 0: String'."\n" - .'* 1: Int'."\n" - .'* 2: Long'."\n" - .'* 3: Float'."\n" - .'* 4: Double'."\n" - .'* 5: Boolean'."\n" - .'* 6: StringList'."\n" - .'* 7: IntList'."\n" - .'* 8: LongList'."\n" - .'* 9: FloatList'."\n" - .'* 10: DoubleList'."\n" - .'* 11: BooleanList'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', + 'WizardConnection' => [ + 'description' => 'The data source information about the API generated in wizard mode.'."\n", + 'type' => 'object', + 'properties' => [ + 'TableName' => ['description' => 'The name of the table in the data source.'."\n", 'type' => 'string', 'example' => 't', 'title' => ''], + 'ConnectionId' => ['description' => 'The data source ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], - 'WizardConnection' => [ - 'description' => 'The data source information of the API generated in wizard mode.'."\n", - 'type' => 'object', - 'properties' => [ - 'TableName' => [ - 'description' => 'The name of the table in the data source.'."\n", - 'type' => 'string', - 'example' => 't', - ], - 'ConnectionId' => [ - 'description' => 'The ID of the data source.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ], + ], + 'title' => 'ListDataServiceApis', + 'summary' => 'Queries a list of APIs in the development state.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => 'The details of different types of APIs are returned in different parameters. The details of an API generated in wizard mode are returned in the WizardDetails parameter. The details of an API generated in script mode are returned in the ScriptDetails parameter. The details of an API generated by registration are returned in the RegistrationDetails parameter.'."\n", + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-10-09T11:17:29.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Apis\\": [\\n {\\n \\"Timeout\\": 10000,\\n \\"Status\\": 0,\\n \\"ApiId\\": 10002,\\n \\"ApiMode\\": 0,\\n \\"ProjectId\\": 10000,\\n \\"ResponseContentType\\": 0,\\n \\"CreatorId\\": \\"1234567\\",\\n \\"VisibleRange\\": 0,\\n \\"ModifiedTime\\": \\"2020-06-23T00:21:01+0800\\",\\n \\"OperatorId\\": \\"2345678\\",\\n \\"GroupId\\": \\"abcde123456789\\",\\n \\"Description\\": \\"Test API description\\",\\n \\"FolderId\\": 0,\\n \\"RequestMethod\\": 0,\\n \\"CreatedTime\\": \\"2020-06-23T00:21:01+0800\\",\\n \\"ApiName\\": \\"My API name\\",\\n \\"TenantId\\": 10000,\\n \\"ApiPath\\": \\"/test/1\\",\\n \\"Protocols\\": [\\n 0\\n ],\\n \\"RegistrationDetails\\": {\\n \\"ServiceHost\\": \\"http://example.aliyundoc.com\\",\\n \\"ServiceContentType\\": 0,\\n \\"ServicePath\\": \\"/index\\",\\n \\"SuccessfulResultSample\\": \\"{\\\\\\"success\\\\\\": true}\\",\\n \\"FailedResultSample\\": \\"{\\\\\\"success\\\\\\": false}\\",\\n \\"ServiceRequestBodyDescription\\": \\"{\\\\\\"abc\\\\\\":1}\\",\\n \\"RegistrationErrorCodes\\": [\\n {\\n \\"ErrorMessage\\": \\"fail to call\\",\\n \\"ErrorCode\\": \\"1001\\",\\n \\"ErrorSolution\\": \\"retry\\"\\n }\\n ],\\n \\"RegistrationRequestParameters\\": [\\n {\\n \\"ColumnName\\": \\"column1\\",\\n \\"ParameterName\\": \\"name1\\",\\n \\"ParameterPosition\\": 0,\\n \\"ParameterDescription\\": \\"description1\\",\\n \\"DefaultValue\\": \\"default1\\",\\n \\"ParameterOperator\\": 0,\\n \\"ParameterDataType\\": 0,\\n \\"ExampleValue\\": \\"example1\\",\\n \\"IsRequiredParameter\\": true\\n }\\n ]\\n },\\n \\"ScriptDetails\\": {\\n \\"Script\\": \\"select a from t\\",\\n \\"IsPagedResponse\\": true,\\n \\"ScriptRequestParameters\\": [\\n {\\n \\"ColumnName\\": \\"column1\\",\\n \\"ParameterName\\": \\"param1\\",\\n \\"ParameterPosition\\": 0,\\n \\"ParameterDescription\\": \\"description1\\",\\n \\"DefaultValue\\": \\"default1\\",\\n \\"ParameterOperator\\": 0,\\n \\"ParameterDataType\\": 0,\\n \\"ExampleValue\\": \\"example1\\",\\n \\"IsRequiredParameter\\": true\\n }\\n ],\\n \\"ScriptResponseParameters\\": [\\n {\\n \\"ParameterDescription\\": \\"description2\\",\\n \\"ColumnName\\": \\"column2\\",\\n \\"ParameterName\\": \\"param2\\",\\n \\"ParameterDataType\\": 0,\\n \\"ExampleValue\\": \\"example2\\"\\n }\\n ],\\n \\"ScriptConnection\\": {\\n \\"TableName\\": \\"t\\",\\n \\"ConnectionId\\": 123\\n }\\n },\\n \\"WizardDetails\\": {\\n \\"IsPagedResponse\\": true,\\n \\"WizardRequestParameters\\": [\\n {\\n \\"ColumnName\\": \\"column1\\",\\n \\"ParameterName\\": \\"param1\\",\\n \\"ParameterPosition\\": 0,\\n \\"ParameterDescription\\": \\"description1\\",\\n \\"DefaultValue\\": \\"default1\\",\\n \\"ParameterOperator\\": 0,\\n \\"ParameterDataType\\": 0,\\n \\"ExampleValue\\": \\"example1\\",\\n \\"IsRequiredParameter\\": true\\n }\\n ],\\n \\"WizardResponseParameters\\": [\\n {\\n \\"ParameterDescription\\": \\"description2\\",\\n \\"ColumnName\\": \\"column2\\",\\n \\"ParameterName\\": \\"param2\\",\\n \\"ParameterDataType\\": 0,\\n \\"ExampleValue\\": \\"example2\\"\\n }\\n ],\\n \\"WizardConnection\\": {\\n \\"TableName\\": \\"t\\",\\n \\"ConnectionId\\": 123\\n }\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + ], + 'ListDataServiceApplications' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '78302', + 'abilityTreeNodes' => ['FEATUREdide7T0EJX'], + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => ['description' => 'The page number. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '50', 'minimum' => '1', 'default' => '10', 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'ProjectIdList', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the workspace based on which you want to query the basic information of applications. You can specify multiple IDs. Separate them with commas (,). You must specify at least one workspace ID. You can specify a maximum of 50 workspace IDs.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '10000,100001', 'title' => ''], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '100002', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0000-ABCD-EFG***', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Normal', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'Data' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => 'The page number. The value of this parameter is the same as that of the PageNumber parameter in the request.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'Applications' => [ + 'description' => 'The basic information of the applications.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ApplicationName' => ['description' => 'The name of the application.', 'type' => 'string', 'example' => 'My application', 'title' => ''], + 'ApplicationId' => ['description' => 'The application ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '20000', 'title' => ''], + 'ProjectId' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFG***\\",\\n \\"ErrorMessage\\": \\"Normal\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"0\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Applications\\": [\\n {\\n \\"ApplicationName\\": \\"My application\\",\\n \\"ApplicationId\\": 20000,\\n \\"ProjectId\\": 10000\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListDataServiceApplications', + 'summary' => 'Retrieves a list of applications.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-10-09T11:17:29.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'translator' => 'manual', + ], + 'ListDataServiceAuthorizedApis' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '78303', + 'abilityTreeNodes' => ['FEATUREdide7T0EJX'], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10000', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'minimum' => '1', 'default' => '1', 'example' => 'PageNumber', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '50', 'minimum' => '1', 'default' => '10', 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['description' => 'The tenant ID. This parameter is deprecated.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10001', 'title' => ''], + ], + [ + 'name' => 'ApiNameKeyword', + 'in' => 'formData', + 'schema' => ['description' => 'The keyword in API names. The keyword is used to search for the APIs whose names contain the keyword.', 'type' => 'string', 'example' => 'My API name', 'required' => false, 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0000-ABCD-EFG****', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified parameters are invalid.', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '1031203110005', 'title' => ''], + 'Data' => [ + 'description' => 'The information about the APIs that you are authorized to access.', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => 'The page number. The value of this parameter is the same as that of the PageNumber parameter in the request.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'ApiAuthorizedList' => [ + 'description' => 'The APIs that you are authorized to access.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ApiId' => ['description' => 'The API ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10002', 'title' => ''], + 'ApiStatus' => ['description' => 'The status of the API. Valid values: 0 and 1. The value 0 indicates that the API is not published. The value 1 indicates that the API is published.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'GrantOperatorId' => ['description' => 'The ID of the Alibaba Cloud account used by the user who granted the access permissions on the API.', 'type' => 'string', 'example' => '23456', 'title' => ''], + 'ProjectId' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'title' => ''], + 'CreatorId' => ['description' => 'The ID of the Alibaba Cloud account used by the API owner.', 'type' => 'string', 'example' => '12345', 'title' => ''], + 'GrantEndTime' => ['description' => 'The expiration time of the access permissions granted on the API.', 'type' => 'string', 'example' => '2020-06-24T00:21:01+0800', 'title' => ''], + 'ModifiedTime' => ['description' => 'The time when the API was last updated.', 'type' => 'string', 'example' => '2020-06-23T00:21:01+0800', 'title' => ''], + 'GroupId' => ['description' => 'The group ID.', 'type' => 'string', 'example' => 'abcde123456789', 'title' => ''], + 'GrantCreatedTime' => ['description' => 'The time when the access permissions on the API were granted.', 'type' => 'string', 'example' => '2020-06-23T00:21:01+0800', 'title' => ''], + 'CreatedTime' => ['description' => 'The time when the API was created.', 'type' => 'string', 'example' => '2020-06-23T00:21:01+0800', 'title' => ''], + 'ApiName' => ['description' => 'The name of the API.', 'type' => 'string', 'example' => 'My API name', 'title' => ''], + 'TenantId' => ['description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10001', 'title' => ''], + 'ApiPath' => ['description' => 'The path of the API.', 'type' => 'string', 'example' => '/test/1', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - ], - 'SqlMode' => [ - 'title' => 'SQL模式，0：基础SQL；1：高级SQL', - 'description' => 'The SQL mode. 0: Basic SQL; 1: Advanced SQL.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], ], 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"ApiAuthorizedList\\": [\\n {\\n \\"ApiId\\": 10002,\\n \\"ApiStatus\\": 0,\\n \\"GrantOperatorId\\": \\"23456\\",\\n \\"ProjectId\\": 10000,\\n \\"CreatorId\\": \\"12345\\",\\n \\"GrantEndTime\\": \\"2020-06-24T00:21:01+0800\\",\\n \\"ModifiedTime\\": \\"2020-06-23T00:21:01+0800\\",\\n \\"GroupId\\": \\"abcde123456789\\",\\n \\"GrantCreatedTime\\": \\"2020-06-23T00:21:01+0800\\",\\n \\"CreatedTime\\": \\"2020-06-23T00:21:01+0800\\",\\n \\"ApiName\\": \\"My API name\\",\\n \\"TenantId\\": 10001,\\n \\"ApiPath\\": \\"/test/1\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListDataServiceAuthorizedApis', + 'summary' => 'Retrieves a list of APIs that you are authorized to access.', + 'changeSet' => [ + ['createdAt' => '2023-10-09T11:17:29.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'translator' => 'manual', + ], + 'ListDataServiceFolders' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '78304', + 'abilityTreeNodes' => ['FEATUREdide7T0EJX'], + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => ['description' => 'The page number. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '50', 'minimum' => '1', 'default' => '10', 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '10001', 'title' => ''], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the page that appears, click the username for the logon in the upper-right corner and click User Info in the Menu section.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '10002', 'title' => ''], + ], + [ + 'name' => 'GroupId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the business process to which the folders belong.', 'type' => 'string', 'required' => false, 'example' => 'ds_123abc', 'title' => ''], + ], + [ + 'name' => 'FolderNameKeyword', + 'in' => 'formData', + 'schema' => ['description' => 'The keyword in folder names. The keyword is used to search for folders whose names contain this keyword.', 'type' => 'string', 'example' => 'Folder name keyword', 'required' => false, 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0000-ABCD-EF****', 'title' => ''], + 'FolderPagingResult' => [ + 'description' => 'The paging result for the folders.', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => 'The page number. The value of this parameter is the same as that of the PageNumber parameter in the request.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'Folders' => [ + 'description' => 'The folders.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ParentId' => ['description' => 'The ID of the parent folder. The ID of the root folder in a business process is 0, and the ID of a folder created by a user in a business process is greater than 0.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'ModifiedTime' => ['description' => 'The time when the folder was last modified.', 'type' => 'string', 'example' => '2020-09-24T18:37:51+0800', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the business process to which the folder belongs.', 'type' => 'string', 'example' => 'ds_1234', 'title' => ''], + 'FolderId' => ['description' => 'The folder ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '11', 'title' => ''], + 'FolderName' => ['description' => 'The name of the folder.', 'type' => 'string', 'example' => 'test1', 'title' => ''], + 'ProjectId' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10001', 'title' => ''], + 'CreatedTime' => ['description' => 'The time when the folder was created.', 'type' => 'string', 'example' => '2020-09-24T18:37:51+0800', 'title' => ''], + 'TenantId' => ['description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10002', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Data\\": {\\n \\"Timeout\\": 10000,\\n \\"Status\\": 1,\\n \\"ApiId\\": 10000,\\n \\"ApiMode\\": 0,\\n \\"ProjectId\\": 10001,\\n \\"ResponseContentType\\": 0,\\n \\"CreatorId\\": \\"1234567\\",\\n \\"VisibleRange\\": 0,\\n \\"ModifiedTime\\": \\"2020-06-23T00:21:01+0800\\",\\n \\"OperatorId\\": \\"2345678\\",\\n \\"GroupId\\": \\"ab12**\\",\\n \\"Description\\": \\"测试API描述\\",\\n \\"RequestMethod\\": 0,\\n \\"CreatedTime\\": \\"2020-06-23T00:21:01+0800\\",\\n \\"ApiName\\": \\"测试API名称\\",\\n \\"TenantId\\": 10001,\\n \\"ApiPath\\": \\"/test/1\\",\\n \\"Protocols\\": [\\n 0\\n ],\\n \\"RegistrationDetails\\": {\\n \\"ServiceHost\\": \\"http://www.abc.com\\",\\n \\"ServiceContentType\\": 0,\\n \\"ServicePath\\": \\"/index\\",\\n \\"SuccessfulResultSample\\": \\"{\\\\\\"success\\\\\\": true}\\",\\n \\"FailedResultSample\\": \\"{\\\\\\"success\\\\\\": false}\\",\\n \\"ServiceRequestBodyDescription\\": \\"{\\\\\\"abc\\\\\\":1}\\",\\n \\"RegistrationErrorCodes\\": [\\n {\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"ErrorSolution\\": \\"retry\\"\\n }\\n ],\\n \\"RegistrationRequestParameters\\": [\\n {\\n \\"ParameterName\\": \\"name1\\",\\n \\"ParameterPosition\\": 0,\\n \\"ParameterDescription\\": \\"description1\\",\\n \\"DefaultValue\\": \\"default1\\",\\n \\"ParameterOperator\\": 0,\\n \\"ExampleValue\\": \\"example1\\",\\n \\"ParameterDataType\\": 0,\\n \\"IsRequiredParameter\\": true\\n }\\n ]\\n },\\n \\"ScriptDetails\\": {\\n \\"IsPagedResponse\\": true,\\n \\"SuccessfulResultSample\\": \\"{\\\\\\"success\\\\\\": true}\\",\\n \\"FailedResultSample\\": \\"{\\\\\\"success\\\\\\": false}\\",\\n \\"Script\\": \\"select a from t\\",\\n \\"ScriptErrorCodes\\": [\\n {\\n \\"ErrorMessage\\": \\"fail to call\\",\\n \\"ErrorCode\\": \\"1001\\",\\n \\"ErrorSolution\\": \\"retry\\"\\n }\\n ],\\n \\"ScriptRequestParameters\\": [\\n {\\n \\"ParameterName\\": \\"param1\\",\\n \\"ParameterPosition\\": 0,\\n \\"ParameterDescription\\": \\"description1\\",\\n \\"DefaultValue\\": \\"default1\\",\\n \\"ParameterOperator\\": 0,\\n \\"ExampleValue\\": \\"example1\\",\\n \\"ParameterDataType\\": 0,\\n \\"IsRequiredParameter\\": true\\n }\\n ],\\n \\"ScriptResponseParameters\\": [\\n {\\n \\"ParameterDescription\\": \\"description2\\",\\n \\"ParameterName\\": \\"param2\\",\\n \\"ExampleValue\\": \\"example2\\",\\n \\"ParameterDataType\\": 0\\n }\\n ],\\n \\"ScriptConnection\\": {\\n \\"TableName\\": \\"t\\",\\n \\"ConnectionId\\": 123\\n }\\n },\\n \\"WizardDetails\\": {\\n \\"IsPagedResponse\\": true,\\n \\"SuccessfulResultSample\\": \\"{\\\\\\"success\\\\\\": true}\\",\\n \\"FailedResultSample\\": \\"{\\\\\\"success\\\\\\": false}\\",\\n \\"WizardErrorCodes\\": [\\n {\\n \\"ErrorMessage\\": \\"fail to call\\",\\n \\"ErrorCode\\": \\"1001\\",\\n \\"ErrorSolution\\": \\"retry\\"\\n }\\n ],\\n \\"WizardRequestParameters\\": [\\n {\\n \\"ParameterName\\": \\"param1\\",\\n \\"ParameterPosition\\": 0,\\n \\"ParameterDescription\\": \\"description1\\",\\n \\"DefaultValue\\": \\"default1\\",\\n \\"ParameterOperator\\": 0,\\n \\"ExampleValue\\": \\"example1\\",\\n \\"ParameterDataType\\": 0,\\n \\"IsRequiredParameter\\": true\\n }\\n ],\\n \\"WizardResponseParameters\\": [\\n {\\n \\"ParameterDescription\\": \\"description2\\",\\n \\"ParameterName\\": \\"param2\\",\\n \\"ExampleValue\\": \\"example2\\",\\n \\"ParameterDataType\\": 0\\n }\\n ],\\n \\"WizardConnection\\": {\\n \\"TableName\\": \\"t\\",\\n \\"ConnectionId\\": 123\\n }\\n },\\n \\"SqlMode\\": 0\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 0000-ABCD-EFG****\\n The connection does not exist.\\n true\\n Invalid.Tenant.ConnectionNotExists\\n \\n 10000\\n 1\\n 10000\\n 0\\n 10001\\n 0\\n 1234567\\n 0\\n 2020-06-23T00:21:01+0800\\n 2345678\\n ab12**\\n 测试API描述\\n 0\\n 2020-06-23T00:21:01+0800\\n 测试API名称\\n 10001\\n /test/1\\n 0\\n \\n http://www.abc.com\\n 0\\n /index\\n {\\"success\\": true}\\n {\\"success\\": false}\\n {\\"abc\\":1}\\n \\n The connection does not exist.\\n Invalid.Tenant.ConnectionNotExists\\n retry\\n \\n \\n name1\\n 0\\n description1\\n default1\\n 0\\n example1\\n 0\\n true\\n \\n \\n \\n true\\n {\\"success\\": true}\\n {\\"success\\": false}\\n \\n \\n fail to call\\n 1001\\n retry\\n \\n \\n param1\\n 0\\n description1\\n default1\\n 0\\n example1\\n 0\\n true\\n \\n \\n description2\\n param2\\n example2\\n 0\\n \\n \\n t\\n 123\\n \\n \\n \\n true\\n {\\"success\\": true}\\n {\\"success\\": false}\\n \\n fail to call\\n 1001\\n retry\\n \\n \\n param1\\n 0\\n description1\\n default1\\n 0\\n example1\\n 0\\n true\\n \\n \\n description2\\n param2\\n example2\\n 0\\n \\n \\n t\\n 123\\n \\n \\n \\n","errorExample":""}]', - 'title' => 'GetDataServicePublishedApi', + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EF****\\",\\n \\"FolderPagingResult\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Folders\\": [\\n {\\n \\"ParentId\\": 0,\\n \\"ModifiedTime\\": \\"2020-09-24T18:37:51+0800\\",\\n \\"GroupId\\": \\"ds_1234\\",\\n \\"FolderId\\": 11,\\n \\"FolderName\\": \\"test1\\",\\n \\"ProjectId\\": 10001,\\n \\"CreatedTime\\": \\"2020-09-24T18:37:51+0800\\",\\n \\"TenantId\\": 10002\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListDataServiceFolders', + 'summary' => 'Retrieves a list of folders.', 'requestParamsDescription' => ' ', - 'responseParamsDescription' => 'The details about the APIs of different types are returned in different parameters. The details about the API generated in wizard mode are returned in the WizardDetails parameter. The details about the API generated in script mode are returned in the ScriptDetails parameter. The details about the API generated by registration are returned in the RegistrationDetails parameter.'."\n", + 'responseParamsDescription' => ' ', 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-10-09T11:17:29.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'translator' => 'manual', ], - 'ListDataServicePublishedApis' => [ - 'summary' => 'Queries a list of APIs in the published state.', - 'methods' => [ - 'post', + 'ListDataServiceGroups' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '78305', + 'abilityTreeNodes' => ['FEATUREdide7T0EJX'], + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => ['description' => 'The page number. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '50', 'minimum' => '1', 'default' => '10', 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '10000', 'title' => ''], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['description' => 'The tenant ID. This parameter is deprecated.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '10001', 'title' => ''], + ], + [ + 'name' => 'GroupNameKeyword', + 'in' => 'formData', + 'schema' => ['description' => 'The keyword of a business process name. The keyword is used to search for business processes whose names contain this keyword.', 'type' => 'string', 'example' => 'Test workflow', 'required' => false, 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0000-ABCD-EF****', 'title' => ''], + 'GroupPagingResult' => [ + 'description' => 'The paging result for the business processes.', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => 'The page number. The value of this parameter is the same as that of the PageNumber parameter in the request.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'Groups' => [ + 'description' => 'The business processes.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ModifiedTime' => ['description' => 'The time when the business process was modified.', 'type' => 'string', 'example' => '2020-09-24T18:37:51+0800', 'title' => ''], + 'Description' => ['description' => 'The description of the business process.', 'type' => 'string', 'example' => 'Workflow description', 'title' => ''], + 'GroupName' => ['description' => 'The name of the business process.', 'type' => 'string', 'example' => 'Workflow name', 'title' => ''], + 'GroupId' => ['description' => 'The business process ID.', 'type' => 'string', 'example' => 'ds_123abc', 'title' => ''], + 'ProjectId' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10002', 'title' => ''], + 'ApiGatewayGroupId' => ['description' => 'The ID of the API Gateway group to which the workflow is bound.', 'type' => 'string', 'example' => '100abc', 'title' => ''], + 'CreatorId' => ['description' => 'The user identifier (UID) of the creator of the business process. The value of this parameter may be empty for creators of some existing business processes.', 'type' => 'string', 'example' => '10001', 'title' => ''], + 'CreatedTime' => ['description' => 'The time when the business process was created.', 'type' => 'string', 'example' => '2020-09-24T18:37:51+0800', 'title' => ''], + 'TenantId' => ['description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10003', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EF****\\",\\n \\"GroupPagingResult\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Groups\\": [\\n {\\n \\"ModifiedTime\\": \\"2020-09-24T18:37:51+0800\\",\\n \\"Description\\": \\"Workflow description\\",\\n \\"GroupName\\": \\"Workflow name\\",\\n \\"GroupId\\": \\"ds_123abc\\",\\n \\"ProjectId\\": 10002,\\n \\"ApiGatewayGroupId\\": \\"100abc\\",\\n \\"CreatorId\\": \\"10001\\",\\n \\"CreatedTime\\": \\"2020-09-24T18:37:51+0800\\",\\n \\"TenantId\\": 10003\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListDataServiceGroups', + 'summary' => 'Retrieves a list of business processes.', + 'changeSet' => [ + ['createdAt' => '2023-10-09T11:17:29.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'translator' => 'manual', + ], + 'ListDataServicePublishedApis' => [ + 'summary' => 'Retrieves a list of published APIs.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -46772,93 +25828,43 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '78306', - 'abilityTreeNodes' => [ - 'FEATUREdide7T0EJX', - ], + 'abilityTreeNodes' => ['FEATUREdide7T0EJX'], ], 'parameters' => [ [ 'name' => 'PageNumber', 'in' => 'formData', - 'schema' => [ - 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'The page number. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of entries per page. Default is 10, and the maximum is 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'maximum' => '50', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], + 'schema' => ['description' => 'The number of entries per page. Default is 10, and the maximum is 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '50', 'minimum' => '1', 'default' => '10', 'example' => '10', 'title' => ''], ], [ 'name' => 'ProjectId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '10000', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10000', 'title' => ''], ], [ 'name' => 'TenantId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '10001', - ], + 'schema' => ['description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10001', 'title' => ''], ], [ 'name' => 'ApiNameKeyword', 'in' => 'formData', - 'schema' => [ - 'description' => 'The keyword in API names. The keyword is used to search for the APIs whose names contain the keyword.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'My API name', - ], + 'schema' => ['description' => 'The keyword in API names. The keyword is used to search for the APIs whose names contain the keyword.', 'type' => 'string', 'required' => false, 'example' => 'My API name', 'title' => ''], ], [ 'name' => 'ApiPathKeyword', 'in' => 'formData', - 'schema' => [ - 'description' => 'The keyword in API paths. The keyword is used to search for the APIs whose paths contain the keyword.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '/test/', - ], + 'schema' => ['description' => 'The keyword in API paths. The keyword is used to search for the APIs whose paths contain the keyword.', 'type' => 'string', 'required' => false, 'example' => '/test/', 'title' => ''], ], [ 'name' => 'CreatorId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the creator of the APIs. The ID is used to search for the APIs created by the creator.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '12345', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the Alibaba Cloud account used by the creator of the APIs. The ID is used to search for the APIs created by the creator.', 'type' => 'string', 'required' => false, 'example' => '12345', 'title' => ''], ], ], 'responses' => [ @@ -46866,738 +25872,943 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0000-ABCD-EFG****', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The connection does not exist.', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], 'Data' => [ - 'description' => 'The data returned.'."\n", + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number. The value of this parameter is the same as that of the PageNumber parameter in the request.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], + 'PageNumber' => ['description' => 'The page number. The value of this parameter is the same as that of the PageNumber parameter in the request.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], 'Apis' => [ - 'description' => 'Information about published APIs.'."\n", + 'description' => 'Information about published APIs.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Timeout' => [ - 'description' => 'The timeout period of the API request. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10000', - ], - 'Status' => [ - 'description' => 'The status of the API. Valid values: 0 and 1. The value 0 indicates that the API is not published. The value 1 indicates that the API is published.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ApiId' => [ - 'description' => 'The API ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10002', - ], - 'ApiMode' => [ - 'description' => 'The type of the API. Valid values: 0, 1, and 2. The value 0 indicates that the API is generated in wizard mode. The value 1 indicates that the API is generated in script mode. The value 2 indicates that the API is generated by registration.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ProjectId' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000', - ], - 'ResponseContentType' => [ - 'description' => 'The format in which the response of the API request is returned. Valid values: 0 and 1. The value 0 indicates the JSON format. The value 1 indicates the XML format. APIs generated in wizard or script mode support the JSON format. APIs generated by registration support the JSON and XML formats.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'CreatorId' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the creator of the API.'."\n", - 'type' => 'string', - 'example' => '1234567', - ], - 'VisibleRange' => [ - 'description' => 'The scope in which the API is visible. Valid values: 0 and 1. The value 0 indicates that the API is visible within the workspace. The value 1 indicates that the API is visible only to its owner.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ModifiedTime' => [ - 'description' => 'The time when the API was last modified.'."\n", - 'type' => 'string', - 'example' => '2020-06-23T00:21:01+0800', - ], - 'OperatorId' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the user who last modified the API.'."\n", - 'type' => 'string', - 'example' => '2345678', - ], - 'GroupId' => [ - 'description' => 'The group ID.'."\n", - 'type' => 'string', - 'example' => 'ab123', - ], - 'Description' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'Test API description', - ], - 'RequestMethod' => [ - 'description' => 'The request method of the API. Valid values: 0, 1, 2, and 3. The value 0 indicates the GET method. The value 1 indicates the POST method. The value 2 indicates the PUT method. The value 3 indicates the DELETE method. APIs generated in wizard or script mode support the GET and POST methods. APIs generated by registration support the GET, POST, PUT, and DELETE methods.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'CreatedTime' => [ - 'description' => 'The time when the API was created.'."\n", - 'type' => 'string', - 'example' => '2020-06-23T00:21:01+0800', - ], - 'ApiName' => [ - 'description' => 'The name of the API.'."\n", - 'type' => 'string', - 'example' => 'My API name', - ], - 'TenantId' => [ - 'description' => 'The tenant ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10001', - ], - 'ApiPath' => [ - 'description' => 'The path of the API.'."\n", - 'type' => 'string', - 'example' => '/test/1', - ], + 'Timeout' => ['description' => 'The timeout period of the API request. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '10000', 'title' => ''], + 'Status' => ['description' => 'The status of the API. Valid values: 0 and 1. The value 0 indicates that the API is not published. The value 1 indicates that the API is published.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ApiId' => ['description' => 'The API ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10002', 'title' => ''], + 'ApiMode' => ['description' => 'The type of the API. Valid values: 0, 1, and 2. The value 0 indicates that the API is generated in wizard mode. The value 1 indicates that the API is generated in script mode. The value 2 indicates that the API is generated by registration.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ProjectId' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'title' => ''], + 'ResponseContentType' => ['description' => 'The format in which the response of the API request is returned. Valid values: 0 and 1. The value 0 indicates the JSON format. The value 1 indicates the XML format. APIs generated in wizard or script mode support the JSON format. APIs generated by registration support the JSON and XML formats.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'CreatorId' => ['description' => 'The ID of the Alibaba Cloud account used by the creator of the API.', 'type' => 'string', 'example' => '1234567', 'title' => ''], + 'VisibleRange' => ['description' => 'The scope in which the API is visible. Valid values: 0 and 1. The value 0 indicates that the API is visible within the workspace. The value 1 indicates that the API is visible only to its owner.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ModifiedTime' => ['description' => 'The time when the API was last modified.', 'type' => 'string', 'example' => '2020-06-23T00:21:01+0800', 'title' => ''], + 'OperatorId' => ['description' => 'The ID of the Alibaba Cloud account used by the user who last modified the API.', 'type' => 'string', 'example' => '2345678', 'title' => ''], + 'GroupId' => ['description' => 'The group ID.', 'type' => 'string', 'example' => 'ab123', 'title' => ''], + 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'Test API description', 'title' => ''], + 'RequestMethod' => ['description' => 'The request method of the API. Valid values: 0, 1, 2, and 3. The value 0 indicates the GET method. The value 1 indicates the POST method. The value 2 indicates the PUT method. The value 3 indicates the DELETE method. APIs generated in wizard or script mode support the GET and POST methods. APIs generated by registration support the GET, POST, PUT, and DELETE methods.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'CreatedTime' => ['description' => 'The time when the API was created.', 'type' => 'string', 'example' => '2020-06-23T00:21:01+0800', 'title' => ''], + 'ApiName' => ['description' => 'The name of the API.', 'type' => 'string', 'example' => 'My API name', 'title' => ''], + 'TenantId' => ['description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10001', 'title' => ''], + 'ApiPath' => ['description' => 'The path of the API.', 'type' => 'string', 'example' => '/test/1', 'title' => ''], 'Protocols' => [ - 'description' => 'The protocol used by the API. Valid values: 0 and 1. The value 0 indicates HTTP. The value 1 indicates HTTPS.'."\n", + 'description' => 'The protocol used by the API. Valid values: 0 and 1. The value 0 indicates HTTP. The value 1 indicates HTTPS.', 'type' => 'array', - 'items' => [ - 'description' => 'The protocol used by the API. Valid values: 0 and 1. The value 0 indicates HTTP. The value 1 indicates HTTPS.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], + 'items' => ['description' => 'The protocol used by the API. Valid values: 0 and 1. The value 0 indicates HTTP. The value 1 indicates HTTPS.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'title' => '', + 'example' => '', ], 'RegistrationDetails' => [ - 'description' => 'The details of the API generated by registration. This parameter is returned only if the API is generated by registration.'."\n", + 'description' => 'The details of the API generated by registration. This parameter is returned only if the API is generated by registration.', 'type' => 'object', 'properties' => [ - 'ServiceHost' => [ - 'description' => 'The URL of the backend service.'."\n", - 'type' => 'string', - 'example' => 'http://example.aliyundoc.com', - ], - 'ServiceContentType' => [ - 'description' => 'The format in which the response of the API request is returned. Valid values: 0 and 1. The value 0 indicates the JSON format. The value 1 indicates the XML format. APIs generated in wizard or script mode support the JSON format. APIs generated by registration support the JSON and XML formats.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ServicePath' => [ - 'description' => 'The path of the backend service.'."\n", - 'type' => 'string', - 'example' => '/index', - ], - 'SuccessfulResultSample' => [ - 'description' => 'The sample success response of the API.'."\n", - 'type' => 'string', - 'example' => '{"success": true}', - ], - 'FailedResultSample' => [ - 'description' => 'The sample error response of the API.'."\n", - 'type' => 'string', - 'example' => '{"success": false}', - ], - 'ServiceRequestBodyDescription' => [ - 'description' => 'The description of the request body initiated to call the backend service.'."\n", - 'type' => 'string', - 'example' => '{"abc":1}', - ], + 'ServiceHost' => ['description' => 'The URL of the backend service.', 'type' => 'string', 'example' => 'http://www.abc.com', 'title' => ''], + 'ServiceContentType' => ['description' => 'The format in which the response of the API request is returned. Valid values: 0 and 1. The value 0 indicates the JSON format. The value 1 indicates the XML format. APIs generated in wizard or script mode support the JSON format. APIs generated by registration support the JSON and XML formats.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ServicePath' => ['description' => 'The path of the backend service.', 'type' => 'string', 'example' => '/index', 'title' => ''], + 'SuccessfulResultSample' => ['description' => 'The sample success response of the API.', 'type' => 'string', 'example' => '{"success": true}', 'title' => ''], + 'FailedResultSample' => ['description' => 'The sample error response of the API.', 'type' => 'string', 'example' => '{"success": false}', 'title' => ''], + 'ServiceRequestBodyDescription' => ['description' => 'The description of the request body initiated to call the backend service.', 'type' => 'string', 'example' => '{"abc":1}', 'title' => ''], 'RegistrationErrorCodes' => [ - 'description' => 'The error codes returned for the API generated by registration.'."\n", + 'description' => 'The error codes returned for the API generated by registration.', 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'fail to call', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '1001', - ], - 'ErrorSolution' => [ - 'description' => 'The solution used to fix the error.'."\n", - 'type' => 'string', - 'example' => 'retry', - ], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'fail to call', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '1001', 'title' => ''], + 'ErrorSolution' => ['description' => 'The solution used to fix the error.', 'type' => 'string', 'example' => 'retry', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], 'RegistrationRequestParameters' => [ - 'description' => 'The request parameters of the API generated by registration.'."\n", + 'description' => 'The request parameters of the API generated by registration.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'ParameterName' => [ - 'description' => 'The name of the parameter.'."\n", - 'type' => 'string', - 'example' => 'name1', - ], - 'ParameterPosition' => [ - 'description' => 'The position of the parameter. Valid values:'."\n" - ."\n" - .'* 0: indicates that the parameter is in the URL path of the request.'."\n" - .'* 1: indicates that the parameter is in the Query parameter of the request URL.'."\n" - .'* 2: indicates that the parameter is in the request header.'."\n" - .'* 3: indicates that the parameter is in the request body.'."\n" - ."\n" - .'APIs generated in wizard or script mode support only the Query position. APIs generated by registration whose request method is GET or DELETE support the Query and Head positions. APIs generated by registration whose request method is PUT or POST support the Query, Head, and Body positions.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ParameterDescription' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'description1', - ], - 'DefaultValue' => [ - 'description' => 'The default value.'."\n", - 'type' => 'string', - 'example' => 'default1', - ], - 'ParameterOperator' => [ - 'description' => 'The operator used for the value of the parameter. Valid values:'."\n" - ."\n" - .'* 0: Equal'."\n" - .'* 1: Like'."\n" - .'* 2: Const'."\n" - .'* 3: In'."\n" - ."\n" - .'APIs generated in wizard mode support the Equal, Like, and In operators. APIs generated in script mode support the Equal operator. APIs generated by registration support the Equal and Const operators.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ExampleValue' => [ - 'description' => 'The sample value.'."\n", - 'type' => 'string', - 'example' => 'example1', - ], - 'ParameterDataType' => [ - 'description' => 'The data type of the parameter. Valid values:'."\n" - ."\n" - .'* 0: String'."\n" - .'* 1: Int'."\n" - .'* 2: Long'."\n" - .'* 3: Float'."\n" - .'* 4: Double'."\n" - .'* 5: Boolean'."\n" - .'* 6: StringList'."\n" - .'* 7: IntList'."\n" - .'* 8: LongList'."\n" - .'* 9: FloatList'."\n" - .'* 10: DoubleList'."\n" - .'* 11: BooleanList'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'IsRequiredParameter' => [ - 'description' => 'Indicates whether the request parameter is required.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'ParameterName' => ['description' => 'The name of the parameter.', 'type' => 'string', 'example' => 'name1', 'title' => ''], + 'ParameterPosition' => ['description' => 'The position of the parameter. Valid values:'."\n" + ."\n" + .'- 0: indicates that the parameter is in the URL path of the request.'."\n" + ."\n" + .'- 1: indicates that the parameter is in the Query parameter of the request URL.'."\n" + ."\n" + .'- 2: indicates that the parameter is in the request header.'."\n" + ."\n" + .'- 3: indicates that the parameter is in the request body.'."\n" + ."\n" + .'APIs generated in wizard or script mode support only the Query position. APIs generated by registration whose request method is GET or DELETE support the Query and Head positions. APIs generated by registration whose request method is PUT or POST support the Query, Head, and Body positions.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ParameterDescription' => ['description' => 'The description.', 'type' => 'string', 'example' => 'description1', 'title' => ''], + 'DefaultValue' => ['description' => 'The default value.', 'type' => 'string', 'example' => 'default1', 'title' => ''], + 'ParameterOperator' => ['description' => 'The operator used for the value of the parameter. Valid values:'."\n" + ."\n" + .'- 0: Equal'."\n" + ."\n" + .'- 1: Like'."\n" + ."\n" + .'- 2: Const'."\n" + ."\n" + .'- 3: In'."\n" + ."\n" + .'APIs generated in wizard mode support the Equal, Like, and In operators. APIs generated in script mode support the Equal operator. APIs generated by registration support the Equal and Const operators.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ExampleValue' => ['description' => 'The sample value.', 'type' => 'string', 'example' => 'example1', 'title' => ''], + 'ParameterDataType' => ['description' => 'The data type of the parameter. Valid values:'."\n" + ."\n" + .'- 0: String'."\n" + ."\n" + .'- 1: Int'."\n" + ."\n" + .'- 2: Long'."\n" + ."\n" + .'- 3: Float'."\n" + ."\n" + .'- 4: Double'."\n" + ."\n" + .'- 5: Boolean'."\n" + ."\n" + .'- 6: StringList'."\n" + ."\n" + .'- 7: IntList'."\n" + ."\n" + .'- 8: LongList'."\n" + ."\n" + .'- 9: FloatList'."\n" + ."\n" + .'- 10: DoubleList'."\n" + ."\n" + .'- 11: BooleanList', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'IsRequiredParameter' => ['description' => 'Indicates whether the request parameter is required.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], 'ScriptDetails' => [ - 'description' => 'The details of the API generated in script mode. This parameter is returned only if the API is generated in script mode.'."\n", + 'description' => 'The details of the API generated in script mode. This parameter is returned only if the API is generated in script mode.', 'type' => 'object', 'properties' => [ - 'IsPagedResponse' => [ - 'description' => 'Indicates whether the entries are returned by page.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'SuccessfulResultSample' => [ - 'description' => 'The sample success response of the API.'."\n", - 'type' => 'string', - 'example' => '{"success": true}', - ], - 'FailedResultSample' => [ - 'description' => 'The sample error response of the API.'."\n", - 'type' => 'string', - 'example' => '{"success": false}', - ], - 'Script' => [ - 'description' => 'The SQL script.'."\n", - 'type' => 'string', - 'example' => 'select a from t', - ], + 'IsPagedResponse' => ['description' => 'Indicates whether the entries are returned by page.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'SuccessfulResultSample' => ['description' => 'The sample success response of the API.', 'type' => 'string', 'example' => '{"success": true}', 'title' => ''], + 'FailedResultSample' => ['description' => 'The sample error response of the API.', 'type' => 'string', 'example' => '{"success": false}', 'title' => ''], + 'Script' => ['description' => 'The SQL script.', 'type' => 'string', 'example' => 'select a from t', 'title' => ''], 'ScriptErrorCodes' => [ - 'description' => 'The error codes returned for the API generated in script mode.'."\n", + 'description' => 'The error codes returned for the API generated in script mode.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'fail to call', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '1001', - ], - 'ErrorSolution' => [ - 'description' => 'The solution used to fix the error.'."\n", - 'type' => 'string', - 'example' => 'retry', - ], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'fail to call', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '1001', 'title' => ''], + 'ErrorSolution' => ['description' => 'The solution used to fix the error.', 'type' => 'string', 'example' => 'retry', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], 'ScriptRequestParameters' => [ - 'description' => 'The request parameters of the API generated in script mode.'."\n", + 'description' => 'The request parameters of the API generated in script mode.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'ParameterName' => [ - 'description' => 'The name of the parameter.'."\n", - 'type' => 'string', - 'example' => 'param1', - ], - 'ParameterPosition' => [ - 'description' => 'The position of the parameter. Valid values:'."\n" - ."\n" - .'* 0: indicates that the parameter is in the URL path of the request.'."\n" - .'* 1: indicates that the parameter is in the Query parameter of the request URL.'."\n" - .'* 2: indicates that the parameter is in the request header.'."\n" - .'* 3: indicates that the parameter is in the request body.'."\n" - ."\n" - .'APIs generated in wizard or script mode support only the Query position. APIs generated by registration whose request method is GET or DELETE support the Query and Head positions. APIs generated by registration whose request method is PUT or POST support the Query, Head, and Body positions.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ParameterDescription' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'description1', - ], - 'DefaultValue' => [ - 'description' => 'The default value.'."\n", - 'type' => 'string', - 'example' => 'default1', - ], - 'ParameterOperator' => [ - 'description' => 'The operator used for the value of the parameter. Valid values:'."\n" - ."\n" - .'* 0: Equal'."\n" - .'* 1: Like'."\n" - .'* 2: Const'."\n" - .'* 3: In'."\n" - ."\n" - .'APIs generated in wizard mode support the Equal, Like, and In operators. APIs generated in script mode support the Equal operator. APIs generated by registration support the Equal and Const operators.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ExampleValue' => [ - 'description' => 'The sample value.'."\n", - 'type' => 'string', - 'example' => 'example1', - ], - 'ParameterDataType' => [ - 'description' => 'The data type of the parameter. Valid values:'."\n" - ."\n" - .'* 0: String'."\n" - .'* 1: Int'."\n" - .'* 2: Long'."\n" - .'* 3: Float'."\n" - .'* 4: Double'."\n" - .'* 5: Boolean'."\n" - ."\n" - .'Advanced scripts also support the following data types:'."\n" - ."\n" - .'* 6: StringList'."\n" - .'* 7: IntList'."\n" - .'* 8: LongList'."\n" - .'* 9: FloatList'."\n" - .'* 10: DoubleList'."\n" - .'* 11: BooleanList'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'IsRequiredParameter' => [ - 'description' => 'Indicates whether the request parameter is required.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'ParameterName' => ['description' => 'The name of the parameter.', 'type' => 'string', 'example' => 'param1', 'title' => ''], + 'ParameterPosition' => ['description' => 'The position of the parameter. Valid values:'."\n" + ."\n" + .'- 0: indicates that the parameter is in the URL path of the request.'."\n" + ."\n" + .'- 1: indicates that the parameter is in the Query parameter of the request URL.'."\n" + ."\n" + .'- 2: indicates that the parameter is in the request header.'."\n" + ."\n" + .'- 3: indicates that the parameter is in the request body.'."\n" + ."\n" + .'APIs generated in wizard or script mode support only the Query position. APIs generated by registration whose request method is GET or DELETE support the Query and Head positions. APIs generated by registration whose request method is PUT or POST support the Query, Head, and Body positions.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ParameterDescription' => ['description' => 'The description.', 'type' => 'string', 'example' => 'description1', 'title' => ''], + 'DefaultValue' => ['description' => 'The default value.', 'type' => 'string', 'example' => 'default1', 'title' => ''], + 'ParameterOperator' => ['description' => 'The operator used for the value of the parameter. Valid values:'."\n" + ."\n" + .'- 0: Equal'."\n" + ."\n" + .'- 1: Like'."\n" + ."\n" + .'- 2: Const'."\n" + ."\n" + .'- 3: In'."\n" + ."\n" + .'APIs generated in wizard mode support the Equal, Like, and In operators. APIs generated in script mode support the Equal operator. APIs generated by registration support the Equal and Const operators.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ExampleValue' => ['description' => 'The sample value.', 'type' => 'string', 'example' => 'example1', 'title' => ''], + 'ParameterDataType' => ['description' => 'The data type of the parameter. Valid values:'."\n" + ."\n" + .'- 0: String'."\n" + ."\n" + .'- 1: Int'."\n" + ."\n" + .'- 2: Long'."\n" + ."\n" + .'- 3: Float'."\n" + ."\n" + .'- 4: Double'."\n" + ."\n" + .'- 5: Boolean'."\n" + ."\n" + .'Advanced scripts also support the following data types:'."\n" + ."\n" + .'- 6: StringList'."\n" + ."\n" + .'- 7: IntList'."\n" + ."\n" + .'- 8: LongList'."\n" + ."\n" + .'- 9: FloatList'."\n" + ."\n" + .'- 10: DoubleList'."\n" + ."\n" + .'- 11: BooleanList', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'IsRequiredParameter' => ['description' => 'Indicates whether the request parameter is required.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], 'ScriptResponseParameters' => [ - 'description' => 'The response parameters of the API generated in script mode.'."\n", + 'description' => 'The response parameters of the API generated in script mode.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'ParameterDescription' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'description2', - ], - 'ParameterName' => [ - 'description' => 'The name of the parameter.'."\n", - 'type' => 'string', - 'example' => 'param2', - ], - 'ExampleValue' => [ - 'description' => 'The sample value.'."\n", - 'type' => 'string', - 'example' => 'example2', - ], - 'ParameterDataType' => [ - 'description' => 'The data type of the parameter. Valid values:'."\n" - ."\n" - .'* 0: String'."\n" - .'* 1: Int'."\n" - .'* 2: Long'."\n" - .'* 3: Float'."\n" - .'* 4: Double'."\n" - .'* 5: Boolean'."\n" - .'* 6: StringList'."\n" - .'* 7: IntList'."\n" - .'* 8: LongList'."\n" - .'* 9: FloatList'."\n" - .'* 10: DoubleList'."\n" - .'* 11: BooleanList'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], + 'ParameterDescription' => ['description' => 'The description.', 'type' => 'string', 'example' => 'description2', 'title' => ''], + 'ParameterName' => ['description' => 'The name of the parameter.', 'type' => 'string', 'example' => 'param2', 'title' => ''], + 'ExampleValue' => ['description' => 'The sample value.', 'type' => 'string', 'example' => 'example2', 'title' => ''], + 'ParameterDataType' => ['description' => 'The data type of the parameter. Valid values:'."\n" + ."\n" + .'- 0: String'."\n" + ."\n" + .'- 1: Int'."\n" + ."\n" + .'- 2: Long'."\n" + ."\n" + .'- 3: Float'."\n" + ."\n" + .'- 4: Double'."\n" + ."\n" + .'- 5: Boolean'."\n" + ."\n" + .'- 6: StringList'."\n" + ."\n" + .'- 7: IntList'."\n" + ."\n" + .'- 8: LongList'."\n" + ."\n" + .'- 9: FloatList'."\n" + ."\n" + .'- 10: DoubleList'."\n" + ."\n" + .'- 11: BooleanList', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], 'ScriptConnection' => [ - 'description' => 'The data source information about the API generated in script mode.'."\n", + 'description' => 'The data source information about the API generated in script mode.', 'type' => 'object', 'properties' => [ - 'TableName' => [ - 'description' => 'The name of the table in the data source.'."\n", - 'type' => 'string', - 'example' => 't', - ], - 'ConnectionId' => [ - 'description' => 'The data source ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], + 'TableName' => ['description' => 'The name of the table in the data source.', 'type' => 'string', 'example' => 't', 'title' => ''], + 'ConnectionId' => ['description' => 'The data source ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], 'WizardDetails' => [ - 'description' => 'The details of the API generated in wizard mode. This parameter is returned only if the API is generated in wizard mode.'."\n", + 'description' => 'The details of the API generated in wizard mode. This parameter is returned only if the API is generated in wizard mode.', 'type' => 'object', 'properties' => [ - 'IsPagedResponse' => [ - 'description' => 'Indicates whether the entries are returned by page.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'SuccessfulResultSample' => [ - 'description' => 'The sample success response of the API.'."\n", - 'type' => 'string', - 'example' => '{"success": true}', - ], - 'FailedResultSample' => [ - 'description' => 'The sample error response of the API.'."\n", - 'type' => 'string', - 'example' => '{"success": false}', - ], + 'IsPagedResponse' => ['description' => 'Indicates whether the entries are returned by page.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'SuccessfulResultSample' => ['description' => 'The sample success response of the API.', 'type' => 'string', 'example' => '{"success": true}', 'title' => ''], + 'FailedResultSample' => ['description' => 'The sample error response of the API.', 'type' => 'string', 'example' => '{"success": false}', 'title' => ''], 'WizardErrorCodes' => [ - 'description' => 'The error codes returned for the API generated in wizard mode.'."\n", + 'description' => 'The error codes returned for the API generated in wizard mode.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'fail to call', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '1001', - ], - 'ErrorSolution' => [ - 'description' => 'The solution used to fix the error.'."\n", - 'type' => 'string', - 'example' => 'retry', - ], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'fail to call', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '1001', 'title' => ''], + 'ErrorSolution' => ['description' => 'The solution used to fix the error.', 'type' => 'string', 'example' => 'retry', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], 'WizardRequestParameters' => [ - 'description' => 'The request parameters of the API generated in wizard mode.'."\n", + 'description' => 'The request parameters of the API generated in wizard mode.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'ParameterName' => [ - 'description' => 'The name of the parameter.'."\n", - 'type' => 'string', - 'example' => 'param1', - ], - 'ParameterPosition' => [ - 'description' => 'The position of the parameter. Valid values: 0, 1, 2, and 3. The value 0 indicates that the parameter is in the URL path of the request. The value 1 indicates that the parameter is in the Query parameter of the request URL. The value 2 indicates that the parameter is in the request header. The value 3 indicates that the parameter is in the request body. APIs generated in wizard or script mode support only the Query position. APIs generated by registration whose request method is GET or DELETE support the Query and Head positions. APIs generated by registration whose request method is PUT or POST support the Query, Head, and Body positions.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ParameterDescription' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'description1', - ], - 'DefaultValue' => [ - 'description' => 'The default value.'."\n", - 'type' => 'string', - 'example' => 'default1', - ], - 'ParameterOperator' => [ - 'description' => 'The operator used for the value of the parameter. Valid values: 0, 1, 2, and 3. The value 0 indicates the Equal operator. The value 1 indicates the Like operator. The value 2 indicates the Const operator. The value 3 indicates the In operator. APIs generated in wizard mode support the Equal, Like, and In operators. APIs generated in script mode support the Equal operator. APIs generated by registration support the Equal and Const operators.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ExampleValue' => [ - 'description' => 'The sample value.'."\n", - 'type' => 'string', - 'example' => 'example1', - ], - 'ParameterDataType' => [ - 'description' => 'The data type of the parameter. Valid values:'."\n" - ."\n" - .'* 0: String'."\n" - .'* 1: Int'."\n" - .'* 2: Long'."\n" - .'* 3: Float'."\n" - .'* 4: Double'."\n" - .'* 5: Boolean'."\n" - .'* 6: StringList'."\n" - .'* 7: IntList'."\n" - .'* 8: LongList'."\n" - .'* 9: FloatList'."\n" - .'* 10: DoubleList'."\n" - .'* 11: BooleanList'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'IsRequiredParameter' => [ - 'description' => 'Indicates whether the request parameter is required.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'ParameterName' => ['description' => 'The name of the parameter.', 'type' => 'string', 'example' => 'param1', 'title' => ''], + 'ParameterPosition' => ['description' => 'The position of the parameter. Valid values: 0, 1, 2, and 3. The value 0 indicates that the parameter is in the URL path of the request. The value 1 indicates that the parameter is in the Query parameter of the request URL. The value 2 indicates that the parameter is in the request header. The value 3 indicates that the parameter is in the request body. APIs generated in wizard or script mode support only the Query position. APIs generated by registration whose request method is GET or DELETE support the Query and Head positions. APIs generated by registration whose request method is PUT or POST support the Query, Head, and Body positions.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ParameterDescription' => ['description' => 'The description.', 'type' => 'string', 'example' => 'description1', 'title' => ''], + 'DefaultValue' => ['description' => 'The default value.', 'type' => 'string', 'example' => 'default1', 'title' => ''], + 'ParameterOperator' => ['description' => 'The operator used for the value of the parameter. Valid values: 0, 1, 2, and 3. The value 0 indicates the Equal operator. The value 1 indicates the Like operator. The value 2 indicates the Const operator. The value 3 indicates the In operator. APIs generated in wizard mode support the Equal, Like, and In operators. APIs generated in script mode support the Equal operator. APIs generated by registration support the Equal and Const operators.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ExampleValue' => ['description' => 'The sample value.', 'type' => 'string', 'example' => 'example1', 'title' => ''], + 'ParameterDataType' => ['description' => 'The data type of the parameter. Valid values:'."\n" + ."\n" + .'- 0: String'."\n" + ."\n" + .'- 1: Int'."\n" + ."\n" + .'- 2: Long'."\n" + ."\n" + .'- 3: Float'."\n" + ."\n" + .'- 4: Double'."\n" + ."\n" + .'- 5: Boolean'."\n" + ."\n" + .'- 6: StringList'."\n" + ."\n" + .'- 7: IntList'."\n" + ."\n" + .'- 8: LongList'."\n" + ."\n" + .'- 9: FloatList'."\n" + ."\n" + .'- 10: DoubleList'."\n" + ."\n" + .'- 11: BooleanList', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'IsRequiredParameter' => ['description' => 'Indicates whether the request parameter is required.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], 'WizardResponseParameters' => [ - 'description' => 'The response parameters of the API generated in wizard mode.'."\n", + 'description' => 'The response parameters of the API generated in wizard mode.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'ParameterDescription' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'description2', - ], - 'ParameterName' => [ - 'description' => 'The name of the parameter.'."\n", - 'type' => 'string', - 'example' => 'param2', - ], - 'ExampleValue' => [ - 'description' => 'The sample value.'."\n", - 'type' => 'string', - 'example' => 'example2', - ], - 'ParameterDataType' => [ - 'description' => 'The data type of the parameter. Valid values:'."\n" - ."\n" - .'* 0: String'."\n" - .'* 1: Int'."\n" - .'* 2: Long'."\n" - .'* 3: Float'."\n" - .'* 4: Double'."\n" - .'* 5: Boolean'."\n" - .'* 6: StringList'."\n" - .'* 7: IntList'."\n" - .'* 8: LongList'."\n" - .'* 9: FloatList'."\n" - .'* 10: DoubleList'."\n" - .'* 11: BooleanList'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], + 'ParameterDescription' => ['description' => 'The description.', 'type' => 'string', 'example' => 'description2', 'title' => ''], + 'ParameterName' => ['description' => 'The name of the parameter.', 'type' => 'string', 'example' => 'param2', 'title' => ''], + 'ExampleValue' => ['description' => 'The sample value.', 'type' => 'string', 'example' => 'example2', 'title' => ''], + 'ParameterDataType' => ['description' => 'The data type of the parameter. Valid values:'."\n" + ."\n" + .'- 0: String'."\n" + ."\n" + .'- 1: Int'."\n" + ."\n" + .'- 2: Long'."\n" + ."\n" + .'- 3: Float'."\n" + ."\n" + .'- 4: Double'."\n" + ."\n" + .'- 5: Boolean'."\n" + ."\n" + .'- 6: StringList'."\n" + ."\n" + .'- 7: IntList'."\n" + ."\n" + .'- 8: LongList'."\n" + ."\n" + .'- 9: FloatList'."\n" + ."\n" + .'- 10: DoubleList'."\n" + ."\n" + .'- 11: BooleanList', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], 'WizardConnection' => [ - 'description' => 'The data source information about the API generated in wizard mode.'."\n", + 'description' => 'The data source information about the API generated in wizard mode.', 'type' => 'object', - 'properties' => [ - 'TableName' => [ - 'description' => 'The name of the table in the data source.'."\n", - 'type' => 'string', - 'example' => 't', - ], - 'ConnectionId' => [ - 'description' => 'The ID of the data source.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], + 'properties' => [ + 'TableName' => ['description' => 'The name of the table in the data source.', 'type' => 'string', 'example' => 't', 'title' => ''], + 'ConnectionId' => ['description' => 'The ID of the data source.', 'type' => 'integer', 'format' => 'int64', 'example' => '12354', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], - 'SqlMode' => [ - 'title' => 'SQL模式，0：基础SQL；1：高级SQL', - 'description' => 'SQL mode. 0: Basic SQL; 1: Advanced SQL.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], + 'SqlMode' => ['description' => 'SQL mode. 0: Basic SQL; 1: Advanced SQL.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Apis\\": [\\n {\\n \\"Timeout\\": 10000,\\n \\"Status\\": 1,\\n \\"ApiId\\": 10002,\\n \\"ApiMode\\": 0,\\n \\"ProjectId\\": 10000,\\n \\"ResponseContentType\\": 0,\\n \\"CreatorId\\": \\"1234567\\",\\n \\"VisibleRange\\": 0,\\n \\"ModifiedTime\\": \\"2020-06-23T00:21:01+0800\\",\\n \\"OperatorId\\": \\"2345678\\",\\n \\"GroupId\\": \\"ab123\\",\\n \\"Description\\": \\"Test API description\\",\\n \\"RequestMethod\\": 0,\\n \\"CreatedTime\\": \\"2020-06-23T00:21:01+0800\\",\\n \\"ApiName\\": \\"My API name\\",\\n \\"TenantId\\": 10001,\\n \\"ApiPath\\": \\"/test/1\\",\\n \\"Protocols\\": [\\n 0\\n ],\\n \\"RegistrationDetails\\": {\\n \\"ServiceHost\\": \\"http://www.abc.com\\",\\n \\"ServiceContentType\\": 0,\\n \\"ServicePath\\": \\"/index\\",\\n \\"SuccessfulResultSample\\": \\"{\\\\\\"success\\\\\\": true}\\",\\n \\"FailedResultSample\\": \\"{\\\\\\"success\\\\\\": false}\\",\\n \\"ServiceRequestBodyDescription\\": \\"{\\\\\\"abc\\\\\\":1}\\",\\n \\"RegistrationErrorCodes\\": [\\n {\\n \\"ErrorMessage\\": \\"fail to call\\",\\n \\"ErrorCode\\": \\"1001\\",\\n \\"ErrorSolution\\": \\"retry\\"\\n }\\n ],\\n \\"RegistrationRequestParameters\\": [\\n {\\n \\"ParameterName\\": \\"name1\\",\\n \\"ParameterPosition\\": 0,\\n \\"ParameterDescription\\": \\"description1\\",\\n \\"DefaultValue\\": \\"default1\\",\\n \\"ParameterOperator\\": 0,\\n \\"ExampleValue\\": \\"example1\\",\\n \\"ParameterDataType\\": 0,\\n \\"IsRequiredParameter\\": true\\n }\\n ]\\n },\\n \\"ScriptDetails\\": {\\n \\"IsPagedResponse\\": true,\\n \\"SuccessfulResultSample\\": \\"{\\\\\\"success\\\\\\": true}\\",\\n \\"FailedResultSample\\": \\"{\\\\\\"success\\\\\\": false}\\",\\n \\"Script\\": \\"select a from t\\",\\n \\"ScriptErrorCodes\\": [\\n {\\n \\"ErrorMessage\\": \\"fail to call\\",\\n \\"ErrorCode\\": \\"1001\\",\\n \\"ErrorSolution\\": \\"retry\\"\\n }\\n ],\\n \\"ScriptRequestParameters\\": [\\n {\\n \\"ParameterName\\": \\"param1\\",\\n \\"ParameterPosition\\": 0,\\n \\"ParameterDescription\\": \\"description1\\",\\n \\"DefaultValue\\": \\"default1\\",\\n \\"ParameterOperator\\": 0,\\n \\"ExampleValue\\": \\"example1\\",\\n \\"ParameterDataType\\": 0,\\n \\"IsRequiredParameter\\": true\\n }\\n ],\\n \\"ScriptResponseParameters\\": [\\n {\\n \\"ParameterDescription\\": \\"description2\\",\\n \\"ParameterName\\": \\"param2\\",\\n \\"ExampleValue\\": \\"example2\\",\\n \\"ParameterDataType\\": 0\\n }\\n ],\\n \\"ScriptConnection\\": {\\n \\"TableName\\": \\"t\\",\\n \\"ConnectionId\\": 123\\n }\\n },\\n \\"WizardDetails\\": {\\n \\"IsPagedResponse\\": true,\\n \\"SuccessfulResultSample\\": \\"{\\\\\\"success\\\\\\": true}\\",\\n \\"FailedResultSample\\": \\"{\\\\\\"success\\\\\\": false}\\",\\n \\"WizardErrorCodes\\": [\\n {\\n \\"ErrorMessage\\": \\"fail to call\\",\\n \\"ErrorCode\\": \\"1001\\",\\n \\"ErrorSolution\\": \\"retry\\"\\n }\\n ],\\n \\"WizardRequestParameters\\": [\\n {\\n \\"ParameterName\\": \\"param1\\",\\n \\"ParameterPosition\\": 0,\\n \\"ParameterDescription\\": \\"description1\\",\\n \\"DefaultValue\\": \\"default1\\",\\n \\"ParameterOperator\\": 0,\\n \\"ExampleValue\\": \\"example1\\",\\n \\"ParameterDataType\\": 0,\\n \\"IsRequiredParameter\\": true\\n }\\n ],\\n \\"WizardResponseParameters\\": [\\n {\\n \\"ParameterDescription\\": \\"description2\\",\\n \\"ParameterName\\": \\"param2\\",\\n \\"ExampleValue\\": \\"example2\\",\\n \\"ParameterDataType\\": 0\\n }\\n ],\\n \\"WizardConnection\\": {\\n \\"TableName\\": \\"t\\",\\n \\"ConnectionId\\": 12354\\n }\\n },\\n \\"SqlMode\\": 0\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListDataServicePublishedApis', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => 'The details of different types of APIs are returned in different fields. Wizard APIs use the WizardDetails field, script APIs use the ScriptDetails field, and registration APIs use the RegistrationDetails field.', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-10-09T11:17:29.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'ListDataSources' => [ + 'summary' => 'Queries the data sources added to a DataWorks workspace.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list'], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the DataWorks workspace to which the data sources belong. You can call the [ListProjects](~~2780068~~) operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the data source that you want to query.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'DataSourceType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the data source. Valid values:'."\n" + ."\n" + .'* odps'."\n" + .'* mysql'."\n" + .'* rds'."\n" + .'* oss'."\n" + .'* sqlserver'."\n" + .'* polardb'."\n" + .'* oracle'."\n" + .'* mongodb'."\n" + .'* emr'."\n" + .'* postgresql'."\n" + .'* analyticdb_for_mysql'."\n" + .'* hybriddb_for_postgresql'."\n" + .'* holo'."\n", 'type' => 'string', 'required' => false, 'example' => 'rds', 'title' => ''], + ], + [ + 'name' => 'SubType', + 'in' => 'query', + 'schema' => ['description' => 'The subtype of the data source. This parameter takes effect only when the DataSourceType parameter is set to rds.'."\n" + ."\n" + .'If the value of the DataSourceType parameter is rds, the value of this parameter can be mysql, sqlserver, or postgresql.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mysql', 'title' => ''], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => 'The status of the data source. Valid values:'."\n" + ."\n" + .'* ENABLED'."\n" + .'* DISABLED'."\n", 'type' => 'string', 'required' => false, 'example' => 'ENABLED', 'title' => ''], + ], + [ + 'name' => 'EnvType', + 'in' => 'query', + 'schema' => ['description' => 'The environment in which the data source is used. Valid values: 0 and 1. The value 0 indicates development environment. The value 1 indicates production environment.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Pages start from page 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0bc14115159376359****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The query result returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of data sources.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '233', 'title' => ''], + 'DataSources' => [ + 'description' => 'The data sources.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the data source.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status of the data source. Valid values:'."\n" + ."\n" + .'* 1: The data source is accessible.'."\n" + .'* 2: The data source is inaccessible.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ProjectId' => ['description' => 'The ID of the workspace to which the data source belongs.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '123', 'title' => ''], + 'SubType' => ['description' => 'The subtype of the data source. This parameter takes effect only when the DataSourceType parameter is set to rds.'."\n", 'type' => 'string', 'example' => 'mysql', 'title' => ''], + 'GmtModified' => ['description' => 'The time when the data source was last modified. Example: Mar 17, 2021 4:09:32 PM.'."\n", 'type' => 'string', 'example' => 'Mar 17, 2021 4:09:32 PM', 'title' => ''], + 'EnvType' => ['description' => 'The environment in which the data source is used. Valid values:'."\n" + ."\n" + .'* 0: development environment'."\n" + .'* 1: production environment'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ConnectStatus' => ['description' => 'The status of the data source. Valid values:'."\n" + ."\n" + .'* 1: The data source is accessible.'."\n" + .'* 2: The data source is inaccessible.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Sequence' => ['description' => 'The sequence number of the data source. Data sources are sorted in descending order based on the value of this parameter.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '300', 'title' => ''], + 'Description' => ['description' => 'The description of the data source.'."\n", 'type' => 'string', 'example' => 'a connection', 'title' => ''], + 'DataSourceType' => ['description' => 'The type of the data source. Valid values:'."\n" + ."\n" + .'* odps'."\n" + .'* mysql'."\n" + .'* rds'."\n" + .'* oss'."\n" + .'* sqlserver'."\n" + .'* polardb'."\n" + .'* oracle'."\n" + .'* mongodb'."\n" + .'* emr'."\n" + .'* postgresql'."\n" + .'* analyticdb_for_mysql'."\n" + .'* hybriddb_for_postgresql'."\n" + .'* holo'."\n", 'type' => 'string', 'example' => 'rds', 'title' => ''], + 'GmtCreate' => ['description' => 'The time when the data source was created. Example: Mar 17, 2021 4:09:32 PM.'."\n", 'type' => 'string', 'example' => 'Mar 17, 2021 4:09:32 PM', 'title' => ''], + 'DefaultEngine' => ['description' => 'Indicates whether the compute engine that is associated with the data source is the default compute engine used by data sources of the same type.'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Shared' => ['description' => 'Indicates whether the data source is a shared data source.'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Operator' => ['description' => 'The ID of the Alibaba Cloud account that is used to last modify the data source.'."\n", 'type' => 'string', 'example' => '193543050****', 'title' => ''], + 'Name' => ['description' => 'The name of the data source.'."\n", 'type' => 'string', 'example' => 'abc', 'title' => ''], + 'Content' => ['description' => 'The data connection string. The value of this parameter is in the JSON format. Examples of connection strings of common data sources:'."\n" + ."\n" + .'* MaxCompute'."\n" + ."\n" + .' {'."\n" + .' "pubEndpoint": "http://service.cn.maxcompute.aliyun.com/api",'."\n" + .' "accessId": "xxxxxxx",'."\n" + .' "securityToken": null,'."\n" + .' "endpoint": "http://service.cn.maxcompute.aliyun-inc.com/api",'."\n" + .' "accessKey": "***",'."\n" + .' "name": "PRE_PROJECT_A_engine",'."\n" + .' "project": "PRE_PROJECT_A",'."\n" + .' "vpcEndpoint": "http://service.cn.maxcompute.aliyun-inc.com/api",'."\n" + .' "region": "cn-shanghai",'."\n" + .' "authType": "2"'."\n" + .' }'."\n" + ."\n" + .'* mysql'."\n" + ."\n" + .' {'."\n" + .' "configType": "1",'."\n" + .' "database": "mysql_d111b",'."\n" + .' "instanceName": "rm-xxxxxx",'."\n" + .' "password": "***",'."\n" + .' "rdsOwnerId": "12133xxxxxx",'."\n" + .' "tag": "rds",'."\n" + .' "username": "mysql_db111"'."\n" + .' }'."\n" + ."\n" + .'* sqlserver'."\n" + ."\n" + .' {'."\n" + .' "configType": "1",'."\n" + .' "jdbcUrl": "jdbc:sqlserver://rm-xxxxx.sqlserver.rds.aliyuncs.com:1433;DatabaseName=sqlserver_db1",'."\n" + .' "password": "***",'."\n" + .' "tag": "public",'."\n" + .' "username": "sqlserver_db111"'."\n" + .' }'."\n" + ."\n" + .'* oss'."\n" + ."\n" + .' {'."\n" + .' "accessId": "***********",'."\n" + .' "accessKey": "***********",'."\n" + .' "bucket": "bigxxx1223",'."\n" + .' "configType": "1",'."\n" + .' "endpoint": "http://oss-cn-hangzhou.aliyuncs.com",'."\n" + .' "tag": "public"'."\n" + .' }'."\n" + ."\n" + .'* postgresql'."\n" + ."\n" + .' {'."\n" + .' "configType": "1",'."\n" + .' "database": "cdp_xxx",'."\n" + .' "instanceName": "rm-xxxx",'."\n" + .' "password": "***",'."\n" + .' "rdsOwnerId": "121xxxxx",'."\n" + .' "tag": "rds",'."\n" + .' "username": "cdp_xxx"'."\n" + .' }'."\n" + ."\n" + .'* ads'."\n" + ."\n" + .' {'."\n" + .' "configType": "1",'."\n" + .' "password": "***",'."\n" + .' "schema": "ads_demo",'."\n" + .' "tag": "public",'."\n" + .' "url": "ads-xxx-xxxx.cn-hangzhou-1.ads.aliyuncs.com:3029",'."\n" + .' "username": "lslslsls"'."\n" + .' }'."\n", 'type' => 'string', 'example' => '{"pubEndpoint":"http://service.cn.maxcompute.aliyun.com/api","accessId":"TMP.3KecGjvzy3i8MYfn2BGHgF7EHGyBFZcHm7GgngrABVRyvvKQrfF5kskR36xP361C3dqwbGo7SGYptAeGyiTwHXqLaBUvYC","securityToken":null,"endpoint":"http://service.cn.maxcompute.aliyun-inc.com/api","accessKey":"***","name":"PRE_PROJECT_A_engine","project":"PRE_PROJECT_A","vpcEndpoint":"http://service.cn.maxcompute.aliyun-inc.com/api","region":"cn-shanghai","authType":"2"}', 'title' => ''], + 'Id' => ['description' => 'The data source ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'BindingCalcEngineId' => ['description' => 'The ID of the compute engine with which the data source is associated.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'TenantId' => ['description' => 'The tenant ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234567', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Invalid.Tenant.ConnectionNotExists', 'errorMessage' => 'The connection does not exist.', 'description' => 'The connection does not exist.'], + ['errorCode' => 'Invalid.Tenant.ProjectNotExists', 'errorMessage' => 'The project does not exist.', 'description' => 'The project does not exist.'], + ['errorCode' => 'Invalid.Tenant.UserNotInProject', 'errorMessage' => 'The user is not in the project.', 'description' => 'The user is not in the project.'], + ], + 403 => [ + ['errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin', 'errorMessage' => 'The user is not a project administrator or owner.', 'description' => 'The user is not a project administrator or owner.'], + ['errorCode' => 'Invalid.Tenant.UserNotInTenant', 'errorMessage' => 'The user is not in tenant.', 'description' => 'The user is not in tenant.'], + ], + ], + 'title' => 'ListDataSources', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-06-05T02:35:20.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-07-12T07:42:06.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0bc14115159376359****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 233,\\n \\"DataSources\\": [\\n {\\n \\"Status\\": 1,\\n \\"ProjectId\\": 123,\\n \\"SubType\\": \\"mysql\\",\\n \\"GmtModified\\": \\"Mar 17, 2021 4:09:32 PM\\",\\n \\"EnvType\\": 1,\\n \\"ConnectStatus\\": 1,\\n \\"Sequence\\": 300,\\n \\"Description\\": \\"a connection\\",\\n \\"DataSourceType\\": \\"rds\\",\\n \\"GmtCreate\\": \\"Mar 17, 2021 4:09:32 PM\\",\\n \\"DefaultEngine\\": false,\\n \\"Shared\\": false,\\n \\"Operator\\": \\"193543050****\\",\\n \\"Name\\": \\"abc\\",\\n \\"Content\\": \\"{\\\\\\"pubEndpoint\\\\\\":\\\\\\"http://service.cn.maxcompute.aliyun.com/api\\\\\\",\\\\\\"accessId\\\\\\":\\\\\\"TMP.3KecGjvzy3i8MYfn2BGHgF7EHGyBFZcHm7GgngrABVRyvvKQrfF5kskR36xP361C3dqwbGo7SGYptAeGyiTwHXqLaBUvYC\\\\\\",\\\\\\"securityToken\\\\\\":null,\\\\\\"endpoint\\\\\\":\\\\\\"http://service.cn.maxcompute.aliyun-inc.com/api\\\\\\",\\\\\\"accessKey\\\\\\":\\\\\\"***\\\\\\",\\\\\\"name\\\\\\":\\\\\\"PRE_PROJECT_A_engine\\\\\\",\\\\\\"project\\\\\\":\\\\\\"PRE_PROJECT_A\\\\\\",\\\\\\"vpcEndpoint\\\\\\":\\\\\\"http://service.cn.maxcompute.aliyun-inc.com/api\\\\\\",\\\\\\"region\\\\\\":\\\\\\"cn-shanghai\\\\\\",\\\\\\"authType\\\\\\":\\\\\\"2\\\\\\"}\\",\\n \\"Id\\": 1,\\n \\"BindingCalcEngineId\\": 123,\\n \\"TenantId\\": 1234567\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListDeployments' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '100712', + 'abilityTreeNodes' => ['FEATUREdide8FM783'], + ], + 'parameters' => [ + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the workspace name.'."\n" + ."\n" + .'You must configure either this parameter or the ProjectId parameter to determine the DataWorks workspace to which the operation is applied.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dw_project'], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the workspace ID.'."\n" + ."\n" + .'You must configure either this parameter or the ProjectIdentifier parameter to determine the DataWorks workspace to which the operation is applied.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000'], + ], + [ + 'name' => 'Creator', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the Alibaba Cloud account used by the user who creates the deployment packages.'."\n", 'type' => 'string', 'required' => false, 'example' => '20030****'], + ], + [ + 'name' => 'EndCreateTime', + 'in' => 'formData', + 'schema' => ['description' => 'The time when the deployment packages to be queried are created. This value must be a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1593877765000'], + ], + [ + 'name' => 'Executor', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the Alibaba Cloud account used by the user who runs the deployment packages.'."\n", 'type' => 'string', 'required' => false, 'example' => '2003****'], + ], + [ + 'name' => 'EndExecuteTime', + 'in' => 'formData', + 'schema' => ['description' => 'The time when the deployment packages are run. This value must be a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1593877765000'], + ], + [ + 'name' => 'Status', + 'in' => 'formData', + 'schema' => ['description' => 'The status of the deployment packages. Valid values:'."\n" + ."\n" + .'* 0: The deployment packages are ready.'."\n" + .'* 1: The deployment packages are deployed.'."\n" + .'* 2: The deployment packages fail to be deployed.'."\n" + .'* 6: The deployment packages are rejected.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'Keyword', + 'in' => 'formData', + 'schema' => ['description' => 'The keyword that is contained in the names of the deployment packages. A fuzzy search is supported. After you enter a keyword, all deployment packages whose names contain the keyword are displayed.'."\n", 'type' => 'string', 'required' => false, 'example' => 'hello'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'example' => '20'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0000-ABCD-EFG'], + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '13'], + 'Deployments' => [ + 'description' => 'The deployment packages.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status of the deployment package. Valid values:'."\n" + ."\n" + .'* 0: The deployment package is ready.'."\n" + .'* 1: The deployment package is deployed.'."\n" + .'* 2: The deployment package fails to be deployed.'."\n" + .'* 6: The deployment package is rejected.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'ErrorMessage' => ['description' => 'The error message returned when the deployment package failed.'."\n", 'type' => 'string', 'example' => 'OK'], + 'CreateTime' => ['description' => 'The time when the deployment package was created.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1593877765000'], + 'Executor' => ['description' => 'The ID of the Alibaba Cloud account used by the user who ran the deployment package.'."\n", 'type' => 'string', 'example' => '2003****'], + 'Creator' => ['description' => 'The ID of the Alibaba Cloud account used by the user who created the deployment package.'."\n", 'type' => 'string', 'example' => '2003****'], + 'ExecuteTime' => ['description' => 'The time when the deployment package was run. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1593877765000'], + 'Name' => ['description' => 'The name of the deployment package.'."\n", 'type' => 'string', 'example' => 'auto_created'], + 'Id' => ['description' => 'The deployment package ID. You can call the [GetDeployment](~~173950~~) operation to obtain the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '11111'], + ], ], ], ], ], ], - 'description' => '', ], ], ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 13,\\n \\"Deployments\\": [\\n {\\n \\"Status\\": 1,\\n \\"ErrorMessage\\": \\"OK\\",\\n \\"CreateTime\\": 1593877765000,\\n \\"Executor\\": \\"2003****\\",\\n \\"Creator\\": \\"2003****\\",\\n \\"ExecuteTime\\": 1593877765000,\\n \\"Name\\": \\"auto_created\\",\\n \\"Id\\": 11111\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 0000-ABCD-EFG\\n \\n 1\\n 10\\n 13\\n \\n 1\\n OK\\n 1593877765000\\n 2003****\\n 2003****\\n 1593877765000\\n auto_created\\n 11111\\n \\n \\n","errorExample":""}]', + 'title' => 'ListDeployments', + 'summary' => 'Queries a list of deployment packages. This operation is equivalent to viewing a list of deployment packages on the Deployment Packages page of the DataWorks console.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDeployments'], + ], + ], + 'ramActions' => [], + ], + 'ListEnabledExtensionsForProject' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '158027', + 'abilityTreeNodes' => ['FEATUREdideRWC5F7'], + ], + 'parameters' => [ + [ + 'name' => 'EventCode', + 'in' => 'formData', + 'schema' => ['description' => 'The code of the extension point event.'."\n", 'type' => 'string', 'required' => true, 'example' => 'commit-file'], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console?spm=a2c4g.11186623.0.0.6b4d4941azHd2k) and go to the Workspace page to obtain the workspace ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000'], + ], + [ + 'name' => 'FileType', + 'in' => 'formData', + 'schema' => ['description' => 'The type of the code for the file.'."\n" + ."\n" + .'Valid values: 6 (Shell), 10 (ODPS SQL), 11 (ODPS MR), 24 (ODPS Script), 99 (zero load), 221 (PyODPS 2), 225 (ODPS Spark), 227 (EMR Hive), 228 (EMR Spark), 229 (EMR Spark SQL), 230 (EMR MR), 239 (OSS object inspection), 257 (EMR Shell), 258 (EMR Spark Shell), 259 (EMR Presto), 260 (EMR Impala), 900 (real-time synchronization), 1089 (cross-tenant collaboration), 1091 (Hologres development), 1093 (Hologres SQL), 1100 (assignment), and 1221 (PyODPS 3).'."\n" + ."\n" + .'You can call the [ListFileType](~~212428~~) operation to query the type of the code for the file.'."\n", 'type' => 'string', 'required' => false, 'example' => '10'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '4F2CA7ED-27E5-59EA-A8C4-F1F7A1FF0B22'], + 'Extensions' => [ + 'description' => 'The extensions.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The extensions.'."\n", + 'type' => 'object', + 'properties' => [ + 'ExtensionCode' => ['description' => 'The unique code of the extension.'."\n", 'type' => 'string', 'example' => 'a94a8e23bc0b4dfab9a5e4d2f374d645'], + 'ExtensionName' => ['description' => 'The name of the extension.'."\n", 'type' => 'string', 'example' => 'max_pt function is not allowed.'], + 'TenantId' => ['description' => 'The tenant ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '529889518659842'], + 'CreateUser' => ['description' => 'The creator of the extension.'."\n", 'type' => 'string', 'example' => '3444434343555'], + 'ModifyUser' => ['description' => 'The modifier of the extension.'."\n", 'type' => 'string', 'example' => '34452335611988'], + 'ExtensionDesc' => ['description' => 'The description of the extension.'."\n", 'type' => 'string', 'example' => 'ODPS SQL compatible Spark engine detection'], + 'Owner' => ['description' => 'The owner ID.'."\n", 'type' => 'string', 'example' => '21323672*******55500'], + 'ParameterSetting' => ['description' => 'The parameter settings of the extension. For more information, see [Configure extension parameters](~~405354~~).'."\n", 'type' => 'string', 'example' => 'extension.fileType.23.deploy-file.enabled=true'], + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4F2CA7ED-27E5-59EA-A8C4-F1F7A1FF0B22\\",\\n \\"Extensions\\": [\\n {\\n \\"ExtensionCode\\": \\"a94a8e23bc0b4dfab9a5e4d2f374d645\\",\\n \\"ExtensionName\\": \\"max_pt function is not allowed.\\",\\n \\"TenantId\\": 0,\\n \\"CreateUser\\": \\"3444434343555\\",\\n \\"ModifyUser\\": \\"34452335611988\\",\\n \\"ExtensionDesc\\": \\"ODPS SQL compatible Spark engine detection\\",\\n \\"Owner\\": \\"21323672*******55500\\",\\n \\"ParameterSetting\\": \\"extension.fileType.23.deploy-file.enabled=true\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 4F2CA7ED-27E5-59EA-A8C4-F1F7A1FF0B22\\n \\n a94a8e23bc0b4dfab9a5e4d2f374d645\\n 不允许使用max_pt函数\\n 529889518659842\\n 3444434343555\\n 34452335611988\\n ODPS SQL兼容Spark引擎检测\\n 21323672*******55500\\n extension.fileType.23.deploy-file.enabled=true\\n 1660117173\\n 1569308162000\\n \\n","errorExample":""}]', + 'title' => 'ListEnabledExtensionsForProject', + 'summary' => 'Queries a list of built-in and custom extensions that are enabled in a workspace.', + 'description' => 'For information about codes of extension point events, see [Development references: Extension point event codes](~~463357~~).'."\n", + 'changeSet' => [ + ['createdAt' => '2023-12-11T11:39:12.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEnabledExtensionsForProject'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Apis\\": [\\n {\\n \\"Timeout\\": 10000,\\n \\"Status\\": 1,\\n \\"ApiId\\": 10002,\\n \\"ApiMode\\": 0,\\n \\"ProjectId\\": 10000,\\n \\"ResponseContentType\\": 0,\\n \\"CreatorId\\": \\"1234567\\",\\n \\"VisibleRange\\": 0,\\n \\"ModifiedTime\\": \\"2020-06-23T00:21:01+0800\\",\\n \\"OperatorId\\": \\"2345678\\",\\n \\"GroupId\\": \\"ab123\\",\\n \\"Description\\": \\"Test API description\\",\\n \\"RequestMethod\\": 0,\\n \\"CreatedTime\\": \\"2020-06-23T00:21:01+0800\\",\\n \\"ApiName\\": \\"My API name\\",\\n \\"TenantId\\": 10001,\\n \\"ApiPath\\": \\"/test/1\\",\\n \\"Protocols\\": [\\n 0\\n ],\\n \\"RegistrationDetails\\": {\\n \\"ServiceHost\\": \\"http://www.abc.com\\",\\n \\"ServiceContentType\\": 0,\\n \\"ServicePath\\": \\"/index\\",\\n \\"SuccessfulResultSample\\": \\"{\\\\\\"success\\\\\\": true}\\",\\n \\"FailedResultSample\\": \\"{\\\\\\"success\\\\\\": false}\\",\\n \\"ServiceRequestBodyDescription\\": \\"{\\\\\\"abc\\\\\\":1}\\",\\n \\"RegistrationErrorCodes\\": [\\n {\\n \\"ErrorMessage\\": \\"fail to call\\",\\n \\"ErrorCode\\": \\"1001\\",\\n \\"ErrorSolution\\": \\"retry\\"\\n }\\n ],\\n \\"RegistrationRequestParameters\\": [\\n {\\n \\"ParameterName\\": \\"name1\\",\\n \\"ParameterPosition\\": 0,\\n \\"ParameterDescription\\": \\"description1\\",\\n \\"DefaultValue\\": \\"default1\\",\\n \\"ParameterOperator\\": 0,\\n \\"ExampleValue\\": \\"example1\\",\\n \\"ParameterDataType\\": 0,\\n \\"IsRequiredParameter\\": true\\n }\\n ]\\n },\\n \\"ScriptDetails\\": {\\n \\"IsPagedResponse\\": true,\\n \\"SuccessfulResultSample\\": \\"{\\\\\\"success\\\\\\": true}\\",\\n \\"FailedResultSample\\": \\"{\\\\\\"success\\\\\\": false}\\",\\n \\"Script\\": \\"select a from t\\",\\n \\"ScriptErrorCodes\\": [\\n {\\n \\"ErrorMessage\\": \\"fail to call\\",\\n \\"ErrorCode\\": \\"1001\\",\\n \\"ErrorSolution\\": \\"retry\\"\\n }\\n ],\\n \\"ScriptRequestParameters\\": [\\n {\\n \\"ParameterName\\": \\"param1\\",\\n \\"ParameterPosition\\": 0,\\n \\"ParameterDescription\\": \\"description1\\",\\n \\"DefaultValue\\": \\"default1\\",\\n \\"ParameterOperator\\": 0,\\n \\"ExampleValue\\": \\"example1\\",\\n \\"ParameterDataType\\": 0,\\n \\"IsRequiredParameter\\": true\\n }\\n ],\\n \\"ScriptResponseParameters\\": [\\n {\\n \\"ParameterDescription\\": \\"description2\\",\\n \\"ParameterName\\": \\"param2\\",\\n \\"ExampleValue\\": \\"example2\\",\\n \\"ParameterDataType\\": 0\\n }\\n ],\\n \\"ScriptConnection\\": {\\n \\"TableName\\": \\"t\\",\\n \\"ConnectionId\\": 123\\n }\\n },\\n \\"WizardDetails\\": {\\n \\"IsPagedResponse\\": true,\\n \\"SuccessfulResultSample\\": \\"{\\\\\\"success\\\\\\": true}\\",\\n \\"FailedResultSample\\": \\"{\\\\\\"success\\\\\\": false}\\",\\n \\"WizardErrorCodes\\": [\\n {\\n \\"ErrorMessage\\": \\"fail to call\\",\\n \\"ErrorCode\\": \\"1001\\",\\n \\"ErrorSolution\\": \\"retry\\"\\n }\\n ],\\n \\"WizardRequestParameters\\": [\\n {\\n \\"ParameterName\\": \\"param1\\",\\n \\"ParameterPosition\\": 0,\\n \\"ParameterDescription\\": \\"description1\\",\\n \\"DefaultValue\\": \\"default1\\",\\n \\"ParameterOperator\\": 0,\\n \\"ExampleValue\\": \\"example1\\",\\n \\"ParameterDataType\\": 0,\\n \\"IsRequiredParameter\\": true\\n }\\n ],\\n \\"WizardResponseParameters\\": [\\n {\\n \\"ParameterDescription\\": \\"description2\\",\\n \\"ParameterName\\": \\"param2\\",\\n \\"ExampleValue\\": \\"example2\\",\\n \\"ParameterDataType\\": 0\\n }\\n ],\\n \\"WizardConnection\\": {\\n \\"TableName\\": \\"t\\",\\n \\"ConnectionId\\": 12354\\n }\\n },\\n \\"SqlMode\\": 0\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 0000-ABCD-EFG****\\n The connection does not exist.\\n true\\n Invalid.Tenant.ConnectionNotExists\\n \\n 1\\n 10\\n 100\\n \\n 10000\\n 1\\n 10002\\n 0\\n 10000\\n 0\\n 1234567\\n 0\\n 2020-06-23T00:21:01+0800\\n 2345678\\n ab123\\n 测试API描述\\n 0\\n 2020-06-23T00:21:01+0800\\n 我的API名称\\n 10001\\n /test/1\\n 0\\n \\n http://www.abc.com\\n 0\\n /index\\n {\\"success\\": true}\\n {\\"success\\": false}\\n {\\"abc\\":1}\\n \\n fail to call\\n 1001\\n retry\\n \\n \\n name1\\n 0\\n description1\\n default1\\n 0\\n example1\\n 0\\n true\\n \\n \\n \\n true\\n {\\"success\\": true}\\n {\\"success\\": false}\\n \\n \\n fail to call\\n 1001\\n retry\\n \\n \\n param1\\n 0\\n description1\\n default1\\n 0\\n example1\\n 0\\n true\\n \\n \\n description2\\n param2\\n example2\\n 0\\n \\n \\n t\\n 123\\n \\n \\n \\n true\\n {\\"success\\": true}\\n {\\"success\\": false}\\n \\n fail to call\\n 1001\\n retry\\n \\n \\n param1\\n 0\\n description1\\n default1\\n 0\\n example1\\n 0\\n true\\n \\n \\n description2\\n param2\\n example2\\n 0\\n \\n \\n t\\n 123\\n \\n \\n \\n \\n","errorExample":""}]', - 'title' => 'ListDataServicePublishedApis', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => 'The details of different types of APIs are returned in different parameters. The details of an API generated in wizard mode are returned in the WizardDetails parameter. The details of an API generated in script mode are returned in the ScriptDetails parameter. The details of an API generated by registration are returned in the RegistrationDetails parameter.'."\n", - 'extraInfo' => ' ', + 'ramActions' => [], ], - 'ListDataServiceApiAuthorities' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListEntitiesByTags' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -47606,220 +26817,195 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '78300', - 'abilityTreeNodes' => [ - 'FEATUREdide7T0EJX', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '187376', + 'abilityTreeNodes' => ['FEATUREdideRZEBFC'], ], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'formData', + 'name' => 'EntityType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the entity.'."\n", 'type' => 'string', 'required' => true, 'example' => 'maxcompute-table'], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The ID of the workspace.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The tag.'."\n", 'required' => false, '$ref' => '#/components/schemas/UserEntityTag'], 'required' => true, - 'docRequired' => true, - 'example' => '10000', + 'maxItems' => 10, ], ], [ - 'name' => 'PageNumber', + 'name' => 'NextToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'The pagination token that is used in the next request to retrieve a new page of results.'."\n", 'type' => 'string', 'required' => false, 'example' => '12345', 'default' => '0'], ], [ 'name' => 'PageSize', 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 10. Valid values: 1 to 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1000', 'example' => '10', 'default' => '10'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'maximum' => '50', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', + 'title' => 'OpenApiMetaResultModel', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'The data returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'NextToken' => ['description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.'."\n", 'type' => 'string', 'example' => '12345'], + 'EntityList' => [ + 'description' => 'The entities.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The entity.'."\n", '$ref' => '#/components/schemas/Entity'], + ], + ], + ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0000-ABCD-E****'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'true\\'."\n" + .'false'."\n", 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '101011005'], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'Invalid.Entity.EntityTypeNotSupported'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + ], ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": {\\n \\"NextToken\\": \\"12345\\",\\n \\"EntityList\\": [\\n {\\n \\"QualifiedName\\": \\"maxcompute_table.563f0357118d05ef145d6bddf2966cc23e86ca8f2f013f915e565afdf09f7a23\\",\\n \\"TenantId\\": 12345,\\n \\"EntityContent\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ]\\n },\\n \\"RequestId\\": \\"0000-ABCD-E****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"101011005\\",\\n \\"ErrorMessage\\": \\"Invalid.Entity.EntityTypeNotSupported\\",\\n \\"HttpStatusCode\\": 200\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 12345\\n \\n maxcompute_table.563f0357118d05ef145d6bddf2966cc23e86ca8f2f013f915e565afdf09f7a23\\n 12345\\n \\n \\n 0000-ABCD-E****\\n true\\n 101011005\\n Invalid.Entity.EntityTypeNotSupported\\n 200\\n","errorExample":""}]', + 'title' => 'ListEntitiesByTags', + 'summary' => 'Queries a list of entities by tag. Only entities of the maxcompute-table type are supported.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'ListEntityTags' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'TenantId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The tenant ID. This parameter is deprecated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '10001', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '187352', + 'abilityTreeNodes' => ['FEATUREdideRZEBFC'], + ], + 'parameters' => [ [ - 'name' => 'ApiNameKeyword', - 'in' => 'formData', + 'name' => 'QualifiedName', + 'in' => 'query', + 'schema' => ['description' => 'The unique identifier of the entity. Example: maxcompute-table.projectA.tableA.'."\n", 'type' => 'string', 'required' => true, 'example' => 'maxcompute-table.projectA.tableA'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The keyword in the name of the API. The keyword can be used to search for the API whose name contains the keyword.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'My API name'."\n", + 'title' => 'OpenApiMetaResultModel', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The tag.'."\n", '$ref' => '#/components/schemas/UserEntityTag'], + ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0000-ABCD-E****'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'true\\'."\n" + .'false'."\n", 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '101011005'], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'Invalid.Entity.EntityTypeNotSupported'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + ], ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": [\\n {\\n \\"TagKey\\": \\"priority\\",\\n \\"TagValue\\": \\"p1\\"\\n }\\n ],\\n \\"RequestId\\": \\"0000-ABCD-E****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"101011005\\",\\n \\"ErrorMessage\\": \\"Invalid.Entity.EntityTypeNotSupported\\",\\n \\"HttpStatusCode\\": 200\\n}","errorExample":""},{"type":"xml","example":"\\n \\n priority\\n p1\\n \\n 0000-ABCD-E****\\n true\\n 101011005\\n Invalid.Entity.EntityTypeNotSupported\\n 200\\n","errorExample":""}]', + 'title' => 'ListEntityTags', + 'summary' => 'Queries a list of tags of an entity. Only entities of the maxcompute-table type are supported.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'ListExtensions' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Normal'."\n", - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'Data' => [ - 'description' => 'The APIs on which other users are granted the access permissions.'."\n", + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request'."\n", 'type' => 'string', 'example' => '0000-ABCD-EFG'], + 'PagingInfo' => [ + 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number. The value of this parameter is the same as that of the PageNumber parameter in the request.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'ApiAuthorizationList' => [ - 'description' => 'The APIs on which other users are granted the access permissions.'."\n", + 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '12'], + 'Extensions' => [ + 'description' => 'The list of extensions.'."\n", 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The extensions.'."\n", 'type' => 'object', 'properties' => [ - 'ApiStatus' => [ - 'description' => 'The status of the API. Valid values: 0 and 1. The value 0 indicates that the API is not published. The value 1 indicates that the API is published.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ApiId' => [ - 'description' => 'The API ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10002', - ], - 'ModifiedTime' => [ - 'description' => 'The time when the API was last modified.'."\n", - 'type' => 'string', - 'example' => '2020-06-23T00:21:01+0800', - ], - 'GroupId' => [ - 'description' => 'The group ID.'."\n", - 'type' => 'string', - 'example' => 'ab123', - ], - 'ProjectId' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000', - ], - 'CreatorId' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the API owner.'."\n", - 'type' => 'string', - 'example' => '12345', - ], - 'CreatedTime' => [ - 'description' => 'The time when the API was created.'."\n", - 'type' => 'string', - 'example' => '2020-06-23T00:21:01+0800', - ], - 'ApiName' => [ - 'description' => 'The name of the API.'."\n", - 'type' => 'string', - 'example' => 'My API name'."\n", - ], - 'TenantId' => [ - 'description' => 'The tenant ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10001', - ], - 'ApiPath' => [ - 'description' => 'The path of the API.'."\n", - 'type' => 'string', - 'example' => '/test/1', - ], - 'AuthorizationRecords' => [ - 'description' => 'The authorization records.'."\n", + 'Status' => ['description' => 'The state of the extension. Valid values: 0: Testing 1: Publishing 3: Disabled 4: Processing 5: Approved 6: Approve Failed'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'ExtensionDesc' => ['description' => 'The description of the extension.'."\n", 'type' => 'string', 'example' => 'This is a description'], + 'ExtensionName' => ['description' => 'The name of the extension.'."\n", 'type' => 'string', 'example' => 'Extension name'], + 'Owner' => ['description' => 'The ID of the RAM user.'."\n", 'type' => 'string', 'example' => '2003****'], + 'ExtensionCode' => ['description' => 'The unique code of the extension.'."\n", 'type' => 'string', 'example' => 'Extension Code'], + 'BindEventList' => [ + 'description' => 'The list of extension point events.'."\n", 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The extension point event.'."\n", 'type' => 'object', 'properties' => [ - 'EndTime' => [ - 'description' => 'The end time of the validity period of the authorization.'."\n", - 'type' => 'string', - 'example' => '2020-06-24T00:21:01+0800', - ], - 'CreatorId' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the API owner.'."\n", - 'type' => 'string', - 'example' => '12345', - ], - 'CreatedTime' => [ - 'description' => 'The time when the access permissions on the API were granted to other users.'."\n", - 'type' => 'string', - 'example' => '2020-06-23T00:21:01+0800', - ], - 'ProjectId' => [ - 'description' => 'The ID of the workspace to which the access permissions on the API are granted.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10004', - ], + 'EventName' => ['description' => 'The name of the event.'."\n", 'type' => 'string', 'example' => 'File submission pre-event'], + 'EventCode' => ['description' => 'The code of the event.'."\n", 'type' => 'string', 'example' => 'commit-file'], ], ], ], @@ -47832,50 +27018,126 @@ ], ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0000-ABCD-****\\",\\n \\"PagingInfo\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 12,\\n \\"Extensions\\": [\\n {\\n \\"Status\\": 0,\\n \\"ExtensionDesc\\": \\"This is a description\\",\\n \\"ExtensionName\\": \\"Extension name\\",\\n \\"Owner\\": \\"2003****\\",\\n \\"ExtensionCode\\": \\"Extension Code\\",\\n \\"BindEventList\\": [\\n {\\n \\"EventName\\": \\"File submission pre-event\\",\\n \\"EventCode\\": \\"commit-file\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 0000-ABCD-EFG\\n \\n 1\\n 10\\n 12\\n \\n 0\\n 这是一个描述\\n 扩展程序名称\\n 2003****\\n 扩展程序码\\n \\n 文件提交前置事件\\n commit-file\\n \\n \\n \\n","errorExample":""}]', + 'title' => 'ListExtensions', + 'summary' => 'Queries a list of extensions.', + 'changeSet' => [ + ['createdAt' => '2022-04-26T08:35:01.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListExtensions'], + ], + ], + 'ramActions' => [], + ], + 'ListFileType' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to view the workspace ID. You must configure either this parameter or the ProjectIdentifier parameter to determine the DataWorks workspace to which the operation is applied.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000'], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace page to view the workspace name. You must configure either this parameter or the ProjectId parameter to determine the DataWorks workspace to which the operation is applied.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dw_project'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['description' => 'The number of entries per page. Maximum value: 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '50'], + ], + [ + 'name' => 'Keyword', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the node type. You can log on to the DataWorks console, go to the DataStudio page, and then view the name of a specific node type on the left side of the page. Take note of the following items when you configure this parameter:'."\n" + ."\n" + .'* You can view the name of a specific node type, but the language specified by this parameter to present the name must be the same as the language specified by the Locale parameter.'."\n" + .'* Fuzzy match is supported.'."\n" + .'* If this parameter is not configured, the names of all node types are returned.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ODPS SQL'], + ], + [ + 'name' => 'Locale', + 'in' => 'formData', + 'schema' => ['description' => 'The language that you use for the query. Valid values: zh-CN and en-US.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh-CN'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0000-ABCD-EFG****'], + 'NodeTypeInfoList' => [ + 'description' => 'The information about node types.'."\n", + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '50'], + 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '127'], + 'NodeTypeInfo' => [ + 'description' => 'The information about the node type.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NodeTypeName' => ['description' => 'The name of the node type. The codes and names of node types have the following mappings: 6 (Shell), 10 (ODPS SQL), 11 (ODPS MR), 23 (Data Integration), 24 (ODPS Script), 99 (zero load), 221 (PyODPS 2), 225 (ODPS Spark), 227 (EMR Hive), 228 (EMR Spark), 229 (EMR Spark SQL), 230 (EMR MR), 239 (OSS object inspection), 257 (EMR Shell), 258 (EMR Spark Shell), 259 (EMR Presto), 260 (EMR Impala), 900 (real-time synchronization), 1089 (cross-tenant collaboration), 1091 (Hologres development), 1093 (Hologres SQL), 1100 (assignment), and 1221 (PyODPS 3)'."\n", 'type' => 'string', 'example' => 'ODPS SQL'], + 'NodeType' => ['description' => 'The code of the node type. The codes and names of node types have the following mappings: 6 (Shell), 10 (ODPS SQL), 11 (ODPS MR), 23 (Data Integration), 24 (ODPS Script), 99 (zero load), 221 (PyODPS 2), 225 (ODPS Spark), 227 (EMR Hive), 228 (EMR Spark), 229 (EMR Spark SQL), 230 (EMR MR), 239 (OSS object inspection), 257 (EMR Shell), 258 (EMR Spark Shell), 259 (EMR Presto), 260 (EMR Impala), 900 (real-time synchronization), 1089 (cross-tenant collaboration), 1091 (Hologres development), 1093 (Hologres SQL), 1100 (assignment), and 1221 (PyODPS 3)'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], 'errorCodes' => [ 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], ], 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"正常\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"0\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"ApiAuthorizationList\\": [\\n {\\n \\"ApiStatus\\": 0,\\n \\"ApiId\\": 10002,\\n \\"ModifiedTime\\": \\"2020-06-23T00:21:01+0800\\",\\n \\"GroupId\\": \\"ab123\\",\\n \\"ProjectId\\": 10000,\\n \\"CreatorId\\": \\"12345\\",\\n \\"CreatedTime\\": \\"2020-06-23T00:21:01+0800\\",\\n \\"ApiName\\": \\"我的API名称\\",\\n \\"TenantId\\": 10001,\\n \\"ApiPath\\": \\"/test/1\\",\\n \\"AuthorizationRecords\\": [\\n {\\n \\"EndTime\\": \\"2020-06-24T00:21:01+0800\\",\\n \\"CreatorId\\": \\"12345\\",\\n \\"CreatedTime\\": \\"2020-06-23T00:21:01+0800\\",\\n \\"ProjectId\\": 10004\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 0000-ABCD-EFG****\\n 正常\\n false\\n 0\\n \\n 1\\n 10\\n 100\\n \\n 0\\n 10002\\n 2020-06-23T00:21:01+0800\\n ab123\\n 10000\\n 12345\\n 2020-06-23T00:21:01+0800\\n 我的API名称\\n 10001\\n /test/1\\n \\n 2020-06-24T00:21:01+0800\\n 12345\\n 2020-06-23T00:21:01+0800\\n 10004\\n \\n \\n \\n","errorExample":""}]', - 'title' => 'ListDataServiceApiAuthorities', - 'summary' => 'Queries the APIs on which other users are granted the access permissions.', - ], - 'ListDataServiceAuthorizedApis' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"NodeTypeInfoList\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 50,\\n \\"TotalCount\\": 127,\\n \\"NodeTypeInfo\\": [\\n {\\n \\"NodeTypeName\\": \\"ODPS SQL\\",\\n \\"NodeType\\": 10\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 0000-ABCD-EFG****\\n \\n 1\\n 50\\n 127\\n \\n ODPS SQL\\n 10\\n \\n \\n","errorExample":""}]', + 'title' => 'ListFileType', + 'summary' => 'Queries the information about node types, such as the code and name.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'ListFileVersions' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -47885,74 +27147,36 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '78303', - 'abilityTreeNodes' => [ - 'FEATUREdide7T0EJX', - ], + 'abilityTreeCode' => '78312', + 'abilityTreeNodes' => ['FEATUREdide8FM783'], ], 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'FileId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '10000', - ], + 'schema' => ['description' => 'The ID of the file. You can call the [ListFiles](~~173942~~) operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '100000001', 'title' => ''], ], [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The DataWorks workspace ID. You can click the Workspace Manage icon in the upper-right corner of the DataStudio page to go to the Workspace page and view the workspace ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '100001', 'title' => ''], ], [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'maximum' => '50', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => ['description' => 'The unique identifier of the DataWorks workspace. You can click the identifier in the upper-left corner of the DataStudio page to switch to another workspace.'."\n" + ."\n" + .'You must specify either this parameter or ProjectId to determine the DataWorks workspace to which the operation is applied.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dw_project', 'title' => ''], ], [ - 'name' => 'TenantId', + 'name' => 'PageNumber', 'in' => 'formData', - 'schema' => [ - 'description' => 'The tenant ID. This parameter is deprecated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '10001', - ], + 'schema' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''], ], [ - 'name' => 'ApiNameKeyword', + 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => 'The keyword in API names. The keyword is used to search for the APIs whose names contain the keyword.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'My API Name'."\n", - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '100', 'minimum' => '0', 'default' => '10', 'example' => '10', 'title' => ''], ], ], 'responses' => [ @@ -47960,291 +27184,318 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified parameters are invalid.', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '1031203110005', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'The connection does not exist.', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '0000-ABCD-EFG****', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned.'."\n", 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'The information about the APIs that you are authorized to access.'."\n", + 'description' => 'The file versions.'."\n", 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number. The value of this parameter is the same as that of the PageNumber parameter in the request.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'ApiAuthorizedList' => [ - 'description' => 'The APIs that you are authorized to access.'."\n", + 'PageNumber' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '13', 'title' => ''], + 'FileVersions' => [ + 'description' => 'The details of file versions.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'ApiId' => [ - 'description' => 'The API ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10002', - ], - 'ApiStatus' => [ - 'description' => 'The status of the API. Valid values: 0 and 1. The value 0 indicates that the API is not published. The value 1 indicates that the API is published.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'GrantOperatorId' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the user who granted the access permissions on the API.'."\n", - 'type' => 'string', - 'example' => '23456', - ], - 'ProjectId' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000', - ], - 'CreatorId' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the API owner.'."\n", - 'type' => 'string', - 'example' => '12345', - ], - 'GrantEndTime' => [ - 'description' => 'The expiration time of the access permissions granted on the API.'."\n", - 'type' => 'string', - 'example' => '2020-06-24T00:21:01+0800', - ], - 'ModifiedTime' => [ - 'description' => 'The time when the API was last updated.'."\n", - 'type' => 'string', - 'example' => '2020-06-23T00:21:01+0800', - ], - 'GroupId' => [ - 'description' => 'The group ID.'."\n", - 'type' => 'string', - 'example' => 'abcde123456789', - ], - 'GrantCreatedTime' => [ - 'description' => 'The time when the access permissions on the API were granted.'."\n", - 'type' => 'string', - 'example' => '2020-06-23T00:21:01+0800', - ], - 'CreatedTime' => [ - 'description' => 'The time when the API was created.'."\n", - 'type' => 'string', - 'example' => '2020-06-23T00:21:01+0800', - ], - 'ApiName' => [ - 'description' => 'The name of the API.'."\n", - 'type' => 'string', - 'example' => 'My API Name'."\n", - ], - 'TenantId' => [ - 'description' => 'The tenant ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10001', - ], - 'ApiPath' => [ - 'description' => 'The path of the API.'."\n", - 'type' => 'string', - 'example' => '/test/1', - ], + 'FileContent' => ['description' => 'The code in the file of the current version.'."\n", 'type' => 'string', 'example' => 'SHOW TABLES;', 'title' => ''], + 'Status' => ['description' => 'The status of the file of the current version. Valid values: COMMITTING, COMMITTED, CHECK_OK, PACKAGED, DEPLOYING, DEPLOYED, and CANCELLED.'."\n", 'type' => 'string', 'example' => 'COMMITTED', 'title' => ''], + 'IsCurrentProd' => ['description' => 'Indicates whether the file version is the same as the latest file version in the production environment.'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'CommitUser' => ['description' => 'The ID of the Alibaba Cloud account used to create the file of the current version.'."\n", 'type' => 'string', 'example' => '73842342****', 'title' => ''], + 'NodeContent' => ['description' => 'The scheduling configurations for the node that corresponds to the file of the current version.'."\n", 'type' => 'string', 'example' => '{"cycleType":0,"cronExpress":"00 05 00 * * ?"}', 'title' => ''], + 'Comment' => ['description' => 'The description of the file version.'."\n", 'type' => 'string', 'example' => 'Second version submission', 'title' => ''], + 'FilePropertyContent' => ['description' => 'The basic information about the file of the current version.'."\n", 'type' => 'string', 'example' => '{"fileName":"ods_user_info_d","fileType":10}', 'title' => ''], + 'FileName' => ['description' => 'The name of the file of the current version.'."\n", 'type' => 'string', 'example' => 'ods_user_info_d', 'title' => ''], + 'UseType' => ['description' => 'The functional module to which the file belongs. Valid values: NORMAL, MANUAL, MANUAL_BIZ, SKIP, ADHOCQUERY, and COMPONENT. The value SKIP indicates that the node corresponding to the file is run in dry-run mode.'."\n", 'type' => 'string', 'example' => 'NORMAL', 'title' => ''], + 'ChangeType' => ['description' => 'The type of the change to the file of the current version. Valid values: CREATE, UPDATE, and DELETE.'."\n", 'type' => 'string', 'example' => 'UPDATE', 'title' => ''], + 'FileVersion' => ['description' => 'The version of the file.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'CommitTime' => ['description' => 'The time when the file version was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1593881265000', 'title' => ''], + 'NodeId' => ['description' => 'The ID of the auto triggered node that corresponds to the file of the current version.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], ], 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"ApiAuthorizedList\\": [\\n {\\n \\"ApiId\\": 10002,\\n \\"ApiStatus\\": 0,\\n \\"GrantOperatorId\\": \\"23456\\",\\n \\"ProjectId\\": 10000,\\n \\"CreatorId\\": \\"12345\\",\\n \\"GrantEndTime\\": \\"2020-06-24T00:21:01+0800\\",\\n \\"ModifiedTime\\": \\"2020-06-23T00:21:01+0800\\",\\n \\"GroupId\\": \\"abcde123456789\\",\\n \\"GrantCreatedTime\\": \\"2020-06-23T00:21:01+0800\\",\\n \\"CreatedTime\\": \\"2020-06-23T00:21:01+0800\\",\\n \\"ApiName\\": \\"我的API名称\\",\\n \\"TenantId\\": 10001,\\n \\"ApiPath\\": \\"/test/1\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n \\n \\n \\n","errorExample":""}]', - 'title' => 'ListDataServiceAuthorizedApis', - 'summary' => 'Queries the APIs that you are authorized to access.', - ], - 'AbolishDataServiceApi' => [ - 'methods' => [ - 'post', + 'title' => 'ListFileVersions', + 'summary' => 'Queries a list of file versions.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 13,\\n \\"FileVersions\\": [\\n {\\n \\"FileContent\\": \\"SHOW TABLES;\\",\\n \\"Status\\": \\"COMMITTED\\",\\n \\"IsCurrentProd\\": false,\\n \\"CommitUser\\": \\"73842342****\\",\\n \\"NodeContent\\": \\"{\\\\\\"cycleType\\\\\\":0,\\\\\\"cronExpress\\\\\\":\\\\\\"00 05 00 * * ?\\\\\\"}\\",\\n \\"Comment\\": \\"Second version submission\\",\\n \\"FilePropertyContent\\": \\"{\\\\\\"fileName\\\\\\":\\\\\\"ods_user_info_d\\\\\\",\\\\\\"fileType\\\\\\":10}\\",\\n \\"FileName\\": \\"ods_user_info_d\\",\\n \\"UseType\\": \\"NORMAL\\",\\n \\"ChangeType\\": \\"UPDATE\\",\\n \\"FileVersion\\": 2,\\n \\"CommitTime\\": 1593881265000,\\n \\"NodeId\\": 1234\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListFiles' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '78165', - 'abilityTreeNodes' => [ - 'FEATUREdide7T0EJX', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '78310', + 'abilityTreeNodes' => ['FEATUREdide8FM783'], ], 'parameters' => [ [ - 'name' => 'TenantId', + 'name' => 'FileFolderPath', 'in' => 'formData', - 'schema' => [ - 'description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '10002', - ], + 'schema' => ['description' => 'The path of the folder to which files belong.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Business_process/my_first_business_process/MaxCompute/ods_layer'], ], [ 'name' => 'ProjectId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the workspace.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '10001', - ], + 'schema' => ['description' => 'The ID of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace Management page to obtain the workspace ID.'."\n" + ."\n" + .'You must configure either the ProjectId or ProjectIdentifier parameter to determine the DataWorks workspace to which the operation is applied.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10000'], ], [ - 'name' => 'ApiId', + 'name' => 'Keyword', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the DataService Studio API.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '10000', - ], + 'schema' => ['description' => 'The keyword in the file names. The keyword is used to perform a fuzzy match. You can specify a keyword to query all files whose names contain the keyword.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'ods'], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace Management page to obtain the workspace name.'."\n" + ."\n" + .'You must configure either the ProjectId or ProjectIdentifier parameter to determine the DataWorks workspace to which the operation is applied.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dw_project'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '100', 'minimum' => '0', 'example' => '10', 'default' => '10'], + ], + [ + 'name' => 'UseType', + 'in' => 'formData', + 'schema' => ['description' => 'The module to which the files belong. Valid values:'."\n" + ."\n" + .'* NORMAL: The files are used for DataStudio.'."\n" + .'* MANUAL: The files are used for manually triggered nodes.'."\n" + .'* MANUAL_BIZ: The files are used for manually triggered workflows.'."\n" + .'* SKIP: The files are used for dry-run nodes in DataStudio.'."\n" + .'* ADHOCQUERY: The files are used for ad hoc queries.'."\n" + .'* COMPONENT: The files are used for snippets.'."\n", 'type' => 'string', 'required' => false, 'example' => 'NORMAL'], + ], + [ + 'name' => 'FileTypes', + 'in' => 'formData', + 'schema' => ['description' => 'The types of the code in the files.'."\n" + ."\n" + .'Valid values: 6 (Shell), 10 (ODPS SQL), 11 (ODPS MR), 23 (Data Integration), 24 (ODPS Script), 97 (PAI), 98 (node group), 99 (zero load), 221 (PyODPS 2), 225 (ODPS Spark), 227 (EMR Hive), 228 (EMR Spark), 229 (EMR Spark SQL), 230 (EMR MR), 239 (OSS object inspection), 257 (EMR Shell), 258 (EMR Spark Shell), 259 (EMR Presto), 260 (EMR Impala), 900 (real-time synchronization), 1002 (PAI inner node), 1089 (cross-tenant collaboration), 1091 (Hologres development), 1093 (Hologres SQL), 1100 (assignment), 1106 (for-each), and 1221 (PyODPS 3).'."\n", 'type' => 'string', 'required' => false, 'example' => '10,23'], + ], + [ + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => ['description' => 'The owner of the files.'."\n", 'type' => 'string', 'required' => false, 'example' => '3726346****'], + ], + [ + 'name' => 'NodeId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the node that is scheduled. You can call the [ListNodes](~~173979~~) operation to query the ID of the node.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123541234'], + ], + [ + 'name' => 'NeedContent', + 'in' => 'formData', + 'schema' => ['description' => 'Whether the query results contain file content (for files with more content, there may be a long network transmission delay).', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'NeedAbsoluteFolderPath', + 'in' => 'formData', + 'schema' => ['description' => 'Whether the query result contains the path of the folder where the file is located.', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'ExactFileName', + 'in' => 'formData', + 'schema' => ['description' => 'The exact matching file name. The file name of the query result is exactly the same as this parameter.', 'type' => 'string', 'required' => false, 'example' => 'ods_create.sql'], + ], + [ + 'name' => 'FileIdIn', + 'in' => 'formData', + 'schema' => ['description' => 'The file ID list. The File ID set of the query result can only be a subset of the list. You can specify up to 50 fileids at a time.', 'type' => 'string', 'required' => false, 'example' => '78237,816123'], + ], + [ + 'name' => 'LastEditUser', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the Alibaba Cloud account that is used to last modify the file.'."\n", 'type' => 'string', 'required' => false, 'example' => '38748246285727'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorMessage' => ['description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'The connection does not exist.'], + 'RequestId' => ['description' => 'The request ID. You can troubleshoot issues based on the ID.'."\n", 'type' => 'string', 'example' => '0000-ABCD-EFG'], + 'ErrorCode' => ['description' => 'The error code returned.'."\n", 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists'], + 'Success' => ['description' => 'Indicates whether the request is successful. Valid values:'."\n" + ."\n" + .'* true: The request is successful.'."\n" + .'* false: The request fails.'."\n", 'type' => 'boolean', 'example' => 'true'], 'Data' => [ - 'description' => 'Indicates whether the API is unpublished.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'description' => 'The files returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '13'], + 'Files' => [ + 'description' => 'The details of the files.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the file.'."\n", + 'type' => 'object', + 'properties' => [ + 'CommitStatus' => ['description' => 'Indicates whether the latest code in the file is committed. Valid values: 0 and 1. The value 0 indicates that the latest code in the file is not committed. The value 1 indicates that the latest code in the file is committed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'AutoParsing' => ['description' => 'Specifies whether the automatic parsing feature is enabled for the file. Valid values:'."\n" + ."\n" + .'* true: The automatic parsing feature is enabled for the file.'."\n" + .'* false: The automatic parsing feature is not enabled for the file.'."\n" + ."\n" + .'This parameter is equivalent to the Analyze Code parameter in the Dependencies section of the Properties panel in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", 'type' => 'boolean', 'example' => 'true'], + 'Owner' => ['description' => 'The ID of the Alibaba Cloud account used by the file owner.'."\n", 'type' => 'string', 'example' => '3872572****'], + 'CreateTime' => ['description' => 'The time when the file was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1593950832000'], + 'FileType' => ['description' => 'The type of the code in the file. Valid values: 6 (Shell), 10 (ODPS SQL), 11 (ODPS MR), 23 (Data Integration), 24 (ODPS Script), 99 (zero load), 221 (PyODPS 2), 225 (ODPS Spark), 227 (EMR Hive), 228 (EMR Spark), 229 (EMR Spark SQL), 230 (EMR MR), 239 (OSS object inspection), 257 (EMR Shell), 258 (EMR Spark Shell), 259 (EMR Presto), 260 (EMR Impala), 900 (real-time synchronization), 1089 (cross-tenant collaboration), 1091 (Hologres development), 1093 (Hologres SQL), 1100 (assignment), and 1221 (PyODPS 3).'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'CurrentVersion' => ['description' => 'The latest version number of the file.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2'], + 'BizId' => ['description' => 'The ID of the workflow to which the file belongs. This parameter is deprecated and replaced by the BusinessId parameter.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '300000'], + 'LastEditUser' => ['description' => 'The ID of the Alibaba Cloud account that is used to last modify the file.'."\n", 'type' => 'string', 'example' => '38748246285727'], + 'FileName' => ['description' => 'The name of the file.'."\n", 'type' => 'string', 'example' => 'ods_user_info_d'], + 'ConnectionName' => ['description' => 'The ID of the compute engine instance that is used to run the node that corresponds to the file.'."\n", 'type' => 'string', 'example' => 'odps_first'], + 'UseType' => ['description' => 'The module to which the file belongs. Valid values:'."\n" + ."\n" + .'* NORMAL: The file is used for DataStudio.'."\n" + .'* MANUAL: The file is used for a manually triggered node.'."\n" + .'* MANUAL_BIZ: The file is used for a manually triggered workflow.'."\n" + .'* SKIP: The files is used for a dry-run node in DataStudio.'."\n" + .'* ADHOCQUERY: The file is used for an ad hoc query.'."\n" + .'* COMPONENT: The file is used for a snippet.'."\n", 'type' => 'string', 'example' => 'NORMAL'], + 'FileFolderId' => ['description' => 'The ID of the folder to which the file belongs.'."\n", 'type' => 'string', 'example' => '2735c2****'], + 'FileId' => ['description' => 'The ID of the file.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10000001'], + 'ParentId' => ['description' => 'The ID of the node group file to which the current file belongs. This parameter is returned only if the current file is an inner file of the node group file.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '-1'], + 'CreateUser' => ['description' => 'The ID of the Alibaba Cloud account that is used to create the file.'."\n", 'type' => 'string', 'example' => '382762****'], + 'IsMaxCompute' => ['description' => 'Indicates whether the file needs to be uploaded to MaxCompute if the file is a MaxCompute resource file.'."\n" + ."\n" + .'This parameter is returned only if the file is a MaxCompute resource file.'."\n", 'type' => 'boolean', 'example' => 'false'], + 'BusinessId' => ['description' => 'The ID of the workflow to which the file belongs.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '300000'], + 'FileDescription' => ['description' => 'The description of the file.'."\n", 'type' => 'string', 'example' => 'my test datastudio file'], + 'LastEditTime' => ['description' => 'The time when the file was last modified. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1593950832000'], + 'Content' => ['description' => 'This parameter is deprecated. You can call the [GetFile](~~173954#doc-api-dataworks-public-GetFile~~) operation to query the details of the file.'."\n", 'type' => 'string', 'example' => 'SHOW TABLES;'], + 'NodeId' => ['description' => 'The ID of the auto triggered node that is generated in the scheduling system after the file is committed.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '300001'], + 'AbsoluteFolderPath' => ['description' => 'The path of the folder to which the file belongs.'."\n", 'type' => 'string', 'example' => 'Business_process/my_first_business_process/MaxCompute/ods_layer'], + ], + ], + ], + ], ], ], - 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n true\\n The connection does not exist.\\n 0000-ABCD-EFG****\\n Invalid.Tenant.ConnectionNotExists\\n true\\n","errorExample":""}]', - 'title' => 'AbolishDataServiceApi', - 'summary' => 'Unpublishes a DataService Studio API.', + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 13,\\n \\"Files\\": [\\n {\\n \\"CommitStatus\\": 1,\\n \\"AutoParsing\\": true,\\n \\"Owner\\": \\"3872572****\\",\\n \\"CreateTime\\": 1593950832000,\\n \\"FileType\\": 10,\\n \\"CurrentVersion\\": 2,\\n \\"BizId\\": 300000,\\n \\"LastEditUser\\": \\"38748246285727\\",\\n \\"FileName\\": \\"ods_user_info_d\\",\\n \\"ConnectionName\\": \\"odps_source\\",\\n \\"UseType\\": \\"NORMAL\\",\\n \\"FileFolderId\\": \\"2735c2****\\",\\n \\"FileId\\": 10000001,\\n \\"ParentId\\": -1,\\n \\"CreateUser\\": \\"382762****\\",\\n \\"IsMaxCompute\\": false,\\n \\"BusinessId\\": 300000,\\n \\"FileDescription\\": \\"my test datastudio file\\",\\n \\"LastEditTime\\": 1593950832000,\\n \\"Content\\": \\"SHOW TABLES;\\",\\n \\"NodeId\\": 300001,\\n \\"AbsoluteFolderPath\\": \\"Business_process/my_first_business_process/MaxCompute/ods_layer\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n The connection does not exist.\\n 0000-ABCD-EFG\\n Invalid.Tenant.ConnectionNotExists\\n true\\n \\n 1\\n 10\\n 13\\n \\n 1\\n true\\n 3872572****\\n 1593950832000\\n 10\\n 2\\n 300000\\n 38748246285727\\n ods_user_info_d\\n odps_source\\n NORMAL\\n 2735c2****\\n 10000001\\n -1\\n 382762****\\n false\\n 300000\\n my test datastudio file\\n 1593950832000\\n SHOW TABLES;\\n 300001\\n \\n \\n","errorExample":""}]', + 'title' => 'ListFiles', + 'summary' => 'Queries a list of files.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'GetDataServiceApplication' => [ - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2025-04-27T02:20:50.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-04-07T12:29:35.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-03-27T12:29:53.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-07-14T05:38:33.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ListFolders' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -48254,47 +27505,34 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '78236', - 'abilityTreeNodes' => [ - 'FEATUREdide7T0EJX', - ], + 'abilityTreeCode' => '78313', + 'abilityTreeNodes' => ['FEATUREdide8FM783'], ], 'parameters' => [ [ - 'name' => 'TenantId', + 'name' => 'ProjectId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '10002', - ], + 'schema' => ['description' => 'The ID of the DataWorks workspace. Log on to the DataWorks console and go to the Workspace Management page to obtain the workspace ID. You must set either this parameter or ProjectIdentifier to specify the DataWorks workspace for this API call.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10000', 'title' => ''], ], [ - 'name' => 'ProjectId', + 'name' => 'ProjectIdentifier', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the workspace.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '10001', - ], + 'schema' => ['description' => 'The name of the DataWorks workspace. Log on to the DataWorks console and go to the Workspace Management page to obtain the workspace name. You must set either this parameter or ProjectId to specify the DataWorks workspace for this API call.', 'type' => 'string', 'required' => false, 'example' => 'dw_project', 'title' => ''], ], [ - 'name' => 'ApplicationId', + 'name' => 'ParentFolderPath', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the application. You can view the information about the application in the API Gateway console.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '10000', - ], + 'schema' => ['description' => 'The path of the parent folder.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Business_process/my_first_business_process/MaxCompute', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => ['description' => 'The number of the page to return. This parameter is used for pagination.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'minimum' => '1', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['description' => 'The number of entries per page. The default value is 10. The maximum value is 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '0', 'example' => '10', 'title' => ''], ], ], 'responses' => [ @@ -48302,122 +27540,87 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Normal'."\n", - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '0', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The connection does not exist.', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request. Use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '0000-ABCD-****', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'The details of the application.'."\n", + 'description' => 'A list of folders that meet the specified criteria.', 'type' => 'object', 'properties' => [ - 'ApplicationCode' => [ - 'description' => 'The AppCode for simple authentication. You can select simple authentication or signature authentication when you call an API operation.'."\n", - 'type' => 'string', - 'example' => 'CODE123', - ], - 'ApplicationKey' => [ - 'description' => 'The AppKey for signature authentication. You can select simple authentication or signature authentication when you call an API operation.'."\n", - 'type' => 'string', - 'example' => 'KEY123', - ], - 'ApplicationSecret' => [ - 'description' => 'The AppSecret for signature authentication. You can select simple authentication or signature authentication when you call an API operation.'."\n", - 'type' => 'string', - 'example' => 'SECRET123', - ], - 'ProjectId' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10001', - ], - 'ApplicationName' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'example' => 'Test application'."\n", - ], - 'ApplicationId' => [ - 'description' => 'The application ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000', + 'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries on the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries that meet the filter criteria.', 'type' => 'integer', 'format' => 'int32', 'example' => '13', 'title' => ''], + 'Folders' => [ + 'description' => 'A list of folders.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FolderPath' => ['description' => 'The path of the folder.', 'type' => 'string', 'example' => 'Business_process/my_first_business_process/MaxCompute/ods_layer', 'title' => ''], + 'FolderId' => ['description' => 'The ID of the folder.', 'type' => 'string', 'example' => '2735c2****', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], ], 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"正常\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"0\\",\\n \\"Data\\": {\\n \\"ApplicationCode\\": \\"CODE123\\",\\n \\"ApplicationKey\\": \\"KEY123\\",\\n \\"ApplicationSecret\\": \\"SECRET123\\",\\n \\"ProjectId\\": 10001,\\n \\"ApplicationName\\": \\"测试应用\\",\\n \\"ApplicationId\\": 10000\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 0000-ABCD-EFG****\\n 正常\\n true\\n 0\\n \\n CODE123\\n KEY123\\n SECRET123\\n 10001\\n 测试应用\\n 10000\\n \\n","errorExample":""}]', - 'title' => 'GetDataServiceApplication', - 'summary' => 'Queries the details of an application.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 13,\\n \\"Folders\\": [\\n {\\n \\"FolderPath\\": \\"Business_process/my_first_business_process/MaxCompute/ods_layer\\",\\n \\"FolderId\\": \\"2735c2****\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListFolders', + 'summary' => 'Call the ListFolders operation to query for folders.', 'requestParamsDescription' => ' ', - 'responseParamsDescription' => 'The disclosure of the ApplicationCode or ApplicationSecret parameter may threaten the security of your API resources in DataService Studio. Therefore, the values of the ApplicationCode and ApplicationSecret parameters are masked before they are returned.'."\n", + 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListDataServiceApplications' => [ - 'methods' => [ - 'post', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListInnerNodes' => [ + 'summary' => 'Retrieves a list of inner nodes within a node group or do-while node. This operation does not support querying the inner nodes of a PAI node.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -48426,343 +27629,216 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '78302', - 'abilityTreeNodes' => [ - 'FEATUREdide7T0EJX', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '146118', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB'], ], 'parameters' => [ + [ + 'name' => 'ProgramType', + 'in' => 'formData', + 'schema' => ['description' => 'The type of the node to which the inner nodes belong.'."\n" + ."\n" + .'Valid values: 6 (Shell), 10 (ODPS SQL), 11 (ODPS MR), 23 (Data Integration), 24 (ODPS Script), 97 (PAI), 98 (node group), 99 (zero load), 221 (PyODPS 2), 225 (ODPS Spark), 227 (EMR Hive), 228 (EMR Spark), 229 (EMR Spark SQL), 230 (EMR MR), 239 (OSS object inspection), 257 (EMR Shell), 258 (EMR Spark Shell), 259 (EMR Presto), 260 (EMR Impala), 900 (real-time synchronization), 1002 (PAI inner node), 1089 (cross-tenant collaboration), 1091 (Hologres development), 1093 (Hologres SQL), 1100 (assignment), 1106 (for-each), and 1221 (PyODPS 3). You can call the ListNodes operation to query the type of the node.', 'type' => 'string', 'required' => false, 'example' => 'ODPS_SQL', 'title' => ''], + ], [ 'name' => 'PageNumber', 'in' => 'formData', - 'schema' => [ - 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'The page number. Valid values: 1 to 100.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'maximum' => '50', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '10', 'default' => '10', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'ProjectIdList', + 'name' => 'ProjectId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the workspace based on which you want to query the basic information of applications. You can specify multiple IDs. Separate them with commas (,). You must specify at least one workspace ID. You can specify a maximum of 50 workspace IDs.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '10000,100001', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1234', 'title' => ''], ], [ - 'name' => 'TenantId', + 'name' => 'ProjectEnv', 'in' => 'formData', - 'schema' => [ - 'description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '100002', - ], + 'schema' => ['description' => 'The environment in which the node is run. Valid values: DEV and PROD. Default value: PROD.', 'type' => 'string', 'required' => false, 'default' => 'PROD', 'example' => 'PROD', 'title' => ''], + ], + [ + 'name' => 'NodeName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the node to which the inner nodes belong.', 'type' => 'string', 'required' => false, 'example' => 'liux_test_n****', 'title' => ''], + ], + [ + 'name' => 'OuterNodeId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the node group to which the inner nodes belong.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '12345', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG***', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Normal'."\n", - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'E6F0DBDD-5AD****'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Paging' => [ + 'description' => 'The pagination information.', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number. The value of this parameter is the same as that of the PageNumber parameter in the request.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'Applications' => [ - 'description' => 'The basic information of the applications.'."\n", + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of inner nodes returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'Nodes' => [ + 'description' => 'The list of inner nodes.', 'type' => 'array', 'items' => [ + 'description' => 'The inner node.', 'type' => 'object', 'properties' => [ - 'ApplicationName' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'example' => 'My application'."\n", - ], - 'ApplicationId' => [ - 'description' => 'The application ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20000', - ], - 'ProjectId' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000', - ], - ], + 'SchedulerType' => ['description' => 'The scheduling type of the inner node. Valid values:'."\n" + ."\n" + .'- NORMAL: The inner node is an auto triggered node.'."\n" + ."\n" + .'- MANUAL: The inner node is a manually triggered node. The scheduling system does not run the node on a regular basis.'."\n" + ."\n" + .'- PAUSE: The inner node is a paused node.'."\n" + ."\n" + .'- SKIP: The inner node is a dry-run node. Dry-run nodes are started as scheduled, but the scheduling system sets the status of the nodes to successful when it starts to run them.', 'type' => 'string', 'example' => 'NORMAL', 'title' => ''], + 'RepeatInterval' => ['description' => 'The interval at which the inner node is rerun after the inner node fails to run.', 'type' => 'integer', 'format' => 'int64', 'example' => '60', 'title' => ''], + 'Repeatability' => ['description' => 'Indicates whether the inner node can be rerun.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ProjectId' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'ProgramType' => ['description' => 'The type of the inner node.', 'type' => 'string', 'example' => 'ODPS_SQL', 'title' => ''], + 'Priority' => ['description' => 'The priority of the inner node. Valid values: 1, 3, 5, 7, and 8.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'OwnerId' => ['description' => 'The owner ID.', 'type' => 'string', 'example' => '1933****36551', 'title' => ''], + 'Connection' => ['description' => 'The connection string.', 'type' => 'string', 'example' => 'odps_source', 'title' => ''], + 'ParamValues' => ['description' => 'The additional parameters.', 'type' => 'string', 'example' => 'a=b', 'title' => ''], + 'DqcType' => ['description' => 'Indicates whether the inner node is associated with a monitoring rule in Data Quality. Valid values: 0 and 1. The value 0 indicates that the inner node is associated with a monitoring rule in Data Quality. The value 1 indicates that the inner node is not associated with a monitoring rule in Data Quality.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'BaselineId' => ['description' => 'The baseline ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'Description' => ['description' => 'The description of the inner node.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'NodeName' => ['description' => 'The name of the inner node.', 'type' => 'string', 'example' => 'liux_test_n****', 'title' => ''], + 'ResGroupName' => ['description' => 'The name of the resource group.', 'type' => 'string', 'example' => 'Default Resource Group', 'title' => ''], + 'BusinessId' => ['description' => 'The workflow ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'DqcDescription' => ['description' => 'The table and partition filter expression in Data Quality that are associated with the inner node.', 'type' => 'string', 'example' => '[{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\\u003d$[yyyy-mm-dd-1]"}]', 'title' => ''], + 'CronExpress' => ['description' => 'The CRON expression.', 'type' => 'string', 'example' => '00 00 00 * * ?', 'title' => ''], + 'NodeId' => ['description' => 'The inner node ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"Success\\": true,\\n \\"Paging\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Nodes\\": [\\n {\\n \\"SchedulerType\\": \\"NORMAL\\",\\n \\"RepeatInterval\\": 60,\\n \\"Repeatability\\": true,\\n \\"ProjectId\\": 123,\\n \\"ProgramType\\": \\"ODPS_SQL\\",\\n \\"Priority\\": 1,\\n \\"OwnerId\\": \\"1933****36551\\",\\n \\"Connection\\": \\"odps_source\\",\\n \\"ParamValues\\": \\"a=b\\",\\n \\"DqcType\\": \\"1\\",\\n \\"BaselineId\\": 1234,\\n \\"Description\\": \\"test\\",\\n \\"NodeName\\": \\"liux_test_n****\\",\\n \\"ResGroupName\\": \\"Default Resource Group\\",\\n \\"BusinessId\\": 123,\\n \\"DqcDescription\\": \\"[{\\\\\\"projectName\\\\\\":\\\\\\"ztjy_dim\\\\\\",\\\\\\"tableName\\\\\\":\\\\\\"dim_user_agent_manage_area_a\\\\\\",\\\\\\"partition\\\\\\":\\\\\\"ds\\\\\\\\u003d$[yyyy-mm-dd-1]\\\\\\"}]\\",\\n \\"CronExpress\\": \\"00 00 00 * * ?\\",\\n \\"NodeId\\": 12\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListInnerNodes', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInnerNodes'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFG***\\",\\n \\"ErrorMessage\\": \\"正常\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"0\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Applications\\": [\\n {\\n \\"ApplicationName\\": \\"我的应用\\",\\n \\"ApplicationId\\": 20000,\\n \\"ProjectId\\": 10000\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 0000-ABCD-EFG***\\n 正常\\n true\\n 0\\n \\n 1\\n 10\\n 100\\n \\n 我的应用\\n 20000\\n 10000\\n \\n \\n","errorExample":""}]', - 'title' => 'ListDataServiceApplications', - 'summary' => 'Queries the basic information of applications.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'ramActions' => [], ], - 'CreateDataServiceFolder' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListInstanceAmount' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', + 'abilityTreeCode' => '78314', + 'abilityTreeNodes' => ['FEATUREdideXLVI81'], ], 'parameters' => [ - [ - 'name' => 'TenantId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The tenant ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '10002', - ], - ], [ 'name' => 'ProjectId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the workspace.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '10001', - ], - ], - [ - 'name' => 'FolderName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the folder.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Test folder'."\n", - ], + 'schema' => ['description' => 'The DataWorks workspace ID. You can log on to the DataWorks console and go to the Work space page to obtain the workspace ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '99999999999', 'minimum' => '2', 'example' => '10000'], ], [ - 'name' => 'ParentId', + 'name' => 'BeginDate', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the desired parent folder of the folder. The ID of the root folder in a workflow is 0. The ID of the folder created by users in a workflow is greater than 0.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '0', - ], + 'schema' => ['description' => 'The beginning of the time range to query, accurate to the day. Specify the time in the ISO 8601 standard in the yyyy-MM-dd\'T\'HH:mm:ssZ format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-06-13T00:00:00+0800'], ], [ - 'name' => 'GroupId', + 'name' => 'EndDate', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the desired workflow to which the folder belongs.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1000abcd', - ], + 'schema' => ['description' => 'The end of the time range to query, accurate to the day. Specify the time in the ISO 8601 standard in the yyyy-MM-dd\'T\'HH:mm:ssZ format. The time must be in UTC.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2021-06-16T00:00:00+0800'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'FolderId' => [ - 'description' => 'The ID of the created folder.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-E****', + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '95279527adhfj****'], + 'InstanceCounts' => [ + 'description' => 'The trend of the number of auto triggered node instances within the specified period of time.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Date' => ['description' => 'The data timestamp at which the number of auto triggered node instances was obtained. This value is a UNIX timestamp.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1623772800000'], + 'Count' => ['description' => 'The number of auto triggered node instances.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '9527'], + ], + ], ], ], - 'description' => '', ], ], ], 'errorCodes' => [ 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + ['errorCode' => 'ResourceNotAuthorized.Api', 'errorMessage' => 'You are not authorized to access the resources.', 'description' => ''], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], ], 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Resource', 'errorMessage' => 'You have reached the limit for the resource. Please contact us by submitting a ticket.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], + ['errorCode' => 'Forbidden.Not.Server', 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.', 'description' => ''], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'Forbidden.Wkbench.NoProject', 'errorMessage' => 'You have not joined any project.', 'description' => ''], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"FolderId\\": 123,\\n \\"RequestId\\": \\"0000-ABCD-E****\\"\\n}","errorExample":""},{"type":"xml","example":"0000-ABCD-E****\\n123","errorExample":""}]', - 'title' => 'CreateDataServiceFolder', - 'summary' => 'Creates a folder in DataService Studio.', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"95279527adhfj****\\",\\n \\"InstanceCounts\\": [\\n {\\n \\"Date\\": 1623772800000,\\n \\"Count\\": 9527\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 95279527adhfj****\\n \\n 1623772800000\\n 9527\\n \\n","errorExample":""}]', + 'title' => 'ListInstanceAmount', + 'summary' => 'Queries the trend of the number of auto triggered node instances within a specified period of time.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'GetDataServiceFolder' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '99', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstanceAmount'], + ], ], + 'ramActions' => [], + ], + 'ListInstanceHistory' => [ + 'summary' => 'Retrieves the run history of an instance. Each rerun generates a new historical record.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -48772,167 +27848,119 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '78237', - 'abilityTreeNodes' => [ - 'FEATUREdide7T0EJX', - ], + 'abilityTreeCode' => '146270', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB'], ], 'parameters' => [ [ - 'name' => 'TenantId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The tenant ID. This parameter is deprecated. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '10003', - ], - ], - [ - 'name' => 'ProjectId', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the workspace.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '10002', - ], + 'schema' => ['description' => 'The instance ID. You can call the ListInstances operation to query the instance ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1234', 'title' => ''], ], [ - 'name' => 'FolderId', + 'name' => 'ProjectEnv', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the folder.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '10001', - ], + 'schema' => ['description' => 'The environment of the workspace. Valid values: PROD and DEV. By default, data of instances in the production environment is queried.', 'type' => 'string', 'default' => 'PROD', 'required' => false, 'example' => 'PROD', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'title' => 'Schema of Response', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EF****', - ], - 'Folder' => [ - 'description' => 'The details of the folder.'."\n", - 'type' => 'object', - 'properties' => [ - 'ParentId' => [ - 'description' => 'The parent folder ID. The ID of the root folder in a business process is 0, and the ID of a folder created by a user in a business process is greater than 0.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'ModifiedTime' => [ - 'description' => 'The time when the folder was last modified.'."\n", - 'type' => 'string', - 'example' => '2020-09-24T18:37:51+0800', - ], - 'GroupId' => [ - 'description' => 'The ID of the business process to which the folder belongs.'."\n", - 'type' => 'string', - 'example' => 'ds_1234', - ], - 'FolderId' => [ - 'description' => 'The folder ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '11', - ], - 'ProjectId' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10001', - ], - 'FolderName' => [ - 'description' => 'The name of the folder.'."\n", - 'type' => 'string', - 'example' => 'test1', - ], - 'CreatedTime' => [ - 'description' => 'The time when the folder was created.'."\n", - 'type' => 'string', - 'example' => '2020-09-24T18:37:51+0800', - ], - 'TenantId' => [ - 'description' => 'The tenant ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10002', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'E6F0DBDD-5AD****'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Instances' => [ + 'description' => 'The instances.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status of the node that generates the instance. Valid values:'."\n" + ."\n" + .'- NOT\\_RUN: The node is not run.'."\n" + ."\n" + .'- WAIT\\_TIME: The node is waiting for the scheduling time to arrive.'."\n" + ."\n" + .'- WAIT\\_RESOURCE: The node is waiting for resources.'."\n" + ."\n" + .'- RUNNING: The node is running.'."\n" + ."\n" + .'- CHECKING: Data quality is being checked for the node.'."\n" + ."\n" + .'- CHECKING\\_CONDITION: Branch conditions are being checked for the node.'."\n" + ."\n" + .'- FAILURE: The node fails to be run.'."\n" + ."\n" + .'- SUCCESS: The node is successfully run.', 'type' => 'string', 'example' => 'NOT_RUN', 'title' => ''], + 'CycTime' => ['description' => 'The time when the node started to be run. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'example' => '1590422400000', 'title' => ''], + 'BeginRunningTime' => ['description' => 'The time when the instance started to be run. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'example' => '1590416703313', 'title' => ''], + 'FinishTime' => ['description' => 'The time when the running of the node was complete. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'example' => '1590416703313', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message. This parameter is deprecated. You can call the GetInstanceLog operation to query the error information related to the node.', 'type' => 'string', 'example' => 'error message', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the instance was generated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1590416703313', 'title' => ''], + 'DagId' => ['description' => 'The workflow ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '33845', 'title' => ''], + 'TaskType' => ['description' => 'The scheduling type of the node. Valid values:'."\n" + ."\n" + .'- NORMAL(0): The node is an auto triggered node. The scheduling system regularly runs the node.'."\n" + ."\n" + .'- MANUAL(1): The node is a manually triggered node. The scheduling system does not regularly run the node.'."\n" + ."\n" + .'- PAUSE(2): The node is a frozen node. The scheduling system regularly runs the node but sets the status of the node to failed when the scheduling system starts to run the node.'."\n" + ."\n" + .'- SKIP(3): The node is a dry-run node. The scheduling system regularly runs the node but sets the status of the node to successful when the scheduling system starts to run the node.'."\n" + ."\n" + .'- SKIP\\_UNCHOOSE(4): The node is an unselected node in a temporary workflow. This type of node exists only in temporary workflows. The scheduling system sets the status of the node to successful when the scheduling system starts to run the node.'."\n" + ."\n" + .'- SKIP\\_CYCLE(5): The node is a node that is scheduled by the week or month and is waiting for the scheduling time to arrive. The scheduling system regularly runs the node but sets the status of the node to successful when the scheduling system starts to run the node.'."\n" + ."\n" + .'- CONDITION\\_UNCHOOSE(6): The node is not selected by its ancestor branch node and is run as a dry-run node.'."\n" + ."\n" + .'- REALTIME\\_DEPRECATED(7): The node has instances that are generated in real time but deprecated. The scheduling system sets the status of the node to successful.', 'type' => 'string', 'example' => 'NORMAL(0)', 'title' => ''], + 'DagType' => ['description' => 'Indicates whether the instance is associated with a monitoring rule in Data Quality. Valid values:'."\n" + ."\n" + .'- 0: The instance is associated with a monitoring rule in Data Quality.'."\n" + ."\n" + .'- 1: The instance is not associated with a monitoring rule in Data Quality.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'ModifyTime' => ['description' => 'The time when the node was last modified.', 'type' => 'integer', 'format' => 'int64', 'example' => '1590416703313', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'BeginWaitResTime' => ['description' => 'The time when the instance started to wait for resources.', 'type' => 'integer', 'format' => 'int64', 'example' => '1590416703313', 'title' => ''], + 'Bizdate' => ['description' => 'The data timestamp of the instance. In most cases, the value is one day before the time when the instance was run.', 'type' => 'integer', 'format' => 'int64', 'example' => '1590336000000', 'title' => ''], + 'NodeName' => ['description' => 'The name of the node.', 'type' => 'string', 'example' => 'kzh', 'title' => ''], + 'BeginWaitTimeTime' => ['description' => 'The time when the instance started to wait to be scheduled.', 'type' => 'integer', 'format' => 'int64', 'example' => '1590416703313', 'title' => ''], + 'NodeId' => ['description' => 'The node ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '33115', 'title' => ''], + 'InstanceHistoryId' => ['description' => 'The historical record number of the instance.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"Success\\": true,\\n \\"Instances\\": [\\n {\\n \\"Status\\": \\"NOT_RUN\\",\\n \\"CycTime\\": 1590422400000,\\n \\"BeginRunningTime\\": 1590416703313,\\n \\"FinishTime\\": 1590416703313,\\n \\"ErrorMessage\\": \\"error message\\",\\n \\"CreateTime\\": 1590416703313,\\n \\"DagId\\": 33845,\\n \\"TaskType\\": \\"NORMAL(0)\\",\\n \\"DagType\\": \\"1\\",\\n \\"ModifyTime\\": 1590416703313,\\n \\"InstanceId\\": 1234,\\n \\"BeginWaitResTime\\": 1590416703313,\\n \\"Bizdate\\": 1590336000000,\\n \\"NodeName\\": \\"kzh\\",\\n \\"BeginWaitTimeTime\\": 1590416703313,\\n \\"NodeId\\": 33115,\\n \\"InstanceHistoryId\\": 1\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListInstanceHistory', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstanceHistory'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EF****\\",\\n \\"Folder\\": {\\n \\"ParentId\\": 0,\\n \\"ModifiedTime\\": \\"2020-09-24T18:37:51+0800\\",\\n \\"GroupId\\": \\"ds_1234\\",\\n \\"FolderId\\": 11,\\n \\"ProjectId\\": 10001,\\n \\"FolderName\\": \\"test1\\",\\n \\"CreatedTime\\": \\"2020-09-24T18:37:51+0800\\",\\n \\"TenantId\\": 10002\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 0000-ABCD-EF****\\n \\n 0\\n 2020-09-24T18:37:51+0800\\n ds_1234\\n 11\\n 10001\\n test1\\n 2020-09-24T18:37:51+0800\\n 10002\\n \\n","errorExample":""}]', - 'title' => 'GetDataServiceFolder', - 'summary' => 'Queries a folder.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'ramActions' => [], ], - 'ListDataServiceFolders' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListInstances' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -48941,372 +27969,394 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '78304', - 'abilityTreeNodes' => [ - 'FEATUREdide7T0EJX', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '78315', + 'abilityTreeNodes' => ['FEATUREdide4QKMAF'], ], 'parameters' => [ [ - 'name' => 'PageNumber', + 'name' => 'ProjectEnv', 'in' => 'formData', 'schema' => [ - 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, + 'description' => 'The environment in which the node runs. Valid values: DEV and PROD.'."\n", + 'type' => 'string', + 'required' => true, 'docRequired' => true, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '1', - 'default' => '1', + 'enumValueTitles' => [], + 'example' => 'PROD', + 'enum' => ['PROD', 'DEV'], + 'title' => '', ], ], [ - 'name' => 'PageSize', + 'name' => 'NodeId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'maximum' => '50', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], + 'schema' => ['description' => 'Indicates whether the instance is associated with a monitoring rule in Data Quality. Valid values:'."\n" + ."\n" + .'* 0: The instance is associated with a monitoring rule in Data Quality.'."\n" + .'* 1: The instance is not associated with a monitoring rule in Data Quality.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '100000000000', 'title' => ''], + ], + [ + 'name' => 'NodeName', + 'in' => 'formData', + 'schema' => ['description' => 'Indicates whether the node can be rerun.'."\n", 'type' => 'string', 'required' => false, 'example' => 'openmr_8****', 'title' => ''], + ], + [ + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => ['description' => 'The connection string.'."\n", 'type' => 'string', 'required' => false, 'example' => '193379****', 'title' => ''], ], [ 'name' => 'ProjectId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the workspace.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '10001', - ], + 'schema' => ['description' => 'The ID of the baseline.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '12345', 'title' => ''], ], [ - 'name' => 'TenantId', + 'name' => 'BizName', 'in' => 'formData', - 'schema' => [ - 'description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the page that appears, click the username for the logon in the upper-right corner and click User Info in the Menu section.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '10002', - ], + 'schema' => ['description' => 'The ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test_bizName', 'title' => ''], ], [ - 'name' => 'GroupId', + 'name' => 'ProgramType', + 'in' => 'formData', + 'schema' => ['description' => 'The error code returned.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ODPS_SQL', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => ['description' => 'The operation that you want to perform.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'example' => '1', 'default' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the node.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10', 'title' => ''], + ], + [ + 'name' => 'DagId', + 'in' => 'formData', + 'schema' => ['description' => 'The environment of the workspace. Valid values: PROD and DEV. The value PROD indicates the production environment. The value DEV indicates the development environment.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '11111', 'title' => ''], + ], + [ + 'name' => 'Bizdate', + 'in' => 'formData', + 'schema' => ['description' => 'The number of entries returned per page. Default value: 10. Maximum value: 100.'."\n", 'type' => 'string', 'required' => false, 'example' => '2020-02-02 00:00:00', 'title' => ''], + ], + [ + 'name' => 'BeginBizdate', + 'in' => 'formData', + 'schema' => ['description' => 'The parameters related to the node.'."\n", 'type' => 'string', 'required' => false, 'example' => '2020-02-02 00:00:00', 'title' => ''], + ], + [ + 'name' => 'EndBizdate', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the workflow.'."\n", 'type' => 'string', 'required' => false, 'example' => '2020-02-03 00:00:00', 'title' => ''], + ], + [ + 'name' => 'Status', 'in' => 'formData', 'schema' => [ - 'description' => 'The ID of the business process to which the folders belong.'."\n", + 'description' => 'The status of the node. Valid values:'."\n" + ."\n" + .'* NOT_RUN: The node is not run.'."\n" + .'* WAIT_TIME: The node is waiting for the scheduling time to arrive.'."\n" + .'* WAIT_RESOURCE: The node is waiting for resources.'."\n" + .'* RUNNING: The node is running.'."\n" + .'* CHECKING: Data quality is being checked for the node.'."\n" + .'* CHECKING_CONDITION: Branch conditions are being checked for the node.'."\n" + .'* FAILURE: The node fails to run.'."\n" + .'* SUCCESS: The node is successfully run.'."\n", 'type' => 'string', 'required' => false, - 'example' => 'ds_123abc', + 'enumValueTitles' => [], + 'example' => 'NOT_RUN', + 'enum' => ['SUCCESS', 'FAILURE', 'WAIT_TRIGGER', 'CHECKING', 'RUNNING', 'WAIT_RESOURCE', 'WAIT_TIME', 'NOT_RUN'], + 'title' => '', ], ], [ - 'name' => 'FolderNameKeyword', + 'name' => 'OrderBy', 'in' => 'formData', 'schema' => [ - 'description' => 'The keyword in folder names. The keyword is used to search for folders whose names contain this keyword.'."\n", + 'description' => 'The sorting rule of the instances to be returned. Valid values:'."\n" + ."\n" + .'* CREATE_TIME_DESC: The instances are sorted in descending order of their creation time.'."\n" + .'* INSTANCE_ID_DESC (default): The instances are sorted in descending order of their IDs.'."\n", 'type' => 'string', 'required' => false, - 'example' => 'Keyword in folder names'."\n", + 'enumValueTitles' => [], + 'example' => 'INSTANCE_ID_DESC', + 'enum' => ['INSTANCE_ID_DESC', 'CREATE_TIME_DESC'], + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The instances returned.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EF****', - ], - 'FolderPagingResult' => [ - 'description' => 'The paging result for the folders.'."\n", + 'HttpStatusCode' => ['description' => 'The error message that is returned for the instance.'."\n" + ."\n" + .'This parameter is deprecated. You can call the [GetInstanceLog](~~173983~~) operation to query the error information related to the node.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The name of the node.'."\n", 'type' => 'string', 'example' => 'E6F0DBDD-5AD****', 'title' => ''], + 'ErrorMessage' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'string', 'example' => 'The project does not exist.', 'title' => ''], + 'ErrorCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'string', 'example' => 'Invalid.Tenant.ProjectNotExists', 'title' => ''], + 'Success' => ['description' => 'The beginning of the time range to query. Specify the time in the yyyy-MM-dd HH:mm:ss format.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The ID of the node. You can call the [ListNodes](~~173979~~) operation to query the ID of the node.'."\n", 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number. The value of this parameter is the same as that of the PageNumber parameter in the request.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'Folders' => [ - 'description' => 'The folders.'."\n", + 'PageNumber' => ['description' => 'The time when the node was scheduled to run.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The end of the time range to query. Specify the time in the yyyy-MM-dd HH:mm:ss format.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The priority of the instance. Valid values: 1, 3, 5, 7, and 8.'."\n" + ."\n" + .'A greater value indicates a higher priority. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '66', 'title' => ''], + 'Instances' => [ + 'description' => 'The name of the node. You can call the [ListNodes](~~173979~~) operation to query the name of the node.'."\n", 'type' => 'array', 'items' => [ + 'description' => 'The time when the instance was generated.'."\n", 'type' => 'object', 'properties' => [ - 'ParentId' => [ - 'description' => 'The ID of the parent folder. The ID of the root folder in a business process is 0, and the ID of a folder created by a user in a business process is greater than 0.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'ModifiedTime' => [ - 'description' => 'The time when the folder was last modified.'."\n", - 'type' => 'string', - 'example' => '2020-09-24T18:37:51+0800', - ], - 'GroupId' => [ - 'description' => 'The ID of the business process to which the folder belongs.'."\n", - 'type' => 'string', - 'example' => 'ds_1234', - ], - 'FolderId' => [ - 'description' => 'The folder ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '11', - ], - 'FolderName' => [ - 'description' => 'The name of the folder.'."\n", - 'type' => 'string', - 'example' => 'test1', - ], - 'ProjectId' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10001', - ], - 'CreatedTime' => [ - 'description' => 'The time when the folder was created.'."\n", - 'type' => 'string', - 'example' => '2020-09-24T18:37:51+0800', - ], - 'TenantId' => [ - 'description' => 'The tenant ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10002', - ], + 'Status' => ['description' => 'The data timestamp of the instances that you want to query. Specify the timestamp in the yyyy-MM-dd HH:mm:ss format.'."\n", 'type' => 'string', 'example' => 'NOT_RUN', 'title' => ''], + 'CycTime' => ['description' => 'The error message returned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1590422400000', 'title' => ''], + 'BeginRunningTime' => ['description' => 'The time when the instance started to run.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1590416703313', 'title' => ''], + 'FinishTime' => ['description' => 'The ID of the Alibaba Cloud account used by the workspace administrator. You can log on to the Alibaba Cloud Management Console and view the ID on the Security Settings page of the Account Center console.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1590416703313', 'title' => ''], + 'ErrorMessage' => ['description' => 'The name of the account that is used to run the instance. For example, if an account named Test was used to run the instance to backfill data, the value of this parameter is Test.'."\n", 'type' => 'string', 'example' => 'error message', 'title' => ''], + 'CreateTime' => ['description' => 'The interval at which the node is rerun after the node fails to run. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1590416703313', 'title' => ''], + 'DagId' => ['description' => 'The time when the instance started to wait for resources.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '33845', 'title' => ''], + 'Priority' => ['description' => 'The total number of instances.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'TaskType' => ['description' => 'The information about the instances.'."\n", 'type' => 'string', 'example' => 'NORMAL(0)', 'title' => ''], + 'ParamValues' => ['description' => 'The table and partition filter expression in Data Quality that are associated with the node.'."\n", 'type' => 'string', 'example' => 'bizdate=$bizdate tbods=$tbods', 'title' => ''], + 'Connection' => ['description' => 'The number of times the node can be rerun. The value of this parameter can be empty or an integer that is greater than or equal to 0.'."\n" + ."\n" + .'* If the value of this parameter is empty, the number of times that the node can be rerun is not specified.'."\n" + .'* If the value of this parameter is 0, the node cannot be rerun.'."\n" + .'* If the value of this parameter is a positive integer such as n, the node can be rerun n times. For example, if the value of this parameter is 1, the node can be rerun once. If the value of this parameter is 2, the node can be rerun twice.'."\n", 'type' => 'string', 'example' => 'odps_first', 'title' => ''], + 'BaselineId' => ['description' => 'The type of the workflow. Valid values:'."\n" + ."\n" + .'* DAILY: The workflow is used to run auto triggered nodes.'."\n" + .'* MANUAL: The workflow is used to run manually triggered nodes.'."\n" + .'* SMOKE_TEST: The workflow is used to perform smoke testing.'."\n" + .'* SUPPLY_DATA: The workflow is used to backfill data.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123123', 'title' => ''], + 'DqcType' => ['description' => 'The status of the node. Valid values:'."\n" + ."\n" + .'* NOT_RUN: The node is not run.'."\n" + .'* WAIT_TIME: The node is waiting for the scheduling time to arrive.'."\n" + .'* WAIT_RESOURCE: The node is waiting for resources.'."\n" + .'* RUNNING: The node is running.'."\n" + .'* CHECKING: Data quality is being checked for the node.'."\n" + .'* CHECKING_CONDITION: Branch conditions are being checked for the node.'."\n" + .'* FAILURE: The node fails to run.'."\n" + .'* SUCCESS: The node is successfully run.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'DagType' => ['description' => 'The data timestamp of the instance. In most cases, the value is one day before the time when the instance was run.'."\n", 'type' => 'string', 'example' => 'DAILY', 'title' => ''], + 'BusinessId' => ['description' => 'The ID of the workflow to which the node belongs.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'TaskRerunTime' => ['description' => 'The ID of the workspace. You can call the [ListProjects](~~178393~~) operation to query the ID of the workspace.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ModifyTime' => ['description' => 'The name of the workflow. You can call the [ListBusiness](~~173945~~) operation to query the name of the workflow.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1590416703313', 'title' => ''], + 'Repeatability' => ['description' => 'The status of the node. Valid values:'."\n" + ."\n" + .'* NOT_RUN: The node is not run.'."\n" + .'* WAIT_TIME: The node is waiting for the scheduling time to arrive.'."\n" + .'* WAIT_RESOURCE: The node is waiting for resources.'."\n" + .'* RUNNING: The node is running.'."\n" + .'* CHECKING: Data quality is being checked for the node.'."\n" + .'* CHECKING_CONDITION: Branch conditions are being checked for the node.'."\n" + .'* FAILURE: The node fails to run.'."\n" + .'* SUCCESS: The node is successfully run.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RepeatInterval' => ['description' => 'The scheduling type of the node. Valid values:'."\n" + ."\n" + .'* NORMAL(0): The node is an auto triggered node. The scheduling system regularly runs the node.'."\n" + ."\n" + .'* MANUAL(1): The node is a manually triggered node. The scheduling system does not regularly run the node.'."\n" + ."\n" + .'* PAUSE(2): The node is a frozen node. The scheduling system regularly runs the node but sets the status of the node to failed when the scheduling system starts to run the node.'."\n" + ."\n" + .'* SKIP(3): The node is a dry-run node. The scheduling system regularly runs the node but sets the status of the node to succeeded when the scheduling system starts to run the node.'."\n" + ."\n" + .'* SKIP_UNCHOOSE(4): The node is an unselected node in a temporary workflow. This type of node exists only in temporary workflows. The scheduling system sets the status of the node to succeeded when the scheduling system starts to run the node.'."\n" + ."\n" + .'* SKIP_CYCLE(5): The node is a node that is scheduled by week or month and is waiting for the scheduling time to arrive. The scheduling system regularly runs the node but sets the status of the node to succeeded when the scheduling system starts to run the node.'."\n" + ."\n" + .'* CONDITION_UNCHOOSE(6): The node is not selected by its ancestor branch node and is run as a dry-run node.'."\n" + ."\n" + .' REALTIME_DEPRECATED(7): The node has instances that are generated in real time but deprecated. The scheduling system sets the status of the node to succeeded.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '60000', 'title' => ''], + 'InstanceId' => ['description' => 'The number of the page to return. Minimum value:1. Maximum value: 100.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'BeginWaitResTime' => ['description' => 'The time when the node stopped running.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1590416703313', 'title' => ''], + 'RelatedFlowId' => ['description' => 'The type of the node. You can call the [ListNodes](~~173979~~) operation to query the type of the node.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123456', 'title' => ''], + 'Bizdate' => ['description' => 'The number of entries to return on each page. Default value: 10. Maximum value: 100.'."\n" + ."\n" + .'You cannot specify the sorting method for the instances to be returned by this operation. By default, the instances are sorted in descending order of the time when the instances were created.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1590336000000', 'title' => ''], + 'NodeName' => ['description' => 'The ID of the workflow.'."\n", 'type' => 'string', 'example' => 'kzh', 'title' => ''], + 'BeginWaitTimeTime' => ['description' => 'The ID of the request. You can use the ID to locate logs and troubleshoot issues.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1590416703313', 'title' => ''], + 'DqcDescription' => ['description' => 'The operation that you want to perform.'."\n", 'type' => 'string', 'example' => '[{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\\u003d$[yyyy-mm-dd-1]"}]', 'title' => ''], + 'NodeId' => ['description' => 'The environment of the workspace. Valid values: PROD and DEV. The value PROD indicates the production environment. The value DEV indicates the development environment.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '33115', 'title' => ''], + 'CreateUser' => ['description' => 'The ID of the node. You can call the [ListNodes](~~173979~~) operation to query the ID of the node.'."\n", 'type' => 'string', 'example' => 'Test', 'title' => ''], ], + 'title' => '', ], + 'title' => '', ], ], + 'title' => '', ], ], - 'description' => '', - ], - ], - ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', + 'title' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EF****\\",\\n \\"FolderPagingResult\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Folders\\": [\\n {\\n \\"ParentId\\": 0,\\n \\"ModifiedTime\\": \\"2020-09-24T18:37:51+0800\\",\\n \\"GroupId\\": \\"ds_1234\\",\\n \\"FolderId\\": 11,\\n \\"FolderName\\": \\"test1\\",\\n \\"ProjectId\\": 10001,\\n \\"CreatedTime\\": \\"2020-09-24T18:37:51+0800\\",\\n \\"TenantId\\": 10002\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 0000-ABCD-EF****\\n \\n 1\\n 10\\n 100\\n \\n 0\\n 2020-09-24T18:37:51+0800\\n ds_1234\\n 11\\n test1\\n 10001\\n 2020-09-24T18:37:51+0800\\n 10002\\n \\n \\n","errorExample":""}]', - 'title' => 'ListDataServiceFolders', - 'summary' => 'Queries folders.', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"ErrorMessage\\": \\"The project does not exist.\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ProjectNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 66,\\n \\"Instances\\": [\\n {\\n \\"Status\\": \\"NOT_RUN\\",\\n \\"CycTime\\": 1590422400000,\\n \\"BeginRunningTime\\": 1590416703313,\\n \\"FinishTime\\": 1590416703313,\\n \\"ErrorMessage\\": \\"error message\\",\\n \\"CreateTime\\": 1590416703313,\\n \\"DagId\\": 33845,\\n \\"Priority\\": 1,\\n \\"TaskType\\": \\"NORMAL(0)\\",\\n \\"ParamValues\\": \\"bizdate=$bizdate tbods=$tbods\\",\\n \\"Connection\\": \\"odps_first\\",\\n \\"BaselineId\\": 123123,\\n \\"DqcType\\": 1,\\n \\"DagType\\": \\"DAILY\\",\\n \\"BusinessId\\": 123,\\n \\"TaskRerunTime\\": 0,\\n \\"ModifyTime\\": 1590416703313,\\n \\"Repeatability\\": true,\\n \\"RepeatInterval\\": 60000,\\n \\"InstanceId\\": 1234,\\n \\"BeginWaitResTime\\": 1590416703313,\\n \\"RelatedFlowId\\": 123456,\\n \\"Bizdate\\": 1590336000000,\\n \\"NodeName\\": \\"kzh\\",\\n \\"BeginWaitTimeTime\\": 1590416703313,\\n \\"DqcDescription\\": \\"[{\\\\\\"projectName\\\\\\":\\\\\\"ztjy_dim\\\\\\",\\\\\\"tableName\\\\\\":\\\\\\"dim_user_agent_manage_area_a\\\\\\",\\\\\\"partition\\\\\\":\\\\\\"ds\\\\\\\\u003d$[yyyy-mm-dd-1]\\\\\\"}]\\",\\n \\"NodeId\\": 33115,\\n \\"CreateUser\\": \\"Test\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n E6F0DBDD-5AD****\\n The project does not exist.\\n Invalid.Tenant.ProjectNotExists\\n true\\n \\n 1\\n 10\\n 66\\n \\n NOT_RUN\\n 1590422400000\\n 1590416703313\\n 1590416703313\\n error message\\n 1590416703313\\n 33845\\n 1\\n NORMAL(0)\\n bizdate=$bizdate tbods=$tbods\\n odps_first\\n 123123\\n 1\\n DAILY\\n 123\\n 0\\n 1590416703313\\n true\\n 60000\\n 1234\\n 1590416703313\\n 123456\\n 1590336000000\\n kzh\\n 1590416703313\\n [{\\"projectName\\":\\"ztjy_dim\\",\\"tableName\\":\\"dim_user_agent_manage_area_a\\",\\"partition\\":\\"ds\\\\u003d$[yyyy-mm-dd-1]\\"}]\\n 33115\\n Test\\n \\n \\n","errorExample":""}]', + 'title' => 'ListInstances', + 'summary' => 'Queries a list of instances.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateDataServiceGroup' => [ - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2023-12-07T06:42:31.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-31T10:19:41.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstances'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListLineage' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '78182', - 'abilityTreeNodes' => [ - 'FEATUREdide7T0EJX', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '178500', + 'abilityTreeNodes' => ['FEATUREdideSYOMAV'], ], 'parameters' => [ [ - 'name' => 'TenantId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The tenant ID. This parameter is deprecated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '10002', - ], + 'name' => 'EntityQualifiedName', + 'in' => 'query', + 'schema' => ['description' => 'The unique identifier of the entity.'."\n", 'type' => 'string', 'required' => true, 'example' => 'maxcompute-table.project.table'], ], [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the workspace.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '10001', - ], + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'The pagination token that is used in the next request to retrieve a new page of results.'."\n", 'type' => 'string', 'required' => false, 'example' => 'next-token-from-previous-request'], ], [ - 'name' => 'ApiGatewayGroupId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the API group that is associated with the business process in the API Gateway console. You can log on to the API Gateway console and go to the Group Details page to view the ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1000abcd', - ], + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => ['description' => 'The keyword of the entity name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'name-keyword'], ], [ - 'name' => 'GroupName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the business process.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Business process name'."\n", - ], + 'name' => 'Direction', + 'in' => 'query', + 'schema' => ['description' => 'The lineage type. Valid values:'."\n" + ."\n" + .'* up: ancestor lineage'."\n" + .'* down: descendant lineage'."\n", 'type' => 'string', 'required' => true, 'example' => 'up'], ], [ - 'name' => 'Description', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The description of the business process.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'Test business process'."\n", - ], + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Maximum value: 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'OpenApiMetaResultModel'."\n", 'type' => 'object', 'properties' => [ - 'GroupId' => [ - 'description' => 'The business process ID.'."\n", - 'type' => 'string', - 'example' => 'ds_12345', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EF****', + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'qualifiedName should be in format as entity-table.entity-guid'], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '64B-587A-8CED-969E1973887FXXX-TT'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '1010040007'], + 'Data' => [ + 'description' => 'The structure returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'NextToken' => ['description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.'."\n", 'type' => 'string', 'example' => 'nextTokenFromRequest-xxxsd-ff'], + 'DataEntityList' => [ + 'description' => 'The array of the entity structure.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The entity structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'Entity' => ['description' => 'The information about the entity.'."\n", '$ref' => '#/components/schemas/Entity'], + 'CreateTimestamp' => ['description' => 'The time when the lineage was generated.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1686215809269'], + 'RelationList' => [ + 'description' => 'The array of the relationship structure.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The relationship structure.'."\n", + 'type' => 'object', + 'properties' => [ + 'Guid' => ['description' => 'The unique relationship ID.'."\n", 'type' => 'string', 'example' => 'aaabbccddguid'], + 'Datasource' => ['description' => 'The data source.'."\n", 'type' => 'string', 'example' => 'mysql'], + 'Type' => ['description' => 'The task type, which is used to describe the relationship between entities, such as SQL-based calculation, mapping based on report fields, or API operation definition.'."\n", 'type' => 'string', 'example' => 'sql'], + 'Channel' => ['description' => 'The data channel. Valid values:'."\n" + ."\n" + .'* **FIRST_PARTY: DataWorks platform**'."\n" + .'* **THIRD_PARTY: user registration**'."\n", 'type' => 'string', 'example' => 'THIRD_PARTY'], + ], + ], + ], + ], + ], + ], + ], ], ], - 'description' => '', ], ], ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"qualifiedName should be in format as entity-table.entity-guid\\",\\n \\"RequestId\\": \\"64B-587A-8CED-969E1973887FXXX-TT\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1010040007\\",\\n \\"Data\\": {\\n \\"NextToken\\": \\"nextTokenFromRequest-xxxsd-ff\\",\\n \\"DataEntityList\\": [\\n {\\n \\"Entity\\": {\\n \\"QualifiedName\\": \\"maxcompute_table.563f0357118d05ef145d6bddf2966cc23e86ca8f2f013f915e565afdf09f7a23\\",\\n \\"TenantId\\": 12345,\\n \\"EntityContent\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"CreateTimestamp\\": 1686215809269,\\n \\"RelationList\\": [\\n {\\n \\"Guid\\": \\"aaabbccddguid\\",\\n \\"Datasource\\": \\"maxcompute,mysql\\",\\n \\"Type\\": \\"sql\\",\\n \\"Channel\\": \\"THIRD_PARTY\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n qualifiedName should be in format as entity-table.entity-guid\\n 64B-587A-8CED-969E1973887FXXX-TT\\n true\\n 1010040007\\n \\n nextTokenFromRequest-xxxsd-ff\\n \\n \\n maxcompute_table.563f0357118d05ef145d6bddf2966cc23e86ca8f2f013f915e565afdf09f7a23\\n 12345\\n \\n 1686215809269\\n \\n aaabbccddguid\\n mysql\\n sql\\n THIRD_PARTY\\n \\n \\n \\n","errorExample":""}]', + 'title' => 'ListLineage', + 'summary' => 'Queries the ancestor or descendant lineage of an entity.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"GroupId\\": \\"ds_12345\\",\\n \\"RequestId\\": \\"0000-ABCD-EF****\\"\\n}","type":"json"}]', - 'title' => 'CreateDataServiceGroup', - 'summary' => 'Creates a business process.', ], - 'GetDataServiceGroup' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListManualDagInstances' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -49315,165 +28365,121 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '78238', - 'abilityTreeNodes' => [ - 'FEATUREdide7T0EJX', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '78316', + 'abilityTreeNodes' => ['FEATUREdideVFMENL'], ], 'parameters' => [ [ - 'name' => 'TenantId', + 'name' => 'ProjectEnv', 'in' => 'formData', 'schema' => [ - 'description' => 'The tenant ID. This parameter is deprecated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '10002', + 'description' => 'The environment of Operation Center. Valid values: PROD and DEV.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'RPOD', + 'enum' => ['PROD', 'DEV'], ], ], [ - 'name' => 'ProjectId', + 'name' => 'ProjectName', 'in' => 'formData', - 'schema' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '10001', - ], + 'schema' => ['description' => 'The name of the workspace to which the manually triggered workflow belongs. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the name.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test_workspace'], ], [ - 'name' => 'GroupId', + 'name' => 'DagId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The business process ID.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ds_123abc', - ], + 'schema' => ['description' => 'The ID of the directed acyclic graph (DAG) for the manually triggered workflow. You can call the [RunManualDagNodes](~~212830~~) operation to obtain the ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '7000001231241'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EF****', - ], - 'Group' => [ - 'description' => 'The details of the business process.'."\n", - 'type' => 'object', - 'properties' => [ - 'ModifiedTime' => [ - 'description' => 'The time when the business process was last modified.'."\n", - 'type' => 'string', - 'example' => '2020-09-24T18:37:51+0800', - ], - 'Description' => [ - 'description' => 'The description of the business process.'."\n", - 'type' => 'string', - 'example' => 'Test'."\n", - ], - 'GroupName' => [ - 'description' => 'The name of the business process.'."\n", - 'type' => 'string', - 'example' => 'Test'."\n", - ], - 'GroupId' => [ - 'description' => 'The business process ID.'."\n", - 'type' => 'string', - 'example' => 'ds_123abc', - ], - 'ProjectId' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10002', - ], - 'ApiGatewayGroupId' => [ - 'description' => 'The ID of the API group that is associated with the business process in the API Gateway console.'."\n", - 'type' => 'string', - 'example' => '100abc', - ], - 'CreatorId' => [ - 'description' => 'The user identifier (UID) of the creator of the business process. The value of this parameter may be empty for creators of some existing business processes.'."\n", - 'type' => 'string', - 'example' => '10001', - ], - 'CreatedTime' => [ - 'description' => 'The time when the business process was created.'."\n", - 'type' => 'string', - 'example' => '2020-09-24T18:37:51+0800', - ], - 'TenantId' => [ - 'description' => 'The tenant ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10003', + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF'], + 'Instances' => [ + 'description' => 'The instances in the manually triggered workflow.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status of the instance. Valid values:'."\n" + ."\n" + .'* NOT_RUN: The instance is not run.'."\n" + .'* WAIT_TIME: The instance is waiting for its scheduling time to arrive.'."\n" + .'* WAIT_RESOURCE: The instance is waiting for resources.'."\n" + .'* RUNNING: The instance is running.'."\n" + .'* CHECKING: Data quality is being checked for the instance.'."\n" + .'* CHECKING_CONDITION: Branch conditions are being checked for the instance.'."\n" + .'* FAILURE: The instance fails to be run.'."\n" + .'* SUCCESS: The instance is successfully run.'."\n", 'type' => 'string', 'example' => 'SUCCESS'], + 'BeginRunningTime' => ['description' => 'The time when the instance started to run.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1605178414676'], + 'BizDate' => ['description' => 'The data timestamp of the instance. In most cases, the value is one day before the time when the instance was run.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1605178414676'], + 'CycTime' => ['description' => 'The time when the instance was scheduled to run.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1605178414676'], + 'FinishTime' => ['description' => 'The time when the instance finished running.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1605178414676'], + 'CreateTime' => ['description' => 'The time when the instance was generated.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1605178414676'], + 'DagId' => ['description' => 'The ID of the DAG for the instance in the manually triggered workflow.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '350850491'], + 'InstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '11726873619'], + 'BeginWaitResTime' => ['description' => 'The time when the instance started to wait for resources.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1605178414676'], + 'TaskType' => ['description' => 'The scheduling type of the node. Valid values:'."\n" + ."\n" + .'* NORMAL(0): The node is an auto triggered node. The scheduling system regularly runs the node.'."\n" + .'* MANUAL(1): The node is a manually triggered node. The scheduling system does not regularly run the node.'."\n" + .'* PAUSE(2): The node is a frozen node. The scheduling system regularly runs the node but sets the status of the node to failed when the scheduling system starts to run the node.'."\n" + .'* SKIP(3): The node is a dry-run node. The scheduling system regularly runs the node but sets the status of the node to successful when the scheduling system starts to run the node.'."\n" + .'* SKIP_UNCHOOSE(4): The node is an unselected node in a temporary workflow. This type of node exists only in temporary workflows. The scheduling system sets the status of the node to successful when the scheduling system starts to run the node.'."\n" + .'* SKIP_CYCLE(5): The node is a node that is scheduled by week or month and is waiting for the scheduling time to arrive. The scheduling system regularly runs the node but sets the status of the node to successful when the scheduling system starts to run the node.'."\n" + .'* CONDITION_UNCHOOSE(6): The node is not selected by its ancestor branch node and is run as a dry-run node.'."\n" + .'* REALTIME_DEPRECATED(7): The node has instances that are generated in real time but deprecated. The scheduling system sets the status of the node to successful.'."\n", 'type' => 'string', 'example' => 'MANUAL'], + 'ParamValues' => ['description' => 'The parameters related to the instance.'."\n", 'type' => 'string', 'example' => 'xxx=yyy'], + 'DagType' => ['description' => 'The type of the manually triggered workflow.'."\n", 'type' => 'string', 'example' => '5'], + 'NodeName' => ['description' => 'The name of the node.'."\n", 'type' => 'string', 'example' => 'test2'], + 'BeginWaitTimeTime' => ['description' => 'The time when the instance started to wait to be scheduled.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1605178414676'], + 'NodeId' => ['description' => 'The ID of the node in the manually triggered workflow.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '37851'], + 'ModifyTime' => ['description' => 'The time when the instance was last modified.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1605178414676'], + 'CreateUser' => ['description' => 'The name of the account that is used to run the instance. For example, if you use an account named Test to run the instance, the value of this parameter is Test.'."\n", 'type' => 'string', 'example' => 'Test'], ], ], ], ], - 'description' => '', ], ], ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF\\",\\n \\"Instances\\": [\\n {\\n \\"Status\\": \\"SUCCESS\\",\\n \\"BeginRunningTime\\": 1605178414676,\\n \\"BizDate\\": 1605178414676,\\n \\"CycTime\\": 1605178414676,\\n \\"FinishTime\\": 1605178414676,\\n \\"CreateTime\\": 1605178414676,\\n \\"DagId\\": 350850491,\\n \\"InstanceId\\": 11726873619,\\n \\"BeginWaitResTime\\": 1605178414676,\\n \\"TaskType\\": \\"MANUAL\\",\\n \\"ParamValues\\": \\"xxx=yyy\\",\\n \\"DagType\\": \\"5\\",\\n \\"NodeName\\": \\"test2\\",\\n \\"BeginWaitTimeTime\\": 1605178414676,\\n \\"NodeId\\": 37851,\\n \\"ModifyTime\\": 1605178414676,\\n \\"CreateUser\\": \\"Test\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF\\n \\n SUCCESS\\n 1605178414676\\n 1605178414676\\n 1605178414676\\n 1605178414676\\n 1605178414676\\n 350850491\\n 11726873619\\n 1605178414676\\n MANUAL\\n xxx=yyy\\n 5\\n test2\\n 1605178414676\\n 37851\\n 1605178414676\\n Test\\n \\n","errorExample":""}]', + 'title' => 'ListManualDagInstances', + 'summary' => 'Queries the information about instances in a manually triggered workflow.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-06-25T08:37:03.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-01-05T02:11:00.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EF****\\",\\n \\"Group\\": {\\n \\"ModifiedTime\\": \\"2020-09-24T18:37:51+0800\\",\\n \\"Description\\": \\"业务流程描述\\",\\n \\"GroupName\\": \\"业务流程名称\\",\\n \\"GroupId\\": \\"ds_123abc\\",\\n \\"ProjectId\\": 10002,\\n \\"ApiGatewayGroupId\\": \\"100abc\\",\\n \\"CreatorId\\": \\"10001\\",\\n \\"CreatedTime\\": \\"2020-09-24T18:37:51+0800\\",\\n \\"TenantId\\": 10003\\n }\\n}","type":"json"}]', - 'title' => 'GetDataServiceGroup', - 'summary' => 'Queries a business process.', ], - 'ListDataServiceGroups' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListMeasureData' => [ + 'summary' => 'Queries the statistics on the number of phone call-based alerts or text message-based alerts reported within the tenant to which your account belongs during the previous 30 days.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -49482,510 +28488,332 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '78305', - 'abilityTreeNodes' => [ - 'FEATUREdide7T0EJX', - ], + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '215284', + 'abilityTreeNodes' => ['FEATUREdideD3SWSQ'], ], 'parameters' => [ [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'maximum' => '50', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], + 'name' => 'DomainCode', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The measurement item. Valid values:'."\n" + ."\n" + .'* DideAlarmPhone: phone call-based alerts'."\n" + .'* DideAlarmSms: text message-based alerts'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DideAlarmPhone', 'title' => ''], ], [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '10000', - ], + 'name' => 'ComponentCode', + 'in' => 'query', + 'schema' => ['description' => 'The metering component. Valid values:'."\n" + ."\n" + .'* Count: The number of DideAlarmPhone (telephone/call) alerts, and the number of DideAlarmSms (SMS/text message) alerts.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Count', 'title' => ''], ], - [ - 'name' => 'TenantId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The tenant ID. This parameter is deprecated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '10001', - ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The start timestamp of the metering cycle, in milliseconds. The metering data is aggregated by day. The time range between EndTime and StartTime cannot exceed 30 days.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1717344000000', 'title' => ''], ], [ - 'name' => 'GroupNameKeyword', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The keyword of a business process name. The keyword is used to search for business processes whose names contain this keyword.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Test business process'."\n", - ], + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end timestamp of the metering cycle, in milliseconds. The metering data is aggregated by day. The time range between EndTime and StartTime cannot exceed 30 days.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1717430400000', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'The returned result.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EF****', - ], - 'GroupPagingResult' => [ - 'description' => 'The paging result for the business processes.'."\n", - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number. The value of this parameter is the same as that of the PageNumber parameter in the request.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. Valid values: 1 to 100. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'Groups' => [ - 'description' => 'The business processes.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ModifiedTime' => [ - 'description' => 'The time when the business process was modified.'."\n", - 'type' => 'string', - 'example' => '2020-09-24T18:37:51+0800', - ], - 'Description' => [ - 'description' => 'The description of the business process.'."\n", - 'type' => 'string', - 'example' => 'Test'."\n", - ], - 'GroupName' => [ - 'description' => 'The name of the business process.'."\n", - 'type' => 'string', - 'example' => 'Test'."\n", - ], - 'GroupId' => [ - 'description' => 'The business process ID.'."\n", - 'type' => 'string', - 'example' => 'ds_123abc', - ], - 'ProjectId' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10002', - ], - 'ApiGatewayGroupId' => [ - 'description' => 'The ID of the API Gateway group to which the workflow is bound.'."\n", - 'type' => 'string', - 'example' => '100abc', - ], - 'CreatorId' => [ - 'description' => 'The user identifier (UID) of the creator of the business process. The value of this parameter may be empty for creators of some existing business processes.'."\n", - 'type' => 'string', - 'example' => '10001', - ], - 'CreatedTime' => [ - 'description' => 'The time when the business process was created.'."\n", - 'type' => 'string', - 'example' => '2020-09-24T18:37:51+0800', - ], - 'TenantId' => [ - 'description' => 'The tenant ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10003', - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AFAE64E-D1BE-432B-A9****', 'title' => ''], + 'MeasureDatas' => [ + 'title' => '', + 'description' => 'The metering results.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DomainCode' => ['description' => 'The item that is measured.'."\n", 'type' => 'string', 'example' => 'DideAlarmPhone', 'title' => ''], + 'ComponentCode' => ['description' => 'The measurement component.'."\n", 'type' => 'string', 'example' => 'Count', 'title' => ''], + 'StartTime' => ['description' => 'The start timestamp of the metering cycle, in milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1717344000000', 'title' => ''], + 'EndTime' => ['description' => 'The end timestamp of the metering cycle, in milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1717430400000', 'title' => ''], + 'Usage' => ['description' => 'The total quantity used within the measurement period.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '100001001', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The user is not in tenant.', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], ], - 'description' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], + ['errorCode' => 'Invalid.Tenant.UserNotInTenant', 'errorMessage' => 'The user is not in tenant.', 'description' => 'The user is not in tenant.'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EF****\\",\\n \\"GroupPagingResult\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Groups\\": [\\n {\\n \\"ModifiedTime\\": \\"2020-09-24T18:37:51+0800\\",\\n \\"Description\\": \\"业务流程描述\\",\\n \\"GroupName\\": \\"业务流程名称\\",\\n \\"GroupId\\": \\"ds_123abc\\",\\n \\"ProjectId\\": 10002,\\n \\"ApiGatewayGroupId\\": \\"100abc\\",\\n \\"CreatorId\\": \\"10001\\",\\n \\"CreatedTime\\": \\"2020-09-24T18:37:51+0800\\",\\n \\"TenantId\\": 10003\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n \\n \\n \\n","errorExample":""}]', - 'title' => 'ListDataServiceGroups', - 'summary' => 'Queries business processes.', - ], - 'CreateDataServiceApiAuthority' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListMeasureData', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AFAE64E-D1BE-432B-A9****\\",\\n \\"MeasureDatas\\": [\\n {\\n \\"DomainCode\\": \\"DideAlarmPhone\\",\\n \\"ComponentCode\\": \\"Count\\",\\n \\"StartTime\\": 1717344000000,\\n \\"EndTime\\": 1717430400000,\\n \\"Usage\\": 10\\n }\\n ],\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"100001001\\",\\n \\"ErrorMessage\\": \\"The user is not in tenant.\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + ], + 'ListMetaCollectionEntities' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '78180', - 'abilityTreeNodes' => [ - 'FEATUREdideWDSR97', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '163137', + 'abilityTreeNodes' => ['FEATUREdideE9XYA6'], ], 'parameters' => [ [ - 'name' => 'TenantId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The tenant ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '1004', - ], + 'name' => 'CollectionQualifiedName', + 'in' => 'query', + 'schema' => ['description' => 'The unique identifier of the collection.'."\n", 'type' => 'string', 'required' => true, 'example' => 'album.12345'], ], [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the workspace.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '10003', - ], + 'name' => 'EntityType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the entities.'."\n" + ."\n" + .'For example, if this parameter is set to maxcompute-table, the entity is a MaxCompute table.'."\n", 'type' => 'string', 'required' => false, 'example' => 'maxcompute-table'], ], [ - 'name' => 'ApiId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the API.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '10001', - ], + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => ['description' => 'The search keyword.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test'], ], [ - 'name' => 'AuthorizedProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the workspace to which the access permissions on the API are granted.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '10002', - ], + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'The pagination token that is used in the next request to retrieve a new page of results.'."\n", 'type' => 'string', 'required' => false, 'example' => '12222'], ], [ - 'name' => 'EndTime', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The end time of the validity period of the access permissions. The time must be a UNIX timestamp. Unit: seconds. Example: 1600531564, which indicates 2020-09-20 00:06:04 (UTC+8).'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '1600531564', - ], + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'OpenApiMetaResultModel', + 'description' => 'OpenApiMetaResultModel'."\n", 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the authorization was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EF****', + 'Data' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'NextToken' => ['description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.'."\n", 'type' => 'string', 'example' => '123344'], + 'EntityList' => [ + 'description' => 'The entities.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The entities.'."\n", '$ref' => '#/components/schemas/Entity'], + ], + ], ], + 'RequestId' => ['description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", 'type' => 'string', 'example' => 'E25887B7-579C-54A5-9C4F-83A0DE367DD'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'true: The request was successful.'."\n" + ."\n" + .'false: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'Invalid.Collection.NotExists'], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The specified parameters are invalid.'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], ], - 'description' => '', ], ], ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": {\\n \\"NextToken\\": \\"123344\\",\\n \\"EntityList\\": [\\n {\\n \\"QualifiedName\\": \\"maxcompute_table.563f0357118d05ef145d6bddf2966cc23e86ca8f2f013f915e565afdf09f7a23\\",\\n \\"TenantId\\": 12345,\\n \\"EntityContent\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ]\\n },\\n \\"RequestId\\": \\"E25887B7-579C-54A5-9C4F-83A0DE367DD\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Collection.NotExists\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"HttpStatusCode\\": 200\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 12\\n \\n \\n maxcompute-table\\n table_name_for_example\\n maxcomputeProjectName\\n cui\\n 1691563804264\\n \\n maxcompute-table.maxcomputeProjectName.table_name_for_example\\n \\n \\n E25887B7-579C-54A5-9C4F-83A0DE367DD\\n true\\n Invalid.Collection.NotExists\\n The specified parameters are invalid.\\n 200\\n","errorExample":""}]', + 'title' => 'ListMetaCollectionEntities', + 'summary' => 'Queries the entities in a collection.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMetaCollectionEntities'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0000-ABCD-EF****\\"\\n}","errorExample":""},{"type":"xml","example":"0000-ABCD-EFo****\\ntrue","errorExample":""}]', - 'title' => 'CreateDataServiceApiAuthority', - 'summary' => 'Grants the access permissions on an API in DataService Studio.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'ramActions' => [], ], - 'DeleteDataServiceApiAuthority' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListMetaCollections' => [ + 'summary' => 'Retrieves a list of collections. Collections include data albums displayed on the Data Map page and categories created in data albums. You can filter collections by type.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '78205', - 'abilityTreeNodes' => [ - 'FEATUREdideWDSR97', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '162854', + 'abilityTreeNodes' => ['FEATUREdideE9XYA6'], ], 'parameters' => [ [ - 'name' => 'TenantId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The tenant ID. This parameter is deprecated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '10004', - ], + 'name' => 'ParentQualifiedName', + 'in' => 'query', + 'schema' => ['description' => 'The unique identifier of the parent collection.', 'type' => 'string', 'required' => false, 'example' => 'Album.1234', 'title' => ''], ], [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '10003', - ], + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'The pagination token that is used in the next request to retrieve a new page of results.', 'type' => 'string', 'required' => false, 'example' => '12345', 'title' => ''], ], [ - 'name' => 'ApiId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The API ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '10001', - ], + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'AuthorizedProjectId', - 'in' => 'formData', + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => ['description' => 'The keyword.', 'type' => 'string', 'example' => 'Keyword', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => ['description' => 'The name of the sorting field.', 'type' => 'string', 'example' => 'Sort field', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'CollectionType', + 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the workspace from which you want to revoke the access permissions on the API.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => '- ALBUM: data album'."\n" + ."\n" + .'- ALBUM\\_CATEGORY: category in a data album', + 'enumValueTitles' => [], + 'type' => 'string', 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '10002', + 'example' => 'ALBUM', + 'title' => '', ], ], + [ + 'name' => 'Creator', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the collection creator.', 'type' => 'string', 'required' => false, 'example' => '1200759642363000', 'title' => ''], + ], + [ + 'name' => 'Administrator', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the collection administrator.', 'type' => 'string', 'required' => false, 'example' => '1200759642363000', 'title' => ''], + ], + [ + 'name' => 'Follower', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the collection follower.', 'type' => 'string', 'required' => false, 'example' => '1200759642363000', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EF****', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'E25887B7-579C-54A5-9C4F-83A0DE367DDE'], + 'Data' => [ + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'NextToken' => ['description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.', 'type' => 'string', 'example' => '37ae2053d87d380f28ce0dc0853ca51e', 'title' => ''], + 'CollectionList' => [ + 'description' => 'The collections.', + 'type' => 'array', + 'items' => ['description' => 'The collection.', '$ref' => '#/components/schemas/Collection', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Invalid.Collection.NotExists', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified parameters are invalid.', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], ], - 'description' => '', - ], - ], - ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', + 'example' => '', ], ], - 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Invalid.Collection.ParamError', 'errorMessage' => 'msg: %s', 'description' => ''], + ['errorCode' => 'Invalid.User.NotExist', 'errorMessage' => 'msg: %s', 'description' => ''], + ['errorCode' => 'Invalid.Collection.QualifiedNameError', 'errorMessage' => 'msg: %s', 'description' => ''], + ['errorCode' => 'Invalid.Collection.CollectionNotCompatible', 'errorMessage' => 'msg: %s', 'description' => ''], + ['errorCode' => 'Invalid.Collection.EntityOverflow', 'errorMessage' => 'msg: %s', 'description' => ''], + ['errorCode' => 'Invalid.Collection.NotExist', 'errorMessage' => 'msg: %s', 'description' => ''], + ['errorCode' => 'Invalid.Collection.AlreadyExist', 'errorMessage' => 'msg: %s', 'description' => ''], + ['errorCode' => 'Invalid.Collection.UnsupportedOperation', 'errorMessage' => 'msg: %s', 'description' => ''], + ['errorCode' => 'InvalidParameter.Meta.Missing', 'errorMessage' => 'msg: %s', 'description' => ''], + ['errorCode' => 'Forbidden.No.Permission', 'errorMessage' => 'msg: %s', 'description' => ''], + ['errorCode' => 'InvalidParameter.Meta.IllegalData', 'errorMessage' => 'msg: %s', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E25887B7-579C-54A5-9C4F-83A0DE367DDE\\",\\n \\"Data\\": {\\n \\"NextToken\\": \\"37ae2053d87d380f28ce0dc0853ca51e\\",\\n \\"CollectionList\\": [\\n {\\n \\"QualifiedName\\": \\"album.12334\\",\\n \\"CollectionType\\": \\"album\\",\\n \\"Name\\": \\"collectionName\\",\\n \\"Comment\\": \\"comment\\",\\n \\"OwnerId\\": \\"1234444\\",\\n \\"OwnerName\\": \\"owner\\",\\n \\"CreateTime\\": 1668600147617,\\n \\"UpdateTime\\": 1668600148617,\\n \\"Level\\": 1\\n }\\n ]\\n },\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Collection.NotExists\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => 'ListMetaCollections', + 'description' => 'Collections include ALBUM (data album) and ALBUM\\_CATEGORY (category within a data album).', + 'requestParamsDescription' => 'You can set at most one of the Creator, Administrator, and Follower parameters.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMetaCollections'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0000-ABCD-EF****\\"\\n}","type":"json"}]', - 'title' => 'DeleteDataServiceApiAuthority', - 'summary' => 'Revokes the access permissions on an API.', + 'translator' => 'manual', ], - 'ListDataServiceApiTest' => [ - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListMetaDB' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -49995,147 +28823,121 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', + 'abilityTreeCode' => '78317', + 'abilityTreeNodes' => ['FEATUREdideE9XYA6'], ], 'parameters' => [ [ - 'name' => 'ApiId', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the DataService Studio API on which tests are performed.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '12345', - ], + 'schema' => ['description' => 'The DataWorks workspace ID. You can call the [ListProjects](~~178393~~) operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '123', 'title' => ''], + ], + [ + 'name' => 'DataSourceType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the data source. Set the value to emr.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'emr', 'title' => ''], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10000', 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the E-MapReduce (EMR) cluster. You can log on to the [EMR console](https://emr.console.aliyun.com/?spm=a2c4g.11186623.0.0.965cc5c2GeiHet#/cn-hangzhou) to query the ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'description' => 'The returned result.'."\n", + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'ESDAFWEA', - ], - 'Data' => [ - 'description' => 'The list of test records.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The test record.'."\n", - 'type' => 'object', - 'properties' => [ - 'TestId' => [ - 'description' => 'The ID of the test.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'ApiId' => [ - 'description' => 'The ID of the DataService Studio API on which the test is performed.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2343', - ], - 'ParamMap' => [ - 'description' => 'The request parameters configured for the test.'."\n", - 'type' => 'string', - 'example' => '{"name":"test"}', - ], - 'RetCode' => [ - 'description' => 'The status code returned for the test. If the test is not complete, this parameter is not returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'RetResult' => [ - 'description' => 'The result returned for the test.'."\n", - 'type' => 'string', - 'example' => '{"id":2}', - ], - 'CostTime' => [ - 'description' => 'The time that is consumed to complete the test.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Status' => [ - 'description' => 'The status of the test. Valid values: RUNNING and FINISHED.'."\n", - 'type' => 'string', - 'example' => 'FINISHED', - ], - 'CreateTime' => [ - 'description' => 'The time when the test was initiated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1651824913000', + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'abc', 'title' => ''], + 'DatabaseInfo' => [ + 'description' => 'The information about the metadatabases.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['description' => 'The total number of the metadatabases returned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'DbList' => [ + 'description' => 'The metadatabases.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The type of the metadatabase.'."\n", 'type' => 'string', 'example' => 'HIVE', 'title' => ''], + 'CreateTimeStamp' => ['description' => 'The timestamp at which the metadatabase was created. You can convert the timestamp to the date based on the time zone that you use.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1388776825', 'title' => ''], + 'UUID' => ['description' => 'The UUID of the metadatabase.'."\n", 'type' => 'string', 'example' => '32342', 'title' => ''], + 'ModifiedTimeStamp' => ['description' => 'The timestamp at which the metadatabase was updated.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1388776837', 'title' => ''], + 'Name' => ['description' => 'The name of the metadatabase.'."\n", 'type' => 'string', 'example' => 'name', 'title' => ''], + 'OwnerId' => ['description' => 'The owner ID.'."\n", 'type' => 'string', 'example' => '1232', 'title' => ''], + 'Location' => ['description' => 'The URL of the metadatabase.'."\n", 'type' => 'string', 'example' => 'hdfs://localhost:777/user/hadoop/test.txt', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Invalid.Meta.AppNotExist', 'errorMessage' => 'The MaxCompute project does not exist.', 'description' => 'The MaxCompute project does not exist.'], + ['errorCode' => 'InvalidParameter.Meta.CommonError', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The request parameter is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.Illegal', 'errorMessage' => 'The app guid parameter is invalid.', 'description' => 'The app guid parameter is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.IllegalDate', 'errorMessage' => 'The date format is invalid.', 'description' => 'The date format is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.IllegalPageError', 'errorMessage' => 'The parameter for paging is invalid.', 'description' => 'The parameter for paging is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.NotExist', 'errorMessage' => 'The object does not exist.', 'description' => ''], + ], 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + ['errorCode' => 'Forbidden.Meta.NoTenant', 'errorMessage' => 'The user is not the owner of any tenants.', 'description' => 'The user is not the owner of any tenants.'], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], ], 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.Meta.NoCalcEngine', 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.', 'description' => ''], + ['errorCode' => 'InternalError.Meta.TenantTimeOut', 'errorMessage' => 'Failed to connect to the interface network.', 'description' => 'Failed to connect to the interface network.'], + ['errorCode' => 'InternalError.Meta.Unknown', 'errorMessage' => 'An unknown error occurred while processing your request.', 'description' => 'An unknown error occurred while processing your request.'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"ESDAFWEA\\",\\n \\"Data\\": [\\n {\\n \\"TestId\\": 123,\\n \\"ApiId\\": 2343,\\n \\"ParamMap\\": \\"{\\\\\\"name\\\\\\":\\\\\\"test\\\\\\"}\\",\\n \\"RetCode\\": 0,\\n \\"RetResult\\": \\"{\\\\\\"id\\\\\\":2}\\",\\n \\"CostTime\\": 10,\\n \\"Status\\": \\"FINISHED\\",\\n \\"CreateTime\\": 1651824913000\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n ESDAFWEA\\n \\n 123\\n 2343\\n {\\"name\\":\\"test\\"}\\n 0\\n {\\"id\\":2}\\n 10\\n FINISHED\\n 1651824913000\\n \\n","errorExample":""}]', - 'title' => 'ListDataServiceApiTest', - 'summary' => 'Queries the test records of a DataService Studio API. This API operation allows you to query only the test records that are generated within the previous month.', - ], - 'TestDataServiceApi' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'ListMetaDB', + 'summary' => 'Queries a list of metadatabases.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ListMetaDB接口的使用示例Demo请参见[DataWorks OpenAPI示例](https://developer.aliyun.com/article/780879?groupCode=dataworks)。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"abc\\",\\n \\"DatabaseInfo\\": {\\n \\"TotalCount\\": 10,\\n \\"DbList\\": [\\n {\\n \\"Type\\": \\"HIVE\\",\\n \\"CreateTimeStamp\\": 1388776825,\\n \\"UUID\\": \\"32342\\",\\n \\"ModifiedTimeStamp\\": 1388776837,\\n \\"Name\\": \\"name\\",\\n \\"OwnerId\\": \\"1232\\",\\n \\"Location\\": \\"hdfs://localhost:777/user/hadoop/test.txt\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListMigrations' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -50144,222 +28946,218 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', + 'abilityTreeCode' => '134647', + 'abilityTreeNodes' => ['FEATUREdide8FM783'], ], 'parameters' => [ [ - 'name' => 'ApiId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the DataService Studio API on which the test is performed.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '12343', - ], + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['title' => 'Workspace Id', 'description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the workspace ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '2', 'exclusiveMinimum' => false, 'example' => '12345'], ], [ - 'name' => 'QueryParam', + 'name' => 'MigrationType', 'in' => 'formData', - 'style' => 'repeatList', 'schema' => [ - 'description' => 'The request parameters that are contained in the query.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The object that is requested to query.'."\n", - 'type' => 'object', - 'properties' => [ - 'ParamKey' => [ - 'description' => 'The name of the parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'name', - ], - 'ParamValue' => [ - 'description' => 'The value of the parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 500, + 'title' => 'Migration operation type, IMPORT/EXPORT', + 'description' => 'The migration task type. Valid values: IMPORT and EXPORT.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [], + 'example' => 'IMPORT', + 'enum' => ['IMPORT', 'EXPORT'], ], ], [ - 'name' => 'BodyParams', + 'name' => 'Owner', 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The request parameters that are contained in the request body.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The object that is requested to query.'."\n", - 'type' => 'object', - 'properties' => [ - 'ParamKey' => [ - 'description' => 'The name of the parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'name', - ], - 'ParamValue' => [ - 'description' => 'The value of the parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 500, - ], + 'schema' => ['description' => 'The owner ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '193379****'], ], [ - 'name' => 'PathParams', + 'name' => 'PageNumber', 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The request parameters that are contained in the request path.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The object that is requested to query.'."\n", - 'type' => 'object', - 'properties' => [ - 'ParamKey' => [ - 'description' => 'The name of the parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'path1', - ], - 'ParamValue' => [ - 'description' => 'The value of the parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'api', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 500, - ], + 'schema' => ['description' => 'The page number. Default value: 1. Maximum value: 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '1', 'default' => '1'], ], [ - 'name' => 'HeadParams', + 'name' => 'PageSize', 'in' => 'formData', - 'style' => 'repeatList', + 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '10', 'example' => '10', 'default' => '10'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The request parameters that are contained in the request header.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The object that is requested to query.'."\n", - 'type' => 'object', - 'properties' => [ - 'ParamKey' => [ - 'description' => 'The name of the parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'requestId', - ], - 'ParamValue' => [ - 'description' => 'The value of the parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abcd', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F9198AA3-9010-53D5-9714-DC4461427D3E'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Migrations' => [ + 'description' => 'The list of migration tasks.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The migration task.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The primary key ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '436064'], + 'Name' => ['description' => 'The name of the migration task.'."\n", 'type' => 'string', 'example' => 'test_task_1638498642279'], + 'PackageType' => [ + 'description' => 'The type of the import or export package. Valid values:'."\n" + ."\n" + .'* DWMA (standard format)'."\n" + .'* DATAWORKS_MODEL (standard format)'."\n" + .'* DATAWORKS_V2 (Apsara Stack DataWorks V3.6.1 to V3.11)'."\n" + .'* DATAWORKS_V3 (Apsara Stack DataWorks V3.12 and later)'."\n" + ."\n" + .'The DWMA and DATAWORKS_MODEL types are interchangeable.'."\n", + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'DATAWORKS_MODEL', + ], + 'MigrationType' => [ + 'description' => 'The type of the migration task. Valid values:'."\n" + ."\n" + .'* IMPORT'."\n" + .'* EXPORT'."\n", + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'EXPORT', + ], + 'CreateTime' => ['description' => 'The time when the migration task was created.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123124123123123'], + 'UpdateTime' => ['description' => 'The time when the migration task was last updated.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123123123123123'], + 'CreateUser' => ['description' => 'The ID of the user who created the migration task.'."\n", 'type' => 'string', 'example' => '123123****'], + 'CreateUserName' => ['description' => 'The name of the user who created the migration task.'."\n", 'type' => 'string', 'example' => '3h1_test'], + 'UpdateUser' => ['description' => 'The ID of the user who last updated the migration task.'."\n", 'type' => 'string', 'example' => '1231****'], + 'UpdateUserName' => ['description' => 'The name of the user who last updated the migration task.'."\n", 'type' => 'string', 'example' => '3h1_test'], + 'ProjectId' => ['description' => 'The ID of the DataWorks workspace to which the task belongs.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '72132'], + 'TenantId' => ['description' => 'The tenant ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '16307'], + 'Status' => [ + 'description' => 'The status of the migration task. Valid values:'."\n" + ."\n" + .'* INIT: The migration task is in the initial state.'."\n" + .'* EDITING: The migration task is being edited.'."\n" + .'* RUNNING: The migration task is running.'."\n" + .'* FAILURE: The migration task fails to run.'."\n" + .'* SUCCESS: The migration task is successfully run.'."\n", + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'SUCCESS', + ], + 'Message' => ['description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'An internal system error occurred. datasource kafka region is not cn-chengdu, can\'t open network for it'], + 'DownloadUrl' => ['description' => 'The URL that is used to download the package of the export task. You can use the URL to download the package of the export task.'."\n", 'type' => 'string', 'example' => 'http://geoip-sdk-user.oss-cn-zhangjiakou.aliyuncs.com/product/v1/ipv4/trace/v1.20220424123842.dex?Expires=1650780849&OSSAccessKeyId=XXXXXXeF4Lv5j&Signature=qxxxxx'], + 'Description' => ['description' => 'The description of the export task.'."\n", 'type' => 'string', 'example' => 'Automated Test creation'], + ], + ], + ], + 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'PageSize' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 50.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + 'TotalCount' => ['description' => 'The total number of entries.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20'], ], ], - 'required' => false, ], - 'required' => false, - 'maxItems' => 500, ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F9198AA3-9010-53D5-9714-DC4****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Migrations\\": [\\n {\\n \\"Id\\": 436064,\\n \\"Name\\": \\"test_task_1638498642279\\",\\n \\"PackageType\\": \\"DATAWORKS_MODEL\\",\\n \\"MigrationType\\": \\"EXPORT\\",\\n \\"CreateTime\\": 123124123123123,\\n \\"UpdateTime\\": 123123123123123,\\n \\"CreateUser\\": \\"123123****\\",\\n \\"CreateUserName\\": \\"3h1_test\\",\\n \\"UpdateUser\\": \\"1231****\\",\\n \\"UpdateUserName\\": \\"3h1_test\\",\\n \\"ProjectId\\": 72132,\\n \\"TenantId\\": 16307,\\n \\"Status\\": \\"SUCCESS\\",\\n \\"Message\\": \\"An internal system error occurred. datasource kafka region is not cn-chengdu, can\'t open network for it\\",\\n \\"DownloadUrl\\": \\"http://geoip-sdk-user.oss-cn-zhangjiakou.aliyuncs.com/product/v1/ipv4/trace/v1.20220424123842.dex?Expires=1650780849&OSSAccessKeyId=*****&Signature=qxxxxx\\",\\n \\"Description\\": \\"Automated Test creation\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 20\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n F9198AA3-9010-53D5-9714-DC4461427D3E\\n true\\n \\n \\n 436064\\n test_task_1638498642279\\n DATAWORKS_MODEL\\n EXPORT\\n 123124123123123\\n 123123123123123\\n 123123****\\n 3h1_test\\n 1231****\\n 3h1_test\\n 72132\\n 16307\\n SUCCESS\\n An internal system error occurred. datasource kafka region is not cn-chengdu, can\'t open network for it\\n http://geoip-sdk-user.oss-cn-zhangjiakou.aliyuncs.com/product/v1/ipv4/trace/v1.20220424123842.dex?Expires=1650780849&OSSAccessKeyId=XXXXXXeF4Lv5j&Signature=qxxxxx\\n 自动化测试创建\\n \\n 1\\n 10\\n 20\\n \\n","errorExample":""}]', + 'title' => 'ListMigrations', + 'summary' => 'Queries a list of migration tasks.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMigrations'], + ], + ], + 'ramActions' => [], + ], + 'ListNodeIO' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'BodyContent', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'NodeId', + 'in' => 'formData', + 'schema' => ['description' => 'The node ID. You can call the [ListNodes](~~173979~~) operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '2', 'example' => '1234', 'isFileTransferUrl' => false], + ], + [ + 'name' => 'ProjectEnv', 'in' => 'formData', 'schema' => [ - 'description' => 'The data of the request body.'."\n", + 'description' => 'The runtime environment. Valid values: DEV and PROD.'."\n", 'type' => 'string', - 'required' => false, - 'example' => '{"name":"test"}', + 'required' => true, + 'docRequired' => true, + 'example' => 'PROD', + 'isFileTransferUrl' => false, + 'enum' => ['PROD', 'DEV'], ], ], + [ + 'name' => 'IoType', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to query the information about ancestor or descendant nodes of the current node. Valid values: input and output.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'output'], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The returned result.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'abdsfewe', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'E6F0DBDD-5AD****'], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The project does not exist.'], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'Invalid.Tenant.ProjectNotExists'], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true'], 'Data' => [ - 'description' => 'The information about the test.'."\n", - 'type' => 'object', - 'properties' => [ - 'TestId' => [ - 'description' => 'The ID of the test.'."\n", - 'type' => 'string', - 'example' => '232432', + 'description' => 'The node information.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TableName' => ['description' => 'The name of the input or output table.'."\n", 'type' => 'string', 'example' => 'dataworks_a.datastudio_tenant_waitres_alarm'], + 'Data' => ['description' => 'The name of the ancestor or descendant node.'."\n", 'type' => 'string', 'example' => 'dataworks_a.1234_out'], + 'NodeId' => ['description' => 'The node ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123123'], ], ], ], ], + 'description' => '', ], ], ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"abdsfewe\\",\\n \\"Data\\": {\\n \\"TestId\\": \\"232432\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n abdsfewe\\n \\n 232432\\n \\n","errorExample":""}]', - 'title' => 'TestDataServiceApi', - 'summary' => 'Tests a DataService Studio API in asynchronous mode. You can call the GetDataServiceApiTest operation to query the test result.', - ], - 'GetDataServiceApiTest' => [ - 'methods' => [ - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"ErrorMessage\\": \\"The project does not exist.\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ProjectNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"TableName\\": \\"dataworks_a.datastudio_tenant_waitres_alarm\\",\\n \\"Data\\": \\"dataworks_a.1234_out\\",\\n \\"NodeId\\": 123123\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"E6F0DBDD-5AD****\\n200\\n\\n 123123\\n dataworks_a.datastudio_tenant_waitres_alarm\\n dataworks_a.1234_out\\n\\nInvalid.Tenant.ProjectNotExists\\nThe project does not exist.\\ntrue","errorExample":""}]', + 'title' => 'ListNodeIO', + 'summary' => 'Queries the information about one level of ancestor or descendant nodes of a node.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-01-13T07:51:16.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'ListNodeInputOrOutput' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -50369,341 +29167,518 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', + 'abilityTreeCode' => '78318', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB'], ], 'parameters' => [ [ - 'name' => 'TestId', - 'in' => 'query', + 'name' => 'NodeId', + 'in' => 'formData', + 'schema' => ['description' => 'The node ID. You can call the [ListNodes](~~173979~~) operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '2', 'isFileTransferUrl' => false, 'example' => '12314567', 'title' => ''], + ], + [ + 'name' => 'ProjectEnv', + 'in' => 'formData', 'schema' => [ - 'description' => 'The Id of the test. TestDataServiceApi is executed asynchronously after the API is called and the test Id is returned. You can also use ListDataServiceApiTest to obtain the latest test Id.', - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The environment of the workspace. Valid values: DEV and PROD.'."\n", + 'type' => 'string', 'required' => true, 'docRequired' => true, - 'example' => '123434', + 'isFileTransferUrl' => false, + 'enum' => ['PROD', 'DEV'], + 'example' => 'PROD', + 'title' => '', ], ], + [ + 'name' => 'IoType', + 'in' => 'formData', + 'schema' => ['description' => 'The type of node that you want to query. Valid values:'."\n" + ."\n" + .'* input: ancestor node'."\n" + .'* output: descendant node'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'output', 'title' => ''], + ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ - 'description' => 'The returned result.'."\n", + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'adssdsewe', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'E6F0DBDD-5AD****', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The project does not exist.', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'Invalid.Tenant.ProjectNotExists', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'Return object', - 'type' => 'object', - 'properties' => [ - 'ApiId' => [ - 'description' => 'Test API Id', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12343', - ], - 'ParamMap' => [ - 'description' => 'Test API request parameters', - 'type' => 'string', - 'example' => '{"name":"test"}', - ], - 'RetCode' => [ - 'description' => 'The test API returns the code. If it is not completed, the data is empty.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'RetResult' => [ - 'description' => 'Return data', - 'type' => 'string', - 'example' => '{"id":2}', - ], - 'DebugInfo' => [ - 'description' => 'Debug information', - 'type' => 'string', - 'example' => '[INFO] [16:15:13.240] resource group is 498774069027041[INFO]', - ], - 'CostTime' => [ - 'description' => 'Time consuming', - 'type' => 'string', - 'example' => '10', - ], - 'NodesDebugInfo' => [ - 'description' => 'Node Debug information', - 'type' => 'string', - 'example' => '[INFO] [16:15:13.240] resource group is 498774069027041[INFO]', - ], - 'Status' => [ - 'description' => 'Whether the task has been completed, including: RUNNING,FINISHED', - 'type' => 'string', - 'example' => 'FINISHED', + 'description' => 'The ancestor or descendant nodes.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ancestor or descendant node.'."\n", + 'type' => 'object', + 'properties' => [ + 'TableName' => ['description' => 'This parameter does not take effect. You cannot obtain the parameter settings.'."\n", 'type' => 'string', 'example' => 'dwd_xxx_table', 'title' => ''], + 'Data' => ['description' => 'The name of the ancestor or descendant node.'."\n", 'type' => 'string', 'example' => 'xxxx.123141254_out', 'title' => ''], + 'NodeId' => ['description' => 'The node ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '12314567', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], - ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', + 'title' => 'ListNodeInputOrOutput', + 'summary' => 'Queries the input and output information about a node. Only the ancestor or descendant nodes at the nearest level can be queried each time.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-08-12T08:46:58.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-08-12T08:46:58.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-08-12T08:46:58.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"adssd****\\",\\n \\"Data\\": {\\n \\"ApiId\\": 12343,\\n \\"ParamMap\\": \\"{\\\\\\"name\\\\\\":\\\\\\"test\\\\\\"}\\",\\n \\"RetCode\\": 0,\\n \\"RetResult\\": \\"{\\\\\\"id\\\\\\":2}\\",\\n \\"DebugInfo\\": \\"[INFO] [16:15:13.240] resource group is 498774069027041[INFO]\\",\\n \\"CostTime\\": \\"10\\",\\n \\"NodesDebugInfo\\": \\"[INFO] [16:15:13.240] resource group is 498774069027041[INFO]\\",\\n \\"Status\\": \\"FINISHED\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n adssdsewe\\n \\n 12343\\n {\\"name\\":\\"test\\"}\\n 0\\n {\\"id\\":2}\\n [<span style=\\\\\\"color: #92D581;\\\\\\">INFO</span>] [16:15:13.240] resource group is 498774069027041[<span style=\\\\\\"color: #92D581;\\\\\\">INFO</span>]\\n 10\\n [<span style=\\\\\\"color: #92D581;\\\\\\">INFO</span>] [16:15:13.240] resource group is 498774069027041[<span style=\\\\\\"color: #92D581;\\\\\\">INFO</span>]\\n FINISHED\\n \\n","errorExample":""}]', - 'title' => 'GetDataServiceApiTest', - 'summary' => 'Queries the test results of an API in DataService Studio.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"ErrorMessage\\": \\"The project does not exist.\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ProjectNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"TableName\\": \\"dwd_xxx_table\\",\\n \\"Data\\": \\"xxxx.123141254_out\\",\\n \\"NodeId\\": 12314567\\n }\\n ]\\n}","type":"json"}]', ], - 'SubmitDataServiceApi' => [ - 'summary' => 'Submits an API in DataService Studio.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListNodes' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '157978', - 'abilityTreeNodes' => [ - 'FEATUREdideZZ63WZ', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '78320', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB'], ], 'parameters' => [ [ - 'name' => 'TenantId', + 'name' => 'Owner', 'in' => 'formData', - 'schema' => [ - 'description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the DataWorks console. Find your workspace and go to the [DataService Studio](https://ds-cn-shanghai.data.aliyun.com/) page. On the DataService Studio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10001', - ], + 'schema' => ['description' => 'The description of the node.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '193379****', 'title' => ''], + ], + [ + 'name' => 'BizName', + 'in' => 'formData', + 'schema' => ['description' => 'The error code returned.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'test_bizName', 'title' => ''], + ], + [ + 'name' => 'ProgramType', + 'in' => 'formData', + 'schema' => ['description' => 'The operation that you want to perform. Set the value to **ListNodes**.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'ODPS_SQL', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => ['description' => 'The page number. Minimum value: 1. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'example' => '10', 'title' => ''], ], [ 'name' => 'ProjectId', 'in' => 'formData', + 'schema' => ['description' => 'The ID of the owner.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1234', 'title' => ''], + ], + [ + 'name' => 'ProjectEnv', + 'in' => 'formData', 'schema' => [ - 'description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The environment in which the node runs. Valid values: DEV and PROD.', + 'type' => 'string', 'required' => true, - 'example' => '10000', + 'docRequired' => true, + 'enum' => ['PROD', 'DEV'], + 'example' => 'PROD', + 'title' => '', + ], + ], + [ + 'name' => 'NodeName', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the baseline with which the node is associated.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'liux_test_n****', 'title' => ''], + ], + [ + 'name' => 'SchedulerType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The scheduling type. Valid values:'."\n" + ."\n" + .'- NORMAL: Nodes are scheduled as expected.'."\n" + ."\n" + .'- PAUSE: Nodes are paused.'."\n" + ."\n" + .'- SKIP: Nodes are dry-run. Dry-run nodes are started as scheduled, but the system sets the status of the nodes to successful when it starts to run them.', + 'type' => 'string', + 'enum' => ['NORMAL', 'MANUAL', 'PAUSE', 'SKIP'], + 'required' => false, + 'example' => 'NORMAL', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'The interval at which the node is rerun after the node fails to run.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The list of nodes.', 'type' => 'string', 'example' => 'E6F0DBDD-5AD****', 'title' => ''], + 'ErrorMessage' => ['description' => 'The page number of the returned page.', 'type' => 'string', 'example' => 'The connection does not exist.', 'title' => ''], + 'ErrorCode' => ['description' => 'The HTTP status code returned.', 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the node can be rerun.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The nodes.', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => 'The name of the node.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The cron expression returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The name of the workflow.', 'type' => 'integer', 'format' => 'int32', 'example' => '66', 'title' => ''], + 'Nodes' => [ + 'description' => 'The information about the nodes.', + 'type' => 'array', + 'items' => [ + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'SchedulerType' => ['description' => 'The types of the nodes. You can call the [ListNodes](~~173979~~) operation to query the type of the node.', 'type' => 'string', 'example' => 'NORMAL', 'title' => ''], + 'RepeatInterval' => ['description' => 'The environment of the workspace. Valid values: PROD and DEV.', 'type' => 'integer', 'format' => 'int64', 'example' => '60', 'title' => ''], + 'Repeatability' => ['description' => 'The name of the node.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RepeatMode' => ['description' => 'The rerun mode. The value 0 indicates that rerun can be performed only if a failure occurs. The value 1 indicates that rerun can be performed in all cases. The value 2 indicates that rerun cannot be performed in all cases.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ProjectId' => ['description' => 'The information about the nodes.', 'type' => 'integer', 'format' => 'int64', 'example' => '33671', 'title' => ''], + 'ProgramType' => ['description' => 'The error message returned.', 'type' => 'string', 'example' => 'ODPS_SQL', 'title' => ''], + 'Priority' => ['description' => 'The ID of the owner.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'OwnerId' => ['description' => 'The additional parameters.', 'type' => 'string', 'example' => '19337906836551', 'title' => ''], + 'Connection' => ['description' => 'The name of the resource group.', 'type' => 'string', 'example' => 'odps_source', 'title' => ''], + 'ParamValues' => ['description' => 'The type of the node.', 'type' => 'string', 'example' => 'a=b', 'title' => ''], + 'RelatedFlowId' => ['description' => 'The table and partition filter expression in Data Quality that are associated with the node.', 'type' => 'integer', 'format' => 'int64', 'example' => '1231123', 'title' => ''], + 'DqcType' => ['description' => 'The connection string.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'BaselineId' => ['description' => 'The number of the page to return. Minimum value: 1. Maximum value: 100.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', 'title' => ''], + 'Description' => ['description' => 'The priority for running the node. Valid values: 1, 3, 5, 7, and 8.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'NodeName' => ['description' => 'The total number of nodes returned.', 'type' => 'string', 'example' => 'liux_test_n****', 'title' => ''], + 'ResGroupName' => ['description' => 'The ID of the workflow.', 'type' => 'string', 'example' => 'Default resource group', 'title' => ''], + 'BusinessId' => ['description' => 'The operation that you want to perform. Set the value to **ListNodes**.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'DqcDescription' => ['description' => 'The ID of the owner.', 'type' => 'string', 'example' => '[{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\\u003d$[yyyy-mm-dd-1]"}]', 'title' => ''], + 'CronExpress' => ['description' => 'The name of the workflow.', 'type' => 'string', 'example' => '00 00 00 * * ?', 'title' => ''], + 'NodeId' => ['description' => 'The types of the nodes. You can call the [ListNodes](~~173979~~) operation to query the type of the node.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'ResGroupIdentifier' => ['description' => 'The identifier of the resource group.', 'type' => 'string', 'example' => 'group_123', 'title' => ''], + 'FileType' => ['description' => 'Different file types have different codes. For more information, see [DataWorks node collection](~~600169~~).'."\n" + .'You can also call the [ListFileType](~~212428~~) interface to query the code type of the file.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'FileId' => ['description' => 'The file ID. You can call the ListFiles operation to query the ID.'."\n" + ."\n" + .'\\*\\*'."\n" + ."\n" + .'**Warning** This field is deprecated.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'FileVersion' => ['description' => 'The latest version number of the file.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'DeployDate' => ['description' => 'The timestamp when the node was deployed. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1734537600000', 'title' => ''], + 'CreateTime' => ['description' => 'The timestamp when the node was created. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1593879116000', 'title' => ''], + 'ModifyTime' => ['description' => 'The timestamp when the node was modified. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1593879116000', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 66,\\n \\"Nodes\\": [\\n {\\n \\"SchedulerType\\": \\"NORMAL\\",\\n \\"RepeatInterval\\": 60,\\n \\"Repeatability\\": true,\\n \\"RepeatMode\\": 1,\\n \\"ProjectId\\": 33671,\\n \\"ProgramType\\": \\"ODPS_SQL\\",\\n \\"Priority\\": 1,\\n \\"OwnerId\\": \\"19337906836551\\",\\n \\"Connection\\": \\"odps_source\\",\\n \\"ParamValues\\": \\"a=b\\",\\n \\"RelatedFlowId\\": 1231123,\\n \\"DqcType\\": 1,\\n \\"BaselineId\\": 123456,\\n \\"Description\\": \\"test\\",\\n \\"NodeName\\": \\"liux_test_n****\\",\\n \\"ResGroupName\\": \\"Default resource group\\",\\n \\"BusinessId\\": 123,\\n \\"DqcDescription\\": \\"[{\\\\\\"projectName\\\\\\":\\\\\\"ztjy_dim\\\\\\",\\\\\\"tableName\\\\\\":\\\\\\"dim_user_agent_manage_area_a\\\\\\",\\\\\\"partition\\\\\\":\\\\\\"ds\\\\\\\\u003d$[yyyy-mm-dd-1]\\\\\\"}]\\",\\n \\"CronExpress\\": \\"00 00 00 * * ?\\",\\n \\"NodeId\\": 1234,\\n \\"ResGroupIdentifier\\": \\"group_123\\",\\n \\"FileType\\": 10,\\n \\"FileId\\": 20,\\n \\"FileVersion\\": 3,\\n \\"DeployDate\\": 1734537600000,\\n \\"CreateTime\\": 1593879116000,\\n \\"ModifyTime\\": 1593879116000\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListNodes', + 'summary' => 'The ID of the workspace.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-10-17T06:48:10.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-05-30T14:18:43.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-06-25T08:45:29.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-08-12T08:46:58.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-08-12T08:46:58.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-08-12T08:46:58.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListNodes'], + ], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'translator' => 'manual', + ], + 'ListNodesByBaseline' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '78321', + 'abilityTreeNodes' => ['FEATUREdideSFSFU4'], + ], + 'parameters' => [ [ - 'name' => 'ApiId', + 'name' => 'BaselineId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The API ID. You can call the [ListDataServiceApis](~~ListDataServiceApis~~) operation to obtain the ID.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '12345', - ], + 'schema' => ['description' => 'The baseline ID. You can call the [ListBaselineConfigs](~~173964~~) operation to query the baseline ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1234', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. You can use the ID to troubleshoot issues.'."\n", 'type' => 'string', 'example' => '0000-ABCD-E****', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The specified parameters are invalid.', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '1031203110005', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'Indicates whether the API was submitted.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'description' => 'The nodes in the baseline.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Owner' => ['description' => 'The ID of the Alibaba Cloud account used by the node owner.'."\n", 'type' => 'string', 'example' => '9527952****', 'title' => ''], + 'NodeName' => ['description' => 'The name of the node.'."\n", 'type' => 'string', 'example' => 'Node name', 'title' => ''], + 'NodeId' => ['description' => 'The node ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '12345', 'title' => ''], + 'ProjectId' => ['description' => 'The ID of the workspace to which the node belongs.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '12345', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 0000-ABCD-EFG****\\n 200\\n true\\n Invalid.Tenant.ConnectionNotExists\\n true\\n","errorExample":""}]', - 'title' => 'SubmitDataServiceApi', - ], - 'SaveDataServiceApiTestResult' => [ - 'summary' => 'Saves the test results of an API.', - 'methods' => [ - 'post', + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Resource', 'errorMessage' => 'You have reached the limit for the resource. Please contact us by submitting a ticket.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'Forbidden.Not.Server', 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.', 'description' => ''], + ['errorCode' => 'Forbidden.Wkbench.BaselineNoPermission', 'errorMessage' => 'You are not authorized to access the baseline.', 'description' => ''], + ['errorCode' => 'Forbidden.Wkbench.ProjectNoPermission', 'errorMessage' => 'You are not authorized to access the workspace.', 'description' => ''], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.Wkbench.ServiceError', 'errorMessage' => 'An internal error occurred.', 'description' => 'An internal error occurred.'], + ['errorCode' => 'Invalid.Wkbench.Parameter', 'errorMessage' => 'The specified parameters are invalid.', 'description' => ''], + ['errorCode' => 'Invalid.Wkbench.BaselineNotExist', 'errorMessage' => 'The baseline does not exist.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'ListNodesByBaseline', + 'summary' => 'Queries nodes in a baseline.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '39', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListNodesByBaseline'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-E****\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": [\\n {\\n \\"Owner\\": \\"9527952****\\",\\n \\"NodeName\\": \\"Node name\\",\\n \\"NodeId\\": 12345,\\n \\"ProjectId\\": 12345\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListNodesByOutput' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '169364', - 'abilityTreeNodes' => [ - 'FEATUREdideNC84FD', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '78322', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB'], ], 'parameters' => [ [ - 'name' => 'ApiId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The API ID. You can call the [ListDataServiceApis](~~174012~~) operation to obtain the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '417381955954827', - ], - ], - [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10001', - ], - ], - [ - 'name' => 'ResultSample', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The sample success response of the API. This parameter is optional.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{ "data": { "totalNum": 0, "pageSize": 10, "rows": [], "pageNum": 1 }, "errCode": 0, "requestId": "0bc14a561678159140664515*****", "errMsg": "success", "apiLog": null}', - ], - ], - [ - 'name' => 'FailResultSample', + 'name' => 'ProjectEnv', 'in' => 'formData', 'schema' => [ - 'description' => 'The sample failure response of the API. This parameter is optional.'."\n", + 'description' => 'The environment of Operation Center. Valid values: PROD and DEV. The value PROD indicates the production environment, and the value DEV indicates the development environment.'."\n", + 'enumValueTitles' => [], 'type' => 'string', - 'required' => false, - 'example' => '{"apiLog": null, "data": null, "errCode": 1108110622, "errMsg": "data Source query failed", "requestId": "0 bc14a **** 5902762031 ****"}', + 'required' => true, + 'docRequired' => true, + 'enum' => ['PROD', 'DEV'], + 'example' => 'PROD', + 'title' => '', ], ], [ - 'name' => 'AutoGenerate', + 'name' => 'Outputs', 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether to use the test results generated by the system. If you do not configure the resultSample or failResultSample parameter, the test results generated by the system are used.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The output name of the node. You can specify multiple output names. Separate them with commas (,).'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'aaaaa.1231412_out,bbbb.12313123_out', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG**** ', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'SDFSDFSDF-asdfDFSDF-SDFSDf-SDfSFD', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The connection does not exist.', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'Indicates whether the test results are saved.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', + 'description' => 'The nodes returned.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Output' => ['description' => 'The output name of the current node.'."\n", 'type' => 'string', 'example' => 'test_0709_1.630003556_out', 'title' => ''], + 'NodeList' => [ + 'description' => 'The information about the nodes returned.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SchedulerType' => ['description' => 'The scheduling type of the node. Valid values:'."\n" + ."\n" + .'* NORMAL: The node is an auto triggered node. The scheduling system regularly runs the node.'."\n" + .'* MANUAL: The node is a manually triggered node. The scheduling system does not regularly run the node.'."\n" + .'* PAUSE: The node is a frozen node. The scheduling system regularly runs the node but sets the status of the node to failed when the scheduling system starts to run the node.'."\n" + .'* SKIP: The node is a dry-run node. The scheduling system regularly runs the node but sets the status of the node to successful when the scheduling system starts to run the node.'."\n", 'type' => 'string', 'example' => 'NORMAL', 'title' => ''], + 'RepeatInterval' => ['description' => 'The interval at which the node is rerun after the node fails to run.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '60', 'title' => ''], + 'Repeatability' => ['description' => 'Indicates whether the node can be rerun.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'FileType' => ['description' => 'The node type. Valid values:'."\n" + ."\n" + .'6 (Shell), 10 (ODPS SQL), 11 (ODPS MR), 23 (Data Integration), 24 (ODPS Script), 99 (zero load), 221 (PyODPS 2), 225 (ODPS Spark), 227 (EMR Hive), 228 (EMR Spark), 229 (EMR Spark SQL), 230 (EMR MR), 239 (OSS object inspection), 257 (EMR Shell), 258 (EMR Spark Shell), 259 (EMR Presto), 260 (EMR Impala), 900 (real-time synchronization), 1089 (cross-tenant collaboration), 1091 (Hologres development), 1093 (Hologres SQL), 1100 (assignment), and 1221 (PyODPS 3)'."\n", 'type' => 'string', 'example' => 'ODPS_SQL', 'title' => ''], + 'ProjectId' => ['description' => 'The workspace ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '33671', 'title' => ''], + 'ProgramType' => ['description' => 'The node type. This parameter is deprecated. For more information about node types, see valid values of the FileType parameter.'."\n", 'type' => 'string', 'example' => 'ODPS_SQL', 'title' => ''], + 'Priority' => ['description' => 'The priority of the node. Valid values: 1, 3, 5, 7, and 8. A greater value indicates a higher priority. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'OwnerId' => ['description' => 'The owner ID.'."\n", 'type' => 'string', 'example' => '19337906836551', 'title' => ''], + 'Connection' => ['description' => 'The name of the data source.'."\n", 'type' => 'string', 'example' => 'odps_source', 'title' => ''], + 'ParamValues' => ['description' => 'The scheduling parameters of the node.'."\n", 'type' => 'string', 'example' => 'a=b', 'title' => ''], + 'RelatedFlowId' => ['description' => 'The ID of the workflow to which the node belongs.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1235655464', 'title' => ''], + 'DqcType' => ['description' => 'Indicates whether the node is associated with a monitoring rule in Data Quality. Valid values: 0 and 1. The value 0 indicates that the node is associated with a monitoring rule in Data Quality. The value 1 indicates that the node is not associated with a monitoring rule in Data Quality.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'BaselineId' => ['description' => 'The baseline ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1235667', 'title' => ''], + 'Description' => ['description' => 'The description of the node.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'NodeName' => ['description' => 'The name of the node.'."\n", 'type' => 'string', 'example' => 'liux_test_n****', 'title' => ''], + 'ResGroupName' => ['description' => 'The name of the resource group.'."\n", 'type' => 'string', 'example' => 'Default Resource Group', 'title' => ''], + 'DqcDescription' => ['description' => 'The table and partition filter expression in Data Quality that are associated with the node.'."\n", 'type' => 'string', 'example' => '[{"projectName":"ztjy_dim","tableName":"dim_user_agent_manage_area_a","partition":"ds\\u003d$[yyyy-mm-dd-1]"}]', 'title' => ''], + 'CronExpress' => ['description' => 'The CRON expression.'."\n", 'type' => 'string', 'example' => '00 00 00 * * ?', 'title' => ''], + 'NodeId' => ['description' => 'The node ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '125677', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EF*****\\\\t\\",\\n \\"Data\\": true,\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200\\n}","errorExample":""},{"type":"xml","example":"\\n 0000-ABCD-EFG****\\t\\n true\\n true\\n 200\\n","errorExample":""}]', - 'title' => 'SaveDataServiceApiTestResult', - ], - 'GetOpSensitiveData' => [ - 'methods' => [ - 'get', + 'title' => 'ListNodesByOutput', + 'summary' => 'Queries nodes based on the output of the nodes.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-08-12T08:46:58.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-08-12T08:46:58.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-08-12T08:46:58.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"SDFSDFSDF-asdfDFSDF-SDFSDf-SDfSFD\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Output\\": \\"test_0709_1.630003556_out\\",\\n \\"NodeList\\": [\\n {\\n \\"SchedulerType\\": \\"NORMAL\\",\\n \\"RepeatInterval\\": 60,\\n \\"Repeatability\\": true,\\n \\"FileType\\": \\"ODPS_SQL\\",\\n \\"ProjectId\\": 33671,\\n \\"ProgramType\\": \\"ODPS_SQL\\",\\n \\"Priority\\": 1,\\n \\"OwnerId\\": \\"19337906836551\\",\\n \\"Connection\\": \\"odps_source\\",\\n \\"ParamValues\\": \\"a=b\\",\\n \\"RelatedFlowId\\": 1235655464,\\n \\"DqcType\\": 1,\\n \\"BaselineId\\": 1235667,\\n \\"Description\\": \\"test\\",\\n \\"NodeName\\": \\"liux_test_n****\\",\\n \\"ResGroupName\\": \\"Default Resource Group\\",\\n \\"DqcDescription\\": \\"[{\\\\\\"projectName\\\\\\":\\\\\\"ztjy_dim\\\\\\",\\\\\\"tableName\\\\\\":\\\\\\"dim_user_agent_manage_area_a\\\\\\",\\\\\\"partition\\\\\\":\\\\\\"ds\\\\\\\\u003d$[yyyy-mm-dd-1]\\\\\\"}]\\",\\n \\"CronExpress\\": \\"00 00 00 * * ?\\",\\n \\"NodeId\\": 125677\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListPermissionApplyOrders' => [ + 'summary' => 'Queries a list of permission application orders.'."\n" + ."\n" + .'Note: The 2020 version of OpenAPI will be discontinued at a scheduled time. Please migrate to the 2024 version of OpenAPI as soon as possible — ListMyApplications/ListPendingApprovals/ListMyRelatedApprovals.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -50712,176 +29687,276 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '78323', + 'abilityTreeNodes' => ['FEATUREdide0DCVNY'], ], 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'FlowStatus', 'in' => 'query', 'schema' => [ - 'description' => 'The parameters that you can configure to query the access records. Valid values:'."\n" - ."\n" - .'* dbType'."\n" - .'* instanceName'."\n" - .'* databaseName'."\n" - .'* projectName'."\n" - .'* clusterName'."\n" - ."\n" - .'The following example shows the parameters configured to query the access records of the sensitive data in the abc database of the Hologres instance ABC: \\[ {"dbType":"hologres","instanceName":"ABC","databaseName":"abc"} ]'."\n" - ."\n" - .'You must configure the parameters based on the compute engine that you use in your business.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '[ {"dbType":"hologres","instanceName":"ABC","databaseName":"abc"}, {"dbType":"ODPS.ODPS","projectName":"adbc"} ]', + 'description' => 'The status of the application order. Valid values:'."\n" + .'- 1: Pending approval.'."\n" + .'- 2: Approved, authorization succeeded.'."\n" + .'- 3: Approved, authorization failed.'."\n" + .'- 4: Rejected.'."\n" + .'- 5: Withdrawn.', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'enum' => ['0', '1', '2', '3', '4', '5'], + 'example' => '1', + 'title' => '', ], ], [ - 'name' => 'PageSize', + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the workspace to which the application order belongs. If this parameter is not specified, application orders from all workspaces are returned. You can log on to the DataWorks console and go to the Workspace Settings page to obtain the workspace ID.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '12345', 'title' => ''], + ], + [ + 'name' => 'OrderType', 'in' => 'query', 'schema' => [ - 'description' => 'The number of entries per page. Minimum value: 1. Maximum value: 1000.'."\n", + 'description' => 'This parameter is deprecated and does not take effect.', 'type' => 'integer', 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '1000', - 'minimum' => '1', + 'required' => false, + 'docRequired' => false, + 'maximum' => '1', + 'minimum' => '0', + 'enum' => ['1', '0'], 'example' => '1', + 'title' => '', ], ], [ - 'name' => 'PageNo', + 'name' => 'MaxComputeProjectName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the MaxCompute project to which the application order belongs. If this parameter is not specified, application orders from all MaxCompute projects are returned.', 'type' => 'string', 'required' => false, 'example' => 'aMaxComputeProject', 'title' => ''], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => ['description' => 'The table name included in the application order. If this parameter is not specified, application orders for all tables are returned.', 'type' => 'string', 'required' => false, 'example' => 'aTableName', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The start time for querying application orders, specified as a UNIX timestamp. If this parameter is not specified, all application orders are queried.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1616200471885', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end time for querying application orders, specified as a UNIX timestamp. If this parameter is not specified, application orders up to the current time are queried.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1617200471885', 'title' => ''], + ], + [ + 'name' => 'EngineType', 'in' => 'query', + 'allowEmptyValue' => true, 'schema' => [ - 'description' => 'The page number. Valid values: 1 to 1000.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '1000', - 'minimum' => '1', - 'example' => '100', + 'description' => 'This parameter is deprecated and does not take effect.', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'enum' => ['odps'], + 'example' => 'odps', + 'title' => '', ], ], [ - 'name' => 'Date', + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => ['description' => 'The page number for paginated queries. The value must be a positive integer greater than or equal to 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '1', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'default' => '10', 'example' => '100', 'title' => ''], + ], + [ + 'name' => 'QueryType', 'in' => 'query', 'schema' => [ - 'description' => 'The date on which access records were generated. Specify the value in the yyyyMMdd format.'."\n", - 'type' => 'string', + 'description' => 'The query type of the application order. Valid values:'."\n" + .'- 0: Application orders submitted by me.'."\n" + .'- 1: Application orders approved by me.'."\n" + .'- 2: All application orders.', + 'type' => 'integer', + 'format' => 'int32', 'required' => true, 'docRequired' => true, - 'example' => '20210116', + 'maximum' => '2', + 'minimum' => '0', + 'enum' => ['0', '1', '2'], + 'example' => '1', + 'title' => '', ], ], [ - 'name' => 'OpType', + 'name' => 'ApplyType', 'in' => 'query', 'schema' => [ - 'description' => 'The operation that is performed on the data. Valid values:'."\n" + 'description' => 'The type of the application order. Valid values:'."\n" ."\n" - .'* SQL_SELECT: specifies the data access operation. For example, execute a SELECT statement to query data.'."\n" - .'* TUNNEL_DOWNLOAD: specifies the data download operation. For example, run a Tunnel command to download data.'."\n", + .'- [MaxComputeTable] MaxCompute table permission application order.'."\n" + .'- [MaxComputeFunction] MaxCompute function application order.'."\n" + .'- [MaxComputeResource] MaxCompute resource application order.'."\n" + .'- [DLFSchema] DLF 1.0 schema permission application order.'."\n" + .'- [DLFTable] DLF 1.0 table permission application order.'."\n" + .'- [DLFColumn] DLF 1.0 column permission application order.'."\n" + .'- [DsApiDeploy] DataService publishing permission application order.', 'type' => 'string', + 'default' => 'MaxComputeTable', + 'enum' => ['MaxComputeTable', 'MaxComputeFunction', 'MaxComputeResource', 'DLFSchema', 'DLFTable', 'DLFColumn', 'HologresTable', 'StarRocksTable', 'StarRocksSchema', 'EmrSchema', 'EmrTable', 'LindormTable', 'DsApiDeploy', 'DIJobs', 'ExtensionSet', 'DgcCheckerOperation'], 'required' => false, - 'example' => 'SQL_SELECT', + 'example' => 'MaxComputeTable', + 'title' => '', ], ], + [ + 'name' => 'CatalogName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the data catalog to query.', 'type' => 'string', 'required' => false, 'example' => 'hive', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The returned result.'."\n", + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'OpSensitiveData' => [ - 'description' => 'The information about the access records of the sensitive data. The information includes totalCount and opRiskDatas. opRiskDatas includes the following parameters:'."\n" - ."\n" - .'* sensType: the type of the sensitive data.'."\n" - .'* sensLevel: the sensitivity level of the sensitive data. A larger value indicates a higher sensitivity level.'."\n" - .'* opType: the type of the operation.'."\n" - .'* sql: the SQL statement that is executed.'."\n" - .'* opAccount: the account that is used to perform the operation.'."\n" - .'* opTime: the time when the operation was performed.'."\n", - 'type' => 'string', - 'example' => '"opSensDatas": [ { "sensLevel": "L4", "opTime": "2021-02-07 00:14:51", "opAccount": "ALIYUN$dsg_test", "sensType": "Mobile phone number", "sql": "select * from dsg_demo.tbl_phonebook where phone_no = '1331111****';" } ], "totalCount": 6', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0bc1ec92159376****', 'title' => ''], + 'ApplyOrders' => [ + 'description' => 'The paginated query results of permission application orders.', + 'type' => 'object', + 'properties' => [ + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of permission application orders returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '150', 'title' => ''], + 'ApplyOrder' => [ + 'description' => 'The list of permission application orders.', + 'type' => 'array', + 'items' => [ + 'description' => 'The response.', + 'type' => 'object', + 'properties' => [ + 'ApplyBaseId' => ['description' => 'The Alibaba Cloud user UID that submitted the application order.', 'type' => 'string', 'example' => '267842600408993176', 'title' => ''], + 'ApplyTimestamp' => ['description' => 'The submission time of the application order, displayed as a UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1615284086000', 'title' => ''], + 'FlowId' => ['description' => 'The application order ID.', 'type' => 'string', 'example' => 'ad8da78d-8135-455e-9486-27cf213fc140', 'title' => ''], + 'FlowStatus' => ['description' => 'The status of the application order. Valid values:'."\n" + .'- 1: Pending approval.'."\n" + .'- 2: Approved, authorization succeeded.'."\n" + .'- 3: Approved, authorization failed.'."\n" + .'- 4: Rejected.'."\n" + .'- 5: Withdrawn.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'ApproveContent' => [ + 'description' => 'The content of the application order.', + 'type' => 'object', + 'properties' => [ + 'ApplyReason' => ['description' => 'The reason for the application, used by the administrator for evaluation and approval.', 'type' => 'string', 'example' => 'I need to use this table', 'title' => ''], + 'OrderType' => ['description' => 'The application order type. Currently, only the value 1 is supported, indicating an object ACL permission application.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ProjectMeta' => [ + 'description' => 'The content of the applied object.', + 'type' => 'object', + 'properties' => [ + 'WorkspaceName' => ['description' => 'The name of the DataWorks workspace to which the MaxCompute project with the requested permissions belongs.', 'type' => 'string', 'example' => 'aWorkspaceName', 'title' => ''], + 'ObjectMetaList' => [ + 'description' => 'The information about the applied objects.', + 'type' => 'array', + 'items' => [ + 'description' => 'The response.', + 'type' => 'object', + 'properties' => [ + 'ObjectName' => ['description' => 'The name of the applied table.', 'type' => 'string', 'example' => 'aTableName', 'title' => ''], + 'Actions' => [ + 'description' => 'The action types.', + 'type' => 'array', + 'items' => ['description' => 'The permission types applied for. Multiple permission types in a single application are separated by commas (,).'."\n" + .'Currently, only Select, Describe, Drop, Alter, Update, and Download types are supported.', 'type' => 'string', 'example' => 'Select,Describe', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'FinishApprovalTimestamp' => ['description' => 'The final approval completion time, displayed as a UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1757496687000', 'title' => ''], + 'FinishApprovalComment' => ['description' => 'The final approval comment.', 'type' => 'string', 'example' => 'agree', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Invalid.Param', - 'errorMessage' => 'The request parameter is invalid.', - ], - ], - 403 => [ - [ - 'errorCode' => 'Forbidden.NoTenant', - 'errorMessage' => 'The tenant information cannot be obtained using user ID.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError.DQC.BizError', - 'errorMessage' => 'An internal error occurred.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"OpSensitiveData\\": \\"\\\\\\"opSensDatas\\\\\\": [ { \\\\\\"sensLevel\\\\\\": \\\\\\"L4\\\\\\", \\\\\\"opTime\\\\\\": \\\\\\"2021-02-07 00:14:51\\\\\\", \\\\\\"opAccount\\\\\\": \\\\\\"ALIYUN$dsg_test\\\\\\", \\\\\\"sensType\\\\\\": \\\\\\"Mobile phone number\\\\\\", \\\\\\"sql\\\\\\": \\\\\\"select * from dsg_demo.tbl_phonebook where phone_no = '1331111****';\\\\\\" } ], \\\\\\"totalCount\\\\\\": 6\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n \\"opSensDatas\\": [ { \\"sensLevel\\": \\"L4\\", \\"opTime\\": \\"2021-02-07 00:14:51\\", \\"opAccount\\": \\"ALIYUN$dsg_test\\", \\"sensType\\": \\"手机号\\", \\"sql\\": \\"select * from dsg_demo.tbl_phonebook where phone_no = &#39;1331111****&#39;;\\" } ], \\"totalCount\\": 6\\n 0000-ABCD-EFG****\\n","errorExample":""}]', - 'title' => 'GetOpSensitiveData', - 'summary' => 'Queries the records that are generated on a specified date for access to sensitive data in all the DataWorks workspaces of a tenant.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc1ec92159376****\\",\\n \\"ApplyOrders\\": {\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 150,\\n \\"ApplyOrder\\": [\\n {\\n \\"ApplyBaseId\\": \\"267842600408993176\\",\\n \\"ApplyTimestamp\\": 1615284086000,\\n \\"FlowId\\": \\"ad8da78d-8135-455e-9486-27cf213fc140\\",\\n \\"FlowStatus\\": 2,\\n \\"ApproveContent\\": {\\n \\"ApplyReason\\": \\"I need to use this table\\",\\n \\"OrderType\\": 1,\\n \\"ProjectMeta\\": {\\n \\"WorkspaceName\\": \\"aWorkspaceName\\",\\n \\"ObjectMetaList\\": [\\n {\\n \\"ObjectName\\": \\"aTableName\\",\\n \\"Actions\\": [\\n \\"Select,Describe\\"\\n ]\\n }\\n ]\\n }\\n },\\n \\"FinishApprovalTimestamp\\": 1757496687000,\\n \\"FinishApprovalComment\\": \\"agree\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Query the list of permission application orders', + 'description' => '**Note: The 2020 version of OpenAPI will be discontinued at a scheduled time. Please migrate to the 2024 version of OpenAPI as soon as possible — [ListMyApplications](https://help.aliyun.com/zh/dataworks/developer-reference/api-dataworks-public-2024-05-18-listmyapplications?spm=a2c4g.11186623.help-menu-72772.d_1_1_3_12_0_7.1c237afdFAePBC&scm=20140722.H_3040929._.OR_help-T_cn~zh-V_1)/[ListPendingApprovals](https://help.aliyun.com/zh/dataworks/developer-reference/api-dataworks-public-2024-05-18-listpendingapprovals?spm=a2c4g.11186623.help-menu-72772.d_1_1_3_12_0_5.644e11b8FqtyZe&scm=20140722.H_3040932._.OR_help-T_cn~zh-V_1)/[ListMyRelatedApprovals](https://help.aliyun.com/zh/dataworks/developer-reference/api-dataworks-public-2024-05-18-listmyrelatedapprovals?spm=a2c4g.11186623.help-menu-72772.d_1_1_3_12_0_6.62893177dwvvfp&scm=20140722.H_3040931._.OR_help-T_cn~zh-V_1).**', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DesensitizeData' => [ - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2025-03-27T09:54:43.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-04-28T08:54:54.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'ListProgramTypeCount' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'deprecated' => true, + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'Data', + 'name' => 'ProjectId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The data that you want to mask.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '15365291784', - ], + 'schema' => ['description' => 'The workspace ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '1234', 'isFileTransferUrl' => false], ], [ - 'name' => 'SceneCode', + 'name' => 'ProjectEnv', 'in' => 'formData', 'schema' => [ - 'description' => 'The code of the data masking scenario. You can view the code on the Data Masking Management page in Data Security Guard of the DataWorks console.'."\n", + 'description' => 'The environment of the workspace. Valid values: PROD and DEV.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, - 'example' => '_default_scene_code', + 'example' => 'PROD', + 'isFileTransferUrl' => false, + 'enum' => ['PROD', 'DEV'], ], ], ], @@ -50890,50 +29965,40 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'DesensitizeData' => [ - 'description' => 'The data returned after masking.'."\n", - 'type' => 'string', - 'example' => '{ "desensData": "**198807120510**" }', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'BCA321BA-46C5-40E9-8A08-6******', + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'E6F0DBDD-5AD****'], + 'ProgramTypeAndCounts' => [ + 'description' => 'The list of node types and quantity.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Count' => ['description' => 'The number of nodes.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3'], + 'ProgramType' => ['description' => 'The node type.'."\n", 'type' => 'string', 'example' => 'ODPS_SQL'], + ], + ], ], ], 'description' => '', ], ], ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.NoTenant', - 'errorMessage' => 'The tenant information cannot be obtained using user ID.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError.DQC.BizError', - 'errorMessage' => 'An internal error occurred.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"DesensitizeData\\": \\"{ \\\\\\"desensData\\\\\\": \\\\\\"**198807120510**\\\\\\" }\\",\\n \\"RequestId\\": \\"BCA321BA-46C5-40E9-8A08-6******\\"\\n}","errorExample":""},{"type":"xml","example":"BCA321BA-46C5-40E9-8A08-6******\\n{ \\"desensData\\": \\"**198807120510**\\" }","errorExample":""}]', - 'title' => 'DesensitizeData', - 'summary' => 'Masks data.', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"ProgramTypeAndCounts\\": [\\n {\\n \\"Count\\": 3,\\n \\"ProgramType\\": \\"ODPS_SQL\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"E6F0DBDD-5AD****\\n\\n ODPS_SQL\\n 3\\n","errorExample":""}]', + 'title' => 'ListProgramTypeCount', + 'summary' => 'Queries the distribution of different types of nodes.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'GetOpRiskData' => [ - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2022-01-13T07:25:27.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'ListProjectIds' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -50941,157 +30006,77 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Maximum value: 1000.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '1000', - 'minimum' => '1', - 'example' => '100', - ], - ], - [ - 'name' => 'PageNo', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Pages start from 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '1000', - 'minimum' => '1', - 'example' => '1', - ], - ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => 'The parameters that you can configure to query the access records. Valid values:'."\n" - ."\n" - .'* dbType'."\n" - .'* instanceName'."\n" - .'* databaseName'."\n" - .'* projectName'."\n" - .'* clusterName'."\n" - ."\n" - .'The following example shows the parameters configured to query the access records of the sensitive data in the abc database of the Hologres instance ABC: \\[ {"dbType":"hologres","instanceName":"ABC","databaseName":"abc"} ]'."\n" - ."\n" - .'You must configure the parameters based on the compute engine that you use in your business.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[ {"dbType":"hologres","instanceName":"ABC","databaseName":"abc"}, {"dbType":"ODPS.ODPS","projectName":"adbc"} ]', - ], - ], - [ - 'name' => 'Date', - 'in' => 'query', - 'schema' => [ - 'description' => 'The date on which access records were generated. Specify the value in the yyyyMMdd format.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '20210221', - ], - ], - [ - 'name' => 'RiskType', + 'name' => 'UserId', 'in' => 'query', - 'schema' => [ - 'description' => 'The method that you use to identify risks.'."\n" - ."\n" - .'* You can manually identify risks.'."\n" - .'* You can also use a sensitive data identification rule to identify risks. You can log on to the DataWorks console and go to the Risk Identification Rules page in Data Security Guard to obtain the name of the rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Manual identification', - ], + 'schema' => ['description' => 'The ID of the desired Alibaba Cloud account.'."\n" + ."\n" + .'You can log on to the [DataWorks](https://workbench.data.aliyun.com/console) console and move the pointer over the profile picture in the upper-right corner to view the ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'maxLength' => 10000000, 'minLength' => 0, 'example' => '139699392458****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The returned results.'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RiskData' => [ - 'description' => 'The information about the high-risk sensitive data. The information includes totalCount and opRiskDatas. opRiskDatas includes the following parameters:'."\n" - ."\n" - .'* sensType: the type of the sensitive data'."\n" - .'* sensLevel: the sensitivity level of the sensitive data'."\n" - .'* opType: the type of the operation'."\n" - .'* sql: the SQL statement that is executed'."\n" - .'* opAccount: the account that is used to perform the operation'."\n" - .'* opTime: the time when the operation was performed'."\n", - 'type' => 'string', - 'example' => '{'."\n" - .' "opRiskDatas": ['."\n" - .' {'."\n" - .' "riskType": "Hierarchical dimension, EMR engine dimension and project dimension, EMR engine project dimension operation data, export method dimension, EMR engine",'."\n" - .' "opTime": "2021-01-04 23:39:13",'."\n" - .' "opType": "SQL_SELECT",'."\n" - .' "opAccount": "user",'."\n" - .' "sensType": "Email/name/mobile phone number",'."\n" - .' "sql": "SELECT * FROM default.jiade_1219_test_create LIMIT 20"'."\n" - .' }'."\n" - .' ],'."\n" - .' "totalCount": 499'."\n" - .'}', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0b57ff7216278945532771749d****', 'title' => ''], + 'ProjectIds' => [ + 'description' => 'The IDs of the DataWorks workspaces. The IDs of the workspaces on which the desired Alibaba Cloud account has permissions were returned.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the DataWorks workspace.', 'type' => 'integer', 'format' => 'int64', 'example' => '466230', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Invalid.Param', - 'errorMessage' => 'The request parameter is invalid.', - ], + ['errorCode' => 'Invalid.Tenant.ConnectionNotExists', 'errorMessage' => 'The connection does not exist.', 'description' => 'The connection does not exist.'], + ['errorCode' => 'Invalid.Tenant.ProjectNotExists', 'errorMessage' => 'The project does not exist.', 'description' => 'The project does not exist.'], + ['errorCode' => 'Invalid.Tenant.UserNotInProject', 'errorMessage' => 'The user is not in the project.', 'description' => 'The user is not in the project.'], ], 403 => [ - [ - 'errorCode' => 'Forbidden.NoTenant', - 'errorMessage' => 'The tenant information cannot be obtained using user ID.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError.DQC.BizError', - 'errorMessage' => 'An internal error occurred.', - ], + ['errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin', 'errorMessage' => 'The user is not a project administrator or owner.', 'description' => 'The user is not a project administrator or owner.'], + ['errorCode' => 'Invalid.Tenant.UserNotInTenant', 'errorMessage' => 'The user is not in tenant.', 'description' => 'The user is not in tenant.'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RiskData\\": \\"{ \\\\\\"opRiskDatas\\\\\\": [ { \\\\\\"riskType\\\\\\": \\\\\\"Hierarchical dimension, EMR engine dimension and project dimension, EMR engine project dimension operation data, export method dimension, EMR engine\\\\\\", \\\\\\"opTime\\\\\\": \\\\\\"2021-01-04 23:39:13\\\\\\", \\\\\\"opType\\\\\\": \\\\\\"SQL_SELECT\\\\\\", \\\\\\"opAccount\\\\\\": \\\\\\"user\\\\\\", \\\\\\"sensType\\\\\\": \\\\\\"Email/name/mobile phone number\\\\\\", \\\\\\"sql\\\\\\": \\\\\\"SELECT * FROM default.jiade_1219_test_create LIMIT 20\\\\\\" } ], \\\\\\"totalCount\\\\\\": 499 }\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 0000-ABCD-EFG****\\n { \\"opRiskDatas\\": [ { \\"riskType\\": \\"分级维度,EMR引擎维度and项目维度,EMR引擎项目维度的操作数据,导出方式维度,EMR引擎\\", \\"opTime\\": \\"2021-01-04 23:39:13\\", \\"opType\\": \\"SQL_SELECT\\", \\"opAccount\\": \\"user\\", \\"sensType\\": \\"邮箱/姓名/手机号\\", \\"sql\\": \\"SELECT * FROM default.jiade_1219_test_create LIMIT 20\\" } ], \\"totalCount\\": 499 }\\n","errorExample":""}]', - 'title' => 'GetOpRiskData', - 'summary' => 'Queries the records that are generated on a specified date for access to the high-risk sensitive data in all the DataWorks workspaces of a tenant.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0b57ff7216278945532771749d****\\",\\n \\"ProjectIds\\": [\\n 466230\\n ]\\n}","type":"json"}]', + 'title' => 'ListProjectIds', + 'summary' => 'Queries the IDs of the workspaces on which a specific Alibaba Cloud account or RAM user has permissions in a specific region.', + 'description' => 'Your Alibaba Cloud account can have different role permissions such as Developer, O\\&M, and Workspace Administrator in a DataWorks workspace. For more information about workspace role permissions, see [DataWorks role management](~~136941~~).', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'GetSensitiveData' => [ - 'methods' => [ - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProjectIds'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:ListProjectIds', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListProjectMembers' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -51101,115 +30086,142 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', + 'abilityTreeCode' => '78326', + 'abilityTreeNodes' => ['FEATUREdideL60QLN'], ], 'parameters' => [ [ - 'name' => 'PageSize', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Maximum value: 1000.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '1000', - 'minimum' => '1', - 'example' => '1000', - ], + 'schema' => ['description' => 'The ID of the DataWorks workspace.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '10000000', 'minimum' => '0', 'example' => '27', 'title' => ''], ], [ - 'name' => 'PageNo', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Pages start from page 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '1000', - 'minimum' => '1', - 'example' => '1', - ], + 'schema' => ['description' => 'The page number. Valid values: 1 to 30. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10000', 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''], ], [ - 'name' => 'Name', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The parameters that you can configure to query the access records. Valid values:'."\n" - ."\n" - .'* dbType'."\n" - .'* instanceName'."\n" - .'* databaseName'."\n" - .'* projectName'."\n" - .'* clusterName'."\n" - ."\n" - .'The sample value shows the parameters configured to query the access records of the sensitive data in the abc database of the Hologres instance ABC. You must configure the parameters based on the compute engine that you use in your business.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '[ {"dbType":"hologres","instanceName":"ABC","databaseName":"abc"}, {"dbType":"ODPS.ODPS","projectName":"adbc"} ]', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '20', 'minimum' => '5', 'default' => '10', 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Response parameters'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'SensitiveData' => [ - 'description' => 'The information about the sensitive data returned. The information includes totalCount and sensDatas. sensDatas includes the following parameters:'."\n" - ."\n" - .'* guid: the ID of the metadata of the tenant. For example, the ID of the metadata in the MaxCompute compute engine is in the Project name.Table name.Column name format.'."\n" - .'* sensType: the type of the sensitive data.'."\n" - .'* sensLevel: the sensitivity level of the sensitive data'."\n", + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1AFAE64E-D1BE-432B-A9****', 'title' => ''], + 'Data' => [ + 'description' => 'The returned results.', 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'ProjectMemberList' => [ + 'description' => 'The information about members in the DataWorks workspace.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status of the member. Valid values:'."\n" + ."\n" + .'- 0: NORMAL, which indicates that the member is in a normal state.'."\n" + ."\n" + .'- 1: FORBIDDEN, which indicates that the member is disabled.'."\n" + ."\n" + .'- 2: DELETED, which indicates that the member is deleted.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'ProjectMemberId' => ['description' => 'The member ID.', 'type' => 'string', 'example' => '121', 'title' => ''], + 'Nick' => ['description' => 'The nickname of the member.', 'type' => 'string', 'example' => 'zhangsan', 'title' => ''], + 'ProjectMemberName' => ['description' => 'The name of the member.', 'type' => 'string', 'example' => 'John Doe', 'title' => ''], + 'ProjectMemberType' => ['description' => 'The type of the member. Valid values:'."\n" + ."\n" + .'- 1: USER\\_ALIYUN, which indicates that the member is an Alibaba Cloud account.'."\n" + ."\n" + .'- 5: USER\\_UBACCOUNT, which indicates that the member is a RAM user.'."\n" + ."\n" + .'- 6: USER\\_STS\\_ROLE, which indicates that the member is a RAM role.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'ProjectRoleList' => [ + 'description' => 'The roles that are assigned to the member.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ProjectRoleId' => ['description' => 'The role ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ProjectRoleType' => ['description' => 'The type of the role. Valid values:'."\n" + ."\n" + .'- 0: SYSTEM, which indicates that the role is a built-in role.'."\n" + ."\n" + .'- 2: USER\\_CUSTOM, which indicates that the role is a custom role.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'ProjectRoleName' => ['description' => 'The name of the role. DataWorks provides built-in roles and allows you to create custom roles based on your business requirements. For more information about roles, see [Overview of users, roles, and permissions](~~295463~~).', 'type' => 'string', 'example' => 'Visitor', 'title' => ''], + 'ProjectRoleCode' => ['description' => 'The code of the role. DataWorks provides built-in roles and allows you to create custom roles based on your business requirements. For more information about roles, see [Overview of users, roles, and permissions](~~295463~~).', 'type' => 'string', 'example' => 'role_project_guest', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', 'example' => '', ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Invalid.Param', - 'errorMessage' => 'The request parameter is invalid.', - ], + ['errorCode' => 'Invalid.Tenant.ConnectionNotExists', 'errorMessage' => 'The connection does not exist.', 'description' => 'The connection does not exist.'], + ['errorCode' => 'Invalid.Tenant.ProjectNotExists', 'errorMessage' => 'The project does not exist.', 'description' => 'The project does not exist.'], + ['errorCode' => 'Invalid.Tenant.UserNotInProject', 'errorMessage' => 'The user is not in the project.', 'description' => 'The user is not in the project.'], ], 403 => [ - [ - 'errorCode' => 'Forbidden.NoTenant', - 'errorMessage' => 'The tenant information cannot be obtained using user ID.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError.DQC.BizError', - 'errorMessage' => 'An internal error occurred.', - ], + ['errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin', 'errorMessage' => 'The user is not a project administrator or owner.', 'description' => 'The user is not a project administrator or owner.'], + ['errorCode' => 'Invalid.Tenant.UserNotInTenant', 'errorMessage' => 'The user is not in tenant.', 'description' => 'The user is not in tenant.'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"SensitiveData\\": {\\n \\"sensDatas\\": [\\n {\\n \\"sensLevel\\": \\"L1\\",\\n \\"guid\\": \\"dsg_demo.animal.dog\\",\\n \\"sensType\\": \\"姓名\\"\\n }\\n ],\\n \\"totalCount\\": 2171\\n },\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 0000-ABCD-EFG****\\n","errorExample":""}]', - 'title' => 'GetSensitiveData', - 'summary' => 'Queries the latest sensitive data in all the DataWorks workspaces of a tenant.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AFAE64E-D1BE-432B-A9****\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 3,\\n \\"ProjectMemberList\\": [\\n {\\n \\"Status\\": \\"0\\",\\n \\"ProjectMemberId\\": \\"121\\",\\n \\"Nick\\": \\"zhangsan\\",\\n \\"ProjectMemberName\\": \\"John Doe\\",\\n \\"ProjectMemberType\\": \\"1\\",\\n \\"ProjectRoleList\\": [\\n {\\n \\"ProjectRoleId\\": 1,\\n \\"ProjectRoleType\\": \\"0\\",\\n \\"ProjectRoleName\\": \\"Visitor\\",\\n \\"ProjectRoleCode\\": \\"role_project_guest\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListProjectMembers', + 'summary' => 'Queries a list of existing members in a DataWorks workspace.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ScanSensitiveData' => [ - 'methods' => [ - 'get', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:ListProjectMembers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'ListProjectRoles' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -51219,72 +30231,87 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', + 'abilityTreeCode' => '78327', + 'abilityTreeNodes' => ['FEATUREdideL60QLN'], ], 'parameters' => [ - [ - 'name' => 'Data', - 'in' => 'query', - 'schema' => [ - 'description' => 'The data that you want to check.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '13900001234', - ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the DataWorks workspace.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '1000000', 'minimum' => '0', 'example' => '27', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The data returned.'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'Sensitives' => [ - 'description' => 'The check result. sensDatas indicates the rules that are used to check the sensitive data. sensDatas includes the following parameters:'."\n" - ."\n" - .'* hitCount: the number of times that the sensitive data hits the rule.'."\n" - .'* ruleName: the name of the rule.'."\n", - 'type' => 'object', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '1AFAE64E-D1BE-432B-A9****', 'title' => ''], + 'ProjectRoleList' => [ + 'description' => 'The roles in the DataWorks workspace.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ProjectRoleId' => ['description' => 'The ID of the role in the DataWorks workspace.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ProjectRoleType' => ['description' => 'The type of the role in the DataWorks workspace.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'ProjectRoleName' => ['description' => 'The name of the role in the DataWorks workspace.', 'type' => 'string', 'example' => 'Visitor', 'title' => ''], + 'ProjectRoleCode' => ['description' => 'The code of the role in the DataWorks workspace.', 'type' => 'string', 'example' => 'role_project_guest', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', 'example' => '', ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Meta.NoTenant', - 'errorMessage' => 'The user is not the owner of any tenants.', - ], + 400 => [ + ['errorCode' => 'Invalid.Tenant.ConnectionNotExists', 'errorMessage' => 'The connection does not exist.', 'description' => 'The connection does not exist.'], + ['errorCode' => 'Invalid.Tenant.ProjectNotExists', 'errorMessage' => 'The project does not exist.', 'description' => 'The project does not exist.'], + ['errorCode' => 'Invalid.Tenant.UserNotInProject', 'errorMessage' => 'The user is not in the project.', 'description' => 'The user is not in the project.'], ], - 500 => [ - [ - 'errorCode' => 'InternalError.DQC.BizError', - 'errorMessage' => 'An internal error occurred.', - ], + 403 => [ + ['errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin', 'errorMessage' => 'The user is not a project administrator or owner.', 'description' => 'The user is not a project administrator or owner.'], + ['errorCode' => 'Invalid.Tenant.UserNotInTenant', 'errorMessage' => 'The user is not in tenant.', 'description' => 'The user is not in tenant.'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Sensitives\\": {\\n \\"sensDatas\\": [\\n {\\n \\"hitCount\\": 1,\\n \\"ruleName\\": \\"手机号\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 0000-ABCD-EFG****\\n","errorExample":""}]', - 'title' => 'ScanSensitiveData', - 'summary' => 'Checks whether input data contains sensitive data.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AFAE64E-D1BE-432B-A9****\\",\\n \\"ProjectRoleList\\": [\\n {\\n \\"ProjectRoleId\\": 1,\\n \\"ProjectRoleType\\": \\"0\\",\\n \\"ProjectRoleName\\": \\"Visitor\\",\\n \\"ProjectRoleCode\\": \\"role_project_guest\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListProjectRoles', + 'summary' => 'Queries a list of roles in a DataWorks workspace.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DsgQuerySensResult' => [ - 'summary' => 'Queries the identification results of sensitive data.', - 'methods' => [ - 'post', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:ListProjectRoles', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'ListProjects' => [ + 'summary' => 'Queries a list of DataWorks workspaces of the tenant to which a user belongs.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -51292,1832 +30319,2284 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '215091', - 'abilityTreeNodes' => [ - 'FEATUREdide64ITEV', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'TenantId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '10241024', - ], - ], - [ - 'name' => 'DbType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The type of the database. Valid values:'."\n" - ."\n" - .'* **ODPS.ODPS**'."\n" - .'* **HOLO.POSTGRES**'."\n" - .'* **EMR**'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'ODPS.ODPS', - ], - ], - [ - 'name' => 'ProjectName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the workspace name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'project', - ], - ], - [ - 'name' => 'SchemaName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the schema.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'schema', - ], - ], - [ - 'name' => 'Table', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'table', - ], - ], - [ - 'name' => 'Col', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the field.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'col', - ], - ], - [ - 'name' => 'NodeName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of a data category.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Personal information', - ], - ], - [ - 'name' => 'Level', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The sensitivity level of the field.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '3', - ], - ], - [ - 'name' => 'SensStatus', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The sensitivity status of the field.'."\n" - ."\n" - .'* 1: indicates sensitive.'."\n" - .'* \\-1: indicates non-sensitive.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => '1', - ], - ], - [ - 'name' => 'SensitiveId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The sensitive field ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '10241024', - ], - ], - [ - 'name' => 'SensitiveName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the sensitive field.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'name', - ], - ], - [ - 'name' => 'Order', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The sorting method. Valid values:'."\n" - ."\n" - .'* DESC'."\n" - .'* ASC'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'DESC', - ], + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Valid values: 1 to 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '10000000', 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''], ], [ - 'name' => 'OrderField', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The field used for sorting.'."\n" - ."\n" - .'* gmt_create'."\n" - .'* gmt_modified'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gmt_create', - ], + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10000000', 'minimum' => '1', 'default' => '10', 'example' => '10', 'title' => ''], ], [ - 'name' => 'PageNo', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The page number. Pages start from page 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'name' => 'ResourceManagerResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmzbn7pt****', 'title' => ''], ], [ - 'name' => 'PageSize', - 'in' => 'formData', + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 20.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The tags to add to the workspace.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The key of tag N to add to the workspace.'."\n", 'type' => 'string', 'required' => false, 'example' => 'key', 'title' => ''], + 'Value' => ['description' => 'The value of tag N to add to the workspace.'."\n", 'type' => 'string', 'required' => false, 'example' => 'value', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => '10', + 'maxItems' => 20, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'OpenApiResultModel', - 'description' => 'The returned data.'."\n", + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '400', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Missing parameter', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - ], - 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'any', - 'example' => '1234', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '900000001', - ], - 'DynamicErrorCode' => [ - 'description' => 'The error code. The value is the same as that of ErrorCode.'."\n", - 'type' => 'string', - 'example' => '400', - ], - 'DynamicErrorMessage' => [ - 'description' => 'The error message. The value is the same as that of ErrorMessage.'."\n", - 'type' => 'string', - 'example' => 'Missing parameter', + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '20658801****', 'title' => ''], + 'PageResult' => [ + 'description' => 'The results that are returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '68', 'title' => ''], + 'ProjectList' => [ + 'description' => 'The DataWorks workspaces.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ProjectStatusCode' => ['description' => 'The status code of the workspace. Valid values:'."\n" + ."\n" + .'* AVAILABLE: 0, which indicates that the workspace is running as expected.'."\n" + .'* DELETED: 1, which indicates that the workspace is deleted.'."\n" + .'* INITIALIZING: 2, which indicates that the workspace is being initialized.'."\n" + .'* INIT_FAILED: 3, which indicates that the workspace fails to be initialized.'."\n" + .'* FORBIDDEN: 4, which indicates that the workspace is manually disabled.'."\n" + .'* DELETING: 5, which indicates that the workspace is being deleted.'."\n" + .'* DEL_FAILED: 6, which indicates that the workspace fails to be deleted.'."\n" + .'* FROZEN: 7, which indicates that the workspace is frozen due to overdue payments.'."\n" + .'* UPDATING: 8, which indicates that the workspace is being updated. After you associate a compute engine with the workspace, the system initializes the compute engine and updates the workspace.'."\n" + .'* UPDATE_FAILED: 9, which indicates that the workspace fails to be updated.'."\n", 'type' => 'string', 'example' => 'AVAILABLE', 'title' => ''], + 'ProjectStatus' => ['description' => 'The status of the workspace. Valid values:'."\n" + ."\n" + .'* 0: AVAILABLE, which indicates that the workspace is running as expected.'."\n" + .'* 1: DELETED, which indicates that the workspace is deleted.'."\n" + .'* 2: INITIALIZING, which indicates that the workspace is being initialized.'."\n" + .'* 3: INIT_FAILED, which indicates that the workspace fails to be initialized.'."\n" + .'* 4: FORBIDDEN, which indicates that the workspace is manually disabled.'."\n" + .'* 5: DELETING, which indicates that the workspace is being deleted.'."\n" + .'* 6: DEL_FAILED, which indicates that the workspace fails to be deleted.'."\n" + .'* 7: FROZEN, which indicates that the workspace is frozen due to overdue payments.'."\n" + .'* 8: UPDATING, which indicates that the workspace is being updated. After you associate a compute engine with the workspace, the system initializes the compute engine and updates the workspace.'."\n" + .'* 9: UPDATE_FAILED, which indicates that the workspace fails to be updated.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ProjectName' => ['description' => 'The display name of the workspace.'."\n", 'type' => 'string', 'example' => 'test_project', 'title' => ''], + 'ProjectIdentifier' => ['description' => 'The name of the workspace.'."\n", 'type' => 'string', 'example' => 'test_project', 'title' => ''], + 'ProjectId' => ['description' => 'The workspace ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '466230', 'title' => ''], + 'ProjectDescription' => ['description' => 'The description of the workspace.'."\n", 'type' => 'string', 'example' => 'test_describe', 'title' => ''], + 'ProjectOwnerBaseId' => ['description' => 'The ID of the user used by the workspace owner.'."\n", 'type' => 'string', 'example' => '13969939245****', 'title' => ''], + 'ResourceManagerResourceGroupId' => ['description' => 'The resource group ID.'."\n", 'type' => 'string', 'example' => 'rg-acfmzbn7****', 'title' => ''], + 'Tags' => [ + 'description' => 'The tags added to the workspace.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The key of tag N added to the workspace.'."\n", 'type' => 'string', 'example' => 'key', 'title' => ''], + 'Value' => ['description' => 'The value of tag N added to the workspace.'."\n", 'type' => 'string', 'example' => 'value', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'DisableDevelopment' => ['description' => 'Indicates whether the Development role is disabled. Valid values:'."\n" + ."\n" + .'* **false**: enabled'."\n" + .'* **true**: disabled'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'UseProxyOdpsAccount' => ['description' => 'Indicates whether a proxy account is used to access the MaxCompute compute engine associated with the workspace. Valid values:'."\n" + ."\n" + .'* **false**'."\n" + .'* **true**'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'TablePrivacyMode' => ['description' => 'Indicates whether the MaxCompute tables in the workspace are visible to the users within a tenant. Valid values:'."\n" + ."\n" + .'* **0**: invisible'."\n" + .'* **1**: visible'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'IsDefault' => ['description' => 'Indicates whether the workspace is a default workspace. Valid values:'."\n" + ."\n" + .'* **1**: The workspace is a default workspace.'."\n" + .'* **0**: The workspace is not a default workspace.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'BADPARAMETERS', - 'errorMessage' => 'Parameters are missing or in the wrong format.', - ], + ['errorCode' => 'Invalid.Tenant.ConnectionNotExists', 'errorMessage' => 'The connection does not exist.', 'description' => 'The connection does not exist.'], + ['errorCode' => 'Invalid.Tenant.ProjectNotExists', 'errorMessage' => 'The project does not exist.', 'description' => 'The project does not exist.'], + ['errorCode' => 'Invalid.Tenant.UserAlreadyInProject', 'errorMessage' => 'The user already exists in the project.', 'description' => 'The user has already existed in project.'], + ['errorCode' => 'Invalid.Tenant.UserNotInProject', 'errorMessage' => 'The user is not in the project.', 'description' => 'The user is not in the project.'], + ], + 403 => [ + ['errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin', 'errorMessage' => 'The user is not a project administrator or owner.', 'description' => 'The user is not a project administrator or owner.'], + ['errorCode' => 'Invalid.Tenant.UserNotInTenant', 'errorMessage' => 'The user is not in tenant.', 'description' => 'The user is not in tenant.'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"400\\",\\n \\"ErrorMessage\\": \\"Missing parameter\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": \\"1234\\",\\n \\"RequestId\\": \\"900000001\\",\\n \\"DynamicErrorCode\\": \\"400\\",\\n \\"DynamicErrorMessage\\": \\"Missing parameter\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 400\\n 缺少参数\\n 400\\n 1234\\n 900000001\\n 400\\n 缺少参数\\n","errorExample":""}]', - 'title' => 'DsgQuerySensResult', - 'description' => 'The query capability of the API operation is similar to the query feature in Data Security Guard in the DataWorks console. The API operation can be used to query the identification results of sensitive data of a tenant based on the association with the tenant ID.'."\n" - ."\n" - .'* You can search for a specific identification result based on filter conditions such as data source type and workspace.'."\n" - .'* You can sort the identification results of sensitive data of a tenant based on the values of a field in ascending or descending order.'."\n" - .'* This operation supports paged query.'."\n", - ], - 'QueryDefaultTemplate' => [ - 'summary' => 'Queries the default data category and data sensitivity level template defined by Data Security Guard.', - 'methods' => [ - 'post', + 'title' => 'ListProjects', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-10-31T02:42:13.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProjects'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20658801****\\",\\n \\"PageResult\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 68,\\n \\"ProjectList\\": [\\n {\\n \\"ProjectStatusCode\\": \\"AVAILABLE\\",\\n \\"ProjectStatus\\": 0,\\n \\"ProjectName\\": \\"test_project\\",\\n \\"ProjectIdentifier\\": \\"test_project\\",\\n \\"ProjectId\\": 466230,\\n \\"ProjectDescription\\": \\"test_describe\\",\\n \\"ProjectOwnerBaseId\\": \\"13969939245****\\",\\n \\"ResourceManagerResourceGroupId\\": \\"rg-acfmzbn7****\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"key\\",\\n \\"Value\\": \\"value\\"\\n }\\n ],\\n \\"DisableDevelopment\\": true,\\n \\"UseProxyOdpsAccount\\": true,\\n \\"TablePrivacyMode\\": 1,\\n \\"IsDefault\\": 1\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListQualityResultsByEntity' => [ + 'summary' => 'Use `ListQualityResultsByEntity` to retrieve validation results based on a partition expression.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'deprecated' => false, + 'operationType' => 'read', + 'deprecated' => true, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '212265', - 'abilityTreeNodes' => [ - 'FEATUREdideBVSRMP', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '78329', + 'abilityTreeNodes' => ['FEATUREdideGK4B66'], ], 'parameters' => [ [ - 'name' => 'TenantId', + 'name' => 'EntityId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '10241024', - ], + 'schema' => ['description' => 'The ID of the partition expression. You can call the [GetQualityEntity](~~174003~~) operation to obtain this ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '15232', 'title' => ''], + ], + [ + 'name' => 'StartDate', + 'in' => 'formData', + 'schema' => ['description' => 'The start of the business date range. The value must be in the `yyyy-MM-dd HH:mm:ss` format.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-09-20 00:00:00', 'title' => ''], + ], + [ + 'name' => 'EndDate', + 'in' => 'formData', + 'schema' => ['description' => 'The end of the business date range. The value must be in the `yyyy-MM-dd HH:mm:ss` format.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-09-21 00:00:00', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['description' => 'The number of entries to return per page. The default is 10, and the maximum is 20.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '20', 'minimum' => '1', 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => ['description' => 'The page number to return.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the engine or data source. You can find this name on the Data Source Configuration page.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'autotest', 'title' => ''], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the DataWorks workspace.', 'type' => 'integer', 'format' => 'int64', 'docRequired' => true, 'required' => true, 'example' => '12345', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'OpenApiResultModel', - 'description' => 'The returned data.'."\n", + 'description' => 'The data quality check results.', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '9990030003', - 'default' => 'null', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Parameter error', - 'default' => 'null', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '400', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'You have no permission.', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => 'CBA58543-00D4-41****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '401', 'title' => ''], 'Data' => [ - 'description' => 'The returned data about the default data category and data sensitivity level template. The data is in the JSON array format.'."\n", - 'type' => 'any', - 'required' => true, - 'example' => '[{"gmtModified":1709022365000,"fileName":"default file","isDelete":false,"isDefaultTemplate":true}]', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '102400001', - 'default' => 'null', + 'description' => 'The data object that contains the quality check results.', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '50', 'title' => ''], + 'RuleChecks' => [ + 'description' => 'The monitoring rule check results.', + 'type' => 'array', + 'items' => [ + 'description' => 'The check result.', + 'type' => 'object', + 'properties' => [ + 'BlockType' => ['description' => 'The strength of the monitoring rule. Valid values:'."\n" + ."\n" + .'- 1: Strong Rule. If a Strong Rule check generates a critical alert, the associated Scheduling Task is blocked.'."\n" + ."\n" + .'- 0: Weak Rule.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'WarningThreshold' => ['description' => 'The warning threshold. This value indicates the acceptable deviation from the expected value. You can customize this threshold based on your business requirements.', 'type' => 'number', 'format' => 'float', 'example' => '0.1', 'title' => ''], + 'Property' => ['description' => 'The name of the monitored column in the Data Source table.', 'type' => 'string', 'example' => 'type', 'title' => ''], + 'TableName' => ['description' => 'The name of the table that is monitored.', 'type' => 'string', 'example' => 'dual', 'title' => ''], + 'Comment' => ['description' => 'The description of the monitoring rule.', 'type' => 'string', 'example' => 'The description of the rule.', 'title' => ''], + 'CheckResultStatus' => ['description' => 'The status of the check result. This parameter corresponds to the status displayed in the UI. Valid values:'."\n" + ."\n" + .'- 0: Normal'."\n" + ."\n" + .'- 1: Warning'."\n" + ."\n" + .'- 2: Critical', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'TemplateName' => ['description' => 'The name of the rule template.', 'type' => 'string', 'example' => 'Expected value verification', 'title' => ''], + 'CheckerName' => ['description' => 'The name of the checker.', 'type' => 'string', 'example' => 'fulx', 'title' => ''], + 'RuleId' => ['description' => 'The monitoring rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123123232', 'title' => ''], + 'FixedCheck' => ['description' => 'Specifies whether the check is based on a fixed value. Valid values:'."\n" + ."\n" + .'- true: The check is based on a fixed value.'."\n" + ."\n" + .'- false: The check is not based on a fixed value.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Op' => ['description' => 'The comparison operator.', 'type' => 'string', 'example' => '>', 'title' => ''], + 'UpperValue' => ['description' => 'The predicted upper limit. This value is automatically generated after you set a threshold.', 'type' => 'number', 'format' => 'float', 'example' => '25555', 'title' => ''], + 'ActualExpression' => ['description' => 'The expression that specifies the data partition that was checked.', 'type' => 'string', 'example' => 'ds=20200912', 'title' => ''], + 'ExternalId' => ['description' => 'The Node ID of the Scheduling Task.', 'type' => 'string', 'example' => '1112323123', 'title' => ''], + 'TimeCost' => ['description' => 'The time taken to run the check, in seconds.', 'type' => 'string', 'example' => '202', 'title' => ''], + 'Trend' => ['description' => 'The trend of the check result.', 'type' => 'string', 'example' => 'abs', 'title' => ''], + 'ExternalType' => ['description' => 'The type of the scheduling system. Currently, only CWF is supported.', 'type' => 'string', 'example' => 'CWF2', 'title' => ''], + 'BizDate' => ['description' => 'The business date. If the monitored data is offline, the business date is typically the day before the check is performed.', 'type' => 'integer', 'format' => 'int64', 'example' => '1600704000000', 'title' => ''], + 'CheckResult' => ['description' => 'The check result. This parameter usually has the same value as `CheckResultStatus`. Valid values:'."\n" + ."\n" + .'- 0: Normal'."\n" + ."\n" + .'- 1: Warning'."\n" + ."\n" + .'- 2: Critical', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ResultString' => ['description' => 'The check result, returned as a string.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'MatchExpression' => ['description' => 'The partition filter expression.', 'type' => 'string', 'example' => 'ds=$[yyyymmdd]', 'title' => ''], + 'CheckerType' => ['description' => 'The type of the checker. Valid values:'."\n" + ."\n" + .'- 0: Fixed Value'."\n" + ."\n" + .'- 1: Fluctuation'."\n" + ."\n" + .'- 2: Dynamic Threshold', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ProjectName' => ['description' => 'The name of the monitored compute engine or Data Source.', 'type' => 'string', 'example' => 'autotest', 'title' => ''], + 'BeginTime' => ['description' => 'The start time of the check. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'example' => '1600704000000', 'title' => ''], + 'DateType' => ['description' => 'The scheduling cycle. A common value is YMD, which represents year, month, and day.', 'type' => 'string', 'example' => 'YMD', 'title' => ''], + 'CriticalThreshold' => ['description' => 'The acceptable deviation from the expected value that triggers a critical alert. This threshold is customizable. If a critical alert is triggered for a Strong Rule, the associated Scheduling Task is blocked.', 'type' => 'number', 'format' => 'float', 'example' => '0.5', 'title' => ''], + 'IsPrediction' => ['description' => 'Specifies whether the result is a predicted value. Valid values:'."\n" + ."\n" + .'- true: The result is a predicted value.'."\n" + ."\n" + .'- false: The result is not a predicted value.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RuleName' => ['description' => 'The name of the monitoring rule.', 'type' => 'string', 'example' => 'The name of the rule.', 'title' => ''], + 'CheckerId' => ['description' => 'The ID of the checker.', 'type' => 'integer', 'format' => 'int32', 'example' => '7', 'title' => ''], + 'DiscreteCheck' => ['description' => 'Specifies whether the check is a discrete check. Valid values:'."\n" + ."\n" + .'- true: The check is a discrete check.'."\n" + ."\n" + .'- false: The check is not a discrete check.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'EndTime' => ['description' => 'The end time of the check. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'format' => 'int64', 'example' => '1600704000000', 'title' => ''], + 'MethodName' => ['description' => 'The method for collecting sample data. Valid values include `avg`, `count`, `sum`, `min`, `max`, `count_distinct`, `user_defined`, `table_count`, `table_size`, `table_dt_load_count`, `table_dt_refuseload_count`, `null_value`, `null_value/table_count`, `(table_count-count_distinct)/table_count`, and `table_count-count_distinct`.', 'type' => 'string', 'example' => 'count_distinct', 'title' => ''], + 'LowerValue' => ['description' => 'The predicted lower limit. This value is automatically generated after you set a threshold.', 'type' => 'number', 'format' => 'float', 'example' => '2344', 'title' => ''], + 'EntityId' => ['description' => 'The ID of the partition filter expression.', 'type' => 'integer', 'format' => 'int64', 'example' => '15432322', 'title' => ''], + 'WhereCondition' => ['description' => 'The filter condition of the monitoring rule.', 'type' => 'string', 'example' => 'id>0', 'title' => ''], + 'ExpectValue' => ['description' => 'The expected value.', 'type' => 'number', 'format' => 'float', 'example' => '200', 'title' => ''], + 'TemplateId' => ['description' => 'The ID of the rule template.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'TaskId' => ['description' => 'The ID of the check task.', 'type' => 'string', 'example' => '16008552981681a0d6****', 'title' => ''], + 'Id' => ['description' => 'The unique ID of the check result.', 'type' => 'integer', 'format' => 'int64', 'example' => '121212121', 'title' => ''], + 'ReferenceValue' => [ + 'description' => 'The historical sample values.', + 'type' => 'array', + 'items' => [ + 'description' => 'A historical check result.', + 'type' => 'object', + 'properties' => [ + 'DiscreteProperty' => ['description' => 'The value of the sample field when a `group by` clause is used. For example, if you group by the gender field, the values for `DiscreteProperty` can be male, female, or null.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'Value' => ['description' => 'The historical check value.', 'type' => 'number', 'format' => 'float', 'example' => '19', 'title' => ''], + 'BizDate' => ['description' => 'The business date. If the monitored data is offline, the business date is typically the day before the check is performed.', 'type' => 'string', 'example' => '2020-12-03', 'title' => ''], + 'SingleCheckResult' => ['description' => 'The result of a single check.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Threshold' => ['description' => 'The threshold that was applied to this historical data point.', 'type' => 'number', 'format' => 'float', 'example' => '0.5', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'SampleValue' => [ + 'description' => 'The current sample values.', + 'type' => 'array', + 'items' => [ + 'description' => 'A sample check result.', + 'type' => 'object', + 'properties' => [ + 'DiscreteProperty' => ['description' => 'The value of the sample field when a `group by` clause is used. For example, if you group by the gender field, the values for `DiscreteProperty` can be male, female, or null.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'BizDate' => ['description' => 'The business date. If the monitored data is offline, the business date is typically the day before the check is performed.', 'type' => 'string', 'example' => '2020-12-03', 'title' => ''], + 'Value' => ['description' => 'The current sample value.', 'type' => 'number', 'format' => 'float', 'example' => '19', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'BADPARAMETERS', - 'errorMessage' => 'Parameters are missing or in the wrong format.', - ], - ], + 'staticInfo' => [ + 'substitutions' => ['dataworks-public::2024-05-18::ListDataQualityScanRuns'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"9990030003\\",\\n \\"ErrorMessage\\": \\"Parameter error\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": \\"[{\\\\\\"gmtModified\\\\\\":1709022365000,\\\\\\"fileName\\\\\\":\\\\\\"default file\\\\\\",\\\\\\"isDelete\\\\\\":false,\\\\\\"isDefaultTemplate\\\\\\":true}]\\",\\n \\"RequestId\\": \\"102400001\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 9990030003\\n 参数错误\\n 400\\n [{\\"gmtModified\\":1709022365000,\\"fileName\\":\\"默认文件\\",\\"isDelete\\":false,\\"isDefaultTemplate\\":true}]\\n 102400001\\n","errorExample":""}]', - 'title' => 'QueryDefaultTemplate', - ], - 'DsgStopSensIdentify' => [ - 'summary' => 'Stops a sensitive data identification task.', - 'methods' => [ - 'post', + 'title' => 'ListQualityResultsByEntity', + 'description' => '***', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-01-22T02:34:47.000Z', 'description' => 'Request parameters changed, Response parameters changed, Response parameters changed'], + ['createdAt' => '2023-03-08T07:46:00.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2021-10-22T11:26:06.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"You have no permission.\\",\\n \\"RequestId\\": \\"CBA58543-00D4-41****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"401\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 50,\\n \\"RuleChecks\\": [\\n {\\n \\"BlockType\\": 0,\\n \\"WarningThreshold\\": 0.1,\\n \\"Property\\": \\"type\\",\\n \\"TableName\\": \\"dual\\",\\n \\"Comment\\": \\"The description of the rule.\\",\\n \\"CheckResultStatus\\": 0,\\n \\"TemplateName\\": \\"Expected value verification\\",\\n \\"CheckerName\\": \\"fulx\\",\\n \\"RuleId\\": 123123232,\\n \\"FixedCheck\\": false,\\n \\"Op\\": \\">\\",\\n \\"UpperValue\\": 25555,\\n \\"ActualExpression\\": \\"ds=20200912\\",\\n \\"ExternalId\\": \\"1112323123\\",\\n \\"TimeCost\\": \\"202\\",\\n \\"Trend\\": \\"abs\\",\\n \\"ExternalType\\": \\"CWF2\\",\\n \\"BizDate\\": 1600704000000,\\n \\"CheckResult\\": 0,\\n \\"ResultString\\": \\"test\\",\\n \\"MatchExpression\\": \\"ds=$[yyyymmdd]\\",\\n \\"CheckerType\\": 1,\\n \\"ProjectName\\": \\"autotest\\",\\n \\"BeginTime\\": 1600704000000,\\n \\"DateType\\": \\"YMD\\",\\n \\"CriticalThreshold\\": 0.5,\\n \\"IsPrediction\\": true,\\n \\"RuleName\\": \\"The name of the rule.\\",\\n \\"CheckerId\\": 7,\\n \\"DiscreteCheck\\": true,\\n \\"EndTime\\": 1600704000000,\\n \\"MethodName\\": \\"count_distinct\\",\\n \\"LowerValue\\": 2344,\\n \\"EntityId\\": 15432322,\\n \\"WhereCondition\\": \\"id>0\\",\\n \\"ExpectValue\\": 200,\\n \\"TemplateId\\": 5,\\n \\"TaskId\\": \\"16008552981681a0d6****\\",\\n \\"Id\\": 121212121,\\n \\"ReferenceValue\\": [\\n {\\n \\"DiscreteProperty\\": \\"0\\",\\n \\"Value\\": 19,\\n \\"BizDate\\": \\"2020-12-03\\",\\n \\"SingleCheckResult\\": 0,\\n \\"Threshold\\": 0.5\\n }\\n ],\\n \\"SampleValue\\": [\\n {\\n \\"DiscreteProperty\\": \\"0\\",\\n \\"BizDate\\": \\"2020-12-03\\",\\n \\"Value\\": 19\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListQualityResultsByRule' => [ + 'summary' => 'Validates the quality of a Data Source against Validation Rules and returns the Validation Results.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'deprecated' => false, + 'operationType' => 'read', + 'deprecated' => true, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '213660', - 'abilityTreeNodes' => [ - 'FEATUREdide1B7LSC', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdideGK4B66'], ], 'parameters' => [ [ - 'name' => 'TenantId', + 'name' => 'RuleId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '10241024', - ], + 'schema' => ['description' => 'The ID of the monitoring rule. You can use the rule ID and a partition filter to query the monitoring results of the rule.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '152322134', 'title' => ''], ], [ - 'name' => 'JobId', + 'name' => 'StartDate', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the sensitive data identification task. You can call the [DsgRunSensIdentify](~~2744039~~) operation to obtain the task ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1000001', - ], + 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in the yyyy-MM-dd HH:mm:ss format.'."\n" + ."\n" + .'You must configure this parameter together with the EndDate parameter. The time range to query cannot exceed 7 days.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-09-20 00:00:00', 'title' => ''], + ], + [ + 'name' => 'EndDate', + 'in' => 'formData', + 'schema' => ['description' => 'The end of the time range to query. Specify the time in the yyyy-MM-dd HH:mm:ss format.'."\n" + ."\n" + .'You must configure this parameter together with the StartDate parameter. The time range to query cannot exceed 7 days.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-09-22 00:00:00', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '20', 'minimum' => '1', 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the compute engine or data source for which you want to perform data quality monitoring.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'autotest', 'title' => ''], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the DataWorks workspace.', 'type' => 'integer', 'format' => 'int64', 'docRequired' => true, 'required' => true, 'example' => '123456', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'OpenApiResultModel', - 'description' => 'The returned data.'."\n", + 'description' => 'The check result.', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '9990030003', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Missing parameter', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'You have no permission.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'CBA58543-00D4-41****', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '401', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'The returned data, which is of the Boolean type.'."\n", - 'type' => 'any', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '10000001', + 'description' => 'The top-level object of the check result.', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], + 'RuleChecks' => [ + 'description' => 'A list of check results.', + 'type' => 'array', + 'items' => [ + 'description' => 'A check result.', + 'type' => 'object', + 'properties' => [ + 'BlockType' => ['description' => 'The strength of the monitoring rule. A strong rule can block a downstream scheduling task if a critical alert is triggered. Valid values:'."\n" + ."\n" + .'- `1`: Strong rule.'."\n" + ."\n" + .'- `0`: Weak rule.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'WarningThreshold' => ['description' => 'The custom threshold for a warning alert. An alert is triggered if the deviation from the expected value exceeds this threshold.', 'type' => 'number', 'format' => 'float', 'example' => '0.1', 'title' => ''], + 'Property' => ['description' => 'The column in the source data table that the rule checks.', 'type' => 'string', 'example' => 'type', 'title' => ''], + 'TableName' => ['description' => 'The name of the table being checked.', 'type' => 'string', 'example' => 'dual', 'title' => ''], + 'Comment' => ['description' => 'The description of the monitoring rule.', 'type' => 'string', 'example' => 'The description of the rule.', 'title' => ''], + 'CheckResultStatus' => ['description' => 'The status of the check result.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'TemplateName' => ['description' => 'The name of the rule template.', 'type' => 'string', 'example' => 'Expected value verification', 'title' => ''], + 'CheckerName' => ['description' => 'The name of the checker.', 'type' => 'string', 'example' => 'fulx', 'title' => ''], + 'RuleId' => ['description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123421', 'title' => ''], + 'FixedCheck' => ['description' => 'Indicates whether a fixed-value check is used. Valid values:'."\n" + ."\n" + .'- `true`: A fixed-value check is used.'."\n" + ."\n" + .'- `false`: A fixed-value check is not used.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Op' => ['description' => 'The comparison operator.', 'type' => 'string', 'example' => '>', 'title' => ''], + 'UpperValue' => ['description' => 'The predicted upper limit, which is automatically generated based on the configured threshold.', 'type' => 'number', 'format' => 'float', 'example' => '22200', 'title' => ''], + 'ActualExpression' => ['description' => 'The actual data partition that was checked.', 'type' => 'string', 'example' => 'ds=20200925', 'title' => ''], + 'ExternalId' => ['description' => 'The node ID of the scheduling task.', 'type' => 'string', 'example' => '123112232', 'title' => ''], + 'TimeCost' => ['description' => 'The duration of the check.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'Trend' => ['description' => 'The trend of the check result.', 'type' => 'string', 'example' => 'up', 'title' => ''], + 'ExternalType' => ['description' => 'The type of the scheduling system. Currently, only CWF is supported.', 'type' => 'string', 'example' => 'CWF2', 'title' => ''], + 'BizDate' => ['description' => 'The business date. For an offline table, this is typically the day before the check is performed.', 'type' => 'integer', 'format' => 'int64', 'example' => '1600704000000', 'title' => ''], + 'CheckResult' => ['description' => 'The check result.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'ResultString' => ['description' => 'The string representation of the check result.', 'type' => 'string', 'example' => 'ResultString', 'title' => ''], + 'MatchExpression' => ['description' => 'The partition filter expression.', 'type' => 'string', 'example' => 'ds=$[yyyymmdd]', 'title' => ''], + 'CheckerType' => ['description' => 'The type of the checker.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ProjectName' => ['description' => 'The name of the engine or data source used for the quality check.', 'type' => 'string', 'example' => 'autotest', 'title' => ''], + 'BeginTime' => ['description' => 'The start time of the check.', 'type' => 'integer', 'format' => 'int64', 'example' => '1600704000000', 'title' => ''], + 'DateType' => ['description' => 'The scheduling cycle. For example, `YMD` can represent yearly, monthly, and daily tasks.', 'type' => 'string', 'example' => 'YMD', 'title' => ''], + 'CriticalThreshold' => ['description' => 'The threshold for a critical alert. For a strong rule, exceeding this threshold blocks the downstream scheduling task.', 'type' => 'number', 'format' => 'float', 'example' => '0.6', 'title' => ''], + 'IsPrediction' => ['description' => 'Indicates whether the result is a prediction. Valid values:'."\n" + ."\n" + .'- `true`: The result is a prediction.'."\n" + ."\n" + .'- `false`: The result is not a prediction.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'RuleName' => ['description' => 'The name of the rule.', 'type' => 'string', 'example' => 'The name of the rule.', 'title' => ''], + 'CheckerId' => ['description' => 'The ID of the checker.', 'type' => 'integer', 'format' => 'int32', 'example' => '7', 'title' => ''], + 'DiscreteCheck' => ['description' => 'Indicates whether a discrete value check is used. Valid values:'."\n" + ."\n" + .'- `true`: A discrete value check is used.'."\n" + ."\n" + .'- `false`: A discrete value check is not used.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'EndTime' => ['description' => 'The end time of the check.', 'type' => 'integer', 'format' => 'int64', 'example' => '1600704000000', 'title' => ''], + 'MethodName' => ['description' => 'The method used to collect sample data. Examples: `avg`, `count`, `sum`, `min`, `max`, `count_distinct`, `user_defined`, `table_count`, `table_size`, `table_dt_load_count`, `table_dt_refuseload_count`, `null_value`, `null_value/table_count`, `(table_count-count_distinct)/table_count`, and `table_count-count_distinct`.', 'type' => 'string', 'example' => 'max', 'title' => ''], + 'LowerValue' => ['description' => 'The predicted lower limit, which is automatically generated based on the configured threshold.', 'type' => 'number', 'format' => 'float', 'example' => '2344', 'title' => ''], + 'EntityId' => ['description' => 'The ID of the partition filter expression.', 'type' => 'integer', 'format' => 'int64', 'example' => '14534343', 'title' => ''], + 'WhereCondition' => ['description' => 'The filter condition for the check.', 'type' => 'string', 'example' => 'type!=\'type2\'', 'title' => ''], + 'ExpectValue' => ['description' => 'The expected value.', 'type' => 'number', 'format' => 'float', 'example' => '90', 'title' => ''], + 'TemplateId' => ['description' => 'The ID of the rule template.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'TaskId' => ['description' => 'The ID of the check task.', 'type' => 'string', 'example' => '16008552981681a0d6****', 'title' => ''], + 'Id' => ['description' => 'The primary key ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '2231123', 'title' => ''], + 'ReferenceValue' => [ + 'description' => 'The historical sample values.', + 'type' => 'array', + 'items' => [ + 'description' => 'A historical sample.', + 'type' => 'object', + 'properties' => [ + 'DiscreteProperty' => ['description' => 'The value of the sample column after being grouped by the `GROUP BY` clause. For example, if you group by a gender column, the values of this parameter can be \'male\', \'female\', or \'null\'.', 'type' => 'string', 'example' => 'type1', 'title' => ''], + 'Value' => ['description' => 'The sample value.', 'type' => 'number', 'format' => 'float', 'example' => '20', 'title' => ''], + 'BizDate' => ['description' => 'The business date. For an offline table, this is typically the day before the check is performed.', 'type' => 'string', 'example' => '1600704000000', 'title' => ''], + 'SingleCheckResult' => ['description' => 'The result of a single check.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'Threshold' => ['description' => 'The threshold.', 'type' => 'number', 'format' => 'float', 'example' => '0.2', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'SampleValue' => [ + 'description' => 'The current sample values.', + 'type' => 'array', + 'items' => [ + 'description' => 'A current sample.', + 'type' => 'object', + 'properties' => [ + 'DiscreteProperty' => ['description' => 'The value of the sample column after being grouped by the `GROUP BY` clause. For example, if you group by a gender column, the values of this parameter can be \'male\', \'female\', or \'null\'.', 'type' => 'string', 'example' => 'type2', 'title' => ''], + 'BizDate' => ['description' => 'The business date. For an offline table, this is typically the day before the check is performed.', 'type' => 'string', 'example' => '1600704000000', 'title' => ''], + 'Value' => ['description' => 'The sample value.', 'type' => 'number', 'format' => 'float', 'example' => '23', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Open' => ['description' => 'Indicates whether the rule is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'BADPARAMETERS', - 'errorMessage' => 'Parameters are missing or in the wrong format.', - ], - ], + 'staticInfo' => [ + 'substitutions' => ['dataworks-public::2024-05-18::ListDataQualityScanRuns'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"9990030003\\",\\n \\"ErrorMessage\\": \\"Missing parameter\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"10000111\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 9990030003\\n 缺少参数\\n 200\\n true\\n 10000001\\n","errorExample":""}]', - 'title' => 'DsgStopSensIdentify', - ], - 'QuerySensClassification' => [ - 'summary' => 'Queries data categories.', - 'methods' => [ - 'post', + 'title' => 'ListQualityResultsByRule', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-05-10T06:31:07.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-01-22T02:34:47.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-03-08T07:46:00.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2021-10-22T11:26:06.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"You have no permission.\\",\\n \\"RequestId\\": \\"CBA58543-00D4-41****\\",\\n \\"ErrorCode\\": \\"401\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 200,\\n \\"RuleChecks\\": [\\n {\\n \\"BlockType\\": 1,\\n \\"WarningThreshold\\": 0.1,\\n \\"Property\\": \\"type\\",\\n \\"TableName\\": \\"dual\\",\\n \\"Comment\\": \\"The description of the rule.\\",\\n \\"CheckResultStatus\\": 2,\\n \\"TemplateName\\": \\"Expected value verification\\",\\n \\"CheckerName\\": \\"fulx\\",\\n \\"RuleId\\": 123421,\\n \\"FixedCheck\\": false,\\n \\"Op\\": \\">\\",\\n \\"UpperValue\\": 22200,\\n \\"ActualExpression\\": \\"ds=20200925\\",\\n \\"ExternalId\\": \\"123112232\\",\\n \\"TimeCost\\": \\"10\\",\\n \\"Trend\\": \\"up\\",\\n \\"ExternalType\\": \\"CWF2\\",\\n \\"BizDate\\": 1600704000000,\\n \\"CheckResult\\": 2,\\n \\"ResultString\\": \\"ResultString\\",\\n \\"MatchExpression\\": \\"ds=$[yyyymmdd]\\",\\n \\"CheckerType\\": 0,\\n \\"ProjectName\\": \\"autotest\\",\\n \\"BeginTime\\": 1600704000000,\\n \\"DateType\\": \\"YMD\\",\\n \\"CriticalThreshold\\": 0.6,\\n \\"IsPrediction\\": false,\\n \\"RuleName\\": \\"The name of the rule.\\",\\n \\"CheckerId\\": 7,\\n \\"DiscreteCheck\\": true,\\n \\"EndTime\\": 1600704000000,\\n \\"MethodName\\": \\"max\\",\\n \\"LowerValue\\": 2344,\\n \\"EntityId\\": 14534343,\\n \\"WhereCondition\\": \\"type!=\'type2\'\\",\\n \\"ExpectValue\\": 90,\\n \\"TemplateId\\": 5,\\n \\"TaskId\\": \\"16008552981681a0d6****\\",\\n \\"Id\\": 2231123,\\n \\"ReferenceValue\\": [\\n {\\n \\"DiscreteProperty\\": \\"type1\\",\\n \\"Value\\": 20,\\n \\"BizDate\\": \\"1600704000000\\",\\n \\"SingleCheckResult\\": 2,\\n \\"Threshold\\": 0.2\\n }\\n ],\\n \\"SampleValue\\": [\\n {\\n \\"DiscreteProperty\\": \\"type2\\",\\n \\"BizDate\\": \\"1600704000000\\",\\n \\"Value\\": 23\\n }\\n ],\\n \\"Open\\": true\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListQualityRules' => [ + 'summary' => 'Call ListQualityRules to retrieve quality rules that match a partition expression.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'deprecated' => false, + 'operationType' => 'read', + 'deprecated' => true, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '212270', - 'abilityTreeNodes' => [ - 'FEATUREdideBVSRMP', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '78331', + 'abilityTreeNodes' => ['FEATUREdide3WJOKE'], + ], + 'parameters' => [ + [ + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the engine or data source. You can find this name on the Data Source Configuration page.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'autotest', 'title' => ''], + ], + [ + 'name' => 'EntityId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the partition expression. Call the [GetQualityEntity](~~174003~~) operation to get this ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '12345', 'title' => ''], ], - ], - 'parameters' => [ [ - 'name' => 'TemplateId', + 'name' => 'PageNumber', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the template defined by Data Security Guard. You can call the [QueryDefaultTemplate](~~2743948~~) operation to query the ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'e1970541-6cf5-4d23-b101-d5b66f6e1024', - ], + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ - 'name' => 'TenantId', + 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '10241024', - ], + 'schema' => ['description' => 'The number of entries to return per page. Default: 10. Maximum: 20.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '20', 'minimum' => '1', 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the DataWorks workspace.', 'type' => 'integer', 'format' => 'int64', 'docRequired' => true, 'required' => true, 'example' => '12345', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'OpenApiResultModel', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '9990030003', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Missing parameter', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '38cbdef0-f6cf-49****', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'You have no permission.', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], 'Data' => [ - 'description' => 'The returned data about data categories. The data is in the JSON format.'."\n", - 'type' => 'any', - 'example' => '[{ "nodeName": "teset1", "sensitiveNotNull": true, "nodeId": "1aac2e35-b437-486b-95c7-a5ae48371024", "nodeOldId": "1aac2e35-b437-486b-95c7-a5ae48371024", "parentId": "0" }]', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '10000001', + 'description' => 'The paginated list of quality rules.', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page. A valid value is 1 to 100. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '400', 'title' => ''], + 'Rules' => [ + 'description' => 'The details of the quality rule.', + 'type' => 'array', + 'items' => [ + 'description' => 'The data returned.', + 'type' => 'object', + 'properties' => [ + 'BlockType' => ['description' => 'The strength of the monitoring rule. The strength of a monitoring rule indicates the importance of the rule. Valid values:'."\n" + ."\n" + .'- `1`: The monitoring rule is a strong rule.'."\n" + ."\n" + .'- `0`: The monitoring rule is a weak rule.'."\n" + .' You can specify a monitoring rule as a strong rule based on your business requirements. If a strong rule is triggered, a critical alert is reported and the scheduling of the task is blocked.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'OnDutyAccountName' => ['description' => 'The name of the Alibaba Cloud account that is used to configure the monitoring rule.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'Property' => ['description' => 'The name of the field.', 'type' => 'string', 'example' => 'id', 'title' => ''], + 'WarningThreshold' => ['description' => 'The threshold for a warning alert. The threshold specifies the deviation of a monitoring result from the expected value. You can customize the threshold based on your business requirements.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'TableName' => ['description' => 'The name of the table.', 'type' => 'string', 'example' => 'dual', 'title' => ''], + 'OnDuty' => ['description' => 'The ID of the Alibaba Cloud account that is used to configure the monitoring rule.', 'type' => 'string', 'example' => '1912****', 'title' => ''], + 'Comment' => ['description' => 'The description of the monitoring rule.', 'type' => 'string', 'example' => 'Verify table rules', 'title' => ''], + 'RuleCheckerRelationId' => ['description' => 'The internal association ID for the rule details.', 'type' => 'integer', 'format' => 'int64', 'example' => '132323', 'title' => ''], + 'FixCheck' => ['description' => 'Indicates whether a fixed value is used for the check.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'MethodId' => ['description' => 'The ID of the method used to collect sample data.', 'type' => 'integer', 'format' => 'int32', 'example' => '21', 'title' => ''], + 'TemplateName' => ['description' => 'The name of the monitoring template.', 'type' => 'string', 'example' => 'Number of SQL task table rows, 1, 7, and 30 days wave detection', 'title' => ''], + 'Trend' => ['description' => 'The trend of the monitoring result.', 'type' => 'string', 'example' => 'abs', 'title' => ''], + 'HistoryWarningThreshold' => ['description' => 'The historical threshold for a warning alert.', 'type' => 'string', 'example' => 'history max:40%,history min:10%', 'title' => ''], + 'RuleType' => ['description' => 'The type of the monitoring rule. Valid values:'."\n" + ."\n" + .'- `0`: The monitoring rule is created by the system.'."\n" + ."\n" + .'- `1`: The monitoring rule is created by a user.'."\n" + ."\n" + .'- `2`: The monitoring rule is a workspace-level rule.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'MatchExpression' => ['description' => 'The partition filter expression.', 'type' => 'string', 'example' => 'dt=$[yyyymmdd]', 'title' => ''], + 'ProjectName' => ['description' => 'The name of the compute engine or data source.', 'type' => 'string', 'example' => 'autotest', 'title' => ''], + 'PropertyKey' => ['description' => 'This parameter is not used. You can ignore this parameter.', 'type' => 'string', 'example' => 'table_count', 'title' => ''], + 'CriticalThreshold' => ['description' => 'The threshold for a critical alert. The threshold specifies the deviation of a monitoring result from the expected value. You can customize the threshold based on your business requirements. If a strong rule is used and a critical alert is triggered, the scheduling of the task is blocked.', 'type' => 'string', 'example' => '40', 'title' => ''], + 'HistoryCriticalThreshold' => ['description' => 'The historical threshold for a critical alert.', 'type' => 'string', 'example' => 'history max:80%,history min:50%', 'title' => ''], + 'MethodName' => ['description' => 'The name of the method used to collect sample data, such as `avg`, `count`, `sum`, `min`, `max`, `count_distinct`, `user_defined`, `table_count`, `table_size`, `table_dt_load_count`, `table_dt_refuseload_count`, `null_value`, `null_value/table_count`, `(table_count-count_distinct)/table_count`, or `table_count-count_distinct`.', 'type' => 'string', 'example' => 'count/table_count', 'title' => ''], + 'CheckerId' => ['description' => 'The checker ID.', 'type' => 'integer', 'format' => 'int32', 'example' => '7', 'title' => ''], + 'EntityId' => ['description' => 'The ID of the partition filter expression.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'ExpectValue' => ['description' => 'The expected value.', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'TemplateId' => ['description' => 'The ID of the monitoring template.', 'type' => 'integer', 'format' => 'int32', 'example' => '7', 'title' => ''], + 'Id' => ['description' => 'The ID of the monitoring rule.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'RuleName' => ['description' => 'The name of the monitoring rule.', 'type' => 'string', 'title' => '', 'example' => 'test'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'BADPARAMETERS', - 'errorMessage' => 'Parameters are missing or in the wrong format.', - ], - ], + 'staticInfo' => [ + 'substitutions' => ['dataworks-public::2024-05-18::GetDataQualityScan'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"9990030003\\",\\n \\"ErrorMessage\\": \\"Missing parameter\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": \\"[{ \\\\\\"nodeName\\\\\\": \\\\\\"teset1\\\\\\", \\\\\\"sensitiveNotNull\\\\\\": true, \\\\\\"nodeId\\\\\\": \\\\\\"1aac2e35-b437-486b-95c7-a5ae48371024\\\\\\", \\\\\\"nodeOldId\\\\\\": \\\\\\"1aac2e35-b437-486b-95c7-a5ae48371024\\\\\\", \\\\\\"parentId\\\\\\": \\\\\\"0\\\\\\" }]\\",\\n \\"RequestId\\": \\"10000001\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 9990030003\\n 缺少参数\\n 400\\n [{ \\"nodeName\\": \\"teset1\\", \\"sensitiveNotNull\\": true, \\"nodeId\\": \\"1aac2e35-b437-486b-95c7-a5ae48371024\\", \\"nodeOldId\\": \\"1aac2e35-b437-486b-95c7-a5ae48371024\\", \\"parentId\\": \\"0\\" }]\\n 10000001\\n","errorExample":""}]', - 'title' => 'QuerySensClassification', - ], - 'QuerySensLevel' => [ - 'summary' => 'Queries data sensitivity levels in Data Security Guard.', - 'methods' => [ - 'post', + 'title' => 'ListQualityRules', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-01-22T02:34:47.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-07-11T11:40:27.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-03-08T07:46:00.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2021-10-26T01:39:33.000Z', 'description' => 'Response parameters changed, Error codes changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"38cbdef0-f6cf-49****\\",\\n \\"ErrorMessage\\": \\"You have no permission.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 400,\\n \\"Rules\\": [\\n {\\n \\"BlockType\\": 0,\\n \\"OnDutyAccountName\\": \\"test\\",\\n \\"Property\\": \\"id\\",\\n \\"WarningThreshold\\": \\"10\\",\\n \\"TableName\\": \\"dual\\",\\n \\"OnDuty\\": \\"1912****\\",\\n \\"Comment\\": \\"Verify table rules\\",\\n \\"RuleCheckerRelationId\\": 132323,\\n \\"FixCheck\\": true,\\n \\"MethodId\\": 21,\\n \\"TemplateName\\": \\"Number of SQL task table rows, 1, 7, and 30 days wave detection\\",\\n \\"Trend\\": \\"abs\\",\\n \\"HistoryWarningThreshold\\": \\"history max:40%,history min:10%\\",\\n \\"RuleType\\": 0,\\n \\"MatchExpression\\": \\"dt=$[yyyymmdd]\\",\\n \\"ProjectName\\": \\"autotest\\",\\n \\"PropertyKey\\": \\"table_count\\",\\n \\"CriticalThreshold\\": \\"40\\",\\n \\"HistoryCriticalThreshold\\": \\"history max:80%,history min:50%\\",\\n \\"MethodName\\": \\"count/table_count\\",\\n \\"CheckerId\\": 7,\\n \\"EntityId\\": 1234,\\n \\"ExpectValue\\": \\"1000\\",\\n \\"TemplateId\\": 7,\\n \\"Id\\": 1234,\\n \\"RuleName\\": \\"test\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListRefDISyncTasks' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '212269', - 'abilityTreeNodes' => [ - 'FEATUREdidePQ4SAC', + [ + 'PrivateKey' => [], + ], + [ + 'APP' => [], ], ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'TemplateId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the template defined by Data Security Guard. You can call the [QueryDefaultTemplate](~~2743948~~) operation to query the ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'e1970541-6cf5-4d23-b101-d5b66f6e10af', - ], + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '10000000000', 'minimum' => '1', 'example' => '10000'], ], [ - 'name' => 'tenantId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '10241024', - ], + 'name' => 'DatasourceName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the data source. You can call the [ListDataSources](~~211431~~) operation to query the name of the data source.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mysql_datasource'], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the synchronization task that you want to query. Valid values:'."\n" + ."\n" + .'* DI_OFFLINE: batch synchronization task'."\n" + .'* DI_REALTIME: real-time synchronization task'."\n" + ."\n" + .'You can call the ListRefDISyncTasks operation to query only one type of the task.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DI_OFFLINE'], + ], + [ + 'name' => 'RefType', + 'in' => 'query', + 'schema' => ['description' => 'The condition used to filter synchronization tasks. Valid values:'."\n" + ."\n" + .'* from: queries the synchronization tasks that use the data source as the source.'."\n" + .'* to: queries the synchronization tasks that use the data source as the destination.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'from'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Valid values: 1 to 100.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'minimum' => '1', 'example' => '1', 'default' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '100000', 'minimum' => '1', 'example' => '100', 'default' => '100'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'OpenApiResultModel', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '9990030003', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Missing parameter', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], + 'RequestId' => ['description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", 'type' => 'string', 'example' => '0bc1411515937635973****'], 'Data' => [ - 'description' => 'The returned data about data sensitivity levels. The data is in the JSON array format.'."\n", - 'type' => 'any', - 'example' => '[{"level":1,"isSensitive":false,"levelName":"1level"},{"level":2,"isSensitive":false,"levelName":"2level"}]', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '10000001', + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'DISyncTasks' => [ + 'description' => 'The details of the synchronization tasks. In most cases, a data source is used by multiple synchronization tasks. Therefore, the value of this parameter is an array. The following parameters are the elements in the array. The sample values of these parameters show the details of a synchronization task.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'DiSourceDatasource' => ['description' => 'The source of the synchronization task. If the synchronization task has multiple sources, the return value is a JSON array, such as \\\\"odps_writer\\\\", \\\\"mysql\\\\". If the RefType parameter is set to from, the synchronization tasks that use the specified data source as the source are returned. In this case, the value of this parameter indicates the specified data source.'."\n", 'type' => 'string', 'example' => '[\\"odps_writer\\"]'], + 'TaskType' => ['description' => 'The type of the synchronization task. Valid values:'."\n" + ."\n" + .'* DI_OFFLINE: batch synchronization task'."\n" + .'* DI_REALTIME: real-time synchronization task'."\n", 'type' => 'string', 'example' => 'DI_OFFLINE'], + 'DiDestinationDatasource' => ['description' => 'The destination of the synchronization task. If the synchronization task has multiple destinations, the return value is a JSON array, such as \\\\"odps_writer\\\\", \\\\"mysql\\\\". If the RefType parameter is set to to, the synchronization tasks that use the specified data source as the destination are returned. In this case, the value of this parameter indicates the specified data source.'."\n", 'type' => 'string', 'example' => '[\\"qcc_polardb2\\"]'], + 'NodeName' => ['description' => 'The name of the synchronization task.'."\n", 'type' => 'string', 'example' => 'abcd1234'], + 'NodeId' => ['description' => 'The ID of the synchronization task.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100000'], + ], + ], + ], + ], ], ], + 'description' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'BADPARAMETERS', - 'errorMessage' => 'Parameters are missing or in the wrong format.', - ], + ['errorCode' => 'Invalid.DI.Parameter', 'errorMessage' => 'The parameter is invalid.', 'description' => ''], + ['errorCode' => 'Invalid.DI.Parameter.File.Existed', 'errorMessage' => 'The file name already exists.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'Forbidden.DI.NoPrivilege', 'errorMessage' => 'No access.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.DI.Parameter', 'errorMessage' => 'A DI internal error occurred.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"9990030003\\",\\n \\"ErrorMessage\\": \\"Missing parameter\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"[{\\\\\\"level\\\\\\":1,\\\\\\"isSensitive\\\\\\":false,\\\\\\"levelName\\\\\\":\\\\\\"1level\\\\\\"},{\\\\\\"level\\\\\\":2,\\\\\\"isSensitive\\\\\\":false,\\\\\\"levelName\\\\\\":\\\\\\"2level\\\\\\"}]\\",\\n \\"RequestId\\": \\"10000001\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 9990030003\\n 缺少参数\\n 200\\n [{\\"level\\":1,\\"isSensitive\\":false,\\"levelName\\":\\"1level\\"},{\\"level\\":2,\\"isSensitive\\":false,\\"levelName\\":\\"2level\\"}]\\n 10000001\\n","errorExample":""}]', - 'title' => 'QuerySensLevel', - ], - 'QueryRecognizeRulesType' => [ - 'summary' => 'Queries the built-in sensitive data identification rule that is used to configure a sensitive field.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0bc1411515937635973****\\",\\n \\"Data\\": {\\n \\"DISyncTasks\\": [\\n {\\n \\"DiSourceDatasource\\": \\"[\\\\\\\\\\\\\\"odps_writer\\\\\\\\\\\\\\"]\\",\\n \\"TaskType\\": \\"DI_OFFLINE\\",\\n \\"DiDestinationDatasource\\": \\"[\\\\\\\\\\\\\\"qcc_polardb2\\\\\\\\\\\\\\"]\\",\\n \\"NodeName\\": \\"abcd1234\\",\\n \\"NodeId\\": 100000\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListRefDISyncTasks', + 'summary' => 'Queries synchronization tasks in Data Integration that use a specific data source.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'ListReminds' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '212274', - 'abilityTreeNodes' => [ - 'FEATUREdideDCM5VK', + 'operationType' => 'list', + 'abilityTreeCode' => '78333', + 'abilityTreeNodes' => ['FEATUREdideRJGWWC'], + ], + 'parameters' => [ + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => ['description' => 'The number of the page to return. Valid values: 1 to 30. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['description' => 'The number of entries to return on each page. Default value: 10. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'Founder', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the Alibaba Cloud account that is used to create the custom alert rules.', 'type' => 'string', 'required' => false, 'example' => '9527952795****', 'title' => ''], + ], + [ + 'name' => 'NodeId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the node to which the custom alert rules are applied. You can use the ID to search for the custom alert rules that are applied to the node.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234', 'title' => ''], + ], + [ + 'name' => 'RemindTypes', + 'in' => 'formData', + 'schema' => ['description' => 'The conditions that trigger an alert for the node. Valid values: FINISHED, UNFINISHED, ERROR, CYCLE\\_UNFINISHED, and TIMEOUT. The value FINISHED indicates that the node finishes running. The value UNFINISHED indicates that the node is still running at the specified point in time. The value ERROR indicates that an error occurs when the node is running. The value CYCLE\\_UNFINISHED indicates that the node does not finish running in the specified scheduling cycle. The value TIMEOUT indicates that the node times out. You can specify multiple conditions for a custom alert rule. If you specify multiple condition, separate them with commas (,).', 'type' => 'string', 'required' => false, 'example' => 'FINISHED,ERROR', 'title' => ''], + ], + [ + 'name' => 'AlertTarget', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the Alibaba Cloud account that is used to receive alert notifications.', 'type' => 'string', 'required' => false, 'example' => '9527952795****', 'title' => ''], + ], + [ + 'name' => 'SearchText', + 'in' => 'formData', + 'schema' => ['description' => 'The keyword in a rule name that is used to search for the rule. Fuzzy search is supported.', 'type' => 'string', 'example' => 'Fuzzy search rule name', 'required' => false, 'title' => ''], ], ], - 'parameters' => [], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ - 'title' => 'OpenApiResultModel', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '9990030003', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Missing parameter', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request. You can use the ID to troubleshoot issues.', 'type' => 'string', 'example' => '0000-ABCD-EFG****', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned.', 'type' => 'string', 'example' => 'The specified parameters are invalid.', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned.', 'type' => 'string', 'example' => '1031203110005', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'The returned data about the built-in sensitive data identification rule that is used to configure a sensitive field. The data is in the JSON format.'."\n", - 'type' => 'any', - 'example' => '{ "HttpStatusCode": 200, "Data": [ { "Regular Expression": "1" }, { "Recognize Rule": "2" }, { "Sample Library": "3" }, { "Model": "4" } ], "Success": true }', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '10000001', + 'description' => 'The data returned.', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of custom alert rules returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'Reminds' => [ + 'description' => 'The list of custom alert rules.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Founder' => ['description' => 'The ID of the Alibaba Cloud account used by the rule creator.', 'type' => 'string', 'example' => '952795****', 'title' => ''], + 'RemindId' => ['description' => 'The custom alert rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'AlertUnit' => ['description' => 'The alert recipient. Valid values: OWNER and OTHER. The value OWNER indicates the node owner. The value OTHER indicates a specified user.', 'type' => 'string', 'example' => 'OWNER', 'title' => ''], + 'RemindType' => ['description' => 'The condition that triggers an alert. Valid values: FINISHED, UNFINISHED, ERROR, CYCLE\\_UNFINISHED, and TIMEOUT.', 'type' => 'string', 'example' => 'FINISHED', 'title' => ''], + 'DndEnd' => ['description' => 'The end time of the quiet hours. The time is in the hh:mm format. Valid values of hh: \\[0,23]. Valid values of mm: \\[0,59].', 'type' => 'string', 'example' => '08:00', 'title' => ''], + 'DndStart' => ['description' => 'The start time of the quiet hours. The time is in the hh:mm format. Valid values of hh: \\[0,23]. Valid values of mm: \\[0,59].', 'type' => 'string', 'example' => '00:00', 'title' => ''], + 'RemindUnit' => ['description' => 'The type of the object to which the custom alert rule is applied. Valid values: NODE, BASELINE, PROJECT, and BIZPROCESS. The value NODE indicates a node. The value BASELINE indicates a baseline. The value PROJECT indicates a workspace. The value BIZPROCESS indicates a workflow.', 'type' => 'string', 'example' => 'NODE', 'title' => ''], + 'Useflag' => ['description' => 'Indicates whether the custom alert rule is enabled. Valid values: true and false.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RemindName' => ['description' => 'The name of the custom alert rule.', 'type' => 'string', 'example' => 'Rule name', 'title' => ''], + 'AlertTargets' => [ + 'description' => 'The IDs of the Alibaba Cloud accounts used by alert recipients.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the Alibaba Cloud account used by the alert recipient.', 'type' => 'string', 'example' => '952795****', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'NodeIds' => [ + 'description' => 'The IDs of the nodes to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is NODE.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the node to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is NODE.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'BizProcessIds' => [ + 'description' => 'The IDs of the workflows to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is BIZPROCESS.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the workflow to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is BIZPROCESS.', 'type' => 'integer', 'format' => 'int64', 'example' => '9527', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'ProjectIds' => [ + 'description' => 'The IDs of the workspaces to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is PROJECT.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the workspace to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is PROJECT.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'BaselineIds' => [ + 'description' => 'The IDs of the baselines to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is BASELINE.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the baseline to which the custom alert rule is applied. This parameter is returned if the value of the RemindUnit parameter is BASELINE.', 'type' => 'integer', 'format' => 'int64', 'example' => '9527', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'AlertMethods' => [ + 'description' => 'The notification method. Valid values: MAIL, SMS, and PHONE. The value MAIL indicates that the notification is sent by email. Only DataWorks Professional Edition and more advanced editions support the PHONE notification method.', + 'type' => 'array', + 'items' => ['description' => 'The notification method. Valid values: MAIL, SMS, and PHONE. The value MAIL indicates that the notification is sent by email. Only DataWorks Professional Edition and more advanced editions support the PHONE notification method.', 'type' => 'string', 'example' => 'SMS', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'BADPARAMETERS', - 'errorMessage' => 'Parameters are missing or in the wrong format.', - ], + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'Forbidden.Not.Server', 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.', 'description' => ''], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"9990030002\\",\\n \\"ErrorMessage\\": \\"Missing parameter\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"{ \\\\\\"HttpStatusCode\\\\\\": 200, \\\\\\"Data\\\\\\": [ { \\\\\\"Regular Expression\\\\\\": \\\\\\"1\\\\\\" }, { \\\\\\"Recognize Rule\\\\\\": \\\\\\"2\\\\\\" }, { \\\\\\"Sample Library\\\\\\": \\\\\\"3\\\\\\" }, { \\\\\\"Model\\\\\\": \\\\\\"4\\\\\\" } ], \\\\\\"Success\\\\\\": true }\\",\\n \\"RequestId\\": \\"10000001\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 9990030003\\n 缺少参数\\n 200\\n { \\"HttpStatusCode\\": 200, \\"Data\\": [ { \\"Regular Expression\\": \\"1\\" }, { \\"Recognize Rule\\": \\"2\\" }, { \\"Sample Library\\": \\"3\\" }, { \\"Model\\": \\"4\\" } ], \\"Success\\": true }\\n 10000001\\n","errorExample":""}]', - 'title' => 'QueryRecognizeRulesType', - ], - 'DsgRunSensIdentify' => [ - 'methods' => [ - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Reminds\\": [\\n {\\n \\"Founder\\": \\"952795****\\",\\n \\"RemindId\\": 1234,\\n \\"AlertUnit\\": \\"OWNER\\",\\n \\"RemindType\\": \\"FINISHED\\",\\n \\"DndEnd\\": \\"08:00\\",\\n \\"DndStart\\": \\"00:00\\",\\n \\"RemindUnit\\": \\"NODE\\",\\n \\"Useflag\\": true,\\n \\"RemindName\\": \\"Rule name\\",\\n \\"AlertTargets\\": [\\n \\"952795****\\"\\n ],\\n \\"NodeIds\\": [\\n 1234\\n ],\\n \\"BizProcessIds\\": [\\n 9527\\n ],\\n \\"ProjectIds\\": [\\n 1234\\n ],\\n \\"BaselineIds\\": [\\n 9527\\n ],\\n \\"AlertMethods\\": [\\n \\"SMS\\"\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListReminds', + 'summary' => 'Queries a list of custom alert rules.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-01-10T12:27:18.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '99', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListReminds'], + ], ], + 'ramActions' => [], + 'translator' => 'manual', + ], + 'ListResourceGroups' => [ + 'summary' => 'Queries a list of resource groups of a specific type.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '212734', - 'abilityTreeNodes' => [ - 'FEATUREdide1B7LSC', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'TenantId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '10241024', - ], + 'name' => 'ResourceGroupType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the resource group that you want to query. Valid values:'."\n" + ."\n" + .'* 0: DataWorks'."\n" + .'* 1: scheduling'."\n" + .'* 2: MaxCompute'."\n" + .'* 3: Platform for AI (PAI)'."\n" + .'* 4: Data Integration'."\n" + .'* 7: exclusive resource group for scheduling (An ID is generated for the purchased resource when you purchase an exclusive resource group for scheduling.)'."\n" + .'* 9: DataService Studio'."\n" + .'* Default value: 1'."\n" + ."\n" + .'If the value indicates a compute engine, the resource groups to query are the ones that were created when you purchased the compute engine.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '3', 'title' => ''], ], [ - 'name' => 'EsMetaParams', - 'in' => 'formData', + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => ['description' => 'The keyword that is used for fuzzy match by resource group name and identifier.'."\n", 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''], + ], + [ + 'name' => 'BizExtKey', + 'in' => 'query', + 'schema' => ['description' => 'The category of the resource group. Valid values:'."\n" + ."\n" + .'* default (default): shared resource group'."\n" + .'* single: exclusive resource group'."\n", 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], + ], + [ + 'name' => 'ResourceManagerResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmzbn7pti3zfa', 'title' => ''], + ], + [ + 'name' => 'Tags', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'The parameters that you need to configure to scan specified metadata.'."\n", + 'description' => 'The tags.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'The parameter that you need to configure to scan specified metadata.'."\n", + 'description' => '', 'type' => 'object', 'properties' => [ - 'DbType' => [ - 'description' => 'The type of the data source. Valid values:'."\n" - ."\n" - .'* ODPS.ODPS'."\n" - .'* EMR'."\n" - .'* HOLO.POSTGRES'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ODPS.ODPS', - ], - 'ClusterId' => [ - 'description' => 'The cluster ID. You can obtain the ID based on the data source you use.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '101010', - ], - 'ProjectName' => [ - 'description' => 'The name of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to query the name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1666676756691024', - ], - 'SchemaName' => [ - 'description' => 'The name of the schema.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], - 'TableName' => [ - 'description' => 'The name of the table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'table1', - ], - 'TableNameList' => [ - 'description' => 'The names of the tables.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The name of the table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'table1,table2', - ], - 'required' => false, - ], - 'User' => [ - 'description' => 'The username of the operator. We recommend that you enter the username of your Alibaba Cloud account.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'xxx-uat', - ], - 'InstanceId' => [ - 'description' => 'The instance ID. You can obtain the ID based on the data source you use.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => 'hgprecn-cn-9lb37k181024', - ], + 'Key' => ['description' => 'The tag key.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Env', 'title' => ''], + 'Value' => ['description' => 'The tag value.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Test', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, + 'maxItems' => 20, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'DataWorksResult', - 'description' => 'The returned data.'."\n", + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '9990030003', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Missing parameter', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0bc1411515937635973****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'The ID of the generated sensitive data identification task. The value is of the INT 64 type.'."\n", - 'type' => 'any', - 'example' => '1000001', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '10000001', + 'description' => 'The resource groups.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status of the resource group. Valid values:'."\n" + ."\n" + .'* 0: NORMAL, which indicates that the resource group is running or in service.'."\n" + .'* 1: STOP, which indicates that the resource group has expired and is frozen.'."\n" + .'* 2: DELETED, which indicates that the resource group is released or destroyed.'."\n" + .'* 3: CREATING, which indicates that the resource group is being created or started.'."\n" + .'* 4: CREATE_FAILED, which indicates that the resource group fails to be created or started.'."\n" + .'* 5: UPDATING, which indicates that the resource group is being scaled out or upgraded.'."\n" + .'* 6: UPDATE_FAILED, which indicates that the resource group fails to be scaled out or upgraded.'."\n" + .'* 7: DELETING, which indicates that the resource group is being released or destroyed.'."\n" + .'* 8: DELETE_FAILED, which indicates that the resource group fails to be released or destroyed.'."\n" + .'* 9: TIMEOUT, which indicates that the operation performed on the resource group times out. All operations may time out. This value is temporarily available only for DataService Studio.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'UpdateTime' => ['description' => 'The time when the resource group was last updated.'."\n", 'type' => 'string', 'example' => 'Jul 9, 2018 2:43:37 PM', 'title' => ''], + 'IsDefault' => ['description' => 'Indicates whether the resource group is the default resource group. Valid values:'."\n" + ."\n" + .'* true: The resource group is the default resource group.'."\n" + .'* false: The resource group is not the default resource group.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Cluster' => ['description' => 'The name of the cluster. This parameter is returned only if the type of the resource group is MaxCompute or PAI.'."\n", 'type' => 'string', 'example' => 'AY18G', 'title' => ''], + 'EnableKp' => ['description' => 'Indicates whether the UID of an Alibaba Cloud account is used for access. Valid values:'."\n" + ."\n" + .'* true: The MaxCompute compute engine uses the UID of the Alibaba Cloud account as the display name of the account for access.'."\n" + .'* false: The MaxCompute compute engine uses the name of the Alibaba Cloud account as the display name of the account for access. The remaining values are useless. This parameter is returned only if the type of the resource group is MaxCompute.'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'ResourceGroupType' => ['description' => 'The type of the resource group. Valid values:'."\n" + ."\n" + .'* 0: DataWorks'."\n" + .'* 2: MaxCompute'."\n" + .'* 3: PAI'."\n" + .'* 4: Data Integration'."\n" + .'* 7: scheduling'."\n" + .'* 9: DataService Studio'."\n", 'type' => 'string', 'example' => '3', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the cluster was created. Example: Jul 9, 2018 2:43:37 PM.'."\n", 'type' => 'string', 'example' => 'Jul 9, 2018 2:43:37 PM', 'title' => ''], + 'Identifier' => ['description' => 'The identifier of the resource group.'."\n", 'type' => 'string', 'example' => 'e1815577-2f4e-4c5e-b29****', 'title' => ''], + 'Mode' => ['description' => 'The mode of the resource group. Valid values:'."\n" + ."\n" + .'* ISOLATE: exclusive resource group that adopts the subscription billing method'."\n" + .'* SHARE: shared resource group that adopts the pay-as-you-go billing method'."\n" + .'* DEVELOP: resource group for developers'."\n", 'type' => 'string', 'example' => 'SHARE', 'title' => ''], + 'BizExtKey' => ['description' => 'The category of the resource group. Valid values:'."\n" + ."\n" + .'* default: shared resource group'."\n" + .'* single: exclusive resource group'."\n", 'type' => 'string', 'example' => 'default', 'title' => ''], + 'Sequence' => ['description' => 'The sequence number of the resource group. Created resource groups are sorted in ascending order by sequence number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '300', 'title' => ''], + 'Specs' => ['description' => 'The details of the resource group. The content enclosed in braces {} is the details of the resource group.'."\n", 'type' => 'object', 'example' => '{}', 'title' => ''], + 'Name' => ['description' => 'The name of the resource group.'."\n", 'type' => 'string', 'example' => 'abc', 'title' => ''], + 'Id' => ['description' => 'The resource group ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234567', 'title' => ''], + 'TenantId' => ['description' => 'The tenant ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234567', 'title' => ''], + 'ResourceManagerResourceGroupId' => ['description' => 'The ID of your Alibaba Cloud resource group.'."\n", 'type' => 'string', 'example' => 'rg-acfmzbn7pti3zfa', 'title' => ''], + 'Tags' => [ + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.'."\n", 'type' => 'string', 'example' => 'Env', 'title' => ''], + 'Value' => ['description' => 'The tag value.'."\n", 'type' => 'string', 'example' => 'Test', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'BADPARAMETERS', - 'errorMessage' => 'Parameters are missing or in the wrong format.', - ], + ['errorCode' => 'Invalid.Tenant.ConnectionNotExists', 'errorMessage' => 'The connection does not exist.', 'description' => 'The connection does not exist.'], + ['errorCode' => 'Invalid.Tenant.ProjectNotExists', 'errorMessage' => 'The project does not exist.', 'description' => 'The project does not exist.'], + ['errorCode' => 'Invalid.Tenant.UserNotInProject', 'errorMessage' => 'The user is not in the project.', 'description' => 'The user is not in the project.'], + ], + 403 => [ + ['errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin', 'errorMessage' => 'The user is not a project administrator or owner.', 'description' => 'The user is not a project administrator or owner.'], + ['errorCode' => 'Invalid.Tenant.UserNotInTenant', 'errorMessage' => 'The user is not in tenant.', 'description' => 'The user is not in tenant.'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ErrorCode\\": \\"9990030003\\",\\n \\"ErrorMessage\\": \\"Missing parameter\\",\\n \\"Success\\": true,\\n \\"Data\\": \\"1000001\\",\\n \\"HttpStatusCode\\": 400,\\n \\"RequestId\\": \\"10000001\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 9990030003\\n 缺少参数\\n true\\n 1000001\\n 400\\n 10000001\\n","errorExample":""}]', - 'title' => 'DsgRunSensIdentify', - 'summary' => 'Starts a sensitive data identification task in Data Security Guard.', - ], - 'DeleteRecognizeRule' => [ - 'summary' => 'Deletes sensitive field types.', - 'methods' => [ - 'post', + 'staticInfo' => [], + 'title' => 'ListResourceGroups', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-12-13T01:57:32.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-11-23T03:17:18.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-10-31T02:39:42.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListResourceGroups'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0bc1411515937635973****\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Status\\": 0,\\n \\"UpdateTime\\": \\"Jul 9, 2018 2:43:37 PM\\",\\n \\"IsDefault\\": true,\\n \\"Cluster\\": \\"AY18G\\",\\n \\"EnableKp\\": false,\\n \\"ResourceGroupType\\": \\"3\\",\\n \\"CreateTime\\": \\"Jul 9, 2018 2:43:37 PM\\",\\n \\"Identifier\\": \\"e1815577-2f4e-4c5e-b29****\\",\\n \\"Mode\\": \\"SHARE\\",\\n \\"BizExtKey\\": \\"default\\",\\n \\"Sequence\\": 300,\\n \\"Specs\\": {},\\n \\"Name\\": \\"abc\\",\\n \\"Id\\": 1234567,\\n \\"TenantId\\": 1234567,\\n \\"ResourceManagerResourceGroupId\\": \\"rg-acfmzbn7pti3zfa\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"Env\\",\\n \\"Value\\": \\"Test\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + ], + 'ListShiftPersonnels' => [ + 'summary' => 'Queries a list of on-duty engineers in a shift schedule.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '212271', - 'abilityTreeNodes' => [ - 'FEATUREdideDCM5VK', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '140337', + 'abilityTreeNodes' => ['FEATUREdideRJGWWC'], ], 'parameters' => [ [ - 'name' => 'SensitiveId', + 'name' => 'ShiftScheduleIdentifier', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the sensitive field. You can call the [QuerySensNodeInfo](~~2747189~~) operation to query the ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '27f5f5e2-ec60-4567-b1e4-779ac3681024', - ], + 'schema' => ['description' => 'The unique identifier of the shift schedule.'."\n", 'type' => 'string', 'required' => true, 'example' => '2ab6456ada634b2f938ee******9b45b', 'title' => ''], ], [ - 'name' => 'TenantId', + 'name' => 'UserType', 'in' => 'formData', 'schema' => [ - 'description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n", + 'description' => 'The type of the on-duty engineer that you want to query. Valid values: ALL, PRIMARY, BACKUP, and DESIGNATED_USER.'."\n", + 'enumValueTitles' => [], 'type' => 'string', - 'required' => true, - 'example' => '10241024', + 'default' => 'ALL', + 'enum' => ['ALL', 'PRIMARY', 'BACKUP', 'DESIGNATED_USER'], + 'required' => false, + 'example' => 'ALL', + 'title' => '', ], ], + [ + 'name' => 'ShiftPersonUID', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the Alibaba Cloud account. You can log on to the DataWorks console and move the pointer over the profile picture in the upper-right corner to view the ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '1933790****551', 'title' => ''], + ], + [ + 'name' => 'BeginTime', + 'in' => 'formData', + 'schema' => ['description' => 'The time when the on-duty engineer starts a shift. Set the value to a UNIX timestamp.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1593950832000', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => ['description' => 'The time when the on-duty engineer ends a shift. Set the value to a UNIX timestamp.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1593950832000', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'OpenApiResultModel', - 'description' => 'The returned data.'."\n", + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '9990030003', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Missing parameter', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The returned data about whether the deletion is successful.'."\n", - 'type' => 'any', - 'example' => '{ "HttpStatusCode": 200, "Success": true }', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '10000001', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID. You can use the ID to troubleshoot issues.'."\n", 'type' => 'string', 'example' => '0000-ABCD-EFG'], + 'Paging' => [ + 'description' => 'The pagination information.'."\n", + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => 'The page number. Valid values: 1 to 100. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'ShiftPersons' => [ + 'description' => 'The on-duty engineers in the shift schedule.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The on-duty engineer in the shift schedule.'."\n", + 'type' => 'object', + 'properties' => [ + 'ShiftPersonUID' => ['description' => 'The UID of the on-duty engineer.'."\n", 'type' => 'string', 'example' => '3726346****', 'title' => ''], + 'ShiftPersonName' => ['description' => 'The name of the on-duty engineer.'."\n", 'type' => 'string', 'example' => 'Zhang San', 'title' => ''], + 'BeginTime' => ['description' => 'The time when the on-duty engineer starts the shift.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1593950832000', 'title' => ''], + 'EndTime' => ['description' => 'The time when the on-duty engineer ends the shift.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1593950832000', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'BADPARAMETERS', - 'errorMessage' => 'Parameters are missing or in the wrong format.', - ], - [ - 'errorCode' => 'SENSITIVEDELETEERROR', - 'errorMessage' => 'The sensitive field is not allowed to delete. Check sensitive field status and binding desensitization rule.', - ], + 'title' => 'ListShiftPersonnels', + 'changeSet' => [ + ['createdAt' => '2022-11-02T09:31:39.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-06-07T11:25:51.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-06-07T11:06:42.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-06-07T09:12:27.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '99', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListShiftPersonnels'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"9990030003\\",\\n \\"ErrorMessage\\": \\"Missing parameter\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"{ \\\\\\"HttpStatusCode\\\\\\": 200, \\\\\\"Success\\\\\\": true }\\",\\n \\"RequestId\\": \\"10000001\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 9990030003\\n 缺少参数\\n 200\\n { \\"HttpStatusCode\\": 200, \\"Success\\": true }\\n 10000001\\n","errorExample":""}]', - 'title' => 'DeleteRecognizeRule', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG\\",\\n \\"Paging\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"ShiftPersons\\": [\\n {\\n \\"ShiftPersonUID\\": \\"3726346****\\",\\n \\"ShiftPersonName\\": \\"Zhang San\\",\\n \\"BeginTime\\": 1593950832000,\\n \\"EndTime\\": 1593950832000\\n }\\n ]\\n }\\n}","type":"json"}]', ], - 'QuerySensNodeInfo' => [ - 'summary' => 'Queries sensitive data identification rules.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListShiftSchedules' => [ + 'summary' => 'Queries a list of shift schedules in Operation Center.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', - 'abilityTreeCode' => '217792', - 'abilityTreeNodes' => [ - 'FEATUREdideDCM5VK', - ], - ], - 'parameters' => [ - [ - 'name' => 'TemplateId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the data category and data sensitivity level template. You can call the [QueryDefaultTemplate](~~2743948~~) operation to query the ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'e1970541-6cf5-4d23-b101-d5b66f6e1024', - ], - ], - [ - 'name' => 'TenantId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '10241024', - ], - ], - [ - 'name' => 'NodeId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the data category. You can call the [QuerySensClassification](~~2746850~~) operation or log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Data Security Guard page to obtain the ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0ce67949-0810-400f-a24a-cc5ffafe1024', - ], - ], + 'abilityTreeCode' => '140315', + 'abilityTreeNodes' => ['FEATUREdideRJGWWC'], + ], + 'parameters' => [ [ - 'name' => 'SensitiveName', + 'name' => 'ShiftScheduleName', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the sensitive field. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Data Security Guard page to obtain the name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ID card', - ], + 'schema' => ['description' => 'The keyword used to perform a fuzzy search on shift schedules.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Duty table name keyword', 'title' => ''], ], [ - 'name' => 'PageNo', + 'name' => 'Owner', 'in' => 'formData', - 'schema' => [ - 'description' => 'The page number. Pages start from page 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The Alibaba Cloud account ID. You can log on to the DataWorks console and move the pointer over the profile picture in the upper-right corner to view the ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '1933790683*****', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of entries per page. Valid values: 10 to 1000. The recommended number of entries per page ranges from 10 to 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '10', 'default' => '10', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'status', + 'name' => 'PageNumber', 'in' => 'formData', - 'schema' => [ - 'description' => 'The status of the sensitive field. Valid values:'."\n" - ."\n" - .'* 0: draft'."\n" - .'* 1: published'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => 'The page number. Minimum value:1. Maximum value: 100. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'OpenApiResultModel', + 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '9990030003', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Missing parameter', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The returned business data in the JSON format.'."\n", - 'type' => 'any', - 'example' => '{"success": true, "httpStatusCode": 200, "data": { "result": [ { "sensitiveName": "certificate expiration date", "sensitiveId": "fd4ff5a2-9537-43d1-8e4f-1d0b5ffaac12", "status": 0, "templateName": "built-in classification and grading template", "keyRuleId": "228248921215042 certificate expiration date"} ], "totalCount": 1, "currentPage": 1, "pageSize": 10 }, "requestId": 10000001}', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '10000001', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'E6F0DBDD-5AD****'], + 'Paging' => [ + 'description' => 'The pagination information.'."\n", + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => 'The page number. Minimum value: 1. Maximum value: 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'ShiftSchedules' => [ + 'description' => 'The shift schedules.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The shift schedule.'."\n", + 'type' => 'object', + 'properties' => [ + 'ShiftScheduleIdentifier' => ['description' => 'The unique identifier of the shift schedule. You can use the identifier to query the on-duty engineers in the shift schedule.'."\n", 'type' => 'string', 'example' => '2ab6456ada634b2f938ee******9b45b', 'title' => ''], + 'ShiftScheduleName' => ['description' => 'The name of the shift schedule.'."\n", 'type' => 'string', 'example' => 'Duty table name', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'BADPARAMETERS', - 'errorMessage' => 'Parameters are missing or in the wrong format.', - ], + 'title' => 'ListShiftSchedules', + 'changeSet' => [ + ['createdAt' => '2022-06-07T11:06:42.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-06-07T09:12:27.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListShiftSchedules'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"9990030003\\",\\n \\"ErrorMessage\\": \\"Missing parameter\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"{\\\\\\"success\\\\\\": true, \\\\\\"httpStatusCode\\\\\\": 200, \\\\\\"data\\\\\\": { \\\\\\"result\\\\\\": [ { \\\\\\"sensitiveName\\\\\\": \\\\\\"certificate expiration date\\\\\\", \\\\\\"sensitiveId\\\\\\": \\\\\\"fd4ff5a2-9537-43d1-8e4f-1d0b5ffaac12\\\\\\", \\\\\\"status\\\\\\": 0, \\\\\\"templateName\\\\\\": \\\\\\"built-in classification and grading template\\\\\\", \\\\\\"keyRuleId\\\\\\": \\\\\\"228248921215042 certificate expiration date\\\\\\"} ], \\\\\\"totalCount\\\\\\": 1, \\\\\\"currentPage\\\\\\": 1, \\\\\\"pageSize\\\\\\": 10 }, \\\\\\"requestId\\\\\\": 10000001}\\",\\n \\"RequestId\\": \\"10000001\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 9990030003\\n 缺少参数\\n 200\\n { \\"success\\": true, \\"httpStatusCode\\": 200, \\"data\\": { \\"result\\": [ { \\"sensitiveName\\": \\"证件到期日期\\", \\"sensitiveId\\": \\"fd4ff5a2-9537-43d1-8e4f-1d0b5ffaac12\\", \\"status\\": 0, \\"templateName\\": \\"内置分类分级模板\\", \\"keyRuleId\\": \\"228248921215042证件到期日期\\" } ], \\"totalCount\\": 1, \\"currentPage\\": 1, \\"pageSize\\": 10 }, \\"requestId\\": 10000001 }\\n 10000001\\n","errorExample":""}]', - 'title' => 'QuerySensNodeInfo', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"Paging\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"ShiftSchedules\\": [\\n {\\n \\"ShiftScheduleIdentifier\\": \\"2ab6456ada634b2f938ee******9b45b\\",\\n \\"ShiftScheduleName\\": \\"Duty table name\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], - 'AddRecognizeRule' => [ - 'summary' => 'Adds a sensitive field that is defined based on the category and sensitivity level of data in Data Security Guard.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListSuccessInstanceAmount' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '212268', - 'abilityTreeNodes' => [ - 'FEATUREdideBVSRMP', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '78335', + 'abilityTreeNodes' => ['FEATUREdideXLVI81'], ], 'parameters' => [ [ - 'name' => 'TenantId', + 'name' => 'ProjectId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '10241024', - ], + 'schema' => ['description' => 'The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to obtain the workspace ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '99999999999', 'minimum' => '2', 'example' => '9527'], ], - [ - 'name' => 'AccountName', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The Alibaba Cloud account that is used to create a sensitive data identification rule. Enter the username of the Alibaba Cloud account.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'dsg-uat', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '952795279527ab****'], + 'InstanceStatusTrend' => [ + 'description' => 'Indicates the trend of the number of auto triggered node instances that are successfully run every hour on the hour of the current day.'."\n", + 'type' => 'object', + 'properties' => [ + 'TodayTrend' => [ + 'description' => 'The trend of the number of auto triggered node instances that are successfully run on the current day.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TimePoint' => ['description' => 'The point in time. The value is an exact hour that ranges from 00:00 to 23:00, such as 00:00, 01:00, or 02:00.'."\n", 'type' => 'string', 'example' => '01:00'], + 'Count' => ['description' => 'The number of instances that are successfully run.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + ], + ], + ], + 'YesterdayTrend' => [ + 'description' => 'The trend of the number of auto triggered node instances that are successfully run one day earlier than the current day.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TimePoint' => ['description' => 'The point in time. The value is an exact hour that ranges from 00:00 to 23:00, such as 00:00, 01:00, or 02:00.'."\n", 'type' => 'string', 'example' => '01:00'], + 'Count' => ['description' => 'The number of instances that are successfully run.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + ], + ], + ], + 'AvgTrend' => [ + 'description' => 'The average trend.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TimePoint' => ['description' => 'The point in time. The value is an exact hour that ranges from 00:00 to 23:00, such as 00:00, 01:00, or 02:00.'."\n", 'type' => 'string', 'example' => '01:00'], + 'Count' => ['description' => 'The number of instances that are successfully run.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10'], + ], + ], + ], + ], + ], + ], ], ], - [ - 'name' => 'SensitiveName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the custom sensitive field. Enter a string that is less than 128 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'name', - ], + ], + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'ResourceNotAuthorized.Api', 'errorMessage' => 'You are not authorized to access the resources.', 'description' => ''], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], ], - [ - 'name' => 'TemplateId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The template ID. You can call the [QueryDefaultTemplate](~~2743948~~) operation to obtain the template ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'e1970541-6cf5-4d23-b101-d5b66f6e1024', - ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Resource', 'errorMessage' => 'You have reached the limit for the resource. Please contact us by submitting a ticket.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], - [ - 'name' => 'NodeId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the data category. You can call the [QuerySensClassification](~~2746850~~) operation to query the ID of all data categories. Then, you can select a data category to create a sensitive field. Enter the ID of the selected data category.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '0ce67949-0810-400f-a24a-cc5ffafe1024', - ], + 500 => [ + ['errorCode' => 'Forbidden.Not.Server', 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.', 'description' => ''], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'Forbidden.Wkbench.ProjectNoPermission', 'errorMessage' => 'You are not authorized to access the workspace.', 'description' => ''], ], - [ - 'name' => 'NodeParent', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The information about the parent data category of the current data category. You can call the [QuerySensClassification](~~2746850~~) operation to obtain the ID of a data category.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Customer/personal/personal_Natural _Information/personal basic_profile_information', - ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"952795279527ab****\\",\\n \\"InstanceStatusTrend\\": {\\n \\"TodayTrend\\": [\\n {\\n \\"TimePoint\\": \\"01:00\\",\\n \\"Count\\": 10\\n }\\n ],\\n \\"YesterdayTrend\\": [\\n {\\n \\"TimePoint\\": \\"01:00\\",\\n \\"Count\\": 10\\n }\\n ],\\n \\"AvgTrend\\": [\\n {\\n \\"TimePoint\\": \\"01:00\\",\\n \\"Count\\": 10\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 952795279527ab****\\n \\n \\n 01:00\\n 10\\n \\n \\n 01:00\\n 10\\n \\n \\n 01:00\\n 10\\n \\n \\n","errorExample":""}]', + 'title' => 'ListSuccessInstanceAmount', + 'summary' => 'Queries the trend of the number of auto triggered node instances that are successfully run every hour on the hour of the current day.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '99', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSuccessInstanceAmount'], ], + ], + 'ramActions' => [], + ], + 'ListTableLevel' => [ + 'summary' => 'Lists hierarchy levels. This operation will be replaced soon. We recommend that you do not call this operation.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Level', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The sensitivity level of the sensitive field. You can select one from all sensitivity levels that are defined in a template as the sensitivity level of the sensitive field, such as level 1 to level 10.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '78336', + 'abilityTreeNodes' => ['FEATUREdideRZEBFC'], + ], + 'parameters' => [ [ - 'name' => 'LevelName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the sensitivity level. You can call the [QueryDefaultTemplate](~~2743948~~) operation to obtain the name of the sensitivity level in the related template.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Confidential', - ], + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the DataWorks workspace. You can log on to the DataWorks console to obtain the workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '123', 'title' => ''], ], [ - 'name' => 'SensitiveDescription', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The description of the sensitive field. Enter a string that is less than 128 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'This is a sensitive field that identifies the name.', - ], + 'name' => 'LevelType', + 'in' => 'query', + 'schema' => ['description' => 'The table level type. Valid values: 1 and 2. The value 1 indicates the logical level. The value 2 indicates the physical level.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '10', 'minimum' => '0', 'example' => '1', 'title' => ''], ], [ - 'name' => 'OperationType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The type of the arithmetic operation. Valid values:'."\n" - ."\n" - .'* 0: OR'."\n" - .'* 1: AND'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'RecognizeRulesType', - 'in' => 'formData', + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The type of the sensitive data identification rule. Valid values:'."\n" - ."\n" - .'* 1: regular expression'."\n" - .'* 2: built-in rule'."\n" - .'* 3: sample library'."\n" - .'* 4: self-generated data identification model'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified parameters are invalid.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'abc', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '1031203110005 ', 'title' => ''], + 'TableLevelInfo' => [ + 'description' => 'The information about the table levels.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['description' => 'The total number of table levels returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'LevelList' => [ + 'description' => 'The list of table levels.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'LevelType' => ['description' => 'The table level type. Valid values: 1 and 2. The value 1 indicates the logical level. The value 2 indicates the physical level.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Description' => ['description' => 'The description of the table level.', 'type' => 'string', 'example' => 'Level description', 'title' => ''], + 'Name' => ['description' => 'The name of the table level.', 'type' => 'string', 'example' => 'Level 1', 'title' => ''], + 'ProjectId' => ['description' => 'The ID of the DataWorks workspace.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'LevelId' => ['description' => 'The table level ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'RecognizeRules', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The content of the sensitive data identification rule. You can call the [QuerySensNodeInfo](~~2747189~~) operation to query the value of the current parameter for a built-in sensitive field.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"contentRule":{"_clazz":"com.alipay.dsgclient.sdk.dsg.fastscan.engine.cond.GenderCond"},"_clazz":"com.alipay.dsg.dal.model.RuleContent"}', - ], + ], + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], ], - [ - 'name' => 'ContentScan', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Identifies content. You can call the [QuerySensNodeInfo](~~2747189~~) operation to query the value of the current parameter for a built-in sensitive field.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"_clazz":"com.alipay.dsgclient.sdk.dsg.fastscan.engine.cond.NationalityCond"}', - ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"RequestId\\": \\"abc\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1031203110005\\\\t\\",\\n \\"TableLevelInfo\\": {\\n \\"TotalCount\\": 10,\\n \\"LevelList\\": [\\n {\\n \\"LevelType\\": 1,\\n \\"Description\\": \\"Level description\\",\\n \\"Name\\": \\"Level 1\\",\\n \\"ProjectId\\": 123,\\n \\"LevelId\\": 123\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListTableLevel', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'translator' => 'manual', + ], + 'ListTableTheme' => [ + 'summary' => 'Lists table themes. This operation will be replaced soon. We recommend that you do not call this operation.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'HitThreshold', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The hit ratio threshold. If more than 60%, which is a sample hit ratio threshold, of all sample data records hit the Name Entity Recognition (NER) model, the sensitive field is hit. The value can be an integer from 0 to 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '50', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '78337', + 'abilityTreeNodes' => ['FEATUREdideRZEBFC'], + ], + 'parameters' => [ [ - 'name' => 'ColScan', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Scans fields. The system identifies only fields that are assigned with values.'."\n" - ."\n" - .'* The value must be in the ${Project name}.${Table name}.${Field name} or ${Project name}.${Schema name}.${Table name}.${Field name} format.'."\n" - .'* *Wildcards are supported. For example, the asterisk (\\*) in default.table.column1\\* can be used to match any content following default.table.column1, such as default.table.column10.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'default.qujian.*', - ], + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The DataWorks workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '123', 'title' => ''], ], [ - 'name' => 'ColExclude', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Excludes fields. The system does not identify fields that are assigned with values.'."\n" - ."\n" - .'* The value must be in the ${Project name}.${Table name}.${Field name} or ${Project name}.${Schema name}.${Table name}.${Field name} format.'."\n" - .'* *Wildcards are supported. For example, the asterisk (\\*) in default.table.column1\\* can be used to match any content following default.table.column1, such as default.table.column10.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'default.qujian.*6', - ], + 'name' => 'ParentId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the parent table theme.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '121', 'title' => ''], ], [ - 'name' => 'CommentScan', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Scans content. The value is the text of each field comment in your data asset. Fuzzy match is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ - 'name' => 'Status', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The status of the sensitive field. Valid values:'."\n" - ."\n" - .'* 0: draft'."\n" - .'* 1: effective'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'OpenApiResultModel', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '9990030003', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Missing parameter', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified parameters are invalid.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'abcde', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '1031203110005', 'title' => ''], 'Data' => [ - 'description' => 'The returned result in the JSON format.'."\n", - 'type' => 'any', - 'example' => '{ "HttpStatusCode": 200, "Success": true }', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '10000001', + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'ThemeList' => [ + 'description' => 'The list of table levels.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CreateTimeStamp' => ['description' => 'The time when the table level was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '123432343243', 'title' => ''], + 'ParentId' => ['description' => 'The ancestor node ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '122', 'title' => ''], + 'ThemeId' => ['description' => 'The table theme ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'ProjectId' => ['description' => 'The DataWorks workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'Name' => ['description' => 'The name of the table level.', 'type' => 'string', 'example' => 'Level name', 'title' => ''], + 'Level' => ['description' => 'The level of the table folder. Valid values: 1 and 2. The value 1 indicates the first level. The value 2 indicates the second level.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Creator' => ['description' => 'The creator of the table level.', 'type' => 'string', 'example' => '123455', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'BADPARAMETERS', - 'errorMessage' => 'Parameters are missing or in the wrong format.', - ], + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"9990030003\\",\\n \\"ErrorMessage\\": \\"Missing parameter\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"{ \\\\\\"HttpStatusCode\\\\\\": 200, \\\\\\"Success\\\\\\": true }\\",\\n \\"RequestId\\": \\"10000001\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 9990030003\\n 缺少参数\\n 200\\n { \\"HttpStatusCode\\": 200, \\"Success\\": true }\\n 10000001\\n","errorExample":""}]', - 'title' => 'AddRecognizeRule', - ], - 'EditRecognizeRule' => [ - 'summary' => 'Edits a sensitive field that is defined based on the category and sensitivity level of data in Data Security Guard.', - 'methods' => [ - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"RequestId\\": \\"abcde\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 10,\\n \\"ThemeList\\": [\\n {\\n \\"CreateTimeStamp\\": 123432343243,\\n \\"ParentId\\": 122,\\n \\"ThemeId\\": 123,\\n \\"ProjectId\\": 123,\\n \\"Name\\": \\"Level name\\",\\n \\"Level\\": 1,\\n \\"Creator\\": \\"123455\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListTableTheme', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'ListTables' => [ + 'summary' => 'Obtains tables of different data source types within a tenant by page.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '212267', - 'abilityTreeNodes' => [ - 'FEATUREdideDCM5VK', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '234146', + 'abilityTreeNodes' => ['FEATUREdideE9XYA6'], ], 'parameters' => [ [ - 'name' => 'TenantId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '10241024', - ], + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries displayed on each page. The default value is 10 and the maximum value is 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'AccountName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The Alibaba Cloud account that is used to create the sensitive data identification rule. Enter the username of the Alibaba Cloud account.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'dsg-uat', - ], + 'name' => 'DataSourceType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the data source. Valid values: ODPS, emr, mysql, holo, analyticdb_for_mysql, oracle, postgresql, sqlserver, clickhouse, and starrocks.', 'type' => 'string', 'required' => true, 'example' => 'odps', 'title' => ''], ], [ - 'name' => 'SensitiveId', - 'in' => 'formData', + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'Pagination information, which specifies the starting point of this read.', 'type' => 'string', 'required' => false, 'example' => '12222', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The sensitive field ID. You can call the [QuerySensNodeInfo](~~2747189~~) operation to query the IDs of all sensitive fields. You can also call the [QueryRecognizeRuleDetail](~~2766023~~) operation to query the IDs of specific sensitive fields.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1a928de7-3962-4e07-93ac-e1973baa1024', + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'E25887B7-579C-54A5-9C4F-83A****'], + 'Data' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Total' => ['description' => 'The total number.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'TableEntityList' => [ + 'description' => 'An array of entities.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the table.'."\n", + 'type' => 'object', + 'properties' => [ + 'EntityQualifiedName' => ['description' => 'The unique identifier of the table entity.', 'type' => 'string', 'example' => 'maxcompute-table.project.table', 'title' => ''], + 'EntityContent' => [ + 'description' => 'The information about the table.'."\n", + 'type' => 'object', + 'properties' => [ + 'TableName' => ['description' => 'The name of the table.', 'type' => 'string', 'example' => 'table', 'title' => ''], + 'DataSourceQualifiedName' => ['description' => 'The unique identifier of the data source.', 'type' => 'string', 'example' => 'accountId:cn-shanghai:odps:project', 'title' => ''], + 'DataSourceUniqueId' => ['description' => 'The unique ID of the data source identifier.', 'type' => 'string', 'example' => 'e70f92239d491057f6a2563b545bdaf8cc6b537d9dc55ec84c55f7cfefg', 'title' => ''], + 'DatabaseName' => ['description' => 'The name of the database.', 'type' => 'string', 'example' => 'database', 'title' => ''], + 'ProjectName' => ['description' => 'The name of the ODPS project.', 'type' => 'string', 'example' => 'project', 'title' => ''], + 'InstanceId' => ['description' => 'The ID of the data source instance.', 'type' => 'string', 'example' => 'rm-uf6rn0123', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'NextToken' => ['description' => 'Pagination information, which specifies the starting point of the next read.', 'type' => 'string', 'example' => 'AAAAAVY3rYiv9VoUJQSiCitgjgSwg+byk0FIjirFkm4zfM4G0xYwM/FQvOhgrTHsCPIZ5yqXYu2NG6qRCRC52HvwbOA=', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListTables', + 'changeSet' => [ + ['createdAt' => '2024-09-03T03:01:14.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E25887B7-579C-54A5-9C4F-83A****\\",\\n \\"Data\\": {\\n \\"Total\\": 100,\\n \\"TableEntityList\\": [\\n {\\n \\"EntityQualifiedName\\": \\"maxcompute-table.project.table\\",\\n \\"EntityContent\\": {\\n \\"TableName\\": \\"table\\",\\n \\"DataSourceQualifiedName\\": \\"accountId:cn-shanghai:odps:project\\",\\n \\"DataSourceUniqueId\\": \\"e70f92239d491057f6a2563b545bdaf8cc6b537d9dc55ec84c55f7cfefg\\",\\n \\"DatabaseName\\": \\"database\\",\\n \\"ProjectName\\": \\"project\\",\\n \\"InstanceId\\": \\"rm-uf6rn0123\\"\\n }\\n }\\n ],\\n \\"NextToken\\": \\"AAAAAVY3rYiv9VoUJQSiCitgjgSwg+byk0FIjirFkm4zfM4G0xYwM/FQvOhgrTHsCPIZ5yqXYu2NG6qRCRC52HvwbOA=\\"\\n }\\n}","type":"json"}]', + ], + 'ListTopics' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'SensitiveName', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '78338', + 'abilityTreeNodes' => ['FEATUREdideSFSFU4'], + ], + 'parameters' => [ + [ + 'name' => 'BeginTime', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the custom sensitive field. Enter a string that is less than 128 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'name'."\n", - ], + 'schema' => ['description' => 'The beginning of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-dd\'T\'HH:mm:ssZ format. The time must be in UTC.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2019-03-24T00:00:00+0800', 'title' => ''], ], [ - 'name' => 'NodeId', + 'name' => 'EndTime', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the data category. You can call the [QuerySensClassification](~~2746850~~) operation to query the ID of all data categories. Then, you can select a data category to create a sensitive field. Enter the ID of the selected data category.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '0ce67949-0810-400f-a24a-cc5ffafe1024', - ], + 'schema' => ['description' => 'The end of the time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-dd\'T\'HH:mm:ssZ format. The time must be in UTC.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2019-03-25T23:00:00+0800', 'title' => ''], ], [ - 'name' => 'NodeParent', + 'name' => 'TopicTypes', 'in' => 'formData', - 'schema' => [ - 'description' => 'The information about the parent data category of the current data category. You can call the [QuerySensClassification](~~2746850~~) operation to obtain the ID of a data category.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Customer/personal/personal_Natural_Information/personal_basic_profile_information', - ], + 'schema' => ['description' => 'The types of the events. Valid values: SLOW and ERROR. The value SLOW indicates that the running duration of the node in the current scheduling cycle is significantly longer than the average running duration of the node in previous scheduling cycles. The value ERROR indicates that the node fails to run. You can specify multiple types. Separate them with commas (,).', 'type' => 'string', 'required' => false, 'example' => 'ERROR,SLOW', 'title' => ''], ], [ - 'name' => 'TemplateId', + 'name' => 'TopicStatuses', 'in' => 'formData', - 'schema' => [ - 'description' => 'The template ID. You can call the [QueryDefaultTemplate](~~2743948~~) operation to obtain the template ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'e1970541-6cf5-4d23-b101-d5b66f6e1024', - ], + 'schema' => ['description' => 'The status of the events. Valid values: IGNORE, NEW, FIXING, and RECOVER. The value IGNORE indicates that the events are ignored. The value NEW indicates that the events are new events. The value FIXING indicates that the events are being processed. The value RECOVER indicates that the events are processed. You can specify multiple states. Separate them with commas (,).', 'type' => 'string', 'required' => false, 'example' => 'IGNORE,NEW,FIXING,RECOVER', 'title' => ''], ], [ - 'name' => 'level', + 'name' => 'NodeId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The sensitivity level of the sensitive field. You can select one from all sensitivity levels that are defined in a template as the sensitivity level of the sensitive field, such as level 1 to level 10.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The ID of the node that triggers the events. You can configure either this parameter or the InstanceId parameter.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234', 'title' => ''], ], [ - 'name' => 'LevelName', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the sensitivity level. You can call the [QueryDefaultTemplate](~~2743948~~) operation to obtain the name of the sensitivity level in the related template.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Confidential', - ], + 'schema' => ['description' => 'The ID of the node instance that triggers the events. You can configure either this parameter or the NodeId parameter.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12345', 'title' => ''], ], [ - 'name' => 'SensitiveDescription', + 'name' => 'Owner', 'in' => 'formData', - 'schema' => [ - 'description' => 'The description of the sensitive field. Enter a string that is less than 128 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'This is a sensitive field that identifies the name.', - ], + 'schema' => ['description' => 'The ID of the Alibaba Cloud account used by the owner of the events.', 'type' => 'string', 'required' => false, 'example' => '952795****', 'title' => ''], ], [ - 'name' => 'Status', + 'name' => 'PageNumber', 'in' => 'formData', - 'schema' => [ - 'description' => 'The status of the sensitive field. Valid values:'."\n" - ."\n" - .'* 0: draft'."\n" - .'* 1: effective'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => 'The number of the page to return. Valid values: 1 to 30. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '30', 'minimum' => '1', 'default' => '', 'example' => '1', 'title' => ''], ], [ - 'name' => 'OperationType', + 'name' => 'PageSize', 'in' => 'formData', + 'schema' => ['description' => 'The number of entries to return on each page. Default value: 10. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '1', 'default' => '', 'example' => '10', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], 'schema' => [ - 'description' => 'The type of the arithmetic operation. Valid values:'."\n" - ."\n" - .'* 0: OR'."\n" - .'* 1: AND'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request. You can use the ID to troubleshoot issues.', 'type' => 'string', 'example' => '0000-ABCD-EFG****', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned.', 'type' => 'string', 'example' => 'The specified parameters are invalid.', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned.', 'type' => 'string', 'example' => '1031203110005', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The information about the events returned.', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of the events returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'Topics' => [ + 'description' => 'The events returned.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TopicName' => ['description' => 'The name of the event.', 'type' => 'string', 'example' => 'Error 1234', 'title' => ''], + 'ProjectId' => ['description' => 'The ID of the workspace to which the node belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'NodeOwner' => ['description' => 'The ID of the Alibaba Cloud account that is used by the node owner.', 'type' => 'string', 'example' => '952795****', 'title' => ''], + 'InstanceId' => ['description' => 'The ID of the node instance that triggers the event.', 'type' => 'integer', 'format' => 'int64', 'example' => '12345', 'title' => ''], + 'FixTime' => ['description' => 'The timestamp when the event was processed.', 'type' => 'integer', 'format' => 'int64', 'example' => '1553508465000', 'title' => ''], + 'TopicType' => ['description' => 'The type of the event. Valid values: SLOW and ERROR. The value SLOW indicates that the running duration of the node in the current scheduling cycle is significantly longer than the average running duration of the node in previous scheduling cycles. The value ERROR indicates that the node fails to run.', 'type' => 'string', 'example' => 'ERROR', 'title' => ''], + 'TopicStatus' => ['description' => 'The status of the event. Valid values: IGNORE, NEW, FIXING, and RECOVER. The value IGNORE indicates that the event is ignored. The value NEW indicates that the event is a new event. The value FIXING indicates that the event is being processed. The value RECOVER indicates that the event is processed.', 'type' => 'string', 'example' => 'NEW', 'title' => ''], + 'HappenTime' => ['description' => 'The timestamp when the event occurred. A time difference may exist between the time when the event occurred and the time when the event was found.', 'type' => 'integer', 'format' => 'int64', 'example' => '1553508465000', 'title' => ''], + 'NodeName' => ['description' => 'The name of the node.', 'type' => 'string', 'example' => 'Node name', 'title' => ''], + 'TopicId' => ['description' => 'The ID of the event.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'AddTime' => ['description' => 'The timestamp when the event was found.', 'type' => 'integer', 'format' => 'int64', 'example' => '1553524393000', 'title' => ''], + 'NodeId' => ['description' => 'The ID of the node that triggers the event.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'Forbidden.Not.Server', 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.', 'description' => ''], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Topics\\": [\\n {\\n \\"TopicName\\": \\"Error 1234\\",\\n \\"ProjectId\\": 1234,\\n \\"NodeOwner\\": \\"952795****\\",\\n \\"InstanceId\\": 12345,\\n \\"FixTime\\": 1553508465000,\\n \\"TopicType\\": \\"ERROR\\",\\n \\"TopicStatus\\": \\"NEW\\",\\n \\"HappenTime\\": 1553508465000,\\n \\"NodeName\\": \\"Node name\\",\\n \\"TopicId\\": 1234,\\n \\"AddTime\\": 1553524393000,\\n \\"NodeId\\": 1234\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListTopics', + 'summary' => 'Queries events.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-01-10T12:27:18.000Z', 'description' => 'Error codes changed, Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '99', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTopics'], + ], + ], + 'ramActions' => [], + 'translator' => 'manual', + ], + 'OfflineNode' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'RecognizeRulesType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The type of the sensitive data identification rule. Valid values:'."\n" - ."\n" - .'* 1: regular expression'."\n" - .'* 2: built-in rule'."\n" - .'* 3: sample library'."\n" - .'* 4: self-generated data identification model'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'RecognizeRules', + 'name' => 'NodeId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The content of the sensitive data identification rule. You can call the [QuerySensNodeInfo](~~2747189~~) operation to query the value of the current parameter for a built-in sensitive field.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"contentRule":{"_clazz":"com.alipay.dsgclient.sdk.dsg.fastscan.engine.cond.GenderCond"},"_clazz":"com.alipay.dsg.dal.model.RuleContent"}', - ], + 'schema' => ['description' => 'The node ID. You can call the [ListNodes](~~173979~~) operation to obtain the node ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '2', 'example' => '1234'], ], [ - 'name' => 'ContentScan', + 'name' => 'ProjectId', 'in' => 'formData', + 'schema' => ['description' => 'The DataWorks workspace ID. You can call the [ListProjects](~~178393~~) operation to obtain the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '1', 'example' => '9527'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Identifies content. You can call the [QuerySensNodeInfo](~~2747189~~) operation to query the value of the current parameter for a built-in sensitive field.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"_clazz":"com.alipay.dsgclient.sdk.dsg.fastscan.engine.cond.NationalityCond"}', + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID. You can use the request ID to query logs and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'E6F0DBDD-5AD****'], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'string', 'example' => 'true'], + ], ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"\\n E6F0DBDD-5AD****\\n true\\n","errorExample":""}]', + 'title' => 'OfflineNode', + 'summary' => 'Undeploys a node.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '99', 'countWindow' => 1, 'regionId' => '*', 'api' => 'OfflineNode'], + ], + ], + 'ramActions' => [ [ - 'name' => 'ColScan', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Scans fields. The system identifies only fields that are assigned with values.'."\n" - ."\n" - .'* The value must be in the ${Project name}.${Table name}.${Field name} or ${Project name}.${Schema name}.${Table name}.${Field name} format.'."\n" - .'* *Wildcards are supported. For example, the asterisk (\\*) in default.table.column1\\* can be used to match any content following default.table.column1, such as default.table.column10.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'default.qujian.*', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'PublishDataServiceApi' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ColExclude', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '78339', + 'abilityTreeNodes' => ['FEATUREdideZZ63WZ'], + ], + 'parameters' => [ + [ + 'name' => 'TenantId', 'in' => 'formData', - 'schema' => [ - 'description' => 'Excludes fields. The system does not identify fields that are assigned with values.'."\n" - ."\n" - .'* The value must be in the ${Project name}.${Table name}.${Field name} or ${Project name}.${Schema name}.${Table name}.${Field name} format.'."\n" - .'* *Wildcards are supported. For example, the asterisk (\\*) in default.table.column1\\* can be used to match any content following default.table.column1, such as default.table.column10.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'default.qujian.*6', - ], + 'schema' => ['description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10002'], ], [ - 'name' => 'CommentScan', + 'name' => 'ProjectId', 'in' => 'formData', - 'schema' => [ - 'description' => 'Scans content. The value is the text of each field comment in your data asset. Fuzzy match is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'The workspace ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10001'], ], [ - 'name' => 'HitThreshold', + 'name' => 'ApiId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The hit ratio threshold. If more than 60%, which is a sample hit ratio threshold, of all sample data records hit the Name Entity Recognition (NER) model, the sensitive field is hit. The value can be an integer from 0 to 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '50', - ], + 'schema' => ['description' => 'The API ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10000'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'OpenApiResultModel', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '9990030003', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Missing parameter', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The returned result in the JSON format.'."\n", - 'type' => 'any', - 'example' => '{ "HttpStatusCode": 200, "Success": true }', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '10000001', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Data' => ['description' => 'Indicates whether the API was published.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The connection does not exist.'], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0000-ABCD-EFG****'], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists'], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true'], ], + 'description' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'BADPARAMETERS', - 'errorMessage' => 'Parameters are missing or in the wrong format.', - ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n true\\n The connection does not exist.\\n 0000-ABCD-EFG****\\n Invalid.Tenant.ConnectionNotExists\\n true\\n","errorExample":""}]', + 'title' => 'PublishDataServiceApi', + 'summary' => 'Publishes an API.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-10-09T11:17:29.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-12T08:46:57.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-08-12T08:46:57.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-08-12T08:46:57.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PublishDataServiceApi'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"9990030003\\",\\n \\"ErrorMessage\\": \\"Missing parameter\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"{ \\\\\\"HttpStatusCode\\\\\\": 200, \\\\\\"Success\\\\\\": true }\\",\\n \\"RequestId\\": \\"10000001\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 9990030003\\n 缺少参数\\n 200\\n { \\"HttpStatusCode\\": 200, \\"Success\\": true }\\n 10000001\\n","errorExample":""}]', - 'title' => 'EditRecognizeRule', + 'ramActions' => [], ], - 'QueryRecognizeDataByRuleType' => [ - 'summary' => 'Queries the type of a sensitive data identification rule.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'QueryDISyncTaskConfigProcessResult' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '212273', - 'abilityTreeNodes' => [ - 'FEATUREdideDCM5VK', + [ + 'PrivateKey' => [], + ], + [ + 'APP' => [], ], ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'RecognizeRulesType', - 'in' => 'formData', + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the ID.'."\n" + ."\n" + .'You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '10000000000', 'minimum' => '1', 'example' => '10000', 'title' => ''], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', 'schema' => [ - 'description' => 'The type of a sensitive data identification rule. You can call the [QueryRecognizeRulesType](~~2746905~~) operation to obtain the type of the rule.'."\n" + 'description' => 'The type of the object that you want to create or update in Data Integration in asynchronous mode. Valid values:'."\n" + ."\n" + .'- DI\\_REALTIME: real-time synchronization task'."\n" + ."\n" + .'- DI\\_SOLUTION: synchronization solution DataWorks allows you to create or update real-time synchronization tasks and synchronization solutions in Data Integration only in asynchronous mode.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- DI\\_OFFLINE'."\n" ."\n" - .'* 1: regular expression'."\n" - .'* 2: built-in rule'."\n" - .'* 3: sample library'."\n" - .'* 4: self-generated data identification model'."\n", + .'- DI\\_REALTIME'."\n" + ."\n" + .'- DI\\_SOLUTION', + 'enumValueTitles' => [], 'type' => 'string', 'required' => true, - 'example' => '2', + 'docRequired' => true, + 'enum' => ['DI_OFFLINE', 'DI_REALTIME', 'DI_SOLUTION'], + 'example' => 'DI_REALTIME', + 'title' => '', ], ], [ - 'name' => 'TenantId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '10241024', - ], + 'name' => 'AsyncProcessId', + 'in' => 'query', + 'schema' => ['description' => 'The asynchronous thread ID. You can call the [GenerateDISyncTaskConfigForCreating](~~383463~~) or [GenerateDISyncTaskConfigForUpdating](~~383464~~) operation to obtain the ID.'."\n" + ."\n" + .'- The GenerateDISyncTaskConfigForCreating operation is used to generate the ID of the asynchronous thread that is used to create a real-time synchronization task in Data Integration.'."\n" + ."\n" + .'- The GenerateDISyncTaskConfigForUpdating operation is used to generate the ID of the asynchronous thread that is used to update a real-time synchronization task in Data Integration.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9999999999999999', 'minimum' => '1', 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'DataWorksResult', - 'description' => 'The response parameters.'."\n", + 'description' => 'The returned results.', 'type' => 'object', 'properties' => [ - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '9990030003', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Missing parameter', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.', 'type' => 'string', 'example' => '0bc1411515937635973****', 'title' => ''], 'Data' => [ - 'description' => 'The returned result in the JSON format.'."\n", - 'type' => 'any', - 'example' => '[{"custom": false, "name": "EducationDegree", "localeName": "EducationDegree", "templateJsonStr": "{"_clazz":"com.alipay.dsgclient.sdk.dsg.fastscan.engine.cond.EducationDegreeCond"}", "desc": ""}]', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => '10000001', + 'description' => 'The information returned for the parameters that are asynchronously generated and used to create or update a real-time synchronization task in Data Integration.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'Indicates whether the parameters are obtained. Valid values:'."\n" + ."\n" + .'- success: The parameters are obtained.'."\n" + ."\n" + .'- fail: The parameters fail to be obtained. You can view the reason for the failure and troubleshoot the issue based on the reason.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Message' => ['description' => 'The reason why the parameters fail to be obtained. If the parameters are obtained, the value null is returned.', 'type' => 'string', 'example' => 'fileId:[100] is invalid.', 'title' => ''], + 'TaskContent' => ['description' => 'The parameters that are obtained. The parameters are used as the request parameters of the [CreateDISyncTask](~~278725~~) or [UpdateDISyncTask](~~289109~~) operation to create or update a real-time synchronization task in Data Integration.', 'type' => 'string', 'example' => '{"extend":{"mode":"migration_holo","resourceGroup":"280749","name":"h"},"type":"job","steps":[{"stepType":"mysql","parameter":{"connection":[{"datasourceType":"mysql","datasource":"mm","selectedTables":[{"schema":[{"tableInfos":[{"enable":true,"table":"m_v1","tableName":"m_v1"}]}],"dbName":"m"}]}]},"name":"reader","category":"reader"},{"stepType":"holo","parameter":{"datasource":"h","tableMappingRule":{"datasource":[{"tableRule":[{"srcTable":"m_v1","mergeIntoCycleType":"DEFAULT","hourDeltaEnable":false,"dstTable":"m.m_v1","dayDeltaEnable":false,"primaryKeyInfo":{"column":["id"],"type":"pk"},"dstCreateTableInfo":{"indexType":"m_v1","dataColumn":[{"columnSize":0,"name":"id","index":0,"comment":"","newDigit":0,"type":"int8","digit":0,"primaryKey":true}],"schemaName":"m","tableName":"m_v1"},"srcDbName":"m"}],"srcDatasourceName":"mm"}],"totalTableMapping":1},"writeMode":"replay"},"name":"writer","category":"writer"}],"version":"2.0","order":{"hops":[{"from":"reader","to":"writer"}]}}', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'BADPARAMETERS', - 'errorMessage' => 'Parameters are missing or in the wrong format.', - ], + ['errorCode' => 'Param.Invalid', 'errorMessage' => 'The parameter is invalid.', 'description' => 'Param invalid'], + ], + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal error occurred.', 'description' => 'InternalError '], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ErrorCode\\": \\"9990030003\\",\\n \\"ErrorMessage\\": \\"Missing parameter\\",\\n \\"Success\\": true,\\n \\"Data\\": \\"[{\\\\\\"custom\\\\\\": false, \\\\\\"name\\\\\\": \\\\\\"EducationDegree\\\\\\", \\\\\\"localeName\\\\\\": \\\\\\"EducationDegree\\\\\\", \\\\\\"templateJsonStr\\\\\\": \\\\\\"{"_clazz":"com.alipay.dsgclient.sdk.dsg.fastscan.engine.cond.EducationDegreeCond"}\\\\\\", \\\\\\"desc\\\\\\": \\\\\\"\\\\\\"}]\\",\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"100000012\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 9990030003\\n 缺少参数\\n true\\n [{\\"custom\\": false, \\"name\\": \\"EducationDegree\\", \\"localeName\\": \\"EducationDegree\\", \\"templateJsonStr\\": \\"{&quot;_clazz&quot;:&quot;com.alipay.dsgclient.sdk.dsg.fastscan.engine.cond.EducationDegreeCond&quot;}\\", \\"desc\\": \\"\\"}]\\n 200\\n 10000001\\n","errorExample":""}]', - 'title' => 'QueryRecognizeDataByRuleType', - ], - 'QueryRecognizeRuleDetail' => [ - 'summary' => 'Queries the details of a specified sensitive field in Data Security Guard.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0bc1411515937635973****\\",\\n \\"Data\\": {\\n \\"Status\\": \\"success\\",\\n \\"Message\\": \\"fileId:[100] is invalid.\\",\\n \\"TaskContent\\": \\"{\\\\\\"extend\\\\\\":{\\\\\\"mode\\\\\\":\\\\\\"migration_holo\\\\\\",\\\\\\"resourceGroup\\\\\\":\\\\\\"280749\\\\\\",\\\\\\"name\\\\\\":\\\\\\"h\\\\\\"},\\\\\\"type\\\\\\":\\\\\\"job\\\\\\",\\\\\\"steps\\\\\\":[{\\\\\\"stepType\\\\\\":\\\\\\"mysql\\\\\\",\\\\\\"parameter\\\\\\":{\\\\\\"connection\\\\\\":[{\\\\\\"datasourceType\\\\\\":\\\\\\"mysql\\\\\\",\\\\\\"datasource\\\\\\":\\\\\\"mm\\\\\\",\\\\\\"selectedTables\\\\\\":[{\\\\\\"schema\\\\\\":[{\\\\\\"tableInfos\\\\\\":[{\\\\\\"enable\\\\\\":true,\\\\\\"table\\\\\\":\\\\\\"m_v1\\\\\\",\\\\\\"tableName\\\\\\":\\\\\\"m_v1\\\\\\"}]}],\\\\\\"dbName\\\\\\":\\\\\\"m\\\\\\"}]}]},\\\\\\"name\\\\\\":\\\\\\"reader\\\\\\",\\\\\\"category\\\\\\":\\\\\\"reader\\\\\\"},{\\\\\\"stepType\\\\\\":\\\\\\"holo\\\\\\",\\\\\\"parameter\\\\\\":{\\\\\\"datasource\\\\\\":\\\\\\"h\\\\\\",\\\\\\"tableMappingRule\\\\\\":{\\\\\\"datasource\\\\\\":[{\\\\\\"tableRule\\\\\\":[{\\\\\\"srcTable\\\\\\":\\\\\\"m_v1\\\\\\",\\\\\\"mergeIntoCycleType\\\\\\":\\\\\\"DEFAULT\\\\\\",\\\\\\"hourDeltaEnable\\\\\\":false,\\\\\\"dstTable\\\\\\":\\\\\\"m.m_v1\\\\\\",\\\\\\"dayDeltaEnable\\\\\\":false,\\\\\\"primaryKeyInfo\\\\\\":{\\\\\\"column\\\\\\":[\\\\\\"id\\\\\\"],\\\\\\"type\\\\\\":\\\\\\"pk\\\\\\"},\\\\\\"dstCreateTableInfo\\\\\\":{\\\\\\"indexType\\\\\\":\\\\\\"m_v1\\\\\\",\\\\\\"dataColumn\\\\\\":[{\\\\\\"columnSize\\\\\\":0,\\\\\\"name\\\\\\":\\\\\\"id\\\\\\",\\\\\\"index\\\\\\":0,\\\\\\"comment\\\\\\":\\\\\\"\\\\\\",\\\\\\"newDigit\\\\\\":0,\\\\\\"type\\\\\\":\\\\\\"int8\\\\\\",\\\\\\"digit\\\\\\":0,\\\\\\"primaryKey\\\\\\":true}],\\\\\\"schemaName\\\\\\":\\\\\\"m\\\\\\",\\\\\\"tableName\\\\\\":\\\\\\"m_v1\\\\\\"},\\\\\\"srcDbName\\\\\\":\\\\\\"m\\\\\\"}],\\\\\\"srcDatasourceName\\\\\\":\\\\\\"mm\\\\\\"}],\\\\\\"totalTableMapping\\\\\\":1},\\\\\\"writeMode\\\\\\":\\\\\\"replay\\\\\\"},\\\\\\"name\\\\\\":\\\\\\"writer\\\\\\",\\\\\\"category\\\\\\":\\\\\\"writer\\\\\\"}],\\\\\\"version\\\\\\":\\\\\\"2.0\\\\\\",\\\\\\"order\\\\\\":{\\\\\\"hops\\\\\\":[{\\\\\\"from\\\\\\":\\\\\\"reader\\\\\\",\\\\\\"to\\\\\\":\\\\\\"writer\\\\\\"}]}}\\"\\n }\\n}","type":"json"}]', + 'title' => 'QueryDISyncTaskConfigProcessResult', + 'summary' => 'Queries the result of an asynchronous task for generating synchronization task configurations.', + 'description' => 'DataWorks allows you to directly call the [CreateDISyncTask](~~278725~~) operation to create or the [UpdateDISyncTask](~~289109~~) operation to update batch synchronization tasks in Data Integration. To create or update a real-time synchronization task, you must first call the [GenerateDISyncTaskConfigForCreating](~~383463~~), [GenerateDISyncTaskConfigForUpdating](~~383464~~), and [QueryDISyncTaskConfigProcessResult](~~383465~~) operations to asynchronously generate the required parameters, and then pass the parameters to the CreateDISyncTask or UpdateDISyncTask operation.'."\n" + .'Only asynchronous creation or update is supported for real-time synchronization tasks in Data Integration.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'QueryDefaultTemplate' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -53126,222 +32605,881 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '212990', - 'abilityTreeNodes' => [ - 'FEATUREdideDCM5VK', - ], + 'abilityTreeCode' => '212265', + 'abilityTreeNodes' => ['FEATUREdideBVSRMP'], ], 'parameters' => [ - [ - 'name' => 'SensitiveName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the sensitive field. To obtain the name of the sensitive field, call the [QuerySensNodeInfo](~~2747189~~) operation or log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Data Category and Sensitivity Level page.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Name', - ], - ], [ 'name' => 'TenantId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '10241024', - ], + 'schema' => ['description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n", 'type' => 'string', 'required' => true, 'example' => '10241024'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'OpenApiResultModel', - 'description' => 'The response parameters.'."\n", + 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '9990030003', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Missing parameter', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The details of the sensitive field in the JSON format.'."\n", - 'type' => 'any', - 'example' => '{"nodeName":"basic unit overview","gmtModified":1709017449000,"hitThreshold":30,"sensitiveName":"mobile-yinni","templateId":"8222abeb-9784-4417-b420-0322926d5cbf","recognizeRulesType":2,"delete":false,"bydAccuracy":1,"colScan":"," defineType ":1,": ydAccuracy ":{" contentRule ":))," operationType ":0}," nodeParent ":" unit/unit basic information/unit basic overview "," level ":6," keyRuleId ":" 228248921215042mobile-yinni "," isDelete ":false," levelName ":" 6level "," sensitive ":false," operationType ":0," sourceName ": dsg-test-zuoyue","nodeId":"bea2fc81-90c9-45f3-b7a9-26d534208a0d","status":1}', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => '10000001', - ], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'required' => true, 'example' => 'true'], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'required' => true, 'example' => '9990030003', 'default' => 'null'], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'required' => true, 'example' => 'Parameter error', 'default' => 'null'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '400'], + 'Data' => ['description' => 'The returned data about the default data category and data sensitivity level template. The data is in the JSON array format.'."\n", 'type' => 'any', 'required' => true, 'example' => '[{"gmtModified":1709022365000,"fileName":"default file","isDelete":false,"isDefaultTemplate":true}]'], + 'RequestId' => ['description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", 'type' => 'string', 'required' => true, 'example' => '102400001', 'default' => 'null'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'BADPARAMETERS', - 'errorMessage' => 'Parameters are missing or in the wrong format.', - ], + ['errorCode' => 'BADPARAMETERS', 'errorMessage' => 'Parameters are missing or in the wrong format.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"9990030003\\",\\n \\"ErrorMessage\\": \\"Missing parameter\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"{\\\\\\"nodeName\\\\\\":\\\\\\"basic unit overview\\\\\\",\\\\\\"gmtModified\\\\\\":1709017449000,\\\\\\"hitThreshold\\\\\\":30,\\\\\\"sensitiveName\\\\\\":\\\\\\"mobile-yinni\\\\\\",\\\\\\"templateId\\\\\\":\\\\\\"8222abeb-9784-4417-b420-0322926d5cbf\\\\\\",\\\\\\"recognizeRulesType\\\\\\":2,\\\\\\"delete\\\\\\":false,\\\\\\"bydAccuracy\\\\\\":1,\\\\\\"colScan\\\\\\":\\\\\\",\\\\\\" defineType \\\\\\":1,\\\\\\": ydAccuracy \\\\\\":{\\\\\\" contentRule \\\\\\":)),\\\\\\" operationType \\\\\\":0},\\\\\\" nodeParent \\\\\\":\\\\\\" unit/unit basic information/unit basic overview \\\\\\",\\\\\\" level \\\\\\":6,\\\\\\" keyRuleId \\\\\\":\\\\\\" 228248921215042mobile-yinni \\\\\\",\\\\\\" isDelete \\\\\\":false,\\\\\\" levelName \\\\\\":\\\\\\" 6level \\\\\\",\\\\\\" sensitive \\\\\\":false,\\\\\\" operationType \\\\\\":0,\\\\\\" sourceName \\\\\\": dsg-test-zuoyue\\\\\\",\\\\\\"nodeId\\\\\\":\\\\\\"bea2fc81-90c9-45f3-b7a9-26d534208a0d\\\\\\",\\\\\\"status\\\\\\":1}\\",\\n \\"RequestId\\": \\"100000012\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 9990030003\\n 缺少参数\\n 200\\n {\\"nodeName\\":\\"单位基本概况\\",\\"gmtModified\\":1709017449000,\\"hitThreshold\\":30,\\"sensitiveName\\":\\"mobile-yinni\\",\\"templateId\\":\\"8222abeb-9784-4417-b420-0322926d5cbf\\",\\"recognizeRulesType\\":2,\\"delete\\":false,\\"bydAccuracy\\":1,\\"colScan\\":\\"\\",\\"defineType\\":1,\\"ydAccuracy\\":1,\\"contentRule\\":{\\"contentRule\\":{},\\"operationType\\":0},\\"nodeParent\\":\\"单位/单位基本信息/单位基本概况\\",\\"level\\":6,\\"keyRuleId\\":\\"228248921215042mobile-yinni\\",\\"isDelete\\":false,\\"levelName\\":\\"6level\\",\\"sensitive\\":false,\\"operationType\\":0,\\"sourceName\\":\\"dsg-test-zuoyue\\",\\"nodeId\\":\\"bea2fc81-90c9-45f3-b7a9-26d534208a0d\\",\\"status\\":1}\\n 10000001\\n","errorExample":""}]', - 'title' => 'QueryRecognizeRuleDetail', - ], - 'DsgUserGroupGetOdpsRoleGroups' => [ - 'methods' => [ - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"9990030003\\",\\n \\"ErrorMessage\\": \\"Parameter error\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": \\"[{\\\\\\"gmtModified\\\\\\":1709022365000,\\\\\\"fileName\\\\\\":\\\\\\"default file\\\\\\",\\\\\\"isDelete\\\\\\":false,\\\\\\"isDefaultTemplate\\\\\\":true}]\\",\\n \\"RequestId\\": \\"102400001\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 9990030003\\n 参数错误\\n 400\\n [{\\"gmtModified\\":1709022365000,\\"fileName\\":\\"默认文件\\",\\"isDelete\\":false,\\"isDefaultTemplate\\":true}]\\n 102400001\\n","errorExample":""}]', + 'title' => 'QueryDefaultTemplate', + 'summary' => 'Queries the default data category and data sensitivity level template defined by Data Security Guard.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:QueryDefaultTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'QueryPublicModelEngine' => [ + 'summary' => 'Retrieves information about Data Modeling objects created by using fast modeling language (FML) statements.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '220985', - 'abilityTreeNodes' => [ - 'FEATUREdideRZM9W6', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'ProjectName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the MaxCompute project. You can call the [DsgPlatformQueryProjectsAndSchemaFromMeta](~~2786303~~) operation to query a list of MaxCompute projects.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test_project', - ], + 'name' => 'Text', + 'in' => 'formData', + 'schema' => ['description' => 'The FML statement that is used to query information about objects that are created in Data Modeling. For more information, see [Use FML statements to configure and manage data tables](~~298128~~). Only SHOW statements are supported.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'show dim tables', 'title' => ''], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to query the ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1234', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'OpenApiResultModel>', - 'description' => 'The data returned.'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '1029030003', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'param error', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - ], - 'Data' => [ - 'description' => 'The data returned.'."\n", + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4CFB2DED-7D9B-4C42-B4AA-CFF4991DFFF4', 'title' => ''], + 'ReturnValue' => [ + 'description' => 'The returned information about objects.', 'type' => 'array', - 'items' => [ - 'description' => 'The name of the MaxCompute role.'."\n", - 'type' => 'string', - 'example' => 'test_role', - ], - ], - 'RequestId' => [ - 'description' => 'The request ID. You can use the ID to locate logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '102400001', + 'items' => ['description' => 'The returned information about the object.', 'type' => 'object', 'example' => '[{ "gmtModified": 最后修改时间,"code": "表名","creatorId": "创建人ID","creatorName": "创建人名称","modifierId": "修改人ID","gmtCreate": 创建时间,"type": 表类型,"ownerId": "负责人ID","uuid": "系统ID","businessUnitUuid": "业务板块ID","detailType": "表二级类型","ownerName": "负责人名称","name": "表显示名","modifierName": "最后修改人名称","businessProcessUuid": "业务过程ID" }]', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'USERGROUP.ACCOUNTLISTSIZE.ERROR', - 'errorMessage' => 'The number of account exceeds the limit.', - ], - [ - 'errorCode' => 'USERGROUP.ID.ERROR', - 'errorMessage' => 'The user group ID does not match the tenant or does not exist.', - ], - [ - 'errorCode' => 'USERGROUP.LISTSIZE.ERROR', - 'errorMessage' => 'The number of user groups exceeds the limit.', - ], - [ - 'errorCode' => 'USERGROUP.PAGESIZE.ERROR', - 'errorMessage' => 'Page size is too large, maximum of 100.', - ], - [ - 'errorCode' => 'USERACCOUNT.OWNER.ERROR', - 'errorMessage' => 'User list or owner user does not exist.', - ], - [ - 'errorCode' => 'PARAMS.ERROR', - 'errorMessage' => 'param error.', - ], - ], - 403 => [ - [ - 'errorCode' => 'PERMISSION.DENIED.ERROR', - 'errorMessage' => 'Permission denied', - ], - ], - 500 => [ - [ - 'errorCode' => 'UNKNOWN.ERROR', - 'errorMessage' => 'unknown error.', - ], - ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Valid.FML.NoPermission', 'errorMessage' => 'You are not authorized to access the project resources.', 'description' => 'You are not granted the required permissions to access the current project.'], + ['errorCode' => 'Valid.FML.OnlySupportQueryStatement', 'errorMessage' => 'Only FML query statement is supported.', 'description' => 'Only FML statements are supported.'], + ['errorCode' => 'Valid.FML.ProjectNotExist', 'errorMessage' => 'The project does not exist.', 'description' => 'Information about the project is not found. Check input parameters.'], + ['errorCode' => 'Valid.FML.StatementNotValid', 'errorMessage' => 'The FML statement is invalid.', 'description' => 'The FML statement is invalid. For information about the FML syntax, see https://dataworks-doc.yuque.com/docs/share/ff7899ed-c433-4970-b20e-6582ea3939f3?#.'], + ['errorCode' => 'Valid.FML.ProductExpired', 'errorMessage' => '智能数据建模产品购买已到期', 'description' => 'The Data Modeling feature that you purchase expires.'], + ['errorCode' => 'Valid.FML.ProductNotActivated', 'errorMessage' => '智能数据建模产品未开通', 'description' => 'The Data Modeling feature is not enabled.'], + ], + 500 => [ + ['errorCode' => 'Execute.FML.ProcessError', 'errorMessage' => 'Failed to execute FML statement.', 'description' => 'The FML statement fails to be executed. Try again later.'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4CFB2DED-7D9B-4C42-B4AA-CFF4991DFFF4\\",\\n \\"ReturnValue\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'QueryPublicModelEngine', + 'description' => '- Each time you call this API operation, you must use FML statements to query information about objects that are created in Data Modeling.'."\n" + ."\n" + .'- The information about the objects can be queried by page, except for data layers, business processes, and data domains. You can add an offset to the end of an FML statement. The num LIMIT num statement specifies the offset when the information about the objects is queried, and the number of pages to return each time. The offset value must be a multiple of the number of pages.'."\n" + ."\n" + .'- A maximum of 1,000 entries can be returned each time you call this API operation.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => '## Response description'."\n" + ."\n" + .'### FML statement used to query data layers'."\n" + ."\n" + .'show layers;
'."\n" + .'Response parameters'."\n" + ."\n" + .'| Parameter | Type | Example | Description |'."\n" + .'| ------------ | --------- | ---------------------------- | ------------------------------------------------------ |'."\n" + .'| code | String | dws | The code of the data layer. |'."\n" + .'| englishName | String | dws | The name of the data layer. |'."\n" + .'| name | String | DWS layer | The display name of the data layer. |'."\n" + .'| ownerId | String | 0123456 | The owner ID. |'."\n" + .'| ownerName | String | A, B, C, and D | The name of the owner. |'."\n" + .'| description | String | Description of the DWS layer | The description of the data layer. |'."\n" + .'| uuid | String | obj-123456 | The UUID of the data layer. |'."\n" + .'| gmtCreate | TimeStamp | 1644397025000 | The time when the data layer was created. |'."\n" + .'| gmtModified | TimeStamp | 1644459965000 | The time when the data layer was last modified. |'."\n" + .'| creatorId | String | 0123456 | The ID of the user who created the data layer. |'."\n" + .'| creatorName | String | A, B, C, and D | The name of the user who created the data layer. |'."\n" + .'| modifierId | String | 0123456 | The ID of the user who last modified the data layer. |'."\n" + .'| modifierName | String | A, B, C, and D | The name of the user who last modified the data layer. |'."\n" + ."\n" + .'### FML statement used to query data domains'."\n" + ."\n" + .'show domains;
'."\n" + .'Response parameters'."\n" + ."\n" + .'| Parameter | Type | Example | Description |'."\n" + .'| ---------------- | --------- | ------------------------------------- | ------------------------------------------------------- |'."\n" + .'| code | String | member | The code of the data domain. |'."\n" + .'| englishName | String | member | The name of the data domain. |'."\n" + .'| name | String | Member | The display name of the data domain. |'."\n" + .'| ownerId | String | 0123456 | The owner ID. |'."\n" + .'| ownerName | String | A, B, C, and D | The name of the owner. |'."\n" + .'| businessUnitCode | String | bu-123456 | The code of the business unit. |'."\n" + .'| description | String | Description of the Member data domain | The description of the data domain. |'."\n" + .'| uuid | String | obj-123456 | The UUID of the data domain. |'."\n" + .'| gmtCreate | TimeStamp | 1644397025000 | The time when the data domain was created. |'."\n" + .'| gmtModified | TimeStamp | 1644459965000 | The time when the data domain was last modified. |'."\n" + .'| creatorId | String | 0123456 | The ID of the user who created the data domain. |'."\n" + .'| creatorName | String | A, B, C, and D | The name of the user who created the data domain. |'."\n" + .'| modifierId | String | 0123456 | The ID of the user who last modified the data domain. |'."\n" + .'| modifierName | String | A, B, C, and D | The name of the user who last modified the data domain. |'."\n" + ."\n" + .'### FML statements used to query business processes'."\n" + ."\n" + .'- FML statement used to query business processes without configuring query conditions: show business\\_processes;'."\n" + ."\n" + .'- FML statement used to query a business process based on the code of the business process: show business\\_processes where code=\'bp-code\';'."\n" + ."\n" + .'- FML statement used to query business processes based on the code of a data domain: show business\\_processes where data\\_domain=\'dm-code\';'."\n" + ."\n" + .'Response parameters'."\n" + ."\n" + .'| Parameter | Type | Example | Description |'."\n" + .'| -------------- | --------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| code | String | bp-123456 | The code of the business process. |'."\n" + .'| englishName | String | pay | The name of the business process. |'."\n" + .'| name | String | Payment | The display name of the business process. |'."\n" + .'| dataDomainCode | String | trade | The code of the data domain to which the business process belongs. |'."\n" + .'| dataDomainName | String | Transaction | The display name of the data domain to which the business process belongs. |'."\n" + .'| dataDomainUuid | String | dm-123456 | The UUID of the data domain to which the business process belongs. |'."\n" + .'| ownerId | String | 0123456 | The owner ID. |'."\n" + .'| ownerName | String | A, B, C, and D | The name of the owner. |'."\n" + .'| description | String | Payment | The description of the business process. |'."\n" + .'| source | Integer | 2 | The source of the business process. Valid values:1: indicates that the business process is created by the system.2: indicates that the business process is created by a user. |'."\n" + .'| uuid | String | obj-123456 | The UUID of the business process. |'."\n" + .'| gmtCreate | TimeStamp | 1644397025000 | The time when the business process was created. |'."\n" + .'| gmtModified | TimeStamp | 1644459965000 | The time when the business process was last modified. |'."\n" + .'| creatorId | String | creatorId | The ID of the user who created the business process. |'."\n" + .'| creatorName | String | A, B, C, and D | The name of the user who created the business process. |'."\n" + .'| modifierId | String | 0123456 | The ID of the user who last modified the business process. |'."\n" + .'| modifierName | String | A, B, C, and D | The name of the user who last modified the business process. |'."\n" + ."\n" + .'### FML statements used to query business categories'."\n" + ."\n" + .'```'."\n" + .' show business_categories;'."\n" + .' show business_categories where code=\'code\';'."\n" + .' show business_categories where keyword=\'keyword\';'."\n" + .' show business_categories where uuid=\'uuid\'; '."\n" + .'```'."\n" + ."\n" + .'Response parameters'."\n" + ."\n" + .'| Parameter | Type | Example | Description |'."\n" + .'| ---------------- | ------------------ | ------------------------------------------------------------------------ | ---------------------------------------------------------------- |'."\n" + .'| categoryDetail | DirectoryDetailDTO | {"uuid": "cate_uuid", "code": "trd", "name": "Transaction"} | The details of the business category. |'."\n" + .'| name | String | E-commerce | The name of the directory. |'."\n" + .'| detailType | String | DICT | The type of the directory. |'."\n" + .'| parentUuid | String | dy-123456 | The UUID of the parent directory. |'."\n" + .'| description | String | Description | The description of the directory. |'."\n" + .'| code | String | ind | The code of the business category. |'."\n" + .'| dataDomains | List | \\[{"uuid": "domain1", "code": "trd", "name": "Transaction data domain"}] | The data domains that are associated with the business category. |'."\n" + .'| ownerId | String | 0123456 | The owner ID. |'."\n" + .'| ownerName | String | A, B, C, and D | The name of the owner. |'."\n" + .'| businessUnitCode | String | bu-123456 | The code of the business unit. |'."\n" + .'| description | String | Description | The description of the directory. |'."\n" + .'| categoryPath | String | tm.ind | The path of the business category. |'."\n" + ."\n" + .'### FML statement used to query data marts'."\n" + ."\n" + .'show markets; Response parameters'."\n" + ."\n" + .'| Parameter | Type | Example | Description |'."\n" + .'| ---------------- | ------------------ | ----------------------------------------------------------- | ------------------------------------ |'."\n" + .'| categoryDetail | DirectoryDetailDTO | {"uuid": "cate_uuid", "code": "trd", "name": "Transaction"} | The details of the data mart. |'."\n" + .'| name | String | E-commerce | The name of the directory. |'."\n" + .'| detailType | String | DICT | The type of the directory. |'."\n" + .'| parentUuid | String | dy-123456 | The UUID of the parent directory. |'."\n" + .'| description | String | Description | The description of the directory. |'."\n" + .'| code | String | ind | The code of the business category. |'."\n" + .'| subDetailType | String | common | The subtype of the directory. |'."\n" + .'| auditDTOList | List | \\[{"baseId":"123","showName":"test"}] | The reviewers. |'."\n" + .'| code | String | member | The code of the data domain. |'."\n" + .'| englishName | String | member | The name of the data domain. |'."\n" + .'| name | String | Member | The display name of the data domain. |'."\n" + .'| ownerId | String | 0123456 | The owner ID. |'."\n" + .'| ownerName | String | A, B, C, and D | The name of the owner. |'."\n" + .'| businessUnitCode | String | bu-123456 | The code of the business unit. |'."\n" + .'| description | String | Description of the Member data domain | The description of the data domain. |'."\n" + .'| auditDTOList | List | \\[{"baseId":"123","showName":"test"}] | The reviewers. |'."\n" + .'| categoryPath | String | tm.ind | The path of the business category. |'."\n" + ."\n" + .'### FML statement used to query subject areas'."\n" + ."\n" + .'show subjects; Response parameters'."\n" + ."\n" + .'| Parameter | Type | Example | Description |'."\n" + .'| ---------------- | ------------------ | ----------------------------------------------------------- | ------------------------------------ |'."\n" + .'| categoryDetail | DirectoryDetailDTO | {"uuid": "cate_uuid", "code": "trd", "name": "Transaction"} | The details of the subject area. |'."\n" + .'| name | String | E-commerce | The name of the directory. |'."\n" + .'| detailType | String | DICT | The type of the directory. |'."\n" + .'| parentUuid | String | dy-123456 | The UUID of the parent directory. |'."\n" + .'| description | String | Description | The description of the directory. |'."\n" + .'| code | String | ind | The code of the business category. |'."\n" + .'| subDetailType | String | common | The subtype of the directory. |'."\n" + .'| auditDTOList | List | \\[{"baseId":"123","showName":"test"}] | The reviewers. |'."\n" + .'| code | String | member | The code of the data domain. |'."\n" + .'| englishName | String | member | The name of the data domain. |'."\n" + .'| name | String | Member | The display name of the data domain. |'."\n" + .'| ownerId | String | 0123456 | The owner ID. |'."\n" + .'| ownerName | String | A, B, C, and D | The name of the owner. |'."\n" + .'| businessUnitCode | String | bu-123456 | The code of the business unit. |'."\n" + .'| description | String | Description of the Member data domain | The description of the subject area. |'."\n" + .'| auditDTOList | List | \\[{"baseId":"123","showName":"test"}] | The reviewers. |'."\n" + .'| categoryPath | String | tm.ind | The path of the business category. |'."\n" + ."\n" + .'### FML statement used to query data standard sets'."\n" + ."\n" + .'show dict groups; Response parameters'."\n" + ."\n" + .'| Parameter | Type | Example | Description |'."\n" + .'| ------------ | --------- | -------------- | ------------------------------------------------------------- |'."\n" + .'| name | String | E-commerce | The name of the directory. |'."\n" + .'| detailType | String | DICT | The type of the directory. |'."\n" + .'| parentUuid | String | dy-123456 | The UUID of the parent directory. |'."\n" + .'| description | String | Description | The description of the directory. |'."\n" + .'| code | String | ind | The code of the business category. |'."\n" + .'| uuid | List | obj-123456 | The UUID of the data standard set. |'."\n" + .'| gmtCreate | TimeStamp | 1644397025000 | The time when the data standard set was created. |'."\n" + .'| gmtModified | TimeStamp | 1644459965000 | The time when the data standard set was last modified. |'."\n" + .'| creatorId | String | 0123456 | The ID of the user who created the data standard set. |'."\n" + .'| creatorName | String | A, B, C, and D | The name of the user who created the data standard set. |'."\n" + .'| modifierId | String | 0123456 | The ID of the user who last modified the data standard set. |'."\n" + .'| modifierName | String | A, B, C, and D | The name of the user who last modified the data standard set. |'."\n" + ."\n" + .'### FML statement used to query data standards'."\n" + ."\n" + .'show dicts; Response parameters'."\n" + ."\n" + .'| Parameter | Type | Example | Description |'."\n" + .'| ------------------ | --------- | -------------- | ------------------------------------------------------------------------------------------------------ |'."\n" + .'| code | String | shop_type | The abbreviation for the name of the data standard. |'."\n" + .'| englishName | String | shop type | The name of the data standard. |'."\n" + .'| name | String | Shop type | The display name of the data standard. |'."\n" + .'| no | String | SN00001 | The data standard ID. |'."\n" + .'| dataType | String | STRING | The data type of the fields that use the data standard. |'."\n" + .'| length | Integer | 10 | The maximum number of digits in the values of the fields that use the data standard. |'."\n" + .'| numericalPrecision | Integer | 2 | The number of decimal places that are retained in the values of the fields that use the data standard. |'."\n" + .'| notNull | Boolean | false | Indicates whether the values of the fields that use the data standard can be non-null. |'."\n" + .'| defaultValue | String | Flagship shop | The default value. |'."\n" + .'| parentNo | String | SN0001 | The ID of the parent data standard. |'."\n" + .'| parentName | String | Shop | The name of the parent data standard. |'."\n" + .'| codeTableNo | String | shop_type | The code of the lookup table that defines the value range of the fields that use the data standard. |'."\n" + .'| codeTableName | String | Shop type | The name of the lookup table that defines the value range of the fields that use the data standard. |'."\n" + .'| codeTableUuid | String | tb-0001 | The UUID of the lookup table that defines the value range of the fields that use the data standard. |'."\n" + .'| directoryUuid | String | Directory UUID | The UUID of the directory in which the data standard is stored. |'."\n" + .'| directoryName | String | Shop directory | The name of the directory in which the data standard is stored. |'."\n" + .'| description | String | remark | The description of the data standard. |'."\n" + .'| uuid | String | obj-123456 | The UUID of the data standard. |'."\n" + .'| gmtCreate | TimeStamp | 1644397025000 | The time when the data standard was created. |'."\n" + .'| gmtModified | TimeStamp | 1644459965000 | The time when the data standard was last modified. |'."\n" + .'| creatorId | String | 0123456 | The ID of the user who created the data standard. |'."\n" + .'| creatorName | String | A, B, C, and D | The name of the user who created the data standard. |'."\n" + .'| modifierId | String | 0123456 | The ID of the user who last modified the data standard. |'."\n" + .'| modifierName | String | A, B, C, and D | The name of the user who last modified the data standard. |'."\n" + ."\n" + .'### FML statement used to query lookup tables'."\n" + ."\n" + .'show code tables; Response parameters'."\n" + ."\n" + .'| Parameter | Type | Example | Description |'."\n" + .'| ------------ | --------- | -------------- | -------------------------------------------------------- |'."\n" + .'| code | String | shop_type | The code of the lookup table. |'."\n" + .'| name | String | Shop type | The display name of the lookup table. |'."\n" + .'| extendName | String | shop type | The name of the lookup table. |'."\n" + .'| description | String | remark | The description of the lookup table. |'."\n" + .'| uuid | String | obj-123456 | The UUID of the lookup table. |'."\n" + .'| gmtCreate | TimeStamp | 1644397025000 | The time when the lookup table was created. |'."\n" + .'| gmtModified | TimeStamp | 1644459965000 | The time when the lookup table was last modified. |'."\n" + .'| creatorId | String | 0123456 | The ID of the user who created the lookup table. |'."\n" + .'| creatorName | String | A, B, C, and D | The name of the user who created the lookup table. |'."\n" + .'| modifierId | String | 0123456 | The ID of the user who last modified the lookup table. |'."\n" + .'| modifierName | String | A, B, C, and D | The name of the user who last modified the lookup table. |'."\n" + ."\n" + .'### FML statement used to query measurement unit groups'."\n" + ."\n" + .'show measure\\_unit groups; Response parameters'."\n" + ."\n" + .'| Parameter | Type | Example | Description |'."\n" + .'| ------------ | --------- | -------------- | ------------------------------------------------------------------ |'."\n" + .'| name | String | E-commerce | The name of the directory. |'."\n" + .'| detailType | String | DICT | The type of the directory. |'."\n" + .'| parentUuid | String | dy-123456 | The UUID of the parent directory. |'."\n" + .'| description | String | Description | The description of the directory. |'."\n" + .'| code | String | ind | The code of the business category. |'."\n" + .'| uuid | String | obj-123456 | The UUID of the measurement unit group. |'."\n" + .'| gmtCreate | TimeStamp | 1644397025000 | The time when the measurement unit group was created. |'."\n" + .'| gmtModified | TimeStamp | 1644459965000 | The time when the measurement unit group was last modified. |'."\n" + .'| creatorId | String | 0123456 | The ID of the user who created the measurement unit group. |'."\n" + .'| creatorName | String | A, B, C, and D | The name of the user who created the measurement unit group. |'."\n" + .'| modifierId | String | 0123456 | The ID of the user who last modified the measurement unit group. |'."\n" + .'| modifierName | String | A, B, C, and D | The name of the user who last modified the measurement unit group. |'."\n" + ."\n" + .'### FML statement used to query measurement units'."\n" + ."\n" + .'show measure\\_units; Response parameters'."\n" + ."\n" + .'| Parameter | Type | Example | Description |'."\n" + .'| ------------- | --------- | -------------- | ----------------------------------------------------------------------------- |'."\n" + .'| code | String | yuan | The abbreviation for the name of the measurement unit. |'."\n" + .'| englishName | String | RMB | The name of the measurement unit. |'."\n" + .'| name | String | Yuan | The display name of the measurement unit. |'."\n" + .'| directoryUuid | String | di-0001 | The UUID of the measurement unit group to which the measurement unit belongs. |'."\n" + .'| directoryName | String | Currency | The name of the measurement unit group to which the measurement unit belongs. |'."\n" + .'| description | String | remark | The description of the measurement unit. |'."\n" + .'| uuid | String | obj-123456 | The UUID of the measurement unit. |'."\n" + .'| gmtCreate | TimeStamp | 1644397025000 | The time when the measurement unit was created. |'."\n" + .'| gmtModified | TimeStamp | 1644459965000 | The time when the measurement unit was last modified. |'."\n" + .'| creatorId | String | 0123456 | The ID of the user who created the measurement unit. |'."\n" + .'| creatorName | String | A, B, C, and D | The name of the user who created the measurement unit. |'."\n" + .'| modifierId | String | 0123456 | The ID of the user who last modified the measurement unit. |'."\n" + .'| modifierName | String | A, B, C, and D | The name of the user who last modified the measurement unit. |'."\n" + ."\n" + .'### FML statement used to query the data of a lookup table'."\n" + ."\n" + .'show codes from code\\_table; Response parameters'."\n" + ."\n" + .'| Parameter | Type | Example | Description |'."\n" + .'| ----------------- | --------- | -------------- | -------------------------------------------------------- |'."\n" + .'| codeContent | String | 0 | The content of the lookup table. |'."\n" + .'| extendNameContent | String | female | The display name of the lookup table. |'."\n" + .'| nameContent | String | Female | The name of the lookup table. |'."\n" + .'| description | String | remark | The description of the lookup table. |'."\n" + .'| uuid | String | obj-123456 | The UUID of the lookup table. |'."\n" + .'| gmtCreate | TimeStamp | 1644397025000 | The time when the lookup table was created. |'."\n" + .'| gmtModified | TimeStamp | 1644459965000 | The time when the lookup table was last modified. |'."\n" + .'| creatorId | String | 0123456 | The ID of the user who created the lookup table. |'."\n" + .'| creatorName | String | A, B, C, and D | The name of the user who created the lookup table. |'."\n" + .'| modifierId | String | 0123456 | The ID of the user who last modified the lookup table. |'."\n" + .'| modifierName | String | A, B, C, and D | The name of the user who last modified the lookup table. |'."\n" + ."\n" + .'### FML statement used to query naming dictionaries'."\n" + ."\n" + .'show naming dicts; Response parameters'."\n" + ."\n" + .'| Parameter | Type | Example | Description |'."\n" + .'| ------------ | --------- | -------------- | ------------------------------------------------------------- |'."\n" + .'| code | String | shop | The abbreviation for the name of the naming dictionary. |'."\n" + .'| creatorId | String | 0123456 | The ID of the user who created the naming dictionary. |'."\n" + .'| creatorName | String | A, B, C, and D | The name of the user who created the naming dictionary. |'."\n" + .'| extendName | String | shop | The name of the naming dictionary. |'."\n" + .'| gmtCreate | TimeStamp | 1644397025000 | The time when the naming dictionary was created. |'."\n" + .'| gmtModified | TimeStamp | 1644459965000 | The time when the naming dictionary was last modified. |'."\n" + .'| modifierId | String | 0123456 | The ID of the user who last modified the naming dictionary. |'."\n" + .'| modifierName | String | A, B, C, and D | The name of the user who last modified the naming dictionary. |'."\n" + .'| name | String | Shop | The display name of the naming dictionary. |'."\n" + .'| ownerId | String | 0123456 | The owner ID. |'."\n" + .'| ownerName | String | A, B, C, and D | The name of the owner. |'."\n" + .'| uuid | String | obj-123456 | The UUID of the naming dictionary. |'."\n" + ."\n" + .'### FML statement used to query tables'."\n" + ."\n" + .'show tables; Response parameters'."\n" + ."\n" + .'| Parameter | Type | Example | Description |'."\n" + .'| ---------------------- | --------- | -------------- | --------------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| code | String | dim_shop | The code of the table. |'."\n" + .'| name | String | Shop table | The display name of the table. |'."\n" + .'| type | Integer | 1 | The type of the table. Valid values:0: fact table1: dimension table3: aggregate table4: application table5: ODS table6: dimension |'."\n" + .'| detailType | String | normal | The subtype of the table. Valid values:Common dimension tableEnumeration dimension tableTransaction fact table |'."\n" + .'| businessProcessUuid | String | bp-123456 | The UUID of the business process. |'."\n" + .'| businessUnitUuid | String | bu-123456 | The UUID of the business unit. |'."\n" + .'| dataWarehouseLayerUuid | String | ly-123456 | The UUID of the data layer. |'."\n" + .'| businessCategoryUuid | String | bc-123456 | The UUID of the business category. |'."\n" + .'| ownerId | String | 0123456 | The owner ID. |'."\n" + .'| ownerName | String | A, B, C, and D | The name of the owner. |'."\n" + .'| description | String | Description | The description of the table. |'."\n" + .'| config | String | JSON string | The extended configurations for the table. |'."\n" + .'| lifeCycle | Integer | 365 | The lifecycle of the table. |'."\n" + .'| uuid | String | obj-123456 | The UUID of the table. |'."\n" + .'| gmtCreate | TimeStamp | 1644397025000 | The time when the table was created. |'."\n" + .'| gmtModified | TimeStamp | 1644459965000 | The time when the table was last modified. |'."\n" + .'| creatorId | String | 0123456 | The ID of the user who created the table. |'."\n" + .'| creatorName | String | A, B, C, and D | The name of the user who created the table. |'."\n" + .'| modifierId | String | 0123456 | The ID of the user who last modified the table. |'."\n" + .'| modifierName | String | A, B, C, and D | The name of the user who last modified the table. |'."\n" + ."\n" + .'### FML statement used to query dimension tables'."\n" + ."\n" + .'show dim tables;
'."\n" + .'Response parameters'."\n" + ."\n" + .'| Parameter | Type | Example | Description |'."\n" + .'| ---------------------- | --------- | -------------- | ---------------------------------------------------------------------------------------- |'."\n" + .'| code | String | dim_shop | The code of the dimension table. |'."\n" + .'| name | String | Shop table | The display name of the dimension table. |'."\n" + .'| type | Integer | 1 | The type of the table. Valid values:0: fact table1: dimension table |'."\n" + .'| detailType | String | normal | The subtype of the table. Valid values:Common dimension tableEnumeration dimension table |'."\n" + .'| businessProcessUuid | String | bp-123456 | The UUID of the business process. |'."\n" + .'| businessUnitUuid | String | bu-123456 | The UUID of the business unit. |'."\n" + .'| dataWarehouseLayerUuid | String | ly-123456 | The UUID of the data layer. |'."\n" + .'| businessCategoryUuid | String | bc-123456 | The UUID of the business category. |'."\n" + .'| ownerId | String | 0123456 | The owner ID. |'."\n" + .'| ownerName | String | A, B, C, and D | The name of the owner. |'."\n" + .'| description | String | Description | The description of the dimension table. |'."\n" + .'| config | String | JSON string | The extended configurations for the dimension table. |'."\n" + .'| lifeCycle | Integer | 365 | The lifecycle of the dimension table. |'."\n" + .'| uuid | String | obj-123456 | The UUID of the dimension table. |'."\n" + .'| gmtCreate | TimeStamp | 1644397025000 | The time when the dimension table was created. |'."\n" + .'| gmtModified | TimeStamp | 1644459965000 | The time when the dimension table was last modified. |'."\n" + .'| creatorId | String | 0123456 | The ID of the user who created the dimension table. |'."\n" + .'| creatorName | String | A, B, C, and D | The name of the user who created the dimension table. |'."\n" + .'| modifierId | String | 0123456 | The ID of the user who last modified the dimension table. |'."\n" + .'| modifierName | String | A, B, C, and D | The name of the user who last modified the dimension table. |'."\n" + ."\n" + .'### FML statement used to query fact tables'."\n" + ."\n" + .'show fact tables; Response parameters'."\n" + ."\n" + .'| Parameter | Type | Example | Description |'."\n" + .'| ---------------------- | --------- | -------------- | --------------------------------------------------------------------- |'."\n" + .'| code | String | dim_shop | The code of the fact table. |'."\n" + .'| name | String | Shop table | The display name of the fact table. |'."\n" + .'| type | Integer | 1 | The type of the table. Valid values:0: fact table1: dimension table |'."\n" + .'| detailType | String | normal | The subtype of the table. Only transaction fact tables are supported. |'."\n" + .'| businessProcessUuid | String | bp-123456 | The UUID of the business process. |'."\n" + .'| businessUnitUuid | String | bu-123456 | The UUID of the business unit. |'."\n" + .'| dataWarehouseLayerUuid | String | ly-123456 | The UUID of the data layer. |'."\n" + .'| businessCategoryUuid | String | bc-123456 | The UUID of the business category. |'."\n" + .'| ownerId | String | 0123456 | The owner ID. |'."\n" + .'| ownerName | String | A, B, C, and D | The name of the owner. |'."\n" + .'| description | String | Description | The description of the fact table. |'."\n" + .'| config | String | JSON string | The extended configurations for the fact table. |'."\n" + .'| lifeCycle | Integer | 365 | The lifecycle of the fact table. |'."\n" + .'| uuid | String | obj-123456 | The UUID of the fact table. |'."\n" + .'| gmtCreate | TimeStamp | 1644397025000 | The time when the fact table was created. |'."\n" + .'| gmtModified | TimeStamp | 1644459965000 | The time when the fact table was last modified. |'."\n" + .'| creatorId | String | 0123456 | The ID of the user who created the fact table. |'."\n" + .'| creatorName | String | A, B, C, and D | The name of the user who created the fact table. |'."\n" + .'| modifierId | String | 0123456 | The ID of the user who last modified the fact table. |'."\n" + .'| modifierName | String | A, B, C, and D | The name of the user who last modified the fact table. |'."\n" + ."\n" + .'### FML statement used to query aggregate tables'."\n" + ."\n" + .'show dws tables; Response parameters'."\n" + ."\n" + .'| Parameter | Type | Example | Description |'."\n" + .'| ---------------------- | --------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |'."\n" + .'| dataDomainUuid | String | dm-12345 | The UUID of the data domain. |'."\n" + .'| dataDomainCode | String | member | The code of the data domain. |'."\n" + .'| dataDomainName | String | Member | The name of the data domain. |'."\n" + .'| timePeriods | List | \\[{"uuid": "uuid", "code": "code", "name": "Display name"}] | The periods for the aggregate table. |'."\n" + .'| uuid | String | obj-123456 | The UUID of the aggregate table. |'."\n" + .'| code | String | dws_001 | The name of the aggregate table. |'."\n" + .'| name | String | Payment aggregate table | The display name of the aggregate table. |'."\n" + .'| adjuncts | List | \\[{"uuid": "uuid", "code": "code", "name": "Display name"}] | The modifiers for the aggregate table. |'."\n" + .'| dimensions | List | \\[{"uuid": "uuid", "code": "code", "name": "Display name"}] | The dimensions that are associated with the aggregate table. |'."\n" + .'| bizEntityUuid | String | dim-123456 | The UUID of the business object. |'."\n" + .'| bizEntityCode | String | dim_shop | The abbreviation for the name of the business object. |'."\n" + .'| bizEntityName | String | Shop table | The display name of the business object. |'."\n" + .'| relUuid | String | dim_a-123456 | The UUID of the dimension that is associated with the aggregate table. |'."\n" + .'| type | Integer | 3 | The type of the table. Only 3 (aggregate table) is supported. |'."\n" + .'| detailType | String | dws_normal | The subtype of the table. Valid values:dws_normal: single-granularity aggregate tabledws_advanced: multi-granularity aggregate table |'."\n" + .'| businessProcessUuid | String | bp-123456 | The UUID of the business process. |'."\n" + .'| businessUnitUuid | String | bu-123456 | The UUID of the business unit. |'."\n" + .'| dataWarehouseLayerUuid | String | ly-123456 | The UUID of the data layer. |'."\n" + .'| businessCategoryUuid | String | bc-123456 | The UUID of the business category. |'."\n" + .'| ownerId | String | 0123456 | The owner ID. |'."\n" + .'| ownerName | String | A, B, C, and D | The name of the owner. |'."\n" + .'| description | String | Description | The description of the aggregate table. |'."\n" + .'| config | String | JSON string | The extended configurations for the aggregate table. |'."\n" + .'| lifeCycle | Integer | 365 | The lifecycle of the aggregate table. |'."\n" + .'| gmtCreate | TimeStamp | 1644397025000 | The time when the aggregate table was created. |'."\n" + .'| gmtModified | TimeStamp | 1644459965000 | The time when the aggregate table was last modified. |'."\n" + .'| creatorId | String | 0123456 | The ID of the user who created the aggregate table. |'."\n" + .'| creatorName | String | A, B, C, and D | The name of the user who created the aggregate table. |'."\n" + .'| modifierId | String | 0123456 | The ID of the user who last modified the aggregate table. |'."\n" + .'| modifierName | String | A, B, C, and D | The name of the user who last modified the aggregate table. |'."\n" + ."\n" + .'### FML statement used to query application tables'."\n" + ."\n" + .'show ads tables; Response parameters'."\n" + ."\n" + .'| Parameter | Type | Example | Description |'."\n" + .'| ---------------------- | --------- | ----------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |'."\n" + .'| dataDomainUuid | String | dm-12345 | The UUID of the data domain. |'."\n" + .'| dataDomainCode | String | member | The code of the data domain. |'."\n" + .'| dataDomainName | String | Member | The name of the data domain. |'."\n" + .'| timePeriods | List | \\[{"uuid": "uuid", "code": "code", "name": "Display name"}] | The periods for the application table. |'."\n" + .'| uuid | String | obj-123456 | The UUID of the application table. |'."\n" + .'| code | String | dws_001 | The name of the application table. |'."\n" + .'| name | String | Payment application table | The display name of the application table. |'."\n" + .'| adjuncts | List | \\[{"uuid": "uuid", "code": "code", "name": "Display name"}] | The modifiers for the application table. |'."\n" + .'| dimensions | List | \\[{"uuid": "uuid", "code": "code", "name": "Display name"}] | The dimensions that are associated with the application table. |'."\n" + .'| bizEntityUuid | String | dim-123456 | The UUID of the business object. |'."\n" + .'| bizEntityCode | String | dim_shop | The abbreviation for the name of the business object. |'."\n" + .'| bizEntityName | String | Shop table | The display name of the business object. |'."\n" + .'| relUuid | String | dim_a-123456 | The UUID of the dimension that is associated with the application table. |'."\n" + .'| type | Integer | 1 | The type of the table. Valid values:0: fact table1: dimension table4: application table |'."\n" + .'| detailType | String | normal | The subtype of the table. Valid values:Common dimension tableEnumeration dimension tableTransaction fact table |'."\n" + .'| businessProcessUuid | String | bp-123456 | The UUID of the business process. |'."\n" + .'| businessUnitUuid | String | bu-123456 | The UUID of the business unit. |'."\n" + .'| dataWarehouseLayerUuid | String | ly-123456 | The UUID of the data layer. |'."\n" + .'| businessCategoryUuid | String | bc-123456 | The UUID of the business category. |'."\n" + .'| ownerId | String | 0123456 | The owner ID. |'."\n" + .'| ownerName | String | A, B, C, and D | The name of the owner. |'."\n" + .'| description | String | Description | The description of the application table. |'."\n" + .'| config | String | JSON string | The extended configurations for the application table. |'."\n" + .'| lifeCycle | Integer | 365 | The lifecycle of the application table. |'."\n" + .'| gmtCreate | TimeStamp | 1644397025000 | The time when the application table was created. |'."\n" + .'| gmtModified | TimeStamp | 1644459965000 | The time when the application table was last modified. |'."\n" + .'| creatorId | String | 0123456 | The ID of the user who created the application table. |'."\n" + .'| creatorName | String | A, B, C, and D | The name of the user who created the application table. |'."\n" + .'| modifierId | String | 0123456 | The ID of the user who last modified the application table. |'."\n" + .'| modifierName | String | A, B, C, and D | The name of the user who last modified the application table. |'."\n" + ."\n" + .'### FML statement used to query tables and return the fields of each table'."\n" + ."\n" + .'show full tables; Response parameters'."\n" + ."\n" + .'| Parameter | Type | Example | Description |'."\n" + .'| -------------- | ------ | ---------- | ---------------------------- |'."\n" + .'| tableUuid | String | tb-123456 | The UUID of the table. |'."\n" + .'| tableCode | String | dim_shop | The code of the table. |'."\n" + .'| tableName | String | Shop table | The name of the table. |'."\n" + .'| columnCode | String | shop_id | The code of the column. |'."\n" + .'| columnName | String | Shop ID | The name of the column. |'."\n" + .'| columnUuid | String | col-123456 | The UUID of the column. |'."\n" + .'| columnType | String | STRING | The data type of the column. |'."\n" + .'| columnCategory | String | ATTRIBUTE | The type of the column. |'."\n" + ."\n" + .'### FML statement used to query information about the columns of a table'."\n" + ."\n" + .'show columns from table\\_code; Response parameters'."\n" + ."\n" + .'| Parameter | Type | Example | Description |'."\n" + .'| ------------------ | --------- | -------------- | ------------------------------------------------------ |'."\n" + .'| code | String | seller_id | The code of the column. |'."\n" + .'| name | String | Seller ID | The display name of the column. |'."\n" + .'| dataType | String | STRING | The data type of the column. |'."\n" + .'| type | String | ATTRIBUTE | The type of the field. |'."\n" + .'| isPrimaryKey | Boolean | false | Indicates whether the field is a primary key column. |'."\n" + .'| isPartitionKey | Boolean | false | Indicates whether the field is a partition key column. |'."\n" + .'| partitionOrder | Integer | 1 | The order of the partition key column. |'."\n" + .'| notNull | Boolean | true | Indicates whether the field is non-null. |'."\n" + .'| dataDictionaryUuid | String | member_id | The UUID of the data dictionary. |'."\n" + .'| dataDictionaryCode | String | Member ID | The name of the data dictionary. |'."\n" + .'| codeTableUuid | String | cd-123456 | The UUID of the associated lookup table. |'."\n" + .'| codeTableCode | String | sex | The code of the associated lookup table. |'."\n" + .'| codeTableName | String | Gender | The name of the associated lookup table. |'."\n" + .'| measureUnitCode | String | percent | The code of the associated measurement unit. |'."\n" + .'| measureUnitName | String | Percent | The name of the associated measurement unit. |'."\n" + .'| sourceProjectName | String | autotest | The name of the source workspace. |'."\n" + .'| sourceTableCode | String | dict | The code of the source table. |'."\n" + .'| sourceColumnCode | String | age | The code of the source field. |'."\n" + .'| sourceRelationTag | String | label | The tag of the source relationship. |'."\n" + .'| description | String | Description | The description of the field. |'."\n" + .'| orderId | String | 1 | The order of the field. |'."\n" + .'| columnGroupName | Integer | col_group_1 | The name of the group to which the field belongs. |'."\n" + .'| config | String | JSON string | The extended configurations for the field. |'."\n" + .'| uuid | String | obj-123456 | The UUID of the field. |'."\n" + .'| gmtCreate | TimeStamp | 1644397025000 | The time when the field was created. |'."\n" + .'| gmtModified | TimeStamp | 1644459965000 | The time when the field was last modified. |'."\n" + .'| creatorId | String | 0123456 | The ID of the user who created the field. |'."\n" + .'| creatorName | String | A, B, C, and D | The name of the user who created the field. |'."\n" + .'| modifierId | String | 0123456 | The ID of the user who last modified the field. |'."\n" + .'| modifierName | String | A, B, C, and D | The name of the user who last modified the field. |'."\n" + ."\n" + .'### FML statement used to query modifiers'."\n" + ."\n" + .'show adjuncts; Response parameters'."\n" + ."\n" + .'| Parameter | Type | Example | Description |'."\n" + .'| ---------------- | --------------- | --------------------- | --------------------------------------------------------------- |'."\n" + .'| businessUnitUuid | String | bu-123456 | The UUID of the business unit. |'."\n" + .'| businessUnitCode | String | test_bu | The code of the business unit. |'."\n" + .'| businessUnitName | String | Test | The name of the business unit. |'."\n" + .'| dataDomainUuid | String | dt-123456 | The UUID of the data domain. |'."\n" + .'| dataDomainCode | String | member | The code of the data domain. |'."\n" + .'| dataDomainName | String | Member | The name of the data domain. |'."\n" + .'| categoryUuid | String | cy-123456 | The UUID of the business category. |'."\n" + .'| categoryCode | String | trade | The code of the business category. |'."\n" + .'| categoryName | String | E-commerce | The name of the business category. |'."\n" + .'| type | AdjunctTypeEnum | DIM_VAL | The type of the modifier. |'."\n" + .'| code | String | beauty | The abbreviation for the name of the modifier. |'."\n" + .'| name | String | Makeup | The display name of the modifier. |'."\n" + .'| extendName | String | beauty | The name of the modifier. |'."\n" + .'| description | String | Description | The description of the modifier. |'."\n" + .'| bizExpression | String | Statistical criterion | The statistical criterion of the modifier. |'."\n" + .'| expression | String | beauty = 1 | The expression of the modifier. |'."\n" + .'| bizEntityUuid | String | dim-123456 | The UUID of the business object. |'."\n" + .'| bizEntityCode | String | dim_shop | The abbreviation for the name of the business object. |'."\n" + .'| bizEntityName | String | Shop table | The display name of the business object. |'."\n" + .'| relUuid | String | dim_a-123456 | The UUID of the dimension that is associated with the modifier. |'."\n" + .'| ownerId | String | 0123456 | The owner ID. |'."\n" + .'| ownerName | String | A, B, C, and D | The name of the owner. |'."\n" + .'| isDeleted | DeleteTagEnum | NO | Indicates whether the modifier is deleted. |'."\n" + .'| uuid | String | obj-123456 | The UUID of the modifier. |'."\n" + .'| gmtCreate | TimeStamp | 1644397025000 | The time when the modifier was created. |'."\n" + .'| gmtModified | TimeStamp | 1644459965000 | The time when the modifier was last modified. |'."\n" + .'| creatorId | String | 0123456 | The ID of the user who created the modifier. |'."\n" + .'| creatorName | String | A, B, C, and D | The name of the user who created the modifier. |'."\n" + .'| modifierId | String | 0123456 | The ID of the user who last modified the modifier. |'."\n" + .'| modifierName | String | A, B, C, and D | The name of the user who last modified the modifier. |'."\n" + ."\n" + .'### FML statement used to query periods'."\n" + ."\n" + .'show time\\_periods; Response parameters'."\n" + ."\n" + .'| Parameter | Type | Example | Description |'."\n" + .'| ---------------- | ------------------ | ---------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| businessUnitUuid | String | bu-123456 | The UUID of the business unit to which the period belongs. |'."\n" + .'| businessUnitCode | String | test_bu | The code of the business unit. |'."\n" + .'| type | TimePeriodTypeEnum | DAY | The type of the period. |'."\n" + .'| typeName | String | Day | The name of the type of the period. |'."\n" + .'| code | String | 1d | The abbreviation for the name of the period. |'."\n" + .'| name | String | One day | The display name of the period. |'."\n" + .'| extendName | String | 1d | The name of the period. |'."\n" + .'| description | String | Description | The description of the period. |'."\n" + .'| isDeleted | DeleteTagEnum | NO | Indicates whether the period is deleted. |'."\n" + .'| timeBegin | String | start_expression | The expression for the start time. |'."\n" + .'| timeEnd | String | end_expression | The expression for the end time. |'."\n" + .'| gmtCreate | TimeStamp | 1633885261000 | The time when the period was created. |'."\n" + .'| gmtModified | TimeStamp | 1633885261000 | The time when the period was last modified. |'."\n" + .'| modifierId | String | 0123456 | The ID of the user who last modified the period. |'."\n" + .'| modifierName | String | A, B, C, and D | The name of the user who last modified the period. |'."\n" + .'| ownerId | String | 0123456 | The owner ID. |'."\n" + .'| ownerName | String | A, B, C, and D | The name of the owner. |'."\n" + .'| beginOffset | Integer | 1 | The offset of the start time. |'."\n" + .'| endOffset | Integer | 1 | The offset of the end time. |'."\n" + .'| firstDay | Integer | 1 | The first day of the period. This parameter is returned if the type of the period is set to WEEK, MONTH, QUARTER, or YEAR. Valid values if the type of the period is set to WEEK: 1 to 7, which indicate Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, and Saturday. Valid values if the type of the period is set to MONTH: 1, 99, and 2 to 27. The value 1 indicates the first day of the month, the value 99 indicates the end of the month, and values from 2 to 27 indicate the 2nd to 27th days of the month. Valid values if the type of the period is set to QUARTER: 0 to 11, which indicate January to December. Valid values if the type of the period is set to YEAR: 0 to 11, which indicate January to December. |'."\n" + .'| uuid | String | obj-123456 | The UUID of the period. |'."\n" + .'| creatorId | String | 0123456 | The ID of the user who created the period. |'."\n" + .'| creatorName | String | A, B, C, and D | The name of the user who created the period. |'."\n" + ."\n" + .'### FML statement used to query atomic metrics'."\n" + ."\n" + .'show atomic indicators; Response parameters'."\n" + ."\n" + .'| Parameter | Type | Example | Description |'."\n" + .'| ------------------- | ---------------- | ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| dataDistinct | YesOrNoEnum | YES | Indicates whether duplicate data is removed during statistics collection. Valid values:YESNO |'."\n" + .'| aggFunctionType | AggFunctionEnum | SUM | The type of the function for the atomic metric. Valid values:SUMCOUNTAVGMAXMINRATERANKUNDEFINED |'."\n" + .'| calExpression | String | price | The expression of the atomic metric. |'."\n" + .'| dataType | DataTypeNameEnum | TINYINT | The type of data that can be collected by the atomic metric. Valid values: TINYINT, SMALLINT, INT, BIGINT, BINARY, FLOAT, DOUBLE, DECIMAL, VARCHAR, CHAR, STRING, DATE, DATETIME, TIMESTAMP, BOOLEAN, ARRAY, MAP, STRUCT, and JSON |'."\n" + .'| dataRound | String | N | The number of decimal places after the decimal point. Valid values:NM |'."\n" + .'| dataUnitUuid | String | du-123456 | The UUID of the metric unit. |'."\n" + .'| dataUnitCode | String | percent | The code of the metric unit. |'."\n" + .'| dataUnitName | String | Fen | The name of the metric unit. |'."\n" + .'| bizExpression | String | Aggregation of payment amount | The statistical criterion. |'."\n" + .'| dataRollUpType | String | AGG_FUNCTION | The method of the data roll-up. Valid values:AGG_FUNCTIONSUM_THEN_RATERATE_THEN_AVGNOT_SUPPORT |'."\n" + .'| businessUnitUuid | String | bu-0001 | The UUID of the business unit. |'."\n" + .'| businessUnitCode | String | project_code | The code of the business unit. |'."\n" + .'| businessProcessUuid | String | di-0002 | The UUID of the business process. |'."\n" + .'| businessProcessCode | String | pay | The code of the business process. |'."\n" + .'| businessProcessName | String | Payment | The name of the business process. |'."\n" + .'| dataDomainUuid | String | di-0003 | The UUID of the data domain. |'."\n" + .'| dataDomainCode | String | trd | The code of the data domain. |'."\n" + .'| dataDomainName | String | Transaction | The name of the data domain. |'."\n" + .'| categoryUuid | String | di-0001 | The UUID of the business category. |'."\n" + .'| categoryCode | String | tb | The code of the business category. |'."\n" + .'| categoryName | String | Taobao | The name of the business category. |'."\n" + .'| type | String | ATOMIC | The type of the metric. Valid values:ATOMICDERIVATIVEDERIVATIVE_COMPOSITE |'."\n" + .'| code | String | pay_amt | The abbreviation for the name of the atomic metric. |'."\n" + .'| name | String | Payment amount | The display name of the atomic metric. |'."\n" + .'| extendName | String | pay amount | The name of the atomic metric. |'."\n" + .'| description | String | remark | The description of the atomic metric. |'."\n" + .'| status | String | NORMAL | The status of the atomic metric. Valid values:DRAFTDEVNORMAL |'."\n" + .'| ownerId | String | 0001 | The owner ID. |'."\n" + .'| ownerName | String | Owner name | The name of the owner. |'."\n" + .'| isDeleted | DeleteTagEnum | NO | Indicates whether the atomic metric is deleted. Valid values:YESNO |'."\n" + .'| uuid | String | obj-123456 | The UUID of the atomic metric. |'."\n" + .'| gmtCreate | TimeStamp | 1644397025000 | The time when the atomic metric was created. |'."\n" + .'| gmtModified | TimeStamp | 1644459965000 | The time when the atomic metric was last modified. |'."\n" + .'| creatorId | String | 0123456 | The ID of the user who created the atomic metric. |'."\n" + .'| creatorName | String | A, B, C, and D | The name of the user who created the atomic metric. |'."\n" + .'| modifierId | String | 0123456 | The ID of the user who last modified the atomic metric. |'."\n" + .'| modifierName | String | A, B, C, and D | The name of the user who last modified the atomic metric. |'."\n" + ."\n" + .'### FML statement used to query derived metrics'."\n" + ."\n" + .'show derivative indicators; Response parameters'."\n" + ."\n" + .'| Parameter | Type | Example | Description |'."\n" + .'| ------------------- | ------------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| timePeriodUuid | String | tp-0001 | The UUID of the period. |'."\n" + .'| timePeriodCode | String | 1d | The abbreviation for the name of the period. |'."\n" + .'| timePeriodName | String | Last day | The display name of the period. |'."\n" + .'| adjunctUuids | List | \\["adj-001"] | The UUIDs of modifiers. |'."\n" + .'| adjunctCodes | List | \\["male"] | The abbreviations for the names of modifiers. |'."\n" + .'| adjunctNames | List | Male | The display names of modifiers. |'."\n" + .'| atomicIndicatorUuid | String | ind-a-0001 | The UUID of the atomic metric. |'."\n" + .'| atomicIndicatorCode | String | pay_amt | The abbreviation for the name of the atomic metric. |'."\n" + .'| atomicIndicatorName | String | Payment amount | The display name of the atomic metric. |'."\n" + .'| dataType | DataTypeNameEnum | BIGINT | The type of data that can be collected by the derived metric. Valid values: TINYINT, SMALLINT, INT, BIGINT, BINARY, FLOAT, DOUBLE, DECIMAL, VARCHAR, CHAR, STRING, DATE, DATETIME, TIMESTAMP, BOOLEAN, ARRAY, MAP, STRUCT, and JSON |'."\n" + .'| bizEntityUuid | String | dim-123456 | The UUID of the business object. |'."\n" + .'| bizEntityCode | String | dim_shop | The abbreviation for the name of the business object. |'."\n" + .'| bizEntityName | String | Shop table | The display name of the business object. |'."\n" + .'| relUuid | String | dim_a-123456 | The UUID of the dimension that is associated with the derived metric. |'."\n" + .'| indHash | String | hash-0001 | The hash value for the elements of the derived metric. |'."\n" + .'| suggestCode | String | pay_amt_1d | The recommended code that is used by the derived metric. |'."\n" + .'| businessUnitUuid | String | bu-0001 | The UUID of the business unit. |'."\n" + .'| businessUnitCode | String | project_code | The code of the business unit. |'."\n" + .'| businessProcessUuid | String | di-0002 | The UUID of the business process. |'."\n" + .'| businessProcessCode | String | pay | The code of the business process. |'."\n" + .'| businessProcessName | String | Payment | The name of the business process. |'."\n" + .'| dataDomainUuid | String | di-0003 | The UUID of the data domain. |'."\n" + .'| dataDomainCode | String | trd | The code of the data domain. |'."\n" + .'| dataDomainName | String | Transaction | The name of the data domain. |'."\n" + .'| categoryUuid | String | di-0001 | The UUID of the business category. |'."\n" + .'| categoryCode | String | tb | The code of the business category. |'."\n" + .'| categoryName | String | Taobao | The name of the business category. |'."\n" + .'| type | IndicatorTypeEnum | ATOMIC | The type of the metric. Valid values:ATOMICDERIVATIVEDERIVATIVE_COMPOSITE |'."\n" + .'| code | String | pay_amt | The abbreviation for the name of the derived metric. |'."\n" + .'| name | String | Payment amount | The display name of the derived metric. |'."\n" + .'| extendName | String | pay amount | The name of the derived metric. |'."\n" + .'| description | String | remark | The description of the derived metric. |'."\n" + .'| status | IndicatorStatusEnum | NORMAL | The status of the derived metric. Valid values:DRAFTDEVNORMAL |'."\n" + .'| ownerId | String | 0001 | The owner ID. |'."\n" + .'| ownerName | String | Owner name | The name of the owner. |'."\n" + .'| isDeleted | DeleteTagEnum | NO | Indicates whether the derived metric is deleted. Valid values:YESNO |'."\n" + .'| uuid | String | obj-123456 | The UUID of the derived metric. |'."\n" + .'| gmtCreate | TimeStamp | 1644397025000 | The time when the derived metric was created. |'."\n" + .'| gmtModified | TimeStamp | 1644459965000 | The time when the derived metric was last modified. |'."\n" + .'| creatorId | String | 0123456 | The ID of the user who created the derived metric. |'."\n" + .'| creatorName | String | A, B, C, and D | The name of the user who created the derived metric. |'."\n" + .'| modifierId | String | 0123456 | The ID of the user who last modified the derived metric. |'."\n" + .'| modifierName | String | A, B, C, and D | The name of the user who last modified the derived metric. |'."\n" + ."\n" + .'### FML statement used to query composite metrics'."\n" + ."\n" + .'show derivative composite indicators; Response parameters'."\n" + ."\n" + .'| Parameter | Type | Example | Description |'."\n" + .'| ----------------------- | ------------- | --------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| businessUnitCode | String | project_code | The name of the workspace. |'."\n" + .'| businessProcessUuid | String | di-0002 | The UUID of the business process. |'."\n" + .'| businessProcessCode | String | pay | The code of the business process. |'."\n" + .'| businessProcessName | String | Payment | The name of the business process. |'."\n" + .'| dataDomainUuid | String | di-0003 | The UUID of the data domain. |'."\n" + .'| dataDomainCode | String | trd | The code of the data domain. |'."\n" + .'| dataDomainName | String | Transaction | The name of the data domain. |'."\n" + .'| categoryUuid | String | di-0001 | The UUID of the business category. |'."\n" + .'| categoryCode | String | tb | The code of the business category. |'."\n" + .'| categoryName | String | Taobao | The name of the business category. |'."\n" + .'| type | String | DERIVATIVE_COMPOSITE | The computing logic. Valid values: DERIVATIVE_COMPOSITE and DERIVATIVE_COMPARISON. The value DERIVATIVE_COMPOSITE indicates a calculation expression. The value DERIVATIVE_COMPARISON indicates comparison. |'."\n" + .'| code | String | pay_amt | The abbreviation for the name of the composite metric. |'."\n" + .'| name | String | Payment amount | The display name of the composite metric. |'."\n" + .'| extendName | String | pay amount | The name of the composite metric. |'."\n" + .'| description | String | remark | The description of the composite metric. |'."\n" + .'| calculateExpression | String | {@pay_amt_1d[Last day_Payment amount]}/{@pay_amt_1m[Last 30 days_Payment amount]} | The calculation expression. |'."\n" + .'| comparisonPeriodType | String | DAY_MOM | The comparison type. Valid values: DAY_MOM, WEEK_MOM, WEEK_YOY, MONTH_MOM, MONTH_YOY, QUARTER_MOM, YEAR_MOM, and YEAR_YOY. |'."\n" + .'| comparisonIndicatorUuid | String | obj-123456 | The UUID of the composite metric that is used for comparison. |'."\n" + .'| comparisonIndicatorCode | String | pay_amt_1d | The abbreviation for the name of the composite metric that is used for comparison. |'."\n" + .'| comparisonIndicatorName | String | Last day_Payment amount | The display name of the composite metric that is used for comparison. |'."\n" + .'| ownerId | String | 0001 | The ID of the owner of the composite metric. |'."\n" + .'| ownerName | String | Bob | The name of the owner of the composite metric. |'."\n" + .'| isDeleted | DeleteTagEnum | NO | Indicates whether the composite metric is deleted. Valid values: YES and NO. |'."\n" + .'| uuid | String | obj-123456 | The UUID of the composite metric. |'."\n" + .'| gmtCreate | TimeStamp | 1644397025000 | The time when the composite metric was created. |'."\n" + .'| gmtModified | TimeStamp | 1644459965000 | The time when the composite metric was last modified. |'."\n" + .'| creatorId | String | 0123456 | The ID of the user who created the composite metric. |'."\n" + .'| creatorName | String | A, B, C, and D | The name of the user who created the composite metric. |'."\n" + .'| modifierId | String | 0123456 | The ID of the user who last modified the composite metric. |'."\n" + .'| modifierName | String | A, B, C, and D | The name of the user who last modified the composite metric. |'."\n" + ."\n" + .'### FML statement used to query information about the model on which a single metric depends'."\n" + ."\n" + .'show statistic indicator table\\_code; Response parameters'."\n" + ."\n" + .'| Parameter | Type | Example | Description |'."\n" + .'| ---------- | ------ | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| uuid | String | obj-123456 | The UUID of the metric. |'."\n" + .'| code | String | pay_amt | The abbreviation for the name of the metric. |'."\n" + .'| name | String | Payment amount | The display name of the metric. |'."\n" + .'| extendName | String | pay amount | The name of the metric. |'."\n" + .'| relations | List | Example | The information about the model on which the metric depends. You can view the following code and table to obtain the structure of the EntityInfo parameter. |'."\n" + ."\n" + .'Sample structure and description of the EntityInfo parameter'."\n" + ."\n" + .'```'."\n" + .'['."\n" + .' {'."\n" + .' "uuid": "uuid",'."\n" + .' "code": "code",'."\n" + .' "name": "Display name",'."\n" + .' "extendName": "full name in English",'."\n" + .' "entityType": "EntityTypeEnum.BASE_DERIVATIVE_INDICATOR",'."\n" + .' "entityTypeName": "Entity type name",'."\n" + .' "entitySubType": "DERIVATIVE_INDICATOR",'."\n" + .' "entitySubTypeName": "Entity subtype name",'."\n" + .' "ownerId": "0001",'."\n" + .' "ownerName": "Owner name"'."\n" + .' }'."\n" + .']'."\n" + .'```'."\n" + ."\n" + .'| Parameter | Type | Example | Description |'."\n" + .'| ----------------- | -------------- | ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| uuid | String | obj-123456 | The UUID of the model. |'."\n" + .'| code | String | dws_001 | The abbreviation for the name of the model. |'."\n" + .'| name | String | Payment aggregate table | The display name of the model. |'."\n" + .'| extendName | String | dws_001 | The name of the model. |'."\n" + .'| entityType | EntityTypeEnum | Table | The entity type of the metric. The values of this parameter include but are not limited to `TABLE, BASE_ATOMIC_INDICATOR, and BASE_DERIVATIVE_INDICATOR`. |'."\n" + .'| entityTypeName | String | Table | The type name of the entity. |'."\n" + .'| entitySubType | String | DWS_TABLE | The subtype of the entity. The values of this parameter include but are not limited to `DWS_TABLE, ATOMIC_INDICATOR, and DERIVATIVE_INDICATOR`. |'."\n" + .'| entitySubTypeName | String | Aggregate table | The subtype name of the entity. |'."\n" + .'| ownerId | String | 0001 | The owner ID. |'."\n" + .'| ownerName | String | Bob | The name of the owner. |', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2021-11-16T12:03:32.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1029030003\\",\\n \\"ErrorMessage\\": \\"param error\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": [\\n \\"test_role\\"\\n ],\\n \\"RequestId\\": \\"102400001\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 1029030003\\n param error\\n 400\\n test_role\\n 102400001\\n","errorExample":""}]', - 'title' => 'DsgUserGroupGetOdpsRoleGroups', - 'summary' => 'Queries a list of MaxCompute roles that can be selected by the members of a user group when the user group is created or modified by the tenant in Data Security Guard.', + 'ramActions' => [], ], - 'DsgDesensPlanAddOrUpdate' => [ - 'summary' => 'Adds or modifies a data masking rule.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'QueryRecognizeDataByRuleType' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -53349,442 +33487,77 @@ ], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '219759', - 'abilityTreeNodes' => [ - 'FEATUREdideRZM9W6', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '212273', + 'abilityTreeNodes' => ['FEATUREdideDCM5VK'], ], 'parameters' => [ [ - 'name' => 'DesensRules', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'A collection of data masking rules that you want to add or modify.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the data masking rule. You can call the [DsgDesensPlanQueryList](~~2786578~~) operation to query the ID of the data masking rule.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '123', - ], - 'DataType' => [ - 'description' => 'The sensitive field type.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'phone', - ], - 'RuleName' => [ - 'description' => 'The name of the data masking rule.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'phone_hash', - ], - 'Status' => [ - 'description' => 'The status of the data masking rule. Valid values:'."\n" - ."\n" - .'* 0: expired'."\n" - .'* 1: effective'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'SceneIds' => [ - 'description' => 'The level-2 data masking scenario.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the level-2 data masking scenario. Make sure that the data masking rule in which the sensitive field type determined by the DataType parameter is specified is not configured for the level-2 data masking scenario that you use. You can call the [DsgSceneQuerySceneListByName](~~2786322~~) to query the ID of the data masking scenario.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '123', - ], - 'required' => true, - ], - 'Owner' => [ - 'description' => 'The owner of the data masking rule.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test_user', - ], - 'CheckWatermark' => [ - 'description' => 'Specifies whether to add a watermark. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'DesensPlan' => [ - 'description' => 'The data masking rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'DesensPlanType' => [ - 'description' => 'The masking method configured in the data masking rule. Valid values:'."\n" - ."\n" - .'* hash'."\n" - .'* mapping'."\n" - .'* mask'."\n" - .'* charreplacement'."\n" - .'* intervalselect'."\n" - .'* decimalpoint'."\n" - .'* emptydesens'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'hash', - ], - 'ExtParam' => [ - 'description' => 'The parameters for the data masking rule.'."\n", - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'any', - 'description' => 'The parameter configurations of the data masking rule. You can add different parameters based on the data masking rule that you want to configure. For more information, see the following example.'."\n", - 'example' => '{ "algo": "MD5", "salt":6 }', - ], - ], - ], - 'required' => true, - ], - ], - 'required' => false, - ], - 'required' => true, - ], + 'name' => 'RecognizeRulesType', + 'in' => 'formData', + 'schema' => ['description' => 'The type of a sensitive data identification rule. You can call the [QueryRecognizeRulesType](~~2746905~~) operation to obtain the type of the rule.'."\n" + ."\n" + .'* 1: regular expression'."\n" + .'* 2: built-in rule'."\n" + .'* 3: sample library'."\n" + .'* 4: self-generated data identification model'."\n", 'type' => 'string', 'required' => true, 'example' => '2'], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n", 'type' => 'string', 'required' => true, 'example' => '10241024'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'OpenApiResultModel', - 'description' => 'OpenApiResultModel'."\n", + 'title' => 'DataWorksResult', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '1029030003', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'param error', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - ], - 'Data' => [ - 'description' => 'The execution result of adding or modifying a data masking rule.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => '102400001', - ], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '9990030003'], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'Missing parameter'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], + 'Data' => ['description' => 'The returned result in the JSON format.'."\n", 'type' => 'any', 'example' => '[{"custom": false, "name": "EducationDegree", "localeName": "EducationDegree", "templateJsonStr": "{"_clazz":"com.alipay.dsgclient.sdk.dsg.fastscan.engine.cond.EducationDegreeCond"}", "desc": ""}]'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'RequestId' => ['description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", 'type' => 'string', 'example' => '10000001'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'PARAMS.ERROR', - 'errorMessage' => 'param error.', - ], - [ - 'errorCode' => 'DESENSPLAN.DATATYPE.ERROR', - 'errorMessage' => 'Sensitive type already has a desensitization rule.', - ], - [ - 'errorCode' => 'DESENSPLAN.DATATYPENOTEXIST.ERROR', - 'errorMessage' => 'Sensitive type not exist.', - ], - [ - 'errorCode' => 'DESENSPLAN.ID.ERROR', - 'errorMessage' => 'Desensitization rule ID does not exist.', - ], - [ - 'errorCode' => 'DESENSPLAN.PAGESIZE.ERROR', - 'errorMessage' => 'Page size is too large, maximum of 100.', - ], - [ - 'errorCode' => 'DESENSPLAN.PARAM.ERROR', - 'errorMessage' => 'Desensitization rule parameter error.', - ], - [ - 'errorCode' => 'DESENSPLAN.SCENECODE.ERROR', - 'errorMessage' => 'Scene code does not exist.', - ], - [ - 'errorCode' => 'DESENSPLAN.SCENEID.ERROR', - 'errorMessage' => 'Scene ID does not exist.', - ], - [ - 'errorCode' => 'DESENSPLAN.SCENEIDLEVEL.ERROR', - 'errorMessage' => 'The scene is not a secondary scene.', - ], - [ - 'errorCode' => 'DESENSPLAN.SIZE.ERROR', - 'errorMessage' => 'The number of desens plan exceeds the limit.', - ], - ], - 403 => [ - [ - 'errorCode' => 'PERMISSION.DENIED.ERROR', - 'errorMessage' => 'Permission denied', - ], - ], - 500 => [ - [ - 'errorCode' => 'UNKNOWN.ERROR', - 'errorMessage' => 'unknown error.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1029030003\\",\\n \\"ErrorMessage\\": \\"param error\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"102400001\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 1029030003\\n param error\\n 400\\n true\\n 102400001\\n","errorExample":""}]', - 'title' => 'DsgDesensPlanAddOrUpdate', - 'requestParamsDescription' => 'The ExtParam parameter is a dynamic parameter. The value of the ExtParam parameter varies based on the data masking rule. The following example shows how to configure the parameters:'."\n" - ."\n" - .' Hash:'."\n" - .' {'."\n" - .' "algo": "MD5",'."\n" - .' "salt": 6'."\n" - .' }'."\n" - .' Pseudonym:'."\n" - .' {'."\n" - .' "charset": "Aa",'."\n" - .' "salt": 6'."\n" - .' }'."\n" - .' Mask:'."\n" - .' {'."\n" - .' "before": 3,'."\n" - .' "after": 4'."\n" - .' }'."\n" - .' Custom mask:'."\n" - .' {'."\n" - .' "separatorList": ['."\n" - .' {'."\n" - .' "desens": true,'."\n" - .' "left": 3'."\n" - .' },'."\n" - .' {'."\n" - .' "desens": false,'."\n" - .' "left": 6'."\n" - .' },'."\n" - .' {'."\n" - .' "desens": true,'."\n" - .' "left": -99'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .' Sample value character replacement:'."\n" - .' {'."\n" - .' "library": "test_library",'."\n" - .' "position": 3'."\n" - .' }'."\n" - .' Fixed value character replacement:'."\n" - .' {'."\n" - .' "replace": "repData",'."\n" - .' "position": 3'."\n" - .' }'."\n" - .' Random character replacement:'."\n" - .' {'."\n" - .' "replace": "repData"'."\n" - .' }'."\n" - .' Custom character replacement:'."\n" - .' {'."\n" - .' "separatorList": ['."\n" - .' {'."\n" - .' "desensParam": {'."\n" - .' "replace": "repData"'."\n" - .' },'."\n" - .' "left": 3'."\n" - .' },'."\n" - .' {'."\n" - .' "desensParam": {'."\n" - .' "library": "test_library"'."\n" - .' },'."\n" - .' "left": 6'."\n" - .' },'."\n" - .' {'."\n" - .' "desensParam": {'."\n" - .' },'."\n" - .' "left": 99'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .' Range change:'."\n" - .' {'."\n" - .' "intervalselects": ['."\n" - .' {'."\n" - .' "desens": "1",'."\n" - .' "interval": ['."\n" - .' "1",'."\n" - .' "100"'."\n" - .' ]'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .' Rounding:'."\n" - .' {'."\n" - .' "point":3'."\n" - .' }'."\n" - .' Left empty:'."\n" - .' {}'."\n" - ."\n" - .'You can call the [DsgQueryDefaultTemplates](~~2786306~~) operation to query the supported data masking methods and related rules.'."\n", - ], - 'DsgPlatformQueryProjectsAndSchemaFromMeta' => [ - 'summary' => 'Queries a list of compute engines of different types in the current tenant.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], + ['errorCode' => 'BADPARAMETERS', 'errorMessage' => 'Parameters are missing or in the wrong format.', 'description' => ''], ], ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '219458', - 'abilityTreeNodes' => [ - 'FEATUREdideRZM9W6', - ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ErrorCode\\": \\"9990030003\\",\\n \\"ErrorMessage\\": \\"Missing parameter\\",\\n \\"Success\\": true,\\n \\"Data\\": \\"[{\\\\\\"custom\\\\\\": false, \\\\\\"name\\\\\\": \\\\\\"EducationDegree\\\\\\", \\\\\\"localeName\\\\\\": \\\\\\"EducationDegree\\\\\\", \\\\\\"templateJsonStr\\\\\\": \\\\\\"{"_clazz":"com.alipay.dsgclient.sdk.dsg.fastscan.engine.cond.EducationDegreeCond"}\\\\\\", \\\\\\"desc\\\\\\": \\\\\\"\\\\\\"}]\\",\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"100000012\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 9990030003\\n 缺少参数\\n true\\n [{\\"custom\\": false, \\"name\\": \\"EducationDegree\\", \\"localeName\\": \\"EducationDegree\\", \\"templateJsonStr\\": \\"{&quot;_clazz&quot;:&quot;com.alipay.dsgclient.sdk.dsg.fastscan.engine.cond.EducationDegreeCond&quot;}\\", \\"desc\\": \\"\\"}]\\n 200\\n 10000001\\n","errorExample":""}]', + 'title' => 'QueryRecognizeDataByRuleType', + 'summary' => 'Queries the type of a sensitive data identification rule.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'EngineName', - 'in' => 'query', - 'schema' => [ - 'title' => '引擎名称', - 'description' => 'The type of the compute engine. Valid values:'."\n" - ."\n" - .'* ODPS.ODPS'."\n" - .'* EMR'."\n" - .'* HOLO.POSTGRES'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'EMR', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'OpenApiResultModel>', - 'description' => 'OpenApiResultModel\\'."\n", - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '1029030003', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'param error', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - ], - 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Project' => [ - 'description' => 'The name of the compute engine.'."\n", - 'type' => 'string', - 'example' => 'emr_test_project', - ], - 'ClusterId' => [ - 'description' => 'The ID of the EMR cluster. This parameter is generated only when the request parameter EngineName is set to EMR.'."\n", - 'type' => 'string', - 'example' => 'c-12345', - ], - ], - ], - ], - 'RequestId' => [ - 'description' => 'The request ID. You can use the ID to locate logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '102400001', - ], + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:QueryRecognizeDataByRuleType', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'PARAMS.ERROR', - 'errorMessage' => 'param error.', - ], - [ - 'errorCode' => 'ENGINE.NOT.ALLOW', - 'errorMessage' => 'engine not allow.', - ], - ], - 403 => [ - [ - 'errorCode' => 'PERMISSION.DENIED.ERROR', - 'errorMessage' => 'Permission denied', - ], - ], - 500 => [ - [ - 'errorCode' => 'UNKNOWN.ERROR', - 'errorMessage' => 'unknown error.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1029030003\\",\\n \\"ErrorMessage\\": \\"param error\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": [\\n {\\n \\"Project\\": \\"emr_test_project\\",\\n \\"ClusterId\\": \\"c-12345\\"\\n }\\n ],\\n \\"RequestId\\": \\"102400001\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 1029030003\\n param error\\n 400\\n \\n emr_test_project\\n c-12345\\n \\n 102400001\\n","errorExample":""}]', - 'title' => 'DsgPlatformQueryProjectsAndSchemaFromMeta', ], - 'DsgUserGroupDelete' => [ - 'summary' => 'Deletes a user group configured in Data Security Guard.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'QueryRecognizeRuleDetail' => [ + 'summary' => 'Retrieves the details of a specified sensitive field in Data Security Guard.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -53792,130 +33565,72 @@ ], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '219457', - 'abilityTreeNodes' => [ - 'FEATUREdideRZM9W6', - ], - ], - 'parameters' => [ - [ - 'name' => 'Ids', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The information about the user group.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The user group ID. You can call the [DsgUserGroupQueryList](~~2786441~~) operation to query the user group ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123', - ], - 'required' => false, - ], + 'operationType' => 'get', + 'abilityTreeCode' => '212990', + 'abilityTreeNodes' => ['FEATUREdideDCM5VK'], + ], + 'parameters' => [ + [ + 'name' => 'SensitiveName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the sensitive field. To obtain the name of the sensitive field, call the [QuerySensNodeInfo](~~2747189~~) operation or log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Data Category and Sensitivity Level page.', 'type' => 'string', 'required' => true, 'example' => 'Name', 'title' => ''], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.', 'type' => 'string', 'required' => true, 'example' => '10241024', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'OpenApiResultModel', - 'description' => 'OpenApiResultModel'."\n", + 'title' => 'OpenApiResultModel', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '1029030003', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'param error', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - ], - 'Data' => [ - 'description' => 'The operation result. Valid values:'."\n" - ."\n" - .'* true: The user group is deleted.'."\n" - .'* false: The user group fails to be deleted.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => '102400001', - ], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '9990030003', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Missing parameter', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The details of the sensitive field in the JSON format.', 'type' => 'any', 'example' => '{"nodeName":"basic unit overview","gmtModified":1709017449000,"hitThreshold":30,"sensitiveName":"mobile-yinni","templateId":"8222abeb-9784-4417-b420-0322926d5cbf","recognizeRulesType":2,"delete":false,"bydAccuracy":1,"colScan":"," defineType ":1,": ydAccuracy ":{" contentRule ":))," operationType ":0}," nodeParent ":" unit/unit basic information/unit basic overview "," level ":6," keyRuleId ":" 228248921215042mobile-yinni "," isDelete ":false," levelName ":" 6level "," sensitive ":false," operationType ":0," sourceName ": dsg-test-zuoyue","nodeId":"bea2fc81-90c9-45f3-b7a9-26d534208a0d","status":1}', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.', 'type' => 'string', 'example' => '100000012', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'USERGROUP.ACCOUNTLISTSIZE.ERROR', - 'errorMessage' => 'The number of account exceeds the limit.', - ], - [ - 'errorCode' => 'USERGROUP.ID.ERROR', - 'errorMessage' => 'The user group ID does not match the tenant or does not exist.', - ], - [ - 'errorCode' => 'USERGROUP.LISTSIZE.ERROR', - 'errorMessage' => 'The number of user groups exceeds the limit.', - ], - [ - 'errorCode' => 'USERGROUP.PAGESIZE.ERROR', - 'errorMessage' => 'Page size is too large, maximum of 100.', - ], - [ - 'errorCode' => 'USERACCOUNT.OWNER.ERROR', - 'errorMessage' => 'User list or owner user does not exist.', - ], - [ - 'errorCode' => 'PARAMS.ERROR', - 'errorMessage' => 'param error.', - ], + ['errorCode' => 'BADPARAMETERS', 'errorMessage' => 'Parameters are missing or in the wrong format.', 'description' => ''], ], - 403 => [ - [ - 'errorCode' => 'PERMISSION.DENIED.ERROR', - 'errorMessage' => 'Permission denied', - ], - ], - 500 => [ - [ - 'errorCode' => 'UNKNOWN.ERROR', - 'errorMessage' => 'unknown error.', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"9990030003\\",\\n \\"ErrorMessage\\": \\"Missing parameter\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"{\\\\\\"nodeName\\\\\\":\\\\\\"basic unit overview\\\\\\",\\\\\\"gmtModified\\\\\\":1709017449000,\\\\\\"hitThreshold\\\\\\":30,\\\\\\"sensitiveName\\\\\\":\\\\\\"mobile-yinni\\\\\\",\\\\\\"templateId\\\\\\":\\\\\\"8222abeb-9784-4417-b420-0322926d5cbf\\\\\\",\\\\\\"recognizeRulesType\\\\\\":2,\\\\\\"delete\\\\\\":false,\\\\\\"bydAccuracy\\\\\\":1,\\\\\\"colScan\\\\\\":\\\\\\",\\\\\\" defineType \\\\\\":1,\\\\\\": ydAccuracy \\\\\\":{\\\\\\" contentRule \\\\\\":)),\\\\\\" operationType \\\\\\":0},\\\\\\" nodeParent \\\\\\":\\\\\\" unit/unit basic information/unit basic overview \\\\\\",\\\\\\" level \\\\\\":6,\\\\\\" keyRuleId \\\\\\":\\\\\\" 228248921215042mobile-yinni \\\\\\",\\\\\\" isDelete \\\\\\":false,\\\\\\" levelName \\\\\\":\\\\\\" 6level \\\\\\",\\\\\\" sensitive \\\\\\":false,\\\\\\" operationType \\\\\\":0,\\\\\\" sourceName \\\\\\": dsg-test-zuoyue\\\\\\",\\\\\\"nodeId\\\\\\":\\\\\\"bea2fc81-90c9-45f3-b7a9-26d534208a0d\\\\\\",\\\\\\"status\\\\\\":1}\\",\\n \\"RequestId\\": \\"100000012\\"\\n}","type":"json"}]', + 'title' => 'QueryRecognizeRuleDetail', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:QueryRecognizeRuleDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1029030003\\",\\n \\"ErrorMessage\\": \\"param error\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"102400001\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 1029030003\\n param error\\n 400\\n true\\n 102400001\\n","errorExample":""}]', - 'title' => 'DsgUserGroupDelete', ], - 'DsgWhiteListDeleteList' => [ - 'summary' => 'Deletes a data masking whitelist configured in Data Security Guard.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'QueryRecognizeRulesType' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -53923,154 +33638,60 @@ ], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '219462', - 'abilityTreeNodes' => [ - 'FEATUREdideRZM9W6', - ], - ], - 'parameters' => [ - [ - 'name' => 'Ids', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The IDs of the whitelists.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The whitelist ID. You can call the [DsgWhiteListQueryList](~~2786508~~) operation to obtain the whitelist ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '123', - ], - 'required' => true, - ], - ], + 'operationType' => 'get', + 'abilityTreeCode' => '212274', + 'abilityTreeNodes' => ['FEATUREdideDCM5VK'], ], + 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'OpenApiResultModel', - 'description' => 'OpenApiResultModel'."\n", + 'title' => 'OpenApiResultModel', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '1029030003', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'param error', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - ], - 'Data' => [ - 'description' => 'The operation result. Valid values:'."\n" - ."\n" - .'* true: The operation is successful.'."\n" - .'* false: The operation failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => '102400001', - ], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '9990030003'], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'Missing parameter'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Data' => ['description' => 'The returned data about the built-in sensitive data identification rule that is used to configure a sensitive field. The data is in the JSON format.'."\n", 'type' => 'any', 'example' => '{ "HttpStatusCode": 200, "Data": [ { "Regular Expression": "1" }, { "Recognize Rule": "2" }, { "Sample Library": "3" }, { "Model": "4" } ], "Success": true }'], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '10000001'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'WHITELIST.DESENSID.ERROR', - 'errorMessage' => 'The desensitization rule ID does not match or does not exist with the tenant.', - ], - [ - 'errorCode' => 'WHITELIST.ENDTIME.ERROR', - 'errorMessage' => 'end time cannot be earlier than start time.', - ], - [ - 'errorCode' => 'WHITELIST.ID.ERROR', - 'errorMessage' => 'The whitelist ID does not match or does not exist with the tenant.', - ], - [ - 'errorCode' => 'WHITELIST.MCPROJECT.ERROR', - 'errorMessage' => 'The projectName on the bottom layer desensitization whitelist of MC cannot be empty.', - ], - [ - 'errorCode' => 'WHITELIST.PAGESIZE.ERROR', - 'errorMessage' => 'Page size is too large, maximum of 100.', - ], - [ - 'errorCode' => 'WHITELIST.SIZE.ERROR', - 'errorMessage' => 'The number of white list exceeds the limit.', - ], - [ - 'errorCode' => 'WHITELIST.STARTTIME.ERROR', - 'errorMessage' => 'start time cannot be earlier than today.', - ], - [ - 'errorCode' => 'WHITELIST.TIMEFORMAT.ERROR', - 'errorMessage' => 'The time format is incorrect, please use yyyy MM dd HH: mm: ss format.', - ], - [ - 'errorCode' => 'WHITELIST.USERGROUP.ERROR', - 'errorMessage' => 'The user group ID does not match or does not exist with the tenant.', - ], - [ - 'errorCode' => 'WHITELIST.USERGROUPEMPTY.ERROR', - 'errorMessage' => 'User group ID cannot be empty.', - ], - [ - 'errorCode' => 'WHITELIST.USERGROUPLISTSIZE.ERROR', - 'errorMessage' => 'The number of user group exceeds the limit.', - ], - [ - 'errorCode' => 'PARAMS.ERROR', - 'errorMessage' => 'param error.', - ], - ], - 403 => [ - [ - 'errorCode' => 'PERMISSION.DENIED.ERROR', - 'errorMessage' => 'Permission denied', - ], + ['errorCode' => 'BADPARAMETERS', 'errorMessage' => 'Parameters are missing or in the wrong format.', 'description' => ''], ], - 500 => [ - [ - 'errorCode' => 'UNKNOWN.ERROR', - 'errorMessage' => 'unknown error.', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"9990030002\\",\\n \\"ErrorMessage\\": \\"Missing parameter\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"{ \\\\\\"HttpStatusCode\\\\\\": 200, \\\\\\"Data\\\\\\": [ { \\\\\\"Regular Expression\\\\\\": \\\\\\"1\\\\\\" }, { \\\\\\"Recognize Rule\\\\\\": \\\\\\"2\\\\\\" }, { \\\\\\"Sample Library\\\\\\": \\\\\\"3\\\\\\" }, { \\\\\\"Model\\\\\\": \\\\\\"4\\\\\\" } ], \\\\\\"Success\\\\\\": true }\\",\\n \\"RequestId\\": \\"10000001\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 9990030003\\n 缺少参数\\n 200\\n { \\"HttpStatusCode\\": 200, \\"Data\\": [ { \\"Regular Expression\\": \\"1\\" }, { \\"Recognize Rule\\": \\"2\\" }, { \\"Sample Library\\": \\"3\\" }, { \\"Model\\": \\"4\\" } ], \\"Success\\": true }\\n 10000001\\n","errorExample":""}]', + 'title' => 'QueryRecognizeRulesType', + 'summary' => 'Queries the built-in sensitive data identification rule that is used to configure a sensitive field.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:QueryRecognizeRulesType', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1029030003\\",\\n \\"ErrorMessage\\": \\"param error\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"102400001\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 1029030003\\n param error\\n 400\\n true\\n 102400001\\n","errorExample":""}]', - 'title' => 'DsgWhiteListDeleteList', ], - 'DsgScenedDeleteScene' => [ - 'summary' => 'Deletes a level-2 data masking scenario created in Data Security Guard.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'QuerySensClassification' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -54078,130 +33699,71 @@ ], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '219460', - 'abilityTreeNodes' => [ - 'FEATUREdideRZM9W6', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '212270', + 'abilityTreeNodes' => ['FEATUREdideBVSRMP'], ], 'parameters' => [ [ - 'name' => 'Ids', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The IDs of level-2 data masking scenarios.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the level-2 data masking scenario. You can call the [DsgSceneQuerySceneListByName](~~2786322~~) operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '123', - ], - 'required' => true, - ], + 'name' => 'TemplateId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the template defined by Data Security Guard. You can call the [QueryDefaultTemplate](~~2743948~~) operation to query the ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'e1970541-6cf5-4d23-b101-d5b66f6e1024'], + ], + [ + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n", 'type' => 'string', 'required' => true, 'example' => '10241024'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'OpenApiResultModel', + 'title' => 'OpenApiResultModel', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '1029030003', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'param error', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - ], - 'Data' => [ - 'description' => 'The operation result. Valid values:'."\n" - ."\n" - .'* true: The operation is successful.'."\n" - .'* false: The operation failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '102400001', - ], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '9990030003'], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'Missing parameter'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '400'], + 'Data' => ['description' => 'The returned data about data categories. The data is in the JSON format.'."\n", 'type' => 'any', 'example' => '[{ "nodeName": "teset1", "sensitiveNotNull": true, "nodeId": "1aac2e35-b437-486b-95c7-a5ae48371024", "nodeOldId": "1aac2e35-b437-486b-95c7-a5ae48371024", "parentId": "0" }]'], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '10000001'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'DESENSSCENE.ID.ERROR', - 'errorMessage' => 'The desensitization scenario ID does not match or does not exist with the tenant.', - ], - [ - 'errorCode' => 'DESENSSCENE.IDLEVEL.ERROR', - 'errorMessage' => 'The desensitization scenario is not a secondary scenario.', - ], - [ - 'errorCode' => 'DESENSSCENE.PROJECT.ERROR', - 'errorMessage' => 'The project space does not exist.', - ], - [ - 'errorCode' => 'DESENSSCENE.SIZE.ERROR', - 'errorMessage' => 'The number of desens scene exceeds the limit.', - ], - [ - 'errorCode' => 'DESENSSCENE.UESRGROUP.ERROR', - 'errorMessage' => 'The user group ID does not match the tenant or does not exist.', - ], - [ - 'errorCode' => 'PARAMS.ERROR', - 'errorMessage' => 'param error.', - ], - ], - 403 => [ - [ - 'errorCode' => 'PERMISSION.DENIED.ERROR', - 'errorMessage' => 'Permission denied', - ], + ['errorCode' => 'BADPARAMETERS', 'errorMessage' => 'Parameters are missing or in the wrong format.', 'description' => ''], ], - 500 => [ - [ - 'errorCode' => 'UNKNOWN.ERROR', - 'errorMessage' => 'unknown error.', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"9990030003\\",\\n \\"ErrorMessage\\": \\"Missing parameter\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": \\"[{ \\\\\\"nodeName\\\\\\": \\\\\\"teset1\\\\\\", \\\\\\"sensitiveNotNull\\\\\\": true, \\\\\\"nodeId\\\\\\": \\\\\\"1aac2e35-b437-486b-95c7-a5ae48371024\\\\\\", \\\\\\"nodeOldId\\\\\\": \\\\\\"1aac2e35-b437-486b-95c7-a5ae48371024\\\\\\", \\\\\\"parentId\\\\\\": \\\\\\"0\\\\\\" }]\\",\\n \\"RequestId\\": \\"10000001\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 9990030003\\n 缺少参数\\n 400\\n [{ \\"nodeName\\": \\"teset1\\", \\"sensitiveNotNull\\": true, \\"nodeId\\": \\"1aac2e35-b437-486b-95c7-a5ae48371024\\", \\"nodeOldId\\": \\"1aac2e35-b437-486b-95c7-a5ae48371024\\", \\"parentId\\": \\"0\\" }]\\n 10000001\\n","errorExample":""}]', + 'title' => 'QuerySensClassification', + 'summary' => 'Queries data categories.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:QuerySensClassification', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1029030003\\",\\n \\"ErrorMessage\\": \\"param error\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"102400001\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 1029030003\\n param error\\n 400\\n true\\n 102400001\\n","errorExample":""}]', - 'title' => 'DsgScenedDeleteScene', ], - 'DsgDesensPlanDelete' => [ - 'summary' => 'Deletes a data masking rule created in Data Security Guard.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'QuerySensLevel' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -54209,163 +33771,71 @@ ], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '219620', - 'abilityTreeNodes' => [ - 'FEATUREdideRZM9W6', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '212269', + 'abilityTreeNodes' => ['FEATUREdidePQ4SAC'], ], 'parameters' => [ [ - 'name' => 'Ids', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'A collection of data masking rules.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the data masking rule. You can call the [DsgDesensPlanQueryList](~~2786578~~) operation to query the ID of the data masking rule.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '123', - ], - 'required' => true, - ], + 'name' => 'TemplateId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the template defined by Data Security Guard. You can call the [QueryDefaultTemplate](~~2743948~~) operation to query the ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'e1970541-6cf5-4d23-b101-d5b66f6e10af'], ], [ - 'name' => 'SceneCode', - 'in' => 'query', - 'schema' => [ - 'description' => 'The code of the level-1 data masking scenario to which the rule belongs. Valid values:'."\n" - ."\n" - .'* dataworks_display_desense_code: masking of displayed data in DataStudio and Data Map'."\n" - .'* maxcompute_desense_code: data masking at the MaxCompute compute engine layer'."\n" - .'* maxcompute_new_desense_code: data masking at the MaxCompute compute engine layer (new)'."\n" - .'* hologres_display_desense_code: data masking at the Hologres compute engine layer'."\n" - .'* dataworks_data_integration_desense_code: static data masking in Data Integration'."\n" - .'* dataworks_analysis_desense_code: masking of displayed data in DataAnalysis'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'dataworks_display_desense_code', - ], + 'name' => 'tenantId', + 'in' => 'formData', + 'schema' => ['description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n", 'type' => 'string', 'required' => true, 'example' => '10241024'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'OpenApiResultModel', - 'description' => 'OpenApiResultModel'."\n", + 'title' => 'OpenApiResultModel', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '1029030003', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'param error', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - ], - 'Data' => [ - 'description' => 'The operation result. Valid values:'."\n" - ."\n" - .'* true: The operation is successful.'."\n" - .'* false: The operation fails.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => '102400001', - ], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '9990030003'], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'Missing parameter'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Data' => ['description' => 'The returned data about data sensitivity levels. The data is in the JSON array format.'."\n", 'type' => 'any', 'example' => '[{"level":1,"isSensitive":false,"levelName":"1level"},{"level":2,"isSensitive":false,"levelName":"2level"}]'], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '10000001'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'PARAMS.ERROR', - 'errorMessage' => 'param error.', - ], - [ - 'errorCode' => 'DESENSPLAN.DATATYPE.ERROR', - 'errorMessage' => 'Sensitive type already has a desensitization rule.', - ], - [ - 'errorCode' => 'DESENSPLAN.DATATYPENOTEXIST.ERROR', - 'errorMessage' => 'Sensitive type not exist.', - ], - [ - 'errorCode' => 'DESENSPLAN.ID.ERROR', - 'errorMessage' => 'Desensitization rule ID does not exist.', - ], - [ - 'errorCode' => 'DESENSPLAN.PAGESIZE.ERROR', - 'errorMessage' => 'Page size is too large, maximum of 100.', - ], - [ - 'errorCode' => 'DESENSPLAN.PARAM.ERROR', - 'errorMessage' => 'Desensitization rule parameter error.', - ], - [ - 'errorCode' => 'DESENSPLAN.SCENECODE.ERROR', - 'errorMessage' => 'Scene code does not exist.', - ], - [ - 'errorCode' => 'DESENSPLAN.SCENEID.ERROR', - 'errorMessage' => 'Scene ID does not exist.', - ], - [ - 'errorCode' => 'DESENSPLAN.SCENEIDLEVEL.ERROR', - 'errorMessage' => 'The scene is not a secondary scene.', - ], - [ - 'errorCode' => 'DESENSPLAN.SIZE.ERROR', - 'errorMessage' => 'The number of desens plan exceeds the limit.', - ], - ], - 403 => [ - [ - 'errorCode' => 'PERMISSION.DENIED.ERROR', - 'errorMessage' => 'Permission denied', - ], + ['errorCode' => 'BADPARAMETERS', 'errorMessage' => 'Parameters are missing or in the wrong format.', 'description' => ''], ], - 500 => [ - [ - 'errorCode' => 'UNKNOWN.ERROR', - 'errorMessage' => 'unknown error.', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"9990030003\\",\\n \\"ErrorMessage\\": \\"Missing parameter\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"[{\\\\\\"level\\\\\\":1,\\\\\\"isSensitive\\\\\\":false,\\\\\\"levelName\\\\\\":\\\\\\"1level\\\\\\"},{\\\\\\"level\\\\\\":2,\\\\\\"isSensitive\\\\\\":false,\\\\\\"levelName\\\\\\":\\\\\\"2level\\\\\\"}]\\",\\n \\"RequestId\\": \\"10000001\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 9990030003\\n 缺少参数\\n 200\\n [{\\"level\\":1,\\"isSensitive\\":false,\\"levelName\\":\\"1level\\"},{\\"level\\":2,\\"isSensitive\\":false,\\"levelName\\":\\"2level\\"}]\\n 10000001\\n","errorExample":""}]', + 'title' => 'QuerySensLevel', + 'summary' => 'Queries data sensitivity levels in Data Security Guard.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:QuerySensLevel', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1029030003\\",\\n \\"ErrorMessage\\": \\"param error\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"102400001\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 1029030003\\n param error\\n 400\\n true\\n 102400001\\n","errorExample":""}]', - 'title' => 'DsgDesensPlanDelete', ], - 'DsgDesensPlanUpdateStatus' => [ - 'summary' => 'Modifies the status of a data masking rule.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'QuerySensNodeInfo' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -54373,1753 +33843,1033 @@ ], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '219619', - 'abilityTreeNodes' => [ - 'FEATUREdideRZM9W6', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '217792', + 'abilityTreeNodes' => ['FEATUREdideDCM5VK'], ], 'parameters' => [ [ - 'name' => 'Ids', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'A collection of IDs of the data masking rules of which the status you want to modify.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the data masking rule. You can call the [DsgDesensPlanQueryList](~~2786578~~) operation to query the ID of the data masking rule.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '123', - ], - 'required' => true, - ], + 'name' => 'TemplateId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the data category and data sensitivity level template. You can call the [QueryDefaultTemplate](~~2743948~~) operation to query the ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'e1970541-6cf5-4d23-b101-d5b66f6e1024'], ], [ - 'name' => 'SceneCode', - 'in' => 'query', - 'schema' => [ - 'description' => 'The code of the level-1 data masking scenario to which the rule belongs. Valid values:'."\n" - ."\n" - .'* dataworks_display_desense_code: masking of displayed data in DataStudio and Data Map'."\n" - .'* maxcompute_desense_code: data masking at the MaxCompute compute engine layer'."\n" - .'* maxcompute_new_desense_code: data masking at the MaxCompute compute engine layer (new)'."\n" - .'* hologres_display_desense_code: data masking at the Hologres compute engine layer'."\n" - .'* dataworks_data_integration_desense_code: static data masking in Data Integration'."\n" - .'* dataworks_analysis_desense_code: masking of displayed data in DataAnalysis'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'dataworks_display_desense_code', - ], + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n", 'type' => 'string', 'required' => true, 'example' => '10241024'], ], [ - 'name' => 'Status', - 'in' => 'query', - 'schema' => [ - 'description' => 'The status of the data masking rule. Valid values:'."\n" - ."\n" - .'* 0: expired'."\n" - .'* 1: effective'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'name' => 'NodeId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the data category. You can call the [QuerySensClassification](~~2746850~~) operation or log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Data Security Guard page to obtain the ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '0ce67949-0810-400f-a24a-cc5ffafe1024'], + ], + [ + 'name' => 'SensitiveName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the sensitive field. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Data Security Guard page to obtain the name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ID card'], + ], + [ + 'name' => 'PageNo', + 'in' => 'formData', + 'schema' => ['description' => 'The page number. Pages start from page 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['description' => 'The number of entries per page. Valid values: 10 to 1000. The recommended number of entries per page ranges from 10 to 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10'], + ], + [ + 'name' => 'status', + 'in' => 'formData', + 'schema' => ['description' => 'The status of the sensitive field. Valid values:'."\n" + ."\n" + .'* 0: draft'."\n" + .'* 1: published'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'OpenApiResultModel', - 'description' => 'OpenApiResultModel'."\n", + 'title' => 'OpenApiResultModel', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '1029030003', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'param error', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - ], - 'Data' => [ - 'description' => 'The operation result. Valid values:'."\n" - ."\n" - .'* true: The operation is successful.'."\n" - .'* false: The operation fails.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => '102400001', - ], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '9990030003'], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'Missing parameter'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Data' => ['description' => 'The returned business data in the JSON format.'."\n", 'type' => 'any', 'example' => '{"success": true, "httpStatusCode": 200, "data": { "result": [ { "sensitiveName": "certificate expiration date", "sensitiveId": "fd4ff5a2-9537-43d1-8e4f-1d0b5ffaac12", "status": 0, "templateName": "built-in classification and grading template", "keyRuleId": "228248921215042 certificate expiration date"} ], "totalCount": 1, "currentPage": 1, "pageSize": 10 }, "requestId": 10000001}'], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '10000001'], ], ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'PARAMS.ERROR', - 'errorMessage' => 'param error.', - ], - [ - 'errorCode' => 'DESENSPLAN.DATATYPE.ERROR', - 'errorMessage' => 'Sensitive type already has a desensitization rule.', - ], - [ - 'errorCode' => 'DESENSPLAN.DATATYPENOTEXIST.ERROR', - 'errorMessage' => 'Sensitive type not exist.', - ], - [ - 'errorCode' => 'DESENSPLAN.ID.ERROR', - 'errorMessage' => 'Desensitization rule ID does not exist.', - ], - [ - 'errorCode' => 'DESENSPLAN.PAGESIZE.ERROR', - 'errorMessage' => 'Page size is too large, maximum of 100.', - ], - [ - 'errorCode' => 'DESENSPLAN.PARAM.ERROR', - 'errorMessage' => 'Desensitization rule parameter error.', - ], - [ - 'errorCode' => 'DESENSPLAN.SCENECODE.ERROR', - 'errorMessage' => 'Scene code does not exist.', - ], - [ - 'errorCode' => 'DESENSPLAN.SCENEID.ERROR', - 'errorMessage' => 'Scene ID does not exist.', - ], - [ - 'errorCode' => 'DESENSPLAN.SCENEIDLEVEL.ERROR', - 'errorMessage' => 'The scene is not a secondary scene.', - ], - [ - 'errorCode' => 'DESENSPLAN.SIZE.ERROR', - 'errorMessage' => 'The number of desens plan exceeds the limit.', - ], - ], - 403 => [ - [ - 'errorCode' => 'PERMISSION.DENIED.ERROR', - 'errorMessage' => 'Permission denied', - ], + ['errorCode' => 'BADPARAMETERS', 'errorMessage' => 'Parameters are missing or in the wrong format.', 'description' => ''], ], - 500 => [ - [ - 'errorCode' => 'UNKNOWN.ERROR', - 'errorMessage' => 'unknown error.', + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"9990030003\\",\\n \\"ErrorMessage\\": \\"Missing parameter\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"{\\\\\\"success\\\\\\": true, \\\\\\"httpStatusCode\\\\\\": 200, \\\\\\"data\\\\\\": { \\\\\\"result\\\\\\": [ { \\\\\\"sensitiveName\\\\\\": \\\\\\"certificate expiration date\\\\\\", \\\\\\"sensitiveId\\\\\\": \\\\\\"fd4ff5a2-9537-43d1-8e4f-1d0b5ffaac12\\\\\\", \\\\\\"status\\\\\\": 0, \\\\\\"templateName\\\\\\": \\\\\\"built-in classification and grading template\\\\\\", \\\\\\"keyRuleId\\\\\\": \\\\\\"228248921215042 certificate expiration date\\\\\\"} ], \\\\\\"totalCount\\\\\\": 1, \\\\\\"currentPage\\\\\\": 1, \\\\\\"pageSize\\\\\\": 10 }, \\\\\\"requestId\\\\\\": 10000001}\\",\\n \\"RequestId\\": \\"10000001\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 9990030003\\n 缺少参数\\n 200\\n { \\"success\\": true, \\"httpStatusCode\\": 200, \\"data\\": { \\"result\\": [ { \\"sensitiveName\\": \\"证件到期日期\\", \\"sensitiveId\\": \\"fd4ff5a2-9537-43d1-8e4f-1d0b5ffaac12\\", \\"status\\": 0, \\"templateName\\": \\"内置分类分级模板\\", \\"keyRuleId\\": \\"228248921215042证件到期日期\\" } ], \\"totalCount\\": 1, \\"currentPage\\": 1, \\"pageSize\\": 10 }, \\"requestId\\": 10000001 }\\n 10000001\\n","errorExample":""}]', + 'title' => 'QuerySensNodeInfo', + 'summary' => 'Queries sensitive data identification rules.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:QuerySensNodeInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1029030003\\",\\n \\"ErrorMessage\\": \\"param error\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"102400001\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 1029030003\\n param error\\n 400\\n true\\n 102400001\\n","errorExample":""}]', - 'title' => 'DsgDesensPlanUpdateStatus', ], - 'DsgWhiteListQueryList' => [ - 'summary' => 'Queries a data masking whitelist.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'RegisterLineageRelation' => [ + 'summary' => 'Registers the lineage between self-managed entities to DataWorks.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '219250', - 'abilityTreeNodes' => [ - 'FEATUREdideRZM9W6', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '178589', + 'abilityTreeNodes' => ['FEATUREdideSYOMAV'], ], 'parameters' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'title' => '页码', - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '页大小', - 'description' => 'The number of entries per page. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '10', - ], - ], - [ - 'name' => 'SceneId', - 'in' => 'query', - 'schema' => [ - 'title' => '二级场景Id', - 'description' => 'The ID of the level-2 data masking scenario. You can call the [DsgSceneQuerySceneListByName](~~2786322~~) operation to query the list of IDs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123', - ], - ], - [ - 'name' => 'DataType', - 'in' => 'query', - 'schema' => [ - 'title' => '敏感类型关键字', - 'description' => 'The keyword of the sensitive field type.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'phone', - ], + 'name' => 'LineageRelationRegisterVO', + 'in' => 'formData', + 'style' => 'json', + 'schema' => ['description' => 'The structure whose lineage you want to register to DataWorks.', 'required' => true, '$ref' => '#/components/schemas/LineageRelationRegisterVO', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'OpenApiResultModel>', - 'description' => 'OpenApiResultModel\\'."\n", + 'description' => 'OpenApiMetaResultModel', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '1029030003', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'param error', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - ], - 'PageData' => [ - 'description' => 'The pagination information.'."\n", + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The entity of lineage not exist, xxx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.', 'type' => 'string', 'example' => 'EE50E05E-028C-182B-****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '1010210001', 'title' => ''], + 'LineageRelation' => [ + 'description' => 'The lineage.', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of data masking whitelists.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'Data' => [ - 'description' => 'A collection of whitelists.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the data masking whitelist.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'Type' => [ - 'description' => 'The sensitive field type.'."\n", - 'type' => 'string', - 'example' => 'phone', - ], - 'UserGroups' => [ - 'description' => 'A collection of user group names.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The name of the user group.'."\n", - 'type' => 'string', - 'example' => 'test_group', - ], - ], - 'GmtCreate' => [ - 'description' => 'The time when the whitelist was created.'."\n", - 'type' => 'string', - 'example' => '2024-05-09 15:46:20', - ], - 'GmtModified' => [ - 'description' => 'The time when the whitelist was modified.'."\n", - 'type' => 'string', - 'example' => '2024-05-09 15:46:20', - ], - 'RuleId' => [ - 'description' => 'The ID of the data masking rule.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'SceneId' => [ - 'description' => 'The ID of the level-2 data masking scenario.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'StartTime' => [ - 'description' => 'The time when the data masking whitelist takes effect cannot be earlier than the current time. Unit: days.'."\n", - 'type' => 'string', - 'example' => '2024-05-09 15:46:20', - ], - 'EndTime' => [ - 'description' => 'The expiration time of the data masking whitelist cannot be earlier than the time when the data masking whitelist takes effect. Unit: days.'."\n", - 'type' => 'string', - 'example' => '2024-05-10 15:46:20', - ], - ], - ], - ], + 'SrcEntityQualifiedName' => ['description' => 'The unique identifier of the source entity.', 'type' => 'string', 'example' => 'maxcompute-table.project.table', 'title' => ''], + 'DestEntityQualifiedName' => ['description' => 'The unique identifier of the destination entity.', 'type' => 'string', 'example' => 'custom-report.month_stat_user', 'title' => ''], + 'RelationshipGuid' => ['description' => 'The ID of the lineage between entities.', 'type' => 'string', 'example' => 'dfsldfdlsfdsaaaabbbb', 'title' => ''], ], - ], - 'RequestId' => [ - 'description' => 'The request ID. You can use the ID to locate logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '102400001', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'WHITELIST.DESENSID.ERROR', - 'errorMessage' => 'The desensitization rule ID does not match or does not exist with the tenant.', - ], - [ - 'errorCode' => 'WHITELIST.ENDTIME.ERROR', - 'errorMessage' => 'end time cannot be earlier than start time.', - ], - [ - 'errorCode' => 'WHITELIST.ID.ERROR', - 'errorMessage' => 'The whitelist ID does not match or does not exist with the tenant.', - ], - [ - 'errorCode' => 'WHITELIST.MCPROJECT.ERROR', - 'errorMessage' => 'The projectName on the bottom layer desensitization whitelist of MC cannot be empty.', - ], - [ - 'errorCode' => 'WHITELIST.PAGESIZE.ERROR', - 'errorMessage' => 'Page size is too large, maximum of 100.', - ], - [ - 'errorCode' => 'WHITELIST.SIZE.ERROR', - 'errorMessage' => 'The number of white list exceeds the limit.', - ], - [ - 'errorCode' => 'WHITELIST.STARTTIME.ERROR', - 'errorMessage' => 'start time cannot be earlier than today.', - ], - [ - 'errorCode' => 'WHITELIST.TIMEFORMAT.ERROR', - 'errorMessage' => 'The time format is incorrect, please use yyyy MM dd HH: mm: ss format.', - ], - [ - 'errorCode' => 'WHITELIST.USERGROUP.ERROR', - 'errorMessage' => 'The user group ID does not match or does not exist with the tenant.', - ], - [ - 'errorCode' => 'WHITELIST.USERGROUPEMPTY.ERROR', - 'errorMessage' => 'User group ID cannot be empty.', - ], - [ - 'errorCode' => 'WHITELIST.USERGROUPLISTSIZE.ERROR', - 'errorMessage' => 'The number of user group exceeds the limit.', - ], - [ - 'errorCode' => 'PARAMS.ERROR', - 'errorMessage' => 'param error.', - ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The entity of lineage not exist, xxx\\",\\n \\"RequestId\\": \\"EE50E05E-028C-182B-****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1010210001\\",\\n \\"LineageRelation\\": {\\n \\"SrcEntityQualifiedName\\": \\"maxcompute-table.project.table\\",\\n \\"DestEntityQualifiedName\\": \\"custom-report.month_stat_user\\",\\n \\"RelationshipGuid\\": \\"dfsldfdlsfdsaaaabbbb\\"\\n }\\n}","type":"json"}]', + 'title' => 'RegisterLineageRelation', + 'description' => 'This API operation is currently in trial. Users who want to try it out can submit an application. After the administrator adds the user to the trial list, the user can call this operation.', + 'requestParamsDescription' => 'Entity unique identifier format: EntityType.EntityGuid'."\n" + ."\n" + .'```'."\n" + .'1: EntityType identifies the entity type'."\n" + .' 1.1 Entity types available in DataWorks'."\n" + .' (1) MaxCompute table: maxcompute-table'."\n" + .' (2) MySQL table: mysql-table'."\n" + .' (3) EMR table: emr-table'."\n" + .' (4) Hologres table: holodb-table'."\n" + ."\n" + .' 1.2 Custom entity types: custom-xxx'."\n" + .' The following types are recommended based on user requirements'."\n" + .' (1) Table: custom-table'."\n" + .' (2) API: custom-api'."\n" + .' (3) Application: custom-app'."\n" + .' (4) Report: custom-report'."\n" + .' (5) Dataset: custom-dataset'."\n" + .' (6) Data source: custom-datasource'."\n" + ."\n" + .'2: EntityGuid: A unique identifier for the entity within the same entity type'."\n" + .' Users can define their own unique ID for custom entities'."\n" + ."\n" + .'3: Entity examples:'."\n" + .' 3.1: DataWorks built-in system entities, which can be viewed in the lineage graph on the Data Map page'."\n" + .' (1) maxcompute-table.project.tableName represents the unique ID of a MaxCompute table'."\n" + .' (2) emr-table.kadfdfaccdd4ted represents the unique ID of an EMR table'."\n" + .' 3.2: Custom entities: Users define their own unique ID based on their business requirements (within 50 bytes)'."\n" + .' (1) custom-api.listUser represents a custom API entity with the unique identifier listUser'."\n" + .' (2) custom-table.db1.table2 represents a custom table entity with the unique identifier db1.table2'."\n" + .'```', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'RemoveEntityTags' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], ], - 403 => [ - [ - 'errorCode' => 'PERMISSION.DENIED.ERROR', - 'errorMessage' => 'Permission denied', + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '187380', + 'abilityTreeNodes' => ['FEATUREdideRZEBFC'], + ], + 'parameters' => [ + [ + 'name' => 'QualifiedName', + 'in' => 'query', + 'schema' => ['description' => 'The unique identifier of the entity. Example: maxcompute-table.projectA.tableA.'."\n", 'type' => 'string', 'required' => true, 'example' => 'maxcompute-table.projectA.tableA'], + ], + [ + 'name' => 'TagKeys', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The tag keys.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The tag key.'."\n", 'type' => 'string', 'required' => false, 'example' => 'priority'], + 'required' => true, + 'maxItems' => 100, ], ], - 500 => [ - [ - 'errorCode' => 'UNKNOWN.ERROR', - 'errorMessage' => 'unknown error.', + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'OpenApiMetaResultModel', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Data' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'true\\'."\n" + .'false'."\n", 'type' => 'boolean', 'example' => 'true'], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0000-ABCD-E****'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'true\\'."\n" + .'false'."\n", 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '101011005'], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'Invalid.Entity.EntityTypeNotSupported'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1029030003\\",\\n \\"ErrorMessage\\": \\"param error\\",\\n \\"HttpStatusCode\\": 400,\\n \\"PageData\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Data\\": [\\n {\\n \\"Id\\": 123,\\n \\"Type\\": \\"phone\\",\\n \\"UserGroups\\": [\\n \\"test_group\\"\\n ],\\n \\"GmtCreate\\": \\"2024-05-09 15:46:20\\",\\n \\"GmtModified\\": \\"2024-05-09 15:46:20\\",\\n \\"RuleId\\": 123,\\n \\"SceneId\\": 123,\\n \\"StartTime\\": \\"2024-05-09 15:46:20\\",\\n \\"EndTime\\": \\"2024-05-10 15:46:20\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"102400001\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 1029030003\\n param error\\n 400\\n \\n 1\\n 10\\n 100\\n \\n 123\\n phone\\n test_group\\n 2024-05-09 15:46:20\\n 2024-05-09 15:46:20\\n 123\\n 123\\n 2024-05-09 15:46:20\\n 2024-05-10 15:46:20\\n \\n \\n 102400001\\n","errorExample":""}]', - 'title' => 'DsgWhiteListQueryList', - ], - 'DsgSceneAddOrUpdateScene' => [ - 'summary' => 'Adds or modifies a level-2 data masking scenario.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"0000-ABCD-E****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"101011005\\",\\n \\"ErrorMessage\\": \\"Invalid.Entity.EntityTypeNotSupported\\",\\n \\"HttpStatusCode\\": 200\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 0000-ABCD-E****\\n true\\n 101011005\\n Invalid.Entity.EntityTypeNotSupported\\n 200\\n","errorExample":""}]', + 'title' => 'RemoveEntityTags', + 'summary' => 'Removes tags from an entity. Only entities of the maxcompute-table type are supported.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'RemoveProjectMemberFromRole' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '219459', - 'abilityTreeNodes' => [ - 'FEATUREdideRZM9W6', - ], - ], + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'scenes', + 'name' => 'ProjectId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The information about the level-2 data masking scenario.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the level-2 data masking scenario.'."\n", - 'type' => 'object', - 'properties' => [ - 'id' => [ - 'description' => 'The ID of the level-2 data masking scenario.'."\n" - ."\n" - .'* If you do not configure this parameter, the current operation is to add a level-2 data masking scenario.'."\n" - .'* If you configure this parameter, the current operation is to modify a level-2 data masking scenario. You can call the [DsgSceneQuerySceneListByName](~~2786322~~) operation to query the ID of the level-2 data masking scenario.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], - 'sceneName' => [ - 'description' => 'The name of the level-2 data masking scenario.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'dev_scene', - ], - 'sceneCode' => [ - 'description' => 'The code of the level-1 data masking scenario to which the level-2 data masking scenario belongs. Valid values:'."\n" - ."\n" - .'* dataworks_display_desense_code: masking of displayed data in DataStudio and Data Map'."\n" - .'* maxcompute_desense_code: data masking at the MaxCompute compute engine layer'."\n" - .'* maxcompute_new_desense_code: data masking at the MaxCompute compute engine layer (new)'."\n" - .'* dataworks_analysis_desense_code: masking of displayed data in DataAnalysis'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'dataworks_display_desense_code', - ], - 'projects' => [ - 'description' => 'The information about the compute engine for which the data masking scenario takes effect.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the compute engine for which the data masking scenario takes effect.'."\n", - 'type' => 'object', - 'properties' => [ - 'clusterId' => [ - 'description' => 'If the data masking scenario takes effect for an E-MapReduce (EMR) compute engine, enter the ID of an EMR cluster. This parameter is required only when you use an EMR compute engine.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'c-1234', - ], - 'projectName' => [ - 'description' => 'The name of the compute engine instance for which the data masking scenario takes effect.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dev_project', - ], - 'dbType' => [ - 'description' => 'The type of the compute engine for which the data masking scenario takes effect. Valid values:'."\n" - ."\n" - .'* ODPS: ODPS.ODPS'."\n" - .'* HOLO: HOLO.POSTGRES'."\n" - .'* EMR: EMR'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ODPS.ODPS', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'desc' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Test scenarios', - ], - 'userGroupIds' => [ - 'description' => 'The information about the user group for which the data masking scenario takes effect.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the user group for which the data masking scenario takes effect. You can call the [DsgUserGroupQueryList](~~2786441~~) operation to query the user group ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123', - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => true, - ], + 'schema' => ['description' => 'The DataWorks workspace ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '10000000', 'minimum' => '0', 'example' => '27', 'title' => ''], + ], + [ + 'name' => 'UserId', + 'in' => 'query', + 'schema' => ['description' => 'The user ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1234', 'title' => ''], + ], + [ + 'name' => 'RoleCode', + 'in' => 'query', + 'schema' => ['description' => 'The code of the role in the DataWorks workspace. You can call the ListProjectRoles operation to query the codes of all roles in a DataWorks workspace. Valid values:'."\n" + ."\n" + .'* role_project_owner: workspace owner'."\n" + .'* role_project_admin: workspace administrator'."\n" + .'* role_project_dev: developer'."\n" + .'* role_project_pe: O\\&M engineer'."\n" + .'* role_project_deploy: deployment expert'."\n" + .'* role_project_guest: visitor'."\n" + .'* role_project_security: security administrator'."\n" + .'* role_project_tester: experiencer'."\n" + .'* role_project_erd: model designer'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'role_project_guest', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'OpenApiResultModel', - 'description' => 'OpenApiResultModel'."\n", + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '1029030003', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'param error', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - ], - 'Data' => [ - 'description' => 'The operation result.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can use the ID to locate logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '102400001', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1AFAE64E-D1BE-432B-A9****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'DESENSSCENE.ID.ERROR', - 'errorMessage' => 'The desensitization scenario ID does not match or does not exist with the tenant.', - ], - [ - 'errorCode' => 'DESENSSCENE.IDLEVEL.ERROR', - 'errorMessage' => 'The desensitization scenario is not a secondary scenario.', - ], - [ - 'errorCode' => 'DESENSSCENE.PROJECT.ERROR', - 'errorMessage' => 'The project space does not exist.', - ], - [ - 'errorCode' => 'DESENSSCENE.SIZE.ERROR', - 'errorMessage' => 'The number of desens scene exceeds the limit.', - ], - [ - 'errorCode' => 'DESENSSCENE.UESRGROUP.ERROR', - 'errorMessage' => 'The user group ID does not match the tenant or does not exist.', - ], - [ - 'errorCode' => 'PARAMS.ERROR', - 'errorMessage' => 'param error.', - ], + ['errorCode' => 'Invalid.Tenant.ConnectionNotExists', 'errorMessage' => 'The connection does not exist.', 'description' => 'The connection does not exist.'], + ['errorCode' => 'Invalid.Tenant.ProjectNotExists', 'errorMessage' => 'The project does not exist.', 'description' => 'The project does not exist.'], + ['errorCode' => 'Invalid.Tenant.UserNotInProject', 'errorMessage' => 'The user is not in the project.', 'description' => 'The user is not in the project.'], ], 403 => [ - [ - 'errorCode' => 'PERMISSION.DENIED.ERROR', - 'errorMessage' => 'Permission denied', - ], - ], - 500 => [ - [ - 'errorCode' => 'UNKNOWN.ERROR', - 'errorMessage' => 'unknown error.', - ], + ['errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin', 'errorMessage' => 'The user is not a project administrator or owner.', 'description' => 'The user is not a project administrator or owner.'], + ['errorCode' => 'Invalid.Tenant.UserNotInTenant', 'errorMessage' => 'The user is not in tenant.', 'description' => 'The user is not in tenant.'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1029030003\\",\\n \\"ErrorMessage\\": \\"param error\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"102400001\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 1029030003\\n param error\\n 400\\n true\\n 102400001\\n","errorExample":""}]', - 'title' => 'DsgSceneAddOrUpdateScene', - ], - 'DsgSceneQuerySceneListByName' => [ - 'summary' => 'Queries a list of data masking scenarios.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', + 'title' => 'RemoveProjectMemberFromRole', + 'summary' => 'Removes a role from a user in a DataWorks workspace.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AFAE64E-D1BE-432B-A9****\\"\\n}","type":"json"}]', + ], + 'RestartInstance' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '219224', - 'abilityTreeNodes' => [ - 'FEATUREdideRZM9W6', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '78342', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB'], ], 'parameters' => [ [ - 'name' => 'SceneName', - 'in' => 'query', + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1234', 'title' => ''], + ], + [ + 'name' => 'ProjectEnv', + 'in' => 'formData', 'schema' => [ - 'title' => '场景名称关键字', - 'description' => 'The name of the data masking scenario. A fuzzy match is performed in the platform based on a keyword to search for the data masking scenario.'."\n", + 'description' => 'The environment of the workspace. Valid values: PROD and DEV.'."\n", 'type' => 'string', - 'required' => false, - 'example' => 'dev_', + 'required' => true, + 'docRequired' => true, + 'enum' => ['PROD', 'DEV'], + 'example' => 'PROD', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'OpenApiResultModel>', - 'description' => 'OpenApiResultModel\\'."\n", 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '1029030003', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'param error', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the data masking scenario.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'SceneCode' => [ - 'description' => 'The code of the level-1 data masking scenario. Valid values:'."\n" - ."\n" - .'* dataworks_display_desense_code: masking of displayed data in DataStudio and Data Map'."\n" - .'* maxcompute_desense_code: data masking at the MaxCompute compute engine layer'."\n" - .'* maxcompute_new_desense_code: data masking at the MaxCompute compute engine layer (new)'."\n" - .'* hologres_display_desense_code: data masking at the Hologres compute engine layer'."\n" - .'* dataworks_data_integration_desense_code: static data masking in Data Integration'."\n" - .'* dataworks_analysis_desense_code: masking of displayed data in DataAnalysis'."\n", - 'type' => 'string', - 'example' => 'dataworks_display_desense_code', - ], - 'Desc' => [ - 'description' => 'The description of the data masking scenario.'."\n", - 'type' => 'string', - 'example' => 'Test scenarios', - ], - 'SceneName' => [ - 'description' => 'The name of the data masking scenario.'."\n", - 'type' => 'string', - 'example' => 'test_scene', - ], - 'UserGroups' => [ - 'description' => 'The list of user groups in the data masking scenario. Separate user groups with commas (,).'."\n", - 'type' => 'string', - 'example' => 'user1,user2', - ], - 'SceneLevel' => [ - 'description' => 'The level of the data masking scenario. Valid values:'."\n" - ."\n" - .'* 0: level-1 data masking scenario'."\n" - .'* 1: level-2 data masking scenario'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Projects' => [ - 'description' => 'The information about the compute engine for which the data masking scenario takes effect.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the compute engine for which the data masking scenario takes effect.'."\n", - 'type' => 'object', - 'properties' => [ - 'DbType' => [ - 'description' => 'The type of the compute engine. Valid values:'."\n" - ."\n" - .'* ODPS: ODPS.ODPS'."\n" - .'* HOLO: HOLO.POSTGRES'."\n" - .'* EMR: EMR'."\n", - 'type' => 'string', - 'example' => 'ODPS.ODPS', - ], - 'ProjectName' => [ - 'description' => 'The name of the compute engine.'."\n", - 'type' => 'string', - 'example' => 'dev_project', - ], - 'ClusterId' => [ - 'description' => 'The ID of the EMR cluster. This parameter is returned only when the data scope that takes effect in the data masking scenario is an EMR compute engine.'."\n", - 'type' => 'string', - 'example' => 'c-1234', - ], - ], - ], - ], - 'Children' => [ - 'description' => 'The information about multiple levels of data masking scenarios.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'If multiple levels of data masking scenarios exist, which indicates that a data masking scenario contains sub-level data masking scenarios, the value of this parameter is the information about the sub-level data masking scenarios. The parameters are the same as the outer parameters.'."\n", - 'type' => 'any', - 'example' => '$ref', - ], - ], - ], - ], - ], - 'RequestId' => [ - 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => '102400001', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The data returned.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The connection does not exist.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'q32ety****', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'title' => 'RestartInstance', + 'summary' => 'Restarts an instance.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-08-12T08:46:57.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-08-12T08:46:57.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-08-12T08:46:57.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"q32ety****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'ResumeInstance' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '78343', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB'], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1234', 'title' => ''], + ], + [ + 'name' => 'ProjectEnv', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The environment of the workspace. Valid values: PROD and DEV.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'PROD', + 'enum' => ['PROD', 'DEV'], + 'title' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'DESENSSCENE.ID.ERROR', - 'errorMessage' => 'The desensitization scenario ID does not match or does not exist with the tenant.', - ], - [ - 'errorCode' => 'DESENSSCENE.IDLEVEL.ERROR', - 'errorMessage' => 'The desensitization scenario is not a secondary scenario.', - ], - [ - 'errorCode' => 'DESENSSCENE.PROJECT.ERROR', - 'errorMessage' => 'The project space does not exist.', - ], - [ - 'errorCode' => 'DESENSSCENE.SIZE.ERROR', - 'errorMessage' => 'The number of desens scene exceeds the limit.', - ], - [ - 'errorCode' => 'DESENSSCENE.UESRGROUP.ERROR', - 'errorMessage' => 'The user group ID does not match the tenant or does not exist.', - ], - [ - 'errorCode' => 'PARAMS.ERROR', - 'errorMessage' => 'param error.', + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The result returned.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The connection does not exist.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'E6F0DBDD-5AD****', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', ], ], - 403 => [ - [ - 'errorCode' => 'PERMISSION.DENIED.ERROR', - 'errorMessage' => 'Permission denied', - ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"E6F0DBDD-5AD****\\n200\\ntrue\\nInvalid.Tenant.ConnectionNotExists\\nThe connection does not exist.\\ntrue","errorExample":""}]', + 'title' => 'ResumeInstance', + 'summary' => 'Resumes a suspended instance.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-08-12T08:46:57.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-08-12T08:46:57.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-08-12T08:46:57.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'RevokeTablePermission' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], ], - 500 => [ - [ - 'errorCode' => 'UNKNOWN.ERROR', - 'errorMessage' => 'unknown error.', + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [], + 'parameters' => [ + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the DataWorks workspace with which the MaxCompute project is associated. You can log on to the DataWorks console and go to the Workspace page to obtain the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9999999', 'minimum' => '1', 'example' => '12345'], + ], + [ + 'name' => 'MaxComputeProjectName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the MaxCompute project to which the table belongs. You can log on to the DataWorks console and go to the SettingCenter page to obtain the name of the MaxCompute project that you associate with the workspace.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'aMaxcomputeProjectName'], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the MaxCompute table. You can call the [SearchMetaTables](~~173919~~) operation to query the name of the MaxCompute table.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'aTableName'], + ], + [ + 'name' => 'Actions', + 'in' => 'query', + 'schema' => ['description' => 'The permissions that you want to revoke. Separate multiple permissions with commas (,). You can revoke only the SELECT, DESCRIBE, and DOWNLOAD permissions on MaxCompute tables.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Select,Describe'], + ], + [ + 'name' => 'RevokeUserName', + 'in' => 'query', + 'schema' => ['description' => 'The Alibaba Cloud account from which you want to revoke permissions. Specify this parameter in the format that is the same as the format of the account used to access the MaxCompute project.'."\n" + ."\n" + .'* If the account is an Alibaba Cloud account, the value is in the ALIYUN$+Account name format.'."\n" + .'* If the account is a RAM user, the value is in the RAM$+Account name format.'."\n" + ."\n" + .'You must specify either this parameter or the RevokeUserId parameter. If you specify both this parameter and the RevokeUserId parameter and the parameter values are different, the value of the RevokeUserId parameter prevails.'."\n", 'type' => 'string', 'required' => false, 'example' => 'RAM$dataworks_3h1_1:stsramuser'], + ], + [ + 'name' => 'RevokeUserId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the Alibaba Cloud account from which you want to revoke permissions. You can log on to the DataWorks console and go to the Security Settings page to obtain the ID. You must specify either this parameter or the RevokeUserName parameter. If you specify both this parameter and the RevokeUserName parameter and the parameter values are different, the value of this parameter prevails.'."\n", 'type' => 'string', 'required' => false, 'example' => '267842600408993176'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RevokeSuccess' => ['description' => 'Indicates whether the permissions are revoked.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0bc1ec92159376****'], + ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1029030003\\",\\n \\"ErrorMessage\\": \\"param error\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": [\\n {\\n \\"Id\\": 123,\\n \\"SceneCode\\": \\"dataworks_display_desense_code\\",\\n \\"Desc\\": \\"Test scenarios\\",\\n \\"SceneName\\": \\"test_scene\\",\\n \\"UserGroups\\": \\"user1,user2\\",\\n \\"SceneLevel\\": 1,\\n \\"Projects\\": [\\n {\\n \\"DbType\\": \\"ODPS.ODPS\\",\\n \\"ProjectName\\": \\"dev_project\\",\\n \\"ClusterId\\": \\"c-123456\\"\\n }\\n ],\\n \\"Children\\": [\\n \\"$ref\\"\\n ]\\n }\\n ],\\n \\"RequestId\\": \\"102400001\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 1029030003\\n param error\\n 400\\n \\n 123\\n dataworks_display_desense_code\\n 测试用场景\\n test_scene\\n user1,user2\\n 1\\n \\n ODPS.ODPS\\n dev_project\\n c-1234\\n \\n $ref\\n \\n 102400001\\n","errorExample":""}]', - 'title' => 'DsgSceneQuerySceneListByName', - ], - 'DsgUserGroupAddOrUpdate' => [ - 'summary' => 'Adds or modifies a user group.', - 'methods' => [ - 'post', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RevokeSuccess\\": true,\\n \\"RequestId\\": \\"0bc1ec92159376****\\"\\n}","errorExample":""},{"type":"xml","example":"true\\n0bc1ec92159376****","errorExample":""}]', + 'title' => 'RevokeTablePermission', + 'summary' => 'Revokes permissions on a table from a user.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-04-28T08:54:54.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'RunCycleDagNodes' => [ + 'summary' => 'Creates a workflow to backfill data.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '219456', - 'abilityTreeNodes' => [ - 'FEATUREdideRZM9W6', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '78346', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB'], ], 'parameters' => [ [ - 'name' => 'UserGroups', - 'in' => 'query', - 'style' => 'json', + 'name' => 'ProjectEnv', + 'in' => 'formData', 'schema' => [ - 'description' => 'The information about the user group.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The user group ID.'."\n" - ."\n" - .'* If you do not configure this parameter, the current operation is to add a user group.'."\n" - .'* If you configure this parameter, the current operation is to modify a user group. You can call the [DsgUserGroupQueryList](~~2786441~~) operation to query the user group ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123', - ], - 'Name' => [ - 'description' => 'The name of the user group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'yun_group', - ], - 'Owner' => [ - 'description' => 'The owner of the user group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'user1', - ], - 'Accounts' => [ - 'description' => 'The users in the group.'."\n" - ."\n" - .'* If a user group is created by using an Alibaba Cloud account and a RAM role, you can call the [DsgUserGroupQueryUserList](~~2786445~~) operation to query the users in the group.'."\n" - .'* If a user group is created by using a MaxCompute role, you can call the [DsgUserGroupQueryUserList](~~2785695~~) operation to query the users in the group.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The username or MaxCompute role. This parameter must be configured based on the value of the UserGroupType parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'user1', - ], - 'required' => true, - ], - 'ProjectName' => [ - 'description' => 'The name of the MaxCompute project. You must configure this parameter when you create a MaxCompute user group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dev_project', - ], - 'UserGroupType' => [ - 'description' => 'The type of the user group. Valid values:'."\n" - ."\n" - .'* 1: Alibaba Cloud account'."\n" - .'* 2: RAM role'."\n" - .'* 3: MaxCompute role'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], - ], - 'required' => true, - ], + 'description' => 'The environment of the workspace. Valid values: PROD and DEV. The value PROD indicates the production environment, and the value DEV indicates the development environment.'."\n", + 'type' => 'string', 'required' => true, + 'docRequired' => true, + 'example' => 'PROD', + 'enum' => ['PROD', 'DEV'], + 'title' => '', + ], + ], + [ + 'name' => 'StartBizDate', + 'in' => 'formData', + 'schema' => ['description' => 'The data timestamp at which data starts to be backfilled. Specify the value in the yyyy-MM-dd 00:00:00 format.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-05-20 00:00:00', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the workflow.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'xm_test', 'maxLength' => 128, 'title' => ''], + ], + [ + 'name' => 'RootNodeId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the node for which data is first backfilled. You can call the [ListNodes](~~173979~~) operation to obtain the node ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1234', 'title' => ''], + ], + [ + 'name' => 'ExcludeNodeIds', + 'in' => 'formData', + 'schema' => ['description' => 'The IDs of the nodes for which no data needs to be backfilled. The system generates dry-run instances for all these nodes. After these dry-run instances are scheduled, the statuses of these instances are directly set to successful, but the script is not run.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '1234,123465', 'title' => ''], + ], + [ + 'name' => 'BizBeginTime', + 'in' => 'formData', + 'schema' => ['description' => 'The time when the node starts to run. This parameter is required only for auto triggered nodes that are scheduled by hour. Specify the value in the HH:mm:ss format. Valid values: 00:00:00 to 23:59:59.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '00:00:00', 'title' => ''], + ], + [ + 'name' => 'BizEndTime', + 'in' => 'formData', + 'schema' => ['description' => 'The time when the node stops running. This parameter is required only for auto triggered nodes that are scheduled by hour. Specify the value in the HH:mm:ss format. Valid values: 00:00:00 to 23:59:59.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '01:00:00', 'title' => ''], + ], + [ + 'name' => 'Parallelism', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether data can be backfilled for multiple nodes at the same time.'."\n", 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'EndBizDate', + 'in' => 'formData', + 'schema' => ['description' => 'The data timestamp at which data is no longer backfilled. Specify the value in the yyyy-MM-dd 00:00:00 format.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-05-21 00:00:00', 'title' => ''], + ], + [ + 'name' => 'NodeParams', + 'in' => 'formData', + 'schema' => ['description' => 'The parameters that need to be configured for the node. Set this parameter to a JSON string. The key indicates the ID of the node, and the value indicates the actual values of the parameters.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '{74324:"a=123 b=456"}', 'title' => ''], + ], + [ + 'name' => 'IncludeNodeIds', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the node for which you want to backfill data. If you want to backfill data for multiple nodes, separate the IDs of the nodes with commas (,). You can call the [ListNodes](~~173979~~) operation to obtain the node ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '74324,74325', 'title' => ''], + ], + [ + 'name' => 'StartFutureInstanceImmediately', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to immediately run an instance that is scheduled to run in the future. If you set this parameter to true, the instance that is scheduled to run in the future is run immediately. Otherwise, the instance is run as scheduled.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'default' => 'false', 'title' => ''], + ], + [ + 'name' => 'ConcurrentRuns', + 'in' => 'formData', + 'schema' => ['description' => 'The number of nodes that can run in parallel. Valid values: 2 to 10.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10', 'minimum' => '2', 'example' => '5', 'title' => ''], + ], + [ + 'name' => 'AlertType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The alert type. Valid values:'."\n" + ."\n" + .'* SUCCESS: An alert is generated when data backfill succeeds.'."\n" + .'* FAILURE: An alert is generated when data backfill fails.'."\n" + .'* SUCCESS_FAILURE: An alert is generated regardless of whether data backfill succeeds or fails.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'FAILURE', + 'enum' => ['SUCCESS', 'FAILURE', 'SUCCESS_FAILURE'], + 'title' => '', + ], + ], + [ + 'name' => 'AlertNoticeType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The alert notification method. Valid values:'."\n" + ."\n" + .'* SMS'."\n" + .'* MAIL'."\n" + .'* SMS_MAIL'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'SMS', + 'enum' => ['SMS', 'MAIL', 'SMS_MAIL'], + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'OpenApiResultModel', - 'description' => 'OpenApiResultModel'."\n", + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '1029030003', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'param error', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. You can use the request ID to query logs and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '>E6F0DBDD-5AD****', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The connection does not exist.', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], 'Data' => [ - 'description' => 'The operation result. Valid values:'."\n" - ."\n" - .'* true: The operation is successful.'."\n" - .'* false: The operation fails.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can use the ID to locate logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '102400001', + 'description' => 'The IDs of the nodes in the workflow. You can query instances based on the IDs.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The ID of the node in the workflow.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '111', 'title' => ''], + 'title' => '', ], ], + 'title' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'USERGROUP.ACCOUNTLISTSIZE.ERROR', - 'errorMessage' => 'The number of account exceeds the limit.', - ], - [ - 'errorCode' => 'USERGROUP.ID.ERROR', - 'errorMessage' => 'The user group ID does not match the tenant or does not exist.', - ], - [ - 'errorCode' => 'USERGROUP.LISTSIZE.ERROR', - 'errorMessage' => 'The number of user groups exceeds the limit.', - ], - [ - 'errorCode' => 'USERGROUP.PAGESIZE.ERROR', - 'errorMessage' => 'Page size is too large, maximum of 100.', - ], - [ - 'errorCode' => 'USERACCOUNT.OWNER.ERROR', - 'errorMessage' => 'User list or owner user does not exist.', - ], - [ - 'errorCode' => 'PARAMS.ERROR', - 'errorMessage' => 'param error.', - ], - ], - 403 => [ - [ - 'errorCode' => 'PERMISSION.DENIED.ERROR', - 'errorMessage' => 'Permission denied', - ], - ], - 500 => [ - [ - 'errorCode' => 'UNKNOWN.ERROR', - 'errorMessage' => 'unknown error.', + 'title' => 'RunCycleDagNodes', + 'description' => 'For more information about data backfill, see [Backfill data](~~137937~~).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1029030003\\",\\n \\"ErrorMessage\\": \\"param error\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"102400001\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 1029030003\\n param error\\n 400\\n true\\n 102400001\\n","errorExample":""}]', - 'title' => 'DsgUserGroupAddOrUpdate', - ], - 'DsgUserGroupQueryList' => [ - 'summary' => 'Queries a list of user groups in Data Security Guard.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\">E6F0DBDD-5AD****\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Data\\": [\\n 111\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n >E6F0DBDD-5AD****\\n The connection does not exist.\\n true\\n Invalid.Tenant.ConnectionNotExists\\n 111\\n","errorExample":""}]', + ], + 'RunManualDagNodes' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '219454', - 'abilityTreeNodes' => [ - 'FEATUREdideRZM9W6', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '78347', + 'abilityTreeNodes' => ['FEATUREdideD0YY7B'], ], 'parameters' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', + 'name' => 'ProjectEnv', + 'in' => 'formData', 'schema' => [ - 'title' => '页码', - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The environment type of Operation Center. Valid values: PROD and DEV. The value PROD indicates the production environment. The value DEV indicates the development environment.'."\n", + 'enumValueTitles' => [], + 'type' => 'string', 'required' => true, - 'example' => '1', + 'docRequired' => true, + 'enum' => ['PROD', 'DEV'], + 'example' => 'PROD or DEV', + 'title' => '', ], ], [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '页大小', - 'description' => 'The number of entries per page. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '10', - ], + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the workspace to which the manually triggered workflow belongs.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'pattern' => '^([^\\x00-\\xff]|[\\w.,;/@\\n-])+$', 'example' => 'test_workspace', 'title' => ''], ], [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'title' => '用户组名称', - 'description' => 'The keyword of the user group name. A fuzzy match is performed based on the keyword to search for the user group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'yun_group', - ], + 'name' => 'FlowName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the manually triggered workflow.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'pattern' => '^([^\\x00-\\xff]|[\\w.,;/@\\n-])+$', 'example' => 'test_workflow', 'title' => ''], ], [ - 'name' => 'Owner', - 'in' => 'query', - 'schema' => [ - 'title' => '负责人', - 'description' => 'The owner of the user group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'user1', - ], + 'name' => 'BizDate', + 'in' => 'formData', + 'schema' => ['description' => 'The data timestamp. The value of the data timestamp must be one or more days before the current date. For example, if the current date is November 11, 2020, set the value to 2020-11-10 00:00:00 or earlier. Configure this parameter in the YYYY-MM-DD 00:00:00 format. The StartBizDate parameter is used together with the EndBizDate parameter. You can configure only the BizDate parameter or the StartBizDate and EndBizDate parameters.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '2020-11-11 00:00:00', 'title' => ''], ], [ - 'name' => 'ProjectName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the compute engine. If you want to query the information about a MaxCompute user group, you need to configure this parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dev_project', - ], + 'name' => 'NodeParameters', + 'in' => 'formData', + 'schema' => ['description' => 'The scheduling parameters of nodes in the manually triggered workflow. Configure NodeParameters in the following JSON format: {"\\": "Scheduling parameter settings of the node, which are in the same format as the parameter settings in the Scheduling Parameter section of the Properties tab on the DataStudio page", "\\": "Scheduling parameter settings of the node, which are in the same format as the parameter settings in the Scheduling Parameter section of the Properties tab on the DataStudio page"}.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '{"20000123121": "key1=val2 key2=val2", "20000123124": "kkkk=vvvvv aaaa=bbbb"}', 'title' => ''], + ], + [ + 'name' => 'DagParameters', + 'in' => 'formData', + 'schema' => ['description' => 'The parameters are synchronized to all the instances in the directed acyclic graph (DAG) of the workflow. If a workflow parameter specified in DagParameters is referenced as a scheduling parameter of a [node](~~147245~~), the value of the scheduling parameter is replaced with the value of the workflow parameter.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '{"kaaaa": "vaaaaa", "kbbbb": "vbbbbb"}', 'title' => ''], + ], + [ + 'name' => 'IncludeNodeIds', + 'in' => 'formData', + 'schema' => ['description' => 'The IDs of the nodes that you need to run in the manually triggered workflow. Separate multiple node IDs with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => '74324,74325', 'title' => ''], + ], + [ + 'name' => 'ExcludeNodeIds', + 'in' => 'formData', + 'schema' => ['description' => 'The IDs of the nodes that you do not need to run in the manually triggered workflow. DataWorks generates dry-run instances for all these nodes. After the dry-run instances are scheduled, the states of these instances are directly set to successful, but the scripts are not run. Separate multiple node IDs with commas (,). The ExcludeNodeIds parameter must be used together with the IncludeNodeIds parameter. This way, the settings of the ExcludeNodeIds parameter can take effect.'."\n", 'type' => 'string', 'required' => false, 'example' => '123,456', 'title' => ''], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the workspace to which the manually triggered workflow belongs.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', 'title' => ''], + ], + [ + 'name' => 'StartBizDate', + 'in' => 'formData', + 'schema' => ['description' => 'The beginning of the time range in which data generated needs to be processed. Configure this parameter in the yyyy-MM-dd HH:mm:ss format. The StartBizDate parameter is used together with the EndBizDate parameter. You can configure only the BizDate parameter or the StartBizDate and EndBizDate parameters.'."\n", 'type' => 'string', 'required' => false, 'example' => '2020-02-02 00:00:00', 'title' => ''], + ], + [ + 'name' => 'EndBizDate', + 'in' => 'formData', + 'schema' => ['description' => 'The end of the time range in which data generated needs to be processed. Configure this parameter in the yyyy-MM-dd HH:mm:ss format. The StartBizDate parameter is used together with the EndBizDate parameter. You can configure only the BizDate parameter or the StartBizDate and EndBizDate parameters.'."\n", 'type' => 'string', 'required' => false, 'example' => '2020-02-03 00:00:00', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'OpenApiResultModel>', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '1029030003', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'param error', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - ], - 'PageData' => [ - 'description' => 'The pagination information.'."\n", - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of user groups returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'Data' => [ - 'description' => 'The user groups.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Accounts' => [ - 'description' => 'The usernames in the user group.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The username.'."\n", - 'type' => 'string', - 'example' => 'user1', - ], - ], - 'Id' => [ - 'description' => 'The user group ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '123', - ], - 'GmtCreate' => [ - 'description' => 'The time when the user group was created.'."\n", - 'type' => 'string', - 'example' => '2024-05-10 17:14:44', - ], - 'GmtModified' => [ - 'description' => 'The time when the user group was modified.'."\n", - 'type' => 'string', - 'example' => '2024-05-10 17:14:44', - ], - 'Name' => [ - 'description' => 'The name of the user group.'."\n", - 'type' => 'string', - 'example' => 'test_group', - ], - 'Owner' => [ - 'description' => 'The owner of the user group.'."\n", - 'type' => 'string', - 'example' => 'user1', - ], - ], - ], - 'example' => '', - ], - ], - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '102400001', - ], + 'DagId' => ['description' => 'The ID of the DAG for the manually triggered workflow. You can call an operation with this parameter as a request parameter to query the details and states of the nodes in the manually triggered workflow.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '700000123123141', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'AASFDFSDFG-DFSDF-DFSDFD-SDFSDF', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'PARAMS.ERROR', - 'errorMessage' => 'param error.', - ], - [ - 'errorCode' => 'USERGROUP.ACCOUNTLISTSIZE.ERROR', - 'errorMessage' => 'The number of account exceeds the limit.', - ], - [ - 'errorCode' => 'USERGROUP.ID.ERROR', - 'errorMessage' => 'The user group ID does not match the tenant or does not exist.', - ], - [ - 'errorCode' => 'USERGROUP.LISTSIZE.ERROR', - 'errorMessage' => 'The number of user groups exceeds the limit.', - ], - [ - 'errorCode' => 'USERGROUP.PAGESIZE.ERROR', - 'errorMessage' => 'Page size is too large, maximum of 100.', - ], - [ - 'errorCode' => 'USERACCOUNT.OWNER.ERROR', - 'errorMessage' => 'User list or owner user does not exist.', - ], - ], - 403 => [ - [ - 'errorCode' => 'PERMISSION.DENIED.ERROR', - 'errorMessage' => 'Permission denied', - ], - ], - 500 => [ - [ - 'errorCode' => 'UNKNOWN.ERROR', - 'errorMessage' => 'unknown error.', + 'title' => 'RunManualDagNodes', + 'summary' => 'Runs nodes in a manually triggered workflow. Before you call this operation, make sure that the manually triggered workflow is committed and deployed. You can find a manually triggered workflow in Operation Center only after the manually triggered workflow is committed and deployed.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-06-25T08:45:29.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-04-12T03:29:09.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-01-05T02:11:00.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-08-12T08:46:57.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-08-12T08:46:57.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-08-12T08:46:57.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1029030003\\",\\n \\"ErrorMessage\\": \\"param error\\",\\n \\"HttpStatusCode\\": 400,\\n \\"PageData\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Data\\": [\\n {\\n \\"Accounts\\": [\\n \\"user1\\"\\n ],\\n \\"Id\\": 123,\\n \\"GmtCreate\\": \\"2024-05-10 17:14:44\\",\\n \\"GmtModified\\": \\"2024-05-10 17:14:44\\",\\n \\"Name\\": \\"test_group\\",\\n \\"Owner\\": \\"user1\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"102400001\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 1029030003\\n param error\\n 400\\n \\n 1\\n 10\\n 100\\n \\n user1\\n 123\\n 2024-05-10 17:14:44\\n 2024-05-10 17:14:44\\n test_group\\n user1\\n \\n \\n 102400001\\n","errorExample":""}]', - 'title' => 'DsgUserGroupQueryList', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"DagId\\": 700000123123141,\\n \\"RequestId\\": \\"AASFDFSDFG-DFSDF-DFSDFD-SDFSDF\\"\\n}","type":"json"}]', ], - 'DsgUserGroupQueryUserList' => [ - 'summary' => 'Queries a list of users or roles of the current tenant.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'RunSmokeTest' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '219455', - 'abilityTreeNodes' => [ - 'FEATUREdideRZM9W6', + 'operationType' => 'get', + 'abilityTreeCode' => '78348', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB'], + ], + 'parameters' => [ + [ + 'name' => 'ProjectEnv', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The environment of the workspace. Valid values: PROD and DEV. The value PROD indicates the production environment, and the value DEV indicates the development environment. A workspace in basic mode does not have a development environment. For more information, see [Differences between workspaces in basic mode and workspaces in standard mode](~~85772~~).'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'PROD', + 'enum' => ['PROD', 'DEV'], + ], + ], + [ + 'name' => 'Bizdate', + 'in' => 'formData', + 'schema' => ['description' => 'The data timestamp.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2020-05-26 00:00:00'], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the workflow.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'xm_create_test', 'maxLength' => 128], + ], + [ + 'name' => 'NodeId', + 'in' => 'formData', + 'schema' => ['description' => 'The node ID. You can call the [ListNodes](~~173979~~) operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1234'], + ], + [ + 'name' => 'NodeParams', + 'in' => 'formData', + 'schema' => ['description' => 'The parameters related to the node. Set this parameter to a JSON string. A key in the string indicates a parameter, and a value in the string indicates the value of the related parameter.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'bizdate=$bizdate tbods=$tbods'], ], ], - 'parameters' => [], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'OpenApiResultModel>', - 'description' => 'The response parameters.'."\n", + 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '1029030003', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'param error', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - ], - 'Data' => [ - 'description' => 'The returned result.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'AccountName' => [ - 'description' => 'The name of the user.'."\n", - 'type' => 'string', - 'example' => 'user1', - ], - 'YunAccount' => [ - 'description' => 'The name of the Alibaba Cloud account or RAM role. The return value of this parameter must be used if the user group is created by using an Alibaba Cloud account or a RAM role.'."\n", - 'type' => 'string', - 'example' => 'user:user1', - ], - 'AccountType' => [ - 'description' => 'The type of the user. Valid values:'."\n" - ."\n" - .'* 1 to 5: Alibaba Cloud account'."\n" - .'* 6: RAM role'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'BaseId' => [ - 'description' => 'The user ID or role ID.'."\n", - 'type' => 'string', - 'example' => '234', - ], - 'ParentAccountId' => [ - 'description' => 'The parent user ID. This parameter is required if a RAM user is used.'."\n", - 'type' => 'string', - 'example' => '123', - ], - ], - ], - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '102400001', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Data' => ['description' => 'The workflow ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '3333333'], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The connection does not exist.'], + 'RequestId' => ['description' => 'The request ID. You can use the ID to locate logs and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'E6F0DBDD-5AD****'], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists'], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'false'], ], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'USERGROUP.ACCOUNTLISTSIZE.ERROR', - 'errorMessage' => 'The number of account exceeds the limit.', - ], - [ - 'errorCode' => 'USERGROUP.ID.ERROR', - 'errorMessage' => 'The user group ID does not match the tenant or does not exist.', - ], - [ - 'errorCode' => 'USERGROUP.LISTSIZE.ERROR', - 'errorMessage' => 'The number of user groups exceeds the limit.', - ], - [ - 'errorCode' => 'USERGROUP.PAGESIZE.ERROR', - 'errorMessage' => 'Page size is too large, maximum of 100.', - ], - [ - 'errorCode' => 'USERACCOUNT.OWNER.ERROR', - 'errorMessage' => 'User list or owner user does not exist.', - ], - [ - 'errorCode' => 'PARAMS.ERROR', - 'errorMessage' => 'param error.', - ], - ], - 403 => [ - [ - 'errorCode' => 'PERMISSION.DENIED.ERROR', - 'errorMessage' => 'Permission denied', - ], - ], - 500 => [ - [ - 'errorCode' => 'UNKNOWN.ERROR', - 'errorMessage' => 'unknown error.', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 3333333,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": false\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 3333333\\n The connection does not exist.\\n E6F0DBDD-5AD****\\n Invalid.Tenant.ConnectionNotExists\\n false\\n","errorExample":""}]', + 'title' => 'RunSmokeTest', + 'summary' => 'Creates a workflow to perform smoke testing.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-08-12T08:46:57.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-08-12T08:46:57.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-08-12T08:46:57.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1029030003\\",\\n \\"ErrorMessage\\": \\"param error\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": [\\n {\\n \\"AccountName\\": \\"user1\\",\\n \\"YunAccount\\": \\"user:user1\\",\\n \\"AccountType\\": 2,\\n \\"BaseId\\": \\"234\\",\\n \\"ParentAccountId\\": \\"123\\"\\n }\\n ],\\n \\"RequestId\\": \\"102400001\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 1029030003\\n param error\\n 400\\n \\n user1\\n user:user1\\n 2\\n 234\\n 123\\n \\n 102400001\\n","errorExample":""}]', - 'title' => 'DsgUserGroupQueryUserList', ], - 'DsgDesensPlanQueryList' => [ - 'summary' => 'Queries a list of data masking rules.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'RunTriggerNode' => [ + 'methods' => ['post', 'get', 'put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '219758', - 'abilityTreeNodes' => [ - 'FEATUREdideRZM9W6', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '78349', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB', 'FEATUREdideVFMENL'], ], 'parameters' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '10', - ], - ], - [ - 'name' => 'SceneId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the level-2 data masking scenario. You can call the [DsgSceneQuerySceneListByName](~~2786322~~) operation to query the list of IDs.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '123', - ], + 'name' => 'NodeId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the manually triggered node. You can call the [ListNodes](~~173979~~) operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '-9223372036854775808', 'example' => '10000011'], ], [ - 'name' => 'RuleName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the sensitive field.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'phone', - ], + 'name' => 'CycleTime', + 'in' => 'formData', + 'schema' => ['description' => 'The scheduling time to run the manually triggered node. Set the value to a 13-digit timestamp in milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '-9223372036854775808', 'example' => '1606200230105'], ], [ - 'name' => 'Owner', - 'in' => 'query', - 'schema' => [ - 'description' => 'The owner of the data masking rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'user1', - ], + 'name' => 'BizDate', + 'in' => 'formData', + 'schema' => ['description' => 'The data timestamp of the instance that is generated for the manually triggered node.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '-9223372036854775808', 'example' => '1606200230105'], ], [ - 'name' => 'Status', - 'in' => 'query', - 'schema' => [ - 'description' => 'The status of the data masking rule. Valid values:'."\n" - ."\n" - .'* 0: expired'."\n" - .'* 1: effective'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'name' => 'AppId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the DataWorks workspace to which the manually triggered node belongs. You can call the [ListProjects](~~178393~~) operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '-9223372036854775808', 'example' => '10001'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'OpenApiResultModel>', - 'description' => 'OpenApiResultModel\\'."\n", 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '1029030003', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'param error', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - ], - 'PageData' => [ - 'description' => 'The pagination information.'."\n", - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The number of data masking rules.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'Data' => [ - 'description' => 'The information about the data masking rule.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '脱敏规则id', - 'description' => 'The ID of the data masking rule.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'DataType' => [ - 'title' => '敏感类型', - 'description' => 'The sensitive field type.'."\n", - 'type' => 'string', - 'example' => 'phone', - ], - 'RuleName' => [ - 'title' => '脱敏规则名称', - 'description' => 'The name of the data masking rule.'."\n", - 'type' => 'string', - 'example' => 'phone_hash', - ], - 'DesensPlan' => [ - 'title' => '脱敏规则详情', - 'description' => 'The details of the data masking rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'DesensPlanType' => [ - 'description' => 'The type of the data masking rule.'."\n", - 'type' => 'string', - 'example' => 'hash', - ], - 'ExtParam' => [ - 'description' => 'The parameters for the data masking rule. For more information about the parameters, see the [DsgDesensPlanAddOrUpdate](~~2786295~~) API reference.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'example' => '"extParam": { "algo":"MD5", "salt":"5" }', - 'description' => 'The details of the data masking rule parameters.'."\n", - ], - ], - ], - ], - 'Owner' => [ - 'title' => '负责人', - 'description' => 'The owner of the data masking rule.'."\n", - 'type' => 'string', - 'example' => 'user1', - ], - 'GmtCreate' => [ - 'title' => '规则创建时间', - 'description' => 'The time when the data masking rule was created.'."\n", - 'type' => 'string', - 'example' => '2024-05-09 15:46:20', - ], - 'GmtModified' => [ - 'title' => '规则修改时间', - 'description' => 'The time when the data masking rule was modified.'."\n", - 'type' => 'string', - 'example' => '2024-05-09 15:46:20', - ], - 'Status' => [ - 'title' => '生效状态0/1', - 'description' => 'The status of the data masking rule. Valid values:'."\n" - ."\n" - .'* 0: expired'."\n" - .'* 1: effective'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'DesensWay' => [ - 'title' => '脱敏方式', - 'description' => 'The data masking method.'."\n", - 'type' => 'string', - 'example' => 'HASH', - ], - 'DesenMode' => [ - 'title' => '脱敏方式类型', - 'description' => 'The type of the data masking method.'."\n", - 'type' => 'string', - 'example' => 'HASH', - ], - 'DesensRule' => [ - 'title' => '脱敏规则', - 'description' => 'The data masking rule.'."\n", - 'type' => 'string', - 'example' => 'HASH', - ], - 'SceneCode' => [ - 'title' => '一级场景code', - 'description' => 'The code of the level-1 data masking scenario to which the rule belongs. Valid values:'."\n" - ."\n" - .'* dataworks_display_desense_code: masking of displayed data in DataStudio and Data Map'."\n" - .'* maxcompute_desense_code: data masking at the MaxCompute compute engine layer'."\n" - .'* maxcompute_new_desense_code: data masking at the MaxCompute compute engine layer (new)'."\n" - .'* hologres_display_desense_code: data masking at the Hologres compute engine layer'."\n" - .'* dataworks_data_integration_desense_code: static data masking in Data Integration'."\n" - .'* dataworks_analysis_desense_code: masking of displayed data in DataAnalysis'."\n", - 'type' => 'string', - 'example' => 'dataworks_display_desense_code', - ], - 'CheckWatermark' => [ - 'title' => '是否插入水印', - 'description' => 'Indicates whether a watermark is added. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'SceneName' => [ - 'title' => '二级场景名称', - 'description' => 'The name of the level-2 data masking scenario to which the data masking rule belongs.'."\n", - 'type' => 'string', - 'example' => 'test_scene', - ], - ], - ], - ], - ], - ], - 'RequestId' => [ - 'description' => 'The request ID. You can use the ID to locate logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '102400001', - ], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '9BA675F1-F848-4752-A6E3-92ABA0616005'], ], + 'description' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'DESENSPLAN.DATATYPE.ERROR', - 'errorMessage' => 'Sensitive type already has a desensitization rule.', - ], - [ - 'errorCode' => 'DESENSPLAN.DATATYPENOTEXIST.ERROR', - 'errorMessage' => 'Sensitive type not exist.', - ], - [ - 'errorCode' => 'DESENSPLAN.ID.ERROR', - 'errorMessage' => 'Desensitization rule ID does not exist.', - ], - [ - 'errorCode' => 'DESENSPLAN.PAGESIZE.ERROR', - 'errorMessage' => 'Page size is too large, maximum of 100.', - ], - [ - 'errorCode' => 'DESENSPLAN.PARAM.ERROR', - 'errorMessage' => 'Desensitization rule parameter error.', - ], - [ - 'errorCode' => 'DESENSPLAN.SCENECODE.ERROR', - 'errorMessage' => 'Scene code does not exist.', - ], - [ - 'errorCode' => 'DESENSPLAN.SCENEID.ERROR', - 'errorMessage' => 'Scene ID does not exist.', - ], - [ - 'errorCode' => 'DESENSPLAN.SCENEIDLEVEL.ERROR', - 'errorMessage' => 'The scene is not a secondary scene.', - ], - [ - 'errorCode' => 'DESENSPLAN.SIZE.ERROR', - 'errorMessage' => 'The number of desens plan exceeds the limit.', - ], - [ - 'errorCode' => 'PARAMS.ERROR', - 'errorMessage' => 'param error.', - ], - ], 403 => [ - [ - 'errorCode' => 'PERMISSION.DENIED.ERROR', - 'errorMessage' => 'Permission denied', - ], + ['errorCode' => 'ResourceNotAuthorized.Api', 'errorMessage' => 'You are not authorized to access the resources.', 'description' => ''], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'UNKNOWN.ERROR', - 'errorMessage' => 'unknown error.', - ], + ['errorCode' => 'Forbidden.Not.Server', 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.', 'description' => ''], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1029030003\\",\\n \\"ErrorMessage\\": \\"param error\\",\\n \\"HttpStatusCode\\": 400,\\n \\"PageData\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Data\\": [\\n {\\n \\"Id\\": 123,\\n \\"DataType\\": \\"phone\\",\\n \\"RuleName\\": \\"phone_hash\\",\\n \\"DesensPlan\\": {\\n \\"DesensPlanType\\": \\"hash\\",\\n \\"ExtParam\\": {\\n \\"key\\": \\"\\\\\\"extParam\\\\\\": { \\\\\\"algo\\\\\\":\\\\\\"MD5\\\\\\", \\\\\\"salt\\\\\\":\\\\\\"5\\\\\\" }\\"\\n }\\n },\\n \\"Owner\\": \\"user1\\",\\n \\"GmtCreate\\": \\"2024-05-09 15:46:20\\",\\n \\"GmtModified\\": \\"2024-05-09 15:46:20\\",\\n \\"Status\\": 1,\\n \\"DesensWay\\": \\"HASH\\",\\n \\"DesenMode\\": \\"HASH\\",\\n \\"DesensRule\\": \\"HASH\\",\\n \\"SceneCode\\": \\"dataworks_display_desense_code\\",\\n \\"CheckWatermark\\": true,\\n \\"SceneName\\": \\"test_scene\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"102400001\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 1029030003\\n param error\\n 400\\n \\n 1\\n 10\\n 100\\n \\n 123\\n phone\\n phone_hash\\n \\n hash\\n \\n \\"extParam\\": { \\"algo\\":\\"MD5\\", \\"salt\\":\\"5\\" }\\n \\n \\n user1\\n 2024-05-09 15:46:20\\n 2024-05-09 15:46:20\\n 1\\n HASH\\n HASH\\n HASH\\n dataworks_display_desense_code\\n true\\n test_scene\\n \\n \\n 102400001\\n","errorExample":""}]', - 'title' => 'DsgDesensPlanQueryList', - ], - 'DsgWhiteListAddOrUpdate' => [ - 'summary' => 'Adds or modifies a data masking whitelist.', - 'methods' => [ - 'post', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"9BA675F1-F848-4752-A6E3-92ABA0616005\\"\\n}","errorExample":""},{"type":"xml","example":"9BA675F1-F848-4752-A6E3-92ABA0616005\\ntrue","errorExample":""}]', + 'title' => 'RunTriggerNode', + 'summary' => 'Runs a manually triggered node.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-02-20T12:31:36.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-01-05T03:53:54.000Z', 'description' => 'Error codes changed, Response parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'SaveDataServiceApiTestResult' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -56127,754 +34877,413 @@ ], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '219461', - 'abilityTreeNodes' => [ - 'FEATUREdideRZM9W6', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '169364', + 'abilityTreeNodes' => ['FEATUREdideNC84FD'], ], 'parameters' => [ [ - 'name' => 'WhiteLists', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'A collection of whitelists.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RuleId' => [ - 'description' => 'The ID of the data masking rule. You can call the [DsgDesensPlanQueryList](~~2786578~~) operation to query the ID of the data masking rule.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '123', - ], - 'Id' => [ - 'description' => 'The ID of the data masking whitelist.'."\n" - ."\n" - .'* If you do not configure this parameter, the current operation is to add a data masking whitelist.'."\n" - .'* If you configure this parameter, the current operation is to modify a data masking whitelist. You can call the [DsgWhiteListQueryList](~~2786508~~) operation to query the whitelist ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '123', - ], - 'StartTime' => [ - 'description' => 'The beginning of the time range to query.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '2024-04-10 00:00:00', - ], - 'EndTime' => [ - 'description' => 'The end of the time range to query. If you enter null, the whitelist is valid permanently.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'null', - ], - 'UserGroupIds' => [ - 'description' => 'A collection of user group IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The user group ID. You can call the [DsgUserGroupQueryList](~~2786441~~) operation to query the user group ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '123', - ], - 'required' => true, - ], - ], - 'required' => false, - ], - 'required' => true, - ], + 'name' => 'ApiId', + 'in' => 'formData', + 'schema' => ['description' => 'The API ID. You can call the [ListDataServiceApis](~~174012~~) operation to obtain the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '417381955954827'], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'OpenApiResultModel', - 'description' => 'The returned results.'."\n", - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '1029030003', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'param error', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - ], - 'Data' => [ - 'description' => 'The operation result. Valid values:'."\n" - ."\n" - .'* true: The operation is successful.'."\n" - .'* false: The operation fails.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => '102400001', - ], - ], - ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the workspace ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10001'], ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'WHITELIST.DESENSID.ERROR', - 'errorMessage' => 'The desensitization rule ID does not match or does not exist with the tenant.', - ], - [ - 'errorCode' => 'WHITELIST.ENDTIME.ERROR', - 'errorMessage' => 'end time cannot be earlier than start time.', - ], - [ - 'errorCode' => 'WHITELIST.ID.ERROR', - 'errorMessage' => 'The whitelist ID does not match or does not exist with the tenant.', - ], - [ - 'errorCode' => 'WHITELIST.MCPROJECT.ERROR', - 'errorMessage' => 'The projectName on the bottom layer desensitization whitelist of MC cannot be empty.', - ], - [ - 'errorCode' => 'WHITELIST.PAGESIZE.ERROR', - 'errorMessage' => 'Page size is too large, maximum of 100.', - ], - [ - 'errorCode' => 'WHITELIST.SIZE.ERROR', - 'errorMessage' => 'The number of white list exceeds the limit.', - ], - [ - 'errorCode' => 'WHITELIST.STARTTIME.ERROR', - 'errorMessage' => 'start time cannot be earlier than today.', - ], - [ - 'errorCode' => 'WHITELIST.TIMEFORMAT.ERROR', - 'errorMessage' => 'The time format is incorrect, please use yyyy MM dd HH: mm: ss format.', - ], - [ - 'errorCode' => 'WHITELIST.USERGROUP.ERROR', - 'errorMessage' => 'The user group ID does not match or does not exist with the tenant.', - ], - [ - 'errorCode' => 'WHITELIST.USERGROUPEMPTY.ERROR', - 'errorMessage' => 'User group ID cannot be empty.', - ], - [ - 'errorCode' => 'WHITELIST.USERGROUPLISTSIZE.ERROR', - 'errorMessage' => 'The number of user group exceeds the limit.', - ], - [ - 'errorCode' => 'PARAMS.ERROR', - 'errorMessage' => 'param error.', - ], + [ + 'name' => 'ResultSample', + 'in' => 'formData', + 'schema' => ['description' => 'The sample success response of the API. This parameter is optional.'."\n", 'type' => 'string', 'required' => false, 'example' => '{ "data": { "totalNum": 0, "pageSize": 10, "rows": [], "pageNum": 1 }, "errCode": 0, "requestId": "0bc14a561678159140664515*****", "errMsg": "success", "apiLog": null}'], + ], + [ + 'name' => 'FailResultSample', + 'in' => 'formData', + 'schema' => ['description' => 'The sample failure response of the API. This parameter is optional.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"apiLog": null, "data": null, "errCode": 1108110622, "errMsg": "data Source query failed", "requestId": "0 bc14a **** 5902762031 ****"}'], + ], + [ + 'name' => 'AutoGenerate', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to use the test results generated by the system. If you do not configure the resultSample or failResultSample parameter, the test results generated by the system are used.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], - 403 => [ - [ - 'errorCode' => 'PERMISSION.DENIED.ERROR', - 'errorMessage' => 'Permission denied', + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0000-ABCD-EFG**** '], + 'Data' => ['description' => 'Indicates whether the test results are saved.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + ], ], ], - 500 => [ - [ - 'errorCode' => 'UNKNOWN.ERROR', - 'errorMessage' => 'unknown error.', - ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EF*****\\\\t\\",\\n \\"Data\\": true,\\n \\"Success\\": true,\\n \\"HttpStatusCode\\": 200\\n}","errorExample":""},{"type":"xml","example":"\\n 0000-ABCD-EFG****\\t\\n true\\n true\\n 200\\n","errorExample":""}]', + 'title' => 'SaveDataServiceApiTestResult', + 'summary' => 'Saves the test results of an API.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SaveDataServiceApiTestResult'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1029030003\\",\\n \\"ErrorMessage\\": \\"param error\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"102400001\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 1029030003\\n param error\\n 400\\n true\\n 102400001\\n","errorExample":""}]', - 'title' => 'DsgWhiteListAddOrUpdate', + 'ramActions' => [], ], - 'DsgQueryDefaultTemplates' => [ - 'summary' => 'Queries a list of available sensitive field type templates and the data masking rules supported by the templates. You can refer to the response parameters of this operation to configure a data masking rule.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ScanSensitiveData' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '219249', - 'abilityTreeNodes' => [ - 'FEATUREdideRZM9W6', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'SceneId', + 'name' => 'Data', 'in' => 'query', - 'schema' => [ - 'title' => '二级场景id', - 'description' => 'The ID of the level-2 data masking scenario. You can call the [DsgSceneQuerySceneListByName](~~2786322~~) operation to query the list of IDs.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '123', - ], + 'schema' => ['description' => 'The data that you want to check.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '13900001234'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'OpenApiResultModel>', - 'description' => 'OpenApiResultModel\\'."\n", + 'description' => 'The data returned.'."\n", 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '1029030003', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'param error', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '400', - ], - 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'DataType' => [ - 'description' => 'The sensitive field type.'."\n", - 'type' => 'string', - 'example' => 'phone', - ], - 'DesensPlanTemplate' => [ - 'description' => 'The supported data masking methods and parameter descriptions.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'type' => 'string', - 'example' => 'hash', - 'description' => 'The name of the data masking method.'."\n", - ], - 'SupportWaterMark' => [ - 'type' => 'boolean', - 'example' => 'true', - 'description' => 'Indicates whether a watermark is added. Valid values:'."\n" - ."\n" - .'* true: allow'."\n" - .'* false: disallow'."\n", - ], - 'ExtParamTemplate' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'any', - 'description' => 'The supported data masking rules and related parameter configurations, which are in the JSON format. The returned results are used to describe the parameters of a data masking rule. You cannot use the results as input parameters to create or modify a data masking rule.'."\n", - 'example' => '{ "key": "algo", "valueEnum": [ "MD5", "SHA256", "SHA512", "SM3" ], "valueType": "string" }, { "key": "salt", "valueEnum": [ 1, 2, 3, 4, 5, 6, 7, 8, 9 ], "valueType": "int" }', - ], - 'description' => 'The data masking parameters and their descriptions.'."\n", - ], - ], - 'description' => '', - ], - 'description' => 'The information about the data masking method and parameters.'."\n", - ], - ], - ], - ], - ], - 'RequestId' => [ - 'description' => 'The request ID. You can use the ID to locate logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '102400001', - ], + 'Sensitives' => ['description' => 'The check result. sensDatas indicates the rules that are used to check the sensitive data. sensDatas includes the following parameters:'."\n" + ."\n" + .'* hitCount: the number of times that the sensitive data hits the rule.'."\n" + .'* ruleName: the name of the rule.'."\n", 'type' => 'object', 'example' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0000-ABCD-EFG****'], ], ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'DESENSTEMPLATE.SCENE.ERROR', - 'errorMessage' => 'Scene ID does not exist.', - ], - [ - 'errorCode' => 'DESENSTEMPLATE.SCENELEVEL.ERROR', - 'errorMessage' => 'The scene is not a secondary scene.', - ], - [ - 'errorCode' => 'PARAMS.ERROR', - 'errorMessage' => 'param error.', - ], - ], 403 => [ - [ - 'errorCode' => 'PERMISSION.DENIED.ERROR', - 'errorMessage' => 'Permission denied', - ], + ['errorCode' => 'Forbidden.Meta.NoTenant', 'errorMessage' => 'The user is not the owner of any tenants.', 'description' => 'The user is not the owner of any tenants.'], ], 500 => [ - [ - 'errorCode' => 'UNKNOWN.ERROR', - 'errorMessage' => 'unknown error.', - ], + ['errorCode' => 'InternalError.DQC.BizError', 'errorMessage' => 'An internal error occurred.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1029030003\\",\\n \\"ErrorMessage\\": \\"param error\\",\\n \\"HttpStatusCode\\": 400,\\n \\"Data\\": [\\n {\\n \\"DataType\\": \\"phone\\",\\n \\"DesensPlanTemplate\\": {\\n \\"key\\": [\\n {\\n \\"Name\\": \\"hash\\",\\n \\"SupportWaterMark\\": true,\\n \\"ExtParamTemplate\\": [\\n \\"{ \\\\\\"key\\\\\\": \\\\\\"algo\\\\\\", \\\\\\"valueEnum\\\\\\": [ \\\\\\"MD5\\\\\\", \\\\\\"SHA256\\\\\\", \\\\\\"SHA512\\\\\\", \\\\\\"SM3\\\\\\" ], \\\\\\"valueType\\\\\\": \\\\\\"string\\\\\\" }, { \\\\\\"key\\\\\\": \\\\\\"salt\\\\\\", \\\\\\"valueEnum\\\\\\": [ 1, 2, 3, 4, 5, 6, 7, 8, 9 ], \\\\\\"valueType\\\\\\": \\\\\\"int\\\\\\" }\\"\\n ]\\n }\\n ]\\n }\\n }\\n ],\\n \\"RequestId\\": \\"102400001\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 1029030003\\n param error\\n 400\\n \\n phone\\n \\n hash\\n true\\n { \\"key\\": \\"algo\\", \\"valueEnum\\": [ \\"MD5\\", \\"SHA256\\", \\"SHA512\\", \\"SM3\\" ], \\"valueType\\": \\"string\\" }, { \\"key\\": \\"salt\\", \\"valueEnum\\": [ 1, 2, 3, 4, 5, 6, 7, 8, 9 ], \\"valueType\\": \\"int\\" }\\n \\n \\n 102400001\\n","errorExample":""}]', - 'title' => 'DsgQueryDefaultTemplates', - ], - 'CreateImportMigration' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Sensitives\\": {\\n \\"sensDatas\\": [\\n {\\n \\"hitCount\\": 1,\\n \\"ruleName\\": \\"手机号\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 0000-ABCD-EFG****\\n","errorExample":""}]', + 'title' => 'ScanSensitiveData', + 'summary' => 'Checks whether input data contains sensitive data.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ScanSensitiveData'], + ], ], + 'ramActions' => [], + ], + 'SearchMetaTables' => [ + 'summary' => 'Queries metatables based on specific conditions.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '78187', - 'abilityTreeNodes' => [ - 'FEATUREdide8FM783', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '78351', + 'abilityTreeNodes' => ['FEATUREdideE9OA4H'], ], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to obtain the workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'minimum' => '2', - 'example' => '123456', - ], - ], - [ - 'name' => 'Name', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the import task. The name must be unique within the workspace.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test_import_001', - ], + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'PackageType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The type of the import package. Valid values:'."\n" - ."\n" - .'* DATAWORKS_MODEL (standard format)'."\n" - .'* DATAWORKS_V2 (Apsara Stack DataWorks V3.6.1 to V3.11)'."\n" - .'* DATAWORKS_V3 (Apsara Stack DataWorks V3.12 and later)'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'DATAWORKS_MODEL', - 'enum' => [ - 'DATAWORKS_MODEL', - 'DATAWOKRS_V2', - 'DATAWORKS_V3', - 'SPEC', - ], - ], + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'PackageFile', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The path of the import package. **The import package must be uploaded. Example of the upload method:**'."\n" - ."\n" - .'```java'."\n" - .' Config config = new Config();'."\n" - .' config.setAccessKeyId(accessId);'."\n" - .' config.setAccessKeySecret(accessKey);'."\n" - .' config.setEndpoint(popEndpoint);'."\n" - .' config.setRegionId(regionId);'."\n" - ."\n" - .' Client client = new Client(config);'."\n" - ."\n" - .' CreateImportMigrationAdvanceRequest request = new CreateImportMigrationAdvanceRequest();'."\n" - .' request.setName("test_migration_api_" + System.currentTimeMillis());'."\n" - .' request.setProjectId(123456L); '."\n" - .' request.setPackageType("DATAWORKS_MODEL");'."\n" - .' request.setPackageFileObject(new FileInputStream("/home/admin/Downloads/test.zip"));'."\n" - ."\n" - .' RuntimeOptions runtime = new RuntimeOptions();'."\n" - .' CreateImportMigrationResponse response = client.createImportMigrationAdvance(request, runtime);'."\n" - .'```'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '/home/admin/xxx/import.zip', - 'isFileTransferUrl' => true, - ], + 'name' => 'AppGuid', + 'in' => 'query', + 'schema' => ['description' => 'The GUID of the workspace where the metatables reside.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'odps.engine_name', 'title' => ''], ], [ - 'name' => 'ResourceGroupMap', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The mapping between the resource group for scheduling and the resource group for Data Integration. The keys and values in the mapping are the identifiers of the resource groups. Specify the mapping in the following format:'."\n" - ."\n" - .'```json'."\n" - .'{'."\n" - .' "SCHEDULER_RESOURCE_GROUP": {'."\n" - .' "xxx": "yyy"'."\n" - .' },'."\n" - .' "DI_RESOURCE_GROUP": {'."\n" - .' "ccc": "dfdd"'."\n" - .' }'."\n" - .'}'."\n" - .'```'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '{"SCHEDULER_RESOURCE_GROUP": {"xxx":"yyy"},"DI_RESOURCE_GROUP":{"ccc":"ddd"}}', - ], + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => ['description' => 'The keyword based on which metatables are queried. During the query, the system tokenizes the names of metatables and matches the names with the keyword. If no name is matched, the value null is returned. By default, the system uses underscores (\\_) to tokenize the names.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'WorkspaceMap', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The mapping between the prefixes for the names of the source and destination workspaces. When the system performs the import operation, the prefix for the name of the source workspace in the import package is replaced based on the mapping.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '{"test_workspace_src": "test_workspace_target"}', - ], + 'name' => 'EntityType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the metatables. Valid values: 0 and 1. The value 0 indicates that tables are queried. The value 1 indicates that views are queried. If you do not configure this parameter, all types of metatables are queried.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ - 'name' => 'CalculateEngineMap', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The mapping between the source compute engine instance and the destination compute engine instance. The following types of compute engine instances are supported: MaxCompute, E-MapReduce (EMR), Hadoop CDH, and Hologres.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '{ "ODPS": { "zxy_8221431_engine": "wzp_kaifazheban_engine" }, "EMR": { "aaaa": "bbb" } }', - ], + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the EMR cluster. This parameter is required only if you set the DataSourceType parameter to emr.'."\n" + ."\n" + .'You can log on to the [EMR console](https://emr.console.aliyun.com/?spm=a2c4g.11186623.0.0.965cc5c2GeiHet#/cn-hangzhou) to obtain the ID.', 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''], ], [ - 'name' => 'CommitRule', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The rule configured for automatically committing and deploying the import task. The rule contains the following parameters:'."\n" - ."\n" - .'* resourceAutoCommit: specifies whether resources are automatically committed. The value true indicates yes and the value false indicates no.'."\n" - .'* resourceAutoDeploy: specifies whether resources are automatically deployed. The value true indicates yes and the value false indicates no.'."\n" - .'* functionAutoCommit: specifies whether the function is automatically committed. The value true indicates yes and the value false indicates no.'."\n" - .'* functionAutoDeploy: specifies whether the function is automatically deployed. The value true indicates yes and the value false indicates no.'."\n" - .'* tableAutoCommitToDev: specifies whether the table is automatically committed to the development environment. The value true indicates yes and the value false indicates no.'."\n" - .'* tableAutoCommitToProd: specifies whether the table is automatically committed to the production environment. The value true indicates yes and the value false indicates no.'."\n" - .'* ignoreLock: specifies whether the lock is automatically ignored when an import task is locked. The value true indicates yes and the value false indicates no. If you set this parameter to true for an import task, you can forcefully update the task even if the task is locked.'."\n" - .'* fileAutoCommit: specifies whether the file is automatically committed. The value true indicates yes and the value false indicates no.'."\n" - .'* fileAutoDeploy: specifies whether the file is automatically deployed. The value true indicates yes and the value false indicates no.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '{ "resourceAutoCommit": false, "resourceAutoDeploy": false, "functionAutoCommit": false, "functionAutoDeploy": false, "tableAutoCommitToDev": false, "tableAutoCommitToProd": false, "ignoreLock": false, "fileAutoCommit": false, "fileAutoDeploy": false }', - ], + 'name' => 'DataSourceType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the data source. Valid values: odps and emr.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'emr', 'title' => ''], ], [ - 'name' => 'Description', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The description of the import package.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'test description', - ], + 'name' => 'Schema', + 'in' => 'query', + 'schema' => ['description' => 'The schema information of the table. You must configure this parameter if you enable the three-layer model of MaxCompute.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The returned data.'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified parameters are invalid.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0bc1ec92159376****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '1031203110005', 'title' => ''], 'Data' => [ - 'description' => 'The import task ID. The ID is used as an input parameter if you want the system to run the import task or you want to obtain the running progress of the import task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'test error message', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => 'ADFASDFASDFA-ADFASDF-ASDFADSDF-AFFADS', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '110001123456', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'description' => 'The search results.', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of metatables.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'DataEntityList' => [ + 'description' => 'The list of metatables.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'TableName' => ['description' => 'The name of the metatable.', 'type' => 'string', 'example' => 'test_name', 'title' => ''], + 'DatabaseName' => ['description' => 'The name of the metadatabase.', 'type' => 'string', 'example' => 'abc', 'title' => ''], + 'EntityType' => ['description' => 'The type of the metatable. Valid values:'."\n" + ."\n" + .'- 0: table'."\n" + ."\n" + .'- 1: view', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ProjectName' => ['description' => 'The name of the workspace.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'ProjectId' => ['description' => 'The ID of the workspace.', 'type' => 'integer', 'format' => 'int64', 'example' => '323', 'title' => ''], + 'TableGuid' => ['description' => 'The GUID of the metatable.', 'type' => 'string', 'example' => 'odps.engine_name.test_name', 'title' => ''], + 'OwnerId' => ['description' => 'The ID of the Alibaba Cloud account used by the workspace owner.', 'type' => 'string', 'example' => '123', 'title' => ''], + 'ClusterId' => ['description' => 'The ID of the EMR cluster.', 'type' => 'string', 'example' => 'abc', 'title' => ''], + 'EnvType' => ['description' => 'The type of the environment. Valid values:'."\n" + ."\n" + .'- 1: production environment'."\n" + ."\n" + .'- 0: development environment', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'TenantId' => ['description' => 'The tenant ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '12345', 'title' => ''], + 'Schema' => ['description' => 'The schema information of the table. You must configure this parameter if you enable the three-layer model of MaxCompute.', 'type' => 'string', 'example' => 'default', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Invalid.Meta.TableNotExist', 'errorMessage' => 'The table does not exist.', 'description' => 'The table does not exist.'], + ['errorCode' => 'InvalidParameter.Meta.CommonError', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The request parameter is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.Illegal', 'errorMessage' => 'The app guid parameter is invalid.', 'description' => 'The app guid parameter is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.IllegalDate', 'errorMessage' => 'The date format is invalid.', 'description' => 'The date format is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.IllegalPageError', 'errorMessage' => 'The parameter for paging is invalid.', 'description' => 'The parameter for paging is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.NotExist', 'errorMessage' => 'The object does not exist.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.Meta.NoCalcEngine', 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.', 'description' => 'Incorrect project entered by user'], + ], + 403 => [ + ['errorCode' => 'ResourceNotAuthorized.Api', 'errorMessage' => 'You are not authorized to access the resources.', 'description' => ''], + ['errorCode' => 'Forbidden.Meta.NoTenant', 'errorMessage' => 'The user is not the owner of any tenants.', 'description' => 'The user is not the owner of any tenants.'], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.Meta.TenantTimeOut', 'errorMessage' => 'Failed to connect to the interface network.', 'description' => 'Failed to connect to the interface network.'], + ['errorCode' => 'InternalError.Meta.Unknown', 'errorMessage' => 'An unknown error occurred while processing your request.', 'description' => 'An unknown error occurred while processing your request.'], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"RequestId\\": \\"0bc1ec92159376****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"DataEntityList\\": [\\n {\\n \\"TableName\\": \\"test_name\\",\\n \\"DatabaseName\\": \\"abc\\",\\n \\"EntityType\\": 0,\\n \\"ProjectName\\": \\"test\\",\\n \\"ProjectId\\": 323,\\n \\"TableGuid\\": \\"odps.engine_name.test_name\\",\\n \\"OwnerId\\": \\"123\\",\\n \\"ClusterId\\": \\"abc\\",\\n \\"EnvType\\": 1,\\n \\"TenantId\\": 12345,\\n \\"Schema\\": \\"default\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'SearchMetaTables', + 'description' => 'Only MaxCompute and EMR engine tables are supported for search.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' SearchMetaTables接口的使用示例Demo请参见[DataWorks OpenAPI示例](https://developer.aliyun.com/article/780879?groupCode=dataworks)。', + 'changeSet' => [ + ['createdAt' => '2022-07-19T06:35:48.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2021-12-20T08:05:19.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 123456,\\n \\"ErrorMessage\\": \\"test error message\\",\\n \\"RequestId\\": \\"ADFASDFASDFA-ADFASDF-ASDFADSDF-AFFADS\\",\\n \\"ErrorCode\\": \\"110001123456\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n 123456\\n test error message\\n ADFASDFASDFA-ADFASDF-ASDFADSDF-AFFADS\\n 110001123456\\n true\\n","errorExample":""}]', - 'title' => 'CreateImportMigration', - 'summary' => 'Creates an import task. The import task contains the import packages of data sources, nodes, and tables.', - 'description' => 'The import package must be uploaded. Example of the upload method:'."\n" - ."\n" - .' Config config = new Config();'."\n" - .' config.setAccessKeyId(accessId);'."\n" - .' config.setAccessKeySecret(accessKey);'."\n" - .' config.setEndpoint(popEndpoint);'."\n" - .' config.setRegionId(regionId);'."\n" - .' '."\n" - .' Client client = new Client(config);'."\n" - ."\n" - .' CreateImportMigrationAdvanceRequest request = new CreateImportMigrationAdvanceRequest();'."\n" - .' request.setName("test_migration_api_" + System.currentTimeMillis());'."\n" - .' request.setProjectId(123456L); '."\n" - .' request.setPackageType("DATAWORKS_MODEL");'."\n" - .' request.setPackageFileObject(new FileInputStream("/home/admin/Downloads/test.zip"));'."\n" - ."\n" - .' RuntimeOptions runtime = new RuntimeOptions();'."\n" - .' CreateImportMigrationResponse response = client.createImportMigrationAdvance(request, runtime);'."\n" - .' ...'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'GetMigrationProcess' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'SearchNodesByOutput' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '78271', - 'abilityTreeNodes' => [ - 'FEATUREdide8FM783', - ], - ], + 'deprecated' => true, + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'ProjectEnv', 'in' => 'formData', 'schema' => [ - 'description' => 'The workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The environment of Operation Center. Valid values: PROD and DEV.'."\n", + 'type' => 'string', 'required' => true, 'docRequired' => true, - 'minimum' => '2', - 'example' => '123456', + 'example' => 'PROD', + 'enum' => ['PROD', 'DEV'], ], ], [ - 'name' => 'MigrationId', + 'name' => 'Outputs', 'in' => 'formData', - 'schema' => [ - 'description' => 'The migration package ID. You can call the CreateImportMigration operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'minimum' => '1', - 'example' => '123456', - ], + 'schema' => ['description' => 'The output names of the node. If you specify multiple output names, separate them with commas (,).'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'aaaaa.1231412_out,bbbb.12313123_out'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'SADFSDFSD-SDFSDF-XDXCVX-ESWW', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'test error msg', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '110001123456', - ], - 'Data' => [ - 'description' => 'The progress information of the migration task, including the names of all steps in and status of the migration task.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'TaskStatus' => [ - 'description' => 'The running status of the step in the migration task. Valid values:'."\n" - ."\n" - .'* INIT'."\n" - .'* RUNNING'."\n" - .'* FAILURE'."\n" - .'* SUCCESS'."\n", - 'type' => 'string', - 'example' => 'SUCCESS', - ], - 'TaskName' => [ - 'description' => 'The name of the step in the migration task.'."\n", - 'type' => 'string', - 'example' => 'IMPORE_PREPARE', - ], - ], - ], - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Data' => ['description' => 'The map returned. The key in the map indicates an output name, and the value in the map indicates the information about the node that generates the output.'."\n", 'type' => 'object', 'example' => '{ "test_0709_1.630003558_out": { "nodeId": 21673, "nodeName": "hour_sql", "ownerId": 123123123124, "cronExpress": "00 00 00-23/2 * * ?", "repeatability": true, "programType": "ODPS_SQL", "projectId": 11111, "schedulerType": "NORMAL", "priority": 1, "baselineId": 20001721, "connection": "odps_first" }, "test_0709_1.630003556_out": { "nodeId": 21671, "nodeName": "start", "ownerId": 123141231231, "cronExpress": "00 */10 00-23 * * ?", "repeatability": true, "programType": "VIRTUAL", "projectId": 1111, "schedulerType": "NORMAL", "priority": 1, "baselineId": 20001721 } }'], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The connection does not exist.'], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'SDFSDFSDF-asdfDFSDF-SDFSDf-SDfSFD'], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"SADFSDFSD-SDFSDF-XDXCVX-ESWW\\",\\n \\"ErrorMessage\\": \\"test error msg\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"110001123456\\",\\n \\"Data\\": [\\n {\\n \\"TaskStatus\\": \\"SUCCESS\\",\\n \\"TaskName\\": \\"IMPORE_PREPARE\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n SADFSDFSD-SDFSDF-XDXCVX-ESWW\\n test error msg\\n true\\n 110001123456\\n \\n SUCCESS\\n IMPORE_PREPARE\\n \\n","errorExample":""}]', - 'title' => 'GetMigrationProcess', - 'summary' => 'Queries the progress of a migration task.', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"test_0709_1.630003558_out\\": {\\n \\"nodeId\\": 21673,\\n \\"nodeName\\": \\"hour_sql\\",\\n \\"ownerId\\": 123123123124,\\n \\"cronExpress\\": \\"00 00 00-23/2 * * ?\\",\\n \\"repeatability\\": true,\\n \\"programType\\": \\"ODPS_SQL\\",\\n \\"projectId\\": 11111,\\n \\"schedulerType\\": \\"NORMAL\\",\\n \\"priority\\": 1,\\n \\"baselineId\\": 20001721,\\n \\"connection\\": \\"odps_first\\"\\n },\\n \\"test_0709_1.630003556_out\\": {\\n \\"nodeId\\": 21671,\\n \\"nodeName\\": \\"start\\",\\n \\"ownerId\\": 123141231231,\\n \\"cronExpress\\": \\"00 */10 00-23 * * ?\\",\\n \\"repeatability\\": true,\\n \\"programType\\": \\"VIRTUAL\\",\\n \\"projectId\\": 1111,\\n \\"schedulerType\\": \\"NORMAL\\",\\n \\"priority\\": 1,\\n \\"baselineId\\": 20001721\\n }\\n },\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"SDFSDFSDF-asdfDFSDF-SDFSDf-SDfSFD\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\"\\n}","errorExample":""},{"type":"xml","example":"true\\n200\\n\\n \\n 21673\\n hour_sql\\n 123123123124\\n 00 00 00-23/2 * * ?\\n true\\n ODPS_SQL\\n 11111\\n NORMAL\\n 1\\n 20001721\\n odps_first\\n \\n \\n 21671\\n start\\n 123141231231\\n 00 */10 00-23 * * ?\\n true\\n VIRTUAL\\n 1111\\n NORMAL\\n 1\\n 20001721\\n \\n","errorExample":""}]', + 'title' => 'SearchNodesByOutput', + 'summary' => 'Queries a node based on the output.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'StartMigration' => [ - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2022-01-13T07:25:27.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'SetDataSourceShare' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '78357', - 'abilityTreeNodes' => [ - 'FEATUREdide8FM783', + [ + 'PrivateKey' => [], + ], + [ + 'APP' => [], ], ], + 'operationType' => 'write', + 'deprecated' => true, + 'systemTags' => [], 'parameters' => [ [ 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The workspace ID. You can log on to the DataWorks console and go to the Workspace page to obtain the workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'minimum' => '2', - 'example' => '123456', - ], + 'in' => 'query', + 'schema' => ['description' => 'The ID of the DataWorks workspace to which the data source belongs. You can call the [ListProjects](~~178393~~) operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '10000000000', 'minimum' => '1', 'example' => '10000'], ], [ - 'name' => 'MigrationId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The migration package ID. You can call the [CreateImportMigration](~~206094~~) operation to query the ID of the import package and call the [CreateExportMigration](~~349325~~) operation to query the ID of the export package.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'minimum' => '2', - 'example' => '123456', - ], + 'name' => 'DatasourceName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the data source that you want to share.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mysql_name'], + ], + [ + 'name' => 'EnvType', + 'in' => 'query', + 'schema' => ['description' => 'The environment in which the data source is used. Valid values:'."\n" + ."\n" + .'* 0: development environment'."\n" + .'* 1: production environment'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '1'], + ], + [ + 'name' => 'ProjectPermissions', + 'in' => 'query', + 'schema' => ['description' => 'The DataWorks workspace to which you want to share the data source. If you configure this parameter, all members of the specified DataWorks workspace can view and use the data source. The value of this parameter is a JSON array. Example: \\[{"projectId":1000,"permission":"WRITE","sharedName":"PX_DATAHUB1.shared_name"}], Parameter description:'."\n" + ."\n" + .'* projectId: the ID of the DataWorks workspace to which you want to share the data source.'."\n" + .'* permission: the mode in which the data source is shared. Valid values: READ and WRITE. The value READ indicates that all members of the specified workspace can read data from the data source, but cannot modify the data. The value WRITE indicates that all members of the specified workspace can modify the data in the data source.'."\n" + .'* sharedName: the name of the data source that you want to share.'."\n", 'type' => 'string', 'required' => false, 'example' => '[{"projectId":1000,"permission":"WRITE","sharedName":"PX_DATAHUB1.shared_name"}]'], + ], + [ + 'name' => 'UserPermissions', + 'in' => 'query', + 'schema' => ['description' => 'The user to whom you want to share the data source. If you configure this parameter, the specified user can view or use the data source. The value of this parameter is a JSON array. Example: \\[{"projectId":10000,"users":\\[{"userId":"276184575345452131","permission":"WRITE"}],"sharedName":"PX_DATAHUB1.shared_name"}], Parameter description:'."\n" + ."\n" + .'* projectId: the ID of the DataWorks workspace. If you configure the UserPermissions parameter, the specified user can view or use the data source only in the specified DataWorks workspace.'."\n" + .'* userId: the ID of the user to whom you want to share the data source.'."\n" + .'* permission: the mode in which the data source is shared. Valid values: READ and WRITE. The value READ indicates that the specified user can read data from the data source, but cannot modify the data. The value WRITE indicates that the specified user can modify the data in the data source.'."\n" + .'* sharedName: the name of the data source that you want to share.'."\n" + ."\n" + .'If the ProjectPermissions and UserPermissions parameters are both left empty, the specified data source is not shared to any DataWorks workspace or user. If neither of the parameters is left empty, both parameters take effect.'."\n", 'type' => 'string', 'required' => false, 'example' => '[{"projectId":10000,"users":[{"userId":"276184575345452131","permission":"WRITE"}],"sharedName":"PX_DATAHUB1.shared_name"}]'], ], ], 'responses' => [ @@ -56882,242 +35291,146 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0000-ABCD-EFG '], 'Data' => [ - 'description' => 'Indicates whether the migration task is started. Valid values:'."\n" - ."\n" - .'* true: The migration task is started.'."\n" - .'* false: The migration task fails to be started.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'test error msg', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'FSDFSDF-WERWER-XVCX-DSFSDF', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '110001123445', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'description' => 'The information about the sharing operation.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'Indicates whether the data source was shared. Valid values:'."\n" + ."\n" + .'* success.'."\n" + .'* fail. You can view the value of the Message parameter to identify the cause of the failure.'."\n", 'type' => 'string', 'example' => 'success'], + 'Message' => ['description' => 'The reason why the data source failed to be shared. If the data source is successfully shared, the value of this parameter is an empty string.'."\n", 'type' => 'string', 'example' => 'datasource is wrong'], + ], ], ], 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"test error msg\\",\\n \\"RequestId\\": \\"FSDFSDF-WERWER-XVCX-DSFSDF\\",\\n \\"ErrorCode\\": \\"110001123445\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n true\\n test error msg\\n FSDFSDF-WERWER-XVCX-DSFSDF\\n 110001123445\\n true\\n","errorExample":""}]', - 'title' => 'StartMigration', - 'summary' => 'Starts a migration task.', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Invalid.DI.Parameter', 'errorMessage' => 'The parameter is invalid.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'Forbidden.DI.NoPrivilege', 'errorMessage' => 'No access.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.DI.Parameter', 'errorMessage' => 'A DI internal error occurred.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0000-ABCD-EFG\\\\t\\",\\n \\"Data\\": {\\n \\"Status\\": \\"success\\",\\n \\"Message\\": \\"datasource is wrong\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"0000-ABCD-EFG\\t\\n\\n success\\n datasource is wrong\\n\\ntrue","errorExample":""}]', + 'title' => 'SetDataSourceShare', + 'summary' => 'Shares a data source to a specific DataWorks workspace or a specific user.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateExportMigration' => [ - 'summary' => 'Creates an export task. You can use this operation to create an export task but cannot use this operation to start the created export task.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'SetEntityTags' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '86657', - 'abilityTreeNodes' => [ - 'FEATUREdide8FM783', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '187379', + 'abilityTreeNodes' => ['FEATUREdideRZEBFC'], ], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '12345', - ], - ], - [ - 'name' => 'Name', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the export task.'."\n" - ."\n" - .'The name of each export task must be unique. You must ensure that no duplicate export task exists in the current workspace.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test_export_01', - ], - ], - [ - 'name' => 'ExportMode', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The export mode of the export task. Valid values:'."\n" - ."\n" - .'* FULL: The export task is used to export all data objects.'."\n" - .'* INCREMENTAL: The export task is used to export data objects that were modified since the specified point in time. If you set this parameter to INCREMENTAL, you must configure the IncrementalSince parameter.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'FULL', - 'enum' => [ - 'FULL', - 'INCREMENTAL', - ], - ], - ], - [ - 'name' => 'IncrementalSince', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The start time of the incremental export task.'."\n" - ."\n" - .'The IncrementalSince parameter takes effect only when the ExportMode parameter is set to INCREMENTAL.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1589904000000', - ], - ], - [ - 'name' => 'ExportObjectStatus', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The status of the data objects that you want to export in the export task. The system exports data objects in the state that is specified by this parameter. Valid values:'."\n" - ."\n" - .'* SAVED'."\n" - .'* SUBMITTED'."\n" - .'* DEPLOYED'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SAVED', - 'default' => 'SAVED', - 'enum' => [ - 'SAVED', - 'SUBMITTED', - 'DEPLOYED', - ], - ], + 'name' => 'QualifiedName', + 'in' => 'query', + 'schema' => ['description' => 'The unique identifier of the entity. Example: maxcompute-table.projectA.tableA.'."\n", 'type' => 'string', 'required' => true, 'example' => 'maxcompute-table.projectA.tableA'], ], [ - 'name' => 'Description', + 'name' => 'Tags', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The description of the export task.'."\n", - 'type' => 'string', + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The tag.'."\n", 'required' => false, '$ref' => '#/components/schemas/UserEntityTag'], 'required' => false, - 'example' => 'test', + 'maxItems' => 100, ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The returned result.'."\n", + 'title' => 'OpenApiMetaResultModel', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => '34267E2E-0335-1A60-A1F0-ADA530890CBA', - ], - 'Data' => [ - 'description' => 'The export task ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Data' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'true and false.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0000-ABCD-E****'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'true and false.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '101011005'], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'Invalid.Entity.EntityTypeNotSupported'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"34267E2E-0335-1A60-A1F0-ADA530890CBA\\",\\n \\"Data\\": 1234,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 34267E2E-0335-1A60-A1F0-ADA530890CBA\\n 1234\\n true\\n","errorExample":""}]', - 'title' => 'CreateExportMigration', - ], - 'GetMigrationSummary' => [ - 'summary' => 'Queries the information about a migration task.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"0000-ABCD-E****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"101011005\\",\\n \\"ErrorMessage\\": \\"Invalid.Entity.EntityTypeNotSupported\\",\\n \\"HttpStatusCode\\": 200\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 0000-ABCD-E****\\n true\\n 101011005\\n Invalid.Entity.EntityTypeNotSupported\\n 200\\n","errorExample":""}]', + 'title' => 'SetEntityTags', + 'summary' => 'Configures tags for an entity. Only entities of the maxcompute-table type are supported.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'SetSuccessInstance' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '86668', - 'abilityTreeNodes' => [ - 'FEATUREdide8FM783', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '78355', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB'], ], 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'InstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'minimum' => '2', - 'example' => '12345', - ], + 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1234'], ], [ - 'name' => 'MigrationId', + 'name' => 'ProjectEnv', 'in' => 'formData', 'schema' => [ - 'description' => 'The migration task ID.'."\n" - ."\n" - .'You can call the [CreateImportMigration](~~2780280~~) operation to obtain the ID of the import task and call the [CreateExportMigration](~~2780281~~) operation to obtain the ID of the export task.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The environment of the workspace. Valid values: PROD and DEV.'."\n", + 'type' => 'string', 'required' => true, 'docRequired' => true, - 'minimum' => '1', - 'example' => '1234', + 'example' => 'PROD', + 'enum' => ['PROD', 'DEV'], ], ], ], @@ -57127,185 +35440,166 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID. You can use the request ID to query logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '19999A96-71BA-2845-B455-ED620EF4E37F', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The details of the migration task.'."\n", - 'type' => 'object', - 'properties' => [ - 'MigrationId' => [ - 'description' => 'The task ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'Name' => [ - 'description' => 'The task name.'."\n", - 'type' => 'string', - 'example' => 'test_export_01', - ], - 'GmtCreate' => [ - 'description' => 'The time when the task was created.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1589904000000', - ], - 'GmtModified' => [ - 'description' => 'The time when the task was modified.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1589904000000', - ], - 'CreateUser' => [ - 'description' => 'The ID of the user who created the task.'."\n", - 'type' => 'string', - 'example' => '982293332403****', - ], - 'OpUser' => [ - 'description' => 'The ID of the user who managed the task.'."\n", - 'type' => 'string', - 'example' => '982293332403****', - ], - 'Status' => [ - 'description' => 'The status of the migration task. Valid values:'."\n" - ."\n" - .'* INIT'."\n" - .'* EDITING'."\n" - .'* IMPORTING'."\n" - .'* IMPORT_ERROR'."\n" - .'* IMPORT_SUCCESS'."\n" - .'* EXPORTING'."\n" - .'* EXPORT_ERROR'."\n" - .'* EXPORT_SUCCESS'."\n" - .'* REVOKED'."\n" - .'* PARTIAL_SUCCESS'."\n", - 'type' => 'string', - 'example' => 'EXPORT_SUCCESS', - ], - 'ProjectId' => [ - 'description' => 'The ID of the DataWorks workspace to which the migration task belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12345', - ], - 'DownloadUrl' => [ - 'description' => 'The URL that is used to download the package of the export task. You can use the URL to download the package of the export task.'."\n", - 'type' => 'string', - 'example' => 'https://shanghai-xxx-oss.oss-cn-shanghai.aliyuncs.com/pre/store/f10_bf47_b4fa7df0860f.zip?Expires=1639540903&OSSAccessKeyId=XXXXXXeF4Lv5j&Signature=qxxxxx', - ], - ], - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Data' => ['description' => 'Indicates whether result details are returned.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The connection does not exist.'], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'E6F0DBDD-5AD****'], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists'], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"19999A96-71BA-1845-B455-ED620EF4E37F\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"MigrationId\\": 1234,\\n \\"Name\\": \\"test_export_01\\",\\n \\"GmtCreate\\": 1589904000000,\\n \\"GmtModified\\": 1589904000000,\\n \\"CreateUser\\": \\"982293332403****\\",\\n \\"OpUser\\": \\"982293332403****\\",\\n \\"Status\\": \\"EXPORT_SUCCESS\\",\\n \\"ProjectId\\": 12345,\\n \\"DownloadUrl\\": \\"https://shanghai-xxx-oss.oss-cn-shanghai.aliyuncs.com/pre/store/f10_bf47_b4fa7df0860f.zip?Expires=1639540903&OSSAccessKeyId=****&Signature=qxxxxx\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 19999A96-71BA-1845-B455-ED620EF4E37F\\n true\\n \\n 1234\\n test_export_01\\n 1589904000000\\n 1589904000000\\n 982293332403****\\n 982293332403****\\n EXPORT_SUCCESS\\n 12345\\n https://shanghai-xxx-oss.oss-cn-shanghai.aliyuncs.com/pre/store/f10_bf47_b4fa7df0860f.zip?Expires=1639540903&OSSAccessKeyId=XXXXXXeF4Lv5j&Signature=qxxxxx\\n \\n","errorExample":""}]', - 'title' => 'GetMigrationSummary', - ], - 'ListMigrations' => [ - 'summary' => 'Queries a list of migration tasks.', - 'methods' => [ - 'post', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n true\\n The connection does not exist.\\n E6F0DBDD-5AD****\\n Invalid.Tenant.ConnectionNotExists\\n true\\n","errorExample":""}]', + 'title' => 'SetSuccessInstance', + 'summary' => 'Sets the state of a failed instance to successful.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-08-12T08:46:57.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-08-12T08:46:57.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-08-12T08:46:57.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'StartDIJob' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '134647', - 'abilityTreeNodes' => [ - 'FEATUREdide8FM783', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '155172', + 'abilityTreeNodes' => ['FEATUREdideQHGTK4'], ], 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'DIJobId', 'in' => 'formData', - 'schema' => [ - 'title' => 'Workspace Id', - 'description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'minimum' => '2', - 'exclusiveMinimum' => false, - 'example' => '12345', - ], + 'schema' => ['description' => 'The task ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11743'], ], [ - 'name' => 'MigrationType', + 'name' => 'RealtimeStartSettings', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => 'Migration operation type, IMPORT/EXPORT', - 'description' => 'The migration task type. Valid values: IMPORT and EXPORT.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [], - 'example' => 'IMPORT', - 'enum' => [ - 'IMPORT', - 'EXPORT', + 'description' => 'The settings for the start.'."\n", + 'type' => 'object', + 'properties' => [ + 'StartTime' => ['description' => 'The timestamp of the start offset. Unit: seconds. If you do not configure this parameter, the offset is not reset by default.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1671516776'], + 'FailoverSettings' => [ + 'description' => 'The failover settings.'."\n", + 'type' => 'object', + 'properties' => [ + 'Interval' => ['description' => 'The failover interval. Unit: minutes.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10'], + 'UpperLimit' => ['description' => 'The maximum number of failovers.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30'], + ], + 'required' => false, + ], ], + 'required' => false, ], ], [ - 'name' => 'Owner', + 'name' => 'ForceToRerun', 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to forcefully rerun all synchronization steps. If you do not configure this parameter, the system does not forcefully rerun the task.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The owner ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '193379****', + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '999431B2-6013-577F-B684-36F7433C753B'], + ], ], ], + ], + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"999431B2-6013-577F-B684-36F7433C753B\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 999431B2-6013-577F-B684-36F7433C753B\\n","errorExample":""}]', + 'title' => 'StartDIJob', + 'summary' => 'Starts a synchronization task of a new version. Only the following type of task is supported: real-time data synchronization from a MySQL database to Hologres.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartDIJob'], + ], + ], + 'ramActions' => [ [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The page number. Default value: 1. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '1', - 'default' => '1', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'StartDISyncInstance' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '10', - 'example' => '10', - 'default' => '10', - ], + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the workspace ID. You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '10000000000', 'minimum' => '1', 'example' => '10000'], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the object that you want to start. Valid values:'."\n" + ."\n" + .'* DI_REALTIME: real-time synchronization task'."\n" + .'* DI_SOLUTION: data synchronization solution'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DI_REALTIME'], + ], + [ + 'name' => 'FileId', + 'in' => 'query', + 'schema' => ['description' => '* If you set TaskType to DI_REALTIME, set this parameter to the ID of the real-time synchronization task that you want to start.'."\n" + .'* If you set TaskType to DI_SOLUTION, set this parameter to the ID of the data synchronization solution that you want to start.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9999999999999999', 'minimum' => '1', 'example' => '100'], + ], + [ + 'name' => 'StartParam', + 'in' => 'query', + 'schema' => ['description' => '* If you set TaskType to DI_REALTIME, the StartParam parameter specifies the startup parameters for the real-time synchronization task. The startup parameters include failover-related parameters, the parameter that specifies the number of dirty data records allowed, and the parameters in the data definition language (DDL) statements.'."\n" + .'* If you set TaskType to DI_SOLUTION, the StartParam parameter does not take effect.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"failoverLimit":{"count":10,"interval":30},"errorLimit":{"record":0},"ddlMarkMap":{"RENAMECOLUMN":"WARNING","DROPTABLE":"WARNING","CREATETABLE":"IGNORE","MODIFYCOLUMN":"WARNING","TRUNCATETABLE":"NORMAL","DROPCOLUMN":"IGNORE","ADDCOLUMN":"NORMAL","RENAMETABLE":"CRITICAL"}}'], ], ], 'responses' => [ @@ -57314,174 +35608,63 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'F9198AA3-9010-53D5-9714-DC4461427D3E', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], + 'RequestId' => ['description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", 'type' => 'string', 'example' => '0bc1411515937635973****'], 'Data' => [ - 'description' => 'The returned data.'."\n", + 'description' => 'The result returned for the start.'."\n", 'type' => 'object', 'properties' => [ - 'Migrations' => [ - 'description' => 'The list of migration tasks.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The migration task.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The primary key ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '436064', - ], - 'Name' => [ - 'description' => 'The name of the migration task.'."\n", - 'type' => 'string', - 'example' => 'test_task_1638498642279', - ], - 'PackageType' => [ - 'description' => 'The type of the import or export package. Valid values:'."\n" - ."\n" - .'* DWMA (standard format)'."\n" - .'* DATAWORKS_MODEL (standard format)'."\n" - .'* DATAWORKS_V2 (Apsara Stack DataWorks V3.6.1 to V3.11)'."\n" - .'* DATAWORKS_V3 (Apsara Stack DataWorks V3.12 and later)'."\n" - ."\n" - .'The DWMA and DATAWORKS_MODEL types are interchangeable.'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'DATAWORKS_MODEL', - ], - 'MigrationType' => [ - 'description' => 'The type of the migration task. Valid values:'."\n" - ."\n" - .'* IMPORT'."\n" - .'* EXPORT'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'EXPORT', - ], - 'CreateTime' => [ - 'description' => 'The time when the migration task was created.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123124123123123', - ], - 'UpdateTime' => [ - 'description' => 'The time when the migration task was last updated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123123123123123', - ], - 'CreateUser' => [ - 'description' => 'The ID of the user who created the migration task.'."\n", - 'type' => 'string', - 'example' => '123123****', - ], - 'CreateUserName' => [ - 'description' => 'The name of the user who created the migration task.'."\n", - 'type' => 'string', - 'example' => '3h1_test', - ], - 'UpdateUser' => [ - 'description' => 'The ID of the user who last updated the migration task.'."\n", - 'type' => 'string', - 'example' => '1231****', - ], - 'UpdateUserName' => [ - 'description' => 'The name of the user who last updated the migration task.'."\n", - 'type' => 'string', - 'example' => '3h1_test', - ], - 'ProjectId' => [ - 'description' => 'The ID of the DataWorks workspace to which the task belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '72132', - ], - 'TenantId' => [ - 'description' => 'The tenant ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16307', - ], - 'Status' => [ - 'description' => 'The status of the migration task. Valid values:'."\n" - ."\n" - .'* INIT: The migration task is in the initial state.'."\n" - .'* EDITING: The migration task is being edited.'."\n" - .'* RUNNING: The migration task is running.'."\n" - .'* FAILURE: The migration task fails to run.'."\n" - .'* SUCCESS: The migration task is successfully run.'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'SUCCESS', - ], - 'Message' => [ - 'description' => 'The error message returned.'."\n", - 'type' => 'string', - 'example' => 'An internal system error occurred. datasource kafka region is not cn-chengdu, can\'t open network for it', - ], - 'DownloadUrl' => [ - 'description' => 'The URL that is used to download the package of the export task. You can use the URL to download the package of the export task.'."\n", - 'type' => 'string', - 'example' => 'http://geoip-sdk-user.oss-cn-zhangjiakou.aliyuncs.com/product/v1/ipv4/trace/v1.20220424123842.dex?Expires=1650780849&OSSAccessKeyId=XXXXXXeF4Lv5j&Signature=qxxxxx', - ], - 'Description' => [ - 'description' => 'The description of the export task.'."\n", - 'type' => 'string', - 'example' => 'Automated Test creation', - ], - ], - ], - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 50.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], + 'Status' => ['description' => 'Indicates whether the real-time synchronization task or the data synchronization solution is started. Valid values:'."\n" + ."\n" + .'* success: The real-time synchronization task or the data synchronization solution is started.'."\n" + .'* fail: The real-time synchronization task or the data synchronization solution fails to be started. You can troubleshoot the issue based on the provided cause.'."\n", 'type' => 'string', 'example' => 'success'], + 'Message' => ['description' => 'The reason why the real-time synchronization task or the data synchronization solution fails to be started.'."\n" + ."\n" + .'If the real-time synchronization task or the data synchronization solution is started, the value null is returned.'."\n", 'type' => 'string', 'example' => 'fileId:[100] is invalid.'], ], ], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"F9198AA3-9010-53D5-9714-DC4****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Migrations\\": [\\n {\\n \\"Id\\": 436064,\\n \\"Name\\": \\"test_task_1638498642279\\",\\n \\"PackageType\\": \\"DATAWORKS_MODEL\\",\\n \\"MigrationType\\": \\"EXPORT\\",\\n \\"CreateTime\\": 123124123123123,\\n \\"UpdateTime\\": 123123123123123,\\n \\"CreateUser\\": \\"123123****\\",\\n \\"CreateUserName\\": \\"3h1_test\\",\\n \\"UpdateUser\\": \\"1231****\\",\\n \\"UpdateUserName\\": \\"3h1_test\\",\\n \\"ProjectId\\": 72132,\\n \\"TenantId\\": 16307,\\n \\"Status\\": \\"SUCCESS\\",\\n \\"Message\\": \\"An internal system error occurred. datasource kafka region is not cn-chengdu, can\'t open network for it\\",\\n \\"DownloadUrl\\": \\"http://geoip-sdk-user.oss-cn-zhangjiakou.aliyuncs.com/product/v1/ipv4/trace/v1.20220424123842.dex?Expires=1650780849&OSSAccessKeyId=*****&Signature=qxxxxx\\",\\n \\"Description\\": \\"Automated Test creation\\"\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 20\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n F9198AA3-9010-53D5-9714-DC4461427D3E\\n true\\n \\n \\n 436064\\n test_task_1638498642279\\n DATAWORKS_MODEL\\n EXPORT\\n 123124123123123\\n 123123123123123\\n 123123****\\n 3h1_test\\n 1231****\\n 3h1_test\\n 72132\\n 16307\\n SUCCESS\\n An internal system error occurred. datasource kafka region is not cn-chengdu, can\'t open network for it\\n http://geoip-sdk-user.oss-cn-zhangjiakou.aliyuncs.com/product/v1/ipv4/trace/v1.20220424123842.dex?Expires=1650780849&OSSAccessKeyId=XXXXXXeF4Lv5j&Signature=qxxxxx\\n 自动化测试创建\\n \\n 1\\n 10\\n 20\\n \\n","errorExample":""}]', - 'title' => 'ListMigrations', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Param.Invalid', 'errorMessage' => 'The parameter is invalid.', 'description' => 'Param invalid'], + ], + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal error occurred.', 'description' => 'InternalError '], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0bc1411515937635973****\\",\\n \\"Data\\": {\\n \\"Status\\": \\"success\\",\\n \\"Message\\": \\"fileId:[100] is invalid.\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 0bc1411515937635973****\\n \\n success\\n fileId:[100] is invalid.\\n \\n true\\n","errorExample":""}]', + 'title' => 'StartDISyncInstance', + 'summary' => 'Starts a real-time synchronization task or a synchronization solution.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], ], - 'CreatePermissionApplyOrder' => [ - 'summary' => 'Creates a permission request order.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'StartMigration' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -57490,1054 +35673,783 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '78190', - 'abilityTreeNodes' => [ - 'FEATUREdide0DCVNY', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '78357', + 'abilityTreeNodes' => ['FEATUREdide8FM783'], ], 'parameters' => [ [ - 'name' => 'ApplyUserIds', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the Alibaba Cloud account for which you want to request permissions. If you want to request permissions for multiple Alibaba Cloud accounts, separate the IDs of the accounts with commas (,).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '267842600408993176,267842600408993177', - ], + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The workspace ID. You can log on to the DataWorks console and go to the Workspace page to obtain the workspace ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '2', 'example' => '123456'], ], [ - 'name' => 'Deadline', - 'in' => 'query', + 'name' => 'MigrationId', + 'in' => 'formData', + 'schema' => ['description' => 'The migration package ID. You can call the [CreateImportMigration](~~206094~~) operation to query the ID of the import package and call the [CreateExportMigration](~~349325~~) operation to query the ID of the export package.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '2', 'example' => '123456'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The expiration time of the permissions that you request. This value is a UNIX timestamp. The default value is January 1, 2065. If LabelSecurity is disabled for the MaxCompute project in which you want to request permissions on the fields of a table, or the security level of the fields is 0 or is lower than or equal to the security level of the Alibaba Cloud account for which you want to request permissions, you can request only permanent permissions. You can go to the Workspace Management page in the DataWorks console, click MaxCompute Management in the left-side navigation pane, and then check whether column-level access control is enabled. You can go to your DataWorks workspace, view the security level of the fields in Data Map, and then view the security level of the Alibaba Cloud account on the User Management page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1617115071885', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Data' => ['description' => 'Indicates whether the migration task is started. Valid values:'."\n" + ."\n" + .'* true: The migration task is started.'."\n" + .'* false: The migration task fails to be started.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'test error msg'], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'FSDFSDF-WERWER-XVCX-DSFSDF'], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '110001123445'], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true'], + ], + 'description' => '', ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"test error msg\\",\\n \\"RequestId\\": \\"FSDFSDF-WERWER-XVCX-DSFSDF\\",\\n \\"ErrorCode\\": \\"110001123445\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n true\\n test error msg\\n FSDFSDF-WERWER-XVCX-DSFSDF\\n 110001123445\\n true\\n","errorExample":""}]', + 'title' => 'StartMigration', + 'summary' => 'Starts a migration task.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'ApplyReason', - 'in' => 'query', - 'schema' => [ - 'description' => 'The reason for your request. The administrator determines whether to approve the request based on the reason.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'I need to use this table', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'StopDIJob' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'MaxComputeProjectName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the MaxCompute project you request access to.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'aMaxcomputeProjectName', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '155174', + 'abilityTreeNodes' => ['FEATUREdideQHGTK4'], + ], + 'parameters' => [ [ - 'name' => 'WorkspaceId', - 'in' => 'query', + 'name' => 'DIJobId', + 'in' => 'formData', + 'schema' => ['description' => 'The task ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11668'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The DataWorks workspace ID to which the MaxCompute project belongs for permission requests. You can check the workspace ID on the DataWorks workspace configuration page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'maximum' => '999999', - 'minimum' => '0', - 'example' => '12345', + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '92F778C7-8F00-53B1-AE1A-B3B17101247D'], + ], ], ], + ], + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"92F778C7-8F00-53B1-AE1A-B3B17101247D\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 92F778C7-8F00-53B1-AE1A-B3B17101247D\\n","errorExample":""}]', + 'title' => 'StopDIJob', + 'summary' => 'Stops a new-version synchronization task. The following type of synchronization task is supported: real-time synchronization of all data in a MySQL database to Hologres.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopDIJob'], + ], + ], + 'ramActions' => [], + ], + 'StopDISyncInstance' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'OrderType', + 'AK' => [], + ], + [ + 'PrivateKey' => [], + ], + [ + 'APP' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ + [ + 'name' => 'ProjectId', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => 'The request type. The only supported value is 1, which represents an object ACL permission request.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'deprecated' => true, - 'required' => false, - 'example' => '1', - 'enum' => [ - '1', - ], - ], + 'schema' => ['description' => 'The ID of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the workspace ID.'."\n" + ."\n" + .'You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '10000000000', 'minimum' => '1', 'example' => '10000'], ], [ - 'name' => 'EngineType', + 'name' => 'TaskType', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => 'The type of compute engine for permission requests. Currently only supports ODPS, which means only MaxCompute compute engine permissions are supported.'."\n", - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - 'example' => 'odps', - 'enum' => [ - 'odps', - ], - ], + 'schema' => ['description' => 'The type of the synchronization task that you want to stop. Set the value to DI_REALTIME.'."\n" + ."\n" + .'DI_REALTIME indicates a real-time synchronization task.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DI_REALTIME'], ], [ - 'name' => 'ApplyObject', + 'name' => 'FileId', 'in' => 'query', - 'style' => 'repeatList', + 'schema' => ['description' => 'The ID of the synchronization task. You can call the [ListFiles](~~173942~~) operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9999999999999999', 'minimum' => '1', 'example' => '100'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The list of requested objects.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'Actions' => [ - 'description' => 'The type of permissions requested. Use commas (,) to separate multiple permission types in a single request. Currently only supports Select, Describe, Drop, Alter, Update, and Download permission types.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Select,Describe', - ], - 'ColumnMetaList' => [ - 'description' => 'The list of column objects.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'Permissions for the target columns. Enter the column names here. If applying for permissions on the entire table, enter all column names of the table. Permissions for specific columns can only be requested if labelSecurity is enabled for the MaxCompute project. Otherwise, you can only apply for permissions on the entire table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'aColumnName', - ], - 'Actions' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Select', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 200, - ], - 'Name' => [ - 'description' => 'The object you request access to. Currently, only permission requests for MaxCompute tables are supported. The name of the target table needs to be entered here.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'aTableName', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], + 'RequestId' => ['description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", 'type' => 'string', 'example' => '0bc1411515937635973****'], + 'Data' => [ + 'description' => 'The information returned for the synchronization task.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'Indicates whether the synchronization task is stopped. Valid values:'."\n" + ."\n" + .'* success'."\n" + .'* fail'."\n", 'type' => 'string', 'example' => 'success'], + 'Message' => ['description' => 'The reason why the synchronization task fails to be stopped.'."\n" + ."\n" + .'If the synchronization task is stopped, the value null is returned.'."\n", 'type' => 'string', 'example' => 'fileId:[100] is invalid.'], ], ], - 'required' => false, ], - 'required' => true, - 'maxItems' => 50, ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Param.Invalid', 'errorMessage' => 'The parameter is invalid.', 'description' => 'Param invalid'], + ], + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal error occurred.', 'description' => 'InternalError '], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0bc1411515937635973****\\",\\n \\"Data\\": {\\n \\"Status\\": \\"success\\",\\n \\"Message\\": \\"fileId:[100] is invalid.\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 0bc1411515937635973****\\n \\n success\\n fileId:[100] is invalid.\\n \\n","errorExample":""}]', + 'title' => 'StopDISyncInstance', + 'summary' => 'Stops a real-time synchronization task.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'StopInstance' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ApplyType', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'MaxComputeTable', - 'default' => 'MaxComputeTable', - 'enum' => [ - 'MaxComputeTable', - 'DLFSchema', - 'DLFTable', - 'DLFColumn', - 'DsApiDeploy', - ], - ], + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '78359', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB'], + ], + 'parameters' => [ + [ + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => 'The instance ID. You can call the [ListInstances](~~173982~~) operation to obtain the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1234'], ], [ - 'name' => 'CatalogName', - 'in' => 'query', + 'name' => 'ProjectEnv', + 'in' => 'formData', 'schema' => [ - 'description' => '', + 'description' => 'The environment of the workspace. Valid values: PROD and DEV.'."\n", 'type' => 'string', - 'required' => false, - 'example' => 'hive', + 'required' => true, + 'docRequired' => true, + 'example' => 'PROD', + 'enum' => ['PROD', 'DEV'], ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The returned result.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0bc1ec92159376****', - ], - 'FlowId' => [ - 'description' => 'The request order ID.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The request order ID. If you request permissions on multiple objects but each object has a different request approver, one request order is generated for each object and is sent to the related approver. In this case, an array is returned.'."\n", - 'type' => 'string', - 'example' => 'ee276e6e-5d34-46d8-b848-bca7879ed233', - ], - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Data' => ['description' => 'The result returned.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The connection does not exist.'], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'E6F0DBDD-5AD****'], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists'], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true'], ], + 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0bc1ec92159376****\\",\\n \\"FlowId\\": [\\n \\"ee276e6e-5d34-46d8-b848-bca7879ed233\\"\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 0bc1ec92159376****\\n ee276e6e-5d34-46d8-b848-bca7879ed233\\n","errorExample":""}]', - 'title' => 'CreatePermissionApplyOrder', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n E6F0DBDD-5AD****\\n 200\\n true\\n Invalid.Tenant.ConnectionNotExists\\n The connection does not exist.\\n true\\n","errorExample":""}]', + 'title' => 'StopInstance', + 'summary' => 'Terminates an instance.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'GetPermissionApplyOrderDetail' => [ - 'summary' => 'Queries the details of a permission request order.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2022-08-12T08:46:57.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-08-12T08:46:57.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-08-12T08:46:57.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'SubmitDataServiceApi' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '78280', - 'abilityTreeNodes' => [ - 'FEATUREdideGWNJ45', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '157978', + 'abilityTreeNodes' => ['FEATUREdideZZ63WZ'], ], 'parameters' => [ [ - 'name' => 'FlowId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the permission request order. You can call the [ListPermissionApplyOrders](~~211008~~) operation to obtain the ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '48f36729-05f9-4a40-9286-933fd940f30a', - ], + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the DataWorks console. Find your workspace and go to the [DataService Studio](https://ds-cn-shanghai.data.aliyun.com/) page. On the DataService Studio page, click the logon username in the upper-right corner and click User Info in the Menu section.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10001'], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the workspace ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000'], + ], + [ + 'name' => 'ApiId', + 'in' => 'formData', + 'schema' => ['description' => 'The API ID. You can call the [ListDataServiceApis](~~ListDataServiceApis~~) operation to obtain the ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12345'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The returned result.'."\n", + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0bc1ec92159376****', - ], - 'ApplyOrderDetail' => [ - 'description' => 'Details of the permission request order.'."\n", - 'type' => 'object', - 'properties' => [ - 'ApplyBaseId' => [ - 'description' => 'The ID of the Alibaba Cloud account that was used to submit the permission request order.'."\n", - 'type' => 'string', - 'example' => '267842600408993176', - ], - 'ApplyTimestamp' => [ - 'description' => 'The time when the permission request order was submitted. The value is a UNIX timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1615284086000', - ], - 'FlowId' => [ - 'description' => 'The ID of the permission request order.'."\n", - 'type' => 'string', - 'example' => 'ad8da78d-8135-455e-9486-27cf213fc140', - ], - 'FlowStatus' => [ - 'description' => 'The status of the permission request order. Valid values:'."\n" - ."\n" - .'* 1: to be processed'."\n" - .'* 2: approved and authorized'."\n" - .'* 3: approved but authorization failed'."\n" - .'* 4: rejected'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'ApproveAccountList' => [ - 'description' => 'The list of Alibaba Cloud accounts that are used to process the permission request order.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'BaseId' => [ - 'description' => 'The ID of the Alibaba Cloud account that is used to process the permission request order.'."\n", - 'type' => 'string', - 'example' => '182293110403****', - ], - ], - ], - ], - 'GranteeObjectList' => [ - 'description' => 'The information about the account that is used to request permissions.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'GranteeType' => [ - 'description' => 'The type of the subject that requests permissions. The value is fixed as 1, which indicates users.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'GranteeTypeSub' => [ - 'description' => 'The subtype of the subject that requests permissions. Valid values:'."\n" - ."\n" - .'* 101: production account'."\n" - .'* 103: individual account'."\n" - .'* 105: account that requests permissions for others'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '103', - ], - 'GranteeName' => [ - 'description' => 'The name of the account that is used to request permissions. The name is in the same format as that of the account used to access the MaxCompute project.'."\n" - ."\n" - .'* If the account is an Alibaba Cloud account, the value is in the ALIYUN$+Account name format.'."\n" - .'* If the account is a RAM user, the value is in the RAM$+Account name format.'."\n", - 'type' => 'string', - 'example' => 'RAM$dataworks_3h1_1:StsRamUser(StsRamUser)', - ], - 'GranteeId' => [ - 'description' => 'The ID of the account that is used to request permissions.'."\n", - 'type' => 'string', - 'example' => '267842600408993176', - ], - ], - ], - ], - 'ApproveContent' => [ - 'description' => 'The content of the permission request.'."\n", - 'type' => 'object', - 'properties' => [ - 'ApplyReason' => [ - 'description' => 'The reason of the permission request. The administrator processes the request based on the reason.'."\n", - 'type' => 'string', - 'example' => 'I need to use this table', - ], - 'Deadline' => [ - 'description' => 'The expiration time of the permissions that you request. The value is a UNIX timestamp. If LabelSecurity is disabled for the MaxCompute project in which you want to request permissions on the fields of a table, or the security level of the fields is 0 or is lower than or equal to the security level of the Alibaba Cloud account for which you want to request permissions, you can request only permanent permissions.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1617115071885', - ], - 'OrderType' => [ - 'description' => 'The type of the permission request order. The parameter value is 1 and cannot be changed. This value indicates ACL-based authorization.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ProjectMeta' => [ - 'description' => 'The information about the project and workspace that are associated with the object on which you request permissions.'."\n", - 'type' => 'object', - 'properties' => [ - 'MaxComputeProjectName' => [ - 'description' => 'The MaxCompute project to which the object on which you request permissions belongs.'."\n", - 'type' => 'string', - 'example' => 'aMaxComputeProject', - ], - 'WorkspaceId' => [ - 'description' => 'The ID of the DataWorks workspace that is associated with the object on which you request permissions.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '12345', - ], - 'ObjectMetaList' => [ - 'description' => 'The details about the object on which you request permissions.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'ObjectName' => [ - 'description' => 'The name of the table on which you request permissions.'."\n", - 'type' => 'string', - 'example' => 'aTableName', - ], - 'ColumnMetaList' => [ - 'description' => 'The information about the column fields in the object on which you request permissions.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'ColumnName' => [ - 'description' => 'The name of the column on which you request permissions.'."\n", - 'type' => 'string', - 'example' => 'aColumnName', - ], - 'ColumnComment' => [ - 'description' => 'The description of the column on which you request permissions.'."\n", - 'type' => 'string', - 'example' => 'Field description', - ], - 'SecurityLevel' => [ - 'description' => 'The security level of the column on which you request permissions. Valid values: 0 to 9.'."\n", - 'type' => 'string', - 'example' => '9', - ], - 'ColumnActions' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - 'Actions' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'FinishAapprovalTimestamp' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1757496687000', - ], - 'FinishApprovalComment' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'agree', - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0000-ABCD-EFG****'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Data' => ['description' => 'Indicates whether the API was submitted.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists'], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0bc1ec92159376****\\",\\n \\"ApplyOrderDetail\\": {\\n \\"ApplyBaseId\\": \\"26784260040899****\\",\\n \\"ApplyTimestamp\\": 1615284086000,\\n \\"FlowId\\": \\"ad8da78d-8135-455e-9486-27cf213f****\\",\\n \\"FlowStatus\\": 2,\\n \\"ApproveAccountList\\": [\\n {\\n \\"BaseId\\": \\"182293110403****\\"\\n }\\n ],\\n \\"GranteeObjectList\\": [\\n {\\n \\"GranteeType\\": 1,\\n \\"GranteeTypeSub\\": 103,\\n \\"GranteeName\\": \\"RAM$dataworks_3h1_1:StsRamUser(StsRamUser)\\",\\n \\"GranteeId\\": \\"26784260040899****\\"\\n }\\n ],\\n \\"ApproveContent\\": {\\n \\"ApplyReason\\": \\"I need to use this table\\",\\n \\"Deadline\\": 1617115071885,\\n \\"OrderType\\": 1,\\n \\"ProjectMeta\\": {\\n \\"MaxComputeProjectName\\": \\"aMaxComputeProject\\",\\n \\"WorkspaceId\\": 123456,\\n \\"ObjectMetaList\\": [\\n {\\n \\"ObjectName\\": \\"aTableName\\",\\n \\"ColumnMetaList\\": [\\n {\\n \\"ColumnName\\": \\"aColumnName\\",\\n \\"ColumnComment\\": \\"Field description\\",\\n \\"SecurityLevel\\": \\"9\\",\\n \\"ColumnActions\\": [\\n \\"\\"\\n ]\\n }\\n ],\\n \\"Actions\\": [\\n \\"\\"\\n ]\\n }\\n ]\\n }\\n },\\n \\"FinishAapprovalTimestamp\\": 1757496687000,\\n \\"FinishApprovalComment\\": \\"agree\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 0bc1ec92159376****\\n \\n 26784260040899****\\n 1615284086000\\n ad8da78d-8135-455e-9486-27cf213f****\\n 2\\n \\n 182293110403****\\n \\n \\n 1\\n 103\\n RAM$dataworks_3h1_1:StsRamUser(StsRamUser)\\n 26784260040899****\\n \\n \\n I need to use this table\\n 1617115071885\\n 1\\n \\n aMaxComputeProject\\n 12345\\n \\n aTableName\\n \\n aColumnName\\n 字段描述\\n 9\\n \\n \\n \\n \\n \\n","errorExample":""}]', - 'title' => 'GetPermissionApplyOrderDetail', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListPermissionApplyOrders' => [ - 'summary' => 'Queries a list of permission requests.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 0000-ABCD-EFG****\\n 200\\n true\\n Invalid.Tenant.ConnectionNotExists\\n true\\n","errorExample":""}]', + 'title' => 'SubmitDataServiceApi', + 'summary' => 'Submits an API in DataService Studio.', + 'changeSet' => [ + ['createdAt' => '2024-04-23T02:32:11.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-10-09T11:17:28.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitDataServiceApi'], + ], ], + 'ramActions' => [], + ], + 'SubmitFile' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '78323', - 'abilityTreeNodes' => [ - 'FEATUREdide0DCVNY', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '78360', + 'abilityTreeNodes' => ['FEATUREdide8FM783'], ], 'parameters' => [ [ - 'name' => 'FlowStatus', - 'in' => 'query', - 'schema' => [ - 'description' => 'The status of the permission request. Valid values:'."\n" - ."\n" - .'* 1: Pending approval'."\n" - .'* 2: Approved and authorization succeeded'."\n" - .'* 3: Approved but authorization failed'."\n" - .'* 4: Rejected'."\n" - .'* 5: Withdrawn'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 0'."\n" - .'* 1'."\n" - .'* 2'."\n" - .'* 3'."\n" - .'* 4'."\n" - .'* 5'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'enum' => [ - '0', - '1', - '2', - '3', - '4', - '5', - ], - ], + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the DataWorks workspace. You can log on to the DataWorks Console and go to the Workspace Configurations page to obtain the workspace ID. Specify either this parameter or `ProjectIdentifier` to identify the DataWorks workspace.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '100001', 'title' => ''], ], [ - 'name' => 'WorkspaceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the workspace to which the permission request belongs. If you do not specify this parameter, permission requests from all workspaces are returned. To obtain the workspace ID, log on to the DataWorks console and navigate to the workspace configuration page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '12345', - ], + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the DataWorks workspace. You can log on to the DataWorks Console and go to the Workspace Configurations page to obtain the workspace name. Specify either this parameter or `ProjectId` to identify the DataWorks workspace.', 'type' => 'string', 'required' => false, 'example' => 'dw_project', 'title' => ''], ], [ - 'name' => 'OrderType', - 'in' => 'query', + 'name' => 'FileId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the file. Obtain this ID by calling the [ListFiles](~~173942~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1000000', 'title' => ''], + ], + [ + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => ['description' => 'The comment for the submission.', 'type' => 'string', 'required' => false, 'example' => 'Submit a task for the first time', 'title' => ''], + ], + [ + 'name' => 'SkipAllDeployFileExtensions', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to skip the pre-deployment check after the file is submitted.'."\n" + ."\n" + .'- false: Do not skip. After the file is submitted, the pre-deployment check process is automatically triggered. The file becomes deployable only after it passes the check.'."\n" + ."\n" + .'- true: Skip. The pre-deployment check process is not triggered after the file is submitted. You can proceed directly with the deployment process.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'false', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'This parameter is deprecated and does not take effect.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 1'."\n" - .'* 0'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'maximum' => '1', - 'minimum' => '0', - 'example' => '1', - 'enum' => [ - '1', - '0', + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The deployment ID. Call the [GetDeployment](~~173950~~) operation with this ID to query the deployment details.', 'type' => 'integer', 'format' => 'int64', 'example' => '3000001', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is used for troubleshooting.', 'type' => 'string', 'example' => '0000-ABCD-EFG****', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The connection does not exist.', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 3000001,\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\"\\n}","type":"json"}]', + 'title' => 'SubmitFile', + 'summary' => 'Submits a file to the development environment to create a corresponding task.', + 'description' => 'This operation is asynchronous. After a successful submission, the system returns a DeploymentId. Call the [GetDeployment](~~173950~~) operation with this ID to query the status and final result of the deployment task.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-07-20T02:47:45.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'MaxComputeProjectName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the MaxCompute project with which the permission request order is associated. If you do not specify the parameter, the permission request orders of all MaxCompute projects are returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'aMaxComputeProject', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'SuspendInstance' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'TableName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the table with which the permission request order is associated. If you do not specify the parameter, the permission request orders of all tables are returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'aTableName', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '78361', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB'], + ], + 'parameters' => [ [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. You can query all the permissions request orders that have been submitted after the time. The parameter value is a UNIX timestamp. If you do not specify the parameter, all permission request orders are queried.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1616200471885', - ], + 'name' => 'InstanceId', + 'in' => 'formData', + 'schema' => ['description' => 'The instance ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1234', 'title' => ''], ], [ - 'name' => 'EndTime', - 'in' => 'query', + 'name' => 'ProjectEnv', + 'in' => 'formData', 'schema' => [ - 'description' => 'The end of the time range to query. You can query all the permissions request orders that have been submitted before the time. The parameter value is a UNIX timestamp. If you do not specify the parameter, all permission request orders that are submitted before the current time are queried.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1617200471885', + 'description' => 'The environment of the workspace. Valid values: PROD and DEV.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enum' => ['PROD', 'DEV'], + 'example' => 'PROD', + 'title' => '', ], ], - [ - 'name' => 'EngineType', - 'in' => 'query', - 'allowEmptyValue' => true, + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'This parameter is deprecated and does not take effect.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* odps'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'odps', - 'enum' => [ - 'odps', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The data returned.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The connection does not exist.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. You can use the ID to locate logs and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '0baf87f0159376****', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'Invalid.Tenant.ProjectNotExists', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'SuspendInstance', + 'summary' => 'Suspends an instance.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-08-12T08:46:57.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-08-12T08:46:57.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-08-12T08:46:57.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0baf87f0159376****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ProjectNotExists\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'TerminateDISyncInstance' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], [ - 'name' => 'PageNum', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number for pagination. The value must be a positive integer greater than or equal to 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + 'PrivateKey' => [], ], [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - 'default' => '10', - ], + 'APP' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], + 'parameters' => [ [ - 'name' => 'QueryType', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => 'The query type for permission requests. Valid values:'."\n" - ."\n" - .'* 0: Permission requests submitted by me'."\n" - .'* 1: Permission requests pending my approval'."\n" - .'* 2: All permission requests'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '2', - 'minimum' => '0', - 'example' => '1', - 'enum' => [ - '0', - '1', - '2', - ], - ], + 'schema' => ['description' => 'The ID of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the workspace ID.'."\n" + ."\n" + .'You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '10000000000', 'minimum' => '1', 'example' => '10000'], ], [ - 'name' => 'ApplyType', + 'name' => 'TaskType', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of permission request. Valid values:'."\n" - ."\n" - .'* MaxComputeTable: Permission request for MaxCompute tables'."\n" - .'* MaxComputeFunction: Permission request for MaxCompute functions'."\n" - .'* MaxComputeResource: Permission request for MaxCompute resources'."\n" - .'* DLFSchema: Permission request for DLF 1.0 schemas'."\n" - .'* DLFTable: Permission request for DLF 1.0 tables'."\n" - .'* DLFColumn: Permission request for DLF 1.0 columns'."\n" - .'* DsApiDeploy: Permission request for publishing data services'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'MaxComputeTable', - 'default' => 'MaxComputeTable', - 'enum' => [ - 'MaxComputeTable', - 'MaxComputeFunction', - 'MaxComputeResource', - 'DLFSchema', - 'DLFTable', - 'DLFColumn', - 'HologresTable', - 'StarRocksTable', - 'StarRocksSchema', - 'EmrSchema', - 'EmrTable', - 'LindormTable', - 'DsApiDeploy', - 'DIJobs', - 'ExtensionSet', - 'DgcCheckerOperation', - ], - ], + 'schema' => ['description' => 'The value DI_REALTIME indicates that the task is a real-time synchronization task.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DI_REALTIME'], ], [ - 'name' => 'CatalogName', + 'name' => 'FileId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the data catalog to query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'hive', - ], + 'schema' => ['description' => 'The ID of the real-time synchronization task.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9999999999999999', 'minimum' => '1', 'example' => '100'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response.'."\n", + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0bc1ec92159376****', - ], - 'ApplyOrders' => [ - 'description' => 'The paginated query results of permission requests.'."\n", + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], + 'RequestId' => ['description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", 'type' => 'string', 'example' => '0bc1411515937635973****'], + 'Data' => [ + 'description' => 'The returned results.'."\n", 'type' => 'object', 'properties' => [ - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TotalCount' => [ - 'description' => 'The total number of permission requests returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '150', - ], - 'ApplyOrder' => [ - 'description' => 'The list of permission requests.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The response.'."\n", - 'type' => 'object', - 'properties' => [ - 'ApplyBaseId' => [ - 'description' => 'The Alibaba Cloud account ID of the user who submitted the permission request.'."\n", - 'type' => 'string', - 'example' => '267842600408993176', - ], - 'ApplyTimestamp' => [ - 'description' => 'The time when the permission request was submitted, in Unix timestamp format.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1615284086000', - ], - 'FlowId' => [ - 'description' => 'The permission request ID.'."\n", - 'type' => 'string', - 'example' => 'ad8da78d-8135-455e-9486-27cf213fc140', - ], - 'FlowStatus' => [ - 'description' => 'The status of the permission request. Valid values:'."\n" - ."\n" - .'* 1: Pending approval'."\n" - .'* 2: Approved and authorization succeeded'."\n" - .'* 3: Approved but authorization failed'."\n" - .'* 4: Rejected'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'ApproveContent' => [ - 'description' => 'The content of the permission request.'."\n", - 'type' => 'object', - 'properties' => [ - 'ApplyReason' => [ - 'description' => 'The reason for the permission request, which is used by administrators for evaluation and approval.'."\n", - 'type' => 'string', - 'example' => 'I need to use this table', - ], - 'OrderType' => [ - 'description' => 'The type of permission request. Only the value 1 is supported, which indicates an ACL permission request for objects.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ProjectMeta' => [ - 'description' => 'The content of the requested object.'."\n", - 'type' => 'object', - 'properties' => [ - 'WorkspaceName' => [ - 'description' => 'The name of the DataWorks workspace that contains the MaxCompute project for which permissions are requested.'."\n", - 'type' => 'string', - 'example' => 'aWorkspaceName', - ], - 'ObjectMetaList' => [ - 'description' => 'The information about the requested object.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The response.'."\n", - 'type' => 'object', - 'properties' => [ - 'ObjectName' => [ - 'description' => 'The name of the requested table.'."\n", - 'type' => 'string', - 'example' => 'aTableName', - ], - 'Actions' => [ - 'description' => 'The operation type.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The permission types requested. Separate multiple permission types with commas (,). Valid values: Select, Describe, Drop, Alter, Update, and Download.'."\n", - 'type' => 'string', - 'example' => 'Select,Describe', - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'FinishApprovalTimestamp' => [ - 'description' => 'The final approval timestamp. Displayed as a Unix timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1757496687000', - ], - 'FinishApprovalComment' => [ - 'description' => 'The final approval comment.'."\n", - 'type' => 'string', - 'example' => 'agree', - ], - ], - ], - ], + 'Status' => ['description' => 'Indicates whether the real-time synchronization task is undeployed. Valid values:'."\n" + ."\n" + .'* success'."\n" + .'* fail'."\n", 'type' => 'string', 'example' => 'success'], + 'Message' => ['description' => 'The reason why the real-time synchronization task fails to be terminated. If the real-time synchronization task is undeployed, the value of this parameter is null.'."\n", 'type' => 'string', 'example' => 'fileId:[100] is invalid.'], ], ], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0bc1ec92159376****\\",\\n \\"ApplyOrders\\": {\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 150,\\n \\"ApplyOrder\\": [\\n {\\n \\"ApplyBaseId\\": \\"267842600408993176\\",\\n \\"ApplyTimestamp\\": 1615284086000,\\n \\"FlowId\\": \\"ad8da78d-8135-455e-9486-27cf213fc140\\",\\n \\"FlowStatus\\": 2,\\n \\"ApproveContent\\": {\\n \\"ApplyReason\\": \\"I need to use this table\\",\\n \\"OrderType\\": 1,\\n \\"ProjectMeta\\": {\\n \\"WorkspaceName\\": \\"aWorkspaceName\\",\\n \\"ObjectMetaList\\": [\\n {\\n \\"ObjectName\\": \\"aTableName\\",\\n \\"Actions\\": [\\n \\"Select,Describe\\"\\n ]\\n }\\n ]\\n }\\n },\\n \\"FinishApprovalTimestamp\\": 1757496687000,\\n \\"FinishApprovalComment\\": \\"agree\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 0bc1ec92159376****\\n \\n 10\\n 1\\n 150\\n \\n 267842600408993176\\n 1615284086000\\n ad8da78d-8135-455e-9486-27cf213fc140\\n 2\\n \\n I need to use this table\\n 1\\n \\n aWorkspaceName\\n \\n aTableName\\n Select,Describe\\n \\n \\n \\n \\n \\n","errorExample":""}]', - 'title' => 'ListPermissionApplyOrders', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ApprovePermissionApplyOrder' => [ - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Param.Invalid', 'errorMessage' => 'The parameter is invalid.', 'description' => 'Param invalid'], + ], + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal error occurred.', 'description' => 'InternalError '], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0bc1411515937635973****\\",\\n \\"Data\\": {\\n \\"Status\\": \\"success\\",\\n \\"Message\\": \\"fileId:[100] is invalid.\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 0bc1411515937635973****\\n \\n success\\n fileId:[100] is invalid.\\n \\n","errorExample":""}]', + 'title' => 'TerminateDISyncInstance', + 'summary' => 'Undeploys a real-time synchronization task.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'TestDataServiceApi' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'FlowId', + 'name' => 'ApiId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the DataService Studio API on which the test is performed.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '12343'], + ], + [ + 'name' => 'QueryParam', + 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The ID of the permission request order. You can call the ListPermissionApplyOrders operation to obtain the order ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '48f36729-05f9-4a40-9286-933fd940f30a', + 'description' => 'The request parameters that are contained in the query.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The object that is requested to query.'."\n", + 'type' => 'object', + 'properties' => [ + 'ParamKey' => ['description' => 'The name of the parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'name'], + 'ParamValue' => ['description' => 'The value of the parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test'], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 500, ], ], [ - 'name' => 'ApproveComment', - 'in' => 'query', + 'name' => 'BodyParams', + 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The comment on the order.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'agree', + 'description' => 'The request parameters that are contained in the request body.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The object that is requested to query.'."\n", + 'type' => 'object', + 'properties' => [ + 'ParamKey' => ['description' => 'The name of the parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'name'], + 'ParamValue' => ['description' => 'The value of the parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test'], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 500, ], ], [ - 'name' => 'ApproveAction', - 'in' => 'query', + 'name' => 'PathParams', + 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The action for the permission request order. Valid values:'."\n" - ."\n" - .'* 1: approve'."\n" - .'* 2: reject'."\n" - ."\n" - .''."\n" - ."\n" - .'* 0'."\n" - .'* 1'."\n" - .'* 2\\.'."\n" - .'* 3\\.'."\n" - .'* 4'."\n" - .'* 5'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '5', - 'minimum' => '0', - 'enumValueTitles' => [], - 'example' => '1', - 'enum' => [ - '0', - '1', - '2', - '3', - '4', - '5', + 'description' => 'The request parameters that are contained in the request path.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The object that is requested to query.'."\n", + 'type' => 'object', + 'properties' => [ + 'ParamKey' => ['description' => 'The name of the parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'path1'], + 'ParamValue' => ['description' => 'The value of the parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'api'], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 500, + ], + ], + [ + 'name' => 'HeadParams', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The request parameters that are contained in the request header.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The object that is requested to query.'."\n", + 'type' => 'object', + 'properties' => [ + 'ParamKey' => ['description' => 'The name of the parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'requestId'], + 'ParamValue' => ['description' => 'The value of the parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'abcd'], + ], + 'required' => false, ], + 'required' => false, + 'maxItems' => 500, ], ], + [ + 'name' => 'BodyContent', + 'in' => 'formData', + 'schema' => ['description' => 'The data of the request body.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"name":"test"}'], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'ApproveSuccess' => [ - 'description' => 'Indicates whether the permission request order is processed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0bc1ec92159376****', + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'abdsfewe'], + 'Data' => [ + 'description' => 'The information about the test.'."\n", + 'type' => 'object', + 'properties' => [ + 'TestId' => ['description' => 'The ID of the test.'."\n", 'type' => 'string', 'example' => '232432'], + ], ], ], - 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ApproveSuccess\\": true,\\n \\"RequestId\\": \\"0bc1ec92159376****\\"\\n}","errorExample":""},{"type":"xml","example":"0bc1ec92159376****\\ntrue","errorExample":""}]', - 'title' => 'ApprovePermissionApplyOrder', - 'summary' => 'Processes a permission request order.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'RevokeTablePermission' => [ - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"abdsfewe\\",\\n \\"Data\\": {\\n \\"TestId\\": \\"232432\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n abdsfewe\\n \\n 232432\\n \\n","errorExample":""}]', + 'title' => 'TestDataServiceApi', + 'summary' => 'Tests a DataService Studio API in asynchronous mode. You can call the GetDataServiceApiTest operation to query the test result.', + 'changeSet' => [ + ['createdAt' => '2022-05-30T02:35:45.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'TestNetworkConnection' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - ], - 'operationType' => 'readAndWrite', - 'systemTags' => [], - 'parameters' => [ [ - 'name' => 'WorkspaceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the DataWorks workspace with which the MaxCompute project is associated. You can log on to the DataWorks console and go to the Workspace page to obtain the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9999999', - 'minimum' => '1', - 'example' => '12345', - ], + 'APP' => [], ], [ - 'name' => 'MaxComputeProjectName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the MaxCompute project to which the table belongs. You can log on to the DataWorks console and go to the SettingCenter page to obtain the name of the MaxCompute project that you associate with the workspace.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'aMaxcomputeProjectName', - ], + 'PrivateKey' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '78363', + 'abilityTreeNodes' => ['FEATUREdideRWC5F7'], + ], + 'parameters' => [ [ - 'name' => 'TableName', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the MaxCompute table. You can call the [SearchMetaTables](~~173919~~) operation to query the name of the MaxCompute table.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'aTableName', - ], + 'schema' => ['description' => 'The ID of the DataWorks workspace to which the data source belongs. You can call the [ListProjects](~~178393~~) operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '10000000000', 'minimum' => '1', 'example' => '100001', 'title' => ''], ], [ - 'name' => 'Actions', + 'name' => 'DatasourceName', 'in' => 'query', - 'schema' => [ - 'description' => 'The permissions that you want to revoke. Separate multiple permissions with commas (,). You can revoke only the SELECT, DESCRIBE, and DOWNLOAD permissions on MaxCompute tables.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Select,Describe', - ], + 'schema' => ['description' => 'The name of the data source.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mysql_name', 'title' => ''], ], [ - 'name' => 'RevokeUserName', + 'name' => 'EnvType', 'in' => 'query', - 'schema' => [ - 'description' => 'The Alibaba Cloud account from which you want to revoke permissions. Specify this parameter in the format that is the same as the format of the account used to access the MaxCompute project.'."\n" - ."\n" - .'* If the account is an Alibaba Cloud account, the value is in the ALIYUN$+Account name format.'."\n" - .'* If the account is a RAM user, the value is in the RAM$+Account name format.'."\n" - ."\n" - .'You must specify either this parameter or the RevokeUserId parameter. If you specify both this parameter and the RevokeUserId parameter and the parameter values are different, the value of the RevokeUserId parameter prevails.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'RAM$dataworks_3h1_1:stsramuser', - ], + 'schema' => ['description' => 'The environment in which the data source resides. Valid values:'."\n" + ."\n" + .'* 0: development environment'."\n" + .'* 1: production environment'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'RevokeUserId', + 'name' => 'ResourceGroup', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the Alibaba Cloud account from which you want to revoke permissions. You can log on to the DataWorks console and go to the Security Settings page to obtain the ID. You must specify either this parameter or the RevokeUserName parameter. If you specify both this parameter and the RevokeUserName parameter and the parameter values are different, the value of this parameter prevails.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '267842600408993176', - ], + 'schema' => ['description' => 'The identifier of the resource group. You can call the [ListResourceGroups](~~173913~~) operation to query the identifier of the resource group.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'S_res_group_2XXXX4_1619100XXXXX', 'title' => ''], ], ], 'responses' => [ @@ -58545,38 +36457,69 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RevokeSuccess' => [ - 'description' => 'Indicates whether the permissions are revoked.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0bc1ec92159376****', + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", 'type' => 'string', 'example' => '0000-ABCD-EFG ', 'title' => ''], + 'TaskList' => [ + 'description' => 'The information about the connectivity test.'."\n", + 'type' => 'object', + 'properties' => [ + 'ConnectMessage' => ['description' => 'The reason why the data source and resource group failed the connectivity test. If data source and the resource group passed the connectivity test, this parameter is left empty.'."\n", 'type' => 'string', 'example' => 'Connectable', 'title' => ''], + 'ConnectStatus' => ['description' => 'The result of the connectivity test. Valid values:'."\n" + ."\n" + .'* true: The data source and the resource group passed the connectivity test.'."\n" + .'* false: The data source and the resource group failed the connectivity test. You can troubleshoot issues based on the ConnectMessage parameter.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RevokeSuccess\\": true,\\n \\"RequestId\\": \\"0bc1ec92159376****\\"\\n}","errorExample":""},{"type":"xml","example":"true\\n0bc1ec92159376****","errorExample":""}]', - 'title' => 'RevokeTablePermission', - 'summary' => 'Revokes permissions on a table from a user.', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Invalid.DI.Parameter', 'errorMessage' => 'The parameter is invalid.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'Forbidden.DI.NoPrivilege', 'errorMessage' => 'No access.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.DI.Parameter', 'errorMessage' => 'A DI internal error occurred.', 'description' => ''], + ], + ], + 'title' => 'TestNetworkConnection', + 'summary' => 'Tests the network connectivity between a data source and a resource group.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListExtensions' => [ - 'summary' => 'Queries a list of extensions.', - 'methods' => [ - 'get', - 'post', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0000-ABCD-EFG\\\\t\\",\\n \\"TaskList\\": {\\n \\"ConnectMessage\\": \\"Connectable\\",\\n \\"ConnectStatus\\": true\\n }\\n}","type":"json"}]', + ], + 'TopTenElapsedTimeInstance' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -58586,141 +36529,95 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', + 'abilityTreeCode' => '78364', + 'abilityTreeNodes' => ['FEATUREdideXLVI81'], ], 'parameters' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '99999999999', 'minimum' => '2', 'example' => '1000001', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG', - ], - 'PagingInfo' => [ - 'description' => 'The pagination information.'."\n", + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '6347364dadsfadf****', 'title' => ''], + 'InstanceConsumeTimeRank' => [ + 'description' => 'The ranking record of the running durations of the instances.'."\n", 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '12', - ], - 'Extensions' => [ - 'description' => 'The list of extensions.'."\n", + 'UpdateTime' => ['description' => 'The timestamp at which the ranking of the running durations of the instances was updated.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1600963200000', 'title' => ''], + 'ConsumeTimeRank' => [ + 'description' => 'The ranking data of the running durations of the instances.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'The extensions.'."\n", + 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The state of the extension. Valid values: 0: Testing 1: Publishing 3: Disabled 4: Processing 5: Approved 6: Approve Failed'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ExtensionDesc' => [ - 'description' => 'The description of the extension.'."\n", - 'type' => 'string', - 'example' => 'This is a description', - ], - 'ExtensionName' => [ - 'description' => 'The name of the extension.'."\n", - 'type' => 'string', - 'example' => 'Extension name', - ], - 'Owner' => [ - 'description' => 'The ID of the RAM user.'."\n", - 'type' => 'string', - 'example' => '2003****', - ], - 'ExtensionCode' => [ - 'description' => 'The unique code of the extension.'."\n", - 'type' => 'string', - 'example' => 'Extension Code', - ], - 'BindEventList' => [ - 'description' => 'The list of extension point events.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The extension point event.'."\n", - 'type' => 'object', - 'properties' => [ - 'EventName' => [ - 'description' => 'The name of the event.'."\n", - 'type' => 'string', - 'example' => 'File submission pre-event', - ], - 'EventCode' => [ - 'description' => 'The code of the event.'."\n", - 'type' => 'string', - 'example' => 'commit-file', - ], - ], - ], - ], - ], + 'Owner' => ['description' => 'The ID of the Alibaba Cloud account used by the node owner.'."\n", 'type' => 'string', 'example' => '952795279527', 'title' => ''], + 'NodeName' => ['description' => 'The name of the node.'."\n", 'type' => 'string', 'example' => 'Node name', 'title' => ''], + 'BusinessDate' => ['description' => 'The data timestamp of the instance.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1600963200000', 'title' => ''], + 'ProgramType' => ['description' => 'The type of the node. Valid values: 6 (Shell), 10 (ODPS SQL), 11 (ODPS MR), 23 (Data Integration), 24 (ODPS Script), 99 (zero load), 221 (PyODPS 2), 225 (ODPS Spark), 227 (EMR Hive), 228 (EMR Spark), 229 (EMR Spark SQL), 230 (EMR MR), 239 (OSS object inspection), 257 (EMR Shell), 258 (EMR Spark Shell), 259 (EMR Presto), 260 (EMR Impala), 900 (real-time synchronization), 1089 (cross-tenant collaboration), 1091 (Hologres development), 1093 (Hologres SQL), 1100 (assignment), and 1221 (PyODPS 3)'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'InstanceId' => ['description' => 'The instance ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '95279527', 'title' => ''], + 'NodeId' => ['description' => 'The node ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '9527', 'title' => ''], + 'Consumed' => ['description' => 'The run time length of the instance. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0000-ABCD-****\\",\\n \\"PagingInfo\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 12,\\n \\"Extensions\\": [\\n {\\n \\"Status\\": 0,\\n \\"ExtensionDesc\\": \\"This is a description\\",\\n \\"ExtensionName\\": \\"Extension name\\",\\n \\"Owner\\": \\"2003****\\",\\n \\"ExtensionCode\\": \\"Extension Code\\",\\n \\"BindEventList\\": [\\n {\\n \\"EventName\\": \\"File submission pre-event\\",\\n \\"EventCode\\": \\"commit-file\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 0000-ABCD-EFG\\n \\n 1\\n 10\\n 12\\n \\n 0\\n 这是一个描述\\n 扩展程序名称\\n 2003****\\n 扩展程序码\\n \\n 文件提交前置事件\\n commit-file\\n \\n \\n \\n","errorExample":""}]', - 'title' => 'ListExtensions', - ], - 'GetExtension' => [ - 'summary' => 'Queries the details of an extension.', - 'methods' => [ - 'get', - 'post', + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'ResourceNotAuthorized.Api', 'errorMessage' => 'You are not authorized to access the resources.', 'description' => ''], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Resource', 'errorMessage' => 'You have reached the limit for the resource. Please contact us by submitting a ticket.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'Forbidden.Not.Server', 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.', 'description' => ''], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'Forbidden.Wkbench.ProjectNoPermission', 'errorMessage' => 'You are not authorized to access the workspace.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6347364dadsfadf****\\",\\n \\"InstanceConsumeTimeRank\\": {\\n \\"UpdateTime\\": 1600963200000,\\n \\"ConsumeTimeRank\\": [\\n {\\n \\"Owner\\": \\"952795279527\\",\\n \\"NodeName\\": \\"Node name\\",\\n \\"BusinessDate\\": 1600963200000,\\n \\"ProgramType\\": 10,\\n \\"InstanceId\\": 95279527,\\n \\"NodeId\\": 9527,\\n \\"Consumed\\": 1000\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'TopTenElapsedTimeInstance', + 'summary' => 'Queries the ranking of the running durations of instances.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '99', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TopTenElapsedTimeInstance'], + ], ], + 'ramActions' => [], + ], + 'TopTenErrorTimesInstance' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -58729,1296 +36626,1419 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdideZKHMWN', - ], - ], - 'parameters' => [ - [ - 'name' => 'ExtensionCode', - 'in' => 'query', - 'schema' => [ - 'description' => 'The unique code of the extension.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ce4*********086da5', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The returned result.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID. You can use the request ID to query logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG', - ], - 'Extension' => [ - 'description' => 'The details of the extension.'."\n", - 'type' => 'object', - 'properties' => [ - 'ExtensionCode' => [ - 'description' => 'The unique code of the extension.'."\n", - 'type' => 'string', - 'example' => 'ce4*********086da5', - ], - 'ExtensionName' => [ - 'description' => 'The name of the extension.'."\n", - 'type' => 'string', - 'example' => 'Extension name', - ], - 'ExtensionDesc' => [ - 'description' => 'The description of the extension.'."\n", - 'type' => 'string', - 'example' => 'This is a description', - ], - 'HelpDocUrl' => [ - 'description' => 'The URL of the help documentation of the extension.'."\n", - 'type' => 'string', - 'example' => 'https://www.aliyun.com/', - ], - 'Status' => [ - 'description' => 'The state of the extension. 0: Testing, 1: Publishing, 3: Disabled, 4: Processing, 5: Approved, 6: Approve Failed'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ProjectTesting' => [ - 'description' => 'The workspace for testing. If the extension is being tested, the extension can be used only in the workspace for testing.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '13552', - ], - 'DetailUrl' => [ - 'description' => 'The URL of the extension details page, on which users can view the details of the process blocked by the extension.'."\n", - 'type' => 'string', - 'example' => 'https://www.aliyun.com/', - ], - 'ParameterSetting' => [ - 'description' => 'The parameter settings of the extension. For more information, see [Configure extension parameters](~~405354~~).'."\n", - 'type' => 'string', - 'example' => 'extension.project.disabled=projectId1,projectId2,projectId3', - ], - 'OptionSetting' => [ - 'description' => 'The options defined for the extension.'."\n", - 'type' => 'string', - 'example' => 'Option configuration', - ], - 'BindEventList' => [ - 'description' => 'The list of extension points.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The details of the extension point.'."\n", - 'type' => 'object', - 'properties' => [ - 'EventCode' => [ - 'description' => 'The code of the extension point event.'."\n", - 'type' => 'string', - 'example' => 'commit-file', - ], - 'EventName' => [ - 'description' => 'The name of the extension point event.'."\n", - 'type' => 'string', - 'example' => 'File submission pre-event', - ], - ], - ], - ], - 'EventCategoryList' => [ - 'description' => 'The list of event types.'."\n", + 'operationType' => 'get', + 'abilityTreeCode' => '78365', + 'abilityTreeNodes' => ['FEATUREdideXLVI81'], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The DataWorks workspace ID. You can log on to the DataWorks console and go to the Workspace page to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '99999999999', 'minimum' => '2', 'example' => '10000001', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '952795279527****', 'title' => ''], + 'InstanceErrorRank' => [ + 'description' => 'The ranking data of nodes on which errors occurred.'."\n", + 'type' => 'object', + 'properties' => [ + 'UpdateTime' => ['description' => 'The timestamp at which the rankings were updated.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1600963200000', 'title' => ''], + 'ErrorRank' => [ + 'description' => 'The ranking data of nodes on which errors occurred within the last month.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'The details of the event type.'."\n", + 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ - 'CategoryCode' => [ - 'description' => 'The code of the event type.'."\n", - 'type' => 'string', - 'example' => 'file-change', - ], - 'CategoryName' => [ - 'description' => 'The name of the event type.'."\n", - 'type' => 'string', - 'example' => 'File change event', - ], - ], + 'Owner' => ['description' => 'The ID of the Alibaba Cloud account used by the node owner.'."\n", 'type' => 'string', 'example' => '952795279527', 'title' => ''], + 'NodeName' => ['description' => 'The name of the node.'."\n", 'type' => 'string', 'example' => 'Node name', 'title' => ''], + 'ProjectId' => ['description' => 'The DataWorks workspace ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '9527', 'title' => ''], + 'ProgramType' => ['description' => 'The type of the node. Valid values: 6 (Shell), 10 (ODPS SQL), 11 (ODPS MR), 23 (Data Integration), 24 (ODPS Script), 99 (zero load), 221 (PyODPS 2), 225 (ODPS Spark), 227 (EMR Hive), 228 (EMR Spark), 229 (EMR Spark SQL), 230 (EMR MR), 239 (OSS object inspection), 257 (EMR Shell), 258 (EMR Spark Shell), 259 (EMR Presto), 260 (EMR Impala), 900 (real-time synchronization), 1089 (cross-tenant collaboration), 1091 (Hologres development), 1093 (Hologres SQL), 1100 (assignment), and 1221 (PyODPS 3)'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'NodeId' => ['description' => 'The node ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '9527', 'title' => ''], + 'Count' => ['description' => 'The number of errors that occurred on the node.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG\\",\\n \\"Extension\\": {\\n \\"ExtensionCode\\": \\"ce4*********086da5\\",\\n \\"ExtensionName\\": \\"Extension name\\",\\n \\"ExtensionDesc\\": \\"This is a description\\",\\n \\"HelpDocUrl\\": \\"https://www.aliyun.com/\\",\\n \\"Status\\": 0,\\n \\"ProjectTesting\\": 1355211,\\n \\"DetailUrl\\": \\"https://www.aliyun.com/\\",\\n \\"ParameterSetting\\": \\"extension.project.disabled=projectId1,projectId2,projectId3\\",\\n \\"OptionSetting\\": \\"Option configuration\\",\\n \\"BindEventList\\": [\\n {\\n \\"EventCode\\": \\"commit-file\\",\\n \\"EventName\\": \\"File submission pre-event\\\\n\\"\\n }\\n ],\\n \\"EventCategoryList\\": [\\n {\\n \\"CategoryCode\\": \\"file-change\\",\\n \\"CategoryName\\": \\"File change event\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 0000-ABCD-EFG\\n \\n ce4*********086da5\\n 扩展程序名称\\n 这是一个描述\\n https://www.aliyun.com/\\n 0\\n 13552\\n https://www.aliyun.com/\\n extension.project.disabled=projectId1,projectId2,projectId3\\n 选项配置\\n \\n commit-file\\n 文件提交前置事件\\n \\n \\n file-change\\n 文件变更事件\\n \\n \\n","errorExample":""}]', - 'title' => 'GetExtension', - ], - 'GetOptionValueForProject' => [ - 'summary' => 'Queries the option settings of an extension in a workspace.', - 'methods' => [ - 'post', + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'ResourceNotAuthorized.Api', 'errorMessage' => 'You are not authorized to access the resources.', 'description' => ''], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Resource', 'errorMessage' => 'You have reached the limit for the resource. Please contact us by submitting a ticket.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'Forbidden.Not.Server', 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.', 'description' => ''], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'Forbidden.Wkbench.ProjectNoPermission', 'errorMessage' => 'You are not authorized to access the workspace.', 'description' => ''], + ['errorCode' => 'Invalid.Wkbench.Parameter', 'errorMessage' => 'The specified parameters are invalid.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'TopTenErrorTimesInstance', + 'summary' => 'Queries the ranking of nodes on which errors occur within the previous month.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '99', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TopTenErrorTimesInstance'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"952795279527****\\",\\n \\"InstanceErrorRank\\": {\\n \\"UpdateTime\\": 1600963200000,\\n \\"ErrorRank\\": [\\n {\\n \\"Owner\\": \\"952795279527\\",\\n \\"NodeName\\": \\"Node name\\",\\n \\"ProjectId\\": 9527,\\n \\"ProgramType\\": 10,\\n \\"NodeId\\": 9527,\\n \\"Count\\": 5\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'UpdateBaseline' => [ + 'summary' => 'Updates a baseline.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', + 'abilityTreeCode' => '158726', + 'abilityTreeNodes' => ['FEATUREdideSFSFU4'], ], 'parameters' => [ [ - 'name' => 'ExtensionCode', + 'name' => 'BaselineId', + 'in' => 'formData', + 'schema' => ['description' => 'The baseline ID. You can call the [ListBaselines](~~2261507~~) operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1000010800007', 'title' => ''], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The workspace ID. You can call the [ListBaselines](~~2261507~~) operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '2043', 'title' => ''], + ], + [ + 'name' => 'BaselineName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the baseline.'."\n", 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'BaselineName'], + ], + [ + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the Alibaba Cloud account used by the baseline owner.'."\n", 'type' => 'string', 'title' => '', 'required' => false, 'example' => '3726346****'], + ], + [ + 'name' => 'Priority', + 'in' => 'formData', + 'schema' => ['description' => 'The priority of the baseline. Valid values: {1,3,5,7,8}.'."\n", 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '7'], + ], + [ + 'name' => 'NodeIds', + 'in' => 'formData', + 'schema' => ['description' => 'The ancestor nodes of nodes in the baseline. Separate the ancestor nodes with commas (,). If a large number of ancestor nodes exist, we recommend that you create a zero load node and configure the zero load node as the descendant node of nodes in the baseline to facilitate node management.'."\n", 'type' => 'string', 'required' => false, 'example' => '1,2,3', 'title' => ''], + ], + [ + 'name' => 'OvertimeSettings', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The unique code of the extension.'."\n", - 'type' => 'string', + 'title' => '', + 'description' => 'The settings of the committed completion time of the baseline.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The cycle.'."\n", + 'type' => 'object', + 'properties' => [ + 'Cycle' => ['description' => 'The cycle that corresponds to the committed completion time. For a day-level baseline, set this parameter to 1. For an hour-level baseline, set this parameter to a value that is no more than 24.'."\n", 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1'], + 'Time' => ['description' => 'The committed completion time in the hh:mm format. Valid values of hh: \\[0,47]. Valid values of mm: \\[0,59].'."\n", 'type' => 'string', 'title' => '', 'required' => false, 'example' => '00:00'], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'ce4*********086da5', + 'maxItems' => 144, + 'example' => '', ], ], [ - 'name' => 'ProjectId', + 'name' => 'AlertMarginThreshold', + 'in' => 'formData', + 'schema' => ['description' => 'The alert margin threshold of the baseline. Unit: minutes.'."\n", 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '30'], + ], + [ + 'name' => 'BaselineType', + 'in' => 'formData', + 'schema' => ['description' => 'The type of the baseline. Valid values: DAILY and HOURLY.'."\n", 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'DAILY'], + ], + [ + 'name' => 'Enabled', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to enable the baseline. Valid values: true and false.'."\n", 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'AlertEnabled', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to enable the alerting feature. Valid values: true and false.'."\n", 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'AlertSettings', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'string', + 'title' => '', + 'description' => 'The alert settings of the baseline.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The alert setting of the baseline.'."\n", + 'type' => 'object', + 'properties' => [ + 'AlertType' => ['description' => 'The type of the alert. Valid values: BASELINE and TOPIC. The value BASELINE indicates a baseline alert. The value TOPIC indicates an event alert.'."\n", 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'BASELINE'], + 'AlertMethods' => [ + 'title' => '', + 'description' => 'The alert notification methods. Valid values: MAIL, SMS, PHONE, DINGROBOTS, and Webhooks. The value MAIL indicates that alert notifications are sent by email. The value SMS indicates that alert notifications are sent by text message. The value PHONE indicates that alert notifications are sent by phone call. You can use this notification method only in DataWorks Professional Edition or a more advanced edition. The value DINGROBOTS indicates that alert notifications are sent by using a DingTalk chatbot. You can use this notification method only if the RobotUrls parameter is configured. The value Webhooks indicates that alert notifications are sent by WeCom or Lark. You can use this notification method only if the Webhooks parameter is configured.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The alert notification method.'."\n", 'type' => 'string', 'required' => false, 'example' => 'SMS', 'title' => ''], + 'required' => false, + 'example' => '', + ], + 'SilenceStartTime' => ['description' => 'The start time of silence.'."\n", 'type' => 'string', 'title' => '', 'required' => false, 'example' => '00:00:00'], + 'SilenceEndTime' => ['description' => 'The end time of silence.'."\n", 'type' => 'string', 'title' => '', 'required' => false, 'example' => '00:00:00'], + 'AlertInterval' => ['description' => 'The interval at which an event alert notification is sent. Unit: minutes. Minimum value: 5. Maximum value: 1,440.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '1440', 'minimum' => '5', 'title' => '', 'example' => '1800'], + 'AlertMaximum' => ['description' => 'The maximum number of times an event alert notification is sent. Maximum value: 24.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '288', 'minimum' => '1', 'title' => '', 'example' => '1'], + 'DingRobots' => [ + 'title' => '', + 'description' => 'The DingTalk chatbots.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The configuration of the DingTalk chatbot.'."\n", + 'type' => 'object', + 'properties' => [ + 'WebUrl' => ['description' => 'The webhook URL of the DingTalk chatbot.'."\n", 'type' => 'string', 'required' => false, 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=xxx ', 'title' => ''], + 'AtAll' => ['description' => 'Specifies whether to remind all members by using the at sign (@). Valid values: true and false.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 10, + 'example' => '', + ], + 'Webhooks' => [ + 'title' => '', + 'description' => 'The webhook URLs.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The webhook URL of the WeCom or Lark chatbot. You can specify multiple webhook URLs. Separate multiple webhook URLs with commas (,). You must specify WEBHOOKS for AlertMethods. If this parameter is set to undefined, the specified webhook URLs are cleared.'."\n" + ."\n" + .'Only DataWorks Enterprise Edition supports this parameter. The webhook URL-based alerting feature is supported in the following regions: China (Shanghai), China (Chengdu), China (Zhangjiakou), China (Beijing), China (Hangzhou), China (Shenzhen), China (Hong Kong), Germany (Frankfurt), and Singapore.'."\n", 'type' => 'string', 'required' => false, 'example' => 'https://open.feishu.cn/open-apis/bot/v2/hook/xxx ', 'title' => ''], + 'required' => false, + 'maxItems' => 10, + 'example' => '', + ], + 'TopicTypes' => [ + 'title' => '', + 'description' => 'The types of event alerts, which are event-specific configurations.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The type of the event. Valid values: SLOW and ERROR. The value SLOW indicates that the running duration of a specific node in the current scheduling cycle is significantly longer than the average running duration of the node in previous scheduling cycles. The value ERROR indicates that a specific node fails to run. You can specify multiple event types. Separate multiple event types with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => 'SLOW', 'title' => ''], + 'required' => false, + 'maxItems' => 10, + 'example' => '', + ], + 'BaselineAlertEnabled' => ['description' => 'Specifies whether to enable the baseline alerting feature. This feature is specific to baselines. Valid values: true and false.'."\n", 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'true'], + 'AlertRecipientType' => ['description' => 'The type of the alert recipient. Valid values: OWNER, OTHER, and SHIFT_SCHEDULE. The value OWNER indicates the node owner. The value OTHER indicates specified personnel. The value SHIFT_SCHEDULE indicates personnel in a shift schedule.'."\n", 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'OWNER'], + 'AlertRecipient' => ['description' => 'The details of the alert recipient. If you set AlertRecipientType to OWNER, leave this parameter empty. If you set AlertRecipientType to SHIFT_SCHEDULE, set this parameter to the name of the shift schedule. If you set AlertRecipientType to OTHER, set this parameter to the employee IDs of specified personnel.'."\n", 'type' => 'string', 'title' => '', 'required' => false, 'example' => '123123'], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => '234', + 'example' => '', ], ], + [ + 'name' => 'RemoveNodeIds', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the node that you want to disassociate from the baseline. You can specify multiple node IDs. Separate multiple node IDs with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => '123,456', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => 'OpenApiResultModel', 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'E6F0DBDD-5AD****', - ], - 'OptionValue' => [ - 'description' => 'The data returned In the example, cuNumber is a custom key.'."\n", - 'type' => 'string', - 'example' => '{"cuNumber":"0"}', - ], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '401', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The specified parameters are invalid.', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the baseline was updated.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '6E07E90B-D9BC-5D6B-896A-82BA41A34AE1', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"OptionValue\\": \\"{\\\\\\"cuNumber\\\\\\":\\\\\\"0\\\\\\"}\\"\\n}","errorExample":""},{"type":"xml","example":"\\n E6F0DBDD-5AD****\\n {\\"cuNumber\\":\\"0\\"}\\n","errorExample":""}]', - 'title' => 'GetOptionValueForProject', - ], - 'ListEnabledExtensionsForProject' => [ - 'summary' => 'Queries a list of built-in and custom extensions that are enabled in a workspace.', - 'methods' => [ - 'post', + 'title' => 'UpdateBaseline', + 'changeSet' => [ + ['createdAt' => '2023-01-05T02:14:03.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-12-02T06:25:11.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-11-16T09:08:31.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"401\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"6E07E90B-D9BC-5D6B-896A-82BA41A34AE1\\"\\n}","type":"json"}]', + ], + 'UpdateBusiness' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '158027', - 'abilityTreeNodes' => [ - 'FEATUREdideRWC5F7', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '78366', + 'abilityTreeNodes' => ['FEATUREdide8FM783'], ], 'parameters' => [ [ - 'name' => 'EventCode', + 'name' => 'ProjectId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The code of the extension point event.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'commit-file', - ], + 'schema' => ['description' => 'The ID of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Management page to obtain the workspace ID. You must configure either this parameter or the ProjectIdentifier parameter to determine the DataWorks workspace to which the operation is applied.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10000', 'title' => ''], ], [ - 'name' => 'ProjectId', + 'name' => 'ProjectIdentifier', 'in' => 'formData', - 'schema' => [ - 'description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console?spm=a2c4g.11186623.0.0.6b4d4941azHd2k) and go to the Workspace page to obtain the workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10000', - ], + 'schema' => ['description' => 'The name of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Management page to obtain the workspace name. You must configure either this parameter or ProjectId parameter to determine the DataWorks workspace to which the operation is applied.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dw_project', 'title' => ''], ], [ - 'name' => 'FileType', + 'name' => 'BusinessName', 'in' => 'formData', - 'schema' => [ - 'description' => 'The type of the code for the file.'."\n" - ."\n" - .'Valid values: 6 (Shell), 10 (ODPS SQL), 11 (ODPS MR), 24 (ODPS Script), 99 (zero load), 221 (PyODPS 2), 225 (ODPS Spark), 227 (EMR Hive), 228 (EMR Spark), 229 (EMR Spark SQL), 230 (EMR MR), 239 (OSS object inspection), 257 (EMR Shell), 258 (EMR Spark Shell), 259 (EMR Presto), 260 (EMR Impala), 900 (real-time synchronization), 1089 (cross-tenant collaboration), 1091 (Hologres development), 1093 (Hologres SQL), 1100 (assignment), and 1221 (PyODPS 3).'."\n" - ."\n" - .'You can call the [ListFileType](~~212428~~) operation to query the type of the code for the file.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The name of the workflow. You can call the [ListBusiness](~~173945~~) operation to obtain the workflow name.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'MyBusiness', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['description' => 'The description of the workflow.'."\n", 'type' => 'string', 'required' => false, 'example' => 'modified from my first business', 'title' => ''], + ], + [ + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => ['description' => 'The owner of the workflow. You can call the [ListBusiness](~~173945~~) operation to obtain the workflow owner.'."\n", 'type' => 'string', 'required' => false, 'example' => '348428****', 'title' => ''], + ], + [ + 'name' => 'BusinessId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the workflow. You can call the [ListBusiness](~~173945~~) operation to obtain the workflow ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '300000', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The returned result.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '4F2CA7ED-27E5-59EA-A8C4-F1F7A1FF0B22', - ], - 'Extensions' => [ - 'description' => 'The extensions.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The extensions.'."\n", - 'type' => 'object', - 'properties' => [ - 'ExtensionCode' => [ - 'description' => 'The unique code of the extension.'."\n", - 'type' => 'string', - 'example' => 'a94a8e23bc0b4dfab9a5e4d2f374d645', - ], - 'ExtensionName' => [ - 'description' => 'The name of the extension.'."\n", - 'type' => 'string', - 'example' => 'max_pt function is not allowed.', - ], - 'TenantId' => [ - 'description' => 'The tenant ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '529889518659842', - ], - 'CreateUser' => [ - 'description' => 'The creator of the extension.'."\n", - 'type' => 'string', - 'example' => '3444434343555', - ], - 'ModifyUser' => [ - 'description' => 'The modifier of the extension.'."\n", - 'type' => 'string', - 'example' => '34452335611988', - ], - 'ExtensionDesc' => [ - 'description' => 'The description of the extension.'."\n", - 'type' => 'string', - 'example' => 'ODPS SQL compatible Spark engine detection', - ], - 'Owner' => [ - 'description' => 'The owner ID.'."\n", - 'type' => 'string', - 'example' => '21323672*******55500', - ], - 'ParameterSetting' => [ - 'description' => 'The parameter settings of the extension. For more information, see [Configure extension parameters](~~405354~~).'."\n", - 'type' => 'string', - 'example' => 'extension.fileType.23.deploy-file.enabled=true', - ], - ], - ], - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'The connection does not exist.', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request. You can use the ID to troubleshoot issues.'."\n", 'type' => 'string', 'example' => '0000-ABCD-EFG****', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned.'."\n", 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4F2CA7ED-27E5-59EA-A8C4-F1F7A1FF0B22\\",\\n \\"Extensions\\": [\\n {\\n \\"ExtensionCode\\": \\"a94a8e23bc0b4dfab9a5e4d2f374d645\\",\\n \\"ExtensionName\\": \\"max_pt function is not allowed.\\",\\n \\"TenantId\\": 0,\\n \\"CreateUser\\": \\"3444434343555\\",\\n \\"ModifyUser\\": \\"34452335611988\\",\\n \\"ExtensionDesc\\": \\"ODPS SQL compatible Spark engine detection\\",\\n \\"Owner\\": \\"21323672*******55500\\",\\n \\"ParameterSetting\\": \\"extension.fileType.23.deploy-file.enabled=true\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n 4F2CA7ED-27E5-59EA-A8C4-F1F7A1FF0B22\\n \\n a94a8e23bc0b4dfab9a5e4d2f374d645\\n 不允许使用max_pt函数\\n 529889518659842\\n 3444434343555\\n 34452335611988\\n ODPS SQL兼容Spark引擎检测\\n 21323672*******55500\\n extension.fileType.23.deploy-file.enabled=true\\n 1660117173\\n 1569308162000\\n \\n","errorExample":""}]', - 'title' => 'ListEnabledExtensionsForProject', - 'description' => 'For information about codes of extension point events, see [Development references: Extension point event codes](~~463357~~).'."\n", - ], - 'CallbackExtension' => [ - 'summary' => 'Sends the processing result of an extension point event by an extension to DataWorks.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ], + ], + 'title' => 'UpdateBusiness', + 'summary' => 'Updates a workflow.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'UpdateClusterConfigs' => [ + 'summary' => 'Updates the submodule configurations of a cluster in a workspace. Currently, only Spark parameters are supported.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '191317', - 'abilityTreeNodes' => [ - 'FEATUREdideRWC5F7', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '231401', + 'abilityTreeNodes' => ['FEATUREdideDGBIGO'], ], 'parameters' => [ [ - 'name' => 'ExtensionCode', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The unique code of the extension.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '8abcb91f-d266-4073-b907-2ed670378ed1', - ], + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the cluster associated with DataWorks.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12345', 'title' => ''], ], [ - 'name' => 'MessageId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The message ID in DataWorks OpenEvent. You can obtain the ID from a received message when an extension point event is triggered.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '03400b03-b721-4c34-8727-2d6884077091', - ], + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '5678', 'title' => ''], ], [ - 'name' => 'CheckResult', - 'in' => 'formData', + 'name' => 'ConfigType', + 'in' => 'query', 'schema' => [ - 'description' => 'The check status of the extension point event. Valid values:'."\n" + 'description' => 'The configuration type of the cluster. Valid values:'."\n" ."\n" - .'* OK: The event passes the check.'."\n" - .'* FAIL: The event fails to pass the check. You must check and handle the reported error at the earliest opportunity to ensure that your program is run as expected.'."\n" - .'* WARN: The event passes the check, but an alert is reported.'."\n", + .'- SPARK\\_CONF: SPARK parameters', + 'enumValueTitles' => [], 'type' => 'string', 'required' => true, - 'example' => 'FAIL', - 'enum' => [ - 'OK', - 'FAIL', - 'WARN', - ], + 'example' => 'SPARK_CONF', + 'title' => '', ], ], [ - 'name' => 'CheckMessage', + 'name' => 'ConfigValues', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The check message of the extension point event. If CheckResult is set to FAIL, you must provide the failure cause.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'The xxx rule is hit. Modify it and try again.', + 'description' => 'The configuration information of the cluster submodule.', + 'type' => 'array', + 'items' => ['description' => 'The configuration information of the cluster in a module.', '$ref' => '#/components/schemas/ClusterConfig', 'required' => false, 'title' => '', 'example' => ''], + 'required' => true, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The data returned.'."\n", + 'title' => 'OpenApiMetaResultModel', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '7C352CB7-CD88-50CF-9D0D-E81BDF020E7F', + 'Data' => [ + 'description' => 'Indicates whether the update was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', + 'enumValueTitles' => [], + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', ], + 'RequestId' => ['description' => 'The ID of the request. It is used to locate logs and troubleshoot problems.', 'type' => 'string', 'example' => '0000-ABCD-E****', 'title' => ''], 'Success' => [ 'description' => 'Indicates whether the request was successful. Valid values:'."\n" ."\n" - .'true'."\n" + .'- true'."\n" ."\n" - .'false'."\n", - 'type' => 'string', + .'- false', + 'enumValueTitles' => [], + 'type' => 'boolean', 'example' => 'true', + 'title' => '', ], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '101011005', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'Invalid.Cluster.ClusterNotFound', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"0000-ABCD-E****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"101011005\\",\\n \\"ErrorMessage\\": \\"Invalid.Cluster.ClusterNotFound\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', + 'title' => 'UpdateClusterConfigs', + 'description' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"7C352CB7-CD88-50CF-9D0D-E81BDF020E7F\\",\\n \\"Success\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 7C352CB7-CD88-50CF-9D0D-E81BDF020E7F\\n true\\n","errorExample":""}]', - 'title' => 'CallbackExtension', + 'ramActions' => [], ], - 'ListCheckProcesses' => [ - 'summary' => 'Queries the check results of extension point events.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateConnection' => [ + 'methods' => ['put'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, + 'operationType' => 'write', + 'deprecated' => true, 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', + 'operationType' => 'update', + 'riskType' => 'high', 'chargeType' => 'free', - 'abilityTreeCode' => '240968', - 'abilityTreeNodes' => [ - 'FEATUREdide63BO88', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREdide7FTVFZ'], ], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the workspace.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123465', - ], - ], - [ - 'name' => 'EventCode', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Extension point event encoding.', - 'type' => 'string', - 'required' => true, - 'example' => 'commit-file', - ], - ], - [ - 'name' => 'Operator', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The operator ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123333232', - ], + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The description of the data source.'."\n", 'type' => 'string', 'required' => false, 'example' => 'abc'], ], [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '10', - 'example' => '10', - 'default' => '10', - ], + 'name' => 'EnvType', + 'in' => 'query', + 'schema' => ['description' => 'The environment in which the data source is used. Valid values: 0 and 1. The value 0 indicates the development environment. The value 1 indicates the production environment.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '1'], ], [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + 'name' => 'Content', + 'in' => 'query', + 'schema' => ['description' => 'The details of the data source. Examples of details of some common data sources:'."\n" + ."\n" + .'* odps'."\n" + ."\n" + .''."\n" + ."\n" + .' {'."\n" + .' "accessId": "xssssss",'."\n" + .' "accessKey": "xsaxsaxsa",'."\n" + .' "authType": 2,'."\n" + .' "endpoint": "http://service.odps.aliyun.com/api",'."\n" + .' "project": "xsaxsax",'."\n" + .' "tag": "public"'."\n" + .' }'."\n" + ."\n" + .'* mysql'."\n" + ."\n" + .''."\n" + ."\n" + .' {'."\n" + .' "database": "xsaxsa",'."\n" + .' "instanceName": "rm-xsaxsa",'."\n" + .' "password": "xsaxsa",'."\n" + .' "rdsOwnerId": "xasxsa",'."\n" + .' "regionId": "cn-shanghai",'."\n" + .' "tag": "rds",'."\n" + .' "username": "xsaxsa"'."\n" + .' }'."\n" + ."\n" + .'* rds'."\n" + ."\n" + .''."\n" + ."\n" + .' {'."\n" + .' "configType": 1,'."\n" + .' "tag": "rds",'."\n" + .' "database": "xsaxsa",'."\n" + .' "username": "xsaxsa",'."\n" + .' "password": "xssaxsa$32050",'."\n" + .' "instanceName": "rm-xsaxs",'."\n" + .' "rdsOwnerId": "11111111"'."\n" + .' }'."\n" + ."\n" + .'* oss'."\n" + ."\n" + .''."\n" + ."\n" + .' {'."\n" + .' "accessId": "sssssxx",'."\n" + .' "accessKey": "xsaxaxsaxs",'."\n" + .' "bucket": "xsa-xs-xs",'."\n" + .' "endpoint": "http://oss-cn-shanghai.aliyuncs.com",'."\n" + .' "tag": "public"'."\n" + .' }'."\n" + ."\n" + .'* sqlserver'."\n" + ."\n" + .''."\n" + ."\n" + .' {'."\n" + .' "jdbcUrl": "jdbc:sqlserver://xsaxsa-xsaxsa.database.xxx.cn:123;DatabaseName=xsxs-xsxs",'."\n" + .' "password": "sdasda$fs",'."\n" + .' "tag": "public",'."\n" + .' "username": "sxaxacdacdd"'."\n" + .' }'."\n" + ."\n" + .'* polardb'."\n" + ."\n" + .''."\n" + ."\n" + .' {'."\n" + .' "clusterId": "pc-sdadsadsa",'."\n" + .' "database": "dsadsadsa",'."\n" + .' "ownerId": "121212122",'."\n" + .' "password": "sdasdafssa",'."\n" + .' "region": "cn-shanghai",'."\n" + .' "tag": "polardb",'."\n" + .' "username": "asdadsads"'."\n" + .' }'."\n" + ."\n" + .'* oracle'."\n" + ."\n" + .''."\n" + ."\n" + .' {'."\n" + .' "jdbcUrl": "jdbc:oracle:saaa:@xxxxx:1521:PROD",'."\n" + .' "password": "sxasaxsa",'."\n" + .' "tag": "public",'."\n" + .' "username": "sasfadfa"'."\n" + .' }'."\n" + ."\n" + .'* mongodb'."\n" + ."\n" + .''."\n" + ."\n" + .' {'."\n" + .' "address": "[\\"xsaxxsa.mongodb.rds.aliyuncs.com:3717\\"]",'."\n" + .' "database": "admin",'."\n" + .' "password": "sadsda@",'."\n" + .' "tag": "public",'."\n" + .' "username": "dsadsadas"'."\n" + .' }'."\n" + ."\n" + .'* emr'."\n" + ."\n" + .''."\n" + ."\n" + .' {'."\n" + .' "accessId": "xsaxsa",'."\n" + .' "emrClusterId": "C-dsads",'."\n" + .' "emrResourceQueueName": "default",'."\n" + .' "emrEndpoint": "emr.aliyuncs.com",'."\n" + .' "accessKey": "dsadsad",'."\n" + .' "emrUserId": "224833315798889783",'."\n" + .' "name": "sasdsadsa",'."\n" + .' "emrAccessMode": "simple",'."\n" + .' "region": "cn-shanghai",'."\n" + .' "authType": "2",'."\n" + .' "emrProjectId": "FP-sdadsad"'."\n" + .' }'."\n" + ."\n" + .'* postgresql'."\n" + ."\n" + .''."\n" + ."\n" + .' {'."\n" + .' "jdbcUrl": "jdbc:postgresql://xxxx:1921/ssss",'."\n" + .' "password": "sdadsads",'."\n" + .' "tag": "public",'."\n" + .' "username": "sdsasda"'."\n" + .' }'."\n" + ."\n" + .'* analyticdb_for_mysql'."\n" + ."\n" + .''."\n" + ."\n" + .' {'."\n" + .' "instanceId": "am-sadsada",'."\n" + .' "database": "xsxsx",'."\n" + .' "username": "xsxsa",'."\n" + .' "password": "asdadsa",'."\n" + .' "connectionString": "am-xssxsxs.ads.aliyuncs.com:3306"'."\n" + .' }'."\n" + ."\n" + .'* hybriddb_for_postgresql'."\n" + ."\n" + .''."\n" + ."\n" + .' {'."\n" + .' "connectionString": "gp-xsaxsaxa-master.gpdbmaster.rds.aliyuncs.com",'."\n" + .' "database": "xsaxsaxas",'."\n" + .' "password": "xsaxsaxsa@11",'."\n" + .' "instanceId": "gp-xsaxsaxsa",'."\n" + .' "port": "541132",'."\n" + .' "ownerId": "xsaxsaxsas",'."\n" + .' "username": "sadsad"'."\n" + .' }'."\n" + ."\n" + .'* holo'."\n" + ."\n" + .''."\n" + ."\n" + .' {'."\n" + .' "accessId": "xsaxsaxs",'."\n" + .' "accessKey": "xsaxsaxsa",'."\n" + .' "database": "xsaxsaxsa",'."\n" + .' "instanceId": "xsaxa",'."\n" + .' "tag": "aliyun"'."\n" + .' }'."\n" + ."\n" + .'* kafka'."\n" + ."\n" + .''."\n" + ."\n" + .' {'."\n" + .' "instanceId": "xsax-cn-xsaxsa",'."\n" + .' "regionId": "cn-shanghai",'."\n" + .' "tag": "aliyun",'."\n" + .' "ownerId": "1212121212112"'."\n" + .' }'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '{"database":"dbname","instanceName":"instancename","password":"password","rdsOwnerId":"123","username":"username"}'], ], [ 'name' => 'Status', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The check status of the extension. Valid values:'."\n" - ."\n" - .'* CHECKING'."\n" - .'* PASSED'."\n" - .'* BLOCKED'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'True', - 'enum' => [ - 'CHECKING', - 'PASSED', - 'BLOCKED', - ], - ], + 'in' => 'query', + 'schema' => ['description' => 'The status of the data source. Valid values: ENABLED and DISABLED. The value ENABLED indicates that the data source is in the normal state. The value DISABLED indicates that the data source is in an abnormal state.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ENABLED'], ], [ - 'name' => 'MessageId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The message ID in DataWorks OpenEvent. You can obtain the ID from a received message when an extension point event is triggered.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '03400b03-b721-4c34-8727-2****1', - ], + 'name' => 'ConnectionId', + 'in' => 'query', + 'schema' => ['description' => 'The data source ID. You can call the [ListConnections](~~173911~~) operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => '0000-ABCD-EF****', - ], - 'PagingInfo' => [ - 'description' => 'The pagination information.'."\n", - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries displayed on each page.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '12', - ], - 'CheckProcesses' => [ - 'description' => 'The check details of the extension.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ProjectId' => [ - 'description' => 'The ID of the DataWorks workspace.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '32563', - ], - 'Status' => [ - 'description' => 'The status of the extender check.'."\n" - .'- CHECKING CHECKING'."\n" - .'- PASSED the pass check'."\n" - .'- BLOCKED check failed', - 'type' => 'string', - 'example' => 'CHECKING', - ], - 'EventCode' => [ - 'description' => 'Extension point event encoding.', - 'type' => 'string', - 'example' => 'commit-file', - ], - 'EventName' => [ - 'description' => 'The name of the extension point event.', - 'type' => 'string', - 'example' => 'DnsEvent', - ], - 'EventNameEn' => [ - 'description' => 'The English name of the event.', - 'type' => 'string', - 'example' => 'Pre-event for Node Commit', - ], - 'ProcessName' => [ - 'description' => 'The name of the check object, such as the file name or node name.'."\n", - 'type' => 'string', - 'example' => 'odps_sql_test', - ], - 'MessageId' => [ - 'description' => 'DataWorks the message ID of the open message. After an extended point event is triggered, you can obtain the message ID from the received event message.', - 'type' => 'string', - 'example' => 'b824a5de-4223-4315-af3e-c4449d236db4', - ], - 'ProcessId' => [ - 'description' => 'The ID of the process instance.', - 'type' => 'string', - 'example' => 'rdk_generate_d395da25-b0d3-4114-b2a5-d0247444a661_none_3496903_365203', - ], - 'Operator' => [ - 'description' => 'The operator ID.'."\n", - 'type' => 'string', - 'example' => '297635', - ], - ], - 'description' => '', - ], - ], - ], - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'string', 'example' => '200'], + 'Data' => ['description' => 'Indicates whether the data source is updated.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0bc14115159376359****'], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true'], ], + 'description' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Invalid.Tenant.ConnectionNotExists', 'errorMessage' => 'The connection does not exist.', 'description' => 'The connection does not exist.'], + ['errorCode' => 'Invalid.Tenant.ProjectNotExists', 'errorMessage' => 'The project does not exist.', 'description' => 'The project does not exist.'], + ['errorCode' => 'Invalid.Tenant.UserNotInProject', 'errorMessage' => 'The user is not in the project.', 'description' => 'The user is not in the project.'], + ['errorCode' => 'Invalid.DataSource.DataSourceStatus', 'errorMessage' => 'The specified dataSourceStatus %s is invalid.', 'description' => 'The specify data source status %s invalid.'], + ], + 403 => [ + ['errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin', 'errorMessage' => 'The user is not a project administrator or owner.', 'description' => 'The user is not a project administrator or owner.'], + ['errorCode' => 'Invalid.Tenant.UserNotInTenant', 'errorMessage' => 'The user is not in tenant.', 'description' => 'The user is not in tenant.'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EF****\\",\\n \\"PagingInfo\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 12,\\n \\"CheckProcesses\\": [\\n {\\n \\"ProjectId\\": 32563,\\n \\"Status\\": \\"CHECKING\\",\\n \\"EventCode\\": \\"commit-file\\",\\n \\"EventName\\": \\"DnsEvent\\",\\n \\"EventNameEn\\": \\"Pre-event for Node Commit\\",\\n \\"ProcessName\\": \\"odps_sql_test\\",\\n \\"MessageId\\": \\"b824a5de-4223-4315-af3e-c4449d236db4\\",\\n \\"ProcessId\\": \\"rdk_generate_d395da25-b0d3-4114-b2a5-d0247444a661_none_3496903_365203\\",\\n \\"Operator\\": \\"297635\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListCheckProcesses', - ], - 'UpdateTableAddColumn' => [ - 'summary' => 'Updates the fields in a MaxCompute table.', - 'methods' => [ - 'post', + 'staticInfo' => [ + 'substitutions' => ['dataworks-public::2020-05-18::UpdateDataSource'], ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'UpdateConnection', + 'summary' => 'Updates a data source.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'UpdateDIAlarmRule' => [ + 'summary' => 'Updates an alert rule for a synchronization task.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'deprecated' => true, + 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '78383', - 'abilityTreeNodes' => [ - 'FEATUREdideRZEBFC', - ], + 'abilityTreeCode' => '154892', + 'abilityTreeNodes' => ['FEATUREdide39WW3A'], ], 'parameters' => [ [ - 'name' => 'TableGuid', - 'in' => 'query', + 'name' => 'DIAlarmRuleId', + 'in' => 'formData', + 'schema' => ['description' => 'The alert rule ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '34982', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['description' => 'The description of the alert rule.', 'type' => 'string', 'required' => false, 'example' => 'mysql synchronizes to hologres heartbeat alert', 'title' => ''], + ], + [ + 'name' => 'MetricType', + 'in' => 'formData', 'schema' => [ - 'description' => 'The globally unique identifier (GUID) of the MaxCompute table. Specify the GUID in the odps.projectName.tableName format.'."\n", + 'description' => 'The metric type in the alert rule. Valid values:'."\n" + ."\n" + .'- Heartbeat'."\n" + ."\n" + .'- FailoverCount'."\n" + ."\n" + .'- Delay', + 'enumValueTitles' => [], 'type' => 'string', 'required' => true, - 'docRequired' => true, - 'example' => 'odps.engine_name.table_name', + 'example' => 'Heartbeat', + 'title' => '', ], ], [ - 'name' => 'Column', + 'name' => 'TriggerConditions', 'in' => 'formData', - 'style' => 'repeatList', + 'style' => 'json', 'schema' => [ - 'description' => 'The fields.'."\n", + 'description' => 'The conditions that are used to trigger the alert rule.', 'type' => 'array', 'items' => [ - 'description' => 'The field.'."\n", + 'description' => 'The condition that is used to trigger the alert rule.', 'type' => 'object', 'properties' => [ - 'ColumnNameCn' => [ - 'description' => 'The display name of the field.'."\n", + 'Severity' => [ + 'description' => 'The severity level. Valid values:'."\n" + ."\n" + .'- Warning'."\n" + ."\n" + .'- Critical', + 'enumValueTitles' => [], 'type' => 'string', 'required' => false, - 'example' => 'Chinese', - ], - 'ColumnName' => [ - 'description' => 'The name of the field.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'abc', + 'example' => 'Warning', + 'title' => '', ], - 'Comment' => [ - 'description' => 'The comment of the field.'."\n", - 'type' => 'string', + 'Duration' => ['description' => 'The time interval for alert calculation. Unit: minutes.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '15', 'title' => ''], + 'Threshold' => ['description' => 'The alert threshold.'."\n" + ."\n" + .'- If the alert rule is for task status, you do not need to specify a threshold.'."\n" + ."\n" + .'- If the alert rule is for failovers, you must specify the number of failovers.'."\n" + ."\n" + .'- If the alert rule is for latency, you must specify the latency duration, in seconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'NotificationSettings', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The alert notification settings.', + 'type' => 'object', + 'properties' => [ + 'NotificationChannels' => [ + 'description' => 'The alert notification methods.', + 'type' => 'array', + 'items' => [ + 'description' => 'The alert notification method.', + 'type' => 'object', + 'properties' => [ + 'Severity' => [ + 'description' => 'The severity level. Valid values:'."\n" + ."\n" + .'- Warning'."\n" + ."\n" + .'- Critical', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'example' => 'Warning', + 'title' => '', + ], + 'Channels' => [ + 'description' => 'The alert notification methods.', + 'type' => 'array', + 'items' => [ + 'description' => 'The alert notification method. Valid values:'."\n" + ."\n" + .'- Mail: email'."\n" + ."\n" + .'- Phone: phone call'."\n" + ."\n" + .'- Sms: text message'."\n" + ."\n" + .'- Ding: DingTalk chatbot token', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'example' => 'Ding', + 'title' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], 'required' => false, - 'example' => 'Remarks', + 'title' => '', + 'example' => '', ], - 'ColumnType' => [ - 'description' => 'The type of the field. For more information, see MaxCompute field types.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'string', + 'required' => true, + 'title' => '', + 'example' => '', + ], + 'NotificationReceivers' => [ + 'description' => 'The settings of alert notification recipients.', + 'type' => 'array', + 'items' => [ + 'description' => 'The setting of an alert notification recipient.', + 'type' => 'object', + 'properties' => [ + 'ReceiverType' => [ + 'description' => 'The recipient type.'."\n" + ."\n" + .'- If the alert notification method is Mail, Phone, or Sms, the recipient type is the Alibaba Cloud account ID.'."\n" + ."\n" + .'- If the alert notification method is Ding, the recipient type is the DingTalk chatbot token.', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'example' => 'DingToken', + 'title' => '', + ], + 'ReceiverValues' => [ + 'description' => 'The recipients.', + 'type' => 'array', + 'items' => ['description' => 'The recipient.'."\n" + ."\n" + .'- If the ReceiverType parameter is set to AliyunUid, set this parameter to the Alibaba Cloud account ID of a user.'."\n" + ."\n" + .'- If the ReceiverType parameter is set to DingToken, set this parameter to the token of a DingTalk chatbot.', 'type' => 'string', 'required' => false, 'example' => 'token1', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => true, + 'title' => '', + 'example' => '', ], - 'required' => false, + 'InhibitionInterval' => ['description' => 'The duration of the alert suppression interval. Default value: 5. Unit: minutes.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', 'title' => ''], ], 'required' => true, - 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'Enabled', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to enable the alert rule. By default, the alert rule is disabled.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'title' => 'Schema of Response', + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'abc', - ], - 'TaskInfo' => [ - 'description' => 'The information about the request task. After a request task is submitted, it is divided into multiple subtasks that are run in sequence. After the current subtask is complete, the next subtask starts to run. After all subtasks are complete, the request task is complete. If a request task is aborted due to one of the following issues, address the issue based on the error code and initiate the request task again:'."\n" - ."\n" - .'* The request task fails to be submitted.'."\n" - .'* After the request task is submitted, a subtask fails to run.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status of the current subtask. Valid values:'."\n" - ."\n" - .'* operating: The subtask is running.'."\n" - .'* success: The subtask succeeds.'."\n" - .'* failure: The subtask fails to run. For more information about the error details, see the Content parameter.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'NextTaskId' => [ - 'description' => 'The ID of the subtask that you want to run. If this parameter is left empty, all subtasks are complete.'."\n", - 'type' => 'string', - 'example' => 'abc1', - ], - 'TaskId' => [ - 'description' => 'The ID of the current subtask.'."\n", - 'type' => 'string', - 'example' => 'abc2', - ], - 'Content' => [ - 'description' => 'The details about the status of the current subtask.'."\n" - ."\n" - .'* If the current subtask is successful, success is returned.'."\n" - .'* If the current subtask fails, the error details are displayed.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'A6C6B486-E3A2-5D52-9E76-D9380485D946'], ], + 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], ], 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], ], ], - 'staticInfo' => [ - 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A6C6B486-E3A2-5D52-9E76-D9380485D946\\"\\n}","type":"json"}]', + 'title' => 'UpdateDIAlarmRule', + 'description' => 'Alert rules can be configured when your task includes real-time synchronization.'."\n" + .'The alert rule is updated as a full-field update. Partial field updates are not supported.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDIAlarmRule'], + ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"abc\\",\\n \\"TaskInfo\\": {\\n \\"Status\\": \\"success\\",\\n \\"NextTaskId\\": \\"abc1\\",\\n \\"TaskId\\": \\"abc2\\",\\n \\"Content\\": \\"success\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n \\n success\\n abc2\\n success\\n abc1\\n \\n abc\\n","errorExample":""}]', - 'title' => 'UpdateTableAddColumn', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'ramActions' => [], ], - 'GetMetaTableFullInfo' => [ - 'summary' => 'Queries the complete information about a table, including information about fields in the table.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateDIJob' => [ + 'summary' => 'Updates a new-version synchronization task. The following type of task is supported: real-time synchronization of all data in a MySQL database to Hologres.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => true, + 'operationType' => 'write', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '78264', - 'abilityTreeNodes' => [ - 'FEATUREdideRZEBFC', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '155160', + 'abilityTreeNodes' => ['FEATUREdideQHGTK4'], ], 'parameters' => [ [ - 'name' => 'TableGuid', - 'in' => 'query', - 'schema' => [ - 'description' => 'The unique identifier of the table. You can call the [GetMetaDBTableList](~~173916~~) operation to query the unique identifier of the table.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'odps.engine_name.table_name', - ], - ], - [ - 'name' => 'PageNum', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number requested for pagination.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'name' => 'DIJobId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the synchronization task.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '11588', 'title' => ''], ], [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of items per page, with a default of 10 and a maximum of 100.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['description' => 'The description of the synchronization task.'."\n", 'type' => 'string', 'example' => 'Synchronize MySQL to Hologres', 'required' => false, 'title' => ''], ], [ - 'name' => 'ClusterId', - 'in' => 'query', + 'name' => 'ResourceSettings', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The ID of the EMR cluster. This parameter is required only if you set the DataSourceType parameter to emr.'."\n" - ."\n" - .'You can log on to the [EMR console](https://emr.console.aliyun.com/?spm=a2c4g.11186623.0.0.965cc5c2GeiHet#/cn-hangzhou) to query the ID.'."\n", - 'type' => 'string', + 'description' => 'The resource settings.'."\n", + 'type' => 'object', + 'properties' => [ + 'OfflineResourceSettings' => [ + 'description' => 'The resource used for batch synchronization.'."\n", + 'type' => 'object', + 'properties' => [ + 'ResourceGroupIdentifier' => ['description' => 'The identifier of the resource group for Data Integration used for batch synchronization.'."\n", 'type' => 'string', 'required' => false, 'example' => 'S_res_group_111_222', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'RealtimeResourceSettings' => [ + 'description' => 'The resource used for real-time synchronization.'."\n", + 'type' => 'object', + 'properties' => [ + 'ResourceGroupIdentifier' => ['description' => 'The identifier of the resource group for Data Integration used for real-time synchronization.'."\n", 'type' => 'string', 'required' => false, 'example' => 'S_res_group_111_222', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'RequestedCu' => ['description' => 'The number of compute units (CUs) in the resource group that are used for full and incremental synchronization.'."\n", 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '2.0', 'title' => ''], + ], 'required' => false, - 'example' => 'C-010A704DA760****', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'DatabaseName', - 'in' => 'query', + 'name' => 'TransformationRules', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The name of the database. This parameter is required only if you set the DataSourceType parameter to emr.'."\n" - ."\n" - .'You can call the [ListMetaDB](~~185662~~) operation to query the database name.'."\n", - 'type' => 'string', + 'description' => 'The list of transformation rules that you want to apply to the synchronization objects selected from the source. Each entry in the list defines a transformation rule.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The transformation rule that you want to apply to the synchronization objects selected from the source.'."\n", + 'type' => 'object', + 'properties' => [ + 'RuleName' => ['description' => 'The name of the rule. If the values of the RuleActionType parameter and the RuleTargetType parameter are the same for multiple transformation rules, you must make sure that the transformation rule names are unique.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rename_rule_1', 'title' => ''], + 'RuleActionType' => [ + 'description' => 'The type of the action. Valid values:'."\n" + ."\n" + .'* DefinePrimaryKey'."\n" + .'* Rename'."\n" + .'* AddColumn'."\n" + .'* HandleDml'."\n" + .'* DefineIncrementalCondition'."\n" + .'* DefineCycleScheduleSettings'."\n" + .'* DefineRuntimeSettings'."\n" + .'* DefinePartitionKey'."\n", + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'example' => 'Rename', + 'title' => '', + ], + 'RuleTargetType' => [ + 'description' => 'The type of the object on which you want to perform the action. Valid values:'."\n" + ."\n" + .'* Table'."\n" + .'* Schema'."\n", + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'example' => 'Table', + 'title' => '', + ], + 'RuleExpression' => ['description' => 'The expression of the rule. The expression must be a JSON string.'."\n" + ."\n" + .'Example of a renaming rule: {"expression":"${srcDatasourceName}\\_${srcDatabaseName}\\_0922","variables":\\[{"variableName":"srcDatabaseName","variableRules":\\[{"from":"fromdb","to":"todb"}]}]}.'."\n" + ."\n" + .'expression: the expression of the renaming rule. The expression may contain the following variables: ${srcDatasourceName}, ${srcDatabaseName}, and ${srcTableName}. ${srcDatasourceName} specifies the name of the source. ${srcDatabaseName} specifies the name of a source database. ${srcTableName} specifies the name of a source table. variables: the generation rule for a variable used in the expression of the renaming rule. The default value of the specified variable is the original value of the object indicated by the variable. You can define a group of string replacement rules to change the original values based on your business requirements. variableName: the name of the variable. Do not enclose the variable name in ${}. variableRules: the string replacement rules for variables. The system runs the string replacement rules in sequence. from specifies the original string. to specifies the new string. Example of a rule used to add a specific field to the destination and assign a value to the field: {"columns":\\[{"columnName":"my_add_column","columnValueType":"Constant","columnValue":"123"}]}.'."\n" + ."\n" + .'If you do not configure such a rule, no fields are added to the destination and no values are assigned by default. columnName: the name of the field that you want to add. columnValueType: the value type of the field. Valid values: Constant and Variable. columnValue: the value of the field that you want to add. If you set the valueType parameter to Constant, set the columnValue parameter to a custom constant of the STRING type. If you set the valueType parameter to Variable, set the columnValue to a built-in variable. The following built-in variables are supported: EXECUTE_TIME (LONG data type), DB_NAME_SRC (STRING data type), DATASOURCE_NAME_SRC (STRING data type), TABLE_NAME_SRC (STRING data type), DB_NAME_DEST (STRING data type), DATASOURCE_NAME_DEST (STRING data type), TABLE_NAME_DEST (STRING data type), and DB_NAME_SRC_TRANSED (STRING data type). EXECUTE_TIME specifies the execution time. DB_NAME_SRC indicates the name of a source database. DATASOURCE_NAME_SRC specifies the name of the source. TABLE_NAME_SRC specifies the name of a source table. DB_NAME_DEST specifies the name of a destination database. DATASOURCE_NAME_DEST specifies the name of the destination. TABLE_NAME_DEST specifies the name of a destination table. DB_NAME_SRC_TRANSED specifies the database name obtained after a transformation. Example of a rule used to specify primary key fields for a destination table: {"columns":\\["ukcolumn1","ukcolumn2"]}.'."\n" + ."\n" + .'If you do not configure such a rule, the primary key fields in the mapped source table are used for the destination table by default. If the destination table is an existing table, Data Integration does not modify the schema of the destination table. If the specified primary key fields do not exist in the destination table, an error is reported when the synchronization task starts to run. If the destination table is automatically created by the system, Data Integration automatically creates the schema of the destination table. The schema contains the primary key fields that you specify. If the specified primary key fields do not exist in the destination table, an error is reported when the synchronization task starts to run. Example of a rule used to process DML messages: {"dmlPolicies":\\[{"dmlType":"Delete","dmlAction":"Filter","filterCondition":"id > 1"}]}.'."\n" + ."\n" + .'If you do not configure such a rule, the default processing policy for messages generated for insert, update, and delete operations is Normal. dmlType: the DML operation. Valid values: Insert, Update, and Delete. dmlAction: the processing policy for DML messages. Valid values: Normal, Ignore, Filter, and LogicalDelete. Filter indicates conditional processing. You can set the dmlAction parameter to Filter only when the dmlType parameter is set to Update or Delete. filterCondition: the condition used to filter DML messages. This parameter is required only when the dmlAction parameter is set to Filter.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"expression":"${srcDatasoureName}_${srcDatabaseName}"}', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'abc', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'TableName', - 'in' => 'query', + 'name' => 'TableMappings', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The name of the table in the EMR cluster. This parameter is required only if you set the DataSourceType parameter to emr.'."\n" - ."\n" - .'You can call the [GetMetaDBTableList](~~173916~~) operation to query the table name.'."\n", - 'type' => 'string', + 'description' => 'The list of mappings between rules used to select synchronization objects in the source and transformation rules applied to the selected synchronization objects. Each entry in the list displays a mapping between a rule used to select synchronization objects and a transformation rule applied to the selected synchronization objects.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The mapping between a rule used to select synchronization objects in the source and a transformation rule applied to the selected synchronization objects.'."\n", + 'type' => 'object', + 'properties' => [ + 'SourceObjectSelectionRules' => [ + 'description' => 'The list of rules that you want to use to select synchronization objects in the source.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The rule that you want to use to select synchronization objects in the source. The objects can be databases or tables.'."\n", + 'type' => 'object', + 'properties' => [ + 'ObjectType' => [ + 'description' => 'The type of the object. Valid values:'."\n" + ."\n" + .'* Table'."\n" + .'* Database'."\n", + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'example' => 'Table', + 'title' => '', + ], + 'Expression' => ['description' => 'The expression.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mysql_table_1', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'TransformationRules' => [ + 'description' => 'The list of transformation rules that you want to apply to the synchronization objects selected from the source.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The transformation rule that you want to apply to the synchronization objects selected from the source.'."\n", + 'type' => 'object', + 'properties' => [ + 'RuleName' => ['description' => 'The name of the rule. If the values of the RuleActionType parameter and the RuleTargetType parameter are the same for multiple transformation rules, you must make sure that the transformation rule names are unique.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rename_rule_1', 'title' => ''], + 'RuleActionType' => [ + 'description' => 'The type of the action. Valid values:'."\n" + ."\n" + .'* DefinePrimaryKey'."\n" + .'* Rename'."\n" + .'* AddColumn'."\n" + .'* HandleDml'."\n" + .'* DefineIncrementalCondition'."\n" + .'* DefineCycleScheduleSettings'."\n" + .'* DefineRuntimeSettings'."\n" + .'* DefinePartitionKey'."\n", + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'example' => 'Rename', + 'title' => '', + ], + 'RuleTargetType' => [ + 'description' => 'The type of the object on which you want to perform the action. Valid values:'."\n" + ."\n" + .'* Table'."\n" + .'* Schema'."\n", + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'example' => 'Table', + 'title' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'abc', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'DataSourceType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the data source. Set the value to emr.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'emr', - ], - ], - ], - 'responses' => [ - 200 => [ + 'name' => 'JobSettings', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'description' => 'The settings for the dimension of the synchronization task. The settings include processing policies for DDL messages, policies for data type mappings between source fields and destination fields, and runtime parameters of the synchronization task.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified parameters are invalid.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0bc1411515937****', + 'DdlHandlingSettings' => [ + 'description' => 'The settings for processing DDL messages. The value of this parameter must be an array.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The processing setting for a specific type of DDL message.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The type of the DDL operation. Valid values:'."\n" + ."\n" + .'* RenameColumn'."\n" + .'* ModifyColumn'."\n" + .'* CreateTable'."\n" + .'* TruncateTable'."\n" + .'* DropTable'."\n" + .'* DropColumn'."\n" + .'* AddColumn'."\n", + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'example' => 'AddColumn', + 'title' => '', + ], + 'Action' => [ + 'description' => 'The processing policy for DDL messages. Valid values:'."\n" + ."\n" + .'* Ignore: ignores a DDL message.'."\n" + .'* Critical: reports an error for a DDL message.'."\n" + .'* Normal: normally processes a DDL message.'."\n", + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'example' => 'Critical', + 'title' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'ColumnDataTypeSettings' => [ + 'description' => 'The settings for data type mappings between source fields and destination fields. The value of this parameter must be an array.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The data type mapping between a source field and a destination field.'."\n", + 'type' => 'object', + 'properties' => [ + 'SourceDataType' => ['description' => 'The data type of a source field.'."\n", 'type' => 'string', 'required' => false, 'example' => 'bigint', 'title' => ''], + 'DestinationDataType' => ['description' => 'The data type of a destination field.'."\n", 'type' => 'string', 'required' => false, 'example' => 'text', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '1031203110005', + 'RuntimeSettings' => [ + 'description' => 'The runtime settings. The value of this parameter must be an array.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The runtime settings.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the configuration item. Valid values:'."\n" + ."\n" + .'* runtime.offline.speed.limit.mb: specifies the maximum transmission rate that is allowed for a batch synchronization task. This configuration item takes effect only when runtime.offline.speed.limit.enable is set to true.'."\n" + .'* runtime.offline.speed.limit.enable: specifies whether throttling is enabled for a batch synchronization task.'."\n" + .'* dst.offline.connection.max: specifies the maximum number of connections that are allowed for writing data to the destination of a batch synchronization task.'."\n" + .'* runtime.offline.concurrent: specifies the maximum number of parallel threads that are allowed for a batch synchronization task.'."\n" + .'* dst.realtime.connection.max: specifies the maximum number of connections that are allowed for writing data to the destination of a real-time synchronization task.'."\n" + .'* runtime.enable.auto.create.schema: specifies whether schemas are automatically created in the destination of a synchronization task.'."\n" + .'* src.offline.datasource.max.connection: specifies the maximum number of connections that are allowed for reading data from the source of a batch synchronization task.'."\n" + .'* runtime.realtime.concurrent: specifies the maximum number of parallel threads that are allowed for a real-time synchronization task.'."\n", + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'example' => 'runtime.offline.concurrent', + 'title' => '', + ], + 'Value' => ['description' => 'The value of the configuration item.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'Data' => [ - 'description' => 'The business data.'."\n", + 'CycleScheduleSettings' => [ + 'description' => 'The settings for periodic scheduling.'."\n", 'type' => 'object', 'properties' => [ - 'TableName' => [ - 'description' => 'The name of the table.'."\n", - 'type' => 'string', - 'example' => 'table_name', - ], - 'Comment' => [ - 'description' => 'The comment on the table.'."\n", - 'type' => 'string', - 'example' => 'comment', - ], - 'LifeCycle' => [ - 'description' => 'The lifecycle of the table. Unit: days.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'CreateTime' => [ - 'description' => 'The time when the table was created. A timestamp is returned for this parameter. You can convert the timestamp to the related date based on the time zone that you use.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1589870293000', - ], - 'ProjectName' => [ - 'description' => 'The name of the workspace to which the table belongs.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'ProjectId' => [ - 'description' => 'The ID of the workspace to which the table belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '22', - ], - 'OwnerId' => [ - 'description' => 'The ID of the table owner.'."\n", - 'type' => 'string', - 'example' => '123', - ], - 'EnvType' => [ - 'description' => 'The type of the environment. Valid values:'."\n" - ."\n" - .'* 0: indicates that the table resides in the development environment.'."\n" - .'* 1: indicates that the table resides in the production environment.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'LastAccessTime' => [ - 'description' => 'The time when the table was last accessed. A timestamp is returned for this parameter. You can convert the timestamp to the related date based on the time zone that you use.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1589870294000', - ], - 'DataSize' => [ - 'description' => 'The size of the storage space that is consumed by the table. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'LastModifyTime' => [ - 'description' => 'The time when the table was last updated. A timestamp is returned for this parameter. You can convert the timestamp to the related date based on the time zone that you use.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1589870294000', - ], - 'DatabaseName' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'example' => 'abc', - ], - 'IsVisible' => [ - 'description' => 'The scope in which the table is visible. Valid values:'."\n" - ."\n" - .'* 0: indicates that the table is visible to workspace members.'."\n" - .'* 1: indicates that the table is visible to users within a tenant.'."\n" - .'* 2: indicates that the table is visible to all tenants.'."\n" - .'* 3: indicates that the table is visible only to the table owner.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TotalColumnCount' => [ - 'description' => 'The total number of fields.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '22', - ], - 'TableGuid' => [ - 'description' => 'The unique identifier of the table.'."\n", - 'type' => 'string', - 'example' => 'odps.engine_name.table_name', - ], - 'PartitionKeys' => [ - 'description' => 'The partition key column.'."\n", - 'type' => 'string', - 'example' => 'abc', - ], - 'LastDdlTime' => [ - 'description' => 'The time when the schema of the table was last changed. A timestamp is returned for this parameter. You can convert the timestamp to the related date based on the time zone that you use.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1589870294000', - ], - 'Location' => [ - 'description' => 'The storage path of the Hive table.'."\n", - 'type' => 'string', - 'example' => 'hdfs://localhost:777/user/hadoop/test.txt', - ], - 'ClusterId' => [ - 'description' => 'The EMR cluster ID.'."\n", - 'type' => 'string', - 'example' => 'C-010A704DA760****', - ], - 'TenantId' => [ - 'description' => 'The tenant ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12345', - ], - 'Schema' => [ - 'description' => 'The schema information of the table.'."\n", - 'type' => 'string', - 'example' => 'default', - ], - 'ColumnList' => [ - 'description' => 'The fields in the table.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The field in the table.'."\n", - 'type' => 'object', - 'properties' => [ - 'ColumnName' => [ - 'description' => 'The name of the field.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'ColumnGuid' => [ - 'description' => 'The unique identifier of the field.'."\n", - 'type' => 'string', - 'example' => 'odps.engine_name.table_name.1', - ], - 'IsPartitionColumn' => [ - 'description' => 'Indicates whether the field is a partition field. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Comment' => [ - 'description' => 'The remarks of the field.'."\n", - 'type' => 'string', - 'example' => 'comment', - ], - 'ColumnType' => [ - 'description' => 'The data type of the field.'."\n", - 'type' => 'string', - 'example' => 'string', - ], - 'IsPrimaryKey' => [ - 'description' => 'Indicates whether the field is a primary key. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'Position' => [ - 'description' => 'The sequence number of the field.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Caption' => [ - 'description' => 'The description of the field.'."\n", - 'type' => 'string', - 'example' => 'data comment', - ], - 'IsForeignKey' => [ - 'description' => 'Indicates whether the field is a foreign key. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], + 'ScheduleParameters' => ['description' => 'The scheduling parameters.'."\n", 'type' => 'string', 'required' => false, 'example' => 'bizdate=$bizdate'."\n", 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'ChannelSettings' => ['description' => 'The channel control settings for the synchronization task. The value of this parameter must be a JSON string.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"structInfo":"MANAGED","storageType":"TEXTFILE","writeMode":"APPEND","partitionColumns":[{"columnName":"pt","columnType":"STRING","comment":""}],"fieldDelimiter":""}'."\n", 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'InvalidParameter.Meta.CommonError', - 'errorMessage' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.Illegal', - 'errorMessage' => 'The app guid parameter is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.IllegalDate', - 'errorMessage' => 'The date format is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.IllegalPageError', - 'errorMessage' => 'The parameter for paging is invalid.', - ], - [ - 'errorCode' => 'InvalidParameter.Meta.NotExist', - 'errorMessage' => 'The object does not exist.', - ], - [ - 'errorCode' => 'InternalError.Meta.NoCalcEngine', - 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.', - ], - ], - 403 => [ - [ - 'errorCode' => 'Forbidden.Meta.NoTenant', - 'errorMessage' => 'The user is not the owner of any tenants.', - ], - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'AAC30B35-820D-5F3E-A42C-E96BB6379325'], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.Meta.TenantTimeOut', - 'errorMessage' => 'Failed to connect to the interface network.', - ], - [ - 'errorCode' => 'InternalError.Meta.Unknown', - 'errorMessage' => 'An unknown error occurred while processing your request.', - ], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], ], ], - 'staticInfo' => [ - 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"RequestId\\": \\"0bc1411515937****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Data\\": {\\n \\"TableName\\": \\"table_name\\",\\n \\"Comment\\": \\"comment\\",\\n \\"LifeCycle\\": 5,\\n \\"CreateTime\\": 1589870293000,\\n \\"ProjectName\\": \\"test\\",\\n \\"ProjectId\\": 22,\\n \\"OwnerId\\": \\"123\\",\\n \\"EnvType\\": 1,\\n \\"LastAccessTime\\": 1589870294000,\\n \\"DataSize\\": 10,\\n \\"LastModifyTime\\": 1589870294000,\\n \\"DatabaseName\\": \\"abc\\",\\n \\"IsVisible\\": 1,\\n \\"TotalColumnCount\\": 22,\\n \\"TableGuid\\": \\"odps.engine_name.table_name\\",\\n \\"PartitionKeys\\": \\"abc\\",\\n \\"LastDdlTime\\": 1589870294000,\\n \\"Location\\": \\"hdfs://localhost:777/user/hadoop/test.txt\\",\\n \\"ClusterId\\": \\"C-010A704DA760****\\",\\n \\"TenantId\\": 12345,\\n \\"Schema\\": \\"default\\",\\n \\"ColumnList\\": [\\n {\\n \\"ColumnName\\": \\"1\\",\\n \\"ColumnGuid\\": \\"odps.engine_name.table_name.1\\",\\n \\"IsPartitionColumn\\": true,\\n \\"Comment\\": \\"comment\\",\\n \\"ColumnType\\": \\"string\\",\\n \\"IsPrimaryKey\\": false,\\n \\"Position\\": 1,\\n \\"Caption\\": \\"data comment\\",\\n \\"IsForeignKey\\": true\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n The specified parameters are invalid.\\n 0bc1411515937****\\n true\\n 1031203110005\\n \\n table_name\\n comment\\n 5\\n 1589870293000\\n test\\n 22\\n 123\\n 1\\n 1589870294000\\n 10\\n 1589870294000\\n abc\\n 1\\n 22\\n odps.engine_name.table_name\\n abc\\n 1589870294000\\n hdfs://localhost:777/user/hadoop/test.txt\\n C-010A704DA760****\\n 12345\\n default\\n \\n 1\\n odps.engine_name.table_name.1\\n true\\n comment\\n string\\n false\\n 1\\n data comment\\n true\\n \\n \\n","errorExample":""}]', - 'title' => 'GetMetaTableFullInfo', - 'description' => 'You can call this operation to query only the information about a table of the E-MapReduce (EMR) compute engine type.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'translator' => 'machine', - ], - 'GetDDLJobStatus' => [ - 'summary' => 'Queries the status of a table creation, update, or deletion task.', - 'methods' => [ - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AAC30B35-820D-5F3E-A42C-E96BB6379325\\"\\n}","type":"json"}]', + 'title' => 'UpdateDIJob', + 'changeSet' => [ + ['createdAt' => '2024-06-04T02:51:15.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-01-18T10:25:13.000Z', 'description' => 'Error codes changed, Request parameters changed, Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDIJob'], + ], ], + 'ramActions' => [], + 'translator' => 'manual', + ], + 'UpdateDIProjectConfig' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - ], - 'operationType' => 'read', - 'deprecated' => true, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdideX3KVYR', + [ + 'APP' => [], + ], + [ + 'PrivateKey' => [], ], ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [], 'parameters' => [ [ - 'name' => 'TaskId', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the DDL task.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'abc', - ], + 'schema' => ['description' => 'The ID of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the workspace ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '10000000000', 'minimum' => '1', 'example' => '10000'], + ], + [ + 'name' => 'DestinationType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the destinations of the synchronization solutions. This parameter cannot be left empty. Valid values: analyticdb_for_mysql, odps, elasticsearch, holo, mysql, and polardb.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'odps'], + ], + [ + 'name' => 'SourceType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the sources of the synchronization solutions. Valid values: oracle, mysql, polardb, datahub, drds, and analyticdb_for_mysql. If you do not configure this parameter, DataWorks applies the default global configuration to all sources.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'mysql'], + ], + [ + 'name' => 'ProjectConfig', + 'in' => 'query', + 'schema' => ['description' => 'The new default global configuration of the synchronization solutions. The value indicates the processing rules of different types of DDL messages. The value must be in the JSON format. Example: {"RENAMECOLUMN":"WARNING","DROPTABLE":"WARNING","CREATETABLE":"WARNING","MODIFYCOLUMN":"WARNING","TRUNCATETABLE":"WARNING","DROPCOLUMN":"WARNING","ADDCOLUMN":"WARNING","RENAMETABLE":"WARNING"}.'."\n" + ."\n" + .'Field description:'."\n" + ."\n" + .'* RENAMECOLUMN: renames a column.'."\n" + .'* DROPTABLE: deletes a table.'."\n" + .'* CREATETABLE: creates a table.'."\n" + .'* MODIFYCOLUMN: changes the data type of a column.'."\n" + .'* TRUNCATETABLE: clears a table.'."\n" + .'* DROPCOLUMN: deletes a column.'."\n" + .'* ADDCOLUMN: creates a column.'."\n" + .'* RENAMETABLE: renames a table.'."\n" + ."\n" + .'DataWorks processes a DDL message of a specific type based on the following rules:'."\n" + ."\n" + .'* WARNING: ignores the message and records an alert in real-time synchronization logs. The alert contains information about the situation that the message is ignored because of an execution error.'."\n" + .'* IGNORE: discards the message and does not send it to the destination.'."\n" + .'* CRITICAL: terminates the real-time synchronization task and sets the node status to Failed.'."\n" + .'* NORMAL: sends the message to the destination to process the message. Each destination processes DDL messages based on its own business logic. If DataWorks adopts the NORMAL policy, DataWorks only forwards DDL messages.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{"RENAMECOLUMN":"WARNING","DROPTABLE":"WARNING","CREATETABLE":"WARNING","MODIFYCOLUMN":"WARNING","TRUNCATETABLE":"WARNING","DROPCOLUMN":"WARNING","ADDCOLUMN":"WARNING","RENAMETABLE":"WARNING"}'], ], ], 'responses' => [ @@ -60026,35 +38046,19 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'abc', - ], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], + 'RequestId' => ['description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", 'type' => 'string', 'example' => '0000-ABCD-EFG '], 'Data' => [ - 'description' => 'The details of the task.'."\n", + 'description' => 'The information about the modification.'."\n", 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The status of the task.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'NextTaskId' => [ - 'description' => 'The ID of the ongoing task. If no value is returned for this parameter, all subtasks are complete.'."\n", - 'type' => 'string', - 'example' => 'abc1', - ], - 'TaskId' => [ - 'description' => 'The task ID.'."\n", - 'type' => 'string', - 'example' => 'abc', - ], - 'Content' => [ - 'description' => 'The content of the task.'."\n", - 'type' => 'string', - 'example' => 'success', - ], + 'Status' => ['description' => 'Indicates whether the default global configuration of synchronization solutions is modified. Valid values:'."\n" + ."\n" + .'* success'."\n" + .'* fail'."\n", 'type' => 'string', 'example' => 'success'], ], ], ], @@ -60063,1074 +38067,890 @@ ], ], 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + 400 => [ + ['errorCode' => 'Invalid.DI.Parameter', 'errorMessage' => 'The parameter is invalid.', 'description' => ''], ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + 403 => [ + ['errorCode' => 'Forbidden.DI.NoPrivilege', 'errorMessage' => 'No access.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], + ['errorCode' => 'InternalError.DI.Parameter', 'errorMessage' => 'A DI internal error occurred.', 'description' => ''], ], ], - 'staticInfo' => [ - 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"abc\\",\\n \\"Data\\": {\\n \\"Status\\": \\"success\\",\\n \\"NextTaskId\\": \\"abc1\\",\\n \\"TaskId\\": \\"abc\\",\\n \\"Content\\": \\"success\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"abc\\n\\n success\\n abc\\n success\\n abc1\\n","errorExample":""}]', - 'title' => 'GetDDLJobStatus', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0000-ABCD-EFG\\\\t\\",\\n \\"Data\\": {\\n \\"Status\\": \\"success\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 0000-ABCD-EFG\\t\\n \\n success\\n \\n","errorExample":""}]', + 'title' => 'UpdateDIProjectConfig', + 'summary' => 'Modifies the default global configuration of synchronization solutions in a DataWorks workspace.', + 'description' => 'DataWorks allows you to specify a default global configuration only for the processing rules of DDL messages in synchronization solutions. After you configure the **processing rules of DDL messages** in synchronization solutions, the configuration is used as the default global configuration and applies to all real-time synchronization tasks in the solutions. You can modify the **processing rules of DDL messages** based on your business requirements. For more information about how to configure a synchronization solution, see [Synchronization solutions](~~199008~~).'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteTable' => [ - 'summary' => 'Deletes a MaxCompute table.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'UpdateDISyncTask' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'APP' => [], + ], + [ + 'PrivateKey' => [], + ], ], - 'operationType' => 'write', - 'deprecated' => true, + 'operationType' => 'readAndWrite', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '78218', - 'abilityTreeNodes' => [ - 'FEATUREdideRZEBFC', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '78371', + 'abilityTreeNodes' => ['FEATUREdideBP0OJZ'], ], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the DataWorks workspace.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '101', - ], + 'schema' => ['description' => 'The ID of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the workspace ID. You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '10000000000', 'minimum' => '1', 'example' => '10000', 'title' => ''], ], [ - 'name' => 'TableName', + 'name' => 'TaskType', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the MaxCompute table.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'table1', - ], + 'schema' => ['description' => 'The type of the data synchronization task. Set the value to DI_OFFLINE. You can call the UpdateDISyncTask operation to update only batch synchronization tasks.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'DI_OFFLINE', 'title' => ''], ], [ - 'name' => 'EnvType', + 'name' => 'TaskContent', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the compute engine or data source. Valid values:'."\n" - ."\n" - .'* cdh'."\n" - .'* analyticdb_for_mysql'."\n" - .'* odps'."\n" - .'* emr'."\n" - .'* hadoop'."\n" - .'* holodb'."\n" - .'* hybriddb_for_postgresql'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'maximum' => '1', - 'minimum' => '0', - 'example' => '1', - ], + 'schema' => ['description' => 'The updated configurations of the data synchronization task. Calling this API operation to update a data synchronization task is equivalent to updating a data synchronization task by using the code editor in the DataWorks console. For more information, see [Create a synchronization task by using the code editor](~~137717~~). You can call the UpdateDISyncTask operation to update only batch synchronization tasks. If you do not need to update the configurations of the data synchronization task, leave this parameter empty.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'default' => '', 'example' => '{"type":"job","version":"2.0","steps":[{"stepType":"mysql","parameter":{"envType":1,"datasource":"mysql_pub","column":["id","name","create_time","age","score","t_01"],"connection":[{"datasource":"mysql_pub","table":["u_pk"]}],"where":"","splitPk":"id","encoding":"UTF-8"},"name":"Reader","category":"reader"},{"stepType":"odps","parameter":{"partition":"pt=${bizdate}","truncate":true,"datasource":"odps_source","envType":1,"column":["id","name","create_time","age","score","t_01"],"emptyAsNull":false,"tableComment":"null","table":"u_pk"},"name":"Writer","category":"writer"}],"setting":{"executeMode":null,"errorLimit":{"record":""},"speed":{"concurrent":2,"throttle":false}},"order":{"hops":[{"from":"Reader","to":"Writer"}]}}', 'title' => ''], ], [ - 'name' => 'AppGuid', + 'name' => 'TaskParam', 'in' => 'query', - 'schema' => [ - 'description' => 'The globally unique identifier (GUID) of the MaxCompute project. Specify the GUID in the odps.{projectName} format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'odps.test', - ], + 'schema' => ['description' => 'The configuration parameters of the data synchronization task. You must configure this parameter in the JSON format.'."\n" + ."\n" + .'* ResourceGroup: the identifier of the resource group for Data Integration that is used by the data synchronization task. You can call the [ListResourceGroups](~~173913~~) operation to query the identifier of the resource group.'."\n" + .'* Cu: the specifications occupied by the data synchronization task in the serverless resource group. The value of this parameter must be a multiple of 0.5.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '{"ResourceGroup":"Serverless_res_group_XXX_XXXX", "Cu":1.5}', 'title' => ''], ], [ - 'name' => 'Schema', + 'name' => 'FileId', 'in' => 'query', - 'schema' => [ - 'description' => 'The schema information of the table. You need to enter the schema information of the table if you enable the table schema in MaxCompute.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], + 'schema' => ['description' => 'The ID of the data synchronization task. You can call the [ListFiles](~~173942~~) operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '1000000', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The returned result.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'abcde', - ], - 'TaskInfo' => [ - 'description' => 'The information about the task that is used to delete the table.'."\n", + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", 'type' => 'string', 'example' => '0bc1411515937635973****', 'title' => ''], + 'Data' => [ + 'description' => 'The information that indicates whether the data synchronization task is updated.'."\n", 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The status of the task that is complete.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'NextTaskId' => [ - 'description' => 'The ID of the task that is running.'."\n", - 'type' => 'string', - 'example' => 'abc1', - ], - 'TaskId' => [ - 'description' => 'The ID of the task that is complete.'."\n", - 'type' => 'string', - 'example' => 'abc', - ], - 'Content' => [ - 'description' => 'The content of the task.'."\n", - 'type' => 'string', - 'example' => 'success', - ], + 'Status' => ['description' => 'The update status of the data synchronization task. Valid values:'."\n" + ."\n" + .'* success'."\n" + .'* fail'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Message' => ['description' => 'The error message returned if the data synchronization task fails to be updated. If the data synchronization task is successfully updated, the value null is returned for this parameter.'."\n", 'type' => 'string', 'example' => 'ResourceGroup:[S_res_group_XXX] is invalid.', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + 400 => [ + ['errorCode' => 'Invalid.DI.Parameter', 'errorMessage' => 'The parameter is invalid.', 'description' => ''], ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + 403 => [ + ['errorCode' => 'Forbidden.DI.NoPrivilege', 'errorMessage' => 'No access.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], + ['errorCode' => 'InternalError.DI.Parameter', 'errorMessage' => 'A DI internal error occurred.', 'description' => ''], ], ], - 'staticInfo' => [ - 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"abcde\\",\\n \\"TaskInfo\\": {\\n \\"Status\\": \\"success\\",\\n \\"NextTaskId\\": \\"abc1\\",\\n \\"TaskId\\": \\"abc\\",\\n \\"Content\\": \\"success\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n success\\n abc\\n success\\n abc1\\n\\nabcde","errorExample":""}]', - 'title' => 'DeleteTable', + 'title' => 'UpdateDISyncTask', + 'summary' => 'Updates a data synchronization task.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateTable' => [ - 'summary' => 'Updates a MaxCompute table.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], + 'changeSet' => [ + ['createdAt' => '2025-04-24T03:30:22.000Z', 'description' => 'Request parameters changed'], ], - 'operationType' => 'write', - 'deprecated' => true, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '78382', - 'abilityTreeNodes' => [ - 'FEATUREdideX3KVYR', - ], + 'flowControl' => [ + 'flowControlList' => [], ], - 'parameters' => [ - [ - 'name' => 'IsView', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether the table is a view. Valid values: 0 and 1. The value 0 indicates that the table is not a view. The value 1 indicates that the table is a view. This parameter is deprecated. Do not use this parameter.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - ], - [ - 'name' => 'Visibility', - 'in' => 'query', - 'schema' => [ - 'description' => 'The scope in which the table is visible. Valid values: 0, 1, and 2. The value 0 indicates that the table is invisible to all workspace members. The value 1 indicates that the table is visible to all workspace members. The value 2 indicates that the table is visible to workspace members.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'LifeCycle', - 'in' => 'query', - 'schema' => [ - 'description' => 'The lifecycle of the table. Unit: days. If this parameter is left empty, the table is permanently stored.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], + 'ramActions' => [ [ - 'name' => 'CategoryId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the associated category.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '101', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0bc1411515937635973****\\",\\n \\"Data\\": {\\n \\"Status\\": \\"success\\",\\n \\"Message\\": \\"ResourceGroup:[S_res_group_XXX] is invalid.\\"\\n }\\n}","type":"json"}]', + ], + 'UpdateDataServiceApi' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'LogicalLevelId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the logical level.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '101', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '78368', + 'abilityTreeNodes' => ['FEATUREdideZZ63WZ'], + ], + 'parameters' => [ [ - 'name' => 'PhysicsLevelId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the physical layer.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '101', - ], + 'name' => 'TenantId', + 'in' => 'formData', + 'schema' => ['description' => 'The tenant ID. To obtain the tenant ID, perform the following steps: Log on to the [DataWorks console](https://workbench.data.aliyun.com/console). Find your workspace and go to the DataStudio page. On the DataStudio page, click the username for the logon in the upper-right corner and click User Info in the Menu section.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10001', 'title' => ''], ], [ - 'name' => 'ExternalTableType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the external table. Valid values: 0, 1, 2, and 3. The value 0 indicates that the external table is an OSS external table. The value 1 indicates that the external table is a Tablestore external table. The value 2 indicates that the external table is a volume external table. The value 3 indicates that the external table is a MySQL external table. This parameter is deprecated. Do not use this parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the workspace.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10001', 'title' => ''], ], [ - 'name' => 'Location', - 'in' => 'query', - 'schema' => [ - 'description' => 'The storage location of the external table. This parameter is deprecated. Do not use this parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'location', - ], + 'name' => 'ApiId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the API.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10000', 'title' => ''], ], [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The DataWorks workspace ID. You can log on to the DataWorks console to obtain the ID of the DataWorks workspace.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '101', - ], + 'name' => 'RequestMethod', + 'in' => 'formData', + 'schema' => ['description' => 'The request method of the API. Valid values: 0, 1, 2, and 3. The value 0 indicates the GET method. The value 1 indicates the POST method. The value 2 indicates the PUT method. The value 3 indicates the DELETE method. APIs generated in wizard or script mode support the GET and POST methods. APIs generated by registration support the GET, POST, PUT, and DELETE methods.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '0', 'title' => ''], ], [ - 'name' => 'TableName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the MaxCompute table.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'abc', - ], + 'name' => 'ResponseContentType', + 'in' => 'formData', + 'schema' => ['description' => 'The format in which the response of the API request is returned. Valid values: 0 and 1. The value 0 indicates the JSON format. The value 1 indicates the XML format. APIs generated in wizard or script mode support the JSON format. APIs generated by registration support the JSON and XML formats.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '0', 'title' => ''], ], [ - 'name' => 'Endpoint', + 'name' => 'Timeout', 'in' => 'formData', - 'schema' => [ - 'description' => 'The endpoint of MaxCompute. If you do not specify this parameter, the endpoint of the MaxCompute project is used.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'odps://', - ], + 'schema' => ['description' => 'The timeout period of the API request. Unit: milliseconds. Valid values: (0,30000].'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10000', 'title' => ''], ], [ - 'name' => 'EnvType', + 'name' => 'VisibleRange', 'in' => 'formData', - 'schema' => [ - 'description' => 'The environment of the DataWorks workspace. Valid values: 0 and 1. The value 0 indicates the development environment. The value 1 indicates the production environment.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The scope in which the API is visible. Valid values: 0 and 1. The value 0 indicates that the API is visible within the workspace. The value 1 indicates that the API is visible only to its owner.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '0', 'title' => ''], ], [ - 'name' => 'AppGuid', - 'in' => 'query', - 'schema' => [ - 'description' => 'The unique identifier of the MaxCompute project. Specify the GUID in the odps.{projectName} format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'odps.test', - ], + 'name' => 'Protocols', + 'in' => 'formData', + 'schema' => ['description' => 'The protocol used by the API. Valid values: 0 and 1. The value 0 indicates HTTP. The value 1 indicates HTTPS. You can specify multiple protocols. Separate multiple protocols with commas (,).'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0,1', 'title' => ''], ], [ - 'name' => 'CreateIfNotExists', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether the table exists. Valid values:'."\n" - ."\n" - .'* true: The table exists.'."\n" - .'* false: The table does not exist.'."\n" - ."\n" - .'This parameter is deprecated. Do not use this parameter.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'name' => 'WizardDetails', + 'in' => 'formData', + 'schema' => ['description' => 'The details of the API generated in wizard mode. For more information, see the WizardDetails parameter returned by the [GetDataServiceApi](~~174013~~) operation.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"isPagedResponse":true,"wizardConnection":{"connectionId":122786,"tableName":"person"},"wizardRequestParameters":[{"columnName":"id","defaultValue":"","exampleValue":"1","isRequiredParameter":true,"parameterDataType":2,"parameterDescription":"","parameterName":"id","parameterOperator":0,"parameterPosition":0}],"wizardResponseParameters":[{"columnName":"id","exampleValue":"11","parameterDataType":2,"parameterDescription":"","parameterName":"id"}]}', 'title' => ''], ], [ - 'name' => 'HasPart', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether the table that you want to update is a partitioned table. Valid values: 0 and 1. The value 0 indicates that the table is not a partitioned table. The value 1 indicates that the table is a partitioned table. This parameter is deprecated. Do not use this parameter. The Column.N.isPartitionCol parameter is used instead of the HasPart parameter to specify whether the MaxCompute table is a partitioned table. If the Column.N.isPartitionCol parameter is set to 1, the MaxCompute table is a partitioned table.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'name' => 'ScriptDetails', + 'in' => 'formData', + 'schema' => ['description' => 'The details of the API generated in script mode. For more information, see the ScriptDetails parameter returned by the [GetDataServiceApi](~~174013~~) operation.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"isPagedResponse":false,"script":"select id as id1, name as name1 from person where id=${inputid}","scriptConnection":{"connectionId":122786,"tableName":"person"},"scriptRequestParameters":[{"defaultValue":"","exampleValue":"","isRequiredParameter":true,"parameterDataType":0,"parameterDescription":"","parameterName":"inputid","parameterOperator":0,"parameterPosition":1}],"scriptResponseParameters":[{"exampleValue":"","parameterDataType":0,"parameterDescription":"","parameterName":"id1"},{"exampleValue":"","parameterDataType":0,"parameterDescription":"","parameterName":"name1"}]}', 'title' => ''], ], [ - 'name' => 'Comment', - 'in' => 'query', - 'schema' => [ - 'description' => 'The comment.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'comment', - ], + 'name' => 'RegistrationDetails', + 'in' => 'formData', + 'schema' => ['description' => 'The details of the API generated by registration. For more information, see the RegistrationDetails parameter returned by the [GetDataServiceApi](~~174013~~) operation.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"failedResultSample":"fail","registrationErrorCodes":[{"errorCode":"e1","errorMessage":"msg1","errorSolution":"sol1"},{"errorCode":"e2","errorMessage":"msg2","errorSolution":"sol2"}],"registrationRequestParameters":[{"columnName":"","defaultValue":"","exampleValue":"","isRequiredParameter":true,"parameterDataType":0,"parameterDescription":"","parameterName":"id","parameterOperator":0,"parameterPosition":1},{"columnName":"","defaultValue":"xx","exampleValue":"","isRequiredParameter":true,"parameterDataType":0,"parameterDescription":"","parameterName":"cc","parameterOperator":2,"parameterPosition":2}],"serviceContentType":1,"serviceHost":"http://www.baidu.com","servicePath":"/[uid]","serviceRequestBodyDescription":"body","successfulResultSample":"success"}', 'title' => ''], ], [ - 'name' => 'Schema', - 'in' => 'query', - 'schema' => [ - 'description' => 'The schema information of the table. You need to enter the schema information of the table if you enable the table schema in MaxCompute.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], + 'name' => 'ApiPath', + 'in' => 'formData', + 'schema' => ['description' => 'The path of the API.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '/test/2', 'title' => ''], ], [ - 'name' => 'Columns', + 'name' => 'ApiDescription', 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The list of fields.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ColumnNameCn' => [ - 'description' => 'The display name of the field.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], - 'ColumnName' => [ - 'description' => 'The name of the field.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'abc', - ], - 'Comment' => [ - 'description' => 'The comment of the field.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'comment', - ], - 'ColumnType' => [ - 'description' => 'The type of the field. For more information, see MaxCompute field types.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'string', - ], - 'SeqNumber' => [ - 'description' => 'The sequence number of the field. If the field is a partition field, this parameter is not supported.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'Length' => [ - 'description' => 'The length of the field.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - 'IsPartitionCol' => [ - 'description' => 'Specifies whether the field is a partition field. Valid values: 0 and 1. The value 0 indicates that the field is not a partition field. The value 1 indicates that the field is a partition field.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => '0', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 100, - ], + 'schema' => ['description' => 'The description of the API.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Test API description', 'title' => ''], ], [ - 'name' => 'Themes', + 'name' => 'ResourceGroupId', 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The list of fields.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ThemeId' => [ - 'description' => 'The ID of the associated topic.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '101', - ], - 'ThemeLevel' => [ - 'description' => 'The level that corresponds to the topic ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '101', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 100, - ], + 'schema' => ['description' => 'The ID of the exclusive resource group.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3242432423', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The returned result.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'abcde', - ], - 'TaskInfo' => [ - 'description' => 'The information about the request task. After a request task is submitted, it is divided into multiple subtasks that are run in sequence. After the current subtask is complete, the next subtask starts to run. After all subtasks are complete, the request task is complete. If a request task is terminated due to one of the following issues, address the issue based on the error code and initiate the request task again:'."\n" - ."\n" - .'* The request task fails to be submitted.'."\n" - .'* After the request task is submitted, a subtask fails to run.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status of the current subtask. Valid values:'."\n" - ."\n" - .'* operating: The subtask is running.'."\n" - .'* success: The subtask succeeds.'."\n" - .'* failure: The subtask fails to run. For more information about the error details, see the Content parameter.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'NextTaskId' => [ - 'description' => 'The ID of the subtask that you want to run. If this parameter is left empty, all subtasks are complete. You can call the [GetDDLJobStatus](~~185659~~) operation to query the status of the subtask based on the subtask ID.'."\n", - 'type' => 'string', - 'example' => 'abc1', - ], - 'TaskId' => [ - 'description' => 'The ID of the current subtask.'."\n", - 'type' => 'string', - 'example' => 'abc', - ], - 'Content' => [ - 'description' => 'The details about the status of the current subtask. Valid values:'."\n" - ."\n" - .'* If the current subtask is successful, success is returned.'."\n" - .'* If the current subtask fails, the error details are displayed.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - ], - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the information about the API was updated.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The connection does not exist.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0000-ABCD-EFG****', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], ], 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"0000-ABCD-EFG****\\n200\\ntrue\\ntrue","errorExample":""}]', + 'title' => 'UpdateDataServiceApi', + 'summary' => 'Updates the information about an API in the development state in DataService Studio.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-10-09T11:17:28.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-03-02T08:13:10.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDataServiceApi'], + ], + ], + 'ramActions' => [], + ], + 'UpdateDataSource' => [ + 'summary' => 'Updates a data source.', + 'methods' => ['put'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '78369', + 'abilityTreeNodes' => ['FEATUREdideRWC5F7'], + ], + 'parameters' => [ + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The description of the data source.'."\n", 'type' => 'string', 'required' => false, 'example' => 'xxx', 'title' => ''], + ], + [ + 'name' => 'EnvType', + 'in' => 'query', + 'schema' => ['description' => 'The environment in which the data source resides. Valid values:'."\n" + ."\n" + .'* 0: development environment'."\n" + .'* 1: production environment'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Content', + 'in' => 'query', + 'schema' => ['description' => 'The details about the data source. You are not allowed to change the type of the data source. For example, you are not allowed to change the data source type from MaxCompute to MySQL. Examples of details of some common data sources:'."\n" + ."\n" + .'* odps'."\n" + ."\n" + .' {'."\n" + .' "accessId": "*****",'."\n" + .' "accessKey": "*****",'."\n" + .' "authType": 2,'."\n" + .' "endpoint": "http://service.odps.aliyun.com/api",'."\n" + .' "project": "xsaxsax",'."\n" + .' "tag": "public"'."\n" + .' }'."\n" + ."\n" + .'* mysql'."\n" + ."\n" + .' {'."\n" + .' "database": "xsaxsa",'."\n" + .' "instanceName": "rm-xsaxsa",'."\n" + .' "password": "xsaxsa",'."\n" + .' "rdsOwnerId": "xasxsa",'."\n" + .' "regionId": "cn-shanghai",'."\n" + .' "tag": "rds",'."\n" + .' "username": "xsaxsa"'."\n" + .' }'."\n" + ."\n" + .'* rds'."\n" + ."\n" + .' {'."\n" + .' "configType": 1,'."\n" + .' "tag": "rds",'."\n" + .' "database": "xsaxsa",'."\n" + .' "username": "xsaxsa",'."\n" + .' "password": "xssaxsa$32050",'."\n" + .' "instanceName": "rm-xsaxs",'."\n" + .' "rdsOwnerId": "11111111"'."\n" + .' }'."\n" + ."\n" + .'* oss'."\n" + ."\n" + .' {'."\n" + .' "accessId": "*****",'."\n" + .' "accessKey": "*****",'."\n" + .' "bucket": "xsa-xs-xs",'."\n" + .' "endpoint": "http://oss-cn-shanghai.aliyuncs.com",'."\n" + .' "tag": "public"'."\n" + .' }'."\n" + ."\n" + .'* sqlserver'."\n" + ."\n" + .' {'."\n" + .' "jdbcUrl": "jdbc:sqlserver://xsaxsa-xsaxsa.database.xxx.cn:123;DatabaseName=xsxs-xsxs",'."\n" + .' "password": "sdasda$fs",'."\n" + .' "tag": "public",'."\n" + .' "username": "sxaxacdacdd"'."\n" + .' }'."\n" + ."\n" + .'* polardb'."\n" + ."\n" + .' {'."\n" + .' "clusterId": "pc-sdadsadsa",'."\n" + .' "database": "dsadsadsa",'."\n" + .' "ownerId": "121212122",'."\n" + .' "password": "sdasdafssa",'."\n" + .' "region": "cn-shanghai",'."\n" + .' "tag": "polardb",'."\n" + .' "username": "asdadsads"'."\n" + .' }'."\n" + ."\n" + .'* oracle'."\n" + ."\n" + .' {'."\n" + .' "jdbcUrl": "jdbc:oracle:saaa:@xxxxx:1521:PROD",'."\n" + .' "password": "sxasaxsa",'."\n" + .' "tag": "public",'."\n" + .' "username": "sasfadfa"'."\n" + .' }'."\n" + ."\n" + .'* mongodb'."\n" + ."\n" + .' {'."\n" + .' "address": "[\\"xsaxxsa.mongodb.rds.aliyuncs.com:3717\\"]",'."\n" + .' "database": "admin",'."\n" + .' "password": "sadsda@",'."\n" + .' "tag": "public",'."\n" + .' "username": "dsadsadas"'."\n" + .' }'."\n" + ."\n" + .'* emr'."\n" + ."\n" + .' {'."\n" + .' "accessId": "*****",'."\n" + .' "emrClusterId": "C-dsads",'."\n" + .' "emrResourceQueueName": "default",'."\n" + .' "emrEndpoint": "emr.aliyuncs.com",'."\n" + .' "accessKey": "*****",'."\n" + .' "emrUserId": "224833315798889783",'."\n" + .' "name": "sasdsadsa",'."\n" + .' "emrAccessMode": "simple",'."\n" + .' "region": "cn-shanghai",'."\n" + .' "authType": "2",'."\n" + .' "emrProjectId": "FP-sdadsad"'."\n" + .' }'."\n" + ."\n" + .'* postgresql'."\n" + ."\n" + .' {'."\n" + .' "jdbcUrl": "jdbc:postgresql://xxxx:1921/ssss",'."\n" + .' "password": "sdadsads",'."\n" + .' "tag": "public",'."\n" + .' "username": "sdsasda"'."\n" + .' }'."\n" + ."\n" + .'* analyticdb_for_mysql'."\n" + ."\n" + .' {'."\n" + .' "instanceId": "am-sadsada",'."\n" + .' "database": "xsxsx",'."\n" + .' "username": "xsxsa",'."\n" + .' "password": "asdadsa",'."\n" + .' "connectionString": "am-xssxsxs.ads.aliyuncs.com:3306"'."\n" + .' }'."\n" + ."\n" + .'* hybriddb_for_postgresql'."\n" + ."\n" + .' {'."\n" + .' "connectionString": "gp-xsaxsaxa-master.gpdbmaster.rds.aliyuncs.com",'."\n" + .' "database": "xsaxsaxas",'."\n" + .' "password": "xsaxsaxsa@11",'."\n" + .' "instanceId": "gp-xsaxsaxsa",'."\n" + .' "port": "541132",'."\n" + .' "ownerId": "xsaxsaxsas",'."\n" + .' "username": "sadsad"'."\n" + .' }'."\n" + ."\n" + .'* holo'."\n" + ."\n" + .' {'."\n" + .' "accessId": "*****",'."\n" + .' "accessKey": "*****",'."\n" + .' "database": "xsaxsaxsa",'."\n" + .' "instanceId": "xsaxa",'."\n" + .' "tag": "aliyun"'."\n" + .' }'."\n" + ."\n" + .'* kafka'."\n" + ."\n" + .' {'."\n" + .' "instanceId": "xsax-cn-xsaxsa",'."\n" + .' "regionId": "cn-shanghai",'."\n" + .' "tag": "aliyun",'."\n" + .' "ownerId": "1212121212112"'."\n" + .' }'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '{"accessId":"*****","accessKey":"*****","authType":2,"endpoint":"http://service.odps.aliyun.com/api","project":"xsaxsax","tag":"public"}', 'title' => ''], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => 'The status of the data source. This parameter is deprecated. Do not use this parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ENABLED', 'title' => ''], + ], + [ + 'name' => 'DataSourceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the data source. You can call the [ListDataSources](~~2780072~~) operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the data source is updated.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0bc14115159376359****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'Invalid.Tenant.ConnectionNotExists', 'errorMessage' => 'The connection does not exist.', 'description' => 'The connection does not exist.'], + ['errorCode' => 'Invalid.Tenant.ProjectNotExists', 'errorMessage' => 'The project does not exist.', 'description' => 'The project does not exist.'], + ['errorCode' => 'Invalid.Tenant.UserNotInProject', 'errorMessage' => 'The user is not in the project.', 'description' => 'The user is not in the project.'], + ['errorCode' => 'MissingParam.ConnectionStr.Property', 'errorMessage' => 'You must specify property %s required by the data source connection string.', 'description' => 'The data source connection str required property missing. '], + ['errorCode' => 'DataSource.CheckRamRoleFailure', 'errorMessage' => 'Failed to check the RAM role. AccountId %s. roleArn %s.', 'description' => ''], + ['errorCode' => 'DataSource.ConnectionStrProperty.PatternNotMatch', 'errorMessage' => 'The pattern value %s is invalid. The correct pattern is %s.', 'description' => ''], + ['errorCode' => 'DataSource.NotFound', 'errorMessage' => 'The specified data source ID %s does not exist.', 'description' => ''], + ['errorCode' => 'Invalid.Connection.Empty', 'errorMessage' => 'You must specify the connection parameter.', 'description' => 'Connection param is empty.'], + ['errorCode' => 'Invalid.DataSource.DataSourceTypeNotExist', 'errorMessage' => 'The data source type %s does not exist.', 'description' => 'The dataSource type %s are not exist.'], + ['errorCode' => 'Invalid.DataSource.DataSourceTypeNotSupport', 'errorMessage' => 'The dataSourceType %s and subType %s are not supported.', 'description' => 'DataSource type not support yet.'], + ['errorCode' => 'Invalid.Operation', 'errorMessage' => 'You cannot delete the bindingCalcEngine that is bound to the data source.', 'description' => 'Can not delete datasource bindingCalcEngine.'], + ['errorCode' => 'Invalid.Param.Odps.EngineIdOrConnectStrEmpty', 'errorMessage' => 'Either the compute engine ID or the connection string must be specified when data source type is ODPS.', 'description' => ''], + ['errorCode' => 'Required.Parameter.Empty', 'errorMessage' => 'You must specify the parameter %s.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin', 'errorMessage' => 'The user is not a project administrator or owner.', 'description' => 'The user is not a project administrator or owner.'], + ['errorCode' => 'Invalid.Tenant.UserNotInTenant', 'errorMessage' => 'The user is not in tenant.', 'description' => 'The user is not in tenant.'], + ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"abcde\\",\\n \\"TaskInfo\\": {\\n \\"Status\\": \\"success\\",\\n \\"NextTaskId\\": \\"abc1\\",\\n \\"TaskId\\": \\"abc\\",\\n \\"Content\\": \\"success\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n \\n success\\n abc\\n success\\n abc1\\n \\n abcde\\n","errorExample":""}]', - 'title' => 'UpdateTable', + 'title' => 'UpdateDataSource', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateTable' => [ - 'summary' => 'Creates a MaxCompute table or view.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": true,\\n \\"RequestId\\": \\"0bc14115159376359****\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'UpdateFile' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => true, + 'operationType' => 'readAndWrite', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '78197', - 'abilityTreeNodes' => [ - 'FEATUREdideRZEBFC', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '78372', + 'abilityTreeNodes' => ['FEATUREdide8FM783'], ], 'parameters' => [ [ - 'name' => 'IsView', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to create a view or table. Valid values:'."\n" - ."\n" - .'* 0: Create a table.'."\n" - .'* 1: Create a view.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'name' => 'FileFolderPath', + 'in' => 'formData', + 'schema' => ['description' => 'The path of the file.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Business_process/First_Business_Process/data_integration/Folder_1/Folder_2'], ], [ - 'name' => 'Visibility', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether the table or workspace is visible. Valid values:'."\n" - ."\n" - .'* 0: Both the table and workspace are invisible.'."\n" - .'* 1: Both the table and workspace are visible.'."\n" - .'* 2: Only the workspace is visible.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10000'], ], [ - 'name' => 'LifeCycle', - 'in' => 'query', - 'schema' => [ - 'description' => 'The lifecycle of the table. Unit: days. By default, this parameter is left empty, which indicates that the table is permanently stored.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'name' => 'FileName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the file. You can set the FileName parameter to a new value to change the file name.'."\n" + ."\n" + .'You can call the [ListFiles](~~173942~~) operation to query the ID of the file whose name you want to change. Then, you can set the FileId parameter to the ID and set the FileName parameter to a new value when you call the [UpdateFile](~~173951~~) operation.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'ods_user_info_d'], ], [ - 'name' => 'CategoryId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the associated category. You can call the [GetMetaCategory](~~173932~~) operation to query the IDs of all categories that can be associated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '101', - ], + 'name' => 'FileDescription', + 'in' => 'formData', + 'schema' => ['description' => 'The description of the file.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Here is the file description', 'maxLength' => 200], ], [ - 'name' => 'LogicalLevelId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the logical level.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '101', - ], + 'name' => 'Content', + 'in' => 'formData', + 'schema' => ['description' => 'The code of the file. The code format varies based on the file type. To view the code format for a specific file type, go to Operation Center, right-click a node of the file type, and then select View Code.'."\n", 'type' => 'string', 'required' => false, 'example' => 'SELECT "1";'], ], [ - 'name' => 'PhysicsLevelId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the physical level.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '101', - ], + 'name' => 'AutoRerunTimes', + 'in' => 'formData', + 'schema' => ['description' => 'The number of automatic reruns that are allowed after an error occurs.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '3'], ], [ - 'name' => 'ExternalTableType', - 'in' => 'query', + 'name' => 'AutoRerunIntervalMillis', + 'in' => 'formData', + 'schema' => ['description' => 'The interval between two consecutive automatic reruns after an error occurs. Unit: milliseconds. Maximum value: 1800000 (30 minutes).'."\n" + ."\n" + .'This parameter corresponds to the Rerun Interval parameter that is displayed after the Auto Rerun upon Error check box is selected in the Schedule section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n" + ."\n" + .'The interval that you specify in the DataWorks console is measured in minutes. Pay attention to the conversion between the units of time when you call the operation.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '120000'], + ], + [ + 'name' => 'RerunMode', + 'in' => 'formData', 'schema' => [ - 'description' => 'The storage type of the external table. Valid values:'."\n" + 'description' => 'Specifies whether the node that corresponds to the file can be rerun. Valid values:'."\n" + ."\n" + .'* ALL_ALLOWED: The node can be rerun regardless of whether it is successfully run or fails to run.'."\n" + .'* FAILURE_ALLOWED: The node can be rerun only after it fails to run.'."\n" + .'* ALL_DENIED: The node cannot be rerun regardless of whether it is successfully run or fails to run.'."\n" + ."\n" + .'This parameter corresponds to the Rerun parameter in the Schedule section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n" + ."\n" + .'Valid values:'."\n" ."\n" - .'* 0: Object Storage Service (OSS)'."\n" - .'* 1: Tablestore'."\n" - .'* 2: Volume'."\n" - .'* 3: MySQL'."\n", + .'* ALL_ALLOWD'."\n" + .'* FAILURE_ALLOWED'."\n" + .'* ALL_DENIED'."\n" + .'* ALL_ALLOWED'."\n", 'type' => 'string', 'required' => false, - 'example' => '0', + 'example' => 'ALL_ALLOWED', + 'enum' => ['ALL_ALLOWD', 'FAILURE_ALLOWED', 'ALL_DENIED', 'ALL_ALLOWED'], ], ], [ - 'name' => 'Location', - 'in' => 'query', - 'schema' => [ - 'description' => 'The storage location of the external table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'location', - ], + 'name' => 'Stop', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to suspend the scheduling of the node. Valid values:'."\n" + ."\n" + .'* true: suspends the scheduling of the node.'."\n" + .'* false: does not suspend the scheduling of the node.'."\n" + ."\n" + .'This parameter corresponds to the Recurrence parameter in the Schedule section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '23', - ], + 'name' => 'ParaValue', + 'in' => 'formData', + 'schema' => ['description' => 'The scheduling parameters of the node.'."\n" + ."\n" + .'This parameter corresponds to the Parameters section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console). For more information, see [Configure scheduling parameters](~~137548~~).'."\n", 'type' => 'string', 'required' => false, 'example' => 'x=a y=b z=c'], ], [ - 'name' => 'TableName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the table.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'tableName1', - ], + 'name' => 'StartEffectDate', + 'in' => 'formData', + 'schema' => ['description' => 'The start time of automatic scheduling. Set this parameter to a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n" + ."\n" + .'This parameter corresponds to the Validity Period parameter in the Schedule section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'minimum' => '0', 'example' => '936923400000'], ], [ - 'name' => 'Endpoint', + 'name' => 'EndEffectDate', 'in' => 'formData', - 'schema' => [ - 'description' => 'The endpoint of MaxCompute.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'odps://abc', - ], + 'schema' => ['description' => 'The end time of automatic scheduling. Set this parameter to a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.'."\n" + ."\n" + .'This parameter corresponds to the end time specified for the Validity Period parameter in the Schedule section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'minimum' => '0', 'example' => '4155787800000'], ], [ - 'name' => 'EnvType', + 'name' => 'CronExpress', 'in' => 'formData', - 'schema' => [ - 'description' => 'The environment type of the DataWorks workspace. Valid values:'."\n" - ."\n" - .'* 0: development environment'."\n" - .'* 1: production environment'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The CRON expression that represents the periodic scheduling policy of the node. This parameter corresponds to the Cron Expression parameter in the Schedule section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console). After you configure the Scheduling Cycle and Run At parameters in the DataWorks console, DataWorks automatically generates a value for the Cron Expression parameter.'."\n" + ."\n" + .'Examples:'."\n" + ."\n" + .'* CRON expression for a node that is scheduled to run at 05:30 every day: `00 30 05 * * ?`'."\n" + .'* CRON expression for a node that is scheduled to run at the fifteenth minute of each hour: `00 15 * * * ?`'."\n" + .'* CRON expression for a node that is scheduled to run every 10 minutes: `00 00/10 * * * ?`'."\n" + .'* CRON expression for a node that is scheduled to run every 10 minutes from 08:00 to 17:00 every day: `00 00-59/10 8-23 * * * ?`'."\n" + .'* CRON expression for a node that is scheduled to run at 00:20 on the first day of each month: `00 20 00 1 * ?`'."\n" + .'* CRON expression for a node that is scheduled to run every three months starting from 00:10 on January 1: `00 10 00 1 1-12/3 ?`'."\n" + .'* CRON expression for a node that is scheduled to run at 00:05 every Tuesday and Friday: `00 05 00 * * 2,5`'."\n" + ."\n" + .'The scheduling system of DataWorks imposes the following limits on CRON expressions:'."\n" + ."\n" + .'* A node can be scheduled to run at a minimum interval of 5 minutes.'."\n" + .'* A node can be scheduled to run at 00:05 every day at the earliest.'."\n", 'type' => 'string', 'required' => false, 'example' => '00 00-59/5 1-23 * * ?'], ], [ - 'name' => 'AppGuid', - 'in' => 'query', + 'name' => 'CycleType', + 'in' => 'formData', 'schema' => [ - 'description' => 'The ID of the MaxCompute project. Specify the ID in the odps.{projectName} format.'."\n", + 'description' => 'The type of the scheduling cycle of the node that corresponds to the file. Valid values: NOT_DAY and DAY. The value NOT_DAY indicates that the node is scheduled to run by minute or hour. The value DAY indicates that the node is scheduled to run by day, week, or month.'."\n" + ."\n" + .'This parameter corresponds to the Scheduling Cycle parameter in the Schedule section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", 'type' => 'string', 'required' => false, - 'example' => 'odps.test', + 'example' => 'NOT_DAY', + 'default' => 'DAY', + 'enum' => ['DAY', 'NOT_DAY'], ], ], [ - 'name' => 'Comment', - 'in' => 'query', + 'name' => 'DependentType', + 'in' => 'formData', 'schema' => [ - 'description' => 'The comment.'."\n", + 'description' => 'The type of the cross-cycle scheduling dependency of the node. Valid values:'."\n" + ."\n" + .'* SELF: The instance generated for the node in the current cycle depends on the instance generated for the node in the previous cycle.'."\n" + .'* CHILD: The instance generated for the node in the current cycle depends on the instances generated for the descendant nodes at the nearest level of the node in the previous cycle.'."\n" + .'* USER_DEFINE: The instance generated for the node in the current cycle depends on the instances generated for one or more specified nodes in the previous cycle.'."\n" + .'* NONE: No cross-cycle scheduling dependency type is selected for the node.'."\n", 'type' => 'string', 'required' => false, - 'example' => 'comment', + 'example' => 'USER_DEFINE', + 'enum' => ['NONE', 'USER_DEFINE', 'CHILD', 'SELF', 'USER_DEFINE_AND_SELF', 'CHILD_AND_SELF'], ], ], [ - 'name' => 'HasPart', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to create a MaxCompute partitioned table. Valid values: 1 and 0. The value 1 indicates a partitioned table. The value 0 indicates a non-partitioned table. This parameter is deprecated. Do not use this parameter. The Column.N.isPartitionCol parameter is used to specify whether to create a MaxCompute partitioned table. If the Column.N.isPartitionCol parameter is set to true, a MaxCompute partitioned table is created.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], + 'name' => 'DependentNodeIdList', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the node on which the node corresponding to the file depends when the DependentType parameter is set to USER_DEFINE. Multiple IDs are separated by commas (,).'."\n" + ."\n" + .'The value of this parameter corresponds to the ID of the node that you specified after you select Previous Cycle and set Depend On to Other Nodes in the Dependencies section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", 'type' => 'string', 'required' => false, 'example' => '5,10,15,20'], ], [ - 'name' => 'ClientToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'reserved', - ], + 'name' => 'InputList', + 'in' => 'formData', + 'schema' => ['description' => 'The output name of the parent file on which the current file depends. If you specify multiple output names, separate them with commas (,).'."\n" + ."\n" + .'This parameter corresponds to the Parent Nodes parameter that is displayed after you select Same Cycle in the Dependencies section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n" + ."\n" + .'> You must configure this parameter when you call the CreateDISyncTask or UpdateFile operation to create a batch synchronization task.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'project_root,project.file1,project.001_out'], ], [ - 'name' => 'Schema', - 'in' => 'query', - 'allowEmptyValue' => false, + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the DataWorks workspace. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace Management page to obtain the workspace name.'."\n" + ."\n" + .'You must configure this parameter or the ProjectId parameter to determine the DataWorks workspace to which the operation is applied.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dw_project'], + ], + [ + 'name' => 'FileId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the file. You can call the [ListFiles](~~173942~~) operation to obtain the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '100000001'], + ], + [ + 'name' => 'OutputList', + 'in' => 'formData', + 'schema' => ['description' => 'The output name of the current file.'."\n" + ."\n" + .'This parameter corresponds to the Output Name parameter in the Dependencies section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", 'type' => 'string', 'required' => false, 'example' => 'dw_project.ods_user_info_d'], + ], + [ + 'name' => 'ResourceGroupIdentifier', + 'in' => 'formData', + 'schema' => ['description' => 'The identifier of the resource group that is used to run the node. You can call the [ListResourceGroups](~~173913~~) operation to query the available resource groups in the workspace.'."\n", 'type' => 'string', 'required' => false, 'example' => 'default_group'], + ], + [ + 'name' => 'ConnectionName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the connected data source that is used to run the node. You can call the [ListDataSources](~~211431~~) operation to query the available data sources of the workspace.'."\n", 'type' => 'string', 'required' => false, 'example' => 'odps_first'], + ], + [ + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the file owner.'."\n", 'type' => 'string', 'required' => false, 'example' => '18023848927592'], + ], + [ + 'name' => 'AutoParsing', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether the automatic parsing feature is enabled for the file. Valid values:'."\n" + ."\n" + .'* true: The automatic parsing feature is enabled for the file.'."\n" + .'* false: The automatic parsing feature is not enabled for the file.'."\n" + ."\n" + .'This parameter corresponds to the Analyze Code parameter that is displayed after Same Cycle is selected in the Dependencies section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'SchedulerType', + 'in' => 'formData', 'schema' => [ - 'description' => 'The schema information of the table. You need to enter the schema information of the table if you enable the table schema in MaxCompute.'."\n", + 'description' => 'The scheduling type of the node. Valid values:'."\n" + ."\n" + .'* NORMAL: The node is an auto triggered node.'."\n" + .'* MANUAL: The node is a manually triggered node. Manually triggered nodes cannot be automatically triggered. They correspond to the nodes in the Manually Triggered Workflows pane.'."\n" + .'* PAUSE: The node is a paused node.'."\n" + .'* SKIP: The node is a dry-run node. Dry-run nodes are started as scheduled, but the system sets the status of the nodes to successful when it starts to run them.'."\n", 'type' => 'string', 'required' => false, - 'example' => 'default', + 'example' => 'NORMAL', + 'enum' => ['NORMAL', 'SKIP', 'PAUSE', 'MANUAL'], ], ], [ - 'name' => 'Columns', - 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The list of fields. A maximum of 1,000 fields are supported.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The field.'."\n", - 'type' => 'object', - 'properties' => [ - 'ColumnNameCn' => [ - 'description' => 'The display name of the field.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'columnName in chinese', - ], - 'ColumnName' => [ - 'description' => 'The name of the field. You can configure a maximum of 1,000 fields when you call the CreateTable operation to create a table.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'columnName1', - ], - 'Comment' => [ - 'description' => 'The comment of the field.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'comment', - ], - 'ColumnType' => [ - 'description' => 'The data type of the field. For information about supported data types, see [Data type editions](~~27821~~) in MaxCompute documentation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'string', - ], - 'SeqNumber' => [ - 'description' => 'The sequence number of the field. You can use this parameter to specify how fields are sorted in a table. By default, fields are sorted based on the order in which requests are created. If the field is a partition field, this parameter is not supported.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'Length' => [ - 'description' => 'The length of the field. For more information, see [MaxCompute data type editions](~~159541~~).'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - 'IsPartitionCol' => [ - 'description' => 'Specifies whether the field is a partition field.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - 'required' => false, - ], - 'required' => true, - 'maxItems' => 1000, - ], + 'name' => 'AdvancedSettings', + 'in' => 'formData', + 'schema' => ['description' => 'The advanced configurations of the node.'."\n" + ."\n" + .'This parameter is valid only for an EMR Spark Streaming node or an EMR Streaming SQL node. This parameter corresponds to the Advanced Settings tab of the node in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n" + ."\n" + .'This parameter is configured in the JSON format.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"queue":"default","SPARK_CONF":"--conf spark.driver.memory=2g"}'], ], [ - 'name' => 'Themes', + 'name' => 'StartImmediately', 'in' => 'formData', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The list of themes.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'ThemeId' => [ - 'description' => 'The theme ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '101', - ], - 'ThemeLevel' => [ - 'description' => 'The level that corresponds to the theme ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '101', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 100, - ], + 'schema' => ['description' => 'Specifies whether to immediately run a node after the node is deployed to the production environment. Valid values:'."\n" + ."\n" + .'* true: A node is immediately run after the node is deployed to the production environment.'."\n" + .'* false: A node is not immediately run after the node is deployed to the production environment.'."\n" + ."\n" + .'This parameter is valid only for an EMR Spark Streaming node or an EMR Streaming SQL node. This parameter corresponds to the Start Method parameter in the Schedule section of the Configure tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'InputParameters', + 'in' => 'formData', + 'schema' => ['description' => 'The input parameters of the node. This parameter is configured in the JSON format. For more information about the input parameters, refer to the InputContextParameterList parameter in the Response parameters section of the [GetFile](~~173954~~) operation.'."\n" + ."\n" + .'This parameter corresponds to the Input Parameters table in the Input and Output Parameters section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", 'type' => 'string', 'required' => false, 'example' => '[{"ValueSource": "project_001.first_node:bizdate_param","ParameterName": "bizdate_input"}]'], + ], + [ + 'name' => 'OutputParameters', + 'in' => 'formData', + 'schema' => ['description' => 'The output parameters of the node. This parameter is configured in the JSON format. For more information about the output parameters, refer to the OutputContextParameterList parameter in the Response parameters section of the [GetFile](~~173954~~) operation.'."\n" + ."\n" + .'This parameter corresponds to the Output Parameters table in the Input and Output Parameters section of the Properties tab in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", 'type' => 'string', 'required' => false, 'example' => '[{"Type": 1,"Value": "${bizdate}","ParameterName": "bizdate_param"}]'], + ], + [ + 'name' => 'IgnoreParentSkipRunningProperty', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to skip the dry-run property of the ancestor nodes of the node. This parameter corresponds to the Skip the dry-run property of the ancestor node parameter that is displayed after you configure the Depend On parameter in the Dependencies section of the Properties tab in the DataWorks console.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'ApplyScheduleImmediately', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether scheduling configurations immediately take effect after the node is deployed.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'Timeout', + 'in' => 'formData', + 'schema' => ['description' => 'The timeout period.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'ImageId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the custom image.'."\n", 'type' => 'string', 'required' => false, 'example' => 'm-uf6d7npxk1hhek8ng0cb'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'description' => '', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'abcdef', - ], - 'TaskInfo' => [ - 'description' => 'The information about the request task. After a request task is submitted, it is divided into multiple subtasks that are run in sequence. After the current subtask is complete, the next subtask starts to run. After all subtasks are complete, the request task is complete.'."\n" - ."\n" - .'If a request task is aborted due to one of the following issues, address the issue based on the error code and initiate the request task again:'."\n" - ."\n" - .'* The request task fails to be submitted.'."\n" - .'* After the request task is submitted, a subtask fails to run.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status of the current subtask. Valid values:'."\n" - ."\n" - .'* operating: The subtask is running.'."\n" - .'* success: The subtask succeeds.'."\n" - .'* failure: The subtask fails to run. For more information about the error details, see the Content parameter.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'NextTaskId' => [ - 'description' => 'The ID of the subtask that you want to run. If this parameter is left empty, all subtasks are complete.'."\n", - 'type' => 'string', - 'example' => 'abc1', - ], - 'TaskId' => [ - 'description' => 'The ID of the current subtask.'."\n", - 'type' => 'string', - 'example' => 'abc', - ], - 'Content' => [ - 'description' => 'The details about the status of the current subtask.'."\n" - ."\n" - .'* If the current subtask is successful, success is returned.'."\n" - .'* If the current subtask fails, the error details are displayed.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - ], - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorMessage' => ['description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'The connection does not exist.'], + 'RequestId' => ['description' => 'The ID of the request. You can use the ID to troubleshoot issues.'."\n", 'type' => 'string', 'example' => '0000-ABCD-EFGH-IJKLMNOPQ'], + 'ErrorCode' => ['description' => 'The error code returned.'."\n", 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists'], + 'Success' => ['description' => 'Indicates whether the request is successful. Valid values:'."\n" + ."\n" + .'* true: The request is successful.'."\n" + .'* false: The request fails.'."\n", 'type' => 'boolean', 'example' => 'true'], ], ], ], ], 'errorCodes' => [ 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], ], 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], ], ], - 'staticInfo' => [ - 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"abcdef\\",\\n \\"TaskInfo\\": {\\n \\"Status\\": \\"success\\",\\n \\"NextTaskId\\": \\"abc1\\",\\n \\"TaskId\\": \\"abc\\",\\n \\"Content\\": \\"success\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n \\n success\\n abc\\n success\\n abc1\\n \\n abcdef\\n","errorExample":""}]', - 'title' => 'CreateTable', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFGH-IJKLMNOPQ\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n The connection does not exist.\\n 0000-ABCD-EFGH-IJKLMNOPQ\\n Invalid.Tenant.ConnectionNotExists\\n true\\n","errorExample":""}]', + 'title' => 'UpdateFile', + 'summary' => 'Updates a file.', + 'description' => 'When you debug or call this operation, you must specify new values for the specified parameters to ensure that the values are different from the original configurations of the file. For example, if the original value of a parameter is A, you must change the value of this parameter to B before you commit the node. If you set the parameter to A, an exception that indicates invalid data occurs.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CheckFileDeployment' => [ - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2025-04-07T07:19:57.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-02-08T09:17:18.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-12-13T08:36:52.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-09-02T08:43:19.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-04-03T03:44:59.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-07-14T05:38:33.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-04-25T06:32:09.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'UpdateFolder' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -61140,217 +38960,198 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'abilityTreeCode' => '78171', - 'abilityTreeNodes' => [ - 'FEATUREdide4AR6E0', - 'FEATUREdide8FM783', - ], + 'abilityTreeCode' => '78373', + 'abilityTreeNodes' => ['FEATUREdide8FM783'], ], 'parameters' => [ [ - 'name' => 'CheckerInstanceId', + 'name' => 'ProjectId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the instance to which the file checker belongs. You can obtain the ID from the CheckerInstanceId parameter in the check event logs returned by DataWorks.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '66_123455623_2', - ], + 'schema' => ['description' => 'The ID of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Management page to obtain the ID. You must specify either this parameter or ProjectIdentifier to determine the DataWorks workspace to which the operation is applied.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10000'], ], [ - 'name' => 'Status', + 'name' => 'ProjectIdentifier', 'in' => 'formData', - 'schema' => [ - 'description' => 'The check status of the file that you want to deploy. Valid values:'."\n" - ."\n" - .'* OK: The file passes the check.'."\n" - .'* WARN: The file passes the check, but an alert is reported.'."\n" - .'* FAIL: The file fails the check.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'OK', - 'enum' => [ - 'OK', - 'FAIL', - 'WARN', - ], - ], + 'schema' => ['description' => 'The name of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Settings panel to obtain the name. You must specify either this parameter or ProjectId to determine the DataWorks workspace to which the operation is applied.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dw_project'], ], [ - 'name' => 'CheckDetailUrl', + 'name' => 'FolderId', 'in' => 'formData', - 'schema' => [ - 'description' => 'This parameter is deprecated.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://result.aliyun.com/?checkerInstanceId=', - ], + 'schema' => ['description' => 'The ID of the folder. You can call the [ListFolders](~~173955~~) operation to query the ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2735c2c19d58'], + ], + [ + 'name' => 'FolderName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the folder.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MySecondFolder'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => '', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID. You can use the ID to troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '86d5a5ac-0cc0-4c5f-a374-a15713b252ab', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'ErrorMessage' => ['description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'The connection does not exist.'], + 'RequestId' => ['description' => 'The ID of the request. You can use the ID to troubleshoot issues.'."\n", 'type' => 'string', 'example' => '0000-ABCD-EFG****'], + 'ErrorCode' => ['description' => 'The error code returned.'."\n", 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists'], + 'Success' => ['description' => 'Indicates whether the request is successful.'."\n", 'type' => 'boolean', 'example' => 'true'], ], - 'description' => '', ], ], ], 'errorCodes' => [ 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', - ], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], ], 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', - ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', - ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', - ], + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"86d5a5ac-0cc0-4c5f-a374-a15713b252ab\\"\\n}","errorExample":""},{"type":"xml","example":"86d5a5ac-0cc0-4c5f-a374-a15713b252ab","errorExample":""}]', - 'title' => 'CheckFileDeployment', - 'summary' => 'Returns the check events of a file. After you commit your file that is created on the DataStudio page, the system checks the file and returns check events before the system deploys the file. You must determine whether the check can be continued based on the events. You can call this operation to return the check events for the file that you want to deploy to DataWorks.', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"\\n 200\\n The connection does not exist.\\n 0000-ABCD-EFG****\\n Invalid.Tenant.ConnectionNotExists\\n true\\n","errorExample":""}]', + 'title' => 'UpdateFolder', + 'summary' => 'Updates a folder.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'ListRefDISyncTasks' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'UpdateIDEEventResult' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'PrivateKey' => [], - ], - [ - 'APP' => [], - ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', + 'abilityTreeCode' => '101717', + 'abilityTreeNodes' => ['FEATUREdide6ZPSGN'], ], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '10000000000', - 'minimum' => '1', - 'example' => '10000', - ], + 'name' => 'MessageId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The message ID. You can obtain the ID from a received message when an extension point event is triggered.'."\n", 'type' => 'string', 'required' => false, 'example' => '8abcb91f-d266-4073-b907-2ed670378ed1'], ], [ - 'name' => 'DatasourceName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the data source. You can call the [ListDataSources](~~211431~~) operation to query the name of the data source.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mysql_datasource', - ], + 'name' => 'ExtensionCode', + 'in' => 'formData', + 'schema' => ['description' => 'The unique identifier of the extension. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Extensions tab of the Open Platform page to view the identifier.'."\n", 'type' => 'string', 'required' => false, 'example' => '8abcb91f-d266-4073-b907-2ed670378ed1'], ], [ - 'name' => 'TaskType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the synchronization task that you want to query. Valid values:'."\n" - ."\n" - .'* DI_OFFLINE: batch synchronization task'."\n" - .'* DI_REALTIME: real-time synchronization task'."\n" - ."\n" - .'You can call the ListRefDISyncTasks operation to query only one type of the task.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'DI_OFFLINE', - ], + 'name' => 'CheckResult', + 'in' => 'formData', + 'schema' => ['description' => 'The check status of the extension point event. Valid values:'."\n" + ."\n" + .'* OK: The event passes the check.'."\n" + .'* FAIL: The event fails to pass the check. You must check and handle the reported error at the earliest opportunity to ensure that your program is run as expected.'."\n" + .'* WARN: The event passes the check, but an alert is reported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'OK'], ], [ - 'name' => 'RefType', - 'in' => 'query', + 'name' => 'CheckResultTip', + 'in' => 'formData', + 'schema' => ['description' => 'The summary information of the check result. The information is displayed in DataStudio. If an alert is reported or the event fails the check, you can troubleshoot errors based on the information.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Succeeded'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The condition used to filter synchronization tasks. Valid values:'."\n" - ."\n" - .'* from: queries the synchronization tasks that use the data source as the source.'."\n" - .'* to: queries the synchronization tasks that use the data source as the destination.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'from', + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '8abcb91f-d266-4073-b907-2ed670378ed1'], + ], ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"8abcb91f-d266-4073-b907-2ed670378ed1\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 8abcb91f-d266-4073-b907-2ed670378ed1\\n","errorExample":""}]', + 'title' => 'UpdateIDEEventResult', + 'summary' => 'Returns the check result of an extension point event to DataStudio after the extension point event is triggered during data development and checked by an extension.', + 'description' => "\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateIDEEventResult'], + ], + ], + 'ramActions' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Valid values: 1 to 100.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'UpdateMetaCategory' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'maximum' => '100000', - 'minimum' => '1', - 'example' => '100', - 'default' => '100', - ], + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '78374', + 'abilityTreeNodes' => ['FEATUREdideRZEBFC'], + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the category.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'category name ', 'title' => ''], + ], + [ + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => ['description' => 'The remarks of the category.'."\n", 'type' => 'string', 'required' => false, 'example' => 'category name', 'title' => ''], + ], + [ + 'name' => 'CategoryId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the category.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '2', 'title' => ''], ], ], 'responses' => [ @@ -61358,494 +39159,206 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => '0bc1411515937635973****', - ], - 'Data' => [ - 'description' => 'The returned result.'."\n", - 'type' => 'object', - 'properties' => [ - 'DISyncTasks' => [ - 'description' => 'The details of the synchronization tasks. In most cases, a data source is used by multiple synchronization tasks. Therefore, the value of this parameter is an array. The following parameters are the elements in the array. The sample values of these parameters show the details of a synchronization task.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'DiSourceDatasource' => [ - 'description' => 'The source of the synchronization task. If the synchronization task has multiple sources, the return value is a JSON array, such as \\\\"odps_writer\\\\", \\\\"mysql\\\\". If the RefType parameter is set to from, the synchronization tasks that use the specified data source as the source are returned. In this case, the value of this parameter indicates the specified data source.'."\n", - 'type' => 'string', - 'example' => '[\\"odps_writer\\"]', - ], - 'TaskType' => [ - 'description' => 'The type of the synchronization task. Valid values:'."\n" - ."\n" - .'* DI_OFFLINE: batch synchronization task'."\n" - .'* DI_REALTIME: real-time synchronization task'."\n", - 'type' => 'string', - 'example' => 'DI_OFFLINE', - ], - 'DiDestinationDatasource' => [ - 'description' => 'The destination of the synchronization task. If the synchronization task has multiple destinations, the return value is a JSON array, such as \\\\"odps_writer\\\\", \\\\"mysql\\\\". If the RefType parameter is set to to, the synchronization tasks that use the specified data source as the destination are returned. In this case, the value of this parameter indicates the specified data source.'."\n", - 'type' => 'string', - 'example' => '[\\"qcc_polardb2\\"]', - ], - 'NodeName' => [ - 'description' => 'The name of the synchronization task.'."\n", - 'type' => 'string', - 'example' => 'abcd1234', - ], - 'NodeId' => [ - 'description' => 'The ID of the synchronization task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100000', - ], - ], - ], - ], - ], - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the category is updated.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0bc1ec92159376', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The connection does not exist.', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'Invalid.DI.Parameter', - 'errorMessage' => 'The parameter is invalid.', - ], - [ - 'errorCode' => 'Invalid.DI.Parameter.File.Existed', - 'errorMessage' => 'The file name already exists.', - ], + ['errorCode' => 'Invalid.Meta.CategoryIllegalDepth', 'errorMessage' => 'A category can contain a maximum of 4 levels.', 'description' => 'A category can contain a maximum of 4 levels.'], + ['errorCode' => 'Invalid.Meta.CategoryNameDuplicate', 'errorMessage' => 'The category name is duplicated at this level.', 'description' => 'The category name is duplicated at this level.'], + ['errorCode' => 'Invalid.Meta.TableNotExist', 'errorMessage' => 'The table does not exist.', 'description' => 'The table does not exist.'], + ['errorCode' => 'InvalidParameter.Meta.CommonError', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The request parameter is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.Illegal', 'errorMessage' => 'The app guid parameter is invalid.', 'description' => 'The app guid parameter is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.IllegalDate', 'errorMessage' => 'The date format is invalid.', 'description' => 'The date format is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.IllegalPageError', 'errorMessage' => 'The parameter for paging is invalid.', 'description' => 'The parameter for paging is invalid.'], + ['errorCode' => 'InvalidParameter.Meta.NotExist', 'errorMessage' => 'The object does not exist.', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'Forbidden.DI.NoPrivilege', - 'errorMessage' => 'No access.', - ], + ['errorCode' => 'Forbidden.Meta.NoTenant', 'errorMessage' => 'The user is not the owner of any tenants.', 'description' => 'The user is not the owner of any tenants.'], + ['errorCode' => 'Invalid.Meta.CategoryForbidden', 'errorMessage' => 'Failed to delete the category. The current category is associated with a table and cannot be operated.', 'description' => 'Failed to delete the category because the table associated with the category does not exist.'], + ['errorCode' => 'Invalid.Meta.CategoryIllegalTenant', 'errorMessage' => 'The tenant ID is different in the parent and child categories.', 'description' => 'The tenant ID is different in the parent and child categories.'], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.DI.Parameter', - 'errorMessage' => 'A DI internal error occurred.', - ], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.Meta.NoCalcEngine', 'errorMessage' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.', 'description' => ''], + ['errorCode' => 'InternalError.Meta.TenantTimeOut', 'errorMessage' => 'Failed to connect to the interface network.', 'description' => 'Failed to connect to the interface network.'], + ['errorCode' => 'InternalError.Meta.Unknown', 'errorMessage' => 'An unknown error occurred while processing your request.', 'description' => 'An unknown error occurred while processing your request.'], + ['errorCode' => 'Invalid.Meta.CategoryRelationDuplicate"', 'errorMessage' => 'The table is already bound to the category.', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0bc1411515937635973****\\",\\n \\"Data\\": {\\n \\"DISyncTasks\\": [\\n {\\n \\"DiSourceDatasource\\": \\"[\\\\\\\\\\\\\\"odps_writer\\\\\\\\\\\\\\"]\\",\\n \\"TaskType\\": \\"DI_OFFLINE\\",\\n \\"DiDestinationDatasource\\": \\"[\\\\\\\\\\\\\\"qcc_polardb2\\\\\\\\\\\\\\"]\\",\\n \\"NodeName\\": \\"abcd1234\\",\\n \\"NodeId\\": 100000\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListRefDISyncTasks', - 'summary' => 'Queries synchronization tasks in Data Integration that use a specific data source.', - ], - 'ExportDataSources' => [ - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'UpdateMetaCategory', + 'summary' => 'Updates a category.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' UpdateMetaCategory接口的使用示例Demo请参见[DataWorks OpenAPI示例](https://developer.aliyun.com/article/780879?groupCode=dataworks)。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'UpdateMetaCollection' => [ + 'summary' => 'Updates the name and comment of a collection.', + 'methods' => ['put', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], - [ - 'APP' => [], - ], - [ - 'PrivateKey' => [], - ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', + 'abilityTreeCode' => '163134', + 'abilityTreeNodes' => ['FEATUREdideE9XYA6'], ], 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'QualifiedName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the DataWorks workspace to which the data sources belong. You can call the [ListProjects](~~178393~~) operation to query the ID of the workspace.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '10000000000', - 'minimum' => '1', - 'example' => '10000', - ], + 'schema' => ['description' => 'The unique identifier of the collection.', 'type' => 'string', 'required' => true, 'example' => 'album.396397', 'title' => ''], ], [ 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The keyword contained in the names of the data sources that you want to export. You can specify only one keyword. For example, if you set this parameter to test, you can call the ExportDataSources operation to export all data sources whose names contain test in the workspace.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'test', - ], - ], - [ - 'name' => 'DataSourceType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the data source. Valid values:'."\n" - ."\n" - .'* odps'."\n" - .'* mysql'."\n" - .'* rds'."\n" - .'* oss'."\n" - .'* sqlserver'."\n" - .'* polardb'."\n" - .'* oracle'."\n" - .'* mongodb'."\n" - .'* emr'."\n" - .'* postgresql'."\n" - .'* analyticdb_for_mysql'."\n" - .'* hybriddb_for_postgresql'."\n" - .'* holo'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - ], - ], - [ - 'name' => 'SubType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The subtype of the data source. This parameter takes effect only when the DataSourceType parameter is set to rds.'."\n" - ."\n" - .'If the value of the DataSourceType parameter is rds, the value of this parameter can be mysql, sqlserver, or postgresql.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mysql', - ], - ], - [ - 'name' => 'EnvType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The environment in which the data source resides. Valid values:'."\n" - ."\n" - .'* 0: development environment'."\n" - .'* 1: production environment'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'example' => '10', - 'default' => '10', - ], + 'schema' => ['description' => 'The name of the collection.', 'type' => 'string', 'required' => false, 'example' => 'myCollectionName', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'Comment', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Pages start from page 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'The comment of the collection. The comment must be 1 to 64 characters in length.', 'type' => 'string', 'required' => false, 'example' => 'this is a comment', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned. Valid values:'."\n" - ."\n" - .'* 200: The request was successful.'."\n" - .'* Other values: The request failed. You can troubleshoot issues based on the HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => '0bc14115159376359****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.', 'type' => 'string', 'example' => '0000-ABCD-E****'], + 'Status' => [ + 'description' => 'The result of the operation. Valid values: true false', + 'enumValueTitles' => [], 'type' => 'boolean', 'example' => 'true', + 'title' => '', ], - 'Data' => [ - 'description' => 'The information about the exported data sources.'."\n", - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number. Pages start from page 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'DataSources' => [ - 'description' => 'The details of the exported data sources. The value is an array. The following parameters are the elements in the array. The sample values of these parameters show the details of a sample data source.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'Indicates whether the data source is available. Valid values:'."\n" - ."\n" - .'* 1: The data source is available.'."\n" - .'* 0: The data source is unavailable.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ProjectId' => [ - 'description' => 'The ID of the DataWorks workspace to which the data source belongs.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '123', - ], - 'SubType' => [ - 'description' => 'The subtype of the data source. This parameter takes effect only when the DataSourceType parameter is set to rds.'."\n" - ."\n" - .'If the value of the DataSourceType parameter is rds, the value of this parameter can be mysql, sqlserver, or postgresql.'."\n", - 'type' => 'string', - 'example' => 'mysql', - ], - 'GmtModified' => [ - 'description' => 'The time when the data source was last modified. Example: Mar 17, 2021 4:09:32 PM.'."\n", - 'type' => 'string', - 'example' => 'Mar 17, 2021 4:09:32 PM', - ], - 'EnvType' => [ - 'description' => 'The environment in which the data source resides. Valid values:'."\n" - ."\n" - .'* 0: development environment'."\n" - .'* 1: production environment'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ConnectStatus' => [ - 'description' => 'Indicates whether the data source is connected to an exclusive resource group. Valid values:'."\n" - ."\n" - .'* 1: The data source is connected to at least one exclusive resource group.'."\n" - .'* 0: The data source is not connected to any exclusive resource group.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Sequence' => [ - 'description' => 'The sequence number of the data source.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '300', - ], - 'Description' => [ - 'description' => 'The description of the data source.'."\n", - 'type' => 'string', - 'example' => 'a connection', - ], - 'DataSourceType' => [ - 'description' => 'The type of the data source. Valid values:'."\n" - ."\n" - .'* odps'."\n" - .'* mysql'."\n" - .'* rds'."\n" - .'* oss'."\n" - .'* sqlserver'."\n" - .'* polardb'."\n" - .'* oracle'."\n" - .'* mongodb'."\n" - .'* emr'."\n" - .'* postgresql'."\n" - .'* analyticdb_for_mysql'."\n" - .'* hybriddb_for_postgresql'."\n" - .'* holo'."\n", - 'type' => 'string', - 'example' => 'rds', - ], - 'GmtCreate' => [ - 'description' => 'The time when the data source was created. Example: Mar 17, 2021 4:09:32 PM.'."\n", - 'type' => 'string', - 'example' => 'Mar 17, 2021 4:09:32 PM', - ], - 'DefaultEngine' => [ - 'description' => 'Indicates whether the compute engine that is added as the data source is the default compute engine. Valid values:'."\n" - ."\n" - .'* true: The compute engine is the default compute engine.'."\n" - .'* false: The compute engine is not the default compute engine.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'Shared' => [ - 'description' => 'Indicates whether the data source can be shared. Valid values:'."\n" - ."\n" - .'* true: The data source can be shared.'."\n" - .'* false: The data source cannot be shared.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'Operator' => [ - 'description' => 'The ID of the user who exported the data source.'."\n", - 'type' => 'string', - 'example' => '193543050****', - ], - 'Name' => [ - 'description' => 'The name of the data source.'."\n", - 'type' => 'string', - 'example' => 'abc', - ], - 'Content' => [ - 'description' => 'The configuration of the data source.'."\n", - 'type' => 'string', - 'example' => '{"pubEndpoint":"http://service.cn.maxcompute.aliyun.com/api","accessId":"TMP.3KecGjvzy3i8MYfn2BGHgF7EHGyBFZcHm7GgngrABVRyvvKQrfF5kskR36xP361C3dqwbGo7SGYptAeGyiTwHXqLaBUvYC","securityToken":null,"endpoint":"http://service.cn.maxcompute.aliyun-inc.com/api","accessKey":"***","name":"PRE_PROJECT_A_engine","project":"PRE_PROJECT_A","vpcEndpoint":"http://service.cn.maxcompute.aliyun-inc.com/api","region":"cn-shanghai","authType":"2"}', - ], - 'Id' => [ - 'description' => 'The data source ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'BindingCalcEngineId' => [ - 'description' => 'The ID of the compute engine that is added as the data source.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '123', - ], - 'TenantId' => [ - 'description' => 'The ID of the Alibaba Cloud account to which the data source belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234567', - ], - ], - ], - ], - ], - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'The specified product does not exist.', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '9999', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true: The request was successful.'."\n" + ."\n" + .'- false: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], - 'description' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Invalid.DI.Parameter', - 'errorMessage' => 'The parameter is invalid.', - ], - ], - 403 => [ - [ - 'errorCode' => 'Forbidden.DI.NoPrivilege', - 'errorMessage' => 'No access.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError.DI.Parameter', - 'errorMessage' => 'A DI internal error occurred.', - ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0000-ABCD-E****\\",\\n \\"Status\\": true,\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The specified product does not exist.\\",\\n \\"ErrorCode\\": \\"9999\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'UpdateMetaCollection', + 'description' => 'Only the Name and Comment fields can be updated.', + 'requestParamsDescription' => 'You must specify at least one of the Name and Comment parameters when you call this operation.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateMetaCollection'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0bc14115159376359****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 10,\\n \\"PageSize\\": 1,\\n \\"TotalCount\\": 100,\\n \\"DataSources\\": [\\n {\\n \\"Status\\": 1,\\n \\"ProjectId\\": 123,\\n \\"SubType\\": \\"mysql\\",\\n \\"GmtModified\\": \\"Mar 17, 2021 4:09:32 PM\\",\\n \\"EnvType\\": 1,\\n \\"ConnectStatus\\": 1,\\n \\"Sequence\\": 300,\\n \\"Description\\": \\"a connection\\",\\n \\"DataSourceType\\": \\"rds\\",\\n \\"GmtCreate\\": \\"Mar 17, 2021 4:09:32 PM\\",\\n \\"DefaultEngine\\": false,\\n \\"Shared\\": false,\\n \\"Operator\\": \\"193543050****\\",\\n \\"Name\\": \\"abc\\",\\n \\"Content\\": \\"{\\\\\\"pubEndpoint\\\\\\":\\\\\\"http://service.cn.maxcompute.aliyun.com/api\\\\\\",\\\\\\"accessId\\\\\\":\\\\\\"TMP.3KecGjvzy3i8MYfn2BGHgF7EHGyBFZcHm7GgngrABVRyvvKQrfF5kskR36xP361C3dqwbGo7SGYptAeGyiTwHXqLaBUvYC\\\\\\",\\\\\\"securityToken\\\\\\":null,\\\\\\"endpoint\\\\\\":\\\\\\"http://service.cn.maxcompute.aliyun-inc.com/api\\\\\\",\\\\\\"accessKey\\\\\\":\\\\\\"***\\\\\\",\\\\\\"name\\\\\\":\\\\\\"PRE_PROJECT_A_engine\\\\\\",\\\\\\"project\\\\\\":\\\\\\"PRE_PROJECT_A\\\\\\",\\\\\\"vpcEndpoint\\\\\\":\\\\\\"http://service.cn.maxcompute.aliyun-inc.com/api\\\\\\",\\\\\\"region\\\\\\":\\\\\\"cn-shanghai\\\\\\",\\\\\\"authType\\\\\\":\\\\\\"2\\\\\\"}\\",\\n \\"Id\\": 1,\\n \\"BindingCalcEngineId\\": 123,\\n \\"TenantId\\": 1234567\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"0bc14115159376359****\\n200\\n\\n 100\\n 1\\n 10\\n \\n 1\\n 193543050****\\n 1\\n mysql\\n a connection\\n 123\\n 123\\n Mar 17, 2021 4:09:32 PM\\n 300\\n false\\n 1\\n abc\\n false\\n 1234567\\n Mar 17, 2021 4:09:32 PM\\n {\\"pubEndpoint\\":\\"http://service.cn.maxcompute.aliyun.com/api\\",\\"accessId\\":\\"TMP.3KecGjvzy3i8MYfn2BGHgF7EHGyBFZcHm7GgngrABVRyvvKQrfF5kskR36xP361C3dqwbGo7SGYptAeGyiTwHXqLaBUvYC\\",\\"securityToken\\":null,\\"endpoint\\":\\"http://service.cn.maxcompute.aliyun-inc.com/api\\",\\"accessKey\\":\\"***\\",\\"name\\":\\"PRE_PROJECT_A_engine\\",\\"project\\":\\"PRE_PROJECT_A\\",\\"vpcEndpoint\\":\\"http://service.cn.maxcompute.aliyun-inc.com/api\\",\\"region\\":\\"cn-shanghai\\",\\"authType\\":\\"2\\"}\\n rds\\n 1\\n \\n\\ntrue","errorExample":""}]', - 'title' => 'ExportDataSources', - 'summary' => 'Exports a list of data sources.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'ramActions' => [], ], - 'ImportDataSources' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateMetaTable' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '78375', + 'abilityTreeNodes' => ['FEATUREdideRZEBFC'], + ], + 'parameters' => [ [ - 'APP' => [], + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The DataWorks workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '101', 'title' => ''], ], [ - 'PrivateKey' => [], + 'name' => 'TableName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the table.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'table1', 'title' => ''], + ], + [ + 'name' => 'EnvType', + 'in' => 'query', + 'schema' => ['description' => 'The environment of the DataWorks workspace. Valid values: 0 and 1. The value 0 indicates the development environment. The value 1 indicates the production environment.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'TableGuid', + 'in' => 'query', + 'schema' => ['description' => 'The GUID of the table. Specify the GUID in the format of odps.{projectName}.{tableName}.', 'type' => 'string', 'required' => false, 'example' => 'odps.test.table1', 'title' => ''], + ], + [ + 'name' => 'NewOwnerId', + 'in' => 'query', + 'schema' => ['description' => 'The new owner ID. If you leave this parameter empty, the owner ID is not updated.', 'type' => 'string', 'required' => false, 'example' => '12345', 'title' => ''], + ], + [ + 'name' => 'AddedLabels', + 'in' => 'formData', + 'schema' => ['description' => 'The names of the labels that you want to add. Separate the labels with commas (,).', 'type' => 'string', 'required' => false, 'example' => 'a,b,c', 'title' => ''], + ], + [ + 'name' => 'RemovedLabels', + 'in' => 'formData', + 'schema' => ['description' => 'The names of labels that you want to remove. Separate the labels with commas (,).', 'type' => 'string', 'required' => false, 'example' => 'a,b,c', 'title' => ''], + ], + [ + 'name' => 'CategoryId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the category that you want to associate.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '101', 'title' => ''], + ], + [ + 'name' => 'Visibility', + 'in' => 'query', + 'schema' => ['description' => 'The scope in which the table is visible. Valid values: 0, 1, and 2. The value 0 indicates that the table is invisible to all members. The value 1 indicates that the table is visible to all members. The value 2 indicates that the table is visible to workspace members.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '100', 'minimum' => '0', 'example' => '1', 'title' => ''], ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [], - 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'Caption', 'in' => 'query', - 'schema' => [ - 'description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '10000000000', - 'minimum' => '1', - 'example' => '10000', - ], + 'schema' => ['description' => 'The display name of the table.', 'type' => 'string', 'required' => false, 'example' => '中文名', 'title' => ''], ], [ - 'name' => 'DataSources', + 'name' => 'Schema', 'in' => 'query', - 'schema' => [ - 'description' => 'The configurations of the data sources that you want to import. The Name, DataSourceType, SubType, Description, Content, and EnvType parameters are required. For more information about the parameters, see [CreateDataSource](~~211429~~).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '[{"SubType":"","DataSourceType":"mysql","EnvType":1,"Name":"mysql_dms2","Description":"aaa","Content":"{\\"database\\":\\"mysql_chengdu_old\\",\\"password\\":\\"***\\",\\"instanceName\\":\\"rm-2vcrckb37163g7l3w\\",\\"regionId\\":\\"cn-chengdu\\",\\"tag\\":\\"rds\\",\\"rdsOwnerId\\":\\"333\\",\\"username\\":\\"mysql_chengdu2\\"}"},{"SubType":"","DataSourceType":"mysql","EnvType":1,"Name":"mysql_dms2","Description":"aaa","Content":"{\\"database\\":\\"mysql_chengdu_old\\",\\"password\\":\\"***\\",\\"instanceName\\":\\"rm-2vcrckb37163g7l3w\\",\\"regionId\\":\\"cn-chengdu\\",\\"tag\\":\\"rds\\",\\"rdsOwnerId\\":\\"143\\",\\"username\\":\\"mysql_chengdu2\\"}"}]', - ], + 'schema' => ['description' => 'The schema information about the table. You must configure this parameter if you enable the three-layer model of MaxCompute.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], ], ], 'responses' => [ @@ -61853,707 +39366,597 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => '0bc1411515937635973****', - ], - 'Data' => [ - 'description' => 'The information about the imported data sources.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'Indicates whether the data sources were imported. Valid values:'."\n" - ."\n" - .'* true: All data sources were imported.'."\n" - .'* false: Specific data sources failed to be imported. You can troubleshoot issues based on the Message parameter.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => 'The reason why the data sources failed to be imported. If the data sources were imported, this parameter is left empty.'."\n", - 'type' => 'string', - 'example' => ' Data source DEV XXX already exists', - ], - ], - ], + 'UpdateResult' => ['description' => 'Indicates whether the metadata information about the table was updated.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'abcde', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Invalid.DI.Parameter', - 'errorMessage' => 'The parameter is invalid.', - ], - ], 403 => [ - [ - 'errorCode' => 'Forbidden.DI.NoPrivilege', - 'errorMessage' => 'No access.', - ], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.DI.Parameter', - 'errorMessage' => 'A DI internal error occurred.', - ], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0bc1411515937635973****\\",\\n \\"Data\\": {\\n \\"Status\\": true,\\n \\"Message\\": \\" Data source DEV XXX already exists\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"0bc1411515937635973****\\n\\n true\\n Data source DEV XXX already exists\\n\\ntrue","errorExample":""}]', - 'title' => 'ImportDataSources', - 'summary' => 'Imports data sources from your on-premises machine to a specific DataWorks workspace.', - 'description' => 'You can import self-managed data sources or data sources that are exported from other DataWorks workspaces to a specific DataWorks workspace.'."\n" - ."\n" - .'* To import a self-managed data source to a DataWorks workspace, the data source type must be supported by DataWorks. For more information about the types of data sources supported by DataWorks, see [Supported data stores](~~181656~~).'."\n" - .'* For more information about how to export data sources from DataWorks workspaces to your on-premises machine, see [ExportDataSources](~~279570~~).'."\n", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"UpdateResult\\": true,\\n \\"RequestId\\": \\"abcde\\"\\n}","type":"json"}]', + 'title' => 'UpdateMetaTable', + 'summary' => 'This operation updates the metadata of a table.', + 'description' => 'This operation supports only MaxCompute tables.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateClusterConfigs' => [ - 'summary' => 'Updates the configurations of submodules in a workspace. You can configure SPARK parameters.', - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2022-07-19T06:35:48.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'UpdateMetaTableIntroWiki' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'abilityTreeCode' => '231401', - 'abilityTreeNodes' => [ - 'FEATUREdideDGBIGO', - ], + 'abilityTreeCode' => '78376', + 'abilityTreeNodes' => ['FEATUREdideRZEBFC'], ], 'parameters' => [ [ - 'name' => 'ClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cluster associated with DataWorks.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234', - ], - ], - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the workspace.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '5678', - ], - ], - [ - 'name' => 'ConfigType', + 'name' => 'TableGuid', 'in' => 'query', - 'schema' => [ - 'description' => 'The configuration type of the cluster. Valid values:'."\n" - ."\n" - .'* SPARK_CONF: SPARK parameters'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [], - 'example' => 'SPARK_CONF', - ], + 'schema' => ['description' => 'The GUID of the table. Specify the GUID in the odps.{projectName}.{tableName} format.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'odps.test.table1', 'title' => ''], ], [ - 'name' => 'ConfigValues', + 'name' => 'Content', 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The configuration information of the cluster submodule.', - 'type' => 'array', - 'items' => [ - 'description' => 'The configuration information of the cluster in a module.', - 'required' => false, - '$ref' => '#/components/schemas/ClusterConfig', - ], - 'required' => true, - ], + 'schema' => ['description' => 'The details of the instructions on how to use the metatable.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'abc', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'OpenApiMetaResultModel', - 'description' => 'The returned data.'."\n", + 'description' => 'The returned result.'."\n", 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => 'Indicates whether the update was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'enumValueTitles' => [], - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The ID of the request. It is used to locate logs and troubleshoot problems.', - 'type' => 'string', - 'example' => '0000-ABCD-E****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'enumValueTitles' => [], - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.', - 'type' => 'string', - 'example' => '101011005', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.', - 'type' => 'string', - 'example' => 'Invalid.Cluster.ClusterNotFound', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'UpdateResult' => ['description' => 'Indicates whether the instructions on how to use the table are updated.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. You can troubleshoot issues based on the ID.'."\n", 'type' => 'string', 'example' => 'abcde', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"0000-ABCD-E****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"101011005\\",\\n \\"ErrorMessage\\": \\"Invalid.Cluster.ClusterNotFound\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', - 'title' => 'UpdateClusterConfigs', - ], - 'ListClusterConfigs' => [ - 'summary' => 'Queries the configurations of submodules in a workspace. You can query information about SPARK parameters.', - 'methods' => [ - 'get', + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ], ], - 'schemes' => [ - 'https', + 'title' => 'UpdateMetaTableIntroWiki', + 'summary' => 'Updates the instructions on how to use a table. If no instruction on how to use the table is available, the instructions that are configured by calling this operation are added.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"UpdateResult\\": true,\\n \\"RequestId\\": \\"abcde\\"\\n}","type":"json"}]', + ], + 'UpdateNodeOwner' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '231400', - 'abilityTreeNodes' => [ - 'FEATUREdideDGBIGO', - ], + 'abilityTreeCode' => '78377', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB'], ], 'parameters' => [ [ - 'name' => 'ClusterId', - 'in' => 'query', + 'name' => 'ProjectEnv', + 'in' => 'formData', 'schema' => [ - 'description' => 'The ID of the cluster generated by DataWorks.', - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The environment in which the node runs. Valid values: DEV and PROD. The value DEV indicates the development environment, and the value PROD indicates the production environment.'."\n" + ."\n" + .'* PROD'."\n" + .'* DEV'."\n", + 'type' => 'string', 'required' => true, - 'example' => '1234', + 'docRequired' => true, + 'example' => 'PROD', + 'enum' => ['PROD', 'DEV'], ], ], [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the DataWorks workspace.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '5678', - ], + 'name' => 'NodeId', + 'in' => 'formData', + 'schema' => ['description' => 'The node ID. You can call the [ListNodes](~~173979~~) operation to query the node ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1234'], ], [ - 'name' => 'ConfigType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The configuration type of the cluster. Valid values:'."\n" - ."\n" - .'* SPARK_CONF: SPARK parameters.'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [], - 'example' => 'SPARK_CONF', - ], + 'name' => 'UserId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the Alibaba Cloud account used by the node owner. You can log on to the DataWorks console and move the pointer over the profile picture in the upper-right corner to view the ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '19337906836551', 'maxLength' => 64], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The returned data.'."\n", + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'ClusterConfigs' => [ - 'description' => 'A list of configurations of cluster modules.', - 'type' => 'array', - 'items' => [ - 'description' => 'The configuration information of a cluster on a module.', - '$ref' => '#/components/schemas/ClusterConfig', - ], - ], - 'RequestId' => [ - 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-E****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'enumValueTitles' => [], - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '101011005', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Cluster.ClusterNotFound', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], + 'RequestId' => ['description' => 'The request ID. You can use the request ID to query logs and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'E6F0DBDD-5AD****'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"ClusterConfigs\\": [\\n {\\n \\"ModuleName\\": \\"ide\\",\\n \\"ConfigValue\\": \\"{\\\\\\"spark.driver.memory\\\\\\":\\\\\\"1g\\\\\\"}\\",\\n \\"EnableOverwrite\\": false\\n }\\n ],\\n \\"RequestId\\": \\"0000-ABCD-*****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"101011005\\",\\n \\"ErrorMessage\\": \\"Invalid.Cluster.ClusterNotFound\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', - 'title' => 'ListClusterConfigs', - ], - 'ListClusters' => [ - 'summary' => 'Queries clusters that are registered in DataWorks. E-MapReduce (EMR) clusters and Cloudera\'s Distribution Including Apache Hadoop (CDH) clusters are supported.', - 'methods' => [ - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n E6F0DBDD-5AD****\\n","errorExample":""}]', + 'title' => 'UpdateNodeOwner', + 'summary' => 'Changes the owner of a node.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-08-12T08:46:56.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-08-12T08:46:56.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-08-12T08:46:56.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'UpdateNodeRunMode' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '231398', - 'abilityTreeNodes' => [ - 'FEATUREdideDGBIGO', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '78378', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB'], ], 'parameters' => [ [ - 'name' => 'ClusterType', - 'in' => 'query', + 'name' => 'ProjectEnv', + 'in' => 'formData', 'schema' => [ - 'description' => 'The type of the cluster. Valid values:'."\n" + 'description' => 'The environment in which the node runs. Valid values: DEV and PROD. The value DEV indicates the development environment, and the value PROD indicates the production environment.'."\n" ."\n" - .'* CDH: CDH cluster'."\n" - .'* EMR: EMR cluster'."\n", + .'* PROD'."\n" + .'* DEV'."\n", 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [], - 'example' => 'EMR', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Pages start from page 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + 'required' => true, + 'docRequired' => true, + 'example' => 'PROD', + 'enum' => ['PROD', 'DEV'], ], ], [ - 'name' => 'PageSize', - 'in' => 'query', + 'name' => 'NodeId', + 'in' => 'formData', + 'schema' => ['description' => 'The node ID. You can call the [ListNodes](~~173979~~) operation to query the node ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1234'], + ], + [ + 'name' => 'SchedulerType', + 'in' => 'formData', 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", + 'description' => 'The operation that you want to perform on the node. Valid values:'."\n" + ."\n" + .'* 0: indicates that you want to unfreeze the node.'."\n" + .'* 2: indicates that you want to freeze the node.'."\n", 'type' => 'integer', 'format' => 'int32', - 'required' => false, - 'example' => '10', + 'required' => true, + 'docRequired' => true, + 'example' => '0', + 'enum' => ['0', '2'], ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The returned data.'."\n", + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => 'The returns data.', - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'Clusters' => [ - 'description' => 'List of cluster information.', - 'type' => 'array', - 'items' => [ - 'description' => 'Cluster information', - '$ref' => '#/components/schemas/Cluster', - ], - ], - ], - ], - 'RequestId' => [ - 'description' => 'The request ID. You can use the request ID to query logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-E****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'enumValueTitles' => [], - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '101011005', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Cluster.ClusterNotFound', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'E6F0DBDD-5AD****'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\"\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n E6F0DBDD-5AD****\\n","errorExample":""}]', + 'title' => 'UpdateNodeRunMode', + 'summary' => 'Freezes or unfreezes a node.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-08-12T08:46:56.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-08-12T08:46:56.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-08-12T08:46:56.000Z', 'description' => 'Error codes changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Clusters\\": [\\n {\\n \\"ClusterId\\": 1234,\\n \\"ClusterBizId\\": \\"c-d8a7523****\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"0000-ABCD-E****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"101011005\\",\\n \\"ErrorMessage\\": \\"Invalid.Cluster.ClusterNotFound\\",\\n \\"HttpStatusCode\\": 200\\n}","type":"json"}]', - 'title' => 'ListClusters', - ], - 'ListEntitiesByTags' => [ - 'summary' => 'Queries a list of entities by tag. Only entities of the maxcompute-table type are supported.', - 'methods' => [ - 'get', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'UpdateQualityFollower' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, + 'operationType' => 'write', + 'deprecated' => true, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '187376', - 'abilityTreeNodes' => [ - 'FEATUREdideRZEBFC', - ], + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '78379', + 'abilityTreeNodes' => ['FEATUREdideGJ7UNJ'], ], 'parameters' => [ [ - 'name' => 'EntityType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the entity.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'maxcompute-table', - ], + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the compute engine or data source.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'autotest', 'title' => ''], ], [ - 'name' => 'Tags', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The tags.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The tag.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/UserEntityTag', - ], - 'required' => true, - 'maxItems' => 10, - ], + 'name' => 'FollowerId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the subscription.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1234', 'title' => ''], ], [ - 'name' => 'NextToken', - 'in' => 'query', - 'schema' => [ - 'description' => 'The pagination token that is used in the next request to retrieve a new page of results.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '12345', - 'default' => '0', - ], + 'name' => 'Follower', + 'in' => 'formData', + 'schema' => ['description' => 'The subscriber.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1912232****', 'title' => ''], ], [ - 'name' => 'PageSize', - 'in' => 'query', + 'name' => 'AlarmMode', + 'in' => 'formData', 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10. Valid values: 1 to 100.'."\n", + 'description' => 'The notification method. Valid values: 1 (email), 2 (email and SMS), 4 (DingTalk group chatbot), 5 (DingTalk group chatbot with an @all reminder), 6 (Lark), 7 (WeCom), 8 (webhook), and 9 (phone call).', 'type' => 'integer', 'format' => 'int32', - 'required' => false, - 'maximum' => '1000', - 'example' => '10', - 'default' => '10', + 'required' => true, + 'docRequired' => true, + 'maximum' => '99', + 'minimum' => '0', + 'enum' => ['1', '2', '4', '5', '6', '7', '8', '9'], + 'example' => '2', + 'title' => '', ], ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the DataWorks workspace. You can log on to the DataWorks console to obtain the ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '123', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'OpenApiMetaResultModel', - 'description' => 'The response parameters.'."\n", + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => 'The data returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'NextToken' => [ - 'description' => 'A pagination token. It can be used in the next request to retrieve a new page of results.'."\n", - 'type' => 'string', - 'example' => '12345', - ], - 'EntityList' => [ - 'description' => 'The entities.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The entity.'."\n", - '$ref' => '#/components/schemas/Entity', - ], - ], - ], - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-E****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'true\\'."\n" - .'false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '101011005', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Entity.EntityTypeNotSupported', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the update was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'You have no permission', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '576b9457-2cf5-4****', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '401', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'staticInfo' => [ - 'returnType' => 'synchronous', + 'substitutions' => ['dataworks-public::2024-05-18::UpdateDataQualityAlertRule'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": {\\n \\"NextToken\\": \\"12345\\",\\n \\"EntityList\\": [\\n {\\n \\"QualifiedName\\": \\"maxcompute_table.563f0357118d05ef145d6bddf2966cc23e86ca8f2f013f915e565afdf09f7a23\\",\\n \\"TenantId\\": 12345,\\n \\"EntityContent\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n }\\n ]\\n },\\n \\"RequestId\\": \\"0000-ABCD-E****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"101011005\\",\\n \\"ErrorMessage\\": \\"Invalid.Entity.EntityTypeNotSupported\\",\\n \\"HttpStatusCode\\": 200\\n}","errorExample":""},{"type":"xml","example":"\\n \\n 12345\\n \\n maxcompute_table.563f0357118d05ef145d6bddf2966cc23e86ca8f2f013f915e565afdf09f7a23\\n 12345\\n \\n \\n 0000-ABCD-E****\\n true\\n 101011005\\n Invalid.Entity.EntityTypeNotSupported\\n 200\\n","errorExample":""}]', - 'title' => 'ListEntitiesByTags', - ], - 'RemoveEntityTags' => [ - 'summary' => 'Removes tags from an entity. Only entities of the maxcompute-table type are supported.', - 'methods' => [ - 'post', + 'title' => 'UpdateQualityFollower', + 'summary' => 'Updates a subscription.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-11-15T12:29:38.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-03-08T07:46:00.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2021-11-23T03:58:45.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"You have no permission\\",\\n \\"RequestId\\": \\"576b9457-2cf5-4****\\",\\n \\"ErrorCode\\": \\"401\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'UpdateQualityRule' => [ + 'summary' => 'Updates a specified quality rule.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ - 'AK' => [], + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '78380', + 'abilityTreeNodes' => ['FEATUREdide3WJOKE'], + ], + 'parameters' => [ + [ + 'name' => 'BlockType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The strength of the quality rule. You can specify a rule as a strong or weak rule based on the importance of the rule. Valid values:'."\n" + ."\n" + .'- 1: strong rule'."\n" + ."\n" + .'- 0: weak rule'."\n" + .' If you specify a rule as a strong rule and a critical alert is triggered for the rule, the scheduling of the associated task is blocked.', + 'enumValueTitles' => [], + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '1', + 'minimum' => '0', + 'enum' => ['0', '1'], + 'example' => '0', + 'title' => '', + ], + ], + [ + 'name' => 'EntityId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the partition filter expression. You can call the [ListQualityRules](~~173995~~) operation to query the ID of the partition filter expression.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', 'title' => ''], + ], + [ + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => ['description' => 'The description of the quality rule.', 'type' => 'string', 'required' => false, 'maxLength' => 512, 'example' => 'Verify the number of table rows', 'title' => ''], + ], + [ + 'name' => 'Checker', + 'in' => 'formData', + 'schema' => ['description' => 'The checker ID. You can call the [ListQualityRules](~~173995~~) operation to query the checker ID.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '9', 'title' => ''], + ], + [ + 'name' => 'ExpectValue', + 'in' => 'formData', + 'schema' => ['description' => 'The expected value.', 'type' => 'string', 'required' => false, 'maxLength' => 128, 'example' => '300', 'title' => ''], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => 'The rule ID. You can call the [ListQualityRules](~~173995~~) operation to query the rule ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1234', 'title' => ''], + ], + [ + 'name' => 'Trend', + 'in' => 'formData', + 'schema' => ['description' => 'The trend of the check result. Valid values:'."\n" + ."\n" + .'- up: upward trend'."\n" + ."\n" + .'- down: downward trend'."\n" + ."\n" + .'- abs: absolute value', 'type' => 'string', 'required' => false, 'example' => 'up', 'title' => ''], + ], + [ + 'name' => 'MethodName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the method used to collect sample data. Valid values: avg, count, sum, min, max, count\\_distinct, user\\_defined, table\\_count, table\\_size, table\\_dt\\_load\\_count, table\\_dt\\_refuseload\\_count, null\\_value, null\\_value/table\\_count, (table\\_count-count\\_distinct)/table\\_count, and table\\_count-count\\_distinct.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'table_count', 'title' => ''], + ], + [ + 'name' => 'Operator', + 'in' => 'formData', + 'schema' => ['description' => 'The comparison operator. Valid values: >, >=, =, !=, <, and <=.'."\n" + ."\n" + .'> This parameter is required if you set the Checker parameter to 9.', 'type' => 'string', 'required' => false, 'maxLength' => 128, 'example' => '>', 'title' => ''], + ], + [ + 'name' => 'ProjectName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the engine or data source. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace Management page to obtain the name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'autotest', 'title' => ''], + ], + [ + 'name' => 'Property', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the field.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'maxLength' => 128, 'minLength' => 1, 'example' => 'id', 'title' => ''], + ], + [ + 'name' => 'PropertyType', + 'in' => 'formData', + 'schema' => ['description' => 'The data type of the field.', 'type' => 'string', 'required' => false, 'maxLength' => 128, 'example' => 'bigint', 'title' => ''], + ], + [ + 'name' => 'RuleType', + 'in' => 'formData', + 'schema' => ['description' => 'The type of the rule. Valid values:'."\n" + ."\n" + .'- 0: system template'."\n" + ."\n" + .'- 1: custom SQL'."\n" + ."\n" + .'- 2: custom template', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '99', 'minimum' => '0', 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'WhereCondition', + 'in' => 'formData', + 'schema' => ['description' => 'The filter condition or custom SQL statement that is used for the check.', 'type' => 'string', 'required' => false, 'example' => 'dt=$[yyyymmdd]', 'title' => ''], + ], + [ + 'name' => 'CriticalThreshold', + 'in' => 'formData', + 'schema' => ['description' => 'The threshold for a critical alert. The threshold specifies the deviation of a check result from the expected value. You can customize the threshold based on your business requirements. If you use a strong rule and a critical alert is triggered, the scheduling of the associated task is blocked.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'WarningThreshold', + 'in' => 'formData', + 'schema' => ['description' => 'The threshold for a warning alert. The threshold specifies the deviation of a check result from the expected value. You can customize the threshold based on your business requirements.', 'type' => 'string', 'required' => false, 'example' => '5', 'title' => ''], + ], + [ + 'name' => 'TemplateId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the template that is used for the check. You can call the [ListQualityRules](~~173995~~) operation to query the template ID.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '7', 'title' => ''], + ], + [ + 'name' => 'RuleName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the quality rule.', 'type' => 'string', 'required' => false, 'maxLength' => 255, 'minLength' => 1, 'example' => '123', 'title' => ''], ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '187380', - 'abilityTreeNodes' => [ - 'FEATUREdideRZEBFC', + [ + 'name' => 'PredictType', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to use a dynamic threshold. Valid values:'."\n" + ."\n" + .'- 0: no'."\n" + ."\n" + .'- 2: yes', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '99', 'minimum' => '0', 'example' => '0', 'title' => ''], ], - ], - 'parameters' => [ [ - 'name' => 'QualifiedName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The unique identifier of the entity. Example: maxcompute-table.projectA.tableA.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'maxcompute-table.projectA.tableA', - ], + 'name' => 'OpenSwitch', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to enable or disable the quality rule. This parameter specifies whether to run the quality rule in the production environment.'."\n" + ."\n" + .'- true: The quality rule is triggered when the scheduling task that is associated with the output table of the rule runs.'."\n" + ."\n" + .'- false: The quality rule is not triggered when the scheduling task that is associated with the output table of the rule runs.', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'TagKeys', + 'name' => 'ProjectId', 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The tag keys.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'priority', - ], - 'required' => true, - 'maxItems' => 100, - ], + 'schema' => ['description' => 'The DataWorks workspace ID.', 'type' => 'integer', 'format' => 'int64', 'docRequired' => true, 'required' => true, 'example' => '26', 'title' => ''], + ], + [ + 'name' => 'TaskSetting', + 'in' => 'formData', + 'schema' => ['description' => 'The variable settings that are inserted before a custom rule. The settings are in the format of x=a,y=b.', 'type' => 'string', 'required' => false, 'example' => 'x=a,y=b', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'OpenApiMetaResultModel', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => 'Indicates whether the call was successful. Valid values:'."\n" - ."\n" - .'true\\'."\n" - .'false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-E****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'true\\'."\n" - .'false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '101011005', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Entity.EntityTypeNotSupported', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the validation rule was successfully updated.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned when the request fails.', 'type' => 'string', 'example' => 'You have no permission.', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request, used for troubleshooting.', 'type' => 'string', 'example' => '576b9457-2cf5-4****', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned when the request fails.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], 'staticInfo' => [ + 'substitutions' => ['dataworks-public::2024-05-18::UpdateDataQualityScan'], 'returnType' => 'synchronous', ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"0000-ABCD-E****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"101011005\\",\\n \\"ErrorMessage\\": \\"Invalid.Entity.EntityTypeNotSupported\\",\\n \\"HttpStatusCode\\": 200\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 0000-ABCD-E****\\n true\\n 101011005\\n Invalid.Entity.EntityTypeNotSupported\\n 200\\n","errorExample":""}]', - 'title' => 'RemoveEntityTags', - ], - 'SetEntityTags' => [ - 'summary' => 'Configures tags for an entity. Only entities of the maxcompute-table type are supported.', - 'methods' => [ - 'post', + 'title' => 'UpdateQualityRule', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-11-14T02:09:56.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-01-22T02:34:47.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-11-15T11:45:03.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-03-08T07:46:00.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2021-11-23T03:58:45.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-11-23T03:58:45.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"You have no permission.\\",\\n \\"RequestId\\": \\"576b9457-2cf5-4****\\",\\n \\"ErrorCode\\": \\"0\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'UpdateRemind' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -62563,353 +39966,220 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'abilityTreeCode' => '187379', - 'abilityTreeNodes' => [ - 'FEATUREdideRZEBFC', - ], + 'abilityTreeCode' => '78381', + 'abilityTreeNodes' => ['FEATUREdideRJGWWC'], ], 'parameters' => [ [ - 'name' => 'QualifiedName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The unique identifier of the entity. Example: maxcompute-table.projectA.tableA.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'maxcompute-table.projectA.tableA', - ], + 'name' => 'RemindId', + 'in' => 'formData', + 'schema' => ['description' => 'The custom alert rule ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1234'], ], [ - 'name' => 'Tags', + 'name' => 'RemindName', 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The tags.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The tag.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/UserEntityTag', - ], - 'required' => false, - 'maxItems' => 100, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'OpenApiMetaResultModel', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'Data' => [ - 'description' => 'Indicates whether the call was successful. Valid values:'."\n" - ."\n" - .'true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-E****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '101011005', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Entity.EntityTypeNotSupported', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - ], - ], + 'schema' => ['description' => 'The name of the custom alert rule. The name cannot exceed 128 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => 'update_remindname'], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": true,\\n \\"RequestId\\": \\"0000-ABCD-E****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"101011005\\",\\n \\"ErrorMessage\\": \\"Invalid.Entity.EntityTypeNotSupported\\",\\n \\"HttpStatusCode\\": 200\\n}","errorExample":""},{"type":"xml","example":"\\n true\\n 0000-ABCD-E****\\n true\\n 101011005\\n Invalid.Entity.EntityTypeNotSupported\\n 200\\n","errorExample":""}]', - 'title' => 'SetEntityTags', - ], - 'ListEntityTags' => [ - 'summary' => 'Queries a list of tags of an entity. Only entities of the maxcompute-table type are supported.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '187352', - 'abilityTreeNodes' => [ - 'FEATUREdideRZEBFC', + 'name' => 'DndEnd', + 'in' => 'formData', + 'schema' => ['description' => 'The end of the period during which no alert notifications are sent. Specify the time in the hh:mm format. Valid values of hh: \\[0,23]. Valid values of mm: \\[0,59].'."\n", 'type' => 'string', 'required' => false, 'example' => '08:00'], ], - ], - 'parameters' => [ [ - 'name' => 'QualifiedName', - 'in' => 'query', + 'name' => 'RemindUnit', + 'in' => 'formData', 'schema' => [ - 'description' => 'The unique identifier of the entity. Example: maxcompute-table.projectA.tableA.'."\n", + 'description' => 'The type of the object to which the custom alert rule is applied. Valid values:'."\n" + ."\n" + .'* NODE'."\n" + .'* BASELINE'."\n" + .'* PROJECT'."\n" + .'* BIZPROCESS'."\n", 'type' => 'string', - 'required' => true, - 'example' => 'maxcompute-table.projectA.tableA', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'OpenApiMetaResultModel', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'Data' => [ - 'description' => 'The tags.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The tag.'."\n", - '$ref' => '#/components/schemas/UserEntityTag', - ], - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-E****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'true\\'."\n" - .'false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '101011005', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Entity.EntityTypeNotSupported', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - ], + 'required' => false, + 'example' => 'NODE', + 'enum' => ['NODE', 'BASELINE', 'PROJECT', 'BIZPROCESS'], ], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": [\\n {\\n \\"TagKey\\": \\"priority\\",\\n \\"TagValue\\": \\"p1\\"\\n }\\n ],\\n \\"RequestId\\": \\"0000-ABCD-E****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"101011005\\",\\n \\"ErrorMessage\\": \\"Invalid.Entity.EntityTypeNotSupported\\",\\n \\"HttpStatusCode\\": 200\\n}","errorExample":""},{"type":"xml","example":"\\n \\n priority\\n p1\\n \\n 0000-ABCD-E****\\n true\\n 101011005\\n Invalid.Entity.EntityTypeNotSupported\\n 200\\n","errorExample":""}]', - 'title' => 'ListEntityTags', - ], - 'SetDataSourceShare' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], [ - 'PrivateKey' => [], + 'name' => 'NodeIds', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the node to which the custom alert rule is applied. A maximum of 50 nodes can be specified for a custom alert rule. You can specify multiple IDs. Separate multiple IDs with commas (,). This parameter takes effect when you set the RemindUnit parameter to NODE.'."\n", 'type' => 'string', 'required' => false, 'example' => '1,2,3'], ], [ - 'APP' => [], + 'name' => 'BaselineIds', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the baseline to which the custom alert rule is applied. A maximum of 5 baselines can be specified for a custom alert rule. You can specify multiple IDs. Separate multiple IDs with commas (,). This parameter takes effect when you set the RemindUnit parameter to BASELINE.'."\n", 'type' => 'string', 'required' => false, 'example' => '1,2,3'], ], - ], - 'operationType' => 'write', - 'deprecated' => true, - 'systemTags' => [], - 'parameters' => [ [ 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the DataWorks workspace to which the data source belongs. You can call the [ListProjects](~~178393~~) operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '10000000000', - 'minimum' => '1', - 'example' => '10000', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the workspace to which the custom alert rule is applied. You can specify only one workspace for a custom alert rule. This parameter takes effect when you set the RemindUnit parameter to PROJECT.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234'], ], [ - 'name' => 'DatasourceName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the data source that you want to share.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mysql_name', - ], + 'name' => 'BizProcessIds', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the workflow to which the custom alert rule is applied. A maximum of 5 workflows can be specified for a custom alert rule. You can specify multiple IDs. Separate multiple IDs with commas (,). This parameter takes effect when you set the RemindUnit parameter to BIZPROCESS.'."\n", 'type' => 'string', 'required' => false, 'example' => '1,2,3'], ], [ - 'name' => 'EnvType', - 'in' => 'query', + 'name' => 'RemindType', + 'in' => 'formData', 'schema' => [ - 'description' => 'The environment in which the data source is used. Valid values:'."\n" + 'description' => 'The condition that triggers the alert rule. Valid values:'."\n" + ."\n" + .'* FINISHED: The system monitors an instance when it starts to run and sends an alert notification after the running of the instance is complete.'."\n" + .'* UNFINISHED: The system monitors an instance when it starts to run and sends an alert notification if the instance is still running at the specified point in time.'."\n" + .'* ERROR: The system monitors an instance when it starts to run and sends an alert notification if an error occurs.'."\n" + .'* CYCLE_UNFINISHED: The system sends an alert notification if a monitored instance is still running at the end of the specified cycle. In most cases, you can configure this trigger condition for node instances that are scheduled to run by hour.'."\n" + .'* TIMEOUT: The system monitors an instance when it starts to run and sends an alert notification if the instance is still running after the specified period ends. In most cases, you can configure this trigger condition to monitor the running duration of node instances.'."\n" ."\n" - .'* 0: development environment'."\n" - .'* 1: production environment'."\n", + .'For more information, see [Manage custom alert rules](~~138172~~).'."\n", 'type' => 'string', 'required' => false, - 'docRequired' => true, - 'example' => '1', + 'example' => 'FINISHED', + 'enum' => ['FINISHED', 'UNFINISHED', 'ERROR', 'CYCLE_UNFINISHED', 'TIMEOUT', 'EXHAUSTED_ERROR'], ], ], [ - 'name' => 'ProjectPermissions', - 'in' => 'query', + 'name' => 'MaxAlertTimes', + 'in' => 'formData', + 'schema' => ['description' => 'The maximum number of alerts. Valid values: 1 to 10. Default value: 3.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '10', 'minimum' => '1', 'example' => '3', 'default' => '3'], + ], + [ + 'name' => 'AlertInterval', + 'in' => 'formData', + 'schema' => ['description' => 'The intervals at which alert notifications are sent. Unit: seconds. Minimum value: 1200. Default value: 1800.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '1800', 'minimum' => '1200', 'example' => '1800', 'default' => '1800'], + ], + [ + 'name' => 'Detail', + 'in' => 'formData', + 'schema' => ['description' => 'The details of the conditions that trigger an alert.'."\n" + ."\n" + .'* If the RemindType parameter is set to FINISHED, leave this parameter empty.'."\n" + .'* If the RemindType parameter is set to UNFINISHED, set this parameter to key-value pairs. Example: {"hour":23,"minu":59}. Valid values of hour: \\[0,47]. Valid values of minu: \\[0,59].'."\n" + .'* If the RemindType parameter is set to ERROR, leave this parameter empty.'."\n" + .'* If the RemindType parameter is set to CYCLE_UNFINISHED, set this parameter to key-value pairs in the JSON format. Example: {"1":"05:50","2":"06:50","3":"07:50","4":"08:50","5":"09:50","6":"10:50","7":"11:50","8":"12:50","9":"13:50","10":"14:50","11":"15:50","12":"16:50","13":"17:50","14":"18:50","15":"19:50","16":"20:50","17":"21:50","18":"22:50","19":"23:50","20":"24:50","21":"25:50"}. A key in the JSON string indicates the sequence number of a cycle. Valid values of keys: 1 to 288. A value in the JSON string indicates the time in point when a monitored instance times out in the relevant cycle. Values must be in the format of hh:mm. Valid values of hh: \\[0,47]. Valid values of mm: \\[0,59].'."\n" + .'* If the RemindType parameter is set to TIMEOUT, set this parameter to the timeout period. Unit: seconds. Example: 1800. This indicates that an alert notification is sent if the running duration of a monitored instance exceeds 30 minutes.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"hour":23,"minu":59}'], + ], + [ + 'name' => 'AlertUnit', + 'in' => 'formData', 'schema' => [ - 'description' => 'The DataWorks workspace to which you want to share the data source. If you configure this parameter, all members of the specified DataWorks workspace can view and use the data source. The value of this parameter is a JSON array. Example: \\[{"projectId":1000,"permission":"WRITE","sharedName":"PX_DATAHUB1.shared_name"}], Parameter description:'."\n" - ."\n" - .'* projectId: the ID of the DataWorks workspace to which you want to share the data source.'."\n" - .'* permission: the mode in which the data source is shared. Valid values: READ and WRITE. The value READ indicates that all members of the specified workspace can read data from the data source, but cannot modify the data. The value WRITE indicates that all members of the specified workspace can modify the data in the data source.'."\n" - .'* sharedName: the name of the data source that you want to share.'."\n", + 'description' => 'The recipient to whom alert notifications are sent. Valid values: OWNER and OTHER. The value OWNER indicates that alert notifications are sent to the object owner. The value OTHER indicates that alert notifications are sent to a specified user.'."\n", 'type' => 'string', 'required' => false, - 'example' => '[{"projectId":1000,"permission":"WRITE","sharedName":"PX_DATAHUB1.shared_name"}]', + 'example' => 'OWNER', + 'default' => '', + 'enum' => ['OTHER', 'OWNER'], ], ], [ - 'name' => 'UserPermissions', - 'in' => 'query', + 'name' => 'AlertMethods', + 'in' => 'formData', 'schema' => [ - 'description' => 'The user to whom you want to share the data source. If you configure this parameter, the specified user can view or use the data source. The value of this parameter is a JSON array. Example: \\[{"projectId":10000,"users":\\[{"userId":"276184575345452131","permission":"WRITE"}],"sharedName":"PX_DATAHUB1.shared_name"}], Parameter description:'."\n" + 'description' => 'The notification method. Valid values:'."\n" ."\n" - .'* projectId: the ID of the DataWorks workspace. If you configure the UserPermissions parameter, the specified user can view or use the data source only in the specified DataWorks workspace.'."\n" - .'* userId: the ID of the user to whom you want to share the data source.'."\n" - .'* permission: the mode in which the data source is shared. Valid values: READ and WRITE. The value READ indicates that the specified user can read data from the data source, but cannot modify the data. The value WRITE indicates that the specified user can modify the data in the data source.'."\n" - .'* sharedName: the name of the data source that you want to share.'."\n" + .'* MAIL: Alert notifications are sent by email.'."\n" + .'* SMS: Alert notifications are sent by text message.'."\n" + .'* PHONE: Alert notifications are sent by phone call. You can use this notification method only in DataWorks Professional Edition or more advanced editions.'."\n" + .'* DINGROBOTS: Alert notifications are sent by DingTalk message. You can use this notification method only if the RobotUrls parameter is configured.'."\n" + .'* WEBHOOKS (WeCom or Lark chatbot): Alert notifications are sent by WeCom or Lark message. You can use this notification method only if the Webhooks parameter is configured.'."\n" ."\n" - .'If the ProjectPermissions and UserPermissions parameters are both left empty, the specified data source is not shared to any DataWorks workspace or user. If neither of the parameters is left empty, both parameters take effect.'."\n", + .'Multiple notification methods are separated by commas (,).'."\n", 'type' => 'string', 'required' => false, - 'example' => '[{"projectId":10000,"users":[{"userId":"276184575345452131","permission":"WRITE"}],"sharedName":"PX_DATAHUB1.shared_name"}]', + 'example' => 'SMS,MAIL', + 'default' => '', + 'enum' => [], ], ], + [ + 'name' => 'AlertTargets', + 'in' => 'formData', + 'schema' => ['description' => 'The value format required by this parameter varies based on the value that you specify for the AlertUnit parameter. Take note of the following items:'."\n" + ."\n" + .'* If the AlertUnit parameter is set to OWNER, leave this parameter empty.'."\n" + .'* If the AlertUnit parameter is set to OTHER, set this parameter to the unique ID (UID) of the specified user. You can specify multiple UIDs. Separate them with commas (,). A maximum of 10 UIDs can be specified for receiving alert notifications.'."\n", 'type' => 'string', 'required' => false, 'example' => '9527952795279527'], + ], + [ + 'name' => 'UseFlag', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to enable the alert rule. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'RobotUrls', + 'in' => 'formData', + 'schema' => ['description' => 'The webhook URL of the DingTalk chatbot. You can specify multiple webhook URLs. Separate multiple webhook URLs with commas (,). If this parameter is set to undefined, the specified webhook URLs are cleared.'."\n", 'type' => 'string', 'required' => false, 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=******************************'], + ], + [ + 'name' => 'Webhooks', + 'in' => 'formData', + 'schema' => ['description' => 'The webhook URL of the WeCom or Lark chatbot. You can specify multiple webhook URLs. Separate multiple webhook URLs with commas (,). The value of AlertMethods must include WEBHOOKS. If this parameter is set to undefined, the specified webhook URLs are cleared.'."\n" + ."\n" + .'Only DataWorks Enterprise Edition supports this parameter. The webhook URL-based alerting feature is supported in the following regions: China (Shanghai), China (Chengdu), China (Zhangjiakou), China (Beijing), China (Hangzhou), China (Shenzhen), China (Hong Kong), Germany (Frankfurt), and Singapore.'."\n", 'type' => 'string', 'required' => false, 'example' => 'https://open.feishu.cn/open-apis/bot/v2/hook/*******'."\n"], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG ', - ], - 'Data' => [ - 'description' => 'The information about the sharing operation.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'Indicates whether the data source was shared. Valid values:'."\n" - ."\n" - .'* success.'."\n" - .'* fail. You can view the value of the Message parameter to identify the cause of the failure.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Message' => [ - 'description' => 'The reason why the data source failed to be shared. If the data source is successfully shared, the value of this parameter is an empty string.'."\n", - 'type' => 'string', - 'example' => 'datasource is wrong', - ], - ], - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Data' => ['description' => 'Indicates whether the modification to the custom alert rule succeeds.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'ErrorMessage' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'The specified parameters are invalid.'], + 'RequestId' => ['description' => 'The request ID. You can use the ID to troubleshoot issues.'."\n", 'type' => 'string', 'example' => '0000-ABCD-EFG****'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], + 'ErrorCode' => ['description' => 'The error code.'."\n", 'type' => 'string', 'example' => '1031203110005'], ], 'description' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Invalid.DI.Parameter', - 'errorMessage' => 'The parameter is invalid.', - ], - ], - 403 => [ - [ - 'errorCode' => 'Forbidden.DI.NoPrivilege', - 'errorMessage' => 'No access.', - ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Resource', 'errorMessage' => 'You have reached the limit for the resource. Please contact us by submitting a ticket.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], ], 500 => [ - [ - 'errorCode' => 'InternalError.DI.Parameter', - 'errorMessage' => 'A DI internal error occurred.', - ], + ['errorCode' => 'Forbidden.Not.Server', 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.', 'description' => ''], + ['errorCode' => 'Forbidden.Wkbench.BaselineNoPermission', 'errorMessage' => 'You are not authorized to access the baseline.', 'description' => ''], + ['errorCode' => 'Forbidden.Wkbench.ProjectNoPermission', 'errorMessage' => 'You are not authorized to access the workspace.', 'description' => ''], + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'Forbidden.Wkbench.RemindNoPermission', 'errorMessage' => 'You are not authorized to modify the reminder.', 'description' => ''], + ['errorCode' => 'Invalid.Wkbench.RemindNotExist', 'errorMessage' => 'The reminder does not exist.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"0000-ABCD-EFG\\\\t\\",\\n \\"Data\\": {\\n \\"Status\\": \\"success\\",\\n \\"Message\\": \\"datasource is wrong\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"0000-ABCD-EFG\\t\\n\\n success\\n datasource is wrong\\n\\ntrue","errorExample":""}]', - 'title' => 'SetDataSourceShare', - 'summary' => 'Shares a data source to a specific DataWorks workspace or a specific user.', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": true,\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"1031203110005\\"\\n}","errorExample":""},{"type":"xml","example":"0000-ABCD-EFG****\\n200\\ntrue\\n1031203110005\\nThe specified parameters are invalid.\\ntrue","errorExample":""}]', + 'title' => 'UpdateRemind', + 'summary' => 'Modifies a custom alert rule.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateConnection' => [ - 'summary' => 'Adds a data source.', - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2023-10-20T02:29:16.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-11-16T09:08:09.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '29', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateRemind'], + ], ], + 'ramActions' => [], + ], + 'UpdateTable' => [ + 'summary' => 'Updates a MaxCompute table.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -62918,528 +40188,470 @@ 'operationType' => 'write', 'deprecated' => true, 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'high', + 'operationType' => 'update', + 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdide7FTVFZ', - ], + 'abilityTreeCode' => '78382', + 'abilityTreeNodes' => ['FEATUREdideX3KVYR'], ], 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'IsView', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the workspace with which the data source is associated. You can call the [ListProjects](~~178393~~) operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'Specifies whether the table is a view. Valid values: 0 and 1. The value 0 indicates that the table is not a view. The value 1 indicates that the table is a view. This parameter is deprecated. Do not use this parameter.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], ], [ - 'name' => 'Name', + 'name' => 'Visibility', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the data source.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'abc', - ], + 'schema' => ['description' => 'The scope in which the table is visible. Valid values: 0, 1, and 2. The value 0 indicates that the table is invisible to all workspace members. The value 1 indicates that the table is visible to all workspace members. The value 2 indicates that the table is visible to workspace members.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'LifeCycle', 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the connection string.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], + 'schema' => ['description' => 'The lifecycle of the table. Unit: days. If this parameter is left empty, the table is permanently stored.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'ConnectionType', + 'name' => 'CategoryId', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the connection string. Valid values:'."\n" - ."\n" - .'* odps'."\n" - .'* mysql'."\n" - .'* rds'."\n" - .'* oss'."\n" - .'* sqlserver'."\n" - .'* polardb'."\n" - .'* oracle'."\n" - .'* mongodb'."\n" - .'* emr'."\n" - .'* postgresql'."\n" - .'* analyticdb_for_mysql'."\n" - .'* hybriddb_for_postgresql'."\n" - .'* holo'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'rds', - ], + 'schema' => ['description' => 'The ID of the associated category.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '101', 'title' => ''], ], [ - 'name' => 'SubType', + 'name' => 'LogicalLevelId', 'in' => 'query', - 'schema' => [ - 'description' => 'The subtype of the connection string. This parameter is used for scenarios where a type includes subtypes. The following type and subtypes are supported:'."\n" - ."\n" - .'* Type: `rds`'."\n" - .'* Subtypes: `mysql`, `sqlserver`, and `postgresql`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mysql', - ], + 'schema' => ['description' => 'The ID of the logical level.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '101', 'title' => ''], + ], + [ + 'name' => 'PhysicsLevelId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the physical layer.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '101', 'title' => ''], + ], + [ + 'name' => 'ExternalTableType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the external table. Valid values: 0, 1, 2, and 3. The value 0 indicates that the external table is an OSS external table. The value 1 indicates that the external table is a Tablestore external table. The value 2 indicates that the external table is a volume external table. The value 3 indicates that the external table is a MySQL external table. This parameter is deprecated. Do not use this parameter.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Location', + 'in' => 'query', + 'schema' => ['description' => 'The storage location of the external table. This parameter is deprecated. Do not use this parameter.', 'type' => 'string', 'required' => false, 'example' => 'location', 'title' => ''], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The DataWorks workspace ID. You can log on to the DataWorks console to obtain the ID of the DataWorks workspace.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '101', 'title' => ''], + ], + [ + 'name' => 'TableName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the MaxCompute table.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'abc', 'title' => ''], + ], + [ + 'name' => 'Endpoint', + 'in' => 'formData', + 'schema' => ['description' => 'The endpoint of MaxCompute. If you do not specify this parameter, the endpoint of the MaxCompute project is used.', 'type' => 'string', 'required' => false, 'example' => 'odps://', 'title' => ''], ], [ 'name' => 'EnvType', + 'in' => 'formData', + 'schema' => ['description' => 'The environment of the DataWorks workspace. Valid values: 0 and 1. The value 0 indicates the development environment. The value 1 indicates the production environment.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'AppGuid', + 'in' => 'query', + 'schema' => ['description' => 'The unique identifier of the MaxCompute project. Specify the GUID in the odps.{projectName} format.', 'type' => 'string', 'required' => false, 'example' => 'odps.test', 'title' => ''], + ], + [ + 'name' => 'CreateIfNotExists', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether the table exists. Valid values:'."\n" + ."\n" + .'- true: The table exists.'."\n" + ."\n" + .'- false: The table does not exist.'."\n" + ."\n" + .'This parameter is deprecated. Do not use this parameter.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'HasPart', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether the table that you want to update is a partitioned table. Valid values: 0 and 1. The value 0 indicates that the table is not a partitioned table. The value 1 indicates that the table is a partitioned table. This parameter is deprecated. Do not use this parameter. The Column.N.isPartitionCol parameter is used instead of the HasPart parameter to specify whether the MaxCompute table is a partitioned table. If the Column.N.isPartitionCol parameter is set to 1, the MaxCompute table is a partitioned table.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'Comment', + 'in' => 'query', + 'schema' => ['description' => 'The comment.', 'type' => 'string', 'example' => 'Remarks', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'Schema', 'in' => 'query', + 'schema' => ['description' => 'The schema information of the table. You need to enter the schema information of the table if you enable the table schema in MaxCompute.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], + ], + [ + 'name' => 'Columns', + 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The environment in which the data source is used. Valid values: 0 and 1. The value 0 indicates the development environment. The value 1 indicates the production environment.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', + 'description' => 'The list of fields.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ColumnNameCn' => ['description' => 'The display name of the field.', 'type' => 'string', 'required' => false, 'example' => '中文', 'title' => ''], + 'ColumnName' => ['description' => 'The name of the field.', 'type' => 'string', 'required' => true, 'example' => 'abc', 'title' => ''], + 'Comment' => ['description' => 'The comment of the field.', 'type' => 'string', 'required' => false, 'example' => '备注', 'title' => ''], + 'ColumnType' => ['description' => 'The type of the field. For more information, see MaxCompute field types.', 'type' => 'string', 'required' => true, 'example' => 'string', 'title' => ''], + 'SeqNumber' => ['description' => 'The sequence number of the field. If the field is a partition field, this parameter is not supported.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'Length' => ['description' => 'The length of the field.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + 'IsPartitionCol' => ['description' => 'Specifies whether the field is a partition field. Valid values: 0 and 1. The value 0 indicates that the field is not a partition field. The value 1 indicates that the field is a partition field.', 'type' => 'boolean', 'required' => false, 'example' => '0', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Content', - 'in' => 'query', + 'name' => 'Themes', + 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The details of the data source. Examples of details of some common data sources:'."\n" - ."\n" - .'* odps'."\n" - ."\n" - .''."\n" - ."\n" - .' {'."\n" - .' "accessId": "xssssss",'."\n" - .' "accessKey": "xsaxsaxsa",'."\n" - .' "authType": 2,'."\n" - .' "endpoint": "http://service.odps.aliyun.com/api",'."\n" - .' "project": "xsaxsax",'."\n" - .' "tag": "public"'."\n" - .' }'."\n" - ."\n" - .'* mysql'."\n" - ."\n" - .''."\n" - ."\n" - .' {'."\n" - .' "database": "xsaxsa",'."\n" - .' "instanceName": "rm-xsaxsa",'."\n" - .' "password": "xsaxsa",'."\n" - .' "rdsOwnerId": "xasxsa",'."\n" - .' "regionId": "cn-shanghai",'."\n" - .' "tag": "rds",'."\n" - .' "username": "xsaxsa"'."\n" - .' }'."\n" - ."\n" - .'* rds'."\n" - ."\n" - .''."\n" - ."\n" - .' {'."\n" - .' "configType": 1,'."\n" - .' "tag": "rds",'."\n" - .' "database": "xsaxsa",'."\n" - .' "username": "xsaxsa",'."\n" - .' "password": "xssaxsa$32050",'."\n" - .' "instanceName": "rm-xsaxs",'."\n" - .' "rdsOwnerId": "11111111"'."\n" - .' }'."\n" - ."\n" - .'* oss'."\n" - ."\n" - .''."\n" - ."\n" - .' {'."\n" - .' "accessId": "sssssxx",'."\n" - .' "accessKey": "xsaxaxsaxs",'."\n" - .' "bucket": "xsa-xs-xs",'."\n" - .' "endpoint": "http://oss-cn-shanghai.aliyuncs.com",'."\n" - .' "tag": "public"'."\n" - .' }'."\n" - ."\n" - .'* sqlserver'."\n" - ."\n" - .''."\n" - ."\n" - .' {'."\n" - .' "jdbcUrl": "jdbc:sqlserver://xsaxsa-xsaxsa.database.xxx.cn:123;DatabaseName=xsxs-xsxs",'."\n" - .' "password": "sdasda$fs",'."\n" - .' "tag": "public",'."\n" - .' "username": "sxaxacdacdd"'."\n" - .' }'."\n" - ."\n" - .'* polardb'."\n" - ."\n" - .''."\n" - ."\n" - .' {'."\n" - .' "clusterId": "pc-sdadsadsa",'."\n" - .' "database": "dsadsadsa",'."\n" - .' "ownerId": "121212122",'."\n" - .' "password": "sdasdafssa",'."\n" - .' "region": "cn-shanghai",'."\n" - .' "tag": "polardb",'."\n" - .' "username": "asdadsads"'."\n" - .' }'."\n" - ."\n" - .'* oracle'."\n" - ."\n" - .''."\n" - ."\n" - .' {'."\n" - .' "jdbcUrl": "jdbc:oracle:saaa:@xxxxx:1521:PROD",'."\n" - .' "password": "sxasaxsa",'."\n" - .' "tag": "public",'."\n" - .' "username": "sasfadfa"'."\n" - .' }'."\n" - ."\n" - .'* mongodb'."\n" - ."\n" - .''."\n" - ."\n" - .' {'."\n" - .' "address": "[\\"xsaxxsa.mongodb.rds.aliyuncs.com:3717\\"]",'."\n" - .' "database": "admin",'."\n" - .' "password": "sadsda@",'."\n" - .' "tag": "public",'."\n" - .' "username": "dsadsadas"'."\n" - .' }'."\n" - ."\n" - .'* emr'."\n" - ."\n" - .''."\n" - ."\n" - .' {'."\n" - .' "accessId": "xsaxsa",'."\n" - .' "emrClusterId": "C-dsads",'."\n" - .' "emrResourceQueueName": "default",'."\n" - .' "emrEndpoint": "emr.aliyuncs.com",'."\n" - .' "accessKey": "dsadsad",'."\n" - .' "emrUserId": "224833315798889783",'."\n" - .' "name": "sasdsadsa",'."\n" - .' "emrAccessMode": "simple",'."\n" - .' "region": "cn-shanghai",'."\n" - .' "authType": "2",'."\n" - .' "emrProjectId": "FP-sdadsad"'."\n" - .' }'."\n" - ."\n" - .'* postgresql'."\n" - ."\n" - .''."\n" - ."\n" - .' {'."\n" - .' "jdbcUrl": "jdbc:postgresql://xxxx:1921/ssss",'."\n" - .' "password": "sdadsads",'."\n" - .' "tag": "public",'."\n" - .' "username": "sdsasda"'."\n" - .' }'."\n" - ."\n" - .'* analyticdb_for_mysql'."\n" - ."\n" - .''."\n" - ."\n" - .' {'."\n" - .' "instanceId": "am-sadsada",'."\n" - .' "database": "xsxsx",'."\n" - .' "username": "xsxsa",'."\n" - .' "password": "asdadsa",'."\n" - .' "connectionString": "am-xssxsxs.ads.aliyuncs.com:3306"'."\n" - .' }'."\n" - ."\n" - .'* hybriddb_for_postgresql'."\n" - ."\n" - .''."\n" - ."\n" - .' {'."\n" - .' "connectionString": "gp-xsaxsaxa-master.gpdbmaster.rds.aliyuncs.com",'."\n" - .' "database": "xsaxsaxas",'."\n" - .' "password": "xsaxsaxsa@11",'."\n" - .' "instanceId": "gp-xsaxsaxsa",'."\n" - .' "port": "541132",'."\n" - .' "ownerId": "xsaxsaxsas",'."\n" - .' "username": "sadsad"'."\n" - .' }'."\n" - ."\n" - .'* holo'."\n" - ."\n" - .''."\n" - ."\n" - .' {'."\n" - .' "accessId": "xsaxsaxs",'."\n" - .' "accessKey": "xsaxsaxsa",'."\n" - .' "database": "xsaxsaxsa",'."\n" - .' "instanceId": "xsaxa",'."\n" - .' "tag": "aliyun"'."\n" - .' }'."\n" - ."\n" - .'* kafka'."\n" - ."\n" - .''."\n" - ."\n" - .' {'."\n" - .' "instanceId": "xsax-cn-xsaxsa",'."\n" - .' "regionId": "cn-shanghai",'."\n" - .' "tag": "aliyun",'."\n" - .' "ownerId": "1212121212112"'."\n" - .' }'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '{"database":"dbname","instanceName":"instancename","password":"password","rdsOwnerId":"123","username":"username"}', + 'description' => 'The list of fields.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'ThemeId' => ['description' => 'The ID of the associated topic.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '101', 'title' => ''], + 'ThemeLevel' => ['description' => 'The level that corresponds to the topic ID.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '101', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The data source ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0bc141151593763****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'abcde', 'title' => ''], + 'TaskInfo' => [ + 'description' => 'The information about the request task. After a request task is submitted, it is divided into multiple subtasks that are run in sequence. After the current subtask is complete, the next subtask starts to run. After all subtasks are complete, the request task is complete. If a request task is terminated due to one of the following issues, address the issue based on the error code and initiate the request task again:'."\n" + ."\n" + .'- The request task fails to be submitted.'."\n" + ."\n" + .'- After the request task is submitted, a subtask fails to run.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status of the current subtask. Valid values:'."\n" + ."\n" + .'- operating: The subtask is running.'."\n" + ."\n" + .'- success: The subtask succeeds.'."\n" + ."\n" + .'- failure: The subtask fails to run. For more information about the error details, see the Content parameter.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'NextTaskId' => ['description' => 'The ID of the subtask that you want to run. If this parameter is left empty, all subtasks are complete. You can call the [GetDDLJobStatus](~~185659~~) operation to query the status of the subtask based on the subtask ID.', 'type' => 'string', 'example' => 'abc1', 'title' => ''], + 'TaskId' => ['description' => 'The ID of the current subtask.', 'type' => 'string', 'example' => 'abc', 'title' => ''], + 'Content' => ['description' => 'The details about the status of the current subtask. Valid values:'."\n" + ."\n" + .'- If the current subtask is successful, success is returned.'."\n" + ."\n" + .'- If the current subtask fails, the error details are displayed.', 'type' => 'string', 'example' => 'success', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Invalid.Tenant.ConnectionNotExists', - 'errorMessage' => 'The connection does not exist.', - ], - [ - 'errorCode' => 'Invalid.Tenant.ProjectNotExists', - 'errorMessage' => 'The project does not exist.', - ], - [ - 'errorCode' => 'Invalid.Tenant.UserNotInProject', - 'errorMessage' => 'The user is not in the project.', - ], - [ - 'errorCode' => 'ConnectionAlreadyExist', - 'errorMessage' => 'The connection with envType %s and name %s already exists.', - ], - [ - 'errorCode' => 'DataSource.CheckRamRoleFailure', - 'errorMessage' => 'Failed to check the RAM role. AccountId %s. roleArn %s.', - ], - [ - 'errorCode' => 'DataSource.ConnectionStrProperty.PatternNotMatch', - 'errorMessage' => 'The pattern value %s is invalid. The correct pattern is %s.', - ], - [ - 'errorCode' => 'Invalid.DataSource.DataSourceTypeNotSupport', - 'errorMessage' => 'The dataSourceType %s and subType %s are not supported.', - ], - [ - 'errorCode' => 'Invalid.Param.Odps.EngineIdOrConnectStrEmpty', - 'errorMessage' => 'Either the compute engine ID or the connection string must be specified when data source type is ODPS.', - ], - [ - 'errorCode' => 'MissingParam.ConnectionStr.Property', - 'errorMessage' => 'You must specify property %s required by the data source connection string.', - ], - [ - 'errorCode' => 'Invalid.DataSource.DataSourceTypeNotExist', - 'errorMessage' => 'The data source type %s does not exist.', - ], - ], 403 => [ - [ - 'errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin', - 'errorMessage' => 'The user is not a project administrator or owner.', - ], - [ - 'errorCode' => 'Invalid.Tenant.UserNotInTenant', - 'errorMessage' => 'The user is not in tenant.', - ], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], ], - ], - 'staticInfo' => [ - 'substitutions' => [ - 'dataworks-public::2020-05-18::CreateDataSource', + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": 123,\\n \\"RequestId\\": \\"0bc141151593763****\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"0bc141151593763****\\n200\\n123\\ntrue","errorExample":""}]', - 'title' => 'CreateConnection', + 'staticInfo' => ['noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"abcde\\",\\n \\"TaskInfo\\": {\\n \\"Status\\": \\"success\\",\\n \\"NextTaskId\\": \\"abc1\\",\\n \\"TaskId\\": \\"abc\\",\\n \\"Content\\": \\"success\\"\\n }\\n}","type":"json"}]', + 'title' => 'UpdateTable', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateDagComplement' => [ - 'methods' => [ - 'post', + 'changeSet' => [ + ['createdAt' => '2022-07-19T06:35:48.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'translator' => 'manual', + ], + 'UpdateTableAddColumn' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => true, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '78383', + 'abilityTreeNodes' => ['FEATUREdideRZEBFC'], ], 'parameters' => [ [ - 'name' => 'ProjectEnv', + 'name' => 'TableGuid', + 'in' => 'query', + 'schema' => ['description' => 'The globally unique identifier (GUID) of the MaxCompute table. Specify the GUID in the odps.projectName.tableName format.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'odps.engine_name.table_name', 'title' => ''], + ], + [ + 'name' => 'Column', 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'PROD', - 'enum' => [ - 'PROD', - 'DEV', + 'description' => 'The fields.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The field.'."\n", + 'type' => 'object', + 'properties' => [ + 'ColumnNameCn' => ['description' => 'The display name of the field.'."\n", 'type' => 'string', 'required' => false, 'example' => '中文', 'title' => ''], + 'ColumnName' => ['description' => 'The name of the field.'."\n", 'type' => 'string', 'required' => true, 'example' => 'abc', 'title' => ''], + 'Comment' => ['description' => 'The comment of the field.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Remarks', 'title' => ''], + 'ColumnType' => ['description' => 'The type of the field. For more information, see MaxCompute field types.'."\n", 'type' => 'string', 'required' => true, 'example' => 'string', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => true, + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'StartBizDate', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2020-05-20 00:00:00', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'abc', 'title' => ''], + 'TaskInfo' => [ + 'description' => 'The information about the request task. After a request task is submitted, it is divided into multiple subtasks that are run in sequence. After the current subtask is complete, the next subtask starts to run. After all subtasks are complete, the request task is complete. If a request task is aborted due to one of the following issues, address the issue based on the error code and initiate the request task again:'."\n" + ."\n" + .'* The request task fails to be submitted.'."\n" + .'* After the request task is submitted, a subtask fails to run.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status of the current subtask. Valid values:'."\n" + ."\n" + .'* operating: The subtask is running.'."\n" + .'* success: The subtask succeeds.'."\n" + .'* failure: The subtask fails to run. For more information about the error details, see the Content parameter.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'NextTaskId' => ['description' => 'The ID of the subtask that you want to run. If this parameter is left empty, all subtasks are complete.'."\n", 'type' => 'string', 'example' => 'abc1', 'title' => ''], + 'TaskId' => ['description' => 'The ID of the current subtask.'."\n", 'type' => 'string', 'example' => 'abc2', 'title' => ''], + 'Content' => ['description' => 'The details about the status of the current subtask.'."\n" + ."\n" + .'* If the current subtask is successful, success is returned.'."\n" + .'* If the current subtask fails, the error details are displayed.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"abc\\",\\n \\"TaskInfo\\": {\\n \\"Status\\": \\"success\\",\\n \\"NextTaskId\\": \\"abc1\\",\\n \\"TaskId\\": \\"abc2\\",\\n \\"Content\\": \\"success\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n \\n success\\n abc2\\n success\\n abc1\\n \\n abc\\n","errorExample":""}]', + 'title' => 'UpdateTableAddColumn', + 'summary' => 'Updates the fields in a MaxCompute table.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'staticInfo' => ['noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。'], + ], + 'UpdateTableLevel' => [ + 'summary' => 'Updates a hierarchy level. This operation will be replaced soon. We recommend that you do not call this operation.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '78384', + 'abilityTreeNodes' => ['FEATUREdideRZEBFC'], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the DataWorks workspace.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '123', 'title' => ''], + ], + [ + 'name' => 'LevelType', + 'in' => 'query', + 'schema' => ['description' => 'The table level type. Valid values: 1 and 2. The value 1 indicates the logical level. The value 2 indicates the physical level.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '10', 'minimum' => '0', 'example' => '1', 'title' => ''], + ], [ 'name' => 'Name', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'xm_test', - ], + 'in' => 'query', + 'schema' => ['description' => 'The name of the table level.', 'type' => 'string', 'example' => 'Level name', 'required' => false, 'docRequired' => true, 'title' => ''], ], [ - 'name' => 'RootNodeId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1234', - ], + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The description of the table level.', 'type' => 'string', 'example' => 'Level description', 'required' => false, 'title' => ''], ], [ - 'name' => 'IncludeNodeIds', - 'in' => 'formData', + 'name' => 'LevelId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the table level. You can call the ListTableLevel operation to query the ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '123', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '74324,74325', + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'abcde', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified parameters are invalid.', 'title' => ''], + 'UpdateResult' => ['description' => 'Indicates whether the table level is updated.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '1031203110005', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"abcde\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"UpdateResult\\": true,\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'UpdateTableLevel', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'translator' => 'manual', + ], + 'UpdateTableModelInfo' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ExcludeNodeIds', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => ' 1234', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '78385', + 'abilityTreeNodes' => ['FEATUREdideRZEBFC'], + ], + 'parameters' => [ [ - 'name' => 'BizBeginTime', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '00:00:00', - ], + 'name' => 'FirstLevelThemeId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the first-level table folder.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '101', 'title' => ''], ], [ - 'name' => 'BizEndTime', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '23:00:00', - ], + 'name' => 'SecondLevelThemeId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the second-level table folder.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '101', 'title' => ''], ], [ - 'name' => 'Parallelism', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => true, - 'docRequired' => true, - 'example' => 'false', - ], + 'name' => 'LevelId', + 'in' => 'query', + 'schema' => ['description' => 'The table level ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '101', 'title' => ''], ], [ - 'name' => 'EndBizDate', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2020-05-21 00:00:00', - ], + 'name' => 'TableGuid', + 'in' => 'query', + 'schema' => ['description' => 'The GUID of the table. Specify the GUID in the odps.{projectName}.{tableName} format.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'odps.test.table1', 'title' => ''], ], [ - 'name' => 'NodeParams', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '{74324:"key1=val1 key2=val"}', - ], + 'name' => 'LevelType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the table level. Valid values: 1 and 2. The value 1 indicates the logical level. The value 2 indicates the physical level.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '0', 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -63447,129 +40659,75 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'E6F0DBDD-5AD****', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Data' => [ - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'example' => '111', - 'format' => 'int64', - ], - ], + 'UpdateResult' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'abcde', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Data\\": [\\n 111\\n ]\\n}","errorExample":""},{"type":"xml","example":"E6F0DBDD-5AD****\\n200\\n111\\nInvalid.Tenant.ConnectionNotExists\\nThe connection does not exist.\\ntrue","errorExample":""}]', - 'title' => 'CreateDagComplement', + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ], + ], + 'title' => 'UpdateTableModelInfo', + 'summary' => 'Modifies the information about a table, such as the table folder, level, and category.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateDagTest' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"UpdateResult\\": true,\\n \\"RequestId\\": \\"abcde\\"\\n}","type":"json"}]', + ], + 'UpdateTableTheme' => [ + 'summary' => 'Updates a table theme. This operation will be replaced soon. We recommend that you do not call this operation.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => true, + 'operationType' => 'write', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '78386', + 'abilityTreeNodes' => ['FEATUREdideRZEBFC'], ], 'parameters' => [ [ - 'name' => 'ProjectEnv', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'PROD', - 'enum' => [ - 'PROD', - 'DEV', - ], - ], - ], - [ - 'name' => 'Bizdate', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2020-05-26 00:00:00', - ], + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '123', 'title' => ''], ], [ 'name' => 'Name', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'xm_create_test', - ], - ], - [ - 'name' => 'NodeId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1234', - ], + 'in' => 'query', + 'schema' => ['description' => 'The name of the theme.', 'type' => 'string', 'example' => 'Topic name', 'required' => true, 'docRequired' => true, 'title' => ''], ], [ - 'name' => 'NodeParams', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'bizdate=$bizdate tbods=$tbods', - ], + 'name' => 'ThemeId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the theme.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '1', 'example' => '123', 'title' => ''], ], ], 'responses' => [ @@ -63577,217 +40735,155 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3333333', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'E6F0DBDD-5AD****', - ], - 'ErrorCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'abcd', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The specified parameters are invalid.', 'title' => ''], + 'UpdateResult' => ['description' => 'Indicates whether the update result is returned. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => '1031203110005', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": 3333333,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"E6F0DBDD-5AD****\\n200\\n3333333\\nInvalid.Tenant.ConnectionNotExists\\nThe connection does not exist.\\ntrue","errorExample":""}]', - 'title' => 'CreateDagTest', + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.Api.Risk', 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"abcd\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"UpdateResult\\": true,\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'UpdateTableTheme', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'CreateManualDag' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'translator' => 'manual', + ], + 'UpdateUdfFile' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'deprecated' => true, + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', + 'abilityTreeCode' => '78387', + 'abilityTreeNodes' => ['FEATUREdide8FM783'], ], 'parameters' => [ [ - 'name' => 'ProjectEnv', + 'name' => 'FileFolderPath', 'in' => 'formData', - 'schema' => [ - 'description' => 'The environment type of Operation Center. Valid values: PROD and DEV.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '', - 'enum' => [ - 'PROD', - 'DEV', - ], - ], + 'schema' => ['description' => 'The path of the folder in which the function file is stored.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Business_process/First_Business_Process/function/string_processing_function', 'title' => ''], ], [ - 'name' => 'ProjectName', + 'name' => 'ProjectId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the workspace to which the manually triggered workflow belongs.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test_workspace', - ], + 'schema' => ['description' => 'The ID of the DataWorks workspace. You can click the Workspace Manage icon in the upper-right corner of the DataStudio page to go to the Workspace Management page and view the workspace ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10000', 'title' => ''], ], [ - 'name' => 'FlowName', + 'name' => 'FunctionType', 'in' => 'formData', 'schema' => [ - 'description' => 'The name of the manually triggered workflow.'."\n", + 'description' => 'The type of the function. Valid values: MATH, AGGREGATE, STRING, DATE, ANALYTIC, and OTHER. This parameter corresponds to the Function Type parameter in the Register Function section of the configuration tab of the function on the DataStudio page.'."\n", + 'enumValueTitles' => [], 'type' => 'string', 'required' => true, 'docRequired' => true, - 'example' => 'test_workflow', + 'enum' => ['MATH', 'AGGREGATE', 'STRING', 'DATE', 'ANALYTIC', 'OTHER'], + 'example' => 'STRING', + 'title' => '', ], ], [ - 'name' => 'BizDate', + 'name' => 'ClassName', 'in' => 'formData', - 'schema' => [ - 'description' => 'The data timestamp. The value of the data timestamp must be one or more days before the current date. For example, if the current date is November 11, 2020, set the value to 2020-11-10 00:00:00 or earlier. Configure this parameter in the YYYY-MM-DD 00:00:00 format.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2020-11-11 00:00:00', - ], + 'schema' => ['description' => 'The name of the class in which the function is defined. This parameter corresponds to the Class Name parameter in the Register Function section of the configuration tab of the function in the DataWorks console.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'com.alibaba.DataWorks.api.udf.StringConcat', 'title' => ''], ], [ - 'name' => 'NodeParameters', + 'name' => 'Resources', 'in' => 'formData', - 'schema' => [ - 'description' => 'The parameters transmitted between nodes in the manually triggered workflow. The parameters are in the following JSON format: `{ "": "Scheduling parameter settings of the node, which are in the same format as the parameters in the Scheduling Parameter section on the Properties tab of the DataStudio page", "": "Scheduling parameter settings of the node, which are in the same format as the parameters in the Scheduling Parameter section on the Properties tab of the DataStudio page" }`'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '{"20000123121": "key1=val2 key2=val2", "20000123124": "kkkk=vvvvv aaaa=bbbb"}', - ], + 'schema' => ['description' => 'The names of the resources that are referenced by the function. This parameter corresponds to the Resources parameter in the Register Function section of the configuration tab of the function in the DataWorks console. Separate multiple resource names with commas (,).'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'string-concat-1.0.0.jar,commons-lang-2.6.jar', 'title' => ''], ], [ - 'name' => 'DagParameters', + 'name' => 'UdfDescription', 'in' => 'formData', - 'schema' => [ - 'description' => 'The parameters of the manually triggered workflow, which are synchronized to all the instances in the directed acyclic graph (DAG) of the workflow. If a workflow parameter specified in DagParameters is referenced as a scheduling parameter of a node, the value of the scheduling parameter is replaced with the value of the workflow parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '{"kaaaa": "vaaaaa", "kbbbb": "vbbbbb"}', - ], + 'schema' => ['description' => 'The description of the function. This parameter corresponds to the Description parameter in the Register Function section of the configuration tab of the function on the DataStudio page.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Concatenate several strings to generate a new string', 'title' => ''], ], [ - 'name' => 'IncludeNodeIds', + 'name' => 'CmdDescription', 'in' => 'formData', - 'schema' => [ - 'description' => 'The IDs of the nodes that you want to run.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '74324,74325', - ], + 'schema' => ['description' => 'The syntax used for calling the function. This parameter corresponds to the Expression Syntax parameter in the Register Function section of the configuration tab of the function in the DataWorks console.'."\n", 'type' => 'string', 'required' => false, 'example' => 'StringConcat(String... substrs)', 'title' => ''], ], [ - 'name' => 'ExcludeNodeIds', + 'name' => 'ParameterDescription', 'in' => 'formData', 'schema' => [ - 'description' => 'The IDs of the nodes that do not need to be run.'."\n", + 'description' => 'The description of the input parameters of the function. This parameter corresponds to the Parameter Description parameter in the Register Function section of the configuration tab of the function on the DataStudio page.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* ALL_ALLOWD'."\n" + .'* FAILURE_ALLOWED'."\n" + .'* ALL_DENIED'."\n", + 'enumValueTitles' => [], 'type' => 'string', 'required' => false, - 'example' => '123,456', + 'default' => 'ALL_ALLOWED', + 'enum' => ['ALL_ALLOWD', 'FAILURE_ALLOWED', 'ALL_DENIED'], + 'example' => 'List of strings to be connected', + 'title' => '', ], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'DagId' => [ - 'description' => 'The ID of the DAG for the manually triggered workflow. You can call an operation with this parameter as a request parameter to query the details and states of the nodes in the manually triggered workflow.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '700000123123141', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'AASFDFSDFG-DFSDF-DFSDFD-SDFSDF', - ], - ], - ], + [ + 'name' => 'ReturnValue', + 'in' => 'formData', + 'schema' => ['description' => 'The description of the return value of the function. This parameter corresponds to the Return Value parameter in the Register Function section of the configuration tab of the function on the DataStudio page.'."\n", 'type' => 'string', 'required' => false, 'default' => 'false', 'example' => 'New strings generated by concatenating all strings before and after the input order', 'title' => ''], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"DagId\\": 700000123123141,\\n \\"RequestId\\": \\"AASFDFSDFG-DFSDF-DFSDFD-SDFSDF\\"\\n}","errorExample":""},{"type":"xml","example":"\\n 700000123123141\\n AASFDFSDFG-DFSDF-DFSDFD-SDFSDF\\n","errorExample":""}]', - 'title' => 'CreateManualDag', - 'summary' => 'Triggers a manually triggered workflow to run. Before you call this operation, make sure that the manually triggered workflow is committed and deployed. You can find the manually triggered workflow on the Operation Center page only after the manually triggered workflow is committed and deployed.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DeleteConnection' => [ - 'summary' => 'Removes a data source.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'Example', + 'in' => 'formData', + 'schema' => ['description' => 'The example for calling the function. This parameter corresponds to the Example parameter in the Register Function section of the configuration tab of the function in the DataWorks console.'."\n", 'type' => 'string', 'required' => false, 'example' => 'StringConcat(\'a\', \'b\', \'c\')', 'title' => ''], ], - ], - 'operationType' => 'write', - 'deprecated' => true, - 'systemTags' => [ - 'operationType' => 'delete', - ], - 'parameters' => [ [ - 'name' => 'ConnectionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The data source ID. You can call the [ListConnection](~~173911~~) operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => ['description' => 'The unique identifier of the DataWorks workspace. You can click the identifier in the upper-left corner of the DataStudio page to switch to another workspace.'."\n" + ."\n" + .'You must specify either this parameter or ProjectId to determine the DataWorks workspace to which the operation is applied.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dw_project', 'title' => ''], + ], + [ + 'name' => 'FileId', + 'in' => 'formData', + 'schema' => ['description' => 'The file ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1000000112', 'title' => ''], ], ], 'responses' => [ @@ -63795,2950 +40891,3110 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'Indicates whether the data source was removed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0bc1411515937635****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'The error message returned.'."\n", 'type' => 'string', 'example' => 'The connection does not exist.', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request. You can troubleshoot issues based on the ID.'."\n", 'type' => 'string', 'example' => '0000-ABCD-EFG****', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code returned.'."\n", 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Invalid.Tenant.ConnectionNotExists', - 'errorMessage' => 'The connection does not exist.', - ], - [ - 'errorCode' => 'Invalid.Tenant.ProjectNotExists', - 'errorMessage' => 'The project does not exist.', - ], - [ - 'errorCode' => 'Invalid.Tenant.UserNotInProject', - 'errorMessage' => 'The user is not in the project.', - ], - ], 403 => [ - [ - 'errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin', - 'errorMessage' => 'The user is not a project administrator or owner.', - ], - [ - 'errorCode' => 'Invalid.Tenant.UserNotInTenant', - 'errorMessage' => 'The user is not in tenant.', - ], + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], + ], + 429 => [ + ['errorCode' => 'Throttling.Api', 'errorMessage' => 'The request for this resource has exceeded your available limit.', 'description' => ''], + ['errorCode' => 'Throttling.System', 'errorMessage' => 'The DataWorks system is busy. Try again later.', 'description' => ''], + ['errorCode' => 'Throttling.User', 'errorMessage' => 'Your request is too frequent. Try again later.', 'description' => ''], + ], + 500 => [ + ['errorCode' => 'InternalError.System', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], + ['errorCode' => 'InternalError.UserId.Missing', 'errorMessage' => 'An internal system error occurred. Try again later.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": true,\\n \\"RequestId\\": \\"0bc1411515937635****\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"0bc1411515937635****\\n200\\ntrue\\ntrue","errorExample":""}]', - 'title' => 'DeleteConnection', + 'title' => 'UpdateUdfFile', + 'summary' => 'Updates the file information about a function.', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'UpdateConnection' => [ - 'summary' => 'Updates a data source.', - 'methods' => [ - 'put', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'UpdateWorkbenchEventResult' => [ + 'summary' => 'Returns the processing result sent by an extension after a process in Operation Center is blocked by the extension.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => true, + 'operationType' => 'readAndWrite', + 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'riskType' => 'high', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdide7FTVFZ', - ], + 'abilityTreeCode' => '103198', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB'], ], 'parameters' => [ [ - 'name' => 'Description', + 'name' => 'MessageId', 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the data source.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], + 'schema' => ['description' => 'The ID of the message received when the related extension point event is triggered after you enable message subscription by using the OpenEvent module.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '03400b03-b721-4c34-8727-2****1', 'title' => ''], ], [ - 'name' => 'EnvType', + 'name' => 'ExtensionCode', 'in' => 'query', - 'schema' => [ - 'description' => 'The environment in which the data source is used. Valid values: 0 and 1. The value 0 indicates the development environment. The value 1 indicates the production environment.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The code of the extension.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '58e95e2acd6f408e8707f1bf2591f9e9', 'title' => ''], ], [ - 'name' => 'Content', + 'name' => 'CheckResult', 'in' => 'query', 'schema' => [ - 'description' => 'The details of the data source. Examples of details of some common data sources:'."\n" - ."\n" - .'* odps'."\n" - ."\n" - .''."\n" - ."\n" - .' {'."\n" - .' "accessId": "xssssss",'."\n" - .' "accessKey": "xsaxsaxsa",'."\n" - .' "authType": 2,'."\n" - .' "endpoint": "http://service.odps.aliyun.com/api",'."\n" - .' "project": "xsaxsax",'."\n" - .' "tag": "public"'."\n" - .' }'."\n" - ."\n" - .'* mysql'."\n" - ."\n" - .''."\n" - ."\n" - .' {'."\n" - .' "database": "xsaxsa",'."\n" - .' "instanceName": "rm-xsaxsa",'."\n" - .' "password": "xsaxsa",'."\n" - .' "rdsOwnerId": "xasxsa",'."\n" - .' "regionId": "cn-shanghai",'."\n" - .' "tag": "rds",'."\n" - .' "username": "xsaxsa"'."\n" - .' }'."\n" - ."\n" - .'* rds'."\n" - ."\n" - .''."\n" - ."\n" - .' {'."\n" - .' "configType": 1,'."\n" - .' "tag": "rds",'."\n" - .' "database": "xsaxsa",'."\n" - .' "username": "xsaxsa",'."\n" - .' "password": "xssaxsa$32050",'."\n" - .' "instanceName": "rm-xsaxs",'."\n" - .' "rdsOwnerId": "11111111"'."\n" - .' }'."\n" - ."\n" - .'* oss'."\n" - ."\n" - .''."\n" - ."\n" - .' {'."\n" - .' "accessId": "sssssxx",'."\n" - .' "accessKey": "xsaxaxsaxs",'."\n" - .' "bucket": "xsa-xs-xs",'."\n" - .' "endpoint": "http://oss-cn-shanghai.aliyuncs.com",'."\n" - .' "tag": "public"'."\n" - .' }'."\n" - ."\n" - .'* sqlserver'."\n" - ."\n" - .''."\n" - ."\n" - .' {'."\n" - .' "jdbcUrl": "jdbc:sqlserver://xsaxsa-xsaxsa.database.xxx.cn:123;DatabaseName=xsxs-xsxs",'."\n" - .' "password": "sdasda$fs",'."\n" - .' "tag": "public",'."\n" - .' "username": "sxaxacdacdd"'."\n" - .' }'."\n" - ."\n" - .'* polardb'."\n" - ."\n" - .''."\n" - ."\n" - .' {'."\n" - .' "clusterId": "pc-sdadsadsa",'."\n" - .' "database": "dsadsadsa",'."\n" - .' "ownerId": "121212122",'."\n" - .' "password": "sdasdafssa",'."\n" - .' "region": "cn-shanghai",'."\n" - .' "tag": "polardb",'."\n" - .' "username": "asdadsads"'."\n" - .' }'."\n" - ."\n" - .'* oracle'."\n" - ."\n" - .''."\n" - ."\n" - .' {'."\n" - .' "jdbcUrl": "jdbc:oracle:saaa:@xxxxx:1521:PROD",'."\n" - .' "password": "sxasaxsa",'."\n" - .' "tag": "public",'."\n" - .' "username": "sasfadfa"'."\n" - .' }'."\n" - ."\n" - .'* mongodb'."\n" - ."\n" - .''."\n" - ."\n" - .' {'."\n" - .' "address": "[\\"xsaxxsa.mongodb.rds.aliyuncs.com:3717\\"]",'."\n" - .' "database": "admin",'."\n" - .' "password": "sadsda@",'."\n" - .' "tag": "public",'."\n" - .' "username": "dsadsadas"'."\n" - .' }'."\n" - ."\n" - .'* emr'."\n" - ."\n" - .''."\n" - ."\n" - .' {'."\n" - .' "accessId": "xsaxsa",'."\n" - .' "emrClusterId": "C-dsads",'."\n" - .' "emrResourceQueueName": "default",'."\n" - .' "emrEndpoint": "emr.aliyuncs.com",'."\n" - .' "accessKey": "dsadsad",'."\n" - .' "emrUserId": "224833315798889783",'."\n" - .' "name": "sasdsadsa",'."\n" - .' "emrAccessMode": "simple",'."\n" - .' "region": "cn-shanghai",'."\n" - .' "authType": "2",'."\n" - .' "emrProjectId": "FP-sdadsad"'."\n" - .' }'."\n" - ."\n" - .'* postgresql'."\n" - ."\n" - .''."\n" - ."\n" - .' {'."\n" - .' "jdbcUrl": "jdbc:postgresql://xxxx:1921/ssss",'."\n" - .' "password": "sdadsads",'."\n" - .' "tag": "public",'."\n" - .' "username": "sdsasda"'."\n" - .' }'."\n" - ."\n" - .'* analyticdb_for_mysql'."\n" - ."\n" - .''."\n" - ."\n" - .' {'."\n" - .' "instanceId": "am-sadsada",'."\n" - .' "database": "xsxsx",'."\n" - .' "username": "xsxsa",'."\n" - .' "password": "asdadsa",'."\n" - .' "connectionString": "am-xssxsxs.ads.aliyuncs.com:3306"'."\n" - .' }'."\n" - ."\n" - .'* hybriddb_for_postgresql'."\n" - ."\n" - .''."\n" - ."\n" - .' {'."\n" - .' "connectionString": "gp-xsaxsaxa-master.gpdbmaster.rds.aliyuncs.com",'."\n" - .' "database": "xsaxsaxas",'."\n" - .' "password": "xsaxsaxsa@11",'."\n" - .' "instanceId": "gp-xsaxsaxsa",'."\n" - .' "port": "541132",'."\n" - .' "ownerId": "xsaxsaxsas",'."\n" - .' "username": "sadsad"'."\n" - .' }'."\n" - ."\n" - .'* holo'."\n" - ."\n" - .''."\n" - ."\n" - .' {'."\n" - .' "accessId": "xsaxsaxs",'."\n" - .' "accessKey": "xsaxsaxsa",'."\n" - .' "database": "xsaxsaxsa",'."\n" - .' "instanceId": "xsaxa",'."\n" - .' "tag": "aliyun"'."\n" - .' }'."\n" - ."\n" - .'* kafka'."\n" - ."\n" - .''."\n" - ."\n" - .' {'."\n" - .' "instanceId": "xsax-cn-xsaxsa",'."\n" - .' "regionId": "cn-shanghai",'."\n" - .' "tag": "aliyun",'."\n" - .' "ownerId": "1212121212112"'."\n" - .' }'."\n", + 'description' => 'The check result of the extension point event. Valid values: OK and Fail.'."\n", 'type' => 'string', - 'required' => false, + 'required' => true, 'docRequired' => true, - 'example' => '{"database":"dbname","instanceName":"instancename","password":"password","rdsOwnerId":"123","username":"username"}', + 'example' => 'FAIL', + 'enum' => ['OK', 'FAIL', 'WARN'], + 'title' => '', ], ], [ - 'name' => 'Status', + 'name' => 'CheckResultTip', 'in' => 'query', - 'schema' => [ - 'description' => 'The status of the data source. Valid values: ENABLED and DISABLED. The value ENABLED indicates that the data source is in the normal state. The value DISABLED indicates that the data source is in an abnormal state.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ENABLED', - ], + 'schema' => ['description' => 'The cause of the check failure.'."\n", 'type' => 'string', 'example' => 'SQL is too long', 'required' => false, 'title' => ''], ], - [ - 'name' => 'ConnectionId', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The data source ID. You can call the [ListConnections](~~173911~~) operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1', + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0bc1ec92159376****'], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'Indicates whether the data source is updated.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0bc14115159376359****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - 'description' => '', - ], - ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc1ec92159376****\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'UpdateWorkbenchEventResult', + 'changeSet' => [ + ['createdAt' => '2022-03-28T03:23:24.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '299', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateWorkbenchEventResult'], + ], + ], + 'ramActions' => [], + ], + ], + 'endpoints' => [ + ['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dataworks.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'dataworks.cn-wulanchabu.aliyuncs.com', 'vpc' => 'dataworks-vpc.cn-wulanchabu.aliyuncs.com'], + ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dataworks.cn-beijing.aliyuncs.com', 'endpoint' => 'dataworks.cn-beijing.aliyuncs.com', 'vpc' => 'dataworks-vpc.cn-beijing.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dataworks.cn-shanghai.aliyuncs.com', 'endpoint' => 'dataworks.cn-shanghai.aliyuncs.com', 'vpc' => 'dataworks-vpc.cn-shanghai.aliyuncs.com'], + ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dataworks.cn-hongkong.aliyuncs.com', 'endpoint' => 'dataworks.cn-hongkong.aliyuncs.com', 'vpc' => 'dataworks-vpc.cn-hongkong.aliyuncs.com'], + ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dataworks.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'dataworks.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'dataworks-vpc.cn-zhangjiakou.aliyuncs.com'], + ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dataworks.cn-shenzhen.aliyuncs.com', 'endpoint' => 'dataworks.cn-shenzhen.aliyuncs.com', 'vpc' => 'dataworks-vpc.cn-shenzhen.aliyuncs.com'], + ['regionId' => 'ap-northeast-2', 'regionName' => 'South Korea (Seoul)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dataworks.ap-northeast-2.aliyuncs.com', 'endpoint' => 'dataworks.ap-northeast-2.aliyuncs.com', 'vpc' => 'dataworks-vpc.ap-northeast-2.aliyuncs.com'], + ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dataworks.ap-northeast-1.aliyuncs.com', 'endpoint' => 'dataworks.ap-northeast-1.aliyuncs.com', 'vpc' => 'dataworks-vpc.ap-northeast-1.aliyuncs.com'], + ['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dataworks.cn-chengdu.aliyuncs.com', 'endpoint' => 'dataworks.cn-chengdu.aliyuncs.com', 'vpc' => 'dataworks-vpc.cn-chengdu.aliyuncs.com'], + ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dataworks.ap-southeast-1.aliyuncs.com', 'endpoint' => 'dataworks.ap-southeast-1.aliyuncs.com', 'vpc' => 'dataworks-vpc.ap-southeast-1.aliyuncs.com'], + ['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dataworks.ap-southeast-3.aliyuncs.com', 'endpoint' => 'dataworks.ap-southeast-3.aliyuncs.com', 'vpc' => 'dataworks-vpc.ap-southeast-3.aliyuncs.com'], + ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dataworks.ap-southeast-5.aliyuncs.com', 'endpoint' => 'dataworks.ap-southeast-5.aliyuncs.com', 'vpc' => 'dataworks-vpc.ap-southeast-5.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'dataworks.cn-hangzhou.aliyuncs.com', 'endpoint' => 'dataworks.cn-hangzhou.aliyuncs.com', 'vpc' => 'dataworks-vpc.cn-hangzhou.aliyuncs.com'], + ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'dataworks.us-east-1.aliyuncs.com', 'endpoint' => 'dataworks.us-east-1.aliyuncs.com', 'vpc' => 'dataworks-vpc.us-east-1.aliyuncs.com'], + ['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'dataworks.eu-west-1.aliyuncs.com', 'endpoint' => 'dataworks.eu-west-1.aliyuncs.com', 'vpc' => 'dataworks-vpc.eu-west-1.aliyuncs.com'], + ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'dataworks.us-west-1.aliyuncs.com', 'endpoint' => 'dataworks.us-west-1.aliyuncs.com', 'vpc' => 'dataworks-vpc.us-west-1.aliyuncs.com'], + ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'dataworks.eu-central-1.aliyuncs.com', 'endpoint' => 'dataworks.eu-central-1.aliyuncs.com', 'vpc' => 'dataworks-vpc.eu-central-1.aliyuncs.com'], + ['regionId' => 'me-east-1', 'regionName' => 'UAE (Dubai)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'dataworks.me-east-1.aliyuncs.com', 'endpoint' => 'dataworks.me-east-1.aliyuncs.com', 'vpc' => 'dataworks-vpc.me-east-1.aliyuncs.com'], + ['regionId' => 'me-central-1', 'regionName' => 'Saudi Arabia (Riyadh)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'dataworks.me-central-1.aliyuncs.com', 'endpoint' => 'dataworks.me-central-1.aliyuncs.com', 'vpc' => 'dataworks-vpc.me-central-1.aliyuncs.com'], + ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => 'China South 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'dataworks.cn-shenzhen-finance-1.aliyuncs.com', 'endpoint' => 'dataworks.cn-shenzhen-finance-1.aliyuncs.com', 'vpc' => 'dataworks-vpc.cn-shenzhen-finance-1.aliyuncs.com'], + ['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'dataworks.cn-shanghai-finance-1.aliyuncs.com', 'endpoint' => 'dataworks.cn-shanghai-finance-1.aliyuncs.com', 'vpc' => 'dataworks-vpc.cn-shanghai-finance-1.aliyuncs.com'], + ['regionId' => 'cn-hangzhou-finance', 'regionName' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'dataworks.aliyuncs.com', 'endpoint' => 'dataworks.aliyuncs.com', 'vpc' => ''], + ], + 'errorCodes' => [ + ['code' => 'BusinessError.Dictionary.InvalidDictionaryOrNoPermission', 'message' => 'Data albums do not exist, or you do not have permissions.', 'http_code' => 500, 'description' => ''], + ['code' => 'BusinessError.Dictionary.InvalidUserId', 'message' => 'Invalid user ID.', 'http_code' => 500, 'description' => ''], + ['code' => 'BusinessError.Dictionary.MountDictionaryCountOverLimit', 'message' => 'The maximum number of directories that can be added is 8. No more directories can be added.', 'http_code' => 500, 'description' => ''], + ['code' => 'BusinessError.Dictionary.NoPermissionToUpdateOtherDictionary', 'message' => 'You have insufficient permissions, only administrators can modify directory of other people.', 'http_code' => 500, 'description' => ''], + ['code' => 'BusinessError.Dictionry.InvalidDictionryOrNoPermission', 'message' => 'Albums that do not exist or do not have permission cannot be mounted.', 'http_code' => 500, 'description' => ''], + ['code' => 'BusinessError.Dictionry.MountDictionryCountOverlimit', 'message' => 'The maximum mount limit is 8, and cannot continue to mount.', 'http_code' => 500, 'description' => ''], + ['code' => 'ConnectionAlreadyExist', 'message' => 'The connection with envType %s and name %s already exists.', 'http_code' => 400, 'description' => 'ConnectionAlreadyExist'], + ['code' => 'DataSource.CheckRamRoleFailure', 'message' => 'Failed to check the RAM role. AccountId %s. roleArn %s.', 'http_code' => 400, 'description' => ''], + ['code' => 'DataSource.ConnectionStrProperty.PatternNotMatch', 'message' => 'The pattern value %s is invalid. The correct pattern is %s.', 'http_code' => 400, 'description' => ''], + ['code' => 'DataSource.NotFound', 'message' => 'The specified data source ID %s does not exist.', 'http_code' => 400, 'description' => ''], + ['code' => 'DESENSPLAN.DATATYPE.ERROR', 'message' => 'Sensitive type already has a desensitization rule.', 'http_code' => 400, 'description' => 'Desensitization rules have been configured for sensitive types.'], + ['code' => 'DESENSPLAN.DATATYPENOTEXIST.ERROR', 'message' => 'Sensitive type not exist.', 'http_code' => 400, 'description' => 'The sensitive type does not exist.'], + ['code' => 'DESENSPLAN.ID.ERROR', 'message' => 'Desensitization rule ID does not exist.', 'http_code' => 400, 'description' => 'The desensitization rule ID does not exist.'], + ['code' => 'DESENSPLAN.PAGESIZE.ERROR', 'message' => 'Page size is too large, maximum of 100.', 'http_code' => 400, 'description' => 'Page size limit, up to 100'], + ['code' => 'DESENSPLAN.PARAM.ERROR', 'message' => 'Desensitization rule parameter error.', 'http_code' => 400, 'description' => 'The desensitization rule parameter is incorrect.'], + ['code' => 'DESENSPLAN.SCENECODE.ERROR', 'message' => 'Scene code does not exist.', 'http_code' => 400, 'description' => 'Scene code does not exist'], + ['code' => 'DESENSPLAN.SCENEID.ERROR', 'message' => 'Scene ID does not exist.', 'http_code' => 400, 'description' => 'Scene ID does not exist.'], + ['code' => 'DESENSPLAN.SCENEIDLEVEL.ERROR', 'message' => 'The scene is not a secondary scene.', 'http_code' => 400, 'description' => 'The scene is not a secondary scene.'], + ['code' => 'DESENSPLAN.SIZE.ERROR', 'message' => 'The number of desens plan exceeds the limit.', 'http_code' => 400, 'description' => 'The number of desensitization rules exceeded the limit.'], + ['code' => 'DESENSSCENE.ID.ERROR', 'message' => 'The desensitization scenario ID does not match or does not exist with the tenant.', 'http_code' => 400, 'description' => 'The scenario ID does not exist or does not belong to the tenant.'], + ['code' => 'DESENSSCENE.IDLEVEL.ERROR', 'message' => 'The desensitization scenario is not a secondary scenario.', 'http_code' => 400, 'description' => ''], + ['code' => 'DESENSSCENE.PROJECT.ERROR', 'message' => 'The project space does not exist.', 'http_code' => 400, 'description' => ''], + ['code' => 'DESENSSCENE.SIZE.ERROR', 'message' => 'The number of desens scene exceeds the limit.', 'http_code' => 400, 'description' => 'Number of desensitization scenarios chao xian'], + ['code' => 'DESENSSCENE.UESRGROUP.ERROR', 'message' => 'The user group ID does not match the tenant or does not exist.', 'http_code' => 400, 'description' => 'The user group ID does not exist or does not belong to the tenant.'], + ['code' => 'DESENSSTATUS.ID.ERROR', 'message' => 'The desens status switch ID does not match or does not exist with the tenant.', 'http_code' => 400, 'description' => 'the desensitization switch id does not exist or does not belong to the tenant'], + ['code' => 'DESENSSTATUS.PAGESIZE.ERROR', 'message' => 'Page size is too large, maximum of 100.', 'http_code' => 400, 'description' => 'Page size exceeded limit, up to 100.'], + ['code' => 'DESENSSTATUS.SCENECODE.ERROR', 'message' => 'Scene code does not exist.', 'http_code' => 400, 'description' => 'Scene code does not exist.'], + ['code' => 'DESENSSTATUS.SIZE.ERROR', 'message' => 'The number of desens status exceeds the limit.', 'http_code' => 400, 'description' => 'The number of desensitization switches exceeds the limit'], + ['code' => 'DESENSTEMPLATE.SCENE.ERROR', 'message' => 'Scene ID does not exist.', 'http_code' => 400, 'description' => 'Scene ID does not exist.'], + ['code' => 'DESENSTEMPLATE.SCENELEVEL.ERROR', 'message' => 'The scene is not a secondary scene.', 'http_code' => 400, 'description' => 'The scene is not a secondary scene.'], + ['code' => 'ENGINE.NOT.ALLOW', 'message' => 'engine not allow.', 'http_code' => 400, 'description' => 'Engine type not allowed'], + ['code' => 'Execute.FML.ProcessError', 'message' => 'Failed to execute FML statement.', 'http_code' => 500, 'description' => 'The FML statement fails to be executed. Try again later.'], + ['code' => 'Execute.FML.SystemError', 'message' => 'A system error occurred. FML statement execution failed.', 'http_code' => 500, 'description' => 'System error. The FML statement fails to be executed. Check whether the parameters that are included in the FML statement are correctly configured.'], + ['code' => 'Forbidden.Access', 'message' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'http_code' => 403, 'description' => 'No permission, please authorize'], + ['code' => 'Forbidden.DI.NoPrivilege', 'message' => 'No access.', 'http_code' => 403, 'description' => ''], + ['code' => 'Forbidden.Meta.NoTenant', 'message' => 'The user is not the owner of any tenants.', 'http_code' => 403, 'description' => 'The user is not the owner of any tenants.'], + ['code' => 'Forbidden.Wkbench.BaselineNoPermission', 'message' => 'You are not authorized to access the baseline.', 'http_code' => 400, 'description' => 'You are not authorized to access the baseline.'], + ['code' => 'Forbidden.Wkbench.NoProject', 'message' => 'You have not joined any project.', 'http_code' => 400, 'description' => 'You have not joined any project.'], + ['code' => 'Forbidden.Wkbench.ProjectNoPermission', 'message' => 'You are not authorized to access the workspace.', 'http_code' => 400, 'description' => 'You are not authorized to access the workspace.'], + ['code' => 'Forbidden.Wkbench.RemindNoPermission', 'message' => 'You are not authorized to modify the reminder.', 'http_code' => 401, 'description' => 'You are not authorized to modify the reminder.'], + ['code' => 'Forbidden.Wkbench.RemindOverlimit', 'message' => 'The maximum number of reminders is exceeded.', 'http_code' => 400, 'description' => 'The maximum number of reminders is exceeded.'], + ['code' => 'Forbidden.Wkbench.Unpurchase', 'message' => 'You have not purchased the service.', 'http_code' => 400, 'description' => 'You have not purchased the service.'], + ['code' => 'Forbidden.Wkbench.UserNotExist', 'message' => 'The user does not exist.', 'http_code' => 401, 'description' => 'The user does not exist.'], + ['code' => 'Guard.Fail.Acl.Auth', 'message' => 'Failed to run the authorization command.', 'http_code' => 400, 'description' => ''], + ['code' => 'Guard.Fail.Auth.Task', 'message' => 'Failed to run the authorization job.', 'http_code' => 400, 'description' => ''], + ['code' => 'Guard.Fail.External.Interface', 'message' => 'An error occurred while calling external API.', 'http_code' => 400, 'description' => ''], + ['code' => 'Guard.Fail.MaxCompute.Commnd', 'message' => 'Failed to run the MaxCompute command.', 'http_code' => 400, 'description' => ''], + ['code' => 'Guard.Invalid.Account', 'message' => 'Failed to query the account information.', 'http_code' => 400, 'description' => ''], + ['code' => 'Guard.Invalid.ApproveAction', 'message' => 'The specified approval action is not supported.', 'http_code' => 400, 'description' => ''], + ['code' => 'Guard.Invalid.Approver', 'message' => 'No valid approval person is found.', 'http_code' => 400, 'description' => ''], + ['code' => 'Guard.Invalid.AuthObject', 'message' => 'The authorization object does not exist.', 'http_code' => 400, 'description' => ''], + ['code' => 'Guard.Invalid.Date', 'message' => 'Failed to parse the date format.', 'http_code' => 400, 'description' => ''], + ['code' => 'Guard.Invalid.Engine', 'message' => 'The engine type is not supported.', 'http_code' => 400, 'description' => ''], + ['code' => 'Guard.Invalid.Flow', 'message' => 'The specified approval item number does not exist.', 'http_code' => 400, 'description' => ''], + ['code' => 'Guard.Invalid.Flow.Finished', 'message' => 'The approval flow has ended.', 'http_code' => 400, 'description' => ''], + ['code' => 'Guard.Invalid.Flow.Permission', 'message' => 'You are not authorized to manage the approval item.', 'http_code' => 400, 'description' => ''], + ['code' => 'Guard.Invalid.Grantee', 'message' => 'The account to be authorized is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'Guard.Invalid.MaxCompute.Action', 'message' => 'The permission type of MaxCompute is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'Guard.Invalid.MaxCompute.Owner', 'message' => 'The owner of the MaxCompute project is not found.', 'http_code' => 400, 'description' => ''], + ['code' => 'Guard.Invalid.MaxCompute.Project', 'message' => 'The MaxCompute project is not found.', 'http_code' => 400, 'description' => ''], + ['code' => 'Guard.Invalid.Permission', 'message' => 'You are not authorized to perform the operation.', 'http_code' => 400, 'description' => ''], + ['code' => 'Guard.Not.Exists.Grantee', 'message' => 'The account to be authorized does not exist.', 'http_code' => 400, 'description' => ''], + ['code' => 'InternalError.DI.Parameter', 'message' => 'A DI internal error occurred.', 'http_code' => 500, 'description' => ''], + ['code' => 'InternalError.Meta.NoCalcEngine', 'message' => 'An error occurred while retrieving the compute engine based on the MaxCompute project.', 'http_code' => 400, 'description' => 'Incorrect project entered by user'], + ['code' => 'InternalError.Meta.TenantTimeOut', 'message' => 'Failed to connect to the interface network.', 'http_code' => 500, 'description' => 'Failed to connect to the interface network.'], + ['code' => 'InternalError.Meta.Unknown', 'message' => 'An unknown error occurred while processing your request.', 'http_code' => 500, 'description' => 'An unknown error occurred while processing your request.'], + ['code' => 'InternalError.System', 'message' => 'An internal error occurred.', 'http_code' => 500, 'description' => 'InternalError '], + ['code' => 'InternalError.Wkbench.ServiceError', 'message' => 'An internal error occurred.', 'http_code' => 500, 'description' => 'An internal error occurred.'], + ['code' => 'InternalError.Wkbench.SystemCallFail', 'message' => 'System call failed.', 'http_code' => 500, 'description' => 'System call failed.'], + ['code' => 'Invalid.CalcEngineEnvType', 'message' => 'The specified envType %s is invalid.', 'http_code' => 400, 'description' => 'The specify env type %s invalid'], + ['code' => 'Invalid.CalcEngineType', 'message' => 'The specified calcEngineType %s is invalid.', 'http_code' => 400, 'description' => 'The specify calc engine type %s invalid.'], + ['code' => 'Invalid.Connection.Empty', 'message' => 'You must specify the connection parameter.', 'http_code' => 400, 'description' => 'Connection param is empty.'], + ['code' => 'Invalid.DataSource.DataSourceStatus', 'message' => 'The specified dataSourceStatus %s is invalid.', 'http_code' => 400, 'description' => 'The specify data source status %s invalid.'], + ['code' => 'Invalid.DataSource.DataSourceTypeNotExist', 'message' => 'The data source type %s does not exist.', 'http_code' => 400, 'description' => 'The dataSource type %s are not exist.'], + ['code' => 'Invalid.DataSource.DataSourceTypeNotSupport', 'message' => 'The dataSourceType %s and subType %s are not supported.', 'http_code' => 400, 'description' => 'DataSource type not support yet.'], + ['code' => 'Invalid.DI.Parameter', 'message' => 'The parameter is invalid.', 'http_code' => 400, 'description' => ''], + ['code' => 'Invalid.DI.Parameter.File.Existed', 'message' => 'The file name already exists.', 'http_code' => 400, 'description' => ''], + ['code' => 'Invalid.DQC.Parameter', 'message' => 'The specified parameters are invalid.', 'http_code' => 500, 'description' => 'The specified parameters are invalid.'], + ['code' => 'Invalid.Meta.AppNotExist', 'message' => 'The MaxCompute project does not exist.', 'http_code' => 400, 'description' => 'The MaxCompute project does not exist.'], + ['code' => 'Invalid.Meta.CategoryForbidden', 'message' => 'Failed to delete the category. The current category is associated with a table and cannot be operated.', 'http_code' => 403, 'description' => 'Failed to delete the category because the table associated with the category does not exist.'], + ['code' => 'Invalid.Meta.CategoryIllegalDepth', 'message' => 'A category can contain a maximum of 4 levels.', 'http_code' => 400, 'description' => 'A category can contain a maximum of 4 levels.'], + ['code' => 'Invalid.Meta.CategoryIllegalTenant', 'message' => 'The tenant ID is different in the parent and child categories.', 'http_code' => 403, 'description' => 'The tenant ID is different in the parent and child categories.'], + ['code' => 'Invalid.Meta.CategoryNameDuplicate', 'message' => 'The category name is duplicated at this level.', 'http_code' => 400, 'description' => 'The category name is duplicated at this level.'], + ['code' => 'Invalid.Meta.CategoryRelationDuplicate"', 'message' => 'The table is already bound to the category.', 'http_code' => 400, 'description' => 'The table is already bound to the category.'], + ['code' => 'Invalid.Meta.TableNotExist', 'message' => 'The table does not exist.', 'http_code' => 400, 'description' => 'The table does not exist.'], + ['code' => 'Invalid.Operation', 'message' => 'You cannot delete the bindingCalcEngine that is bound to the data source.', 'http_code' => 400, 'description' => 'Can not delete datasource bindingCalcEngine.'], + ['code' => 'Invalid.Param.Odps.EngineIdOrConnectStrEmpty', 'message' => 'You must specify at least one of the compute engine ID and the connection string when the data source type is ODPS.', 'http_code' => 400, 'description' => 'The calculation engine id or connection str can not be empty at the same time when the dataSource type is odps.'], + ['code' => 'Invalid.Tenant.ConnectionNotExists', 'message' => 'The connection does not exist.', 'http_code' => 400, 'description' => 'The connection does not exist.'], + ['code' => 'Invalid.Tenant.ProjectNotExists', 'message' => 'The project does not exist.', 'http_code' => 400, 'description' => 'The project does not exist.'], + ['code' => 'Invalid.Tenant.UserAlreadyInProject', 'message' => 'The user already exists in the project.', 'http_code' => 400, 'description' => 'The user has already existed in project.'], + ['code' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin', 'message' => 'The user is not a project administrator or owner.', 'http_code' => 403, 'description' => 'The user is not a project administrator or owner.'], + ['code' => 'Invalid.Tenant.UserNotInProject', 'message' => 'The user is not in the project.', 'http_code' => 400, 'description' => 'The user is not in the project.'], + ['code' => 'Invalid.Tenant.UserNotInTenant', 'message' => 'The user is not in tenant.', 'http_code' => 403, 'description' => 'The user is not in tenant.'], + ['code' => 'Invalid.Tenant.UserNotInTenant', 'message' => 'The user is not in the tenant.', 'http_code' => 400, 'description' => 'The user is not in the tenant.'], + ['code' => 'Invalid.Wkbench.BaselineNotExist', 'message' => 'The baseline does not exist.', 'http_code' => 400, 'description' => 'The baseline does not exist.'], + ['code' => 'Invalid.Wkbench.BaselineStatusNotExist', 'message' => 'The BaselineStatus does not exist.', 'http_code' => 400, 'description' => 'The BaselineStatus does not exist.'], + ['code' => 'Invalid.Wkbench.InstanceNotExist', 'message' => 'The instance does not exist.', 'http_code' => 400, 'description' => 'The instance does not exist.'], + ['code' => 'Invalid.Wkbench.NodeNotExist', 'message' => 'The node does not exist.', 'http_code' => 400, 'description' => 'The node does not exist.'], + ['code' => 'Invalid.Wkbench.Parameter', 'message' => 'The specified parameters are invalid.', 'http_code' => 400, 'description' => 'The specified parameters are invalid.'], + ['code' => 'Invalid.Wkbench.RemindNotExist', 'message' => 'The reminder does not exist.', 'http_code' => 400, 'description' => 'The reminder does not exist.'], + ['code' => 'Invalid.Wkbench.TopicNotExist', 'message' => 'The topic does not exist.', 'http_code' => 400, 'description' => 'The topic does not exist.'], + ['code' => 'InvalidParameter', 'message' => 'The specified parameter is not valid.', 'http_code' => 400, 'description' => ''], + ['code' => 'InvalidParameter.Meta.CommonError', 'message' => 'The specified parameter is invalid.', 'http_code' => 400, 'description' => 'The request parameter is invalid.'], + ['code' => 'InvalidParameter.Meta.GuidFormat', 'message' => 'The GUID format is invalid.', 'http_code' => 400, 'description' => 'The GUID format is invalid.'], + ['code' => 'InvalidParameter.Meta.Illegal', 'message' => 'The app guid parameter is invalid.', 'http_code' => 400, 'description' => 'The app guid parameter is invalid.'], + ['code' => 'InvalidParameter.Meta.IllegalDate', 'message' => 'The date format is invalid.', 'http_code' => 400, 'description' => 'The date format is invalid.'], + ['code' => 'InvalidParameter.Meta.IllegalPageError', 'message' => 'The parameter for paging is invalid.', 'http_code' => 400, 'description' => 'The parameter for paging is invalid.'], + ['code' => 'InvalidParameter.Meta.NotExist', 'message' => 'The data does not exist.', 'http_code' => 400, 'description' => 'No data is available.'], + ['code' => 'MissingParam.ConnectionStr.Property', 'message' => 'You must specify property %s required by the data source connection string.', 'http_code' => 400, 'description' => 'The data source connection str required property missing. '], + ['code' => 'Param.Invalid', 'message' => 'The parameter is invalid.', 'http_code' => 400, 'description' => 'Param invalid'], + ['code' => 'Param.Invalid.File.Existed', 'message' => 'The file name already exists.', 'http_code' => 400, 'description' => ''], + ['code' => 'PARAMS.ERROR', 'message' => 'param error.', 'http_code' => 400, 'description' => ''], + ['code' => 'PERMISSION.DENIED.ERROR', 'message' => 'Permission denied', 'http_code' => 403, 'description' => 'Insufficient permissions.'], + ['code' => 'Required.Parameter.Empty', 'message' => 'You must specify the parameter %s.', 'http_code' => 400, 'description' => ''], + ['code' => 'Throttling.Meta.CategoryRelationDuplicate', 'message' => 'The maximum number of categories is exceeded.', 'http_code' => 403, 'description' => 'The maximum number of categories is exceeded.'], + ['code' => 'Throttling.Resource', 'message' => 'the number of API calls that you can make has reached the upper limit. You can upgrade the edition of your DataWorks service to obtain a larger quota for the number of API calls.', 'http_code' => 429, 'description' => 'the number of API calls that you can make has reached the upper limit. You can upgrade the edition of your DataWorks service to obtain a larger quota for the number of API calls.'], + ['code' => 'UNKNOWN.ERROR', 'message' => 'unknown error.', 'http_code' => 500, 'description' => 'Unknown error.'], + ['code' => 'USERACCOUNT.OWNER.ERROR', 'message' => 'User list or owner user does not exist.', 'http_code' => 400, 'description' => 'User list or responsible user does not exist'], + ['code' => 'USERGROUP.ACCOUNTLISTSIZE.ERROR', 'message' => 'The number of account exceeds the limit.', 'http_code' => 400, 'description' => 'The number of users exceeds the limit'], + ['code' => 'USERGROUP.ID.ERROR', 'message' => 'The user group ID does not match the tenant or does not exist.', 'http_code' => 400, 'description' => 'The user group ID does not exist or does not belong to the tenant.'], + ['code' => 'USERGROUP.LISTSIZE.ERROR', 'message' => 'The number of user groups exceeds the limit.', 'http_code' => 400, 'description' => 'The number of user groups exceeds the limit'], + ['code' => 'USERGROUP.PAGESIZE.ERROR', 'message' => 'Page size is too large, maximum of 100.', 'http_code' => 400, 'description' => 'Page size limit, up to 100'], + ['code' => 'Valid.FML.NoPermission', 'message' => 'You are not authorized to access the project resources.', 'http_code' => 400, 'description' => 'You are not granted the required permissions to access the current project.'], + ['code' => 'Valid.FML.OnlySupportQueryStatement', 'message' => 'Only FML query statement is supported.', 'http_code' => 400, 'description' => 'Only FML statements are supported.'], + ['code' => 'Valid.FML.ProductExpired', 'message' => '智能数据建模产品购买已到期', 'http_code' => 400, 'description' => 'The Data Modeling feature that you purchase expires.'], + ['code' => 'Valid.FML.ProductNotActivated', 'message' => '智能数据建模产品未开通', 'http_code' => 400, 'description' => 'The Data Modeling feature is not enabled.'], + ['code' => 'Valid.FML.ProjectNotExist', 'message' => 'The project does not exist.', 'http_code' => 400, 'description' => 'Information about the project is not found. Check input parameters.'], + ['code' => 'Valid.FML.StatementNotValid', 'message' => 'The FML statement is invalid.', 'http_code' => 400, 'description' => 'The FML statement is invalid. For information about the FML syntax, see https://dataworks-doc.yuque.com/docs/share/ff7899ed-c433-4970-b20e-6582ea3939f3?#.'], + ['code' => 'WHITELIST.DESENSID.ERROR', 'message' => 'The desensitization rule ID does not match or does not exist with the tenant.', 'http_code' => 400, 'description' => 'The scenario ID does not exist or does not belong to the tenant.'], + ['code' => 'WHITELIST.ENDTIME.ERROR', 'message' => 'end time cannot be earlier than start time.', 'http_code' => 400, 'description' => 'The end time cannot be earlier than the start time.'], + ['code' => 'WHITELIST.ID.ERROR', 'message' => 'The whitelist ID does not match or does not exist with the tenant.', 'http_code' => 400, 'description' => 'The whitelist ID does not exist or does not belong to the tenant.'], + ['code' => 'WHITELIST.MCPROJECT.ERROR', 'message' => 'The projectName on the bottom layer desensitization whitelist of MC cannot be empty.', 'http_code' => 400, 'description' => 'ProjectName cannot be empty when creating MC desensitization whitelist'], + ['code' => 'WHITELIST.PAGESIZE.ERROR', 'message' => 'Page size is too large, maximum of 100.', 'http_code' => 400, 'description' => 'Page size exceeded, cannot exceed 100'], + ['code' => 'WHITELIST.SIZE.ERROR', 'message' => 'The number of white list exceeds the limit.', 'http_code' => 400, 'description' => 'Whitelist quantity exceeded'], + ['code' => 'WHITELIST.STARTTIME.ERROR', 'message' => 'start time cannot be earlier than today.', 'http_code' => 400, 'description' => 'Start time cannot be earlier than today'], + ['code' => 'WHITELIST.TIMEFORMAT.ERROR', 'message' => 'The time format is incorrect, please use yyyy MM dd HH: mm: ss format.', 'http_code' => 400, 'description' => 'The time parameter is formatted incorrectly. You need to use yyyy MM dd HH: mm: ss.'], + ['code' => 'WHITELIST.USERGROUP.ERROR', 'message' => 'The user group ID does not match or does not exist with the tenant.', 'http_code' => 400, 'description' => 'The user group ID does not exist or does not belong to the tenant.'], + ['code' => 'WHITELIST.USERGROUPEMPTY.ERROR', 'message' => 'User group ID cannot be empty.', 'http_code' => 400, 'description' => 'User group ID cannot be empty'], + ['code' => 'WHITELIST.USERGROUPLISTSIZE.ERROR', 'message' => 'The number of user group exceeds the limit.', 'http_code' => 400, 'description' => 'The number of user groups exceeds the limit.'], + ], + 'changeSet' => [ + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListFiles'], + ['description' => 'Request parameters changed', 'api' => 'ListFiles'], + ], + 'createdAt' => '2025-04-27T02:21:22.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'UpdateDISyncTask'], + ], + 'createdAt' => '2025-04-24T03:30:56.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListFiles'], + ], + 'createdAt' => '2025-04-07T12:30:07.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateFile'], + ['description' => 'Request parameters changed', 'api' => 'UpdateFile'], + ], + 'createdAt' => '2025-04-07T07:20:31.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListFiles'], + ], + 'createdAt' => '2025-03-27T12:30:29.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreatePermissionApplyOrder'], + ['description' => 'Response parameters changed, Response parameters changed', 'api' => 'GetPermissionApplyOrderDetail'], + ], + 'createdAt' => '2025-03-27T11:02:38.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListPermissionApplyOrders'], + ], + 'createdAt' => '2025-03-27T09:55:16.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'RunTriggerNode'], + ], + 'createdAt' => '2025-02-20T12:32:08.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListBaselineStatuses'], + ], + 'createdAt' => '2025-02-20T11:28:01.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateFile'], + ['description' => 'Response parameters changed', 'api' => 'GetFile'], + ['description' => 'Request parameters changed', 'api' => 'UpdateFile'], + ], + 'createdAt' => '2025-02-08T09:17:51.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListCheckProcesses'], + ], + 'createdAt' => '2025-01-23T02:49:19.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetDISyncTask'], + ], + 'createdAt' => '2025-01-13T02:51:48.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateFile'], + ['description' => 'Response parameters changed', 'api' => 'GetFile'], + ['description' => 'Request parameters changed', 'api' => 'UpdateFile'], + ], + 'createdAt' => '2024-12-13T08:37:26.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'UpdateQualityRule'], + ], + 'createdAt' => '2024-11-14T02:10:30.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListNodes'], + ], + 'createdAt' => '2024-10-17T06:48:39.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetNode'], + ], + 'createdAt' => '2024-09-26T12:06:13.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDISyncTask'], + ], + 'createdAt' => '2024-09-23T01:45:50.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetRemind'], + ], + 'createdAt' => '2024-09-18T07:12:08.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetFile'], + ], + 'createdAt' => '2024-09-03T06:54:21.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListTables'], + ], + 'createdAt' => '2024-09-03T03:01:49.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateFile'], + ['description' => 'Response parameters changed', 'api' => 'GetFile'], + ['description' => 'Request parameters changed', 'api' => 'UpdateFile'], + ], + 'createdAt' => '2024-09-02T08:43:53.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DeleteLineageRelation'], + ], + 'createdAt' => '2024-08-14T02:36:59.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetQualityRule'], + ], + 'createdAt' => '2024-06-18T06:52:56.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDIJob'], + ['description' => 'Response parameters changed', 'api' => 'GetDIJob'], + ], + 'createdAt' => '2024-06-04T02:51:48.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetNode'], + ['description' => 'Response parameters changed', 'api' => 'GetNodeChildren'], + ['description' => 'Response parameters changed', 'api' => 'GetNodeParents'], + ], + 'createdAt' => '2024-05-30T14:19:19.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'CreateQualityEntity'], + ['description' => 'Response parameters changed', 'api' => 'CreateQualityRelativeNode'], + ['description' => 'Response parameters changed', 'api' => 'DeleteQualityEntity'], + ['description' => 'Response parameters changed', 'api' => 'DeleteQualityRelativeNode'], + ], + 'createdAt' => '2024-05-10T06:31:44.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'SubmitDataServiceApi'], + ], + 'createdAt' => '2024-04-23T02:32:41.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateFile'], + ], + 'createdAt' => '2024-04-03T06:18:18.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'UpdateFile'], + ], + 'createdAt' => '2024-04-03T03:45:36.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateProject'], + ], + 'createdAt' => '2024-03-29T08:33:57.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'DeleteProjectMember'], + ], + 'createdAt' => '2024-03-28T02:18:50.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDIJob'], + ], + 'createdAt' => '2024-02-28T06:45:11.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'GetMetaTablePartition'], + ], + 'createdAt' => '2024-02-22T06:37:02.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateQualityEntity'], + ['description' => 'Request parameters changed', 'api' => 'DeleteQualityEntity'], + ['description' => 'Request parameters changed', 'api' => 'DeleteQualityRule'], + ['description' => 'Request parameters changed', 'api' => 'GetQualityEntity'], + ['description' => 'Request parameters changed', 'api' => 'GetQualityFollower'], + ['description' => 'Request parameters changed, Response parameters changed, Response parameters changed', 'api' => 'ListQualityResultsByEntity'], + ['description' => 'Request parameters changed', 'api' => 'ListQualityResultsByRule'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListQualityRules'], + ['description' => 'Request parameters changed', 'api' => 'UpdateQualityRule'], + ], + 'createdAt' => '2024-01-22T02:35:15.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'GetMetaTableFullInfo'], + ], + 'createdAt' => '2024-01-19T11:59:33.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed, Request parameters changed, Response parameters changed', 'api' => 'CreateDIJob'], + ['description' => 'Error codes changed, Response parameters changed', 'api' => 'GetDIJob'], + ['description' => 'Error codes changed, Request parameters changed, Response parameters changed', 'api' => 'UpdateDIJob'], + ], + 'createdAt' => '2024-01-18T10:25:38.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListEnabledExtensionsForProject'], + ], + 'createdAt' => '2023-12-11T11:39:38.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetInstanceStatusStatistic'], + ['description' => 'Request parameters changed', 'api' => 'ListInstances'], + ], + 'createdAt' => '2023-12-07T06:44:06.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateQualityFollower'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'UpdateQualityFollower'], + ], + 'createdAt' => '2023-11-15T12:30:04.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateQualityRule'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'UpdateQualityRule'], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Invalid.Tenant.ConnectionNotExists', - 'errorMessage' => 'The connection does not exist.', - ], - [ - 'errorCode' => 'Invalid.Tenant.ProjectNotExists', - 'errorMessage' => 'The project does not exist.', - ], - [ - 'errorCode' => 'Invalid.Tenant.UserNotInProject', - 'errorMessage' => 'The user is not in the project.', - ], - [ - 'errorCode' => 'Invalid.DataSource.DataSourceStatus', - 'errorMessage' => 'The specified dataSourceStatus %s is invalid.', - ], - ], - 403 => [ - [ - 'errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin', - 'errorMessage' => 'The user is not a project administrator or owner.', - ], - [ - 'errorCode' => 'Invalid.Tenant.UserNotInTenant', - 'errorMessage' => 'The user is not in tenant.', - ], - ], + 'createdAt' => '2023-11-15T11:45:29.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetDataSourceMeta'], ], - 'staticInfo' => [ - 'substitutions' => [ - 'dataworks-public::2020-05-18::UpdateDataSource', - ], + 'createdAt' => '2023-11-14T10:55:09.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'UpdateRemind'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": true,\\n \\"RequestId\\": \\"0bc14115159376359****\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"0bc14115159376359****\\n200\\ntrue\\ntrue","errorExample":""}]', - 'title' => 'UpdateConnection', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'createdAt' => '2023-10-20T02:29:41.000Z', + 'description' => '', ], - 'ListConnections' => [ - 'summary' => 'Queries a list of data sources.', - 'methods' => [ - 'get', + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateImportMigration'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2023-10-10T11:14:04.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'AbolishDataServiceApi'], + ['description' => 'Request parameters changed', 'api' => 'CreateDataServiceApi'], + ['description' => 'Request parameters changed', 'api' => 'CreateDataServiceApiAuthority'], + ['description' => 'Request parameters changed', 'api' => 'CreateDataServiceGroup'], + ['description' => 'Request parameters changed', 'api' => 'DeleteDataServiceApi'], + ['description' => 'Request parameters changed', 'api' => 'DeleteDataServiceApiAuthority'], + ['description' => 'Request parameters changed', 'api' => 'GetDataServiceApi'], + ['description' => 'Request parameters changed', 'api' => 'GetDataServiceApplication'], + ['description' => 'Request parameters changed', 'api' => 'GetDataServiceFolder'], + ['description' => 'Request parameters changed', 'api' => 'GetDataServiceGroup'], + ], + 'createdAt' => '2023-10-10T02:05:19.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListDataServiceApiAuthorities'], + ['description' => 'Request parameters changed', 'api' => 'ListDataServiceApis'], + ['description' => 'Request parameters changed', 'api' => 'ListDataServiceApplications'], + ['description' => 'Request parameters changed', 'api' => 'ListDataServiceAuthorizedApis'], + ['description' => 'Request parameters changed', 'api' => 'ListDataServiceFolders'], + ['description' => 'Request parameters changed', 'api' => 'ListDataServiceGroups'], + ['description' => 'Request parameters changed', 'api' => 'ListDataServicePublishedApis'], + ['description' => 'Request parameters changed', 'api' => 'PublishDataServiceApi'], + ['description' => 'Request parameters changed', 'api' => 'SubmitDataServiceApi'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'UpdateDataServiceApi'], + ], + 'createdAt' => '2023-10-09T11:18:00.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDataServiceFolder'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2023-10-09T02:53:44.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDataServiceFolder'], ], - 'operationType' => 'read', - 'deprecated' => true, - 'systemTags' => [ - 'operationType' => 'get', + 'createdAt' => '2023-10-09T02:21:02.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetFolder'], ], - 'parameters' => [ - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the workspace to which the data source belongs. You can call the [ListProjects](~~178393~~) operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '76086', - ], - ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the data source that you want to query.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'abc', - ], - ], - [ - 'name' => 'ConnectionType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the data source. Valid values:'."\n" - ."\n" - .'* odps'."\n" - .'* mysql'."\n" - .'* rds'."\n" - .'* oss'."\n" - .'* sqlserver'."\n" - .'* polardb'."\n" - .'* oracle'."\n" - .'* mongodb'."\n" - .'* emr'."\n" - .'* postgresql'."\n" - .'* analyticdb_for_mysql'."\n" - .'* hybriddb_for_postgresql'."\n" - .'* holo'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rds', - ], - ], - [ - 'name' => 'SubType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The subtype of the data source. This parameter is used in scenarios where a type includes subtypes. The following type and subtypes are supported:'."\n" - ."\n" - .'* Type: `rds`'."\n" - .'* Subtypes: `mysql`, `sqlserver`, and `postgresql`'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mysql', - ], - ], - [ - 'name' => 'Status', - 'in' => 'query', - 'schema' => [ - 'description' => 'The status of the data source. Valid values:'."\n" - ."\n" - .'* ENABLED'."\n" - .'* DISABLED'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'EnvType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The environment in which the data source is used. Valid values: 0 and 1. The value 0 indicates the development environment. The value 1 indicates the production environment.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Pages start from page 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], + 'createdAt' => '2023-09-20T06:18:34.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetProject'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0bc14115159376359****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The query results for data sources that are returned on multiple pages.'."\n", - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'TotalCount' => [ - 'description' => 'The total number of data sources returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'Connections' => [ - 'description' => 'The data sources.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status of the data source. Valid values:'."\n" - ."\n" - .'* 1: The data source is normal.'."\n" - .'* 2: The data source is disabled.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ConnectionType' => [ - 'description' => 'The type of the data source. Valid values:'."\n" - ."\n" - .'* odps'."\n" - .'* mysql'."\n" - .'* rds'."\n" - .'* oss'."\n" - .'* sqlserver'."\n" - .'* polardb'."\n" - .'* oracle'."\n" - .'* mongodb'."\n" - .'* emr'."\n" - .'* postgresql'."\n" - .'* analyticdb_for_mysql'."\n" - .'* hybriddb_for_postgresql'."\n" - .'* holo'."\n", - 'type' => 'string', - 'example' => 'mysql', - ], - 'ProjectId' => [ - 'description' => 'The ID of the workspace with which the data source is associated.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '123', - ], - 'SubType' => [ - 'description' => 'The subtype of the data source. This parameter is used in scenarios where a type includes subtypes. The following type and subtypes are supported:'."\n" - ."\n" - .'* Type: `rds`'."\n" - .'* Subtypes: `mysql`, `sqlserver`, and `postgresql`.'."\n", - 'type' => 'string', - 'example' => 'mysql', - ], - 'GmtModified' => [ - 'description' => 'The time when the data source was last modified. Example: Mar 17, 2021 4:09:32 PM.'."\n", - 'type' => 'string', - 'example' => 'Mar 17, 2021 4:09:32 PM', - ], - 'EnvType' => [ - 'description' => 'The environment in which the data source is used. Valid values:'."\n" - ."\n" - .'* 0: development environment'."\n" - .'* 1: production environment'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ConnectStatus' => [ - 'description' => 'The status of the data source. Valid values:'."\n" - ."\n" - .'* 1: The data source is normal.'."\n" - .'* 2: The data source is disabled.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Sequence' => [ - 'description' => 'The field that is used to sort data sources. Data sources are sorted in descending order based on the value of this parameter.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '300', - ], - 'Description' => [ - 'description' => 'The description of the data source.'."\n", - 'type' => 'string', - 'example' => 'a connection', - ], - 'GmtCreate' => [ - 'description' => 'The time when the data source was created. Example: Mar 17, 2021 4:09:32 PM.'."\n", - 'type' => 'string', - 'example' => 'Mar 17, 2021 4:09:32 PM', - ], - 'DefaultEngine' => [ - 'description' => 'Indicates whether the compute engine that is associated with the data source is the default compute engine used by data sources of the same type.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'Shared' => [ - 'description' => 'Indicates whether the data source is a shared data source.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'Operator' => [ - 'description' => 'The ID of the Alibaba Cloud account that is used to last modify the data source.'."\n", - 'type' => 'string', - 'example' => '193543050****', - ], - 'Name' => [ - 'description' => 'The name of the data source.'."\n", - 'type' => 'string', - 'example' => 'abc', - ], - 'Content' => [ - 'description' => 'The details of the data source. Examples of details of some common data sources:'."\n" - ."\n" - .'* odps'."\n" - ."\n" - .''."\n" - ."\n" - .' {'."\n" - .' "accessId": "xssssss",'."\n" - .' "accessKey": "xsaxsaxsa",'."\n" - .' "authType": 2,'."\n" - .' "endpoint": "http://service.odps.aliyun.com/api",'."\n" - .' "project": "xsaxsax",'."\n" - .' "tag": "public"'."\n" - .' }'."\n" - ."\n" - .'* mysql'."\n" - ."\n" - .''."\n" - ."\n" - .' {'."\n" - .' "database": "xsaxsa",'."\n" - .' "instanceName": "rm-xsaxsa",'."\n" - .' "password": "xsaxsa",'."\n" - .' "rdsOwnerId": "xasxsa",'."\n" - .' "regionId": "cn-shanghai",'."\n" - .' "tag": "rds",'."\n" - .' "username": "xsaxsa"'."\n" - .' }'."\n" - ."\n" - .'* rds'."\n" - ."\n" - .''."\n" - ."\n" - .' {'."\n" - .' "configType": 1,'."\n" - .' "tag": "rds",'."\n" - .' "database": "xsaxsa",'."\n" - .' "username": "xsaxsa",'."\n" - .' "password": "xssaxsa$32050",'."\n" - .' "instanceName": "rm-xsaxs",'."\n" - .' "rdsOwnerId": "11111111"'."\n" - .' }'."\n" - ."\n" - .'* oss'."\n" - ."\n" - .''."\n" - ."\n" - .' {'."\n" - .' "accessId": "sssssxx",'."\n" - .' "accessKey": "xsaxaxsaxs",'."\n" - .' "bucket": "xsa-xs-xs",'."\n" - .' "endpoint": "http://oss-cn-shanghai.aliyuncs.com",'."\n" - .' "tag": "public"'."\n" - .' }'."\n" - ."\n" - .'* sqlserver'."\n" - ."\n" - .''."\n" - ."\n" - .' {'."\n" - .' "jdbcUrl": "jdbc:sqlserver://xsaxsa-xsaxsa.database.xxx.cn:123;DatabaseName=xsxs-xsxs",'."\n" - .' "password": "sdasda$fs",'."\n" - .' "tag": "public",'."\n" - .' "username": "sxaxacdacdd"'."\n" - .' }'."\n" - ."\n" - .'* polardb'."\n" - ."\n" - .''."\n" - ."\n" - .' {'."\n" - .' "clusterId": "pc-sdadsadsa",'."\n" - .' "database": "dsadsadsa",'."\n" - .' "ownerId": "121212122",'."\n" - .' "password": "sdasdafssa",'."\n" - .' "region": "cn-shanghai",'."\n" - .' "tag": "polardb",'."\n" - .' "username": "asdadsads"'."\n" - .' }'."\n" - ."\n" - .'* oracle'."\n" - ."\n" - .''."\n" - ."\n" - .' {'."\n" - .' "jdbcUrl": "jdbc:oracle:saaa:@xxxxx:1521:PROD",'."\n" - .' "password": "sxasaxsa",'."\n" - .' "tag": "public",'."\n" - .' "username": "sasfadfa"'."\n" - .' }'."\n" - ."\n" - .'* mongodb'."\n" - ."\n" - .''."\n" - ."\n" - .' {'."\n" - .' "address": "[\\"xsaxxsa.mongodb.rds.aliyuncs.com:3717\\"]",'."\n" - .' "database": "admin",'."\n" - .' "password": "sadsda@",'."\n" - .' "tag": "public",'."\n" - .' "username": "dsadsadas"'."\n" - .' }'."\n" - ."\n" - .'* emr'."\n" - ."\n" - .''."\n" - ."\n" - .' {'."\n" - .' "accessId": "xsaxsa",'."\n" - .' "emrClusterId": "C-dsads",'."\n" - .' "emrResourceQueueName": "default",'."\n" - .' "emrEndpoint": "emr.aliyuncs.com",'."\n" - .' "accessKey": "dsadsad",'."\n" - .' "emrUserId": "224833315798889783",'."\n" - .' "name": "sasdsadsa",'."\n" - .' "emrAccessMode": "simple",'."\n" - .' "region": "cn-shanghai",'."\n" - .' "authType": "2",'."\n" - .' "emrProjectId": "FP-sdadsad"'."\n" - .' }'."\n" - ."\n" - .'* postgresql'."\n" - ."\n" - .''."\n" - ."\n" - .' {'."\n" - .' "jdbcUrl": "jdbc:postgresql://xxxx:1921/ssss",'."\n" - .' "password": "sdadsads",'."\n" - .' "tag": "public",'."\n" - .' "username": "sdsasda"'."\n" - .' }'."\n" - ."\n" - .'* analyticdb_for_mysql'."\n" - ."\n" - .''."\n" - ."\n" - .' {'."\n" - .' "instanceId": "am-sadsada",'."\n" - .' "database": "xsxsx",'."\n" - .' "username": "xsxsa",'."\n" - .' "password": "asdadsa",'."\n" - .' "connectionString": "am-xssxsxs.ads.aliyuncs.com:3306"'."\n" - .' }'."\n" - ."\n" - .'* hybriddb_for_postgresql'."\n" - ."\n" - .''."\n" - ."\n" - .' {'."\n" - .' "connectionString": "gp-xsaxsaxa-master.gpdbmaster.rds.aliyuncs.com",'."\n" - .' "database": "xsaxsaxas",'."\n" - .' "password": "xsaxsaxsa@11",'."\n" - .' "instanceId": "gp-xsaxsaxsa",'."\n" - .' "port": "541132",'."\n" - .' "ownerId": "xsaxsaxsas",'."\n" - .' "username": "sadsad"'."\n" - .' }'."\n" - ."\n" - .'* holo'."\n" - ."\n" - .''."\n" - ."\n" - .' {'."\n" - .' "accessId": "xsaxsaxs",'."\n" - .' "accessKey": "xsaxsaxsa",'."\n" - .' "database": "xsaxsaxsa",'."\n" - .' "instanceId": "xsaxa",'."\n" - .' "tag": "aliyun"'."\n" - .' }'."\n" - ."\n" - .'* kafka'."\n" - ."\n" - .''."\n" - ."\n" - .' {'."\n" - .' "instanceId": "xsax-cn-xsaxsa",'."\n" - .' "regionId": "cn-shanghai",'."\n" - .' "tag": "aliyun",'."\n" - .' "ownerId": "1212121212112"'."\n" - .' }'."\n", - 'type' => 'string', - 'example' => '{\\"database\\":\\"xxx\\",\\"instanceName\\":\\"xxx\\",\\"password\\":\\"xxx\\",\\"rdsOwnerId\\":\\"xxx\\",\\"tag\\":\\"rds\\",\\"username\\":\\"xxx\\"}', - ], - 'Id' => [ - 'description' => 'The data source ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'BindingCalcEngineId' => [ - 'description' => 'The ID of the compute engine with which the data source is associated.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '123', - ], - 'TenantId' => [ - 'description' => 'The tenant ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234567', - ], - ], - ], - ], - ], - ], - ], - 'description' => '', - ], - ], + 'createdAt' => '2023-09-19T03:32:17.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetFile'], + ], + 'createdAt' => '2023-09-12T02:06:11.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DeleteQualityFollower'], + ['description' => 'Response parameters changed', 'api' => 'DeleteQualityRule'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetQualityRule'], + ], + 'createdAt' => '2023-08-29T02:36:48.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'AddMetaCollectionEntity'], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Invalid.Tenant.ConnectionNotExists', - 'errorMessage' => 'The connection does not exist.', - ], - [ - 'errorCode' => 'Invalid.Tenant.ProjectNotExists', - 'errorMessage' => 'The project does not exist.', - ], - [ - 'errorCode' => 'Invalid.Tenant.UserNotInProject', - 'errorMessage' => 'The user is not in the project.', - ], - ], - 403 => [ - [ - 'errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin', - 'errorMessage' => 'The user is not a project administrator or owner.', - ], - [ - 'errorCode' => 'Invalid.Tenant.UserNotInTenant', - 'errorMessage' => 'The user is not in tenant.', - ], - ], + 'createdAt' => '2023-08-09T06:48:11.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateResourceFile'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0bc14115159376359****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 3,\\n \\"Connections\\": [\\n {\\n \\"Status\\": 1,\\n \\"ConnectionType\\": \\"mysql\\",\\n \\"ProjectId\\": 123,\\n \\"SubType\\": \\"mysql\\",\\n \\"GmtModified\\": \\"Mar 17, 2021 4:09:32 PM\\",\\n \\"EnvType\\": 1,\\n \\"ConnectStatus\\": 1,\\n \\"Sequence\\": 300,\\n \\"Description\\": \\"a connection\\",\\n \\"GmtCreate\\": \\"Mar 17, 2021 4:09:32 PM\\",\\n \\"DefaultEngine\\": false,\\n \\"Shared\\": false,\\n \\"Operator\\": \\"193543050****\\",\\n \\"Name\\": \\"abc\\",\\n \\"Content\\": \\"{\\\\\\\\\\\\\\"database\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"instanceName\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"password\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"rdsOwnerId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"tag\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"rds\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"username\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"xxx\\\\\\\\\\\\\\"}\\",\\n \\"Id\\": 1,\\n \\"BindingCalcEngineId\\": 123,\\n \\"TenantId\\": 1234567\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"0bc14115159****\\n200\\n\\n \\n 193543050****\\n 1\\n 1\\n a connection\\n mysql\\n 123\\n mysql\\n Oct 10, 2019 3:42:53 PM\\n 123\\n 300\\n false\\n 1\\n false\\n abc\\n Oct 10, 2019 3:42:53 PM\\n 1234567\\n {\\\\\\"database\\\\\\":\\\\\\"xxx\\\\\\",\\\\\\"instanceName\\\\\\":\\\\\\"xxx\\\\\\",\\\\\\"password\\\\\\":\\\\\\"xxx\\\\\\",\\\\\\"rdsOwnerId\\\\\\":\\\\\\"xxx\\\\\\",\\\\\\"tag\\\\\\":\\\\\\"rds\\\\\\",\\\\\\"username\\\\\\":\\\\\\"xxx\\\\\\"}\\n 1\\n \\n 3\\n 20\\n 1\\n\\ntrue","errorExample":""}]', - 'title' => 'ListConnections', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'createdAt' => '2023-07-25T01:05:42.000Z', + 'description' => '', ], - 'GetProjectDetail' => [ - 'summary' => 'Queries the information about a DataWorks workspace.', - 'methods' => [ - 'post', + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateFile'], + ['description' => 'Request parameters changed', 'api' => 'CreateUdfFile'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListFiles'], + ['description' => 'Request parameters changed', 'api' => 'UpdateFile'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2023-07-14T05:40:04.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetQualityFollower'], + ['description' => 'Response parameters changed', 'api' => 'ListQualityRules'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2023-07-11T11:41:48.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetQualityEntity'], ], - 'operationType' => 'read', - 'deprecated' => true, - 'systemTags' => [ - 'operationType' => 'get', + 'createdAt' => '2023-07-11T08:02:07.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreatePermissionApplyOrder'], ], - 'parameters' => [ - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '27', - ], - ], + 'createdAt' => '2023-06-28T02:01:42.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetNode'], + ['description' => 'Response parameters changed', 'api' => 'ListDataSources'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0bc1411515937635973****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The information about the workspace.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status of the workspace.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ResidentArea' => [ - 'description' => 'The type of the workspace. Valid values: private and swap.'."\n", - 'type' => 'string', - 'example' => 'private', - ], - 'ProjectId' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '27', - ], - 'ProjectIdentifier' => [ - 'description' => 'The unique identifier of the workspace.'."\n", - 'type' => 'string', - 'example' => 'abc', - ], - 'ProjectName' => [ - 'description' => 'The display name of the workspace.'."\n", - 'type' => 'string', - 'example' => 'abc', - ], - 'IsAllowDownload' => [ - 'description' => 'Indicates whether the download operation is allowed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ProjectMode' => [ - 'description' => 'The mode of the workspace. The value 2 indicates that the workspace is in basic mode. The value 3 indicates that the workspace is in standard mode.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ProjectDescription' => [ - 'description' => 'The description of the workspace.'."\n", - 'type' => 'string', - 'example' => 'abc', - ], - 'GmtModified' => [ - 'description' => 'The time when the workspace was last modified.'."\n", - 'type' => 'string', - 'example' => 'Dec 3, 2019 9:12:20 PM', - ], - 'ProjectOwnerBaseId' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the workspace owner.'."\n", - 'type' => 'string', - 'example' => '18229311****', - ], - 'DevelopmentType' => [ - 'description' => 'The development type of the workspace. The value is fixed to 4.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'DefaultDiResourceGroupIdentifier' => [ - 'description' => 'The identifier of the shared resource group for Data Integration on which nodes are run.'."\n", - 'type' => 'string', - 'example' => 'group_280749521****', - ], - 'GmtCreate' => [ - 'description' => 'The time when the workspace was created.'."\n", - 'type' => 'string', - 'example' => 'Oct 10, 2019 3:42:53 PM', - ], - 'SchedulerMaxRetryTimes' => [ - 'description' => 'The default maximum number of automatic reruns that are allowed after an error occurs.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'ProtectedMode' => [ - 'description' => 'Indicates whether the workspace protection feature is enabled.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TenantId' => [ - 'description' => 'The tenant ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '280749521950784', - ], - 'SchedulerRetryInterval' => [ - 'description' => 'The interval between automatic reruns after an error occurs.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '120000', - ], - 'EnvTypes' => [ - 'description' => 'The environments of workspaces in different modes. Workspaces in basic mode provide only the production environment. Workspaces in standard mode provide both the development environment and the production environment.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The environment of the workspace in a different mode. Workspaces in basic mode provide only the production environment. Workspaces in standard mode provide both the development environment and the production environment.'."\n", - 'type' => 'string', - 'example' => '["PROD"]', - ], - ], - 'ResourceManagerResourceGroupId' => [ - 'description' => 'The resource group ID.'."\n", - 'type' => 'string', - 'example' => 'rg-acfmzbn7pti3zfa', - ], - 'Tags' => [ - 'description' => 'The tag information.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'Env', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => 'Test', - ], - ], - ], - ], - 'DisableDevelopment' => [ - 'description' => 'Indicates whether the Develop role is disabled. Valid values:'."\n" - ."\n" - .'* **false** (default)'."\n" - .'* **true**'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'UseProxyOdpsAccount' => [ - 'description' => 'Indicates whether a proxy account is used to access the MaxCompute compute engine.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'TablePrivacyMode' => [ - 'description' => 'Indicates whether the MaxCompute tables in the workspace are visible to the users within a tenant. Valid values:'."\n" - ."\n" - .'* 0: The MaxCompute tables in the workspace are not visible to the users within a tenant.'."\n" - .'* 1: The MaxCompute tables in the workspace are visible to the users within a tenant.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'IsDefault' => [ - 'description' => 'Indicates whether the workspace is a default workspace. Valid values:'."\n" - ."\n" - .'* 1: The workspace is a default workspace.'."\n" - .'* 0: The workspace is not a default workspace.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - ], - ], - ], - 'description' => '', - ], - ], + 'createdAt' => '2023-06-25T08:47:13.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'GetMetaDBInfo'], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'Invalid.Tenant.ConnectionNotExists', - 'errorMessage' => 'The connection does not exist.', - ], - [ - 'errorCode' => 'Invalid.Tenant.ProjectNotExists', - 'errorMessage' => 'The project does not exist.', - ], - [ - 'errorCode' => 'Invalid.Tenant.UserNotInProject', - 'errorMessage' => 'The user is not in the project.', - ], - ], - 403 => [ - [ - 'errorCode' => 'Invalid.Tenant.UserIsNotProjectOwnerOrAdmin', - 'errorMessage' => 'The user is not a project administrator or owner.', - ], - [ - 'errorCode' => 'Invalid.Tenant.UserNotInTenant', - 'errorMessage' => 'The user is not in tenant.', - ], - ], + 'createdAt' => '2023-05-12T08:28:59.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateFile'], + ['description' => 'Request parameters changed', 'api' => 'UpdateFile'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0bc1411515937635973****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Status\\": 0,\\n \\"ResidentArea\\": \\"private\\",\\n \\"ProjectId\\": 27,\\n \\"ProjectIdentifier\\": \\"abc\\",\\n \\"ProjectName\\": \\"abc\\",\\n \\"IsAllowDownload\\": 1,\\n \\"ProjectMode\\": 1,\\n \\"ProjectDescription\\": \\"abc\\",\\n \\"GmtModified\\": \\"Dec 3, 2019 9:12:20 PM\\",\\n \\"ProjectOwnerBaseId\\": \\"18229311****\\",\\n \\"DevelopmentType\\": 4,\\n \\"DefaultDiResourceGroupIdentifier\\": \\"group_280749521****\\",\\n \\"GmtCreate\\": \\"Oct 10, 2019 3:42:53 PM\\",\\n \\"SchedulerMaxRetryTimes\\": 3,\\n \\"ProtectedMode\\": 1,\\n \\"TenantId\\": 280749521950784,\\n \\"SchedulerRetryInterval\\": 120000,\\n \\"EnvTypes\\": [\\n \\"[\\\\\\"PROD\\\\\\"]\\"\\n ],\\n \\"ResourceManagerResourceGroupId\\": \\"rg-acfmzbn7pti3zfa\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"Env\\",\\n \\"Value\\": \\"Test\\"\\n }\\n ],\\n \\"DisableDevelopment\\": true,\\n \\"UseProxyOdpsAccount\\": true,\\n \\"TablePrivacyMode\\": 1,\\n \\"IsDefault\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n \\n false\\n group_280749521****\\n 28\\n 64\\n 4\\n false\\n PROD\\n Oct 10, 2019 3:42:53 PM\\n Dec 3, 2019 9:12:20 PM\\n 1\\n 0\\n 30\\n 64\\n 27\\n abc\\n 2\\n abc\\n 18229311****\\n 1\\n private\\n 3\\n 120000\\n 0\\n 0\\n 280749521950784\\n false\\n\\n200\\n0bc1ec9b15973****\\ntrue","errorExample":""}]', - 'title' => 'GetProjectDetail', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'createdAt' => '2023-04-25T06:32:34.000Z', + 'description' => '', ], - 'ListNodeIO' => [ - 'methods' => [ - 'post', + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'RunManualDagNodes'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2023-04-12T03:29:30.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateDataServiceApi'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2023-03-31T09:26:39.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed, Request parameters changed', 'api' => 'MountDirectory'], + ['description' => 'Request parameters changed', 'api' => 'UmountDirectory'], ], - 'operationType' => 'read', - 'deprecated' => true, - 'systemTags' => [ - 'operationType' => 'get', + 'createdAt' => '2023-03-24T08:25:56.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateDataServiceApi'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'UpdateDataServiceApi'], ], - 'parameters' => [ - [ - 'name' => 'NodeId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The node ID. You can call the [ListNodes](~~173979~~) operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'minimum' => '2', - 'example' => '1234', - 'isFileTransferUrl' => false, - ], - ], - [ - 'name' => 'ProjectEnv', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The runtime environment. Valid values: DEV and PROD.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'PROD', - 'isFileTransferUrl' => false, - 'enum' => [ - 'PROD', - 'DEV', - ], - ], - ], - [ - 'name' => 'IoType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether to query the information about ancestor or descendant nodes of the current node. Valid values: input and output.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'output', - ], - ], + 'createdAt' => '2023-03-24T08:25:32.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed, Response parameters changed', 'api' => 'GetMetaTableLineage'], + ], + 'createdAt' => '2023-03-24T08:25:31.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateQualityEntity'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateQualityFollower'], + ['description' => 'Response parameters changed', 'api' => 'CreateQualityRelativeNode'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateQualityRule'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DeleteQualityEntity'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DeleteQualityFollower'], + ['description' => 'Response parameters changed', 'api' => 'DeleteQualityRelativeNode'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DeleteQualityRule'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetQualityEntity'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetQualityFollower'], + ], + 'createdAt' => '2023-03-24T08:24:09.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed, Response parameters changed', 'api' => 'GetBaselineKeyPath'], + ], + 'createdAt' => '2023-03-24T08:22:08.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed, Response parameters changed', 'api' => 'GetBaselineConfig'], + ['description' => 'Error codes changed, Response parameters changed', 'api' => 'GetBaselineKeyPath'], + ['description' => 'Error codes changed, Response parameters changed', 'api' => 'GetBaselineStatus'], + ['description' => 'Error codes changed, Response parameters changed', 'api' => 'GetTopic'], + ['description' => 'Error codes changed, Response parameters changed', 'api' => 'GetTopicInfluence'], + ['description' => 'Error codes changed, Response parameters changed', 'api' => 'ListBaselineConfigs'], + ['description' => 'Error codes changed, Response parameters changed', 'api' => 'ListReminds'], + ['description' => 'Error codes changed, Response parameters changed', 'api' => 'ListTopics'], + ], + 'createdAt' => '2023-01-10T12:27:38.000Z', + 'description' => '删除无用错误码', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed, Response parameters changed', 'api' => 'RunTriggerNode'], + ], + 'createdAt' => '2023-01-05T03:54:39.000Z', + 'description' => '抹零战役', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateBaseline'], + ['description' => 'Request parameters changed', 'api' => 'UpdateBaseline'], + ], + 'createdAt' => '2023-01-05T02:14:28.000Z', + 'description' => '参数变更', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListManualDagInstances'], + ['description' => 'Response parameters changed', 'api' => 'RunManualDagNodes'], + ], + 'createdAt' => '2023-01-05T02:11:59.000Z', + 'description' => 'ListManualDagInstances，GetManualDagInstances新增兼容STS入参', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'GetMetaTableProducingTasks'], + ], + 'createdAt' => '2022-12-22T01:51:16.000Z', + 'description' => 'Provide table producing tasks query API.', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetMetaTableOutput'], + ], + 'createdAt' => '2022-12-14T06:12:35.000Z', + 'description' => '1 添加查询表产出任务列表的OpenAPI；2 表产出信息查询OpenAPI增加taskId参数。', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListResourceGroups'], + ], + 'createdAt' => '2022-12-13T01:58:04.000Z', + 'description' => 'RMC', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListBaselines'], + ['description' => 'Request parameters changed', 'api' => 'UpdateBaseline'], + ], + 'createdAt' => '2022-12-02T06:26:10.000Z', + 'description' => '基线操作 openapi', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListResourceGroups'], + ], + 'createdAt' => '2022-11-23T03:19:46.000Z', + 'description' => 'Dataworks独享资源组增加企业治理关联CRUD API', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CreateBaseline'], + ['description' => 'Request parameters changed', 'api' => 'CreateRemind'], + ['description' => 'OpenAPI offline', 'api' => 'DeleteBaseline'], + ['description' => 'OpenAPI offline', 'api' => 'GetBaseline'], + ['description' => 'Response parameters changed', 'api' => 'GetRemind'], + ['description' => 'OpenAPI offline', 'api' => 'ListBaselines'], + ['description' => 'OpenAPI offline', 'api' => 'UpdateBaseline'], + ['description' => 'Request parameters changed', 'api' => 'UpdateRemind'], + ], + 'createdAt' => '2022-11-16T09:10:22.000Z', + 'description' => '新增运维中心基线操作类 OpenAPI', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'GetProject'], + ], + 'createdAt' => '2022-11-07T02:16:57.000Z', + 'description' => 'RMC', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetProject'], + ['description' => 'Response parameters changed', 'api' => 'GetProjectDetail'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListProjects'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListResourceGroups'], + ], + 'createdAt' => '2022-10-31T02:43:22.000Z', + 'description' => '发布', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetDeployment'], + ], + 'createdAt' => '2022-09-27T08:01:15.000Z', + 'description' => 'GetDeployment API响应中添加本次Deployment关联的文件版本列表', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListInstances'], + ], + 'createdAt' => '2022-08-31T10:20:59.000Z', + 'description' => 'ListInstances增加Status入参', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetExtension'], + ], + 'createdAt' => '2022-08-22T02:00:31.000Z', + 'description' => '设置GetExtension的关键字段为必填字段', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'AbolishDataServiceApi'], + ['description' => 'Error codes changed', 'api' => 'AbolishDataServiceApi'], + ['description' => 'Error codes changed', 'api' => 'AbolishDataServiceApi'], + ], + 'createdAt' => '2022-08-12T08:47:58.000Z', + 'description' => '企业治理，支持DataWorks OpenAPI deny', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetMetaDBInfo'], + ['description' => 'Request parameters changed', 'api' => 'GetMetaTablePartition'], + ], + 'createdAt' => '2022-08-11T08:52:31.000Z', + 'description' => 'GetMetaTablePartition接口支持排序', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'SubmitFile'], + ], + 'createdAt' => '2022-07-20T03:03:30.000Z', + 'description' => 'SubmitFile接口添加SkipAllDeployFileExtensions参数，支持提交成功后选择是否跳过发布前检查器。', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateTable'], + ['description' => 'Request parameters changed', 'api' => 'DeleteTable'], + ['description' => 'Response parameters changed', 'api' => 'GetMetaTableBasicInfo'], + ['description' => 'Response parameters changed', 'api' => 'GetMetaTableFullInfo'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'SearchMetaTables'], + ['description' => 'Request parameters changed', 'api' => 'UpdateMetaTable'], + ['description' => 'Request parameters changed', 'api' => 'UpdateTable'], + ], + 'createdAt' => '2022-07-19T06:46:59.000Z', + 'description' => '支持MaxCompute三层模型', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListDataSources'], + ], + 'createdAt' => '2022-07-12T07:43:05.000Z', + 'description' => 'ListDataSources接口 Name 改为非必填查询项', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListShiftPersonnels'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'E6F0DBDD-5AD****', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The project does not exist.', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ProjectNotExists', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The node information.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'TableName' => [ - 'description' => 'The name of the input or output table.'."\n", - 'type' => 'string', - 'example' => 'dataworks_a.datastudio_tenant_waitres_alarm', - ], - 'Data' => [ - 'description' => 'The name of the ancestor or descendant node.'."\n", - 'type' => 'string', - 'example' => 'dataworks_a.1234_out', - ], - 'NodeId' => [ - 'description' => 'The node ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123123', - ], - ], - ], - ], - ], - 'description' => '', - ], - ], + 'createdAt' => '2022-06-07T11:37:26.000Z', + 'description' => 'API字段类型定义错误，完成更改，api还没投入使用', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'ListShiftPersonnels'], + ['description' => 'OpenAPI offline', 'api' => 'ListShiftSchedules'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"ErrorMessage\\": \\"The project does not exist.\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ProjectNotExists\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"TableName\\": \\"dataworks_a.datastudio_tenant_waitres_alarm\\",\\n \\"Data\\": \\"dataworks_a.1234_out\\",\\n \\"NodeId\\": 123123\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"E6F0DBDD-5AD****\\n200\\n\\n 123123\\n dataworks_a.datastudio_tenant_waitres_alarm\\n dataworks_a.1234_out\\n\\nInvalid.Tenant.ProjectNotExists\\nThe project does not exist.\\ntrue","errorExample":""}]', - 'title' => 'ListNodeIO', - 'summary' => 'Queries the information about one level of ancestor or descendant nodes of a node.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'createdAt' => '2022-06-07T11:36:23.000Z', + 'description' => '新增运维运维中心值班表查询API', ], - 'GetInstanceStatusCount' => [ - 'methods' => [ - 'post', + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListShiftPersonnels'], + ['description' => 'Response parameters changed', 'api' => 'ListShiftSchedules'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2022-06-07T11:36:23.000Z', + 'description' => '变更API字段类型，API刚刚上线，还未投入使用', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'GetDataServiceApiTest'], + ['description' => 'OpenAPI offline', 'api' => 'ListDataServiceApiTest'], + ['description' => 'OpenAPI offline', 'api' => 'TestDataServiceApi'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2022-05-30T02:36:23.000Z', + 'description' => '增加数据服务测试API', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'GetDutyRoster'], + ['description' => 'OpenAPI offline', 'api' => 'ListDutyRosters'], ], - 'operationType' => 'read', - 'deprecated' => true, - 'systemTags' => [ - 'operationType' => 'get', + 'createdAt' => '2022-05-17T09:25:47.000Z', + 'description' => '新增运维中心值班表API ListDutyRosters 查询值班表列表GetDutyRoster 查询值班表值班人员列表', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateQualityFollower'], + ['description' => 'Request parameters changed', 'api' => 'UpdateQualityFollower'], ], - 'parameters' => [ - [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '1234', - 'isFileTransferUrl' => false, - ], - ], - [ - 'name' => 'ProjectEnv', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The runtime environment. Valid values: PROD and DEV.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'PROD', - 'isFileTransferUrl' => false, - 'enum' => [ - 'PROD', - 'DEV', - ], - ], - ], - [ - 'name' => 'BizDate', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The data timestamp of instances.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2020-01-01', - 'isFileTransferUrl' => false, - ], - ], + 'createdAt' => '2022-05-10T11:40:46.000Z', + 'description' => '新增订阅类型', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'ApprovePermissionApplyOrder'], + ['description' => 'Error codes changed', 'api' => 'CreatePermissionApplyOrder'], + ['description' => 'Error codes changed', 'api' => 'ListPermissionApplyOrders'], + ['description' => 'Error codes changed', 'api' => 'RevokeColumnPermission'], + ['description' => 'Error codes changed', 'api' => 'RevokeTablePermission'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'StatusCount' => [ - 'description' => 'The statistics of instances.'."\n", - 'type' => 'object', - 'properties' => [ - 'FailureCount' => [ - 'description' => 'The number of instances that failed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'WaitTimeCount' => [ - 'description' => 'The number of instances that are waiting for their scheduling time to arrive.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RunningCount' => [ - 'description' => 'The number of instances that are running.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'SuccessCount' => [ - 'description' => 'The number of instances that are successfully run.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'TotalCount' => [ - 'description' => 'The total number of instances returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'NotRunCount' => [ - 'description' => 'The number of instances that are not run.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'WaitResCount' => [ - 'description' => 'The number of instances that are waiting for resources.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - ], - ], - ], - 'description' => '', - ], - ], + 'createdAt' => '2022-04-28T08:55:34.000Z', + 'description' => '招联部署api', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'GetPermissionApplyOrderDetail'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"StatusCount\\": {\\n \\"FailureCount\\": 1,\\n \\"WaitTimeCount\\": 1,\\n \\"RunningCount\\": 1,\\n \\"SuccessCount\\": 1,\\n \\"TotalCount\\": 1,\\n \\"NotRunCount\\": 1,\\n \\"WaitResCount\\": 1\\n }\\n}","errorExample":""},{"type":"xml","example":"\\n 1\\n 1\\n 1\\n 1\\n 1\\n 1\\n 1\\n\\n0000-ABCD-EFG****","errorExample":""}]', - 'title' => 'GetInstanceStatusCount', - 'summary' => 'Queries the statistics of instances in different states.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'createdAt' => '2022-04-28T07:47:12.000Z', + 'description' => '增加招联部署', ], - 'ListProgramTypeCount' => [ - 'methods' => [ - 'post', + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'GetExtension'], + ['description' => 'OpenAPI offline', 'api' => 'GetOptionValueForProject'], + ['description' => 'OpenAPI offline', 'api' => 'ListExtensions'], + ], + 'createdAt' => '2022-04-26T08:46:46.000Z', + 'description' => '新增开放平台相关API', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'UpdateWorkbenchEventResult'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2022-03-28T03:25:22.000Z', + 'description' => '新增扩展程序回调api，用于处理运维中心卡点事件的回调', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListCalcEngines'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2022-03-17T07:57:38.000Z', + 'description' => '变更API 字段文档说明', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'UpdateQualityRule'], ], - 'operationType' => 'read', - 'deprecated' => true, - 'systemTags' => [ - 'operationType' => 'get', + 'createdAt' => '2022-03-15T12:25:52.000Z', + 'description' => '增加openswitch', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'DeleteQualityFollower'], + ['description' => 'Error codes changed', 'api' => 'DeleteQualityRule'], + ['description' => 'Error codes changed', 'api' => 'GetQualityFollower'], ], - 'parameters' => [ - [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '1', - 'example' => '1234', - 'isFileTransferUrl' => false, - ], - ], - [ - 'name' => 'ProjectEnv', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The environment of the workspace. Valid values: PROD and DEV.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'PROD', - 'isFileTransferUrl' => false, - 'enum' => [ - 'PROD', - 'DEV', - ], - ], - ], + 'createdAt' => '2022-03-15T06:08:59.000Z', + 'description' => '招联api支持', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'CheckMetaPartition'], + ['description' => 'Error codes changed', 'api' => 'CheckMetaTable'], + ['description' => 'Error codes changed', 'api' => 'GetMetaDBInfo'], + ['description' => 'Error codes changed', 'api' => 'GetMetaDBTableList'], + ['description' => 'Error codes changed', 'api' => 'GetMetaTableColumn'], + ['description' => 'Error codes changed', 'api' => 'GetMetaTableLineage'], + ['description' => 'Error codes changed', 'api' => 'SearchMetaTables'], + ], + 'createdAt' => '2022-03-10T06:25:23.000Z', + 'description' => '修改ErrorCode', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'QueryPublicModelEngine'], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'E6F0DBDD-5AD****', - ], - 'ProgramTypeAndCounts' => [ - 'description' => 'The list of node types and quantity.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Count' => [ - 'description' => 'The number of nodes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'ProgramType' => [ - 'description' => 'The node type.'."\n", - 'type' => 'string', - 'example' => 'ODPS_SQL', - ], - ], - ], - ], - ], - 'description' => '', - ], - ], + 'createdAt' => '2022-03-10T06:25:22.000Z', + 'description' => '去除无用的错误吗', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'StartTaskQuality'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"ProgramTypeAndCounts\\": [\\n {\\n \\"Count\\": 3,\\n \\"ProgramType\\": \\"ODPS_SQL\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"E6F0DBDD-5AD****\\n\\n ODPS_SQL\\n 3\\n","errorExample":""}]', - 'title' => 'ListProgramTypeCount', - 'summary' => 'Queries the distribution of different types of nodes.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'createdAt' => '2022-01-18T09:34:24.000Z', + 'description' => 'dqc参数变更', ], - 'GetManualDagInstances' => [ - 'methods' => [ - 'post', + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'StartTaskQuality'], ], - 'schemes' => [ - 'http', - 'https', + 'createdAt' => '2022-01-18T07:26:05.000Z', + 'description' => 'dqc插件启动task方法', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'StartQualityTask'], ], - 'security' => [ - [ - 'AK' => [], - ], + 'createdAt' => '2022-01-18T01:31:27.000Z', + 'description' => '新增启动task方法', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'ListNodeIO'], ], - 'operationType' => 'read', - 'deprecated' => true, - 'systemTags' => [ - 'operationType' => 'get', + 'createdAt' => '2022-01-13T07:51:56.000Z', + 'description' => '废弃部分API', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'CreateDagComplement'], + ['description' => 'Error codes changed', 'api' => 'CreateDagTest'], + ['description' => 'Error codes changed', 'api' => 'CreateManualDag'], + ['description' => 'Error codes changed', 'api' => 'GetInstanceStatusCount'], ], - 'parameters' => [ - [ - 'name' => 'ProjectEnv', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The environment of Operation Center. Valid values: PROD and DEV.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'RPOD', - 'enum' => [ - 'PROD', - 'DEV', - ], + 'createdAt' => '2022-01-13T07:26:42.000Z', + 'description' => '把部分废弃的API标记成废弃状态，提示用户不建议使用', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'GetMetaTableBasicInfo'], + ], + 'createdAt' => '2021-12-20T08:06:51.000Z', + 'description' => '更改错误码', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetMetaDBTableList'], + ], + 'createdAt' => '2021-12-14T09:28:00.000Z', + 'description' => '调整超时时间', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetMetaTableColumn'], + ['description' => 'Response parameters changed', 'api' => 'GetMetaTableLineage'], + ], + 'createdAt' => '2021-12-07T15:36:34.000Z', + 'description' => '- 增加字段热度- 增加血缘创建时间', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetQualityEntity'], + ['description' => 'Request parameters changed', 'api' => 'UpdateQualityRule'], + ], + 'createdAt' => '2021-11-25T04:05:59.000Z', + 'description' => '更新数据质量接口参数的边界值和文档说明', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CreateExportMigration'], + ['description' => 'OpenAPI offline', 'api' => 'GetMigrationSummary'], + ], + 'createdAt' => '2021-11-18T05:38:42.000Z', + 'description' => '- 新增创建导出任务接口：CreateExportMigration- 新增获取导入导出报告概要信息接口：GetMigrationSummary', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed, Error codes changed', 'api' => 'ListQualityRules'], + ], + 'createdAt' => '2021-10-26T01:40:45.000Z', + 'description' => '获取规则列表新增返回规则名称字段，方便开发者进行匹配。', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'ListQualityResultsByEntity'], + ['description' => 'Error codes changed', 'api' => 'ListQualityResultsByRule'], + ], + 'createdAt' => '2021-10-22T11:27:04.000Z', + 'description' => '修改接口超时时间', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateTable'], + ], + 'createdAt' => '2021-10-22T02:22:45.000Z', + 'description' => 'CreateTable支持的最大字段数量调整到1000', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ExportDISyncTasks'], + ['description' => 'Request parameters changed', 'api' => 'ImportDISyncTasks'], + ], + 'createdAt' => '2021-10-20T13:22:06.000Z', + 'description' => '升级ImportDISyncTasks/ExportDISyncTasks 接口 为数据类API', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDags'], + ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDIJob'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDIAlarmRule'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateMetaCollection'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEnabledExtensionsForProject'], + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDataServiceApi'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSensitiveData'], + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AbolishDataServiceApi'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMetaCollection'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDIJobs'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDIAlarmRule'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetNodeCode'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMetaCollections'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteMetaCollectionEntity'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDIAlarmRule'], + ['threshold' => '99', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListReminds'], + ['threshold' => '29', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateRemind'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDIAlarmRules'], + ['threshold' => '399', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetBaselineConfig'], + ['threshold' => '99', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstanceAmount'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartDIJob'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstances'], + ['threshold' => '499', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTopic'], + ['threshold' => '299', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetBaselineKeyPath'], + ['threshold' => '299', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetBaselineStatus'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetOptionValueForProject'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SubmitDataServiceApi'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DesensitizeData'], + ['threshold' => '39', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListNodesByBaseline'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateMetaCollection'], + ['threshold' => '199', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTopicInfluence'], + ['threshold' => '299', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateWorkbenchEventResult'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateIDEEventResult'], + ['threshold' => '99', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListBaselineConfigs'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDIJob'], + ['threshold' => '99', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSuccessInstanceAmount'], + ['threshold' => '99', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRemind'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListNodes'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetExtension'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopDIJob'], + ['threshold' => '99', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListBaselineStatuses'], + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteDataServiceApiAuthority'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetNodeParents'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetProject'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDeployments'], + ['threshold' => '5', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMetaTableChangeLog'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDIJob'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetIDEEventDetail'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDIAlarmRule'], + ['threshold' => '99', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteRemind'], + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDataServiceGroup'], + ['threshold' => '99', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListShiftPersonnels'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetOpSensitiveData'], + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProjectIds'], + ['threshold' => '299', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAlertMessages'], + ['threshold' => '99', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TopTenElapsedTimeInstance'], + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetProjectDetail'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SaveDataServiceApiTestResult'], + ['threshold' => '99', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTopics'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListProjects'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetOpRiskData'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListShiftSchedules'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListExtensions'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ScanSensitiveData'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetMetaCollectionDetail'], + ['threshold' => '99', 'countWindow' => 1, 'regionId' => '*', 'api' => 'OfflineNode'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetDIJob'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInnerNodes'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListInstanceHistory'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMigrations'], + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'PublishDataServiceApi'], + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateDataServiceApi'], + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDataServiceApiAuthority'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListResourceGroups'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateExportMigration'], + ['threshold' => '99', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TopTenErrorTimesInstance'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddMetaCollectionEntity'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListMetaCollectionEntities'], + ['threshold' => '1', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateDataServiceFolder'], + ], + ], + 'ram' => [ + 'productCode' => 'DataWorks', + 'productName' => 'DataWorks', + 'ramCodes' => ['dataworks'], + 'ramLevel' => 'OPERATION', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'DsgStopSensIdentify', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dataworks:DsgStopSensIdentify', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ProjectName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the workspace to which the manually triggered workflow belongs. You can log on to the DataWorks console and go to the Workspace Settings panel to query the name.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'test_workspace', + ], + [ + 'apiName' => 'GetDag', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'DagId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the directed acyclic graph (DAG) for the manually triggered workflow. You can call the [CreateManualDag](~~189728~~) operation to query the ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '7000001231241', + ], + [ + 'apiName' => 'CheckMetaTable', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF', - ], - 'Instances' => [ - 'description' => 'The instances in the manually triggered workflow.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status of the instance. Valid values:'."\n" - ."\n" - .'* NOT_RUN: The instance is not run.'."\n" - .'* WAIT_TIME: The instance is waiting for its scheduling time to arrive.'."\n" - .'* WAIT_RESOURCE: The instance is waiting for resources.'."\n" - .'* RUNNING: The instance is running.'."\n" - .'* CHECKING: Data quality is being checked for the instance.'."\n" - .'* CHECKING_CONDITION: Branch conditions are being checked for the instance.'."\n" - .'* FAILURE: The instance fails to be run.'."\n" - .'* SUCCESS: The instance is successfully run.'."\n", - 'type' => 'string', - 'example' => 'WAIT_TIME', - ], - 'BeginRunningTime' => [ - 'description' => 'The time when the instance started to run.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1605178414676', - ], - 'BizDate' => [ - 'description' => 'The data timestamp of the instance. In most cases, the value is one day before the time when the instance was run.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1605178414676', - ], - 'CycTime' => [ - 'description' => 'The time when the instance was scheduled to run.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1605178414676', - ], - 'FinishTime' => [ - 'description' => 'The time when the instance finished running.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1605178414676', - ], - 'CreateTime' => [ - 'description' => 'The time when the instance was generated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1605178414676', - ], - 'DagId' => [ - 'description' => 'The ID of the DAG for the manually triggered workflow.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '350850491', - ], - 'InstanceId' => [ - 'description' => 'The ID of the instance in the manually triggered workflow.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '11726873619', - ], - 'BeginWaitResTime' => [ - 'description' => 'The time when the instance started to wait for resources.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1605178414676', - ], - 'TaskType' => [ - 'description' => 'The scheduling type of the node that generates the instance. Valid values:'."\n" - ."\n" - .'* NORMAL(0): The node is an auto triggered node. The scheduling system regularly runs the node.'."\n" - .'* MANUAL(1): The node is a manually triggered node. The scheduling system does not regularly run the node.'."\n" - .'* PAUSE(2): The node is a paused node. The scheduling system regularly runs the node but sets the status of the node to failed when the scheduling system starts to run the node.'."\n" - .'* SKIP(3): The node is a dry-run node. The scheduling system regularly runs the node but sets the status of the node to successful when the scheduling system starts to run the node.'."\n" - .'* SKIP_UNCHOOSE(4): The node is an unselected node in a temporary workflow. This type of node exists only in temporary workflows. The scheduling system sets the status of the node to successful when the scheduling system starts to run the node.'."\n" - .'* SKIP_CYCLE(5): The node is a node that is scheduled by week or month and is waiting for the scheduling time to arrive. The scheduling system regularly runs the node but sets the status of the node to successful when the scheduling system starts to run the node.'."\n" - .'* CONDITION_UNCHOOSE(6): The node is not selected by its ancestor branch node and is run as a dry-run node.'."\n" - .'* REALTIME_DEPRECATED(7): The node has instances that are generated in real time but deprecated. The scheduling system sets the status of the node to successful.'."\n", - 'type' => 'string', - 'example' => 'NORMAL(0)', - ], - 'ParamValues' => [ - 'description' => 'The parameters related to the instance.'."\n", - 'type' => 'string', - 'example' => 'xxx', - ], - 'DagType' => [ - 'description' => 'The type of the manually triggered workflow.'."\n", - 'type' => 'string', - 'example' => '5', - ], - 'NodeName' => [ - 'description' => 'The name of the node.'."\n", - 'type' => 'string', - 'example' => 'test2', - ], - 'BeginWaitTimeTime' => [ - 'description' => 'The time when the instance started to wait to be scheduled.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1605178414676', - ], - 'NodeId' => [ - 'description' => 'The ID of the node in the manually triggered workflow.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '37851', - ], - 'ModifyTime' => [ - 'description' => 'The time when the instance was last modified.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1605178414676', - ], - 'CreateUser' => [ - 'description' => 'The user who performed the operation.'."\n", - 'type' => 'string', - 'example' => 'xxx', - ], - ], - ], - ], - ], + [ + 'apiName' => 'GetFile', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF\\",\\n \\"Instances\\": [\\n {\\n \\"Status\\": \\"WAIT_TIME\\",\\n \\"BeginRunningTime\\": 1605178414676,\\n \\"BizDate\\": 1605178414676,\\n \\"CycTime\\": 1605178414676,\\n \\"FinishTime\\": 1605178414676,\\n \\"CreateTime\\": 1605178414676,\\n \\"DagId\\": 350850491,\\n \\"InstanceId\\": 11726873619,\\n \\"BeginWaitResTime\\": 1605178414676,\\n \\"TaskType\\": \\"NORMAL(0)\\",\\n \\"ParamValues\\": \\"xxx\\",\\n \\"DagType\\": \\"5\\",\\n \\"NodeName\\": \\"test2\\",\\n \\"BeginWaitTimeTime\\": 1605178414676,\\n \\"NodeId\\": 37851,\\n \\"ModifyTime\\": 1605178414676,\\n \\"CreateUser\\": \\"xxx\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"\\n SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF\\n \\n WAIT_TIME\\n 1605178414676\\n 1605178414676\\n 1605178414676\\n 1605178414676\\n 1605178414676\\n 350850491\\n 11726873619\\n 1605178414676\\n NORMAL(0)\\n xxx\\n 5\\n test2\\n 1605178414676\\n 37851\\n 1605178414676\\n xxx\\n \\n","errorExample":""}]', - 'title' => 'GetManualDagInstances', - 'summary' => 'Queries the information about instances in a manually triggered workflow.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'SearchNodesByOutput' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DsgQueryDesensStatusList', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:DsgQueryDesensStatusList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ListMetaDB', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => true, - 'systemTags' => [ + [ + 'apiName' => 'GetInstanceLog', + 'description' => '', 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'ProjectEnv', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The environment of Operation Center. Valid values: PROD and DEV.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'PROD', - 'enum' => [ - 'PROD', - 'DEV', - ], + [ + 'apiName' => 'GetMetaTableChangeLog', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Outputs', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The output names of the node. If you specify multiple output names, separate them with commas (,).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'aaaaa.1231412_out,bbbb.12313123_out', + ], + [ + 'apiName' => 'ListFiles', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The map returned. The key in the map indicates an output name, and the value in the map indicates the information about the node that generates the output.'."\n", - 'type' => 'object', - 'example' => '{ "test_0709_1.630003558_out": { "nodeId": 21673, "nodeName": "hour_sql", "ownerId": 123123123124, "cronExpress": "00 00 00-23/2 * * ?", "repeatability": true, "programType": "ODPS_SQL", "projectId": 11111, "schedulerType": "NORMAL", "priority": 1, "baselineId": 20001721, "connection": "odps_first" }, "test_0709_1.630003556_out": { "nodeId": 21671, "nodeName": "start", "ownerId": 123141231231, "cronExpress": "00 */10 00-23 * * ?", "repeatability": true, "programType": "VIRTUAL", "projectId": 1111, "schedulerType": "NORMAL", "priority": 1, "baselineId": 20001721 } }', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'SDFSDFSDF-asdfDFSDF-SDFSDf-SDfSFD', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - ], - 'description' => '', + [ + 'apiName' => 'QuerySensClassification', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:QuerySensClassification', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"test_0709_1.630003558_out\\": {\\n \\"nodeId\\": 21673,\\n \\"nodeName\\": \\"hour_sql\\",\\n \\"ownerId\\": 123123123124,\\n \\"cronExpress\\": \\"00 00 00-23/2 * * ?\\",\\n \\"repeatability\\": true,\\n \\"programType\\": \\"ODPS_SQL\\",\\n \\"projectId\\": 11111,\\n \\"schedulerType\\": \\"NORMAL\\",\\n \\"priority\\": 1,\\n \\"baselineId\\": 20001721,\\n \\"connection\\": \\"odps_first\\"\\n },\\n \\"test_0709_1.630003556_out\\": {\\n \\"nodeId\\": 21671,\\n \\"nodeName\\": \\"start\\",\\n \\"ownerId\\": 123141231231,\\n \\"cronExpress\\": \\"00 */10 00-23 * * ?\\",\\n \\"repeatability\\": true,\\n \\"programType\\": \\"VIRTUAL\\",\\n \\"projectId\\": 1111,\\n \\"schedulerType\\": \\"NORMAL\\",\\n \\"priority\\": 1,\\n \\"baselineId\\": 20001721\\n }\\n },\\n \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"SDFSDFSDF-asdfDFSDF-SDFSDf-SDfSFD\\",\\n \\"Success\\": true,\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\"\\n}","errorExample":""},{"type":"xml","example":"true\\n200\\n\\n \\n 21673\\n hour_sql\\n 123123123124\\n 00 00 00-23/2 * * ?\\n true\\n ODPS_SQL\\n 11111\\n NORMAL\\n 1\\n 20001721\\n odps_first\\n \\n \\n 21671\\n start\\n 123141231231\\n 00 */10 00-23 * * ?\\n true\\n VIRTUAL\\n 1111\\n NORMAL\\n 1\\n 20001721\\n \\n","errorExample":""}]', - 'title' => 'SearchNodesByOutput', - 'summary' => 'Queries a node based on the output.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'GetNodeTypeListInfo' => [ - 'methods' => [ - 'post', + [ + 'apiName' => 'CreateDISyncTask', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DsgQueryDefaultTemplates', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:QueryDefaultTemplates', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ListMigrations', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => true, - 'systemTags' => [ + [ + 'apiName' => 'GetMetaTableThemeLevel', + 'description' => '', 'operationType' => 'get', - ], - 'parameters' => [ - [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The DataWorks workspace ID. You can click the Workspace Manage icon in the upper-right corner of the DataStudio page to go to the Workspace page and query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'example' => '10000', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ProjectIdentifier', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The unique identifier of the DataWorks workspace. You can view the identifier in the upper part of the DataStudio page. You can also select another identifier to switch to another workspace. You must configure either this parameter or the ProjectId parameter to determine the DataWorks workspace to which the operation is applied.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dw_project', + ], + [ + 'apiName' => 'CreateFolder', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '1', + ], + [ + 'apiName' => 'RunSmokeTest', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of entries per page. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '100', - 'minimum' => '0', - 'example' => '50', + ], + [ + 'apiName' => 'StartDISyncInstance', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Keyword', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the node type. You can log on to the DataWorks console, go to the DataStudio page, and then view the name of a specific node type on the left side of the page. You can view the English or Chinese name of a specific node type, but the language specified to present the name must be the same as the language specified by the Locale parameter. Fuzzy match is supported. If this parameter is not configured, the names of all node types are returned.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ODPS SQ', + ], + [ + 'apiName' => 'QueryRecognizeDataByRuleType', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:QueryRecognizeDataByRuleType', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Locale', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The language that you use for the query. Valid values: zh-CN and en-US.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh-CN', + ], + [ + 'apiName' => 'GetInstanceStatusStatistic', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'NodeTypeInfoList' => [ - 'description' => 'The list of node types.'."\n", - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '50', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '127', - ], - 'NodeTypeInfo' => [ - 'description' => 'The information about a node type.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'NodeTypeName' => [ - 'description' => 'The name of the node type.'."\n", - 'type' => 'string', - 'example' => 'ODPS SQL', - ], - 'NodeType' => [ - 'description' => 'The type of the node, which is specified by a number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - ], - ], - ], - ], - ], - ], - 'description' => '', + [ + 'apiName' => 'DsgSceneAddOrUpdateScene', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:DsgSceneAddOrUpdateScene', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', + [ + 'apiName' => 'DsgWhiteListAddOrUpdate', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:DsgWhiteListAddOrUpdate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', + ], + [ + 'apiName' => 'ListDIAlarmRules', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', + ], + ], + [ + 'apiName' => 'DsgSceneQuerySceneListByName', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:DsgSceneQuerySceneListByName', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', + ], + ], + [ + 'apiName' => 'GetInstance', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', + ], + [ + 'apiName' => 'ListFileVersions', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', + ], + ], + [ + 'apiName' => 'DsgUserGroupDelete', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:DsgUserGroupDelete', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"NodeTypeInfoList\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 50,\\n \\"TotalCount\\": 127,\\n \\"NodeTypeInfo\\": [\\n {\\n \\"NodeTypeName\\": \\"ODPS SQL\\",\\n \\"NodeType\\": 10\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"0000-ABCD-EFG****\\n\\n 127\\n 50\\n 1\\n \\n ODPS SQL\\n 10\\n \\n","errorExample":""}]', - 'title' => 'GetNodeTypeListInfo', - 'summary' => 'Queries the information about node types, including the code and name of a node type.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'GetNodeOnBaseline' => [ - 'methods' => [ - 'post', + [ + 'apiName' => 'DeployFile', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'ListProjectRoles', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:ListProjectRoles', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'TestNetworkConnection', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => true, - 'systemTags' => [ + [ + 'apiName' => 'StartDIJob', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListDIProjectConfig', + 'description' => '', 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'BaselineId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The baseline ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1234', + [ + 'apiName' => 'ListManualDagInstances', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-E****', - ], - 'ErrorMessage' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'The specified parameters are invalid.', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => '1031203110005', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The list of nodes.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Owner' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the node owner.'."\n", - 'type' => 'string', - 'example' => '9527952****', - ], - 'NodeName' => [ - 'description' => 'The name of the node.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'NodeId' => [ - 'description' => 'The node ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'ProjectId' => [ - 'description' => 'The ID of the workspace to which the node belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - ], - ], - ], - ], - 'description' => '', + [ + 'apiName' => 'GetDISyncInstanceInfo', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', + [ + 'apiName' => 'DsgWhiteListQueryList', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:DsgWhiteListQueryList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', + ], + [ + 'apiName' => 'GetDIJob', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', + ], + ], + [ + 'apiName' => 'GetDataSourceMeta', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'Throttling.Resource', - 'errorMessage' => 'You have reached the limit for the resource. Please contact us by submitting a ticket.', + ], + ], + [ + 'apiName' => 'DeleteFile', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', + ], + ], + [ + 'apiName' => 'DsgDesensPlanQueryList', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:DsgDesensPlanQueryList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', + ], + ], + [ + 'apiName' => 'ListMetaCollections', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 500 => [ - [ - 'errorCode' => 'Forbidden.Not.Server', - 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.', + ], + [ + 'apiName' => 'CreateResourceFile', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'Forbidden.Wkbench.BaselineNoPermission', - 'errorMessage' => 'You are not authorized to access the baseline.', + ], + ], + [ + 'apiName' => 'SearchMetaTables', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'Forbidden.Wkbench.ProjectNoPermission', - 'errorMessage' => 'You are not authorized to access the workspace.', + ], + ], + [ + 'apiName' => 'ListFolders', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', + ], + ], + [ + 'apiName' => 'AddRecognizeRule', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataworks:AddRecognizeRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', + ], + ], + [ + 'apiName' => 'DsgUserGroupAddOrUpdate', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:DsgUserGroupAddOrUpdate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'InternalError.Wkbench.ServiceError', - 'errorMessage' => 'An internal error occurred.', + ], + ], + [ + 'apiName' => 'ListProjects', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:ListProjects', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'Project', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:workspace/*'], ], - [ - 'errorCode' => 'Invalid.Wkbench.Parameter', - 'errorMessage' => 'The specified parameters are invalid.', + ], + ], + [ + 'apiName' => 'ListMetaCollectionEntities', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'Invalid.Wkbench.BaselineNotExist', - 'errorMessage' => 'The baseline does not exist.', + ], + ], + [ + 'apiName' => 'ListNodes', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"RequestId\\": \\"0000-ABCD-E****\\",\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\",\\n \\"ErrorCode\\": \\"1031203110005\\",\\n \\"Success\\": \\"true\\",\\n \\"Data\\": [\\n {\\n \\"Owner\\": \\"9527952****\\",\\n \\"NodeName\\": \\"节点名称\\",\\n \\"NodeId\\": 1234,\\n \\"ProjectId\\": 1234\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"0000-ABCD-E****\\n200\\n\\n 9527952****\\n 节点名称\\n 1234\\n 1234\\n\\n1031203110005\\nThe specified parameters are invalid.\\ntrue","errorExample":""}]', - 'title' => 'GetNodeOnBaseline', - 'summary' => 'Queries the nodes associated with a baseline.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'GetSuccessInstanceTrend' => [ - 'methods' => [ - 'post', + [ + 'apiName' => 'DsgDesensPlanDelete', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dataworks:DsgDesensPlanDelete', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'GetMetaTableListByCategory', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'QueryDefaultTemplate', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:QueryDefaultTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => true, - 'systemTags' => [ + [ + 'apiName' => 'ListBusiness', + 'description' => '', 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '99999999999', - 'minimum' => '2', - 'example' => '9527', + [ + 'apiName' => 'DsgUpdateDesensStatusList', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:DsgUpdateDesensStatusList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '952795279527ab****', - ], - 'InstanceStatusTrend' => [ - 'description' => 'The trend of statistics on the instance status in different time periods.'."\n", - 'type' => 'object', - 'properties' => [ - 'TodayTrend' => [ - 'description' => 'The trend on the current day.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'TimePoint' => [ - 'description' => 'The point in time. Valid values: 00:00 to 23:00.'."\n", - 'type' => 'string', - 'example' => '01:00', - ], - 'Count' => [ - 'description' => 'The number of instances.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - ], - ], - ], - 'YesterdayTrend' => [ - 'description' => 'The trend on the previous day.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'TimePoint' => [ - 'description' => 'The point in time. Valid values: 00:00 to 23:00.'."\n", - 'type' => 'string', - 'example' => '01:00', - ], - 'Count' => [ - 'description' => 'The number of instances.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - ], - ], - ], - 'AvgTrend' => [ - 'description' => 'The average trend.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'TimePoint' => [ - 'description' => 'The point in time. Valid values: 00:00 to 23:00.'."\n", - 'type' => 'string', - 'example' => '01:00', - ], - 'Count' => [ - 'description' => 'The number of instances.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - ], - ], - ], - ], - ], - ], - 'description' => '', + [ + 'apiName' => 'CallbackExtension', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'RemoveProjectMemberFromRole', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dataworks:RemoveProjectMemberFromRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'StartMigration', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetPermissionApplyOrderDetail', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateProjectMember', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataworks:CreateProjectMember', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'ResourceNotAuthorized.Api', - 'errorMessage' => 'You are not authorized to access the resources.', + [ + 'apiName' => 'QuerySensNodeInfo', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:QuerySensNodeInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', + ], + ], + [ + 'apiName' => 'GetMetaColumnLineage', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', + ], + [ + 'apiName' => 'GetMetaTableColumn', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', + ], + ], + [ + 'apiName' => 'GetMetaTableLineage', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'AddProjectMemberToRole', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataworks:AddProjectMemberToRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'Throttling.Resource', - 'errorMessage' => 'You have reached the limit for the resource. Please contact us by submitting a ticket.', + ], + ], + [ + 'apiName' => 'CreateImportMigration', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', + ], + ], + [ + 'apiName' => 'GetMigrationSummary', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', + ], + ], + [ + 'apiName' => 'ListNodeInputOrOutput', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 500 => [ - [ - 'errorCode' => 'Forbidden.Not.Server', - 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.', + ], + [ + 'apiName' => 'QuerySensLevel', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:QuerySensLevel', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', + ], + ], + [ + 'apiName' => 'UpdateDISyncTask', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', + ], + ], + [ + 'apiName' => 'ListInstances', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'Forbidden.Wkbench.ProjectNoPermission', - 'errorMessage' => 'You are not authorized to access the workspace.', + ], + ], + [ + 'apiName' => 'GetMetaTableIntroWiki', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"952795279527ab****\\",\\n \\"InstanceStatusTrend\\": {\\n \\"TodayTrend\\": [\\n {\\n \\"TimePoint\\": \\"01:00\\",\\n \\"Count\\": 10\\n }\\n ],\\n \\"YesterdayTrend\\": [\\n {\\n \\"TimePoint\\": \\"01:00\\",\\n \\"Count\\": 10\\n }\\n ],\\n \\"AvgTrend\\": [\\n {\\n \\"TimePoint\\": \\"01:00\\",\\n \\"Count\\": 10\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"952795279527ab****\\n\\n \\n 01:00\\n 10\\n \\n \\n 01:00\\n 10\\n \\n \\n 01:00\\n 10\\n \\n \\n 01:00\\n 10\\n \\n \\n 01:00\\n 10\\n \\n \\n 01:00\\n 10\\n \\n \\n 01:00\\n 10\\n \\n \\n 01:00\\n 10\\n \\n \\n 01:00\\n 10\\n \\n","errorExample":""}]', - 'title' => 'GetSuccessInstanceTrend', - 'summary' => 'Queries the statistics of instances in different periods of a day.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'GetInstanceCountTrend' => [ - 'methods' => [ - 'post', + [ + 'apiName' => 'CreateProject', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataworks:CreateProject', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'Project', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:workspace/*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'UpdateFile', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'CreateExportMigration', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => true, - 'systemTags' => [ + [ + 'apiName' => 'GetFileTypeStatistic', + 'description' => '', 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '99999999999', - 'minimum' => '2', - 'example' => '10000', + [ + 'apiName' => 'ApprovePermissionApplyOrder', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'BeginDate', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The beginning of the time range to query, accurate to the day. Specify the time in the ISO 8601 standard in the yyyy-MM-dd\'T\'HH:mm:ssZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2020-04-02T00:00:00+0800', + ], + [ + 'apiName' => 'ListTableTheme', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'EndDate', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The end of the time range to query, accurate to the day. Specify the time in the ISO 8601 standard in the yyyy-MM-dd\'T\'HH:mm:ssZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2020-09-10T00:00:00+0800', + ], + [ + 'apiName' => 'CreateBusiness', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '95279527adhfj****', - ], - 'InstanceCounts' => [ - 'description' => 'The quantity trend of instances.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Date' => [ - 'description' => 'The data timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1600963200000', - ], - 'Count' => [ - 'description' => 'The number of instances.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '9527', - ], - ], - ], - ], - ], - 'description' => '', + [ + 'apiName' => 'CreateFile', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'ResourceNotAuthorized.Api', - 'errorMessage' => 'You are not authorized to access the resources.', + [ + 'apiName' => 'UpdateMetaTable', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', + ], + ], + [ + 'apiName' => 'EditRecognizeRule', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:EditRecognizeRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', + ], + [ + 'apiName' => 'SubmitFile', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', + ], + ], + [ + 'apiName' => 'DsgWhiteListDeleteList', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:DsgWhiteListDeleteList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'Throttling.Resource', - 'errorMessage' => 'You have reached the limit for the resource. Please contact us by submitting a ticket.', + ], + ], + [ + 'apiName' => 'DsgUserGroupQueryUserList', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:DsgUserGroupQueryUserList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', + ], + ], + [ + 'apiName' => 'DsgDesensPlanUpdateStatus', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:DsgDesensPlanUpdateStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', + ], + ], + [ + 'apiName' => 'GetMetaDBInfo', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 500 => [ - [ - 'errorCode' => 'Forbidden.Not.Server', - 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.', + ], + [ + 'apiName' => 'GetDeployment', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DsgUserGroupQueryList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:DsgUserGroupQueryList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', + ], + ], + [ + 'apiName' => 'ListNodesByOutput', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', + ], + ], + [ + 'apiName' => 'ListDIJobs', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'Forbidden.Wkbench.NoProject', - 'errorMessage' => 'You have not joined any project.', + ], + ], + [ + 'apiName' => 'QueryRecognizeRulesType', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:QueryRecognizeRulesType', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'Invalid.Wkbench.Parameter', - 'errorMessage' => 'The specified parameters are invalid.', + ], + ], + [ + 'apiName' => 'GetNodeParents', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"95279527adhfj****\\",\\n \\"InstanceCounts\\": [\\n {\\n \\"Date\\": 1600963200000,\\n \\"Count\\": 9527\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"95279527adhfj****\\n\\n 9527\\n 1600963200000\\n","errorExample":""}]', - 'title' => 'GetInstanceCountTrend', - 'summary' => 'Queries the quantity trend of auto triggered instances.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'GetInstanceConsumeTimeRank' => [ - 'methods' => [ - 'post', + [ + 'apiName' => 'DeleteRecognizeRule', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dataworks:DeleteRecognizeRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'GetQualityRule', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DsgQuerySensResult', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:DsgQuerySensResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => true, - 'systemTags' => [ + [ + 'apiName' => 'RestartInstance', + 'description' => '', 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '99999999999', - 'minimum' => '2', - 'example' => '100000', + [ + 'apiName' => 'GetNodeCode', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetDISyncTask', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'QueryRecognizeRuleDetail', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:QueryRecognizeRuleDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListQualityRules', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ChangeResourceManagerResourceGroup', + 'description' => '', + 'operationType' => '', + 'ramAction' => [ + 'action' => 'dataworks:ChangeResourceManagerResourceGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetMetaCategory', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DsgPlatformQueryProjectsAndSchemaFromMeta', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:DsgPlatformQueryProjectsAndSchemaFromMeta', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetNodeChildren', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Bizdate', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The data timestamp, accurate to the day. Specify the time in the ISO 8601 standard in the yyyy-MM-dd\'T\'HH:mm:ssZ format. The time must be in UTC.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2020-09-21T00:00:00+0800', + ], + [ + 'apiName' => 'UpdateNodeRunMode', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '6347364dadsfadf****', - ], - 'InstanceConsumeTimeRank' => [ - 'description' => 'The ranking record of the running durations of instances.'."\n", - 'type' => 'object', - 'properties' => [ - 'UpdateTime' => [ - 'description' => 'The timestamp when the ranking was updated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1600963200000', - ], - 'ConsumeTimeRank' => [ - 'description' => 'The ranking data of the running durations of instances.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Owner' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the node owner.'."\n", - 'type' => 'string', - 'example' => '952795279527', - ], - 'NodeName' => [ - 'description' => 'The name of the node.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Bizdate' => [ - 'description' => 'The data timestamp of the instance.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1600963200000', - ], - 'InstanceId' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '95279527', - ], - 'PrgType' => [ - 'description' => 'The type of the node.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'NodeId' => [ - 'description' => 'The node ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '9527', - ], - 'Consumed' => [ - 'description' => 'The running duration of the instance. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - ], - ], - ], - ], - ], - ], - ], - 'description' => '', + [ + 'apiName' => 'DsgScenedDeleteScene', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:DsgScenedDeleteScene', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'ResourceNotAuthorized.Api', - 'errorMessage' => 'You are not authorized to access the resources.', - ], - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', + [ + 'apiName' => 'DeleteProjectMember', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dataworks:DeleteProjectMember', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', + ], + [ + 'apiName' => 'ListResourceGroups', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:ListResourceGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'DataWorks', 'resourceType' => 'TenantResourceGroup', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:exclusive_resource_group/*'], ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', + ], + ], + [ + 'apiName' => 'GetFolder', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'Throttling.Resource', - 'errorMessage' => 'You have reached the limit for the resource. Please contact us by submitting a ticket.', + ], + ], + [ + 'apiName' => 'GetNode', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', + ], + ], + [ + 'apiName' => 'ListLineage', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', + ], + ], + [ + 'apiName' => 'DsgRunSensIdentify', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dataworks:RunIdentifyOpenapi', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 500 => [ - [ - 'errorCode' => 'Forbidden.Not.Server', - 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.', + ], + [ + 'apiName' => 'GetQualityEntity', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', + ], + ], + [ + 'apiName' => 'GetProject', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetProject', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'DataWorks', 'resourceType' => 'Project', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:workspace/{#ProjectIdentifier}'], ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', + ], + ], + [ + 'apiName' => 'GetMetaTableOutput', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'Forbidden.Wkbench.ProjectNoPermission', - 'errorMessage' => 'You are not authorized to access the workspace.', + ], + ], + [ + 'apiName' => 'ListProjectMembers', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:ListProjectMembers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'Invalid.Wkbench.Parameter', - 'errorMessage' => 'The specified parameters are invalid.', + ], + ], + [ + 'apiName' => 'GetIDEEventDetail', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6347364dadsfadf****\\",\\n \\"InstanceConsumeTimeRank\\": {\\n \\"UpdateTime\\": 1600963200000,\\n \\"ConsumeTimeRank\\": [\\n {\\n \\"Owner\\": \\"952795279527\\",\\n \\"NodeName\\": \\"节点名称\\",\\n \\"Bizdate\\": 1600963200000,\\n \\"InstanceId\\": 95279527,\\n \\"PrgType\\": 10,\\n \\"NodeId\\": 9527,\\n \\"Consumed\\": 1000\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"6347364dadsfadf****\\n\\n \\n 10\\n 952795279527\\n 节点名称\\n 95279527\\n 9527\\n 1000\\n 1600963200000\\n \\n 1600963200000\\n","errorExample":""}]', - 'title' => 'GetInstanceConsumeTimeRank', - 'summary' => 'Queries the ranking of the running durations of instances.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'GetInstanceErrorRank' => [ - 'methods' => [ - 'post', + [ + 'apiName' => 'ListMeasureData', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:ListMeasureData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'RunManualDagNodes', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'CreatePermissionApplyOrder', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => true, - 'systemTags' => [ + [ + 'apiName' => 'ListCalcEngines', + 'description' => '', 'operationType' => 'get', - ], - 'parameters' => [ - [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '99999999999', - 'minimum' => '2', - 'example' => '9527', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '952795279527****', - ], - 'InstanceErrorRank' => [ - 'description' => 'The ranking data of nodes on which errors occurred.'."\n", - 'type' => 'object', - 'properties' => [ - 'UpdateTime' => [ - 'description' => 'The timestamp at which the rankings were updated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1600963200000', - ], - 'ErrorRank' => [ - 'description' => 'The ranking data of nodes on which errors occurred within the last month.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Owner' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the node owner.'."\n", - 'type' => 'string', - 'example' => '952795279527', - ], - 'NodeName' => [ - 'description' => 'The name of the node.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'ProjectId' => [ - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '9527', - ], - 'NodeId' => [ - 'description' => 'The node ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '9527', - ], - 'Count' => [ - 'description' => 'The number of errors that occurred on the node.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'PrgType' => [ - 'description' => 'The type of the node.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - ], - ], - ], - ], - ], - ], - 'description' => '', + [ + 'apiName' => 'DsgUserGroupGetOdpsRoleGroups', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:DsgUserGroupGetOdpsRoleGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'ResourceNotAuthorized.Api', - 'errorMessage' => 'You are not authorized to access the resources.', + [ + 'apiName' => 'GetMetaDBTableList', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'Forbidden.Access', - 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', + ], + ], + [ + 'apiName' => 'UpdateIDEEventResult', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 429 => [ - [ - 'errorCode' => 'Throttling.Api', - 'errorMessage' => 'The request for this resource has exceeded your available limit.', + ], + [ + 'apiName' => 'RunCycleDagNodes', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'Throttling.Api.Risk', - 'errorMessage' => 'The request for this resource has exceeded your daily available limit.', + ], + ], + [ + 'apiName' => 'GetProjectDetail', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetProjectDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'conditional', 'product' => 'DataWorks', 'resourceType' => 'Project', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:workspace/{#ProjectIdentifier}'], ], - [ - 'errorCode' => 'Throttling.Resource', - 'errorMessage' => 'You have reached the limit for the resource. Please contact us by submitting a ticket.', + ], + ], + [ + 'apiName' => 'OfflineNode', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'Throttling.System', - 'errorMessage' => 'The DataWorks system is busy. Try again later.', + ], + ], + [ + 'apiName' => 'GetMetaCollectionDetail', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'Throttling.User', - 'errorMessage' => 'Your request is too frequent. Try again later.', + ], + ], + [ + 'apiName' => 'GetMetaTableBasicInfo', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - 500 => [ - [ - 'errorCode' => 'Forbidden.Not.Server', - 'errorMessage' => 'The dataworksAPI service is not available in this area. Please try it in another area.', + ], + [ + 'apiName' => 'ListDataSources', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', + ], + ], + [ + 'apiName' => 'GetMetaTablePartition', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'InternalError.UserId.Missing', - 'errorMessage' => 'An internal system error occurred. Try again later.', + ], + ], + [ + 'apiName' => 'ListProjectIds', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:ListProjectIds', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'Forbidden.Wkbench.ProjectNoPermission', - 'errorMessage' => 'You are not authorized to access the workspace.', + ], + ], + [ + 'apiName' => 'GetQualityFollower', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'Invalid.Wkbench.Parameter', - 'errorMessage' => 'The specified parameters are invalid.', + ], + ], + [ + 'apiName' => 'DsgDesensPlanAddOrUpdate', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:DsgDesensPlanAddOrUpdate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"952795279527****\\",\\n \\"InstanceErrorRank\\": {\\n \\"UpdateTime\\": 1600963200000,\\n \\"ErrorRank\\": [\\n {\\n \\"Owner\\": \\"952795279527\\",\\n \\"NodeName\\": \\"节点名称\\",\\n \\"ProjectId\\": 9527,\\n \\"NodeId\\": 9527,\\n \\"Count\\": 5,\\n \\"PrgType\\": 10\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"952795279527****\\n\\n \\n 10\\n 952795279527\\n 节点名称\\n 9527\\n 9527\\n 5\\n \\n 1600963200000\\n","errorExample":""}]', - 'title' => 'GetInstanceErrorRank', - 'summary' => 'Queries the ranking of nodes on which errors occur within the last month.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - ], - 'endpoints' => [ - [ - 'regionId' => 'cn-wulanchabu', - 'endpoint' => 'dataworks.cn-wulanchabu.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'dataworks.cn-beijing.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'dataworks.cn-shanghai.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hongkong', - 'endpoint' => 'dataworks.cn-hongkong.aliyuncs.com', - ], - [ - 'regionId' => 'cn-zhangjiakou', - 'endpoint' => 'dataworks.cn-zhangjiakou.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen', - 'endpoint' => 'dataworks.cn-shenzhen.aliyuncs.com', - ], - [ - 'regionId' => 'ap-northeast-1', - 'endpoint' => 'dataworks.ap-northeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'cn-chengdu', - 'endpoint' => 'dataworks.cn-chengdu.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'dataworks.ap-southeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-3', - 'endpoint' => 'dataworks.ap-southeast-3.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-5', - 'endpoint' => 'dataworks.ap-southeast-5.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'dataworks.cn-hangzhou.aliyuncs.com', - ], - [ - 'regionId' => 'us-east-1', - 'endpoint' => 'dataworks.us-east-1.aliyuncs.com', - ], - [ - 'regionId' => 'eu-west-1', - 'endpoint' => 'dataworks.eu-west-1.aliyuncs.com', - ], - [ - 'regionId' => 'us-west-1', - 'endpoint' => 'dataworks.us-west-1.aliyuncs.com', - ], - [ - 'regionId' => 'eu-central-1', - 'endpoint' => 'dataworks.eu-central-1.aliyuncs.com', - ], - [ - 'regionId' => 'me-east-1', - 'endpoint' => 'dataworks.me-east-1.aliyuncs.com', - ], - [ - 'regionId' => 'me-central-1', - 'endpoint' => 'dataworks.me-central-1.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen-finance-1', - 'endpoint' => 'dataworks.cn-shenzhen-finance-1.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai-finance-1', - 'endpoint' => 'dataworks.cn-shanghai-finance-1.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou-finance', - 'endpoint' => 'dataworks.aliyuncs.com', - ], - [ - 'regionId' => 'ap-northeast-2', - 'endpoint' => 'dataworks.ap-northeast-2.aliyuncs.com', + [ + 'apiName' => 'GetMigrationProcess', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'resourceTypes' => [ + ['validationType' => 'conditional', 'resourceType' => 'Connection', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:connection/*'], + ['validationType' => 'conditional', 'resourceType' => 'QualityFollower', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:qualityfollower/*'], + ['validationType' => 'conditional', 'resourceType' => 'DataServiceApiAuthority', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:dataserviceapiauthority/*'], + ['validationType' => 'conditional', 'resourceType' => 'QualityRelativeNode', 'arn' => 'acs:dataworks:*:*:*'], + ['validationType' => 'conditional', 'resourceType' => 'Instance', 'arn' => 'acs:dataworks:{#regionId}:*:*'], + ['validationType' => 'conditional', 'resourceType' => 'Table', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:table/*'], + ['validationType' => 'conditional', 'resourceType' => 'NodeOnBaseline', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:nodeonbaseline/*'], + ['validationType' => 'conditional', 'resourceType' => 'BaselineStatus', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:baselinestatus/*'], + ['validationType' => 'always', 'resourceType' => 'File', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:file/*'], + ['validationType' => 'conditional', 'resourceType' => 'Project', 'arn' => 'acs:dataworks:*:*:*'], + ['validationType' => 'conditional', 'resourceType' => 'Instance', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:instance/*'], + ['validationType' => 'conditional', 'resourceType' => 'TableTheme', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:tabletheme/*'], + ['validationType' => 'conditional', 'resourceType' => 'DataServiceFolder', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:dataservicefolder/*'], + ['validationType' => 'conditional', 'resourceType' => 'QualityRule', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:qualityrule/*'], + ['validationType' => 'conditional', 'resourceType' => 'Folder', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:folder/*'], + ['validationType' => 'conditional', 'resourceType' => 'Table', 'arn' => 'acs:dataworks:*:*:*'], + ['validationType' => 'always', 'resourceType' => 'Instance', 'arn' => 'acs:dataworks:*:*:*'], + ['validationType' => 'conditional', 'resourceType' => 'DataServiceAuthorizedApi', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:dataserviceauthorizedapi/*'], + ['validationType' => 'conditional', 'resourceType' => 'QualityEntity', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:qualityentity/*'], + ['validationType' => 'conditional', 'resourceType' => 'FileVersion', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:fileversion/*'], + ['validationType' => 'conditional', 'resourceType' => 'ProjectRole', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:workspace/*'], + ['validationType' => 'conditional', 'resourceType' => 'BaselineConfig', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:baselineconfig/*'], + ['validationType' => 'always', 'resourceType' => 'Connection', 'arn' => 'acs:dataworks:*:*:*'], + ['validationType' => 'always', 'resourceType' => 'Project', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:project/*'], + ['validationType' => 'conditional', 'resourceType' => 'DataServiceApi', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:dataserviceapi/*'], + ['validationType' => 'conditional', 'resourceType' => 'QualityRelativeNode', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:qualityrelativenode/*'], + ['validationType' => 'always', 'resourceType' => 'ResourceFile', 'arn' => ':dataworks:{#regionId}::resourcefile/*'], + ['validationType' => 'always', 'resourceType' => 'Project', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:workspace/*'], + ['validationType' => 'conditional', 'resourceType' => 'TableTheme', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:tabletheme/{#TableThemeId}'], + ['validationType' => 'conditional', 'resourceType' => 'Node', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:node/*'], + ['validationType' => 'conditional', 'resourceType' => 'ModelCategory', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:modelcategory/*'], + ['validationType' => 'conditional', 'resourceType' => 'TableLevel', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:tablelevel/*'], + ['validationType' => 'conditional', 'resourceType' => 'Remind', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:remind/*'], + ['validationType' => 'always', 'resourceType' => 'AlertMessage', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:*'], + ['validationType' => 'conditional', 'resourceType' => 'Business', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:business/*'], + ['validationType' => 'conditional', 'resourceType' => 'ProjectMember', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:workspace/*'], + ['validationType' => 'conditional', 'resourceType' => 'ColumnLineage', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:columnlineage/*'], + ['validationType' => 'conditional', 'resourceType' => 'DataServiceApplication', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:dataserviceapplication/*'], + ['validationType' => 'conditional', 'resourceType' => 'Column', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:column/*'], + ['validationType' => 'conditional', 'resourceType' => 'TableLineage', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:tablelineage/*'], + ['validationType' => 'always', 'resourceType' => 'ProjectMember', 'arn' => 'acs:dataworks:*:{#accountId}:projectmember/{#ProjectMemberId}'], + ['validationType' => 'conditional', 'resourceType' => 'DataServiceApi', 'arn' => 'acs:dataworks:*:*:*'], + ['validationType' => 'conditional', 'resourceType' => 'NodeIO', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:nodeio/*'], + ['validationType' => 'conditional', 'resourceType' => 'BaselineConfig', 'arn' => 'acs:dataworks:*:*:*'], + ['validationType' => 'conditional', 'resourceType' => 'Topic', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:topic/*'], + ['validationType' => 'conditional', 'resourceType' => 'MetaCategory', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:metacategory/*'], + ['validationType' => 'conditional', 'resourceType' => 'File', 'arn' => 'acs:dataworks:{#regionId}:*:*'], + ['validationType' => 'conditional', 'resourceType' => 'AlertMessage', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:alertmessage/*'], + ['validationType' => 'conditional', 'resourceType' => 'MetaCategory', 'arn' => 'acs:dataworks:*:*:*'], + ['validationType' => 'conditional', 'resourceType' => 'TableLevel', 'arn' => 'acs:dataworks:*:*:*'], + ['validationType' => 'conditional', 'resourceType' => 'Column', 'arn' => 'acs:dataworks:*:*:*'], + ['validationType' => 'conditional', 'resourceType' => 'Node', 'arn' => 'acs:dataworks:*:*:*'], + ['validationType' => 'conditional', 'resourceType' => 'DataServiceFolder', 'arn' => 'acs:dataworks:*:*:*'], + ['validationType' => 'conditional', 'resourceType' => 'DataServiceGroup', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:dataservicegroup/*'], + ['validationType' => 'conditional', 'resourceType' => 'Deployment', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:deployment/*'], + ['validationType' => 'conditional', 'resourceType' => 'Node', 'arn' => 'acs:dataworks:{#regionId}:*:*'], + ['validationType' => 'conditional', 'resourceType' => 'File', 'arn' => 'acs:dataworks:*:*:*'], + ['validationType' => 'conditional', 'resourceType' => 'DataServicePublishedApi', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:dataservicepublishedapi/*'], + ['validationType' => 'conditional', 'resourceType' => 'Project', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:workspace/{#ProjectIdentifier}'], + ['validationType' => 'conditional', 'resourceType' => 'TenantResourceGroup', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:exclusive_resource_group/{#Identifier}'], + ['validationType' => 'always', 'resourceType' => 'Remind', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:remind/{#RemindId}'], + ['validationType' => 'conditional', 'resourceType' => 'TenantResourceGroup', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:exclusive_resource_group/*'], + ['validationType' => 'conditional', 'resourceType' => 'UdfFile', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:udffile/*'], + ['validationType' => 'conditional', 'resourceType' => 'DataServiceFolder', 'arn' => 'acs:dataworks:{#regionId}:*:*'], + ['validationType' => 'conditional', 'resourceType' => 'CalcEngine', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:calcengine/*'], + ['validationType' => 'conditional', 'resourceType' => 'QualityCheckResult', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:qualitycheckresult/*'], + ['validationType' => 'conditional', 'resourceType' => 'DataServiceApi', 'arn' => 'acs:dataworks:{#regionId}:*:*'], + ['validationType' => 'conditional', 'resourceType' => 'DataServiceGroup', 'arn' => 'acs:dataworks:{#regionId}:*:*'], + ['validationType' => 'always', 'resourceType' => 'CheckerInstance', 'arn' => 'acs:dataworks:*:{#accountId}:checkerinstance/{#CheckerInstanceId}'], + ['validationType' => 'conditional', 'resourceType' => 'Topic', 'arn' => 'acs:dataworks:{#regionId}:*:*'], ], ], ]; -- cgit v1.2.3