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/2024-05-18/api-docs.php | 92925 +++++++++---------- 1 file changed, 44895 insertions(+), 48030 deletions(-) (limited to 'data/en_us/dataworks-public/2024-05-18') diff --git a/data/en_us/dataworks-public/2024-05-18/api-docs.php b/data/en_us/dataworks-public/2024-05-18/api-docs.php index 0feb02d..d620b9e 100644 --- a/data/en_us/dataworks-public/2024-05-18/api-docs.php +++ b/data/en_us/dataworks-public/2024-05-18/api-docs.php @@ -1,934 +1,514 @@ '1.0', - 'info' => [ - 'style' => 'RPC', - 'product' => 'dataworks-public', - 'version' => '2024-05-18', - ], + 'info' => ['style' => 'RPC', 'product' => 'dataworks-public', 'version' => '2024-05-18'], 'directories' => [ [ - 'id' => 203861, - 'title' => 'Authentication File Management', - 'type' => 'directory', 'children' => [ - 'ImportCertificate', - 'GetCertificate', - 'ListCertificates', - 'DeleteCertificate', + [ + 'children' => ['CreateMcpServer', 'DeleteMcpServer', 'UpdateMcpServer', 'GetMcpServer', 'ListMcpServers'], + 'type' => 'directory', + 'title' => 'MCP server management', + ], + [ + 'children' => ['DeleteSkill', 'GetSkill', 'ListSkills'], + 'type' => 'directory', + 'title' => 'Skill management', + ], + [ + 'children' => ['CreateAgent', 'ListCustomAgents', 'GetAgent', 'ListAgents'], + 'type' => 'directory', + 'title' => 'Agent management', + ], + [ + 'children' => ['PromptAgentSession', 'LoadAgentSession', 'ListAgentSessions', 'ListAgentSessionArtifacts', 'GetAgentSessionTokenUsage', 'GetAgentSessionArtifactMeta', 'CreateAgentSession', 'CancelAgentSession'], + 'type' => 'directory', + 'title' => 'Agent session management', + ], ], + 'type' => 'directory', + 'title' => 'Data Agent', ], [ - 'id' => 198217, - 'title' => 'Space Management', - 'type' => 'directory', 'children' => [ [ - 'id' => 198218, - 'title' => 'Workspace', + 'children' => ['CreateProject', 'DeleteProject', 'UpdateProject', 'ListProjects', 'GetProject'], 'type' => 'directory', - 'children' => [ - 'CreateProject', - 'UpdateProject', - 'DeleteProject', - 'GetProject', - 'ListProjects', - ], + 'title' => 'Workspace', ], [ - 'id' => 198566, - 'title' => 'Workspace Role', + 'children' => ['CreateProjectRole', 'DeleteProjectRole', 'UpdateProjectRole', 'GetProjectRole', 'ListProjectRoles'], 'type' => 'directory', - 'children' => [ - 'GetProjectRole', - 'ListProjectRoles', - ], + 'title' => 'Workspace role', ], [ - 'id' => 198571, - 'title' => 'Workspace Member', + 'children' => ['CreateProjectMember', 'DeleteProjectMember', 'GrantMemberProjectRoles', 'RevokeMemberProjectRoles', 'GetProjectMember', 'ListProjectMembers'], 'type' => 'directory', - 'children' => [ - 'CreateProjectMember', - 'DeleteProjectMember', - 'GrantMemberProjectRoles', - 'RevokeMemberProjectRoles', - 'GetProjectMember', - 'ListProjectMembers', - ], + 'title' => 'Workspace member', ], ], + 'type' => 'directory', + 'title' => 'Workspace management', ], [ - 'id' => 198149, - 'title' => 'Data Source', - 'type' => 'directory', 'children' => [ + 'UpdateDataSource', 'TestDataSourceConnectivity', 'CreateDataSource', 'DeleteDataSource', - 'UpdateDataSource', 'CloneDataSource', - 'GetDataSource', 'ListDataSources', [ - 'id' => 198204, - 'title' => 'Data Source Sharing Rules', + 'children' => ['CreateDataSourceSharedRule', 'DeleteDataSourceSharedRule', 'ListDataSourceSharedRules'], 'type' => 'directory', - 'children' => [ - 'CreateDataSourceSharedRule', - 'DeleteDataSourceSharedRule', - 'ListDataSourceSharedRules', - ], + 'title' => 'Data source sharing rule', ], ], + 'type' => 'directory', + 'title' => 'Data source', ], [ - 'id' => 321265, - 'title' => 'Computing Resource', + 'children' => ['DeleteComputeResource', 'GetComputeResource', 'UpdateComputeResource', 'ListComputeResources', 'CreateComputeResource'], 'type' => 'directory', - 'children' => [ - 'DeleteComputeResource', - 'DeleteComputeResource', - 'GetComputeResource', - 'UpdateComputeResource', - 'ListComputeResources', - 'CreateComputeResource', - ], + 'title' => 'Compute resource', ], [ - 'id' => 198537, - 'title' => 'Resource Group Management', - 'type' => 'directory', 'children' => [ [ - 'id' => 198549, - 'title' => 'Resource Group', + 'children' => ['CreateResourceGroup', 'DeleteResourceGroup', 'UpdateResourceGroup', 'GetResourceGroup', 'ListResourceGroups', 'DissociateProjectFromResourceGroup', 'AssociateProjectToResourceGroup', 'ListResourceGroupAssociateProjects', 'ListResourceGroupMetricData'], 'type' => 'directory', - 'children' => [ - 'CreateResourceGroup', - 'DeleteResourceGroup', - 'UpdateResourceGroup', - 'GetResourceGroup', - 'ListResourceGroups', - 'DissociateProjectFromResourceGroup', - 'AssociateProjectToResourceGroup', - 'ListResourceGroupAssociateProjects', - 'ListResourceGroupMetricData', - ], + 'title' => 'Resource group', ], [ - 'id' => 198538, - 'title' => 'Routing', + 'children' => ['CreateRoute', 'DeleteRoute', 'UpdateRoute', 'GetRoute', 'ListRoutes'], 'type' => 'directory', - 'children' => [ - 'CreateRoute', - 'DeleteRoute', - 'UpdateRoute', - 'GetRoute', - 'ListRoutes', - ], + 'title' => 'Route', ], [ - 'id' => 198544, - 'title' => 'Network', + 'children' => ['CreateNetwork', 'DeleteNetwork', 'GetNetwork', 'ListNetworks'], 'type' => 'directory', - 'children' => [ - 'CreateNetwork', - 'DeleteNetwork', - 'GetNetwork', - 'ListNetworks', - ], + 'title' => 'Network', ], ], + 'type' => 'directory', + 'title' => 'Resource group management', ], [ - 'id' => 197271, - 'title' => 'Data Development', + 'children' => ['GetImage', 'ListImages', 'ListImageVersions', 'AssociateProjectToImage', 'DissociateProjectFromImage', 'ListImageAssociatedProjects'], 'type' => 'directory', + 'title' => 'Image management', + ], + [ 'children' => [ [ - 'id' => 268819, - 'title' => 'Component', + 'children' => ['CreateComponent', 'DeleteComponent', 'GetComponent', 'UpdateComponent', 'ListComponents'], 'type' => 'directory', - 'children' => [ - 'CreateComponent', - 'DeleteComponent', - 'GetComponent', - 'UpdateComponent', - 'ListComponents', - ], + 'title' => 'Component', ], [ - 'id' => 197703, - 'title' => 'Node', + 'children' => ['CreateNode', 'DeleteNode', 'UpdateNode', 'MoveNode', 'RenameNode', 'GetNode', 'ListNodes', 'ListNodeDependencies'], 'type' => 'directory', - 'children' => [ - 'CreateNode', - 'DeleteNode', - 'UpdateNode', - 'MoveNode', - 'RenameNode', - 'GetNode', - 'ListNodes', - 'ListNodeDependencies', - ], + 'title' => 'Node', ], [ - 'id' => 197702, - 'title' => 'Workflow Definition', + 'children' => ['CreateWorkflowDefinition', 'ImportWorkflowDefinition', 'DeleteWorkflowDefinition', 'UpdateWorkflowDefinition', 'MoveWorkflowDefinition', 'RenameWorkflowDefinition', 'GetWorkflowDefinition', 'ListWorkflowDefinitions'], 'type' => 'directory', - 'children' => [ - 'CreateWorkflowDefinition', - 'ImportWorkflowDefinition', - 'DeleteWorkflowDefinition', - 'UpdateWorkflowDefinition', - 'MoveWorkflowDefinition', - 'RenameWorkflowDefinition', - 'GetWorkflowDefinition', - 'ListWorkflowDefinitions', - ], + 'title' => 'Workflow definition', ], [ - 'id' => 197700, - 'title' => 'Resource', + 'children' => ['CreateResource', 'DeleteResource', 'UpdateResource', 'GetResource', 'ListResources', 'MoveResource', 'RenameResource'], 'type' => 'directory', - 'children' => [ - 'CreateResource', - 'DeleteResource', - 'DeleteResource', - 'UpdateResource', - 'MoveResource', - 'RenameResource', - 'GetResource', - 'ListResources', - ], + 'title' => 'Resource', ], [ - 'id' => 197701, - 'title' => 'Function', + 'children' => ['CreateFunction', 'DeleteFunction', 'UpdateFunction', 'MoveFunction', 'RenameFunction', 'GetFunction', 'ListFunctions'], 'type' => 'directory', - 'children' => [ - 'CreateFunction', - 'DeleteFunction', - 'UpdateFunction', - 'UpdateFunction', - 'MoveFunction', - 'RenameFunction', - 'GetFunction', - 'ListFunctions', - ], + 'title' => 'Function', ], [ - 'id' => 197704, - 'title' => 'Deployment', + 'children' => ['CreatePipelineRun', 'AbolishPipelineRun', 'ExecPipelineRunStage', 'GetPipelineRun', 'ListPipelineRuns', 'ListPipelineRunItems'], 'type' => 'directory', - 'children' => [ - 'CreatePipelineRun', - 'AbolishPipelineRun', - 'ExecPipelineRunStage', - 'GetPipelineRun', - 'ListPipelineRuns', - 'ListPipelineRunItems', - ], + 'title' => 'Publish process', ], ], + 'type' => 'directory', + 'title' => 'Data development (new version)', ], [ - 'id' => 208290, - 'title' => 'Data Development (Old)', - 'type' => 'directory', 'children' => [ [ - 'id' => 208291, - 'title' => 'File', + 'children' => ['CreateFile', 'CreateResourceFile', 'CreateUdfFile', 'UpdateFile', 'UpdateUdfFile', 'GetFile', 'ListFiles', 'SubmitFile', 'DeployFile'], 'type' => 'directory', - 'children' => [ - 'CreateFile', - 'CreateResourceFile', - 'CreateUdfFile', - 'DeleteFile', - 'UpdateFile', - 'UpdateUdfFile', - 'GetFile', - 'ListFiles', - 'SubmitFile', - 'DeployFile', - ], + 'title' => 'File', ], [ - 'id' => 208302, - 'title' => 'Folder', + 'children' => ['CreateFolder', 'DeleteFolder', 'UpdateFolder', 'GetFolder', 'ListFolders'], 'type' => 'directory', - 'children' => [ - 'CreateFolder', - 'DeleteFolder', - 'UpdateFolder', - 'GetFolder', - 'ListFolders', - ], + 'title' => 'Folder', ], [ - 'id' => 208308, - 'title' => 'Business', + 'children' => ['CreateBusiness', 'DeleteBusiness', 'UpdateBusiness', 'GetBusiness', 'ListBusiness'], 'type' => 'directory', - 'children' => [ - 'CreateBusiness', - 'DeleteBusiness', - 'UpdateBusiness', - 'GetBusiness', - 'ListBusiness', - ], + 'title' => 'Business process', ], [ - 'id' => 208314, - 'title' => 'Deployment Package', + 'children' => ['GetDeploymentPackage', 'ListDeploymentPackages', 'ListDeploymentPackageFiles'], 'type' => 'directory', - 'children' => [ - 'GetDeploymentPackage', - 'ListDeploymentPackages', - 'ListDeploymentPackageFiles', - ], + 'title' => 'Publish package', ], [ - 'id' => 208318, - 'title' => 'File Version', + 'children' => ['GetFileVersion', 'ListFileVersions'], 'type' => 'directory', - 'children' => [ - 'GetFileVersion', - 'ListFileVersions', - ], + 'title' => 'File version', ], [ - 'id' => 208321, - 'title' => 'IDE Event', + 'children' => ['UpdateIDEEventResult', 'GetIDEEventDetail'], 'type' => 'directory', - 'children' => [ - 'UpdateIDEEventResult', - 'GetIDEEventDetail', - ], + 'title' => 'Extension point event', ], [ - 'id' => 208324, - 'title' => 'Table', + 'children' => ['EstablishRelationTableToBusiness'], 'type' => 'directory', - 'children' => [ - 'EstablishRelationTableToBusiness', - ], + 'title' => 'Table', ], ], + 'type' => 'directory', + 'title' => 'Data development (legacy)', ], [ - 'id' => 198342, - 'title' => 'Data Integration', - 'type' => 'directory', 'children' => [ [ - 'id' => 198343, - 'title' => 'Synchronization Task', + 'children' => ['CreateDIJob', 'UpdateDIJob', 'DeleteDIJob', 'StopDIJob', 'StartDIJob', 'GetDIJob', 'GetDIJobLog', 'ListDIJobs', 'ListDIJobRunDetails', 'ListDIJobMetrics', 'ListDIJobEvents'], 'type' => 'directory', - 'children' => [ - 'CreateDIJob', - 'UpdateDIJob', - 'DeleteDIJob', - 'StopDIJob', - 'StartDIJob', - 'GetDIJob', - 'GetDIJobLog', - 'ListDIJobs', - 'ListDIJobRunDetails', - 'ListDIJobMetrics', - 'ListDIJobEvents', - ], - ], - [ - 'id' => 198354, - 'title' => 'Task Alert', + 'title' => 'Synchronization task', + ], + [ + 'children' => ['CreateDIAlarmRule', 'UpdateDIAlarmRule', 'DeleteDIAlarmRule', 'ListDIAlarmRules'], 'type' => 'directory', - 'children' => [ - 'CreateDIAlarmRule', - 'UpdateDIAlarmRule', - 'DeleteDIAlarmRule', - 'ListDIAlarmRules', - ], + 'title' => 'Task alert', ], ], + 'type' => 'directory', + 'title' => 'Data integration', ], [ - 'id' => 204415, - 'title' => 'Data Map', - 'type' => 'directory', 'children' => [ [ - 'id' => 204416, - 'title' => 'Metadata Collector Type', + 'children' => ['ListCustomAttributes', 'GetCustomAttribute', 'CreateCustomAttribute', 'UpdateCustomAttribute', 'DeleteCustomAttribute'], 'type' => 'directory', - 'children' => [ - 'ListCrawlerTypes', - ], + 'title' => 'Custom property', + ], + [ + 'children' => ['ListMetaEntityDefs', 'GetMetaEntityDef', 'CreateMetaEntityDef', 'UpdateMetaEntityDef'], + 'type' => 'directory', + 'title' => 'Custom metadata entity definition', ], [ - 'id' => 204418, - 'title' => 'Metadata Entity', + 'children' => ['ListCrawlerTypes'], 'type' => 'directory', + 'title' => 'Metadata collector type', + ], + [ 'children' => [ [ - 'id' => 204419, - 'title' => 'Catalog', + 'children' => ['ListMetaEntities', 'GetMetaEntity', 'BatchCreateMetaEntities', 'UpdateMetaEntity', 'BatchDeleteMetaEntities'], 'type' => 'directory', - 'children' => [ - 'ListCatalogs', - 'GetCatalog', - ], + 'title' => 'Custom entity', ], [ - 'id' => 204422, - 'title' => 'Data Base', + 'children' => ['ListCatalogs', 'GetCatalog'], 'type' => 'directory', - 'children' => [ - 'ListDatabases', - 'GetDatabase', - ], + 'title' => 'Data catalog', ], [ - 'id' => 204425, - 'title' => 'Schema', + 'children' => ['ListDatabases', 'GetDatabase'], 'type' => 'directory', - 'children' => [ - 'ListSchemas', - 'GetSchema', - ], + 'title' => 'Database', ], [ - 'id' => 204428, - 'title' => 'Table', + 'children' => ['ListSchemas', 'GetSchema'], 'type' => 'directory', - 'children' => [ - 'ListTables', - 'GetTable', - 'UpdateTableBusinessMetadata', - ], + 'title' => 'Schema', ], [ - 'id' => 204432, - 'title' => 'Column', + 'children' => ['ListTables', 'GetTable', 'UpdateTableBusinessMetadata'], 'type' => 'directory', - 'children' => [ - 'ListColumns', - 'GetColumn', - 'UpdateColumnBusinessMetadata', - ], + 'title' => 'Data table', ], [ - 'id' => 344258, - 'title' => 'Dataset', + 'children' => ['ListColumns', 'GetColumn', 'UpdateColumnBusinessMetadata'], 'type' => 'directory', - 'children' => [ - 'ListDatasets', - 'GetDataset', - 'CreateDataset', - 'UpdateDataset', - 'DeleteDataset', - ], + 'title' => 'Field', ], [ - 'id' => 347399, - 'title' => 'Dataset Version', + 'children' => ['ListDatasets', 'GetDataset', 'CreateDataset', 'UpdateDataset', 'DeleteDataset'], 'type' => 'directory', - 'children' => [ - 'ListDatasetVersions', - 'GetDatasetVersion', - 'CreateDatasetVersion', - 'UpdateDatasetVersion', - 'DeleteDatasetVersion', - 'PreviewDatasetVersion', - ], + 'title' => 'Dataset', + ], + [ + 'children' => ['ListDatasetVersions', 'GetDatasetVersion', 'CreateDatasetVersion', 'UpdateDatasetVersion', 'DeleteDatasetVersion', 'PreviewDatasetVersion'], + 'type' => 'directory', + 'title' => 'Dataset version', ], ], + 'type' => 'directory', + 'title' => 'Metadata entity', ], [ - 'id' => 204436, - 'title' => 'Partition', + 'children' => ['ListPartitions', 'GetPartition'], 'type' => 'directory', - 'children' => [ - 'ListPartitions', - 'GetPartition', - ], + 'title' => 'Partition', ], [ - 'id' => 204439, - 'title' => 'Lineage Relationship', + 'children' => ['ListLineageRelationships', 'GetLineageRelationship', 'DeleteLineageRelationship', 'CreateLineageRelationship', 'ListLineages'], 'type' => 'directory', - 'children' => [ - 'ListLineageRelationships', - 'GetLineageRelationship', - 'DeleteLineageRelationship', - 'CreateLineageRelationship', - 'ListLineages', - ], + 'title' => 'Lineage', ], [ - 'id' => 204445, - 'title' => 'Meta Collection', + 'children' => ['ListMetaCollections', 'CreateMetaCollection', 'GetMetaCollection', 'UpdateMetaCollection', 'DeleteMetaCollection', 'ListEntitiesInMetaCollection', 'AddEntityIntoMetaCollection', 'RemoveEntityFromMetaCollection'], 'type' => 'directory', - 'children' => [ - 'ListMetaCollections', - 'CreateMetaCollection', - 'GetMetaCollection', - 'UpdateMetaCollection', - 'DeleteMetaCollection', - 'ListEntitiesInMetaCollection', - 'AddEntityIntoMetaCollection', - 'RemoveEntityFromMetaCollection', - ], + 'title' => 'Metadata collection', ], ], + 'type' => 'directory', + 'title' => 'Data map', ], [ - 'id' => 198752, - 'title' => 'Operation Center', - 'type' => 'directory', 'children' => [ [ - 'id' => 199222, - 'title' => 'Monitoring Alarm', + 'children' => ['CreateParameter', 'DeleteParameter', 'UpdateParameter', 'RollbackParameter', 'GetParameter', 'ListParameters', 'ListParameterVersions'], 'type' => 'directory', - 'children' => [ - 'ListAlertRules', - 'GetAlertRule', - 'UpdateAlertRule', - 'DeleteAlertRule', - 'CreateAlertRule', - ], + 'title' => 'Parameter', + ], + [ + 'children' => ['ListAlertRules', 'GetAlertRule', 'UpdateAlertRule', 'DeleteAlertRule', 'CreateAlertRule'], + 'type' => 'directory', + 'title' => 'Monitoring and alerting', ], [ - 'id' => 198753, + 'children' => ['DeleteTask', 'UpdateTask', 'BatchUpdateTasks', 'GetTask', 'ListTasks', 'ListUpstreamTasks', 'ListDownstreamTasks', 'ListTaskOperationLogs'], + 'type' => 'directory', 'title' => 'Task', + ], + [ + 'children' => ['UpdateTaskInstances', 'GetTaskInstance', 'GetTaskInstanceLog', 'ListTaskInstances', 'ListUpstreamTaskInstances', 'ListTaskInstanceOperationLogs', 'ListDownstreamTaskInstances', 'SuspendTaskInstances', 'ResumeTaskInstances', 'StopTaskInstances', 'SetSuccessTaskInstances', 'RerunTaskInstances', 'RemoveTaskInstanceDependencies', 'TriggerSchedulerTaskInstance'], 'type' => 'directory', - 'children' => [ - 'DeleteTask', - 'UpdateTask', - 'BatchUpdateTasks', - 'GetTask', - 'ListTasks', - 'ListUpstreamTasks', - 'ListDownstreamTasks', - 'ListTaskOperationLogs', - ], + 'title' => 'Task instance', ], [ - 'id' => 198759, - 'title' => 'Task Instances', + 'children' => ['DeleteWorkflow'], 'type' => 'directory', - 'children' => [ - 'UpdateTaskInstances', - 'GetTaskInstance', - 'GetTaskInstanceLog', - 'ListTaskInstances', - 'ListUpstreamTaskInstances', - 'ListTaskInstanceOperationLogs', - 'ListDownstreamTaskInstances', - 'SuspendTaskInstances', - 'ResumeTaskInstances', - 'StopTaskInstances', - 'SetSuccessTaskInstances', - 'RerunTaskInstances', - 'RemoveTaskInstanceDependencies', - 'TriggerSchedulerTaskInstance', - ], - ], - [ - 'id' => 201611, 'title' => 'Workflow', - 'type' => 'directory', - 'children' => [ - 'DeleteWorkflow', - 'UpdateWorkflow', - 'GetWorkflow', - 'ListWorkflows', - ], ], [ - 'id' => 201615, - 'title' => 'Workflow Instances', + 'children' => ['GetRerunWorkflowInstancesResult', 'RerunWorkflowInstances', 'CreateWorkflowInstances', 'GetCreateWorkflowInstancesResult', 'GetWorkflowInstance', 'ListWorkflowInstances', 'StartWorkflowInstances', 'StopWorkflowInstances', 'ExecuteAdhocWorkflowInstance'], 'type' => 'directory', - 'children' => [ - 'GetRerunWorkflowInstancesResult', - 'RerunWorkflowInstances', - 'CreateWorkflowInstances', - 'GetCreateWorkflowInstancesResult', - 'GetWorkflowInstance', - 'ListWorkflowInstances', - 'StartWorkflowInstances', - 'StopWorkflowInstances', - 'ExecuteAdhocWorkflowInstance', - ], + 'title' => 'Workflow instance', ], ], + 'type' => 'directory', + 'title' => 'Operation center', ], [ - 'id' => 198728, - 'title' => 'Data Quality', - 'type' => 'directory', 'children' => [ [ - 'id' => 199702, - 'title' => 'Data Quality Template', + 'children' => ['CreateDataQualityTemplate', 'UpdateDataQualityTemplate', 'ListDataQualityTemplates', 'GetDataQualityTemplate', 'DeleteDataQualityTemplate'], 'type' => 'directory', - 'children' => [ - 'CreateDataQualityTemplate', - 'UpdateDataQualityTemplate', - 'ListDataQualityTemplates', - 'GetDataQualityTemplate', - 'DeleteDataQualityTemplate', - ], + 'title' => 'Data quality rule template', ], [ - 'id' => 199687, - 'title' => 'Data Quality Scan', + 'children' => ['CreateDataQualityScan', 'UpdateDataQualityScan', 'ListDataQualityScans', 'GetDataQualityScan', 'DeleteDataQualityScan'], 'type' => 'directory', - 'children' => [ - 'CreateDataQualityScan', - 'UpdateDataQualityScan', - 'ListDataQualityScans', - 'GetDataQualityScan', - 'DeleteDataQualityScan', - ], + 'title' => 'Data quality monitoring', ], [ - 'id' => 199694, - 'title' => 'Data Quality Alert Rules', + 'children' => ['CreateDataQualityAlertRule', 'UpdateDataQualityAlertRule', 'ListDataQualityAlertRules', 'GetDataQualityAlertRule', 'DeleteDataQualityAlertRule'], 'type' => 'directory', - 'children' => [ - 'CreateDataQualityAlertRule', - 'UpdateDataQualityAlertRule', - 'ListDataQualityAlertRules', - 'GetDataQualityAlertRule', - 'DeleteDataQualityAlertRule', - ], + 'title' => 'Alert rule', ], [ - 'id' => 199699, - 'title' => 'Data Quality ScanRun', + 'children' => ['CreateDataQualityScanRun', 'ListDataQualityScanRuns', 'GetDataQualityScanRunLog', 'GetDataQualityScanRun'], 'type' => 'directory', - 'children' => [ - 'CreateDataQualityScanRun', - 'ListDataQualityScanRuns', - 'GetDataQualityScanRunLog', - 'GetDataQualityScanRun', - ], + 'title' => 'Data quality run', ], ], + 'type' => 'directory', + 'title' => 'Data quality', ], [ - 'id' => 339900, - 'title' => 'Security Center', - 'type' => 'directory', 'children' => [ + [ + 'children' => ['ApplyResourceAccessPermission', 'StopProcessInstance', 'ApproveProcessInstance', 'GetApplicationContents', 'GetProcessInstance', 'ListPendingApprovals', 'ListMyRelatedApprovals', 'ListMyApplications'], + 'type' => 'directory', + 'title' => 'Permission request and approval', + ], + [ + 'children' => ['CreateSecurityStrategy', 'DeleteSecurityStrategy', 'UpdateSecurityStrategy', 'GetSecurityStrategy', 'ListSecurityStrategies', 'FindBestMatchSecurityStrategy'], + 'type' => 'directory', + 'title' => 'Query result control policy', + ], + [ + 'children' => ['CreateProcessDefinition', 'DeleteProcessDefinition', 'EnableProcessDefinition', 'DisableProcessDefinition', 'UpdateProcessDefinition', 'GetProcessDefinition', 'ListProcessDefinitions'], + 'type' => 'directory', + 'title' => 'Approval policy', + ], 'CreateIdentifyCredential', ], + 'type' => 'directory', + 'title' => 'Security center', ], [ - 'id' => 201385, - 'title' => 'Tags Management', + 'children' => ['CreateDataAssetTag', 'DeleteDataAssetTag', 'UpdateDataAssetTag', 'ListDataAssetTags', 'TagDataAssets', 'UnTagDataAssets', 'ListDataAssets'], 'type' => 'directory', - 'children' => [ - 'CreateDataAssetTag', - 'DeleteDataAssetTag', - 'UpdateDataAssetTag', - 'ListDataAssetTags', - 'TagDataAssets', - 'UnTagDataAssets', - 'ListDataAssets', - ], + 'title' => 'Tag management', ], [ - 'id' => 198491, - 'title' => 'Open Platform', + 'children' => ['GetJobStatus'], 'type' => 'directory', - 'children' => [ - 'GetJobStatus', - ], + 'title' => 'Open platform', ], [ - 'id' => 246416, - 'title' => 'Other', - 'type' => 'directory', 'children' => [ - 'ListDataQualityEvaluationTasks', - 'ListDataQualityRules', - 'ListDataQualityEvaluationTaskInstances', - 'ListDataQualityResults', - 'DetachDataQualityRulesFromEvaluationTask', - 'DeleteDataQualityEvaluationTask', - 'GetDataQualityEvaluationTaskInstance', - 'GetDataQualityEvaluationTask', - 'AttachDataQualityRulesToEvaluationTask', - 'UpdateDataQualityEvaluationTask', - 'CreateDataQualityEvaluationTaskInstance', - 'CreateDataQualityEvaluationTask', - 'DeleteDataQualityRule', - 'UpdateDataQualityRuleTemplate', - 'CreateDataQualityRuleTemplate', - 'DeleteDataQualityRuleTemplate', - 'GetDataQualityRuleTemplate', - 'CreateDataQualityRule', - 'UpdateDataQualityRule', - 'GetDataQualityRule', - 'ListDataQualityRuleTemplates', + 'ListDataQualityEvaluationTasks', 'ListDataQualityRules', 'ListDataQualityEvaluationTaskInstances', 'ListDataQualityResults', 'DetachDataQualityRulesFromEvaluationTask', 'DeleteDataQualityEvaluationTask', 'GetDataQualityEvaluationTaskInstance', 'GetDataQualityEvaluationTask', 'AttachDataQualityRulesToEvaluationTask', 'UpdateDataQualityEvaluationTask', 'CreateDataQualityEvaluationTaskInstance', 'CreateDataQualityEvaluationTask', 'UpdateDataQualityRuleTemplate', 'CreateDataQualityRuleTemplate', 'DeleteDataQualityRuleTemplate', 'GetDataQualityRuleTemplate', 'CreateDataQualityRule', 'UpdateDataQualityRule', 'GetDataQualityRule', 'ListDataQualityRuleTemplates', + 'DeleteCertificate', 'GetCertificate', 'GetDataSource', 'ImportCertificate', 'ListCertificates', 'DeleteFile', 'GetWorkflow', 'ListWorkflows', 'UpdateWorkflow', 'CreateSkill', 'DeleteAgent', 'DeleteDataQualityRule', 'DeleteMetaEntityDef', ], + 'type' => 'directory', + 'title' => 'Others', ], ], 'components' => [ 'schemas' => [ 'Catalog' => [ - 'title' => '', + 'title' => '元数据数据目录', 'description' => 'The metadata catalog.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => 'ID', - 'description' => 'The catalog ID. Currently, only the DLF and StarRocks types are supported. For details, see [description of concepts related to metadata entities.](~~2880092~~)'."\n" - ."\n" - .'* For the DLF type, the format is `dlf-catalog::catalog_id`.'."\n" - .'* For the starrocks type, the format is `starrocks-catalog:(instance_id|encoded_jdbc_url):catalog_name`.'."\n" - ."\n" - .'> \\'."\n" - .'`catalog_id`: The the DLF catalog ID.\\'."\n" - .'`instance_id`: The instance ID, required if the data source is registered in instance mode.\\'."\n" - .'`encoded_jdbc_url`: The URL-encoded JDBC connection string, required if the data source is registered using a connection string.\\'."\n" - .'`catalog_name`: The StarRocks catalog name.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'dlf-catalog:123456XXX:test_catalog'."\n" - .'starrocks-catalog:c-abc123xxx:default_catalog', - 'backendName' => 'id', - ], - 'Name' => [ - 'title' => '', - 'description' => 'The catalog name.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'default_catalog', - 'backendName' => 'name', - ], - 'Comment' => [ - 'title' => '', - 'description' => 'The comment.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'this is a comment'."\n", - 'backendName' => 'comment', - ], - 'Type' => [ - 'title' => '', - 'description' => 'The catalog type. The value of this parameter varies based on the type of the metadata crawler.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Internal', - 'backendName' => 'type', - ], - 'CreateTime' => [ - 'title' => '', - 'description' => 'The creation time. The value is a UNIX timestamp. Unit: milliseconds.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1722073854000', - 'backendName' => 'createTime', - ], - 'ModifyTime' => [ - 'title' => '', - 'description' => 'The modification time. The value is a UNIX timestamp. Unit: milliseconds.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1722073854000'."\n", - 'backendName' => 'modifyTime', - ], - 'ParentMetaEntityId' => [ - 'title' => '', - 'description' => 'The parent entity ID.'."\n" - ."\n" - .'* For the DLF type, the format of `ParentMetaEntityId` is `dlf`.'."\n" - .'* For the StarRocks type, the format of `ParentMetaEntityId` is `starrocks:(instance_id|encoded_jdbc_url)`.'."\n" - ."\n" - .'> \\'."\n" - .'`instance_id`: The instance ID, required when the data source is registered in instance mode.\\'."\n" - .'`encoded_jdbc_url`: The URL-encoded JDBC connection string, required if the data source is registered via a connection string.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'dlf'."\n" - .'starrocks:c-abc123xxx', - 'backendName' => 'parentMetaEntityId', - ], + 'Id' => ['title' => 'ID', 'description' => 'The catalog ID. Currently, only the DLF and StarRocks types are supported. For details, see [description of concepts related to metadata entities.](~~2880092~~)'."\n" + ."\n" + .'* For the DLF type, the format is `dlf-catalog::catalog_id`.'."\n" + .'* For the starrocks type, the format is `starrocks-catalog:(instance_id|encoded_jdbc_url):catalog_name`.'."\n" + ."\n" + .'> \\'."\n" + .'`catalog_id`: The the DLF catalog ID.\\'."\n" + .'`instance_id`: The instance ID, required if the data source is registered in instance mode.\\'."\n" + .'`encoded_jdbc_url`: The URL-encoded JDBC connection string, required if the data source is registered using a connection string.\\'."\n" + .'`catalog_name`: The StarRocks catalog name.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'dlf-catalog:123456XXX:test_catalog'."\n" + .'starrocks-catalog:c-abc123xxx:default_catalog', 'backendName' => 'id'], + 'Name' => ['title' => '名称', 'description' => 'The catalog name.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'default_catalog', 'backendName' => 'name'], + 'Comment' => ['title' => '注释', 'description' => 'The comment.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'this is a comment'."\n", 'backendName' => 'comment'], + 'Type' => ['title' => '类型', 'description' => 'The catalog type. The value of this parameter varies based on the type of the metadata crawler.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'Internal', 'backendName' => 'type'], + 'CreateTime' => ['title' => '创建时间', 'description' => 'The creation time. The value is a UNIX timestamp. Unit: milliseconds.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1722073854000', 'backendName' => 'createTime'], + 'ModifyTime' => ['title' => '修改时间', 'description' => 'The modification time. The value is a UNIX timestamp. Unit: milliseconds.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1722073854000'."\n", 'backendName' => 'modifyTime'], + 'ParentMetaEntityId' => ['title' => '父层级实体ID', 'description' => 'The parent entity ID.'."\n" + ."\n" + .'* For the DLF type, the format of `ParentMetaEntityId` is `dlf`.'."\n" + .'* For the StarRocks type, the format of `ParentMetaEntityId` is `starrocks:(instance_id|encoded_jdbc_url)`.'."\n" + ."\n" + .'> \\'."\n" + .'`instance_id`: The instance ID, required when the data source is registered in instance mode.\\'."\n" + .'`encoded_jdbc_url`: The URL-encoded JDBC connection string, required if the data source is registered via a connection string.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'dlf'."\n" + .'starrocks:c-abc123xxx', 'backendName' => 'parentMetaEntityId'], ], ], 'Column' => [ 'title' => '', - 'description' => 'The field.'."\n", - 'visibility' => 'Public', + 'description' => 'The table column.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => 'ID', - 'description' => 'The ID. For more information, see [Description of concepts related to metadata entities](~~2880092~~).'."\n" - ."\n" - .'The format is: `${EntityType}:${Instance ID or encoded URL}:${Catalog Identifier}:${Database name}:${Schema name}:${Table Name}:${Column name}`. Use empty strings as placeholders for non-existent hierarchy levels.'."\n" - ."\n" - .'> For the MaxCompute and DLF types, use an empty string as the placeholder for the instance ID. For MaxCompute, the database name refers to the MaxCompute project name. If the project has schema enabled, you must specify the schema name. Otherwise, use an empty string as the placeholder for the schema name.'."\n" - ."\n" - .'> For StarRocks, the catalog identifier is the catalog name. For DLF, it is the catalog ID. Other types do not support the catalog level and you can use an empty string as a placeholder.'."\n" - ."\n" - .'Examples of ID formats for common types are as follows:'."\n" - ."\n" - .'`maxcompute-column:::project_name:[schema_name]:table_name:column_name`'."\n" - ."\n" - .'`dlf-column::catalog_id:database_name::table_name:column_name`'."\n" - ."\n" - .'`hms-column:instance_id::database_name::table_name:column_name`'."\n" - ."\n" - .'`holo-column:instance_id::database_name:schema_name:table_name:column_name`'."\n" - ."\n" - .'`mysql-column:(instance_id|encoded_jdbc_url)::database_name::table_name:column_name`'."\n" - ."\n" - .'> \\'."\n" - .'`instance_id`: The instance ID, required when the data source is registered in instance mode.\\'."\n" - .'`encoded_jdbc_url`: The URL-encoded JDBC connection string, which is required when the data source is registered via a connection string.\\'."\n" - .'`catalog_id`: The DLF catalog ID.\\'."\n" - .'`project_name`: The MaxCompute project name.\\'."\n" - .'`database_name`: The database name.\\'."\n" - .'`schema_name`: The schema name. For the MaxCompute type, this is required only if the project has enabled schema; otherwise, use an empty string as a placeholder.\\'."\n" - .'`table_name`: The table name.\\'."\n" - .'`column_name`: The field name.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'maxcompute-column:123456::test_project:default:test_tbl:col1', - 'backendName' => 'id', - ], - 'Name' => [ - 'title' => '', - 'description' => 'The name.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'col1', - 'backendName' => 'name', - ], - 'Comment' => [ - 'title' => '', - 'description' => 'The comment.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'comment', - ], - 'TableId' => [ - 'title' => '', - 'description' => 'The table ID. You can refer to the `Table` object.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'maxcompute-table:123456::test_project:default:test_tbl', - 'backendName' => 'tableId', - ], - 'Position' => [ - 'title' => '', - 'description' => 'The position of the field.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'backendName' => 'position', - ], - 'Type' => [ - 'title' => '', - 'description' => 'The type.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'bigint', - 'backendName' => 'type', - ], - 'PrimaryKey' => [ - 'title' => '', - 'description' => 'Specifies whether the column is a primary key (only supported by MaxCompute).'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'primaryKey', - ], - 'PartitionKey' => [ - 'title' => '', - 'description' => 'Specifies whether the column is a partition key.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'partitionKey', - ], - 'ForeignKey' => [ - 'title' => '', - 'description' => 'Specifies whether the column is a foreign key (only supported by MaxCompute).'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'foreignKey', - ], + 'Id' => ['title' => '', 'description' => 'The ID. For more information, see [Metadata entity concepts](~~2880092~~).'."\n" + ."\n" + .'The format is `${EntityType}:${instance ID or encoded URL}:${DataCatalogIdentity}:${DatabaseName}:${PatternName}:${TableName}:${ColumnName}`. Use an empty character as a placeholder for levels that do not exist.'."\n" + ."\n" + .'> For MaxCompute and DLF types, use an empty string as a placeholder for the instance ID. For MaxCompute, the database name is the MaxCompute project name. Projects with the three-layer model enabled must include the schema name. For projects without the three-layer model enabled, use an empty string as a placeholder for the schema name.'."\n" + ."\n" + .'> For StarRocks, the data catalog identifier is the catalog name. For DLF, the data catalog identifier is the catalog ID. Other types do not support the catalog level, and you can use an empty string as a placeholder.'."\n" + ."\n" + .'The following examples show the ID formats for several common types:'."\n" + ."\n" + .'`maxcompute-column:::project_name:[schema_name]:table_name:column_name`'."\n" + ."\n" + .'`dlf-column::catalog_id:database_name::table_name:column_name`'."\n" + ."\n" + .'`hms-column:instance_id::database_name::table_name:column_name`'."\n" + ."\n" + .'`holo-column:instance_id::database_name:schema_name:table_name:column_name`'."\n" + ."\n" + .'`mysql-column:(instance_id|encoded_jdbc_url)::database_name::table_name:column_name`'."\n" + ."\n" + .'> Where '."\n" + .'`instance_id`: The instance ID. This is required when the data source is registered in instance mode. '."\n" + .'`encoded_jdbc_url`: The URL-encoded JDBC connection string. This is required when the data source is registered by using a connection string. '."\n" + .'`catalog_id`: The DLF catalog ID. '."\n" + .'`project_name`: The MaxCompute project name. '."\n" + .'`database_name`: The database name. '."\n" + .'`schema_name`: The schema name. For MaxCompute, this is required only when the three-layer model is enabled for the project. If the three-layer model is not enabled, use an empty string as a placeholder. '."\n" + .'`table_name`: The table name. '."\n" + .'`column_name`: The column name.', 'type' => 'string', 'example' => 'maxcompute-column:::project_name:[schema_name]:table_name:column_name'], + 'Name' => ['title' => '', 'description' => 'The name.', 'type' => 'string', 'example' => 'column_name'], + 'Comment' => ['title' => '', 'description' => 'The comment.', 'type' => 'string', 'example' => '字段1'], + 'TableId' => ['title' => '', 'description' => 'The table ID. For more information, see the `Table` object.', 'type' => 'string', 'example' => 'maxcompute-table:::project_name:[schema_name]:table_name'], + 'Position' => ['title' => '', 'description' => 'The position.', 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Type' => ['title' => '', 'description' => 'The type.', 'type' => 'string', 'example' => 'bigint'], + 'PrimaryKey' => ['title' => '', 'description' => 'Indicates whether the column is a primary key. Currently, only MaxCompute is supported.', 'type' => 'boolean', 'example' => 'false'], + 'PartitionKey' => ['title' => '', 'description' => 'Indicates whether the column is a partition key.', 'type' => 'boolean', 'example' => 'false'], + 'ForeignKey' => ['title' => '', 'description' => 'Indicates whether the column is a foreign key. Currently, only MaxCompute is supported.', 'type' => 'boolean', 'example' => 'false'], 'BusinessMetadata' => [ 'title' => '', - 'description' => 'Business metadata.'."\n", - 'visibility' => 'Public', + 'description' => 'The business metadata.', 'type' => 'object', 'properties' => [ - 'Description' => [ + 'Description' => ['title' => '', 'description' => 'The business description of the field. Currently, only MaxCompute, HMS (EMR cluster), and DLF types are supported.', 'type' => 'string', 'example' => '字段1的业务描述'], + 'CustomAttributes' => [ 'title' => '', - 'description' => 'A business-level description of the field (supported only by MaxCompute, HMS (EMR clusters) and DLF.'."\n", - 'visibility' => 'Public', - 'type' => 'string', + 'description' => 'The custom attribute values, where key is the custom attribute identifier and value is the attribute value list.', + 'type' => 'object', + 'additionalProperties' => [ + 'title' => '', + 'description' => 'The attribute value list.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The attribute value.', 'type' => 'string', 'example' => '张三'], + 'example' => '', + ], 'example' => '', - 'backendName' => 'description', ], ], - 'backendName' => 'businessMetadata', + 'example' => '', + ], + 'StatisticsInfos' => [ + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], 'CrawlerType' => [ - 'title' => '', + 'title' => '元数据采集器类型', 'description' => 'The type of the metadata crawler.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'title' => '', - 'description' => 'The identifier of the metadata crawler type. Valid values:'."\n" - ."\n" - .'* `maxcompute`'."\n" - .'* `dlf`'."\n" - .'* `hms`: This type of crawler can be used to collect metadata from E-MapReduce (EMR) and CDH Hive clusters.'."\n" - .'* `holo`'."\n" - .'* `mysql`'."\n" - .'* `oracle`'."\n" - .'* `postgresql`'."\n" - .'* `sqlserver`'."\n" - .'* `analyticdb_for_mysql`'."\n" - .'* `ads`'."\n" - .'* `hybriddb_for_postgresql`'."\n" - .'* `ots`'."\n" - .'* `clickhouse`'."\n" - .'* `starrocks`: This type of crawler can be used to query metadata entities only in internal catalogs.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'dlf', - 'backendName' => 'type', - ], - 'DisplayName' => [ - 'title' => '', - 'description' => 'The display name of the metadata crawler.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Data Lake Formation', - 'backendName' => 'displayName', - ], + 'Type' => ['title' => '类型标识', 'description' => 'The identifier of the metadata crawler type. Valid values:'."\n" + ."\n" + .'* `maxcompute`'."\n" + .'* `dlf`'."\n" + .'* `hms`: This type of crawler can be used to collect metadata from E-MapReduce (EMR) and CDH Hive clusters.'."\n" + .'* `holo`'."\n" + .'* `mysql`'."\n" + .'* `oracle`'."\n" + .'* `postgresql`'."\n" + .'* `sqlserver`'."\n" + .'* `analyticdb_for_mysql`'."\n" + .'* `ads`'."\n" + .'* `hybriddb_for_postgresql`'."\n" + .'* `ots`'."\n" + .'* `clickhouse`'."\n" + .'* `starrocks`: This type of crawler can be used to query metadata entities only in internal catalogs.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'dlf', 'backendName' => 'type'], + 'DisplayName' => ['title' => '展示名称', 'description' => 'The display name of the metadata crawler.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'Data Lake Formation', 'backendName' => 'displayName'], 'SupportedEntityTypes' => [ - 'title' => '', + 'title' => '支持的实体类型列表，实体类型之间按照声明顺序，具有自上而下的层级关系', 'description' => 'The supported entity types. The entity types are sorted based on the declaration order.'."\n", 'visibility' => 'Public', 'type' => 'array', @@ -936,40 +516,12 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'title' => '', - 'description' => 'The identifier of the entity type. The value of this parameter varies based on the type of the metadata crawler. Configure this parameter in the `${Crawler type}-${Subtype}` format.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'dlf-table', - 'backendName' => 'type', - ], - 'SubType' => [ - 'title' => '', - 'description' => 'The identifier of the entity subtype. Valid values: `catalog, database, schema, table, and column`.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'table', - 'backendName' => 'subType', - ], - 'Optional' => [ - 'title' => '', - 'description' => 'Specifies whether the entity type is optional.'."\n" - ."\n" - .'For example, whether the schema level of the MaxCompute crawler type is optional depends on whether the three-layer model is enabled for a MaxCompute project.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'optional', - ], - 'ParentSubType' => [ - 'title' => '', - 'description' => 'The subtype of the parent entity. If the subtype does not exist, null is returned.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'database', - 'backendName' => 'parentSubType', - ], + 'Type' => ['title' => '实体类型标识，与采集器类型相关，格式为(CrawlerType)-{SubType}', 'description' => 'The identifier of the entity type. The value of this parameter varies based on the type of the metadata crawler. Configure this parameter in the `${Crawler type}-${Subtype}` format.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'dlf-table', 'backendName' => 'type'], + 'SubType' => ['title' => '实体子类型标识', 'description' => 'The identifier of the entity subtype. Valid values: `catalog, database, schema, table, and column`.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'table', 'backendName' => 'subType'], + 'Optional' => ['title' => '实体类型是否可选', 'description' => 'Specifies whether the entity type is optional.'."\n" + ."\n" + .'For example, whether the schema level of the MaxCompute crawler type is optional depends on whether the three-layer model is enabled for a MaxCompute project.'."\n", 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true', 'backendName' => 'optional'], + 'ParentSubType' => ['title' => '父层级的实体子类型，不存在时为null', 'description' => 'The subtype of the parent entity. If the subtype does not exist, null is returned.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'database', 'backendName' => 'parentSubType'], ], 'extendType' => 'true', 'description' => '', @@ -978,106 +530,99 @@ ], ], ], - 'Database' => [ + 'CustomAttribute' => [ 'title' => '', - 'description' => 'The information about the database.'."\n", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => 'ID', - 'description' => 'The database ID. For more information, see [Concepts related to metadata entities](~~2880092~~).'."\n" - ."\n" - .'The common format of this parameter is `${Entity type}:${Instance ID or escaped URL}:${Catalog identifier}:${Database name}`. If a level does not exist, specify an empty string as a placeholder.'."\n" - ."\n" - .'> For StarRocks data sources, specify a catalog name at the Catalog identifier level. For DLF data sources, specify a catalog ID at the Catalog identifier level. Other types of data sources do not support the Catalog identifier level. You can specify an empty string as a placeholder.'."\n" - ."\n" - .'You can configure this parameter in one of the following formats based on your data source type:'."\n" - ."\n" - .'`dlf-database::catalog_id:database_name`'."\n" - ."\n" - .'`holo-database:instance_id::database_name`'."\n" - ."\n" - .'`mysql-database:(instance_id|encoded_jdbc_url)::database_name`'."\n" - ."\n" - .'> \\'."\n" - .'`catalog_id`: the ID of a DLF catalog.\\'."\n" - .'`instance_id`: the ID of an instance. If the related data source is added to DataWorks in Alibaba Cloud instance mode, you must configure this parameter.\\'."\n" - .'`encoded_jdbc_url`: the JDBC connection string that is URL-encoded. If the related data source is added to DataWorks in connection string mode, you must configure this parameter.\\'."\n" - .'`database_name`: the name of a database.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'holo-database:h-xxxx::test_db', - 'backendName' => 'id', - ], - 'Name' => [ - 'title' => '', - 'description' => 'The database name.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test_db', - 'backendName' => 'name', - ], - 'Comment' => [ - 'title' => '', - 'description' => 'The comments.'."\n", - 'visibility' => 'Public', + 'Id' => ['description' => 'Custom attribute ID. It must match the regular expression ^custom-attribute:\\[A-Za-z]\\[A-Za-z0-9\\_]{0,98}$. The part after `custom-attribute:` must be fewer than 100 characters.', 'type' => 'string', 'title' => '', 'example' => 'custom-attribute:biz_owner'], + 'DisplayName' => ['description' => 'Display name for the custom attribute. It must be fewer than 128 characters.', 'type' => 'string', 'title' => '', 'example' => '业务负责人'], + 'Type' => [ + 'description' => 'Custom attribute type. Supported types are ENUM, TEXT, and HYPERLINK.', 'type' => 'string', - 'example' => 'test comment', - 'backendName' => 'comment', - ], - 'LocationUri' => [ 'title' => '', - 'description' => 'The uniform resource identifier (URI) of the storage location.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'oss://test-bucket/test_db', - 'backendName' => 'locationUri', + 'example' => 'TEXT', + 'enum' => ['ENUM', 'TEXT', 'HYPERLINK'], ], - 'ParentMetaEntityId' => [ + 'EntityTypes' => [ 'title' => '', - 'description' => 'The parent entity ID. For more information, see [Concepts related to metadata entities](~~2880092~~).'."\n" - ."\n" - .'You can call the ListCrawlerTypes operation to query the parent entity types.'."\n" - ."\n" - .'* If the parent entity is a catalog, you can configure the `ParentMetaEntityId` parameter by referring to the `Catalog` topic.'."\n" - .'* If the parent entity is a metadata crawler, you can configure the `ParentMetaEntityId` parameter in the `${Crawler type}:${Instance ID or escaped URL}` format.'."\n" - ."\n" - .'You can configure the ParentMetaEntityId parameter in one of the following formats based on your data source type:'."\n" + 'type' => 'array', + 'items' => ['description' => 'Entity type', 'type' => 'string', 'title' => '', 'example' => 'maxcompute-table'], + 'description' => 'List of applicable entity types. Supports exact entity types and wildcard patterns such as `*-table` and `*-column`, for example:'."\n" ."\n" - .'`dlf-catalog::catalog_id`'."\n" + .'- dataworks-project'."\n" ."\n" - .'`holo:instance_id`'."\n" + .'- dataworks-dataset'."\n" ."\n" - .'`mysql:(instance_id|encoded_jdbc_url)`'."\n" + .'- maxcompute-table'."\n" ."\n" - .'> \\'."\n" - .'`catalog_id`: the ID of a DLF catalog.\\'."\n" - .'`instance_id`: the ID of an instance. If the related data source is added to DataWorks in Alibaba Cloud instance mode, you must configure this parameter.\\'."\n" - .'`encoded_jdbc_url`: the JDBC connection string that is URL-encoded. If the related data source is added to DataWorks in connection string mode, you must configure this parameter.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'holo:h-xxxx', - 'backendName' => 'parentMetaEntityId', - ], - 'CreateTime' => [ - 'title' => '', - 'description' => 'The creation time. This value is a UNIX timestamp. Unit: milliseconds.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1736852168000', - 'backendName' => 'createTime', + .'- maxcompute-column', + 'example' => '', ], - 'ModifyTime' => [ + 'ValueEnums' => [ 'title' => '', - 'description' => 'The update time. This value is a UNIX timestamp. Unit: milliseconds.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1736852168000', - 'backendName' => 'modifyTime', + 'type' => 'array', + 'items' => ['description' => 'Enumeration value', 'type' => 'string', 'title' => '', 'example' => 'VALUE_1'], + 'description' => 'Enumeration values. Required when Type is ENUM. Not supported for TEXT or HYPERLINK types.', + 'example' => '', ], + 'SearchFilterEnabled' => ['description' => 'Indicates whether this attribute can be used as a filter on the search page (only affects search in Data Map). Only ENUM attributes can be set to true. Default is false.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'DisplayEnabled' => ['description' => 'Indicates whether this attribute is displayed on the page. Default is true.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'Comment' => ['description' => 'Description of the custom attribute. It must be fewer than 256 characters.', 'type' => 'string', 'title' => '', 'example' => 'this is a comment'], + 'CreateTime' => ['description' => 'Creation time as a millisecond UNIX timestamp.', 'type' => 'integer', 'title' => '', 'example' => '1750817692000', 'format' => 'int64'], + 'ModifyTime' => ['description' => 'Modification time as a millisecond UNIX timestamp.', 'type' => 'integer', 'title' => '', 'example' => '1763380628000', 'format' => 'int64'], + ], + 'description' => 'Custom attribute definition', + 'example' => '', + ], + 'Database' => [ + 'title' => '数据库', + 'description' => 'The information about the database.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => 'ID', 'description' => 'The database ID. For more information, see [Concepts related to metadata entities](~~2880092~~).'."\n" + ."\n" + .'The common format of this parameter is `${Entity type}:${Instance ID or escaped URL}:${Catalog identifier}:${Database name}`. If a level does not exist, specify an empty string as a placeholder.'."\n" + ."\n" + .'> For StarRocks data sources, specify a catalog name at the Catalog identifier level. For DLF data sources, specify a catalog ID at the Catalog identifier level. Other types of data sources do not support the Catalog identifier level. You can specify an empty string as a placeholder.'."\n" + ."\n" + .'You can configure this parameter in one of the following formats based on your data source type:'."\n" + ."\n" + .'`dlf-database::catalog_id:database_name`'."\n" + ."\n" + .'`holo-database:instance_id::database_name`'."\n" + ."\n" + .'`mysql-database:(instance_id|encoded_jdbc_url)::database_name`'."\n" + ."\n" + .'> \\'."\n" + .'`catalog_id`: the ID of a DLF catalog.\\'."\n" + .'`instance_id`: the ID of an instance. If the related data source is added to DataWorks in Alibaba Cloud instance mode, you must configure this parameter.\\'."\n" + .'`encoded_jdbc_url`: the JDBC connection string that is URL-encoded. If the related data source is added to DataWorks in connection string mode, you must configure this parameter.\\'."\n" + .'`database_name`: the name of a database.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'holo-database:h-xxxx::test_db', 'backendName' => 'id'], + 'Name' => ['title' => '名称', 'description' => 'The database name.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'test_db', 'backendName' => 'name'], + 'Comment' => ['title' => '注释', 'description' => 'The comments.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'test comment', 'backendName' => 'comment'], + 'LocationUri' => ['title' => '存储位置URI', 'description' => 'The uniform resource identifier (URI) of the storage location.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'oss://test-bucket/test_db', 'backendName' => 'locationUri'], + 'ParentMetaEntityId' => ['title' => '父层级元数据实体ID', 'description' => 'The parent entity ID. For more information, see [Concepts related to metadata entities](~~2880092~~).'."\n" + ."\n" + .'You can call the ListCrawlerTypes operation to query the parent entity types.'."\n" + ."\n" + .'* If the parent entity is a catalog, you can configure the `ParentMetaEntityId` parameter by referring to the `Catalog` topic.'."\n" + .'* If the parent entity is a metadata crawler, you can configure the `ParentMetaEntityId` parameter in the `${Crawler type}:${Instance ID or escaped URL}` format.'."\n" + ."\n" + .'You can configure the ParentMetaEntityId parameter in one of the following formats based on your data source type:'."\n" + ."\n" + .'`dlf-catalog::catalog_id`'."\n" + ."\n" + .'`holo:instance_id`'."\n" + ."\n" + .'`mysql:(instance_id|encoded_jdbc_url)`'."\n" + ."\n" + .'> \\'."\n" + .'`catalog_id`: the ID of a DLF catalog.\\'."\n" + .'`instance_id`: the ID of an instance. If the related data source is added to DataWorks in Alibaba Cloud instance mode, you must configure this parameter.\\'."\n" + .'`encoded_jdbc_url`: the JDBC connection string that is URL-encoded. If the related data source is added to DataWorks in connection string mode, you must configure this parameter.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'holo:h-xxxx', 'backendName' => 'parentMetaEntityId'], + 'CreateTime' => ['title' => '创建时间（毫秒级时间戳）', 'description' => 'The creation time. This value is a UNIX timestamp. Unit: milliseconds.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1736852168000', 'backendName' => 'createTime'], + 'ModifyTime' => ['title' => '更新时间（毫秒级时间戳）', 'description' => 'The update time. This value is a UNIX timestamp. Unit: milliseconds.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1736852168000', 'backendName' => 'modifyTime'], ], ], 'DataQualityEvaluationTask' => [ @@ -1086,153 +631,58 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '', - 'description' => 'The ID of the data quality monitoring task.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10001', - 'backendName' => 'id', - ], - 'Name' => [ - 'title' => '', - 'description' => 'The name of the data quality monitoring task. The name can be up to 255 characters in length and can contain digits, letters, and punctuation marks.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'name', - ], - 'Description' => [ - 'title' => '', - 'description' => 'The description of the task. The description can be up to 65,535 characters in length.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'This is a daily run data quality evaluation plan.', - 'backendName' => 'description', - ], - 'TenantId' => [ - 'title' => '', - 'description' => 'The DataWorks tenant ID.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - 'backendName' => 'tenantId', - ], - 'ProjectId' => [ - 'title' => '', - 'description' => 'The DataWorks workspace ID.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - 'backendName' => 'projectId', - ], + 'Id' => ['title' => '数据质量校验任务ID', 'description' => 'The ID of the data quality monitoring task.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '10001', 'backendName' => 'id'], + 'Name' => ['title' => '数据质量校验任务名称，数字、英文字母、汉字、半角全角标点符号组合，最长255个字符', 'description' => 'The name of the data quality monitoring task. The name can be up to 255 characters in length and can contain digits, letters, and punctuation marks.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '质量校验任务', 'backendName' => 'name'], + 'Description' => ['title' => '数据质量校验任务描述，最长65535个字符', 'description' => 'The description of the task. The description can be up to 65,535 characters in length.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'This is a daily run data quality evaluation plan.', 'backendName' => 'description'], + 'TenantId' => ['title' => 'DataWorks租户ID', 'description' => 'The DataWorks tenant ID.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'backendName' => 'tenantId'], + 'ProjectId' => ['title' => 'Dataworks项目空间ID', 'description' => 'The DataWorks workspace ID.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'backendName' => 'projectId'], 'Target' => [ - 'title' => '', + 'title' => '数据质量校验任务的监控对象', 'description' => 'The monitored object of the task.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'title' => '', - 'description' => 'The type of the monitored object. Valid values:'."\n" - ."\n" - .'* Table'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Table', - 'backendName' => 'type', - ], - 'DatabaseType' => [ - 'title' => '', - 'description' => 'The type of the database to which the table belongs. Valid values:'."\n" - ."\n" - .'* maxcompute'."\n" - .'* emr'."\n" - .'* cdh'."\n" - .'* hologres'."\n" - .'* analyticdb_for_postgresql'."\n" - .'* analyticdb_for_mysql'."\n" - .'* starrocks'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'maxcompute', - 'backendName' => 'databaseType', - ], - 'TableGuid' => [ - 'title' => '', - 'description' => 'The ID of the table in Data Map.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'odps.unit_test.tb_unit_test', - 'backendName' => 'tableGuid', - ], - 'PartitionSpec' => [ - 'title' => '', - 'description' => 'The configuration of the partitioned table.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'ds=$[yyyymmdd-1]', - 'backendName' => 'partitionSpec', - ], + 'Type' => ['title' => '监控对象类型', 'description' => 'The type of the monitored object. Valid values:'."\n" + ."\n" + .'* Table'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'Table', 'backendName' => 'type'], + 'DatabaseType' => ['title' => '表类型的数据集，表所属的数据库类型', 'description' => 'The type of the database to which the table belongs. Valid values:'."\n" + ."\n" + .'* maxcompute'."\n" + .'* emr'."\n" + .'* cdh'."\n" + .'* hologres'."\n" + .'* analyticdb_for_postgresql'."\n" + .'* analyticdb_for_mysql'."\n" + .'* starrocks'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'maxcompute', 'backendName' => 'databaseType'], + 'TableGuid' => ['title' => '表在数据地图中的唯一ID', 'description' => 'The ID of the table in Data Map.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'odps.unit_test.tb_unit_test', 'backendName' => 'tableGuid'], + 'PartitionSpec' => ['title' => '分区表的分区设置', 'description' => 'The configuration of the partitioned table.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'ds=$[yyyymmdd-1]', 'backendName' => 'partitionSpec'], ], 'backendName' => 'target', ], 'Trigger' => [ - 'title' => '', + 'title' => '数据质量校验任务的触发配置', 'description' => 'The trigger configuration of the task.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'title' => '', - 'description' => 'The trigger condition of the task. Valid values:'."\n" - ."\n" - .'* ByScheduledTaskInstance. The value indicates that the task is triggered when the instance of an auto triggered node is successfully run.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'ByScheduledTaskInstance', - 'backendName' => 'type', - ], + 'Type' => ['title' => '何种事件可以触发质量校验任务执行', 'description' => 'The trigger condition of the task. Valid values:'."\n" + ."\n" + .'* ByScheduledTaskInstance. The value indicates that the task is triggered when the instance of an auto triggered node is successfully run.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'ByScheduledTaskInstance', 'backendName' => 'type'], 'TaskIds' => [ - 'title' => '', + 'title' => 'type=ByScheduledTaskInstance时生效 ,具体指明哪些调度节点的实例执行成功后可以触发', 'description' => 'The IDs of the auto triggered nodes of which the instances are successfully run. This parameter takes effect only if the Type parameter is set to ByScheduledTaskInstance.'."\n", 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the auto triggered node.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10001', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The ID of the auto triggered node.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '10001', 'extendType' => 'true'], 'backendName' => 'taskIds', ], ], 'backendName' => 'trigger', ], - 'DataSourceId' => [ - 'title' => '', - 'description' => 'The ID of the data source that is used for task running.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '201', - 'backendName' => 'dataSourceId', - ], - 'RuntimeConf' => [ - 'title' => '', - 'description' => 'The configuration of the data source. The value of the queue field is default, and that of the sqlEngine field can be set to SPARK_SQL, KYUUBI, PRESTO_SQL, or HIVE_SQL. The value default indicates the YARN queue for E-MapReduce (EMR) tasks.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{ "queue": "default", "sqlEngine": "SPARK_SQL" }', - 'backendName' => 'runtimeConf', - ], + 'DataSourceId' => ['title' => '数据质量校验任务执行时应使用的数据源', 'description' => 'The ID of the data source that is used for task running.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '201', 'backendName' => 'dataSourceId'], + 'RuntimeConf' => ['title' => '使用数据源时的一些设置，目前只支持指定EMR的yarn队列、采集EMR表时把SQL引擎指定为SPARK_SQL|KYUUBI|PRESTO_SQL|HIVE_SQL', 'description' => 'The configuration of the data source. The value of the queue field is default, and that of the sqlEngine field can be set to SPARK_SQL, KYUUBI, PRESTO_SQL, or HIVE_SQL. The value default indicates the YARN queue for E-MapReduce (EMR) tasks.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '{ "queue": "default", "sqlEngine": "SPARK_SQL" }', 'backendName' => 'runtimeConf'], 'Hooks' => [ - 'title' => '', + 'title' => '数据质量校验任务实例生命周期中的回调设置，目前只支持一个阻塞调度任务的Hook', 'description' => 'The callback configurations of the task during the instance lifecycle. Blocking an auto triggered node is a type of callback event. Only this type is supported.'."\n", 'visibility' => 'Public', 'type' => 'array', @@ -1240,24 +690,10 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'title' => '', - 'description' => 'The type of the callback event. Valid values:'."\n" - ."\n" - .'* BlockTaskInstance. The value indicates that an auto triggered node is blocked.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'BlockTaskInstance', - 'backendName' => 'type', - ], - 'Condition' => [ - 'title' => '', - 'description' => 'The trigger configuration of the callback event.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '${severity} == "High" AND ${status} == "Critical"', - 'backendName' => 'condition', - ], + 'Type' => ['title' => '后续处理动作类型，如BLOCK_TASK_INSTANCE：阻塞DataWorks任务实例执行', 'description' => 'The type of the callback event. Valid values:'."\n" + ."\n" + .'* BlockTaskInstance. The value indicates that an auto triggered node is blocked.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'BlockTaskInstance', 'backendName' => 'type'], + 'Condition' => ['title' => 'Hook触发条件', 'description' => 'The trigger configuration of the callback event.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '${severity} == "High" AND ${status} == "Critical"', 'backendName' => 'condition'], ], 'extendType' => 'true', 'description' => '', @@ -1265,7 +701,7 @@ 'backendName' => 'hooks', ], 'Notifications' => [ - 'title' => '', + 'title' => '数据质量校验任务通知订阅配置', 'description' => 'The configurations for alert notifications.'."\n", 'visibility' => 'Public', 'type' => 'array', @@ -1273,16 +709,9 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Condition' => [ - 'title' => '', - 'description' => 'The trigger condition of the alert notification.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '${blockType} == "Strong"', - 'backendName' => 'condition', - ], + 'Condition' => ['title' => '告警触发条件', 'description' => 'The trigger condition of the alert notification.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '${blockType} == "Strong"', 'backendName' => 'condition'], 'Notifications' => [ - 'title' => '', + 'title' => '具体的消息通知设置', 'description' => 'The configurations for alert notifications.'."\n", 'visibility' => 'Public', 'type' => 'array', @@ -1292,7 +721,7 @@ 'type' => 'object', 'properties' => [ 'NotificationChannels' => [ - 'title' => '', + 'title' => '告警方式', 'description' => 'The alert notification methods.'."\n", 'visibility' => 'Public', 'type' => 'array', @@ -1301,23 +730,17 @@ 'type' => 'object', 'properties' => [ 'Channels' => [ - 'title' => '', + 'title' => '告警方式', 'description' => 'The alert notification method.'."\n", 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '* Mail'."\n" - .'* Sms'."\n" - .'* Phone'."\n" - .'* Feishu'."\n" - .'* Weixin: WeCom notification'."\n" - .'* Dingding'."\n" - .'* Webhook'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Mail', - 'extendType' => 'true', - ], + 'items' => ['description' => '* Mail'."\n" + .'* Sms'."\n" + .'* Phone'."\n" + .'* Feishu'."\n" + .'* Weixin: WeCom notification'."\n" + .'* Dingding'."\n" + .'* Webhook'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'Mail', 'extendType' => 'true'], 'example' => 'Mail', 'backendName' => 'channels', ], @@ -1328,7 +751,7 @@ 'backendName' => 'notificationChannels', ], 'NotificationReceivers' => [ - 'title' => '', + 'title' => '告警接收人设置', 'description' => 'The alert recipients.'."\n", 'visibility' => 'Public', 'type' => 'array', @@ -1336,36 +759,16 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'ReceiverType' => [ - 'title' => '', - 'description' => 'The type of the alert recipient.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'AliUid', - 'backendName' => 'receiverType', - ], + 'ReceiverType' => ['title' => '告警接收人类型', 'description' => 'The type of the alert recipient.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'AliUid', 'backendName' => 'receiverType'], 'ReceiverValues' => [ - 'title' => '', + 'title' => '告警接收人具体值', 'description' => 'The alert recipients.'."\n", 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'The alert recipient.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'user1', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The alert recipient.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'user1', 'extendType' => 'true'], 'backendName' => 'receiverValues', ], - 'Extension' => [ - 'title' => '', - 'description' => 'The extended information in the JSON format. For example, the DingTalk chatbot can remind all members in a DingTalk group by using the at sign (@).'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{"atAll":"true"}', - 'backendName' => 'extension', - ], + 'Extension' => ['title' => '扩展信息，格式为 json，例如钉钉机器人支持 at 所有人', 'description' => 'The extended information in the JSON format. For example, the DingTalk chatbot can remind all members in a DingTalk group by using the at sign (@).'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '{"atAll":"true"}', 'backendName' => 'extension'], ], 'extendType' => 'true', 'description' => '', @@ -1391,186 +794,67 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '', - 'description' => 'The instance ID.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10001', - 'backendName' => 'id', - ], - 'CreateTime' => [ - 'title' => '', - 'description' => 'The time at which the instance was generated.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - 'backendName' => 'createTime', - ], - 'FinishTime' => [ - 'title' => '', - 'description' => 'The time at which the instance finished running.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - 'backendName' => 'finishTime', - ], - 'Status' => [ - 'title' => '', - 'description' => 'The status of the instance.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Passed', - 'backendName' => 'status', - ], + 'Id' => ['title' => '任务实例ID', 'description' => 'The instance ID.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '10001', 'backendName' => 'id'], + 'CreateTime' => ['title' => '任务实例创建时间', 'description' => 'The time at which the instance was generated.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'backendName' => 'createTime'], + 'FinishTime' => ['title' => '任务实例结束时间', 'description' => 'The time at which the instance finished running.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'backendName' => 'finishTime'], + 'Status' => ['title' => '当前运行状态', 'description' => 'The status of the instance.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'Passed', 'backendName' => 'status'], 'Task' => [ - 'title' => '', + 'title' => '校验开始时，数据质量校验任务的快照', 'description' => 'The snapshot of the configurations for the data quality monitoring task when the task starts.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '', - 'description' => 'The ID of the data quality monitoring task.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10001', - 'backendName' => 'id', - ], - 'Name' => [ - 'title' => '', - 'description' => 'The name of the data quality monitoring task. The name can be up to 255 characters in length and can contain digits, letters, and punctuation marks.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'name', - ], - 'TenantId' => [ - 'title' => '', - 'description' => 'The DataWorks tenant ID.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '195820716552192', - 'backendName' => 'tenantId', - ], - 'ProjectId' => [ - 'title' => '', - 'description' => 'The DataWorks workspace ID.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2626', - 'backendName' => 'projectId', - ], + 'Id' => ['title' => '数据质量校验任务ID', 'description' => 'The ID of the data quality monitoring task.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '10001', 'backendName' => 'id'], + 'Name' => ['title' => '数据质量校验任务名称，数字、英文字母、汉字、半角全角标点符号组合，最长255个字符', 'description' => 'The name of the data quality monitoring task. The name can be up to 255 characters in length and can contain digits, letters, and punctuation marks.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '质量校验任务', 'backendName' => 'name'], + 'TenantId' => ['title' => 'DataWorks租户ID', 'description' => 'The DataWorks tenant ID.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '195820716552192', 'backendName' => 'tenantId'], + 'ProjectId' => ['title' => 'DataWorks项目空间ID', 'description' => 'The DataWorks workspace ID.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '2626', 'backendName' => 'projectId'], 'Target' => [ - 'title' => '', + 'title' => '数据质量校验任务的监控对象', 'description' => 'The monitored object of the data quality monitoring task.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'title' => '', - 'description' => 'The type of the monitored object. Valid values:'."\n" - ."\n" - .'* Table'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Table', - 'backendName' => 'type', - ], - 'DatabaseType' => [ - 'title' => '', - 'description' => 'The type of the database to which the table belongs. Valid values:'."\n" - ."\n" - .'* maxcompute'."\n" - .'* emr'."\n" - .'* cdh'."\n" - .'* hologres'."\n" - .'* analyticdb_for_postgresql'."\n" - .'* analyticdb_for_mysql'."\n" - .'* starrocks'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'maxcompute', - 'backendName' => 'databaseType', - ], - 'TableGuid' => [ - 'title' => '', - 'description' => 'The ID of the table in Data Map.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'odps.unit_test.tb_unit_test', - 'backendName' => 'tableGuid', - ], - 'PartitionSpec' => [ - 'title' => '', - 'description' => 'The configuration of the partitioned table.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'ds=$[yyyymmdd-1]', - 'backendName' => 'partitionSpec', - ], + 'Type' => ['title' => '监控对象类型', 'description' => 'The type of the monitored object. Valid values:'."\n" + ."\n" + .'* Table'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'Table', 'backendName' => 'type'], + 'DatabaseType' => ['title' => '表类型的数据集，表所属的数据库类型', 'description' => 'The type of the database to which the table belongs. Valid values:'."\n" + ."\n" + .'* maxcompute'."\n" + .'* emr'."\n" + .'* cdh'."\n" + .'* hologres'."\n" + .'* analyticdb_for_postgresql'."\n" + .'* analyticdb_for_mysql'."\n" + .'* starrocks'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'maxcompute', 'backendName' => 'databaseType'], + 'TableGuid' => ['title' => '表在数据地图中的唯一ID', 'description' => 'The ID of the table in Data Map.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'odps.unit_test.tb_unit_test', 'backendName' => 'tableGuid'], + 'PartitionSpec' => ['title' => '分区表的分区设置', 'description' => 'The configuration of the partitioned table.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'ds=$[yyyymmdd-1]', 'backendName' => 'partitionSpec'], ], 'backendName' => 'target', ], 'Trigger' => [ - 'title' => '', + 'title' => '数据质量校验任务的触发配置', 'description' => 'The trigger configuration of the data quality monitoring task.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'title' => '', - 'description' => 'The trigger condition of the task. Valid values:'."\n" - ."\n" - .'* ByScheduledTaskInstance: The task is triggered when the instance of an auto triggered node is successfully run.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'ByScheduledTaskInstance', - 'backendName' => 'type', - ], + 'Type' => ['title' => '何种事件可以触发质量校验任务执行', 'description' => 'The trigger condition of the task. Valid values:'."\n" + ."\n" + .'* ByScheduledTaskInstance: The task is triggered when the instance of an auto triggered node is successfully run.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'ByScheduledTaskInstance', 'backendName' => 'type'], 'TaskIds' => [ - 'title' => '', + 'title' => 'type=ByScheduledTaskInstance时生效 ,具体指明哪些调度节点的实例执行成功后可以触发', 'description' => 'The IDs of the auto triggered nodes of which the instances are successfully run. This parameter takes effect only if the Type parameter is set to ByScheduledTaskInstance.'."\n", 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the auto triggered node.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10001', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The ID of the auto triggered node.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '10001', 'extendType' => 'true'], 'backendName' => 'taskIds', ], ], 'backendName' => 'trigger', ], - 'DataSourceId' => [ - 'title' => '', - 'description' => 'The ID of the data source that is used for task running.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '201', - 'backendName' => 'dataSourceId', - ], - 'RuntimeConf' => [ - 'title' => '', - 'description' => 'The configuration of the data source. The value of the queue field is default, and that of the sqlEngine field can be SPARK_SQL, KYUUBI, PRESTO_SQL, or HIVE_SQL to collect EMR data. The value default indicates the YARN queue for E-MapReduce (EMR) tasks.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{ "queue": "default", "sqlEngine": "SPARK_SQL" }', - 'backendName' => 'runtimeConf', - ], + 'DataSourceId' => ['title' => '数据质量校验任务执行时应使用的数据源', 'description' => 'The ID of the data source that is used for task running.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '201', 'backendName' => 'dataSourceId'], + 'RuntimeConf' => ['title' => '使用数据源时的一些设置，目前只支持指定EMR的yarn队列、采集EMR表时把SQL引擎指定为SPARK_SQL|KYUUBI|PRESTO_SQL|HIVE_SQL', 'description' => 'The configuration of the data source. The value of the queue field is default, and that of the sqlEngine field can be SPARK_SQL, KYUUBI, PRESTO_SQL, or HIVE_SQL to collect EMR data. The value default indicates the YARN queue for E-MapReduce (EMR) tasks.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '{ "queue": "default", "sqlEngine": "SPARK_SQL" }', 'backendName' => 'runtimeConf'], 'Hooks' => [ - 'title' => '', + 'title' => '数据质量校验任务实例生命周期中的回调设置，目前只支持一个阻塞调度任务的Hook', 'description' => 'The callback configurations of the task during the instance lifecycle. Blocking an auto triggered node is a type of callback event. Only this type is supported.'."\n", 'visibility' => 'Public', 'type' => 'array', @@ -1579,31 +863,17 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'title' => '', - 'description' => 'The type of the callback event. Valid values:'."\n" - ."\n" - .'* BlockTaskInstance: An auto triggered node is blocked.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'BlockTaskInstance', - 'backendName' => 'type', - ], - 'Condition' => [ - 'title' => '', - 'description' => 'The trigger configuration of the callback event.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '${severity} == "High" AND ${status} == "Critical"', - 'backendName' => 'condition', - ], + 'Type' => ['title' => '后续处理动作类型', 'description' => 'The type of the callback event. Valid values:'."\n" + ."\n" + .'* BlockTaskInstance: An auto triggered node is blocked.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'BlockTaskInstance', 'backendName' => 'type'], + 'Condition' => ['title' => 'Hook触发条件', 'description' => 'The trigger configuration of the callback event.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '${severity} == "High" AND ${status} == "Critical"', 'backendName' => 'condition'], ], 'extendType' => 'true', ], 'backendName' => 'hooks', ], 'Notifications' => [ - 'title' => '', + 'title' => '数据质量校验任务告警订阅配置', 'description' => 'The subscription configurations for alert notifications.'."\n", 'visibility' => 'Public', 'type' => 'array', @@ -1612,16 +882,9 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Condition' => [ - 'title' => '', - 'description' => 'The trigger condition of the alert notification.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '${blockType} == "Strong"', - 'backendName' => 'condition', - ], + 'Condition' => ['title' => '告警触发条件', 'description' => 'The trigger condition of the alert notification.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '${blockType} == "Strong"', 'backendName' => 'condition'], 'Notifications' => [ - 'title' => '', + 'title' => '具体的消息通知设置', 'description' => 'The configurations for the alert notification.'."\n", 'visibility' => 'Public', 'type' => 'array', @@ -1630,7 +893,7 @@ 'type' => 'object', 'properties' => [ 'NotificationChannels' => [ - 'title' => '', + 'title' => '告警方式', 'description' => 'The alert notification methods.'."\n", 'visibility' => 'Public', 'type' => 'array', @@ -1639,23 +902,17 @@ 'type' => 'object', 'properties' => [ 'Channels' => [ - 'title' => '', + 'title' => '告警方式', 'description' => 'The alert notification methods.'."\n", 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => '* Mail'."\n" - .'* Sms'."\n" - .'* Phone'."\n" - .'* Feishu'."\n" - .'* Weixin'."\n" - .'* Dingding'."\n" - .'* Webhook'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Mail', - 'extendType' => 'true', - ], + 'items' => ['description' => '* Mail'."\n" + .'* Sms'."\n" + .'* Phone'."\n" + .'* Feishu'."\n" + .'* Weixin'."\n" + .'* Dingding'."\n" + .'* Webhook'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'Mail', 'extendType' => 'true'], 'example' => 'Mail', 'backendName' => 'channels', ], @@ -1667,7 +924,7 @@ 'backendName' => 'notificationChannels', ], 'NotificationReceivers' => [ - 'title' => '', + 'title' => '告警接收人配置', 'description' => 'The alert recipient configurations.'."\n", 'visibility' => 'Public', 'type' => 'array', @@ -1675,36 +932,16 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'ReceiverType' => [ - 'title' => '', - 'description' => 'The alert recipient configuration.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'AliUid', - 'backendName' => 'receiverType', - ], + 'ReceiverType' => ['title' => '告警接收人配置', 'description' => 'The alert recipient configuration.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'AliUid', 'backendName' => 'receiverType'], 'ReceiverValues' => [ - 'title' => '', + 'title' => '告警接收人具体值', 'description' => 'The alert recipients.'."\n", 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'The alert recipient.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'user1', - 'extendType' => 'true', - ], + 'items' => ['description' => 'The alert recipient.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'user1', 'extendType' => 'true'], 'backendName' => 'receiverValues', ], - 'Extension' => [ - 'title' => '', - 'description' => 'The extended information in the JSON format. For example, the DingTalk chatbot can remind all members in a DingTalk group by using the at sign (@).'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{"atAll":"true"}', - 'backendName' => 'extension', - ], + 'Extension' => ['title' => '扩展信息，格式为 json，例如钉钉机器人支持 at 所有人', 'description' => 'The extended information in the JSON format. For example, the DingTalk chatbot can remind all members in a DingTalk group by using the at sign (@).'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '{"atAll":"true"}', 'backendName' => 'extension'], ], 'extendType' => 'true', 'description' => '', @@ -1733,341 +970,147 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '', - 'description' => 'The ID of the check result.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10001', - 'backendName' => 'id', - ], - 'Status' => [ - 'title' => '', - 'description' => 'The status of the check result.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Passed', - 'backendName' => 'status', - ], - 'TaskInstanceId' => [ - 'title' => '', - 'description' => 'The ID of the instance generated by the check.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20001', - 'backendName' => 'taskInstanceId', - ], + 'Id' => ['title' => '校验结果ID', 'description' => 'The ID of the check result.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '10001', 'backendName' => 'id'], + 'Status' => ['title' => '校验结果状态', 'description' => 'The status of the check result.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'Passed', 'backendName' => 'status'], + 'TaskInstanceId' => ['title' => '质量校验任务实例ID', 'description' => 'The ID of the instance generated by the check.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '20001', 'backendName' => 'taskInstanceId'], 'Rule' => [ - 'title' => '', + 'title' => '校验开始时，规则配置快照', 'description' => 'The snapshot of the rule configuration when the check starts.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '', - 'description' => 'The rule ID.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100001', - 'backendName' => 'id', - ], - 'Name' => [ - 'title' => '', - 'description' => 'The name of the rule. The name can be up to 255 characters in length and can contain digits, letters, and punctuation marks.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'name', - ], - 'TenantId' => [ - 'title' => '', - 'description' => 'The DataWorks tenant ID.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - 'backendName' => 'tenantId', - ], - 'ProjectId' => [ - 'title' => '', - 'description' => 'The DataWorks workspace ID.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - 'backendName' => 'projectId', - ], - 'Enabled' => [ - 'title' => '', - 'description' => 'Indicates whether the rule is enabled.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'enabled', - ], - 'Severity' => [ - 'title' => '', - 'description' => 'The strength of the rule.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'High', - 'backendName' => 'severity', - ], - 'Description' => [ - 'title' => '', - 'description' => 'The description of the rule. The description can be up to 500 characters in length.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'this is a odps _sql task', - 'backendName' => 'description', - ], + 'Id' => ['title' => '规则ID，全局唯一标识', 'description' => 'The rule ID.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '100001', 'backendName' => 'id'], + 'Name' => ['title' => '规则名称，数字、英文字母、汉字、半角全角标点符号组合，最长255个字符', 'description' => 'The name of the rule. The name can be up to 255 characters in length and can contain digits, letters, and punctuation marks.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '表不能为空', 'backendName' => 'name'], + 'TenantId' => ['title' => 'DataWorks租户ID', 'description' => 'The DataWorks tenant ID.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'backendName' => 'tenantId'], + 'ProjectId' => ['title' => 'DataWorks项目空间ID', 'description' => 'The DataWorks workspace ID.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'backendName' => 'projectId'], + 'Enabled' => ['title' => '规则是否启用', 'description' => 'Indicates whether the rule is enabled.'."\n", 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true', 'backendName' => 'enabled'], + 'Severity' => ['title' => '规则对于业务的等级（对应页面上的强弱规则）', 'description' => 'The strength of the rule.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'High', 'backendName' => 'severity'], + 'Description' => ['title' => '规则描述信息，最长500个字符', 'description' => 'The description of the rule. The description can be up to 500 characters in length.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'this is a odps _sql task', 'backendName' => 'description'], 'Target' => [ - 'title' => '', + 'title' => '规则所监控的对象', 'description' => 'The monitored object of the rule.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'title' => '', - 'description' => 'The type of the monitored object. Valid values:'."\n" - ."\n" - .'* Table'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Table', - 'backendName' => 'type', - ], - 'DatabaseType' => [ - 'title' => '', - 'description' => 'The type of the database to which the table belongs. Valid values:'."\n" - ."\n" - .'* maxcompute'."\n" - .'* emr'."\n" - .'* cdh'."\n" - .'* hologres'."\n" - .'* analyticdb_for_postgresql'."\n" - .'* analyticdb_for_mysql'."\n" - .'* starrocks'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'maxcompute', - 'backendName' => 'databaseType', - ], - 'TableGuid' => [ - 'title' => '', - 'description' => 'The ID of the table in Data Map.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'odps.unit_test.tb_unit_test', - 'backendName' => 'tableGuid', - ], - 'PartitionSpec' => [ - 'title' => '', - 'description' => 'The configuration of the partitioned table.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'ds=$[yyyymmdd-1]', - 'backendName' => 'partitionSpec', - ], + 'Type' => ['title' => '监控对象类型', 'description' => 'The type of the monitored object. Valid values:'."\n" + ."\n" + .'* Table'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'Table', 'backendName' => 'type'], + 'DatabaseType' => ['title' => '表类型的数据集，表所属的数据库类型', 'description' => 'The type of the database to which the table belongs. Valid values:'."\n" + ."\n" + .'* maxcompute'."\n" + .'* emr'."\n" + .'* cdh'."\n" + .'* hologres'."\n" + .'* analyticdb_for_postgresql'."\n" + .'* analyticdb_for_mysql'."\n" + .'* starrocks'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'maxcompute', 'backendName' => 'databaseType'], + 'TableGuid' => ['title' => '表在数据地图中的唯一ID', 'description' => 'The ID of the table in Data Map.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'odps.unit_test.tb_unit_test', 'backendName' => 'tableGuid'], + 'PartitionSpec' => ['title' => '分区表的分区设置', 'description' => 'The configuration of the partitioned table.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'ds=$[yyyymmdd-1]', 'backendName' => 'partitionSpec'], ], 'backendName' => 'target', ], - 'TemplateCode' => [ - 'title' => '', - 'description' => 'The template used by the rule.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'system::user_defined', - 'backendName' => 'templateCode', - ], + 'TemplateCode' => ['title' => 'system::user创建规则时所引用的规则模板', 'description' => 'The template used by the rule.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'system::user_defined', 'backendName' => 'templateCode'], 'SamplingConfig' => [ - 'title' => '', + 'title' => '样本采集所需的设置', 'description' => 'The sampling settings.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Metric' => [ - 'title' => '', - 'description' => 'The metrics used for sampling. Valid values:'."\n" - ."\n" - .'* Count: the number of rows in the table.'."\n" - .'* Min: the minimum value of the field.'."\n" - .'* Max: the maximum value of the field.'."\n" - .'* Avg: the average value of the field.'."\n" - .'* DistinctCount: the number of unique values of the field after deduplication.'."\n" - .'* DistinctPercent: the proportion of the number of unique values of the field after deduplication to the number of rows in the table.'."\n" - .'* DuplicatedCount: the number of duplicated values of the field.'."\n" - .'* DuplicatedPercent: the proportion of the number of duplicated values of the field to the number of rows in the table.'."\n" - .'* TableSize: the table size.'."\n" - .'* NullValueCount: the number of rows in which the field value is null.'."\n" - .'* NullValuePercent: the proportion of the number of rows in which the field value is null to the number of rows in the table.'."\n" - .'* GroupCount: the field value and the number of rows for each field value.'."\n" - .'* CountNotIn: the number of rows in which the field values are different from the referenced values that you specified in the rule.'."\n" - .'* CountDistinctNotIn: the number of unique values that are different from the referenced values that you specified in the rule after deduplication.'."\n" - .'* UserDefinedSql: indicates that data is sampled by executing custom SQL statements.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Min', - 'backendName' => 'metric', - ], - 'MetricParameters' => [ - 'title' => '', - 'description' => 'The parameters required for sampling.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{ "Columns": [ "id", "name" ] }', - 'backendName' => 'metricParameters', - ], - 'SettingConfig' => [ - 'title' => '', - 'description' => 'The statements that are used to configure the parameters required for sampling before you execute the sampling statements. The statements can be up to 1,000 characters in length. Only the MaxCompute database is supported.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'SET odps.sql.udf.timeout=600s;', - 'backendName' => 'settingConfig', - ], - 'SamplingFilter' => [ - 'title' => '', - 'description' => 'The statements that are used to filter unnecessary data during sampling. The statements can be up to 16,777,215 characters in length.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'id IS NULL', - 'backendName' => 'samplingFilter', - ], + 'Metric' => ['title' => '采样的指标名称', 'description' => 'The metrics used for sampling. Valid values:'."\n" + ."\n" + .'* Count: the number of rows in the table.'."\n" + .'* Min: the minimum value of the field.'."\n" + .'* Max: the maximum value of the field.'."\n" + .'* Avg: the average value of the field.'."\n" + .'* DistinctCount: the number of unique values of the field after deduplication.'."\n" + .'* DistinctPercent: the proportion of the number of unique values of the field after deduplication to the number of rows in the table.'."\n" + .'* DuplicatedCount: the number of duplicated values of the field.'."\n" + .'* DuplicatedPercent: the proportion of the number of duplicated values of the field to the number of rows in the table.'."\n" + .'* TableSize: the table size.'."\n" + .'* NullValueCount: the number of rows in which the field value is null.'."\n" + .'* NullValuePercent: the proportion of the number of rows in which the field value is null to the number of rows in the table.'."\n" + .'* GroupCount: the field value and the number of rows for each field value.'."\n" + .'* CountNotIn: the number of rows in which the field values are different from the referenced values that you specified in the rule.'."\n" + .'* CountDistinctNotIn: the number of unique values that are different from the referenced values that you specified in the rule after deduplication.'."\n" + .'* UserDefinedSql: indicates that data is sampled by executing custom SQL statements.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'Min', 'backendName' => 'metric'], + 'MetricParameters' => ['title' => '样本采集时，所需的参数', 'description' => 'The parameters required for sampling.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '{ "Columns": [ "id", "name" ] }', 'backendName' => 'metricParameters'], + 'SettingConfig' => ['title' => '具体执行采样语句前，插入执行的一些运行时参数设置语句，最长1000个字符。目前只支持MaxCompute', 'description' => 'The statements that are used to configure the parameters required for sampling before you execute the sampling statements. The statements can be up to 1,000 characters in length. Only the MaxCompute database is supported.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'SET odps.sql.udf.timeout=600s;', 'backendName' => 'settingConfig'], + 'SamplingFilter' => ['title' => '采样时，对不关注的数据进行二次过滤的条件，最多16777215个字符', 'description' => 'The statements that are used to filter unnecessary data during sampling. The statements can be up to 16,777,215 characters in length.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'id IS NULL', 'backendName' => 'samplingFilter'], ], 'backendName' => 'samplingConfig', ], 'CheckingConfig' => [ - 'title' => '', + 'title' => '样本校验设置', 'description' => 'The check settings for sample data.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'title' => '', - 'description' => 'The threshold calculation method. Valid values:'."\n" - ."\n" - .'* Fixed'."\n" - .'* Fluctation'."\n" - .'* FluctationDiscreate'."\n" - .'* Auto'."\n" - .'* Average'."\n" - .'* Variance'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Fixed', - 'backendName' => 'type', - ], - 'ReferencedSamplesFilter' => [ - 'title' => '', - 'description' => 'The method that is used to query the referenced samples. To obtain some types of thresholds, you need to query reference values. In this example, an expression is used to indicate the query method of referenced samples.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{ "bizdate": [ "-1", "-7", "-1m" ] }', - 'backendName' => 'referencedSamplesFilter', - ], + 'Type' => ['title' => '阈值计算方式', 'description' => 'The threshold calculation method. Valid values:'."\n" + ."\n" + .'* Fixed'."\n" + .'* Fluctation'."\n" + .'* FluctationDiscreate'."\n" + .'* Auto'."\n" + .'* Average'."\n" + .'* Variance'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'Fixed', 'backendName' => 'type'], + 'ReferencedSamplesFilter' => ['title' => '有些类型的阈值需要查询出一些参考样本，然后对参考样本的值进行汇总得出进行比较的阈值，这里使用一个表达式来表示参考样本的查询方式', 'description' => 'The method that is used to query the referenced samples. To obtain some types of thresholds, you need to query reference values. In this example, an expression is used to indicate the query method of referenced samples.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '{ "bizdate": [ "-1", "-7", "-1m" ] }', 'backendName' => 'referencedSamplesFilter'], 'Thresholds' => [ - 'title' => '', + 'title' => '阈值设置', 'description' => 'The threshold settings.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'Expected' => [ - 'title' => '', + 'title' => '期望的阈值设置', 'description' => 'The expected threshold setting.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Value' => [ - 'title' => '', - 'description' => 'The threshold value.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '100.0', - 'backendName' => 'value', - ], - 'Operator' => [ - 'title' => '', - 'description' => 'The comparison operator. Valid values:'."\n" - ."\n" - .'* \\>'."\n" - .'* \\>='."\n" - .'* <'."\n" - .'* <='."\n" - .'* !='."\n" - .'* \\='."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '>', - 'backendName' => 'operator', - ], + 'Value' => ['title' => '阈值数值', 'description' => 'The threshold value.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '100.0', 'backendName' => 'value'], + 'Operator' => ['title' => '比较符', 'description' => 'The comparison operator. Valid values:'."\n" + ."\n" + .'* \\>'."\n" + .'* \\>='."\n" + .'* <'."\n" + .'* <='."\n" + .'* !='."\n" + .'* \\='."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '>', 'backendName' => 'operator'], ], 'backendName' => 'expected', ], 'Warned' => [ - 'title' => '', + 'title' => '普通警告的阈值设置', 'description' => 'The threshold settings for normal alerts.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Value' => [ - 'title' => '', - 'description' => 'The threshold value.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '100.0', - 'backendName' => 'value', - ], - 'Operator' => [ - 'title' => '', - 'description' => 'The comparison operator. Valid values:'."\n" - ."\n" - .'* \\>'."\n" - .'* \\>='."\n" - .'* <'."\n" - .'* <='."\n" - .'* !='."\n" - .'* \\='."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '>', - 'backendName' => 'operator', - ], + 'Value' => ['title' => '阈值数值', 'description' => 'The threshold value.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '100.0', 'backendName' => 'value'], + 'Operator' => ['title' => '比较符', 'description' => 'The comparison operator. Valid values:'."\n" + ."\n" + .'* \\>'."\n" + .'* \\>='."\n" + .'* <'."\n" + .'* <='."\n" + .'* !='."\n" + .'* \\='."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '>', 'backendName' => 'operator'], ], 'backendName' => 'warned', ], 'Critical' => [ - 'title' => '', + 'title' => '严重警告的阈值设置', 'description' => 'The threshold settings for critical alerts.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Value' => [ - 'title' => '', - 'description' => 'The threshold value.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '100.0', - 'backendName' => 'value', - ], - 'Operator' => [ - 'title' => '', - 'description' => 'The comparison operator. Valid values:'."\n" - ."\n" - .'* \\>'."\n" - .'* \\>='."\n" - .'* <'."\n" - .'* <='."\n" - .'* !='."\n" - .'* \\='."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '>', - 'backendName' => 'operator', - ], + 'Value' => ['title' => '阈值数值', 'description' => 'The threshold value.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '100.0', 'backendName' => 'value'], + 'Operator' => ['title' => '比较符', 'description' => 'The comparison operator. Valid values:'."\n" + ."\n" + .'* \\>'."\n" + .'* \\>='."\n" + .'* <'."\n" + .'* <='."\n" + .'* !='."\n" + .'* \\='."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '>', 'backendName' => 'operator'], ], 'backendName' => 'critical', ], @@ -2078,7 +1121,7 @@ 'backendName' => 'checkingConfig', ], 'ErrorHandlers' => [ - 'title' => '', + 'title' => '质量规则校验问题处理器', 'description' => 'The operations that you can perform after the rule-based check fails.'."\n", 'visibility' => 'Public', 'type' => 'array', @@ -2087,22 +1130,8 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'title' => '', - 'description' => 'The type of the operation.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'SaveErrorData', - 'backendName' => 'type', - ], - 'ErrorDataFilter' => [ - 'title' => '', - 'description' => 'The SQL statement that is used to filter failed tasks. If the rule is defined by custom SQL statements, you must specify an SQL statement to filter failed tasks.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'SELECT * FROM tb_api_log WHERE id IS NULL', - 'backendName' => 'errorDataFilter', - ], + 'Type' => ['title' => '处理器类型', 'description' => 'The type of the operation.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'SaveErrorData', 'backendName' => 'type'], + 'ErrorDataFilter' => ['title' => '如果是自定义SQL规则，需要用户指定SQL来过滤问题数据', 'description' => 'The SQL statement that is used to filter failed tasks. If the rule is defined by custom SQL statements, you must specify an SQL statement to filter failed tasks.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'SELECT * FROM tb_api_log WHERE id IS NULL', 'backendName' => 'errorDataFilter'], ], 'extendType' => 'true', ], @@ -2111,16 +1140,9 @@ ], 'backendName' => 'rule', ], - 'Sample' => [ - 'title' => '', - 'description' => 'The sample values used for the check.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '[ { "gender": "male", "_count": 100 }, { "gender": "female", "_count": 100 } ]', - 'backendName' => 'sample', - ], + 'Sample' => ['title' => '本次校验所使用的样本值', 'description' => 'The sample values used for the check.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '[ { "gender": "male", "_count": 100 }, { "gender": "female", "_count": 100 } ]', 'backendName' => 'sample'], 'Details' => [ - 'title' => '', + 'title' => '本次校验的详情', 'description' => 'The information about the data quality check.'."\n", 'visibility' => 'Public', 'type' => 'array', @@ -2129,30 +1151,9 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'ReferencedValue' => [ - 'title' => '', - 'description' => 'The value that is calculated based on sample data. The value serves as a baseline value during the calculation of the value of the CheckedValue parameter.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '0.0', - 'backendName' => 'referencedValue', - ], - 'CheckedValue' => [ - 'title' => '', - 'description' => 'The value that is used for comparison with the threshold.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '100.0', - 'backendName' => 'checkedValue', - ], - 'Status' => [ - 'title' => '', - 'description' => 'The comparison result between the value specified by the CheckedValue parameter and the threshold.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Passed', - 'backendName' => 'status', - ], + 'ReferencedValue' => ['title' => '使用引用的样本，用来参与CheckedValue计算的基准值', 'description' => 'The value that is calculated based on sample data. The value serves as a baseline value during the calculation of the value of the CheckedValue parameter.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '0.0', 'backendName' => 'referencedValue'], + 'CheckedValue' => ['title' => '最终用来与阈值比较的值', 'description' => 'The value that is used for comparison with the threshold.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '100.0', 'backendName' => 'checkedValue'], + 'Status' => ['title' => '最终的比较结果状态', 'description' => 'The comparison result between the value specified by the CheckedValue parameter and the threshold.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'Passed', 'backendName' => 'status'], ], 'extendType' => 'true', ], @@ -2166,313 +1167,144 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '', - 'description' => 'The rule ID.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - 'backendName' => 'id', - ], - 'Name' => [ - 'title' => '', - 'description' => 'The rule name. The name can be up to 255 characters in length and can contain digits, letters, and punctuation marks.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'name', - ], - 'TenantId' => [ - 'title' => '', - 'description' => 'The DataWorks tenant ID.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - 'backendName' => 'tenantId', - ], - 'ProjectId' => [ - 'title' => '', - 'description' => 'The DataWorks workspace ID.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - 'backendName' => 'projectId', - ], - 'Enabled' => [ - 'title' => '', - 'description' => 'Indicates whether the rule is enabled.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'enabled', - ], - 'Severity' => [ - 'title' => '', - 'description' => 'The strength of the rule. Valid values:'."\n" - ."\n" - .'* Normal'."\n" - .'* High'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'High', - 'backendName' => 'severity', - ], - 'Description' => [ - 'title' => '', - 'description' => 'The description of the rule. The description can be up to 500 characters in length.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'this is a odps _sql task', - 'backendName' => 'description', - ], - 'TemplateCode' => [ - 'title' => '', - 'description' => 'The template used by the rule.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'system::user_defined', - 'backendName' => 'templateCode', - ], + 'Id' => ['title' => '规则ID', 'description' => 'The rule ID.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'backendName' => 'id'], + 'Name' => ['title' => '规则名称，数字、英文字母、汉字、半角全角标点符号组合，最长255个字符', 'description' => 'The rule name. The name can be up to 255 characters in length and can contain digits, letters, and punctuation marks.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '表不能为空', 'backendName' => 'name'], + 'TenantId' => ['title' => 'Dataworks租户ID', 'description' => 'The DataWorks tenant ID.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'backendName' => 'tenantId'], + 'ProjectId' => ['title' => 'Dataworks项目空间ID', 'description' => 'The DataWorks workspace ID.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'backendName' => 'projectId'], + 'Enabled' => ['title' => '规则是否启用', 'description' => 'Indicates whether the rule is enabled.'."\n", 'visibility' => 'Public', 'type' => 'boolean', 'example' => 'true', 'backendName' => 'enabled'], + 'Severity' => ['title' => '规则对于业务的等级（对应页面上的强弱规则）', 'description' => 'The strength of the rule. Valid values:'."\n" + ."\n" + .'* Normal'."\n" + .'* High'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'High', 'backendName' => 'severity'], + 'Description' => ['title' => '规则描述信息，最长500个字符', 'description' => 'The description of the rule. The description can be up to 500 characters in length.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'this is a odps _sql task', 'backendName' => 'description'], + 'TemplateCode' => ['title' => '创建规则时所引用的规则模板', 'description' => 'The template used by the rule.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'system::user_defined', 'backendName' => 'templateCode'], 'Target' => [ - 'title' => '', + 'title' => '规则所监控的对象', 'description' => 'The monitored object of the rule.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'title' => '', - 'description' => 'The type of the monitored object. Valid values:'."\n" - ."\n" - .'* Table'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Table', - 'backendName' => 'type', - ], - 'DatabaseType' => [ - 'title' => '', - 'description' => 'The type of the database to which the table belongs. Valid values:'."\n" - ."\n" - .'* maxcompute'."\n" - .'* emr'."\n" - .'* cdh'."\n" - .'* hologres'."\n" - .'* analyticdb_for_postgresql'."\n" - .'* analyticdb_for_mysql'."\n" - .'* starrocks'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'maxcompute', - 'backendName' => 'databaseType', - ], - 'TableGuid' => [ - 'title' => '', - 'description' => 'The ID of the table in Data Map.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'odps.unit_test.tb_unit_test', - 'backendName' => 'tableGuid', - ], - 'PartitionSpec' => [ - 'title' => '', - 'description' => 'The configuration of the partitioned table.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'ds=$[yyyymmdd-1]', - 'backendName' => 'partitionSpec', - ], + 'Type' => ['title' => '监控对象类型', 'description' => 'The type of the monitored object. Valid values:'."\n" + ."\n" + .'* Table'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'Table', 'backendName' => 'type'], + 'DatabaseType' => ['title' => '表类型的数据集，表所属的数据库类型', 'description' => 'The type of the database to which the table belongs. Valid values:'."\n" + ."\n" + .'* maxcompute'."\n" + .'* emr'."\n" + .'* cdh'."\n" + .'* hologres'."\n" + .'* analyticdb_for_postgresql'."\n" + .'* analyticdb_for_mysql'."\n" + .'* starrocks'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'maxcompute', 'backendName' => 'databaseType'], + 'TableGuid' => ['title' => '表在数据地图中的唯一ID', 'description' => 'The ID of the table in Data Map.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'odps.unit_test.tb_unit_test', 'backendName' => 'tableGuid'], + 'PartitionSpec' => ['title' => '分区表的分区设置', 'description' => 'The configuration of the partitioned table.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'ds=$[yyyymmdd-1]', 'backendName' => 'partitionSpec'], ], 'backendName' => 'target', ], 'SamplingConfig' => [ - 'title' => '', + 'title' => '样本采集所需的设置', 'description' => 'The settings for sampling.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Metric' => [ - 'title' => '', - 'description' => 'The metrics used for sampling. Valid values:'."\n" - ."\n" - .'* Count: the number of rows in the table.'."\n" - .'* Min: the minimum value of the field.'."\n" - .'* Max: the maximum value of the field.'."\n" - .'* Avg: the average value of the field.'."\n" - .'* DistinctCount: the number of unique values of the field after deduplication.'."\n" - .'* DistinctPercent: the percentage of the number of unique values of the field after deduplication to the number of rows in the table.'."\n" - .'* DuplicatedCount: the number of duplicated values in the field.'."\n" - .'* DuplicatedPercent: the percentage of the number of duplicated values of the field to the number of rows in the table.'."\n" - .'* TableSize: the table size.'."\n" - .'* NullValueCount: the number of rows in which the field is set to null.'."\n" - .'* NullValuePercent: the percentage of the number of rows in which the field is set to null to the number of rows in the table.'."\n" - .'* GroupCount: the field value and the number of rows for each field value.'."\n" - .'* CountNotIn: the number of rows in which the field values are different from the referenced values that you specified in the rule.'."\n" - .'* CountDistinctNotIn: the number of unique values that are different from the referenced values that you specified in the rule after deduplication.'."\n" - .'* UserDefinedSql: indicates that the data is sampled by executing custom SQL statements.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Min', - 'backendName' => 'metric', - ], - 'MetricParameters' => [ - 'title' => '', - 'description' => 'The parameters required for sampling.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{ "Columns": [ "id", "name" ] }', - 'backendName' => 'metricParameters', - ], - 'SettingConfig' => [ - 'title' => '', - 'description' => 'The statements that are used to configure the parameters required for sampling before you execute the sampling statements. The statements can be up to 1,000 characters in length. Only the MaxCompute database is supported.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'SET odps.sql.udf.timeout=600s;', - 'backendName' => 'settingConfig', - ], - 'SamplingFilter' => [ - 'title' => '', - 'description' => 'The statements that are used to filter unnecessary data during sampling. The statements can be up to 16,777,215 characters in length.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'id IS NULL', - 'backendName' => 'samplingFilter', - ], + 'Metric' => ['title' => '采样的指标名称', 'description' => 'The metrics used for sampling. Valid values:'."\n" + ."\n" + .'* Count: the number of rows in the table.'."\n" + .'* Min: the minimum value of the field.'."\n" + .'* Max: the maximum value of the field.'."\n" + .'* Avg: the average value of the field.'."\n" + .'* DistinctCount: the number of unique values of the field after deduplication.'."\n" + .'* DistinctPercent: the percentage of the number of unique values of the field after deduplication to the number of rows in the table.'."\n" + .'* DuplicatedCount: the number of duplicated values in the field.'."\n" + .'* DuplicatedPercent: the percentage of the number of duplicated values of the field to the number of rows in the table.'."\n" + .'* TableSize: the table size.'."\n" + .'* NullValueCount: the number of rows in which the field is set to null.'."\n" + .'* NullValuePercent: the percentage of the number of rows in which the field is set to null to the number of rows in the table.'."\n" + .'* GroupCount: the field value and the number of rows for each field value.'."\n" + .'* CountNotIn: the number of rows in which the field values are different from the referenced values that you specified in the rule.'."\n" + .'* CountDistinctNotIn: the number of unique values that are different from the referenced values that you specified in the rule after deduplication.'."\n" + .'* UserDefinedSql: indicates that the data is sampled by executing custom SQL statements.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'Min', 'backendName' => 'metric'], + 'MetricParameters' => ['title' => '样本采集时，所需的参数', 'description' => 'The parameters required for sampling.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '{ "Columns": [ "id", "name" ] }', 'backendName' => 'metricParameters'], + 'SettingConfig' => ['title' => '具体执行采样语句前，插入执行的一些运行时参数设置语句，最长1000个字符。目前只支持MaxCompute', 'description' => 'The statements that are used to configure the parameters required for sampling before you execute the sampling statements. The statements can be up to 1,000 characters in length. Only the MaxCompute database is supported.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'SET odps.sql.udf.timeout=600s;', 'backendName' => 'settingConfig'], + 'SamplingFilter' => ['title' => '采样时，对不关注的数据进行二次过滤的条件，最多16777215个字符', 'description' => 'The statements that are used to filter unnecessary data during sampling. The statements can be up to 16,777,215 characters in length.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'id IS NULL', 'backendName' => 'samplingFilter'], ], 'backendName' => 'samplingConfig', ], 'CheckingConfig' => [ - 'title' => '', + 'title' => '样本校验设置', 'description' => 'The check settings for sample data.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'title' => '', - 'description' => 'The threshold calculation method. Valid values:'."\n" - ."\n" - .'* Fixed'."\n" - .'* Fluctation'."\n" - .'* FluctationDiscreate'."\n" - .'* Auto'."\n" - .'* Average'."\n" - .'* Variance'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'Fixed', - 'backendName' => 'type', - ], - 'ReferencedSamplesFilter' => [ - 'title' => '', - 'description' => 'The method that is used to query the referenced samples. To obtain some types of thresholds, you need to query reference values. In this example, an expression is used to indicate the query method of referenced samples.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{ "bizdate": [ "-1", "-7", "-1m" ] }', - 'backendName' => 'referencedSamplesFilter', - ], + 'Type' => ['title' => '阈值计算方式', 'description' => 'The threshold calculation method. Valid values:'."\n" + ."\n" + .'* Fixed'."\n" + .'* Fluctation'."\n" + .'* FluctationDiscreate'."\n" + .'* Auto'."\n" + .'* Average'."\n" + .'* Variance'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'Fixed', 'backendName' => 'type'], + 'ReferencedSamplesFilter' => ['title' => '有些类型的阈值需要查询出一些参考样本，然后对参考样本的值进行汇总得出进行比较的阈值，这里使用一个表达式来表示参考样本的查询方式', 'description' => 'The method that is used to query the referenced samples. To obtain some types of thresholds, you need to query reference values. In this example, an expression is used to indicate the query method of referenced samples.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '{ "bizdate": [ "-1", "-7", "-1m" ] }', 'backendName' => 'referencedSamplesFilter'], 'Thresholds' => [ - 'title' => '', + 'title' => '阈值设置', 'description' => 'The threshold settings.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ 'Expected' => [ - 'title' => '', + 'title' => '期望的阈值设置', 'description' => 'The expected threshold setting.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Value' => [ - 'title' => '', - 'description' => 'The threshold value.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '100.0', - 'backendName' => 'value', - ], - 'Operator' => [ - 'title' => '', - 'description' => 'The comparison operator. Valid values:'."\n" - ."\n" - .'* />'."\n" - .'* />='."\n" - .'* <'."\n" - .'* <='."\n" - .'* !='."\n" - .'* \\='."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '>', - 'backendName' => 'operator', - ], + 'Value' => ['title' => '阈值数值', 'description' => 'The threshold value.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '100.0', 'backendName' => 'value'], + 'Operator' => ['title' => '比较符', 'description' => 'The comparison operator. Valid values:'."\n" + ."\n" + .'* />'."\n" + .'* />='."\n" + .'* <'."\n" + .'* <='."\n" + .'* !='."\n" + .'* \\='."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '>', 'backendName' => 'operator'], + 'Expression' => ['title' => '阈值表达式', 'description' => '阈值表达式', 'visibility' => 'Public', 'type' => 'string', 'example' => '波动率类型规则使用，通过表达式来表示波动阈值。如：波动上升大于0.01： $checkValue > 0.01 波动下降大于0.01：$checkValue < -0.01 波动率绝对值：abs($checkValue) > 0.01', 'backendName' => 'expression'], ], 'backendName' => 'expected', ], 'Warned' => [ - 'title' => '', + 'title' => '普通警告的阈值设置', 'description' => 'The threshold settings for normal alerts.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Value' => [ - 'title' => '', - 'description' => 'The threshold value.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '100.0', - 'backendName' => 'value', - ], - 'Operator' => [ - 'title' => '', - 'description' => 'The comparison operator. Valid values:'."\n" - ."\n" - .'* />'."\n" - .'* />='."\n" - .'* <'."\n" - .'* <='."\n" - .'* !='."\n" - .'* \\='."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '>', - 'backendName' => 'operator', - ], + 'Value' => ['title' => '阈值数值', 'description' => 'The threshold value.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '100.0', 'backendName' => 'value'], + 'Operator' => ['title' => '比较符', 'description' => 'The comparison operator. Valid values:'."\n" + ."\n" + .'* />'."\n" + .'* />='."\n" + .'* <'."\n" + .'* <='."\n" + .'* !='."\n" + .'* \\='."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '>', 'backendName' => 'operator'], + 'Expression' => ['title' => '阈值表达式', 'description' => '阈值表达式', 'visibility' => 'Public', 'type' => 'string', 'example' => '波动率类型规则使用，通过表达式来表示波动阈值。如：波动上升大于0.01： $checkValue > 0.01 波动下降大于0.01：$checkValue < -0.01 波动率绝对值：abs($checkValue) > 0.01', 'backendName' => 'expression'], ], 'backendName' => 'warned', ], 'Critical' => [ - 'title' => '', + 'title' => '严重警告的阈值设置', 'description' => 'The threshold settings for critical alerts.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Value' => [ - 'title' => '', - 'description' => 'The threshold value.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '100.0', - 'backendName' => 'value', - ], - 'Operator' => [ - 'title' => '', - 'description' => 'The comparison operator. Valid values:'."\n" - ."\n" - .'* />'."\n" - .'* />='."\n" - .'* <'."\n" - .'* <='."\n" - .'* !='."\n" - .'* \\='."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '>', - 'backendName' => 'operator', - ], + 'Value' => ['title' => '阈值数值', 'description' => 'The threshold value.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '100.0', 'backendName' => 'value'], + 'Operator' => ['title' => '比较符', 'description' => 'The comparison operator. Valid values:'."\n" + ."\n" + .'* />'."\n" + .'* />='."\n" + .'* <'."\n" + .'* <='."\n" + .'* !='."\n" + .'* \\='."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '>', 'backendName' => 'operator'], + 'Expression' => ['title' => '校验表达式', 'description' => '校验表达式', 'visibility' => 'Public', 'type' => 'string', 'example' => '波动率类型规则使用，通过表达式来表示波动阈值。如：波动上升大于0.01： $checkValue > 0.01 波动下降大于0.01：$checkValue < -0.01 波动率绝对值：abs($checkValue) > 0.01', 'backendName' => 'expression'], ], 'backendName' => 'critical', ], @@ -2483,7 +1315,7 @@ 'backendName' => 'checkingConfig', ], 'ErrorHandlers' => [ - 'title' => '', + 'title' => '质量规则校验问题处理器', 'description' => 'The operations that you can perform after the rule-based check fails.'."\n", 'visibility' => 'Public', 'type' => 'array', @@ -2491,24 +1323,10 @@ 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'title' => '', - 'description' => 'The type of the operation. Valid values:'."\n" - ."\n" - .'* SaveErrorData'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'SaveErrorData', - 'backendName' => 'type', - ], - 'ErrorDataFilter' => [ - 'title' => '', - 'description' => 'The SQL statement that is used to filter failed tasks. If the rule is defined by custom SQL statements, you must specify an SQL statement to filter failed tasks.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'SELECT * FROM tb_api_log WHERE id IS NULL', - 'backendName' => 'errorDataFilter', - ], + 'Type' => ['title' => '处理器类型', 'description' => 'The type of the operation. Valid values:'."\n" + ."\n" + .'* SaveErrorData'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'SaveErrorData', 'backendName' => 'type'], + 'ErrorDataFilter' => ['title' => '如果是自定义SQL规则，需要用户指定SQL来过滤问题数据', 'description' => 'The SQL statement that is used to filter failed tasks. If the rule is defined by custom SQL statements, you must specify an SQL statement to filter failed tasks.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'SELECT * FROM tb_api_log WHERE id IS NULL', 'backendName' => 'errorDataFilter'], ], 'extendType' => 'true', 'description' => '', @@ -2517,58 +1335,54 @@ ], ], ], - 'Dataset' => [ - 'title' => '', - 'description' => 'The dataset object.'."\n", - 'visibility' => 'Public', + 'DataQualityRuleTemplate' => [ + 'title' => '质量规则模版', + 'description' => '质量规则模版', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '', - 'description' => 'The dataset ID.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'dataworks-dataset:1gxxxqjx155usz3hrv', - 'backendName' => 'id', - ], - 'Name' => [ - 'title' => '', - 'description' => 'The dataset name. It must be a non-empty string and cannot exceed 128 characters.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test_dataset', - 'backendName' => 'name', - ], - 'Comment' => [ - 'title' => '', - 'description' => 'The description of the dataset. The length cannot exceed 1024 characters.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'comment', - ], - 'ProjectId' => [ - 'title' => '', - 'description' => 'The DataWorks workspace ID.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456', - 'backendName' => 'projectId', + 'Code' => ['title' => '规则模板Code，全局唯一标识', 'type' => 'string', 'backendName' => 'code'], + 'Name' => ['title' => '规则模板名称', 'type' => 'string', 'backendName' => 'name'], + 'TenantId' => ['title' => 'DataWorks租户ID', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'tenantId'], + 'ProjectId' => ['title' => 'DataWorks工作空间ID', 'type' => 'integer', 'format' => 'int64', 'backendName' => 'projectId'], + 'SamplingConfig' => [ + 'title' => '样本采集设置', + 'type' => 'object', + 'properties' => [ + 'Metric' => ['title' => '采样的指标名称', 'type' => 'string', 'example' => 'Min', 'backendName' => 'metric'], + 'MetricParameters' => ['title' => '样本采集时，所需的参数', 'type' => 'string', 'example' => '{ "SQL": "SELECT min(id) from table;" }', 'backendName' => 'metricParameters'], + 'SettingConfig' => ['title' => '具体执行采样语句前，插入执行的一些运行时参数设置语句，最长1000个字符。目前只支持MaxCompute', 'type' => 'string', 'example' => 'SET odps.sql.udf.timeout=600s;', 'backendName' => 'settingConfig'], + ], + 'backendName' => 'samplingConfig', ], - 'Origin' => [ - 'title' => '', - 'description' => 'The source of the dataset. Currently supported sources:'."\n" - ."\n" - .'* DataWorks'."\n" - .'* PAI'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'DataWorks', - 'backendName' => 'origin', + 'CheckingConfig' => [ + 'title' => '样本校验设置', + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '阈值计算方式', 'type' => 'string', 'example' => 'Fixed', 'backendName' => 'type'], + 'ReferencedSamplesFilter' => ['title' => '有些类型的阈值需要查询出一些参考样本，然后对参考样本的值进行汇总得出进行比较的阈值，这里使用一个表达式来表示参考样本的查询方式', 'type' => 'string', 'example' => '{ "bizdate": [ "-1", "-7", "-1m" ] }', 'backendName' => 'referencedSamplesFilter'], + ], + 'backendName' => 'checkingConfig', ], + 'VisibleScope' => ['title' => '模板的可用范围', 'type' => 'string', 'example' => 'Project', 'backendName' => 'visibleScope'], + 'DirectoryPath' => ['title' => '自定义模板被存放的类目目录，斜线分隔层级', 'type' => 'string', 'example' => '/ods/订单数据', 'backendName' => 'directoryPath'], + ], + ], + 'Dataset' => [ + 'title' => '数据集对象', + 'description' => 'The dataset object.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The dataset ID.'."\n", 'type' => 'string', 'title' => '数据集ID', 'example' => 'dataworks-dataset:1gxxxqjx155usz3hrv'], + 'Name' => ['description' => 'The dataset name. It must be a non-empty string and cannot exceed 128 characters.'."\n", 'type' => 'string', 'title' => '数据集名称，非空字符串，长度小于128', 'example' => 'test_dataset'], + 'Comment' => ['description' => 'The description of the dataset. The length cannot exceed 1024 characters.'."\n", 'type' => 'string', 'title' => '数据集描述，长度小于1024', 'example' => '测试数据集'], + 'ProjectId' => ['description' => 'The DataWorks workspace ID.'."\n", 'type' => 'integer', 'title' => 'DataWorks工作空间ID', 'format' => 'int64', 'example' => '123456'], + 'Origin' => ['description' => 'The source of the dataset. Currently supported sources:'."\n" + ."\n" + .'* DataWorks'."\n" + .'* PAI'."\n", 'type' => 'string', 'title' => '数据集来源，当前支持'."\n" + .'- DataWorks'."\n" + .'- PAI', 'example' => 'DataWorks'], 'DataType' => [ - 'title' => '', 'description' => 'The data type. Valid values:'."\n" ."\n" .'* COMMON'."\n" @@ -2578,22 +1392,19 @@ .'* VIDEO'."\n" .'* AUDIO'."\n" .'* INDEX'."\n", - 'visibility' => 'Public', + 'enumValueTitles' => ['TABLE' => '', 'VIDEO' => '', 'COMMON' => '', 'TEXT' => '', 'PIC' => '', 'INDEX' => '', 'AUDIO' => ''], 'type' => 'string', - 'enumValueTitles' => [ - 'TABLE' => '', - 'VIDEO' => '', - 'COMMON' => '', - 'TEXT' => '', - 'PIC' => '', - 'INDEX' => '', - 'AUDIO' => '', - ], + 'title' => '数据类型，取值有'."\n" + .'- COMMON 通用'."\n" + .'- PIC 图片'."\n" + .'- TEXT 文本'."\n" + .'- TABLE 表格'."\n" + .'- VIDEO 视频'."\n" + .'- AUDIO 音频'."\n" + .'- INDEX 索引', 'example' => 'COMMON', - 'backendName' => 'dataType', ], 'StorageType' => [ - 'title' => '', 'description' => 'The storage type. Valid values:'."\n" ."\n" .'* OSS: Object Storage Service'."\n" @@ -2603,204 +1414,71 @@ .'* CPFS: Cloud Paralleled File System'."\n" .'* BMCPFS: CPFS for Lingjun'."\n" .'* MAXCOMPUTE: MaxCompute table'."\n", - 'visibility' => 'Public', + 'enumValueTitles' => ['NAS' => '', 'MAXCOMPUTE' => '', 'CPFS' => '', 'BMCPFS' => '', 'EXTREMENAS' => '', 'OSS' => '', 'DLF_LANCE' => ''], 'type' => 'string', - 'enumValueTitles' => [ - 'NAS' => '', - 'MAXCOMPUTE' => '', - 'CPFS' => '', - 'BMCPFS' => '', - 'EXTREMENAS' => '', - 'OSS' => '', - 'DLF_LANCE' => '', - ], + 'title' => '存储类型，取值有'."\n" + .'- OSS 对象存储'."\n" + .'- NAS 通用型NAS文件存储'."\n" + .'- EXTREM_NAS 极速型NAS文件存储'."\n" + .'- DLF_LANCE 数据湖构建'."\n" + .'- CPFS CPFS文件存储'."\n" + .'- BMCPFS 智算CPFS文件存储'."\n" + .'- MAXCOMPUTE MaxCompute表', 'example' => 'OSS', - 'backendName' => 'storageType', - ], - 'CreatorId' => [ - 'title' => '', - 'description' => 'The ID of the creator.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '210484359', - 'backendName' => 'creatorId', - ], - 'Readme' => [ - 'title' => '', - 'description' => 'Instructions for using the dataset. Markdown rich text is supported.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '## introduction', - 'backendName' => 'readme', - ], - 'LatestVersion' => [ - 'title' => '', - 'description' => 'The latest dataset version object.'."\n", - 'visibility' => 'Public', - 'backendName' => 'latestVersion', - '$ref' => '#/components/schemas/DatasetVersion', - ], - 'CreateTime' => [ - 'title' => '', - 'description' => 'The creation time. This value is a UNIX timestamp in milliseconds.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1736756055000', - 'backendName' => 'createTime', - ], - 'ModifyTime' => [ - 'title' => '', - 'description' => 'The modification time. This value is a UNIX timestamp in milliseconds.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1736756055000', - 'backendName' => 'modifyTime', ], + 'CreatorId' => ['description' => 'The ID of the creator.'."\n", 'type' => 'string', 'title' => '创建者ID', 'example' => '210484359'], + 'Readme' => ['description' => 'Instructions for using the dataset. Markdown rich text is supported.'."\n", 'type' => 'string', 'title' => '数据集使用说明，支持markdown富文本', 'example' => '## introduction'], + 'LatestVersion' => ['description' => 'The latest dataset version object.'."\n", 'title' => '最新数据集版本对象', '$ref' => '#/components/schemas/DatasetVersion', 'example' => ''], + 'CreateTime' => ['description' => 'The creation time. This value is a UNIX timestamp in milliseconds.'."\n", 'type' => 'integer', 'title' => '创建时间毫秒级时间戳', 'format' => 'int64', 'example' => '1736756055000'], + 'ModifyTime' => ['description' => 'The modification time. This value is a UNIX timestamp in milliseconds.'."\n", 'type' => 'integer', 'title' => '修改时间毫秒级时间戳', 'format' => 'int64', 'example' => '1736756055000'], 'Labels' => [ - 'title' => '', + 'title' => '数据集标签，目前仅PAI数据集支持', 'description' => 'Dataset tags. Supported only for PAI datasets.'."\n", - 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'The PAI dataset tag object.'."\n", - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/DatasetLabel', - ], - 'backendName' => 'labels', + 'items' => ['description' => 'The PAI dataset tag object.'."\n", '$ref' => '#/components/schemas/DatasetLabel', 'title' => '', 'example' => ''], + 'example' => '', ], ], + 'example' => '', ], 'DatasetLabel' => [ - 'title' => '', + 'title' => 'PAI数据集标签', 'description' => 'PAI dataset labels'."\n", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'title' => '', - 'description' => 'Dataset label keys'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'key1', - 'backendName' => 'key', - ], - 'Value' => [ - 'title' => '', - 'description' => 'Dataset label values'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'value1', - 'backendName' => 'value', - ], + 'Key' => ['title' => '数据集标签键', 'description' => 'Dataset label keys'."\n", 'type' => 'string', 'example' => 'key1'], + 'Value' => ['title' => '数据集标签值', 'description' => 'Dataset label values'."\n", 'type' => 'string', 'example' => 'value1'], ], + 'example' => '', ], 'DatasetVersion' => [ - 'title' => '', + 'title' => '数据集版本对象', 'description' => 'The dataset version object.'."\n", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '', - 'description' => 'The dataset version ID.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'dataworks-datasetVersion:0gfxxxjx155usz3hrv:1', - 'backendName' => 'id', - ], - 'DatasetId' => [ - 'title' => '', - 'description' => 'The corresponding dataset ID.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'dataworks-datasetVersion:0gfxxxjx155usz3hrv', - 'backendName' => 'datasetId', - ], - 'Comment' => [ - 'title' => '', - 'description' => 'The dataset version description.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'comment', - ], - 'CreatorId' => [ - 'title' => '', - 'description' => 'The creator ID.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '17815XXX61016173', - 'backendName' => 'creatorId', - ], - 'VersionNumber' => [ - 'title' => '', - 'description' => 'The dataset version number.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'backendName' => 'versionNumber', - ], - 'StorageType' => [ - 'title' => '', - 'description' => 'Storage type (read-only); consistent with the corresponding property of the parent dataset.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'OSS', - 'backendName' => 'storageType', - ], - 'Url' => [ - 'title' => '', - 'description' => 'URL'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'oss://test-oss-bucket/test_dir/', - 'backendName' => 'url', - ], - 'MountPath' => [ - 'title' => '', - 'description' => 'The mount path. Defaults to /mnt/data.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '/mnt/data', - 'backendName' => 'mountPath', - ], - 'CreateTime' => [ - 'title' => '', - 'description' => 'Creation time (milliseconds)'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1736756055000', - 'backendName' => 'createTime', - ], - 'ModifyTime' => [ - 'title' => '', - 'description' => 'Modification time (milliseconds)'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1736756055000', - 'backendName' => 'modifyTime', - ], + 'Id' => ['title' => '数据集版本ID', 'description' => 'The dataset version ID.'."\n", 'type' => 'string', 'example' => 'dataworks-datasetVersion:0gfxxxjx155usz3hrv:1'], + 'DatasetId' => ['title' => '对应数据集ID', 'description' => 'The corresponding dataset ID.'."\n", 'type' => 'string', 'example' => 'dataworks-datasetVersion:0gfxxxjx155usz3hrv'], + 'Comment' => ['title' => '版本使用说明', 'description' => 'The dataset version description.'."\n", 'type' => 'string', 'example' => '初始版本'], + 'CreatorId' => ['title' => '创建者ID', 'description' => 'The creator ID.'."\n", 'type' => 'string', 'example' => '17815XXX61016173'], + 'VersionNumber' => ['title' => '数据集版本号', 'description' => 'The dataset version number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'StorageType' => ['title' => '存储类型，只读，与所属数据集对应属性保持一致', 'description' => 'Storage type (read-only); consistent with the corresponding property of the parent dataset.'."\n", 'type' => 'string', 'example' => 'OSS'], + 'Url' => ['title' => 'URL地址', 'description' => 'URL'."\n", 'type' => 'string', 'example' => 'oss://test-oss-bucket/test_dir/'], + 'MountPath' => ['title' => '挂载路径，默认为 /mnt/data', 'description' => 'The mount path. Defaults to /mnt/data.'."\n", 'type' => 'string', 'example' => '/mnt/data'], + 'CreateTime' => ['title' => '创建时间毫秒级时间戳', 'description' => 'Creation time (milliseconds)'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1736756055000'], + 'ModifyTime' => ['title' => '修改时间毫秒级时间戳', 'description' => 'Modification time (milliseconds)'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1736756055000'], 'Labels' => [ - 'title' => '', + 'title' => 'PAI数据集标签', 'description' => 'The PAI dataset label.'."\n", - 'visibility' => 'Public', 'type' => 'array', - 'items' => [ - 'description' => 'The PAI dataset label.'."\n", - 'visibility' => 'Public', - 'extendType' => 'true', - '$ref' => '#/components/schemas/DatasetLabel', - ], - 'backendName' => 'labels', + 'items' => ['description' => 'The PAI dataset label.'."\n", '$ref' => '#/components/schemas/DatasetLabel', 'title' => '', 'example' => ''], + 'example' => '', ], 'ImportInfo' => [ - 'title' => '', + 'title' => '数据集的存储导入配置'."\n" + .'对于NAS类型，需要提供以下属性，取值可参考DescribeFileSystems接口的返回信息'."\n" + .'- fileSystemId 文件系统ID'."\n" + .'- fileSystemStorageType 文件系统的存储规格'."\n" + .'- vpcId 挂载点的 VPC ID', 'description' => 'The storage import configuration for the dataset; required configuration varies by storage type.'."\n" ."\n" .'**NAS**'."\n" @@ -2814,1281 +1492,910 @@ .'"vpcId": "vpc-uf66oxxxrqge1t2gson7s" // The VPC ID of the mount point.'."\n" .'}'."\n" .'```'."\n", - 'visibility' => 'Public', 'type' => 'object', - 'additionalProperties' => [ - 'description' => 'The storage import configuration for the dataset.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'None', - ], - 'backendName' => 'importInfo', + 'additionalProperties' => ['description' => 'The storage import configuration for the dataset.'."\n", 'type' => 'string', 'example' => 'None', 'title' => ''], + 'example' => '', ], ], + 'example' => '', ], 'IdentifyCredential' => [ - 'description' => '', - 'visibility' => 'Public', + 'description' => 'The identity credential.', 'type' => 'object', 'properties' => [ - 'UserId' => [ - 'description' => 'The user ID. If it is a role, the ROLE\\_ prefix must be added.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => 'ROLE_300888674340307309', - 'backendName' => 'baseId', - ], + 'UserId' => ['description' => 'The user UID. If the `UserType` is `Role`, you must prefix this value with `ROLE_`.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'ROLE_300888674340307309'], 'UserType' => [ - 'description' => '* Alibaba Cloud account'."\n" - .'* RAM user'."\n" - .'* Role'."\n", - 'visibility' => 'Public', + 'description' => 'The user type. Supported values are:'."\n" + ."\n" + .'- primary account: `PrimaryAccount`'."\n" + ."\n" + .'- subaccount: `SubAccount`'."\n" + ."\n" + .'- role: `Role`', + 'enumValueTitles' => ['Role' => '', 'PrimaryAccount' => '', 'SubAccount' => ''], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'Role' => '', - 'PrimaryAccount' => '', - 'SubAccount' => '', - ], + 'title' => '', 'example' => ' primaryAccount', - 'backendName' => 'accountType', - ], - 'ProjectId' => [ - 'description' => 'The workspace ID (optional).'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '10000', - 'backendName' => 'workspaceId', ], + 'ProjectId' => ['description' => 'The project ID. This parameter is optional.', 'type' => 'string', 'title' => '', 'example' => '10000'], 'DataSource' => [ - 'description' => 'The data source.'."\n", - 'visibility' => 'Public', + 'description' => 'The data source.', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => 'The type of the data source. Supported types:'."\n" - ."\n" - .'* hive'."\n" - .'* lindorm_for_engine'."\n" - .'* starrocks'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => 'hologres', - 'backendName' => 'dsType', - ], + 'Type' => ['description' => 'The data source type. Supported values are:'."\n" + ."\n" + .'- `hive`'."\n" + ."\n" + .'- `lindorm_for_engine`'."\n" + ."\n" + .'- `starrocks`', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'hologres'], 'Role' => [ - 'description' => 'The user type of the data source.'."\n" - ."\n" - .'* Admin'."\n" - .'* RegularUser'."\n" + 'description' => 'The user role for the data source. Valid values are:'."\n" ."\n" - .'Valid values:'."\n" + .'- `Admin`'."\n" ."\n" - .'* RegularUser: Normal user.'."\n" - .'* Admin: Administrator.'."\n", - 'visibility' => 'Public', + .'- `RegularUser`', + 'enumValueTitles' => ['RegularUser' => '', 'Admin' => ''], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'RegularUser' => '', - 'Admin' => '', - ], + 'title' => '', 'example' => 'admin', - 'backendName' => 'dsUserType', - ], - 'UserName' => [ - 'description' => 'The username for the data source.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => 'tom', - 'backendName' => 'dsUsername', - ], - 'Password' => [ - 'description' => 'The password for the data source.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => '***', - 'backendName' => 'dsPassword', - 'sensitive' => true, - ], - 'InstanceId' => [ - 'description' => 'The instance ID of the data source.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => '710007423244', - 'backendName' => 'dsInstanceId', - ], - 'InstanceName' => [ - 'description' => 'The instance name of the data source.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'required' => false, - 'example' => 'rm-2zez82ho69yex7s7g', - 'backendName' => 'dsInstanceName', ], + 'UserName' => ['description' => 'The data source user name.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'tom'], + 'Password' => ['description' => 'The data source password.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '***'], + 'InstanceId' => ['description' => 'The data source instance ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '710007423244'], + 'InstanceName' => ['description' => 'The data source instance name.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'rm-2zez82ho69yex7s7g'], ], - 'backendName' => 'dataSource', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], 'LineageEntity' => [ - 'title' => '', + 'title' => '血缘实体', 'description' => 'The lineage entity.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '', - 'description' => 'The entity ID.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'maxcompute-table:123456XXX::test_project::test_tbl'."\n" - .'dlf-table:123456XXX:test_catalog:test_db::test_tbl'."\n" - .'hms-table:c-abc123xxx::test_db::test_tbl'."\n" - .'holo-table:h-abc123xxx::test_db:test_schema:test_tbl'."\n" - .'custom-api:api123'."\n" - .'custom-table:table456', - 'backendName' => 'id', - ], - 'Name' => [ - 'title' => '', - 'description' => 'The name.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test_tbl', - 'backendName' => 'name', - ], + 'Id' => ['title' => '实体ID', 'description' => 'The entity ID.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'maxcompute-table:123456XXX::test_project::test_tbl'."\n" + .'dlf-table:123456XXX:test_catalog:test_db::test_tbl'."\n" + .'hms-table:c-abc123xxx::test_db::test_tbl'."\n" + .'holo-table:h-abc123xxx::test_db:test_schema:test_tbl'."\n" + .'custom-api:api123'."\n" + .'custom-table:table456', 'backendName' => 'id'], + 'Name' => ['title' => '名称', 'description' => 'The name.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'test_tbl', 'backendName' => 'name'], 'Attributes' => [ - 'title' => '', + 'title' => '其他属性', 'description' => 'The additional properties.'."\n", 'visibility' => 'Public', 'type' => 'object', - 'additionalProperties' => [ - 'description' => 'The property.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'key1:value1', - ], + 'additionalProperties' => ['description' => 'The property.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'key1:value1'], 'example' => '{"key1":"value1"}', 'backendName' => 'attributes', ], ], ], 'LineageRelationship' => [ - 'title' => '', + 'title' => '血缘关系', 'description' => 'The lineage.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'SrcEntity' => [ - 'title' => '', - 'description' => 'The source entity.'."\n", - 'visibility' => 'Public', - 'backendName' => 'srcEntity', - '$ref' => '#/components/schemas/LineageEntity', - ], - 'DstEntity' => [ - 'title' => '', - 'description' => 'The destination entity.'."\n", - 'visibility' => 'Public', - 'backendName' => 'dstEntity', - '$ref' => '#/components/schemas/LineageEntity', - ], - 'Task' => [ - 'title' => '', - 'description' => 'The task.'."\n", - 'visibility' => 'Public', - 'backendName' => 'task', - '$ref' => '#/components/schemas/LineageTask', - ], - 'Id' => [ - 'title' => 'ID', - 'description' => 'The ID.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'maxcompute-table.p.table:custom-table.xxx:custom-sql.123', - 'backendName' => 'id', - ], - 'CreateTime' => [ - 'title' => '', - 'description' => 'The creation time.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1743040581000', - 'backendName' => 'createTime', - ], + 'SrcEntity' => ['title' => '源实体', 'description' => 'The source entity.'."\n", 'visibility' => 'Public', 'backendName' => 'srcEntity', '$ref' => '#/components/schemas/LineageEntity'], + 'DstEntity' => ['title' => '目标实体', 'description' => 'The destination entity.'."\n", 'visibility' => 'Public', 'backendName' => 'dstEntity', '$ref' => '#/components/schemas/LineageEntity'], + 'Task' => ['title' => '任务', 'description' => 'The task.'."\n", 'visibility' => 'Public', 'backendName' => 'task', '$ref' => '#/components/schemas/LineageTask'], + 'Id' => ['title' => 'ID', 'description' => 'The ID.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'maxcompute-table.p.table:custom-table.xxx:custom-sql.123', 'backendName' => 'id'], + 'CreateTime' => ['title' => '创建时间', 'description' => 'The creation time.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1743040581000', 'backendName' => 'createTime'], ], ], 'LineageTask' => [ - 'title' => '', + 'title' => '任务信息', 'description' => 'The information about the task.'."\n", 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '', - 'description' => 'The task ID.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '12345', - 'backendName' => 'id', - ], - 'Type' => [ - 'title' => '', - 'description' => 'The type of the task.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'custom-sql', - 'backendName' => 'type', - ], + 'Id' => ['title' => '任务ID', 'description' => 'The task ID.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => '12345', 'backendName' => 'id'], + 'Type' => ['title' => '任务类型', 'description' => 'The type of the task.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'custom-sql', 'backendName' => 'type'], 'Attributes' => [ - 'title' => '', + 'title' => '任务属性', 'description' => 'The properties of the task.'."\n", 'visibility' => 'Public', 'type' => 'object', - 'additionalProperties' => [ - 'description' => 'The property.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'key1:value21', - ], + 'additionalProperties' => ['description' => 'The property.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'key1:value21'], 'backendName' => 'attributes', ], ], ], - 'Partition' => [ + 'MetaEntity' => [ 'title' => '', - 'description' => 'The information about the partition.'."\n", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'TableId' => [ - 'title' => '', - 'description' => 'The ID of the table to which the partition belongs. You can configure this parameter by referring to the `Table` topic.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'maxcompute-table:accountId::project::table', - 'backendName' => 'tableId', - 'bizType' => 'normal', - ], - 'Name' => [ - 'title' => '', - 'description' => 'The partition name.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'ds=20250101', - 'backendName' => 'name', - 'bizType' => 'normal', - ], - 'CreateTime' => [ - 'title' => '', - 'description' => 'The creation time. This value is a UNIX timestamp. Unit: milliseconds.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1700192563000', - 'backendName' => 'createTime', - ], - 'ModifyTime' => [ + 'Id' => ['description' => 'Entity ID', 'type' => 'string', 'title' => '', 'example' => 'custom_entity-customer_api:api_001'], + 'EntityType' => ['description' => 'Entity type', 'type' => 'string', 'title' => '', 'example' => 'custom_entity-customer_api'], + 'Name' => ['description' => 'Entity name', 'type' => 'string', 'title' => '', 'example' => 'api_001'], + 'Comment' => ['description' => 'Comment', 'type' => 'string', 'title' => '', 'example' => 'this is a comment'], + 'OwnerId' => ['description' => 'Owner ID. The default value is the Alibaba Cloud UID of the creator.', 'type' => 'string', 'title' => '', 'example' => '207924799988354'], + 'CustomAttributes' => [ 'title' => '', - 'description' => 'The modification time. This value is a UNIX timestamp. Unit: milliseconds.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1700192563000', - 'backendName' => 'modifyTime', - ], - 'RecordCount' => [ - 'title' => '', - 'description' => 'The number of records in the partition.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000000', - 'backendName' => 'recordCount', + 'type' => 'object', + 'additionalProperties' => [ + 'title' => '', + 'type' => 'array', + 'items' => ['description' => 'Attribute value', 'type' => 'string', 'title' => '', 'example' => '张三'], + 'description' => 'List of attribute values', + 'example' => '', + ], + 'description' => 'Custom attribute values. The key is the custom attribute identifier. The value is a list of attribute values.', + 'example' => '', ], - 'DataSize' => [ + 'MetaEntityDef' => ['description' => 'Attribute definition of the custom entity.'."\n" + .'>For historical reasons, this property is not returned and its value is empty. We recommend that you use the GetMetaEntityDef API to obtain the entity type definition.>', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/MetaEntityDef'], + 'CreateTime' => ['description' => 'Creation time as a millisecond-level timestamp', 'type' => 'integer', 'title' => '', 'example' => '1780553640613', 'format' => 'int64'], + 'ModifyTime' => ['description' => 'Modification time as a millisecond-level timestamp', 'type' => 'integer', 'title' => '', 'example' => '1763380628000', 'format' => 'int64'], + 'Attributes' => [ 'title' => '', - 'description' => 'The storage size of the partition. Unit: bytes.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4096', - 'backendName' => 'dataSize', + 'type' => 'object', + 'additionalProperties' => ['description' => 'Entity attribute value. If the value is a complex type, it is represented as a JSON string.', 'type' => 'string', 'title' => '', 'example' => 'v1'], + 'description' => 'Entity attributes. Complex values are represented as JSON strings.', + 'example' => '', ], ], + 'description' => 'Custom entity', + 'example' => '', ], - 'Schema' => [ + 'MetaEntityAttributeDef' => [ 'title' => '', - 'description' => 'The mode.'."\n", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => 'ID', - 'description' => 'The schema ID. For more information, see [Concepts related to metadata entities.](~~2880092~~).'."\n" - ."\n" - .'The format is `${EntityType}:${Instance ID or escaped URL}:${Catalog name}:${Database name}`. Use empty strings as placeholders for levels that do not exist.'."\n" - ."\n" - .'> For the MaxCompute type, the instance ID level is represented by an empty string. The database name is the name of the MaxCompute project, which has enabled the schema feature.'."\n" - ."\n" - .'Examples of common ID formats'."\n" - ."\n" - .'`maxcompute-project:::project_name` (For MaxCompute projects schema enabled)'."\n" - ."\n" - .'`holo-schema:instance_id::database_name:schema_name`'."\n" - ."\n" - .'> \\'."\n" - .'`instance_id`: The Hologres instance ID\\'."\n" - .'. `database_name`: The database name\\'."\n" - .'. `project_name`: The MaxCompute project name\\'."\n" - .'. `schema_name`: The schema name.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'maxcompute-schema:123456XXX::test_project:default'."\n" - .'holo-schema:h-abc123xxx::test_db:test_schema', - 'backendName' => 'id', - ], - 'Name' => [ - 'title' => '', - 'description' => 'The name.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test_db', - 'backendName' => 'name', - ], - 'Comment' => [ - 'title' => '', - 'description' => 'The comment.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test comment', - 'backendName' => 'comment', - ], + 'Name' => ['description' => 'Attribute identifier. It can contain letters, digits, and underscores. It must start with a letter or digit and be up to 64 characters long.', 'type' => 'string', 'title' => '', 'example' => 'apiCode'], + 'DisplayName' => ['description' => 'Display name. It can be up to 32 characters long.', 'type' => 'string', 'title' => '', 'example' => 'API编码'], 'Type' => [ - 'title' => '', - 'description' => 'The type.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'MANAGED', - 'backendName' => 'type', - ], - 'ParentMetaEntityId' => [ - 'title' => '', - 'description' => 'The parent entity ID. For more information, see [Concepts related to metadata entities](~~2880092~~).'."\n" - ."\n" - .'The format: `${EntityType}:${Instance ID or escaped URL}:${Catalog name}:${Database name}`. Use empty strings as placeholders for levels that do not exist.'."\n" - ."\n" - .'> For the MaxCompute type, the instance ID level is represented by an empty string. The database name is the name of the MaxCompute project with schema enabled.'."\n" - ."\n" - .'Examples of common ParentMetaEntityId formats'."\n" - ."\n" - .'`maxcompute-project:::project_name` (For MaxCompute projects with schema enabled)'."\n" - ."\n" - .'`holo-database:instance_id::database_name`'."\n" - ."\n" - .'> \\'."\n" - .'`instance_id`: The Hologres instance ID\\'."\n" - .'. `database_name`: The database name\\'."\n" - .'. `project_name`: The MaxCompute project name.'."\n", - 'visibility' => 'Public', + 'description' => 'Attribute type. Supported types include STRING, TEXT, INT, FLOAT, BOOLEAN, DATE, ARRAY, ENUM, and JSON.', 'type' => 'string', - 'example' => 'maxcompute-project:123456XXX::test_project'."\n" - .'holo-database:h-abc123xxx::test_db', - 'backendName' => 'parentMetaEntityId', - ], - 'CreateTime' => [ 'title' => '', - 'description' => 'The creation time. The value is a UNIX timestamp. Unit: milliseconds.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1736852168000', - 'backendName' => 'createTime', - ], - 'ModifyTime' => [ + 'example' => 'STRING', + 'enum' => ['STRING', 'TEXT', 'INT', 'FLOAT', 'BOOLEAN', 'DATE', 'ARRAY', 'ENUM', 'JSON'], + ], + 'IsOptional' => ['description' => 'Indicates whether the value is optional. Default is true.> Validation occurs when creating an entity. If this value is false and no value is provided during creation, validation fails and an error is returned.>', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'SearchFilterEnabled' => ['description' => 'Indicates whether the attribute can be used as a filter on the search page. Default is false.'."\n" + ."\n" + .'Only attributes of type STRING, DATE, ENUM, ARRAY, INT, or BOOLEAN support this setting.', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'DisplayEnabled' => ['description' => 'Indicates whether the attribute appears on the product page. Default is true.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'AllowedValues' => [ 'title' => '', - 'description' => 'The modification time. The value is a UNIX timestamp. Unit: milliseconds.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1736852168000', - 'backendName' => 'modifyTime', + 'type' => 'array', + 'items' => ['description' => 'Allowed value', 'type' => 'string', 'title' => '', 'example' => 'LABEL_1'], + 'description' => 'Enumeration values. Required when Type is ENUM.', + 'example' => '', ], + 'Description' => ['description' => 'Attribute description', 'type' => 'string', 'title' => '', 'example' => '层级描述'], ], + 'description' => 'Custom entity attribute definition', + 'example' => '', ], - 'Table' => [ + 'MetaEntityDef' => [ 'title' => '', - 'description' => 'The information about a data table object.'."\n", - 'visibility' => 'Public', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => 'ID', - 'description' => 'The table ID. For more information, see [Concepts related to metadata entities](~~2880092~~).'."\n" - ."\n" - .'The common format of this parameter is `${Entity type}:${Instance ID or escaped URL}:${Catalog identifier}:${Database name}:${Schema name}:${Table name}`. If a level does not exist, specify an empty string as a placeholder.'."\n" - ."\n" - .'> For MaxCompute and DLF tables, specify an empty string at the Instance ID level as a placeholder. For MaxCompute tables, specify a MaxCompute project name at the Database name level. If the three-layer model is enabled for your MaxCompute project, you must specify a schema name at the Schema name level. Otherwise, you can specify an empty string at the Schema name level as a placeholder.'."\n" - ."\n" - .'> For StarRocks tables, specify a catalog name at the Catalog identifier level. For DLF tables, specify a catalog ID at the Catalog identifier level. Other types of tables do not support the Catalog identifier level, and you can specify an empty string as a placeholder.'."\n" - ."\n" - .'You can configure this parameter in one of the following formats based on your table type:'."\n" - ."\n" - .'`maxcompute-table:::project_name:[schema_name]:table_name`'."\n" - ."\n" - .'`dlf-table::catalog_id:database_name::table_name`'."\n" - ."\n" - .'`hms-table:instance_id::database_name::table_name`'."\n" - ."\n" - .'`holo-table:instance_id::database_name:schema_name:table_name`'."\n" - ."\n" - .'`mysql-table:(instance_id|encoded_jdbc_url)::database_name::table_name`'."\n" - ."\n" - .'> \\'."\n" - .'`instance_id`: the ID of an instance. If the related data source is added to DataWorks in Alibaba Cloud instance mode, you must configure this parameter.\\'."\n" - .'`encoded_jdbc_url`: the JDBC connection string that is URL-encoded. If the related data source is added to DataWorks in connection string mode, you must configure this parameter.\\'."\n" - .'`catalog_id`: the ID of a DLF catalog.\\'."\n" - .'`project_name`: the name of a MaxCompute project.\\'."\n" - .'`database_name`: the name of a database.\\'."\n" - .'`schema_name`: the name of a schema. For a MaxCompute table, this parameter is required only if the three-layer model is enabled for the MaxCompute project to which the table belongs. If the schema feature is not enabled for the MaxCompute project, specify an empty string for this parameter as a placeholder.\\'."\n" - .'`table_name`: the name of a table.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'maxcompute-table:123456XXX::test_project::test_tbl'."\n" - .'dlf-table:123456XXX:test_catalog:test_db::test_tbl'."\n" - .'hms-table:c-abc123xxx::test_db::test_tbl'."\n" - .'holo-table:h-abc123xxx::test_db:test_schema:test_tbl', - 'backendName' => 'id', - 'bizType' => 'normal', - ], - 'Name' => [ - 'title' => '', - 'description' => 'The table name.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test_tbl', - 'backendName' => 'name', - 'bizType' => 'normal', - ], - 'Comment' => [ + 'Name' => ['description' => 'The name of the type definition.', 'type' => 'string', 'title' => '', 'example' => 'biz_api'], + 'EntityType' => ['description' => 'The entity type.', 'type' => 'string', 'title' => '', 'example' => 'custom_entity-biz_api'], + 'DisplayName' => ['description' => 'The display name.', 'type' => 'string', 'title' => '', 'example' => '业务API'], + 'Description' => ['description' => 'The description.', 'type' => 'string', 'title' => '', 'example' => 'test'], + 'AttributeDefs' => [ 'title' => '', - 'description' => 'The comments.'."\n", - 'visibility' => 'Public', - 'type' => 'string', + 'type' => 'array', + 'items' => ['description' => 'An entity attribute definition object.', 'title' => '', 'example' => '', '$ref' => '#/components/schemas/MetaEntityAttributeDef'], + 'description' => 'A list of entity attribute definition objects.', 'example' => '', - 'backendName' => 'comment', - 'bizType' => 'normal', ], - 'TableType' => [ - 'title' => '', - 'description' => 'The table type. The value of this parameter is related to the type of metadata crawler.'."\n", - 'visibility' => 'Public', + 'Extend' => [ + 'description' => 'The extension mode. Valid values: NONE and TABLE. NONE indicates a custom type. TABLE indicates that the type extends a table type.', 'type' => 'string', - 'example' => 'TABLE', - 'backendName' => 'tableType', - 'bizType' => 'normal', + 'title' => '', + 'example' => 'NONE', + 'enum' => ['NONE', 'TABLE'], ], + 'CreateTime' => ['description' => 'The time when the definition was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'title' => '', 'example' => '1780553640613', 'format' => 'int64'], + 'ModifyTime' => ['description' => 'The time when the definition was last updated. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.', 'type' => 'integer', 'title' => '', 'example' => '1780553640613', 'format' => 'int64'], + ], + 'description' => 'The definition of a custom entity.', + 'example' => '', + ], + 'MetaEntityWriteResult' => [ + 'title' => '', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The entity name.', 'type' => 'string', 'title' => '', 'example' => 'entity_01'], + 'EntityType' => ['description' => 'The entity type.', 'type' => 'string', 'title' => '', 'example' => 'custom_entity-demo'], + 'Id' => ['description' => 'The entity ID.', 'type' => 'string', 'title' => '', 'example' => 'custom_entity-demo:entity_01'], + 'Success' => ['description' => 'Indicates whether the operation succeeded for the entity.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'ErrorMessage' => ['description' => 'The error message if the operation fails for the entity.', 'type' => 'string', 'title' => '', 'example' => 'The specified parameters are invalid.'], + ], + 'description' => 'The result of an entity write operation.', + 'example' => '', + ], + 'Partition' => [ + 'title' => '数据表的分区对象', + 'description' => 'The information about the partition.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'TableId' => ['title' => '所属数据表的资源标识', 'description' => 'The ID of the table to which the partition belongs. You can configure this parameter by referring to the `Table` topic.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'maxcompute-table:accountId::project::table', 'backendName' => 'tableId', 'bizType' => 'normal'], + 'Name' => ['title' => '名称', 'description' => 'The partition name.'."\n", 'visibility' => 'Public', 'type' => 'string', 'example' => 'ds=20250101', 'backendName' => 'name', 'bizType' => 'normal'], + 'CreateTime' => ['title' => '创建时间（毫秒级时间戳）', 'description' => 'The creation time. This value is a UNIX timestamp. Unit: milliseconds.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1700192563000', 'backendName' => 'createTime'], + 'ModifyTime' => ['title' => '修改时间（毫秒级时间戳）', 'description' => 'The modification time. This value is a UNIX timestamp. Unit: milliseconds.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1700192563000', 'backendName' => 'modifyTime'], + 'RecordCount' => ['title' => '分区记录数', 'description' => 'The number of records in the partition.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1000000', 'backendName' => 'recordCount'], + 'DataSize' => ['title' => '分区存储量，单位：字节', 'description' => 'The storage size of the partition. Unit: bytes.'."\n", 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '4096', 'backendName' => 'dataSize'], + ], + ], + 'Schema' => [ + 'title' => '模式', + 'description' => '模式。', + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => 'ID', 'description' => 'ID，可参考[元数据实体相关概念说明](~~2880092~~)。'."\n" + ."\n" + .'格式为`${EntityType}:${实例ID或转义后的URL}:${数据目录名称}:${数据库名称}:${模式名称}`，对于不存在的层级置空。'."\n" + ."\n" + .'> 对于MaxCompute类型，此处的实例ID即为主账号ID，数据库名称即为MaxCompute项目名称。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'maxcompute-schema:123456XXX::test_project:default'."\n" + .'holo-schema:h-abc123xxx::test_db:test_schema', 'backendName' => 'id'], + 'Name' => ['title' => '名称', 'description' => '名称。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'test_db', 'backendName' => 'name'], + 'Comment' => ['title' => '注释', 'description' => '注释。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'test comment', 'backendName' => 'comment'], + 'Type' => ['title' => '类型', 'description' => '类型。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'MANAGED', 'backendName' => 'type'], + 'ParentMetaEntityId' => ['title' => '父层级元数据实体ID', 'description' => '父层级元数据实体ID，父层级实体类型取值参考ListCrawlerTypes接口。'."\n" + ."\n" + .'格式为`${EntityType}:${实例ID或转义后的URL}:${数据目录名称}:${数据库名称}`，对于不存在的层级置空。'."\n" + ."\n" + .'> 对于MaxCompute类型，此处的实例ID即为主账号ID，数据库名称即为MaxCompute项目名称。', 'visibility' => 'Public', 'type' => 'string', 'example' => 'maxcompute-project:123456XXX::test_project'."\n" + .'holo-database:h-abc123xxx::test_db', 'backendName' => 'parentMetaEntityId'], + 'CreateTime' => ['title' => '创建时间（毫秒级时间戳）', 'description' => '创建时间（毫秒级时间戳）。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1736852168000', 'backendName' => 'createTime'], + 'ModifyTime' => ['title' => '更新时间（毫秒级时间戳）', 'description' => '更新时间（毫秒级时间戳）。', 'visibility' => 'Public', 'type' => 'integer', 'format' => 'int64', 'example' => '1736852168000', 'backendName' => 'modifyTime'], + ], + ], + 'Table' => [ + 'title' => '', + 'description' => 'The table object.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The ID. For more information, see [Metadata entity concepts](~~2880092~~).'."\n" + ."\n" + .'The format is `${EntityType}:${instance ID or encoded URL}:${DataFolderIdentity}:${DatabaseName}:${PatternName}:${TableName}`. Use an empty character as a placeholder for levels that do not exist.'."\n" + ."\n" + .'> For maxcompute and dlf types, use an empty string as a placeholder for the instance ID. For the maxcompute type, the database name is the MaxCompute project name. Projects with the three-layer model enabled require a schema name. For projects without the three-layer model enabled, use an empty string as a placeholder for the schema name.'."\n" + ."\n" + .'> For the starrocks type, the data catalog identifier is the catalog name. For the dlf type, the data catalog identifier is the catalog ID. Other types do not support the catalog level. Use an empty string as a placeholder.'."\n" + ."\n" + .'The following examples show the ID formats for common types:'."\n" + ."\n" + .'`maxcompute-table:::project_name:[schema_name]:table_name`'."\n" + ."\n" + .'`dlf-table::catalog_id:database_name::table_name`'."\n" + ."\n" + .'`hms-table:instance_id::database_name::table_name`'."\n" + ."\n" + .'`holo-table:instance_id::database_name:schema_name:table_name`'."\n" + ."\n" + .'`mysql-table:(instance_id|encoded_jdbc_url)::database_name::table_name`'."\n" + .'> Where '."\n" + .'`instance_id`: The instance ID. This is required when the data source is registered in instance mode. '."\n" + .'`encoded_jdbc_url`: The URL-encoded JDBC connection string. This is required when the data source is registered by using a connection string. '."\n" + .'`catalog_id`: The DLF catalog ID. '."\n" + .'`project_name`: The MaxCompute project name. '."\n" + .'`database_name`: The database name. '."\n" + .'`schema_name`: The schema name. For the maxcompute type, this is required only when the three-layer model is enabled for the project. If the three-layer model is not enabled, use an empty string as a placeholder. '."\n" + .'`table_name`: The table name.', 'type' => 'string', 'example' => 'dlf-table::catalog_id:database_name::table_name'], + 'Name' => ['title' => '', 'description' => 'The name.', 'type' => 'string', 'example' => 'table_name'], + 'Comment' => ['title' => '', 'description' => 'The comment.', 'type' => 'string', 'example' => '测试表'], + 'TableType' => ['title' => '', 'description' => 'The table type. The valid values depend on the metadata collector type.', 'type' => 'string', 'example' => 'TABLE'], 'PartitionKeys' => [ 'title' => '', - 'description' => 'The partition keys. If the table is a non-partitioned table, leave this parameter empty.'."\n", - 'visibility' => 'Public', + 'description' => 'The list of partition keys. This is empty for non-partitioned tables.', 'type' => 'array', - 'items' => [ - 'description' => 'The partition key.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'ds', - 'extendType' => 'true', - ], - 'backendName' => 'partitionKeys', - ], - 'ParentMetaEntityId' => [ - 'title' => '', - 'description' => 'The ID of a parent metadata entity. For more information, see [Concepts related to metadata entities](~~2880092~~).'."\n" - ."\n" - .'* For data source types that support schemas, such as `MaxCompute, Hologres, PostgreSQL, SQL Server, HybridDB for PostgreSQL, and Oracle`, the `ParentMetaEntityId` parameter specifies the schema of the database to which the table belongs. In this case, the common format of this parameter is `${Entity type}:${Instance ID or escaped URL}:${Catalog identifier}:${Database name}:${Schema name}`. If a level does not exist, leave the level empty. For a MaxCompute data table, you must make sure that the three-layer model is enabled for the MaxCompute project to which the table belongs.'."\n" - .'* For other data source types that do not support schemas, the `ParentMetaEntityId` parameter specifies the database to which the table belongs. In this case, the common format of this parameter is `${Entity type}:${Instance ID or escaped URL}:${Catalog identifier}:${Database name}`. If a level does not exist, leave the level empty.'."\n" - ."\n" - .'> For MaxCompute and DLF tables, specify an empty string at the Instance ID level as a placeholder. For MaxCompute tables, specify a MaxCompute project name at the Database name level.'."\n" - ."\n" - .'> For StarRocks tables, specify a catalog name at the Catalog identifier level. For DLF tables, specify a catalog ID at the Catalog identifier level. Other types of tables do not support the Catalog identifier level, and you can specify an empty string as a placeholder.'."\n" - ."\n" - .'You can configure this parameter in one of the following formats based on your table type:'."\n" - ."\n" - .'`maxcompute-project:::project_name`'."\n" - ."\n" - .'`maxcompute-schema:::project_name:schema_name` (Three-layer model enabled for the MaxCompute project)'."\n" - ."\n" - .'`dlf-database::catalog_id:database_name`'."\n" - ."\n" - .'`hms-database:instance_id::database_name`'."\n" - ."\n" - .'`holo-schema:instance_id::database_name:schema_name`'."\n" - ."\n" - .'`mysql-database:(instance_id|encoded_jdbc_url)::database_name`'."\n" - ."\n" - .'> \\'."\n" - .'`instance_id`: the ID of an instance. If the related data source is added to DataWorks in Alibaba Cloud instance mode, you must configure this parameter.\\'."\n" - .'`encoded_jdbc_url`: the JDBC connection string that is URL-encoded. If the related data source is added to DataWorks in connection string mode, you must configure this parameter.\\'."\n" - .'`catalog_id`: the ID of a DLF catalog.\\'."\n" - .'`project_name`: the name of a MaxCompute project.\\'."\n" - .'`database_name`: the name of a database.\\'."\n" - .'`schema_name`: the name of a schema.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'maxcompute-schema:123456XXX::test_project_with_schema:default'."\n" - .'maxcompute-project:123456XXX::test_project_without_schema'."\n" - .'dlf-database:123456XXX:test_catalog:test_db'."\n" - .'hms-database:c-abc123xxx::test_db'."\n" - .'holo-schema:h-abc123xxx::test_db:test_schema', - 'backendName' => 'parentMetaEntityId', - ], - 'CreateTime' => [ - 'title' => '', - 'description' => 'The creation time. This value is a UNIX timestamp. Unit: milliseconds.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1736852168000', - 'backendName' => 'createTime', - ], - 'ModifyTime' => [ - 'title' => '', - 'description' => 'The modification time. This value is a UNIX timestamp. Unit: milliseconds.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1736852168000', - 'backendName' => 'modifyTime', + 'items' => ['description' => 'The partition key.', 'type' => 'string', 'example' => 'ds', 'title' => ''], + 'example' => '', ], + 'ParentMetaEntityId' => ['title' => '', 'description' => 'The parent-level metadata entity ID. For more information, see [Metadata entity concepts](~~2880092~~).'."\n" + ."\n" + .'- For types that support schemas (`maxcompute/holo/postgresql/sqlserver/hybriddb_for_postgresql/oracle, where the maxcompute type requires the Layer 3 model to be enabled for the project`), ParentMetaEntityId is the database pattern to which the table belongs. The format is `${EntityType}:${instance ID or encoded URL}:${DataFolderIdentity}:${DatabaseName}:${PatternName}`. Use an empty character as a placeholder for levels that do not exist.'."\n" + ."\n" + .'- For other types, ParentMetaEntityId is the database to which the table belongs. The format is `${EntityType}:${instance ID or encoded URL}:${DataFolderIdentity}:${DatabaseName}`. Use an empty character as a placeholder for levels that do not exist.'."\n" + ."\n" + .'> For maxcompute and dlf types, use an empty string as a placeholder for the instance ID. For the maxcompute type, the database name is the MaxCompute project name.'."\n" + ."\n" + .'> For the starrocks type, the data catalog identifier is the catalog name. For the dlf type, the data catalog identifier is the catalog ID. Other types do not support the catalog level. Use an empty string as a placeholder.'."\n" + ."\n" + .'The following examples show the ParentMetaEntityId formats for common types:'."\n" + .' '."\n" + .'`maxcompute-project:::project_name`'."\n" + ."\n" + .'`maxcompute-schema:::project_name:schema_name` (only when the three-layer model is enabled for the project)'."\n" + ."\n" + .'`dlf-database::catalog_id:database_name`'."\n" + ."\n" + .'`hms-database:instance_id::database_name`'."\n" + ."\n" + .'`holo-schema:instance_id::database_name:schema_name`'."\n" + ."\n" + .'`mysql-database:(instance_id|encoded_jdbc_url)::database_name`'."\n" + ."\n" + .'> Where '."\n" + .'`instance_id`: The instance ID. This is required when the data source is registered in instance mode. '."\n" + .'`encoded_jdbc_url`: The URL-encoded JDBC connection string. This is required when the data source is registered by using a connection string. '."\n" + .'`catalog_id`: The DLF catalog ID. '."\n" + .'`project_name`: The MaxCompute project name. '."\n" + .'`database_name`: The database name. '."\n" + .'`schema_name`: The schema name.', 'type' => 'string', 'example' => 'dlf-database::catalog_id:database_name'], + 'CreateTime' => ['title' => '', 'description' => 'The creation time, in millisecond-level timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1736852168000'], + 'ModifyTime' => ['title' => '', 'description' => 'The modification time, in millisecond-level timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1736852168000'], 'TechnicalMetadata' => [ 'title' => '', - 'description' => 'The technical metadata.'."\n", - 'visibility' => 'Public', + 'description' => 'The technical metadata.', 'type' => 'object', 'properties' => [ - 'Owner' => [ - 'title' => '', - 'description' => 'The table owner.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test_user', - 'backendName' => 'owner', - ], - 'Location' => [ - 'title' => '', - 'description' => 'The storage location of the table.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'oss://test-bucket/test_tbl', - 'backendName' => 'location', - ], - 'Compressed' => [ - 'title' => '', - 'description' => 'Specifies whether the table is a compressed table. Valid values: true and false.'."\n", - 'visibility' => 'Public', - 'type' => 'boolean', - 'example' => 'false', - 'backendName' => 'compressed', - ], - 'InputFormat' => [ - 'title' => '', - 'description' => 'The input format.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'org.apache.hadoop.hive.ql.io.parquet.MapredParquetInputFormat', - 'backendName' => 'inputFormat', - ], - 'OutputFormat' => [ - 'title' => '', - 'description' => 'The output format.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'org.apache.hadoop.hive.ql.io.parquet.MapredParquetOutputFormat', - 'backendName' => 'outputFormat', - ], - 'SerializationLibrary' => [ - 'title' => '', - 'description' => 'The implementation class of SerDe.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'org.apache.hadoop.hive.ql.io.parquet.serde.ParquetHiveSerDe', - 'backendName' => 'serializationLibrary', - ], + 'Owner' => ['title' => '', 'description' => 'The owner.', 'type' => 'string', 'example' => 'test_user'], + 'Location' => ['title' => '', 'description' => 'The storage location.', 'type' => 'string', 'example' => 'oss://test-bucket/test_tbl'], + 'Compressed' => ['title' => '', 'description' => 'Indicates whether the table is compressed.', 'type' => 'boolean', 'example' => 'false'], + 'InputFormat' => ['title' => '', 'description' => 'The input format.', 'type' => 'string', 'example' => 'org.apache.hadoop.hive.ql.io.parquet.MapredParquetInputFormat'], + 'OutputFormat' => ['title' => '', 'description' => 'The output format.', 'type' => 'string', 'example' => 'org.apache.hadoop.hive.ql.io.parquet.MapredParquetOutputFormat'], + 'SerializationLibrary' => ['title' => '', 'description' => 'The class used by SerDe.', 'type' => 'string', 'example' => 'org.apache.hadoop.hive.ql.io.parquet.serde.ParquetHiveSerDe'], 'Parameters' => [ 'title' => '', - 'description' => 'The information about parameters.'."\n", - 'visibility' => 'Public', + 'description' => 'The parameter information.', 'type' => 'object', - 'additionalProperties' => [ - 'description' => 'The information about the parameter.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '{\\"k1\\":\\"v1\\"}', - ], - 'backendName' => 'parameters', + 'additionalProperties' => ['description' => 'The parameter information.', 'type' => 'string', 'example' => 'value', 'title' => ''], + 'example' => '', ], ], - 'backendName' => 'technicalMetadata', + 'example' => '', ], 'BusinessMetadata' => [ 'title' => '', - 'description' => 'The information about the business metadata that is related to DataWorks, including the usage notes, tags, categories, ancestor tasks, and extended information.'."\n", - 'visibility' => 'Public', + 'description' => 'The business metadata related to DataWorks, including usage instructions, tags, categories, upstream production nodes, and extended information.', 'type' => 'object', 'properties' => [ - 'Readme' => [ + 'Readme' => ['title' => '', 'description' => 'The usage instructions.', 'type' => 'string', 'example' => '## 使用说明'], + 'CustomAttributes' => [ 'title' => '', - 'description' => 'The usage notes.'."\n", - 'visibility' => 'Public', - 'type' => 'string', + 'description' => 'The custom attribute values, where key is the custom attribute identifier and value is the list of attribute values.', + 'type' => 'object', + 'additionalProperties' => [ + 'title' => '', + 'description' => 'The list of attribute values.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The attribute value.', 'type' => 'string', 'example' => '张三'], + 'example' => '', + ], 'example' => '', - 'backendName' => 'readme', ], 'Tags' => [ 'title' => '', - 'description' => 'The tags.'."\n", - 'visibility' => 'Public', + 'description' => 'The list of tags.', 'type' => 'array', 'items' => [ - 'description' => 'The information about the tag.'."\n", - 'visibility' => 'Public', + 'description' => 'The tag information.', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'title' => '', - 'description' => 'The tag key. You cannot leave this parameter empty.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'tag_key', - 'backendName' => 'key', - ], - 'Value' => [ - 'title' => '', - 'description' => 'The tag value. You can leave this parameter empty.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'tag_value', - 'nullable' => true, - 'backendName' => 'value', - ], + 'Key' => ['title' => '', 'description' => 'The tag key. This parameter cannot be empty.', 'type' => 'string', 'example' => 'tag_key'], + 'Value' => ['title' => '', 'description' => 'The tag value. This parameter can be empty.', 'type' => 'string', 'example' => 'tag_value'], ], - 'extendType' => 'true', + 'title' => '', + 'example' => '', ], - 'backendName' => 'tags', + 'example' => '', ], 'Categories' => [ 'title' => '', - 'description' => 'The categories.'."\n", - 'visibility' => 'Public', + 'description' => 'The list of categories.', 'type' => 'array', 'items' => [ - 'description' => 'The levels of a category. The category can be a single category or a multi-level category.'."\n", - 'visibility' => 'Public', + 'description' => 'The hierarchical list of a single category (multi-level category).', 'type' => 'array', 'items' => [ - 'description' => 'The information about the category.'."\n", - 'visibility' => 'Public', + 'description' => 'The category information.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => 'ID', - 'description' => 'The category ID.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'CATEGORY.456', - 'backendName' => 'id', - ], - 'Name' => [ - 'title' => '', - 'description' => 'The category name.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => '', - 'backendName' => 'name', - ], - 'ParentId' => [ - 'title' => '', - 'description' => 'The parent category ID. You can leave this parameter empty.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'CATEGORY.123', - 'backendName' => 'parentId', - ], + 'Id' => ['title' => '', 'description' => 'The category ID.', 'type' => 'string', 'example' => 'CATEGORY.456'], + 'Name' => ['title' => '', 'description' => 'The name.', 'type' => 'string', 'example' => '测试类目'], + 'ParentId' => ['title' => '', 'description' => 'The parent category ID. This parameter can be empty.', 'type' => 'string', 'example' => 'CATEGORY.123'], ], - 'extendType' => 'true', + 'title' => '', + 'example' => '', ], - 'extendType' => 'true', + 'title' => '', + 'example' => '', ], - 'backendName' => 'categories', - 'itemName' => 'Category', + 'example' => '', ], 'UpstreamTasks' => [ 'title' => '', - 'description' => 'The ancestor tasks.'."\n", - 'visibility' => 'Public', + 'description' => 'The list of upstream nodes.', 'type' => 'array', 'items' => [ - 'description' => 'The ancestor task.'."\n", - 'visibility' => 'Public', + 'description' => 'The upstream node.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '', - 'description' => 'The ancestor task ID.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456', - 'backendName' => 'id', - ], - 'Name' => [ - 'title' => '', - 'description' => 'The ancestor task name.'."\n", - 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'test_task', - 'backendName' => 'name', - ], + 'Id' => ['title' => '', 'description' => 'The node ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456'], + 'Name' => ['title' => '', 'description' => 'The node name.', 'type' => 'string', 'example' => 'test_task'], ], - 'extendType' => 'true', + 'title' => '', + 'example' => '', ], - 'backendName' => 'upstreamTasks', + 'example' => '', ], 'Extension' => [ 'title' => '', - 'description' => 'The extended information. Only MaxCompute tables supports this parameter.'."\n", - 'visibility' => 'Public', + 'description' => 'The extension information. Currently only supported for MaxCompute type.', 'type' => 'object', 'properties' => [ - 'ProjectId' => [ - 'title' => '', - 'description' => 'The DataWorks workspace ID.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '234', - 'backendName' => 'projectId', - ], + 'ProjectId' => ['title' => '', 'description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '234'], 'EnvType' => [ 'title' => '', - 'description' => 'The type of the environment. Valid values:'."\n" + 'description' => 'The environment type. Valid values:'."\n" ."\n" - .'* Prod'."\n" - .'* Dev'."\n", - 'visibility' => 'Public', - 'type' => 'string', + .'- Prod: Production environment.'."\n" + .'- Dev: Development environment.', 'enumValueTitles' => [], + 'type' => 'string', 'example' => 'Dev', - 'backendName' => 'envType', - 'enum' => [ - 'Dev', - 'Prod', - ], - ], - 'ViewCount' => [ - 'title' => '', - 'description' => 'The number of times the table is viewed.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - 'backendName' => 'viewCount', - ], - 'ReadCount' => [ - 'title' => '', - 'description' => 'The number of times the table is read.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - 'backendName' => 'readCount', - ], - 'FavorCount' => [ - 'title' => '', - 'description' => 'The number of times the table is added to favorites.'."\n", - 'visibility' => 'Public', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - 'backendName' => 'favorCount', + 'enum' => ['Dev', 'Prod'], ], + 'ViewCount' => ['title' => '', 'description' => 'The view count.', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'ReadCount' => ['title' => '', 'description' => 'The read count.', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'FavorCount' => ['title' => '', 'description' => 'The favorite count.', 'type' => 'integer', 'format' => 'int64', 'example' => '0'], ], - 'backendName' => 'extension', + 'example' => '', ], ], - 'backendName' => 'businessMetadata', + 'example' => '', + ], + 'StatisticsInfos' => [ + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'apis' => [ - 'ImportCertificate' => [ - 'summary' => 'Imports a certificate file.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'AbolishPipelineRun' => [ + 'summary' => 'Terminates the specified deployment process. This operation changes the status of the process to Terminated but does not delete the process. You can still query the process.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '250619', - 'abilityTreeNodes' => [ - 'FEATUREdideRWC5F7', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '267906', + 'abilityTreeNodes' => ['FEATUREdide4AR6E0'], ], 'parameters' => [ [ 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the workspace to which the certificate file belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '106560', - ], - ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => 'The certificate file name. In a project workspace, certificate file names must be unique.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ca1.crt', - ], - ], - [ - 'name' => 'CertificateFile', - 'in' => 'query', - 'schema' => [ - 'description' => 'The certificate file to upload. Upload method: Upload the file by creating an InputStream.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '-', - 'isFileTransferUrl' => true, - ], + '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" + ."\n" + .'You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000', 'title' => ''], ], [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the task.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'This is a file', - ], + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the process.', 'type' => 'string', 'required' => true, 'example' => '1606087c-9ac4-43f0-83a8-0b5ced21XXXX'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response.'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '证书文件ID，即证书文件的唯一标识符。', - 'description' => 'The ID of the certificate file, which is the unique identifier of the certificate file.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '676303114031776', - ], - 'RequestId' => [ - 'description' => 'The request ID. Used to locate logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '7C352CB7-CD88-50CF-9D0D-E81BDF020E7F', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '55D786C9-DD57-524D-884C-C5239278XXXX'."\n"], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Id\\": 676303114031776,\\n \\"RequestId\\": \\"7C352CB7-CD88-50CF-9D0D-E81BDF020E7F\\"\\n}","type":"json"}]', - 'title' => 'ImportCertificate', - ], - 'GetCertificate' => [ - 'summary' => 'View certificate details.', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"55D786C9-DD57-524D-884C-C5239278XXXX\\\\n\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'AbolishPipelineRun', + 'description' => '>'."\n" + ."\n" + .'This API may not be available in earlier versions of the SDK. In that case, use the AbolishDeployment API, which accepts the same parameters.'."\n" + ."\n" + .'>', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'AddEntityIntoMetaCollection' => [ + 'summary' => 'Adds an entity to a collection in Data Map. Collections include categories and data albums. Entities can be only tables. If you want to add an entity to a data album, the account that you use must be attached the AliyunDataWorksFullAccess policy, or you are the data album creator or administrator.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '250938', - 'abilityTreeNodes' => [ - 'FEATUREdideRWC5F7', - ], + 'abilityTreeCode' => '267213', + 'abilityTreeNodes' => ['FEATUREdideE9XYA6'], ], 'parameters' => [ + [ + 'name' => 'MetaCollectionId', + 'in' => 'query', + 'schema' => ['description' => 'The collection ID. You can refer to the return result of the ListMetaCollections operation.', 'type' => 'string', 'required' => true, 'example' => 'as78d756asd', 'title' => ''], + ], [ 'name' => 'Id', 'in' => 'query', 'schema' => [ - 'title' => '证书文件ID，即证书文件的唯一标识符。', - 'description' => 'The ID of the certificate file.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The entity ID. Currently, only table entities are supported. You can call the ListTables operation to obtain the ID.', + 'enumValueTitles' => [], + 'type' => 'string', 'required' => true, - 'example' => '676303114031776', + 'example' => 'maxcompute-table:::project_name:[schema_name]:table_name', + 'title' => '', ], ], [ - 'name' => 'ProjectId', + 'name' => 'Remark', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the workspace to which the certificate file belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1065601', - ], + 'schema' => ['description' => 'Remarks added when adding the entity to a collection. This parameter is currently valid only for album collections.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'Certificate' => [ - 'description' => 'The details of the certificate file.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '证书文件ID，即证书文件的唯一标识符。', - 'description' => 'The ID of the certificate file.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '676303114031776', - ], - 'Name' => [ - 'title' => '文件名称', - 'description' => 'The name of the certificate file.'."\n", - 'type' => 'string', - 'example' => 'ca1.crt', - ], - 'ProjectId' => [ - 'title' => '证书文件所属项目ID。', - 'description' => 'The ID of the workspace to which the certificate file belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '177161', - ], - 'Description' => [ - 'title' => '描述信息', - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'This is a file', - ], - 'CreateUser' => [ - 'title' => '认证文件的创建者ID', - 'description' => 'The ID of the user who created the certificate file.'."\n", - 'type' => 'string', - 'example' => '1107550004253538', - ], - 'CreateTime' => [ - 'title' => '创建时间（时间戳，单位：毫秒）', - 'description' => 'The time when the certificate file was created. The value is a UNIX timestamp. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1730217600000', - ], - 'FileSizeInBytes' => [ - 'title' => '文件的字节大小', - 'description' => 'The size of the certificate file, in bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '77549', - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"Certificate\\": {\\n \\"Id\\": 676303114031776,\\n \\"Name\\": \\"ca1.crt\\",\\n \\"ProjectId\\": 177161,\\n \\"Description\\": \\"This is a file\\",\\n \\"CreateUser\\": \\"1107550004253538\\",\\n \\"CreateTime\\": 1730217600000,\\n \\"FileSizeInBytes\\": 77549\\n }\\n}","type":"json"}]', - 'title' => 'GetCertificate', - 'description' => '1. This API operation is available for all DataWorks editions.'."\n" - .'2. You can call this operation only if you are assigned one of the following roles in DataWorks: Tenant Owner, Workspace Administrator, Deploy, Develop, Workspace Owner, and O\\&M.'."\n", - ], - 'ListCertificates' => [ - 'summary' => 'Queries a list of certificate files.', - 'methods' => [ - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490\\"\\n}","type":"json"}]', + 'title' => 'AddEntityIntoMetaCollection', + 'description' => '1. DataWorks Professional Edition or a higher edition is required.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dataworks:AddEntityIntoMetaCollection', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ApplyResourceAccessPermission' => [ + 'summary' => 'Submits an application for access permissions on a specific resource.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '250939', - 'abilityTreeNodes' => [ - 'FEATUREdideRWC5F7', - ], + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => 'TBD', + 'abilityTreeNodes' => ['FEATUREdideYTM537'], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'title' => '证书文件所属项目ID。', - 'description' => 'The ID of the workspace to which the certificate file belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10000', - ], + 'name' => 'Reason', + 'in' => 'formData', + 'schema' => ['description' => 'The reason for the application.'."\n", 'type' => 'string', 'required' => true, 'example' => '业务发展需要', 'title' => ''], ], [ - 'name' => 'PageSize', - 'in' => 'query', + 'name' => 'ApplyContents', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '分页大小，默认值为10，最大值100', - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', + 'description' => 'The list of resource permission application contents.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Resource' => [ + 'description' => 'The resource description.', + 'type' => 'object', + 'properties' => [ + 'DefSchema' => [ + 'description' => 'The resource type.'."\n" + ."\n" + .'**Note**: The resource types supported for application are constrained by [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).name.'."\n" + ."\n" + .'Appendix: [ResourceSchema documentation for international site](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)', + 'enumValueTitles' => ['MaxCompute' => 'MaxCompute', 'LINDORM' => 'LINDORM', 'EMR_ON_ECS_HIVE' => 'EMR_ON_ECS_HIVE', 'DLF_V1' => 'DLF_V1', 'HOLOGRES' => 'HOLOGRES', 'SEVERLESS_STARROCKS' => 'SEVERLESS_STARROCKS', 'DATAWORKS_ENTITY' => 'DATAWORKS_ENTITY', 'DLF_NEXT' => 'DLF_NEXT'], + 'type' => 'string', + 'required' => true, + 'example' => 'MaxCompute', + 'title' => '', + ], + 'DefVersion' => ['description' => 'The resource parsing version, which is constrained by [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).version.'."\n" + ."\n" + .'[ResourceSchema documentation for international site](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)', 'type' => 'string', 'required' => false, 'default' => 'v1.0.0', 'example' => 'v1.0.0', 'title' => ''], + 'MetaData' => [ + 'description' => 'The resource metadata declaration.'."\n" + ."\n" + .'**Note**: The metadata is constrained by [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).resources. A valid resource declaration must include full-path metadata declarations from level 0 to validLeaf.'."\n" + ."\n" + .'Appendix: [ResourceSchema documentation for international site](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['description' => 'Declares a specific resource in Map format. The declaration must comply with the resource constraints for the specific resource type in ResourceSchema.'."\n" + ."\n\n" + .'Note:'."\n" + .'1. When applying for column-level permissions in MaxCompute, you must also declare columnSensibleLevel for label-based authorization to take effect.'."\n" + .'2. For MaxCompute permission applications with Schema enabled, pass the threeTierModel parameter and set it to true.', 'type' => 'any', 'example' => '{'."\n" + .' "workspace": "449656",'."\n" + .' "project": "sync_destination",'."\n" + .' "table": "order_table",'."\n" + .' "threeTierModel": false'."\n" + .' }', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Grantee' => [ + 'description' => 'The grantee description.'."\n" + ."\n" + .'**Note**: The supported grantee types are constrained by [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).authPrincipal.'."\n" + ."\n" + .'Appendix: [ResourceSchema documentation for international site](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)', + 'type' => 'object', + 'properties' => [ + 'PrincipalType' => [ + 'description' => 'The grantee type. Valid values:'."\n" + ."\n" + .'- RamRole'."\n" + .'- RamUser'."\n" + .'- DlfRole', + 'enumValueTitles' => ['DlfRole' => 'DlfRole', 'RamUser' => 'RamUser', 'RamRole' => 'RamRole'], + 'type' => 'string', + 'required' => true, + 'example' => 'RamRole', + 'title' => '', + ], + 'PrincipalId' => ['description' => 'The grantee ID. The ID has different semantics depending on the grantee type:'."\n" + ."\n" + .'- RamUser: Dataworks UserId'."\n" + .'- RamRole: Dataworks UserId prefixed with "ROLE_"'."\n" + ."\n" + .'- DlfRole: DlfNext role name', 'type' => 'string', 'required' => true, 'example' => 'ROLE_32237475848545', 'title' => ''], + ], + 'required' => true, + 'title' => '', + 'example' => '', + ], + 'AccessTypes' => [ + 'description' => 'The list of permissions to apply for.'."\n" + ."\n" + .'**Note**: Different resource levels support different permission types. They are uniformly constrained by [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).isValidLeaf, accessTypeRestrictions, and authMethodAccessTypes.'."\n" + ."\n" + .'Appendix: [ResourceSchema documentation for international site](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)', + 'type' => 'array', + 'items' => ['description' => 'The resource permission.', 'type' => 'string', 'required' => false, 'example' => 'select', 'title' => ''], + 'required' => true, + 'title' => '', + 'example' => '', + ], + 'ExpirationTime' => ['description' => 'The permission expiration time, in milliseconds timestamp.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1785835708000', 'title' => ''], + 'AuthMethod' => [ + 'description' => 'The authorization method. Currently, only SEVERLESS_STARROCKS supports specifying the authorization method: ranger or starrocksManager.'."\n" + ."\n" + .'**Note**: Different resources support different authorization methods, which are uniformly constrained by [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).authMethods.'."\n" + ."\n" + .'Appendix: [ResourceSchema documentation for international site](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)', + 'enumValueTitles' => ['starrocksManager' => 'Starrocks Manager', 'ranger' => 'Ranger'], + 'type' => 'string', + 'required' => false, + 'example' => 'ranger', + 'title' => '', + ], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'maxItems' => 400, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'PageNumber', - 'in' => 'query', + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => ['description' => 'The idempotency parameter. Used to prevent duplicate operations caused by multiple calls.', 'type' => 'string', 'required' => false, 'example' => 'ABFUOEUOTRTRJKE', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '查询第几页，默认值为1表示第一页', - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + 'title' => '', + 'description' => 'The response result.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID. Used for locating logs and troubleshooting issues.', 'type' => 'string', 'example' => '0bc5df3a17***903790e8e8a'], + 'Data' => [ + 'description' => 'The list of application IDs.', + 'type' => 'array', + 'items' => ['description' => 'The application/approval process ID.', 'type' => 'string', 'example' => '332066440109224007', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Submit a Resource Access Permission Application', + 'description' => '## Request Description'."\n" + .'- **Reason**: The reason for the application. This parameter is required.'."\n" + .'- **ApplyContents**: Contains multiple resource permission application contents, each including the resource description (Resource), grantee description (Grantee), permission types (AccessTypes), and permission expiration time (ExpirationTime). The maximum limit per request is 400 entries.'."\n" + .'- **Resource**: The resource description. You need to specify the ResourceSchema.name and version that the resource parsing depends on, as well as the resource metadata MetaData.'."\n" + .'- **Grantee**: The grantee description. You need to specify the grantee type (PrincipalType) and the principal ID (PrincipalId).'."\n" + .'- **AccessTypes**: The list of permission types. Multiple permission combinations are supported.'."\n" + .'- **ExpirationTime**: The permission expiration time, provided as a milliseconds timestamp.'."\n" + .'- **AuthMethod**: An optional parameter that specifies the authorization method. The system uses the built-in default authorization method if not specified.'."\n" + .'- **ClientToken**: The client token used to prevent duplicate requests. This parameter is optional.'."\n" + ."\n" + .'Ensure all required fields are filled in correctly and comply with the corresponding constraints. For example, `DefVersion` and `MetaData` in `Resource` should match the selected `DefSchema`.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc5df3a17***903790e8e8a\\",\\n \\"Data\\": [\\n \\"332066440109224007\\"\\n ]\\n}","type":"json"}]', + ], + 'ApproveProcessInstance' => [ + 'summary' => 'Approves or rejects a specified approval process instance.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'title' => '文件名称，基于此名称做模糊查询', - 'description' => 'The name of the certificate file. Fuzzy match by file name is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'xm_create_test', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '243667', + 'abilityTreeNodes' => ['FEATUREdideYTM537'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ [ - 'name' => 'CreateUser', - 'in' => 'query', - 'schema' => [ - 'title' => '查询某个创建者ID所创建的文件列表', - 'description' => 'The ID of the user who created the certificate files.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1107550004253538', - ], + 'name' => 'ProcessInstanceId', + 'in' => 'formData', + 'schema' => ['description' => 'The process instance ID. Both new and legacy Security Center approval forms are supported.', 'type' => 'string', 'required' => true, 'example' => '332066440109224007', 'title' => ''], ], [ - 'name' => 'StartCreateTime', - 'in' => 'query', - 'schema' => [ - 'title' => '查询创建时间在该日期之后的文件。'."\n" - .'单位：毫秒', - 'description' => 'The time when the certificate file was created. You can call this operation to query the files that are created after the time. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1730217600000', - ], + 'name' => 'ApprovalComment', + 'in' => 'formData', + 'schema' => ['description' => 'The approval comment.', 'type' => 'string', 'required' => true, 'example' => '同意授权', 'title' => ''], ], [ - 'name' => 'EndCreateTime', - 'in' => 'query', - 'schema' => [ - 'title' => '查询创建时间在该日期之前的文件。'."\n" - .'单位：毫秒', - 'description' => 'The time when the certificate file was created. You can call this operation to query the files that are created before the time. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1593877765000', - ], + 'name' => 'NewExpiration', + 'in' => 'formData', + 'schema' => ['description' => 'The new authorization expiration time. Unit: milliseconds (UNIX timestamp).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1782541464000', 'title' => ''], ], [ - 'name' => 'SortBy', - 'in' => 'query', + 'name' => 'ApprovalAction', + 'in' => 'formData', 'schema' => [ - 'title' => '认证文件列表排序字段，支持名称、创建时间、文件ID排序'."\n" - .'● CreateTime'."\n" - .'● Id'."\n" - .'● Name'."\n" - .'默认值：Id', - 'description' => 'The field used to sort the certificate files. Valid values: CreateTime Id Name Default value: Id'."\n", + 'description' => 'The approval action. Valid values:'."\n" + ."\n" + .'- Agree: Approved.'."\n" + ."\n" + .'- Deny: Rejected.', + 'enumValueTitles' => ['Agree' => 'Agree', 'Deny' => 'Deny'], 'type' => 'string', - 'required' => false, - 'example' => 'Id', + 'required' => true, + 'example' => 'Agree', + 'title' => '', ], ], [ - 'name' => 'Order', - 'in' => 'query', - 'schema' => [ - 'title' => '认证文件列表排序方向，枚举值：'."\n" - .'● Desc表示倒序'."\n" - .'● Asc表示正序'."\n" - .'默认值：Asc', - 'description' => 'The order in which you want to sort the certificate files. Valid values: Desc: descending order ASC: ascending order Default value: Asc'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Asc', - ], + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => ['description' => 'The idempotency token. We recommend that you use a UUID.', 'type' => 'string', 'required' => false, 'example' => '1AFAE64E-D1BE-432B-A9*****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'ecb967ec-c137-48****', - ], - 'PagingInfo' => [ - 'description' => 'The pagination information.'."\n", - 'type' => 'object', - 'properties' => [ - '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', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Certificates' => [ - 'title' => '认证文件列表', - 'description' => 'The certificate files.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the certificate file.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the certificate file.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '676303114031776', - ], - 'Name' => [ - 'description' => 'The name of the certificate file.'."\n", - 'type' => 'string', - 'example' => 'ca1.crt', - ], - 'CreateUser' => [ - 'description' => 'The ID of the user who created the certificate file.'."\n", - 'type' => 'string', - 'example' => '1107550004253538', - ], - 'CreateTime' => [ - 'description' => 'The time when the certificate file was created. This value is a UNIX timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1730217600000', - ], - 'FileSizeInBytes' => [ - 'description' => 'The size of the certificate file, in bytes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1024', - ], - 'Description' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'This is a file', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID, which is used to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => '0bc5df3a17***903790e8e8a'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Approve a workflow instance', + 'description' => '## Request description'."\n" + .'- This operation allows you to approve or reject a specified approval process instance by passing in the ProcessInstanceId and approval information (including ApprovalComment and ApprovalAction).'."\n" + .'- ApprovalAction can be Agree or Deny, indicating approval or rejection respectively.'."\n" + .'- ApprovalComment is required and records the specific approval opinion.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ecb967ec-c137-48****\\",\\n \\"PagingInfo\\": {\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"Certificates\\": [\\n {\\n \\"Id\\": 676303114031776,\\n \\"Name\\": \\"ca1.crt\\",\\n \\"CreateUser\\": \\"1107550004253538\\",\\n \\"CreateTime\\": 1730217600000,\\n \\"FileSizeInBytes\\": 1024,\\n \\"Description\\": \\"This is a file\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListCertificates', - 'description' => '1. This API operation is available for all DataWorks editions.'."\n" - .'2. You can call this operation only if you are assigned one of the following roles in DataWorks: Tenant Owner, Workspace Administrator, Deploy, Develop, Visitor, Workspace Owner, O\\&M, Model Designer, Security Administrator, Data Analyst, OpenPlatform Administrator, and Data Governance Administrator.'."\n", + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc5df3a17***903790e8e8a\\"\\n}","type":"json"}]', ], - 'DeleteCertificate' => [ - 'summary' => 'Deletes a certificate file.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'AssociateProjectToImage' => [ + 'summary' => 'Associates an image with a workspace.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -4097,76 +2404,56 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '250936', - 'abilityTreeNodes' => [ - 'FEATUREdideRWC5F7', - ], + 'abilityTreeCode' => '245182', + 'abilityTreeNodes' => ['FEATUREdide2SV6DS'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the certificate file.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '676303114031776', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The image ID.', 'type' => 'string', 'required' => true, 'example' => 'Custom_image_xxxx_xxxx', 'title' => ''], ], [ 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the workspace to which the certificate file belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '106560', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '100000001', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Success' => [ - 'title' => '是否删除成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D9A61DC0-B922-421B-B706', - ], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'example' => 'true'], + 'Data' => ['description' => 'The result of the API request.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID, which is used to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', 'title' => ''], ], + 'title' => '', + 'description' => 'Schema of Response', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'AssociateProjectToImage', + 'description' => '1. You must purchase DataWorks Basic Edition or later to use this operation.'."\n" + ."\n" + .'2. **Ensure the AliyunServiceRoleForDataWorks service-linked role is created before you call this operation.**', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"D9A61DC0-B922-421B-B706\\"\\n}","type":"json"}]', - 'title' => 'DeleteCertificate', - 'description' => '1. This API operation is available for all DataWorks editions.'."\n" - .'2. You can call this operation only if you are assigned one of the following roles in DataWorks: Tenant Owner, Workspace Administrator, Workspace Owner, and O\\&M.'."\n", + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]', ], - 'CreateProject' => [ - 'summary' => 'Creates a workspace.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'AssociateProjectToResourceGroup' => [ + 'summary' => 'Associates a resource group with a workspace.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -4175,319 +2462,145 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '243667', - 'abilityTreeNodes' => [ - 'FEATUREdideYTM537', - ], + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '245168', + 'abilityTreeNodes' => ['FEATUREdide2SV6DS'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'Name', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the workspace.'."\n" - ."\n" - .'Limits:'."\n" - ."\n" - .'* The workspace name must be unqiue in a region.'."\n" - .'* The workspace name can contain letters, digits, and underscores (\\_), and must start with a letter.'."\n" - .'* The workspace name must be 3 to 28 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'sora_finance', - ], - ], - [ - 'name' => 'DisplayName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The display name of the workspace.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Sora financial analysis', - ], - ], - [ - 'name' => 'Description', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The description of the workspace.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Financial analysis group project data development', - ], - ], - [ - 'name' => 'AliyunResourceGroupId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the Alibaba Cloud resource group to which the workspace belongs. You can log on to the [Resource Management console](https://resourcemanager.console.aliyun.com/resource-groups) and go to the Resource Group page to query the ID.'."\n" - ."\n" - .'You must configure this parameter to specify an Alibaba Cloud resource group for the workspace that you want to create.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfmzbn7pti3zff', - ], - ], - [ - 'name' => 'PaiTaskEnabled', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether to enable scheduling of Platform for AI (PAI) tasks. Valid values:'."\n" - ."\n" - .'* true: enables scheduling of PAI tasks. In this case, you can create a PAI node in a DataWorks workspace and configure scheduling properties for the node to implement periodic scheduling of PAI tasks.'."\n" - .'* false: disables scheduling of PAI tasks.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'DevEnvironmentEnabled', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether to enable the development environment. Valid values:'."\n" - ."\n" - .'* true : enables the development environment. In this case, the development environment is isolated from the production environment in the workspace.'."\n" - .'* false: disables the development environment. In this case, only the production environment is used in the workspace.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - [ - 'name' => 'AliyunResourceTags', + 'name' => 'ResourceGroupId', 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The tags.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'batch', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'blue', - ], - ], - 'required' => false, - 'description' => '', - ], - 'required' => false, - ], + 'schema' => ['description' => 'The unique identifier of the resource group.', 'type' => 'string', 'required' => true, 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX', 'title' => ''], ], [ - 'name' => 'DevRoleDisabled', + 'name' => 'ProjectId', 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether to disable the Develop role. Valid values:'."\n" - ."\n" - .'* false (default)'."\n" - .'* true'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The ID of the workspace to associate.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1000', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'AFBB799F-8578-51C5-A766-E922EDB8XXXX'."\n", - ], - 'ProjectId' => [ - 'title' => '该字段即将废弃，请使用Id字段。', - 'description' => 'The workspace ID. Note: This parameter is deprecated and is replaced by the Id parameter.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'deprecated' => true, - 'example' => '123456', - ], - 'Id' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456', - ], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'example' => 'true'], + 'RequestId' => ['description' => 'The request ID, which is used to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'asynchronous', - 'callback' => 'dataworks-public::2024-05-18::GetProject', - 'callbackInterval' => 100, - 'maxCallbackTimes' => 3, - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AFBB799F-8578-51C5-A766-E922EDB8XXXX\\\\n\\",\\n \\"ProjectId\\": 123456,\\n \\"Id\\": 123456\\n}","type":"json"}]', - 'title' => 'CreateProject', - ], - 'UpdateProject' => [ - 'summary' => 'Updates a DataWorks workspace.', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]', + 'title' => 'AssociateProjectToResourceGroup', + 'description' => '1. This operation requires DataWorks Basic Edition or a more advanced edition.'."\n" + ."\n" + .'2. You must have one of the following roles in the DataWorks workspace:'."\n" + ."\n" + .'- tenant owner, workspace administrator, project owner, or operator', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:AssociateProjectToResourceGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'AttachDataQualityRulesToEvaluationTask' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, + 'operationType' => 'write', + 'deprecated' => true, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '244492', - 'abilityTreeNodes' => [ - 'FEATUREdideYTM537', - ], - 'tenantRelevance' => 'tenant', + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '250888', + 'abilityTreeNodes' => ['FEATUREdide3WJOKE'], ], 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the DataWorks workspace. You can log on to the [DataWorks console](https://dataworks.console.aliyun.com/workspace/list) and go to the workspace management page to obtain the ID.'."\n" - ."\n" - .'This parameter is used to determine the DataWorks workspaces used for this API call.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456', - ], - ], - [ - 'name' => 'Description', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The description of the workspace.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Financial analysis group project data development', - ], - ], - [ - 'name' => 'Status', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether to disable or enable the workspace. Valid values:'."\n" - ."\n" - .'* Available: enables the workspace.'."\n" - .'* Forbidden: disables the workspace.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Forbidden', - 'enum' => [ - 'Forbidden', - 'Available', - ], - ], - ], - [ - 'name' => 'DevEnvironmentEnabled', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether to enable the development environment. Valid values:'."\n" - ."\n" - .'* true: enables the development environment. In this case, the development environment is isolated from the production environment in the workspace.'."\n" - .'* false: disables the development environment. In this case, only the production environment is used in the workspace.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'DevRoleDisabled', + 'name' => 'ProjectId', 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether to disable the Develop role. Valid values:'."\n" - ."\n" - .'* false (default)'."\n" - .'* true'."\n" - ."\n" - .'Note: If you disable the Develop role, you cannot assume the Develop role to develop nodes in workflows and edit node code. The Develop role cannot be enabled again after it is disabled.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + '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 Settings page to obtain the workspace ID.'."\n" + .'This parameter specifies the DataWorks workspace in which the API operation is performed.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '100001', 'title' => ''], ], [ - 'name' => 'DisplayName', + 'name' => 'DataQualityEvaluationTaskId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The display name of the workspace.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Sora financial analysis Space', - ], + 'schema' => ['description' => 'The ID of the associated data quality monitoring task.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '200001', 'title' => ''], ], [ - 'name' => 'PaiTaskEnabled', + 'name' => 'DataQualityRuleIds', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'Specifies whether to enable scheduling of Platform for AI (PAI) tasks. Valid values:'."\n" - ."\n" - .'* true: enables scheduling of PAI tasks. In this case, you can create a PAI node in a DataWorks workspace and configure scheduling properties for the node to implement periodic scheduling of PAI tasks.'."\n" - .'* false: disables scheduling of PAI tasks.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + 'description' => 'The list of data quality rule IDs.', + 'type' => 'array', + 'items' => ['description' => 'The list of data quality rule IDs.', 'type' => 'integer', 'format' => 'int64', 'docRequired' => true, 'required' => true, 'example' => '2000001', 'title' => ''], + 'required' => true, + 'docRequired' => true, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request. It is used to locate logs and troubleshoot problems.', - 'type' => 'string', - 'example' => 'AFBB799F-8578-51C5-A766-E922EDB8XXXX'."\n", - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'E6F0DBDD-5AD8-4870-A6A0'], + 'Success' => ['description' => 'Indicates whether the association is successful. Valid values:'."\n" + .'- true: The call is successful.'."\n" + .'- false: The call fails.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], 'staticInfo' => [ - 'returnType' => 'synchronous', + 'substitutions' => ['dataworks-public::2024-05-18::UpdateDataQualityScan'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AFBB799F-8578-51C5-A766-E922EDB8XXXX\\\\n\\"\\n}","type":"json"}]', - 'title' => 'UpdateProject', - ], - 'DeleteProject' => [ - 'summary' => 'Deletes a DataWorks workspace.', - 'methods' => [ - 'post', + 'title' => 'Associate data quality rules with a data quality monitoring task', + 'summary' => 'Associates data quality rules with a data quality monitoring task.', + 'description' => 'You must purchase DataWorks Basic Edition or higher to use this feature.', + 'changeSet' => [ + ['createdAt' => '2024-12-23T06:29:09.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E6F0DBDD-5AD8-4870-A6A0\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'BatchCreateMetaEntities' => [ + 'summary' => 'Creates metadata entities in a batch. All entities within a batch must have the same entity type. This operation currently supports only custom types and extended table types, which represent databases and tables.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -4496,858 +2609,816 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '244493', - 'abilityTreeNodes' => [ - 'FEATUREdideYTM537', - ], + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdideX3KVYR'], + 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'Entities', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://dataworks.console.aliyun.com/workspace/list) 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', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EntityType' => ['description' => 'The entity type. All entities in a batch must have the same type. The following types are supported:'."\n" + ."\n" + .'- Custom types, such as `custom_entity-biz_api`.'."\n" + ."\n" + .'- Extended table types. For example, if you have registered the `custom_dw-table` metadata entity type, you can create objects of the corresponding `custom_dw-database` (database) and `custom_dw-table` (table) types.', 'type' => 'string', 'required' => true, 'example' => 'custom_entity-customer_api', 'title' => ''], + 'Name' => ['description' => 'The entity name. The name can contain uppercase letters, lowercase letters, digits, and underscores (\\_). It must start with a letter and not exceed 64 characters.', 'type' => 'string', 'required' => true, 'example' => 'api_001', 'title' => ''], + 'Comment' => ['description' => 'The comment for the entity.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'this is a comment'], + 'Attributes' => [ + 'type' => 'object', + 'additionalProperties' => ['description' => 'An entity attribute.', 'type' => 'string', 'example' => 'key1', 'title' => ''], + 'title' => '', + 'description' => 'The entity attributes. Complex values must be serialized into a JSON string.', + 'required' => false, + 'example' => '', + ], + 'CustomAttributes' => [ + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'array', + 'items' => ['description' => 'A custom attribute value.', 'type' => 'string', 'example' => 'value1', 'title' => ''], + 'description' => 'A list of custom attribute values.', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'description' => 'The custom attribute values. The key is the identifier of the custom attribute, and the value is a single-element list.'."\n" + .'>The custom attributes used here must be created in advance by using the CreateCustomAttribute API. For example, after you create a custom attribute with the ID `custom-attribute:owner_name`, you can configure the custom attribute by setting this parameter to {\'owner\\_name\': \\[\'Bob\']}.>', + 'required' => false, + 'example' => '', + ], + ], + 'description' => 'An object that represents a metadata entity.', + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => true, - 'example' => '123456', + 'maxItems' => 5, + 'minItems' => 1, + 'title' => '', + 'description' => 'An entity list. You can create up to five entities in a batch. All entities in the batch must have the same `EntityType`.', + 'example' => '[]', ], ], ], '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' => 'AFBB799F-8578-51C5-A766-E922EDB8XXXX'."\n", + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '9E0C8E7A-C6BE-5A73-9562-2A030A80E8C6'], + 'Success' => ['description' => 'Indicates whether the request was successful. This parameter returns `true` even if creating some entities fails. To determine the outcome for each entity, check the `Success` and `ErrorMessage` fields in the `Results` array.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'Results' => [ + 'type' => 'array', + 'items' => ['description' => 'The result of a single entity creation within the batch.', '$ref' => '#/components/schemas/MetaEntityWriteResult', 'title' => '', 'example' => ''], + 'title' => '', + 'description' => 'A list of results for the batch creation operation. This list provides the success status and any error messages for each individual entity in the request.', + 'example' => '', ], ], + 'title' => '', + 'description' => 'The response body.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'BatchCreateMetaEntities', + 'description' => 'You must purchase DataWorks Professional Edition or a higher edition to use this operation.', + 'requestParamsDescription' => '## Extended database'."\n" + ."\n" + .'Set the `EntityType` to `custom_xxx-database`. The `xxx` placeholder is derived from an existing extended entity definition (EntityDef) for a table, such as `custom_xxx-table`.'."\n" + ."\n" + .'### Attributes'."\n" + ."\n" + .'| Attribute key | Required | Type | Description |'."\n" + .'| ---------------------------- | -------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------ |'."\n" + .'| `parentMetaEntityId` | Yes | String | The parent instance ID. It must be at the instance level and cannot contain catalog, database, schema, table, or column identifiers. |'."\n" + .'| `technicalMetadata.location` | No | String | The storage location of the database. |'."\n" + ."\n" + .'## Extended table'."\n" + ."\n" + .'Set the `EntityType` to `custom_xxx-table`. You must also register the table columns by using the `Attributes.columns` parameter.'."\n" + ."\n" + .'### Attributes'."\n" + ."\n" + .'| Attribute key | Required | Type | Description |'."\n" + .'| ---------------------------------------- | -------- | ------------------------------ | ------------------------------------------------------------------------------------------------------ |'."\n" + .'| `parentMetaEntityId` | Yes | String | The parent database ID. It must be at the database level. |'."\n" + .'| `tableType` | No | String | The table type. If you do not set this parameter, the default value TABLE is used. |'."\n" + .'| `partitionKeys` | No | JSON array string | The partition keys. Example: `["dt"]`. |'."\n" + .'| `technicalMetadata.location` | No | String | The storage location. |'."\n" + .'| `technicalMetadata.compressed` | No | Boolean string or JSON boolean | Specifies whether the data is compressed. |'."\n" + .'| `technicalMetadata.inputFormat` | No | String | The input format. |'."\n" + .'| `technicalMetadata.outputFormat` | No | String | The output format. |'."\n" + .'| `technicalMetadata.serializationLibrary` | No | String | The serialization/deserialization (SerDe) library. |'."\n" + .'| `technicalMetadata.parameters` | No | JSON object string | Parameter information. Example: `{"retention":"30"}`. |'."\n" + .'| `columns` | No | JSON array string | A list of embedded columns. Use this parameter to register extended columns when the table is created. |'."\n" + ."\n" + .'### Attributes.columns'."\n" + ."\n" + .'The `columns` parameter is a JSON array string within `Attributes`. Each object in the array supports the following fields:'."\n" + ."\n" + .'| Parameter | Required | Type | Description |'."\n" + .'| ------------------ | -------- | ------- | ----------------------------------------------------------------------------------------------------------- |'."\n" + .'| `name` | Yes | String | The column name. If this property is empty, the column is skipped. |'."\n" + .'| `type` | Yes | String | The column type. If this property is missing, the system reports an error for `attributes.columns[i].type`. |'."\n" + .'| `comment` | No | String | The column comment. |'."\n" + .'| `position` | No | Integer | The position of the column. If not specified, it defaults to the array index `i + 1`. |'."\n" + .'| `partitionKey` | No | Boolean | Specifies whether the column is a partition key. |'."\n" + .'| `primaryKey` | No | Boolean | Specifies whether the column is a primary key. |'."\n" + .'| `customAttributes` | No | Object | The custom attribute values for the column. |'."\n" + ."\n" + .'## Examples'."\n" + ."\n" + .'### Create an extended database'."\n" + ."\n" + .'```json'."\n" + .'{'."\n" + .' "Entities": ['."\n" + .' {'."\n" + .' "EntityType": "custom_demo-database",'."\n" + .' "Name": "ods",'."\n" + .' "Comment": "ODS database",'."\n" + .' "Attributes": {'."\n" + .' "parentMetaEntityId": "custom_demo:demo_source",'."\n" + .' "technicalMetadata.location": "oss://bucket/ods"'."\n" + .' },'."\n" + .' "CustomAttributes": {'."\n" + .' "biz_owner": ["data_team"]'."\n" + .' }'."\n" + .' }'."\n" + .' ]'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'### Create an extended table and columns'."\n" + ."\n" + .'```json'."\n" + .'{'."\n" + .' "Entities": ['."\n" + .' {'."\n" + .' "EntityType": "custom_demo-table",'."\n" + .' "Name": "order_fact",'."\n" + .' "Comment": "Order fact table",'."\n" + .' "Attributes": {'."\n" + .' "parentMetaEntityId": "custom_demo-database:demo_source::ods",'."\n" + .' "tableType": "TABLE",'."\n" + .' "partitionKeys": "[\\"dt\\"]",'."\n" + .' "technicalMetadata.location": "oss://bucket/ods/order_fact",'."\n" + .' "technicalMetadata.compressed": "true",'."\n" + .' "technicalMetadata.parameters": "{\\"retention\\":\\"30\\",\\"bizDomain\\":\\"trade\\"}",'."\n" + .' "columns": "[{\\"name\\":\\"id\\",\\"type\\":\\"BIGINT\\",\\"comment\\":\\"Primary key\\",\\"position\\":1,\\"primaryKey\\":true,\\"customAttributes\\":{\\"security_level\\":[\\"P1\\"]}},{\\"name\\":\\"dt\\",\\"type\\":\\"STRING\\",\\"comment\\":\\"Partition date\\",\\"position\\":2,\\"partitionKey\\":true}]"'."\n" + .' },'."\n" + .' "CustomAttributes": {'."\n" + .' "biz_owner": ["data_team"]'."\n" + .' }'."\n" + .' }'."\n" + .' ]'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'## Usage notes'."\n" + ."\n" + .'- The `parentMetaEntityId` for an extended database must be at the instance level, such as `custom_demo:demo_source`.'."\n" + ."\n" + .'- The `parentMetaEntityId` for an extended table must be at the database level, such as `custom_demo-database:demo_source::ods`.'."\n" + ."\n" + .'- Parent and child entities must belong to the same extension family. For example, the parent of a `custom_demo-table` entity must be a `custom_demo-database` entity.'."\n" + ."\n" + .'- The `columns` parameter can be provided only when you create a table. You cannot use the `BatchCreateMetaEntities` operation to create `custom_xxx-column` entities separately.'."\n" + ."\n" + .'- For extended entities, the write path does not strictly block unknown keys in the `Attributes` parameter based on `MetaEntityDef.AttributeDefs`. Unknown keys are typically ignored.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AFBB799F-8578-51C5-A766-E922EDB8XXXX\\\\n\\"\\n}","type":"json"}]', - 'title' => 'DeleteProject', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9E0C8E7A-C6BE-5A73-9562-2A030A80E8C6\\",\\n \\"Success\\": true,\\n \\"Results\\": [\\n {\\n \\"Name\\": \\"entity_01\\",\\n \\"EntityType\\": \\"custom_entity-demo\\",\\n \\"Id\\": \\"custom_entity-demo:entity_01\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'GetProject' => [ - 'summary' => 'Queries the information about a DataWorks workspace.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'BatchDeleteMetaEntities' => [ + 'summary' => 'Deletes multiple meta entities in a batch. This operation deletes custom meta entities and extended table-based objects, such as databases and tables. You cannot delete a column individually. Instead, you must delete the entire table to remove its associated columns.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '244495', - 'abilityTreeNodes' => [ - 'FEATUREdideYTM537', - ], + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdideX3KVYR'], + 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'query', + 'name' => 'Ids', + 'in' => 'formData', + 'style' => 'simple', 'schema' => [ - 'description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://dataworks.console.aliyun.com/workspace/list) 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', + 'type' => 'array', + 'items' => ['description' => 'The ID of the meta entity.', 'type' => 'string', 'required' => false, 'example' => 'custom_entity-demo:entity_01', 'title' => ''], 'required' => true, - 'example' => '123456', + 'maxItems' => 10, + 'minItems' => 1, + 'title' => '', + 'description' => 'An array of IDs for the meta entities to delete. You can specify up to 10 IDs in a single request. All entities in the batch must have the same EntityType.', + 'example' => '', ], ], ], '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 locate logs and troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n", - ], - 'Project' => [ - 'description' => 'The information about the workspace.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '28477242', - ], - 'Name' => [ - 'description' => 'The name of the workspace.'."\n", - 'type' => 'string', - 'example' => 'sora_finance', - ], - 'DisplayName' => [ - 'description' => 'The display name of the workspace.'."\n", - 'type' => 'string', - 'example' => 'Sora financial analysis', - ], - 'Description' => [ - 'description' => 'The description of the workspace.'."\n", - 'type' => 'string', - 'example' => 'Financial analysis group project data development', - ], - 'Owner' => [ - 'description' => 'The ID of the Alibaba Cloud account to which the workspace belongs.'."\n", - 'type' => 'string', - 'example' => '207947397706614299', - ], - 'AliyunResourceGroupId' => [ - 'description' => 'The ID of the Alibaba Cloud resource group to which the workspace belongs.'."\n", - 'type' => 'string', - 'example' => 'rg-acfmzbn7pti3zfa', - ], - 'Status' => [ - 'description' => 'The status of the workspace. Valid values:'."\n" - ."\n" - .'* Available'."\n" - .'* Initializing'."\n" - .'* InitFailed'."\n" - .'* Forbidden'."\n" - .'* Deleting'."\n" - .'* DeleteFailed'."\n" - .'* Frozen'."\n" - .'* Updating'."\n" - .'* UpdateFailed'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Available', - ], - 'PaiTaskEnabled' => [ - 'description' => 'Indicates whether scheduling of PAI tasks is enabled. Valid values:'."\n" - ."\n" - .'* true: Scheduling of PAI tasks is enabled. In this case, you can create a PAI node in a DataWorks workspace and configure scheduling properties for the node to implement periodic scheduling of PAI tasks.'."\n" - .'* false: Scheduling of PAI tasks is disabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'DevEnvironmentEnabled' => [ - 'description' => 'Indicates whether the development environment is enabled. Valid values:'."\n" - ."\n" - .'* true: The development environment is enabled. In this case, the development environment is isolated from the production environment in the workspace.'."\n" - .'* false: The development environment is disabled. In this case, only the production environment is used in the workspace.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'DevRoleDisabled' => [ - 'description' => 'Indicates whether the Develop role is disabled. Valid values:'."\n" - ."\n" - .'* false'."\n" - .'* true', - 'type' => 'boolean', - 'example' => 'false', - ], - 'AliyunResourceTags' => [ - 'description' => 'The tags.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The tag.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'batch', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => 'blue', - ], - ], - ], - ], - ], + 'RequestId' => ['description' => 'The unique identifier of the request.', 'type' => 'string', 'title' => '', 'example' => '1FC02D76-4A94-5D97-B52C-00A031B95359'], + 'Success' => ['description' => 'Indicates whether the request was successful. This parameter returns true even if the deletion of some entities fails. To check the status of each individual deletion, see the Success and ErrorMessage fields in the Results array.', 'type' => 'boolean', 'title' => '', 'example' => '[]'], + 'Results' => [ + 'type' => 'array', + 'items' => ['description' => 'The deletion result for a single entity.', '$ref' => '#/components/schemas/MetaEntityWriteResult', 'title' => '', 'example' => ''], + 'title' => '', + 'description' => 'An array of deletion results, one for each requested entity. Each result indicates whether the deletion was successful and includes an error message upon failure.', + 'example' => '', ], ], + 'title' => '', + 'description' => 'The response object.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'BatchDeleteMetaEntities', + 'description' => 'This operation requires DataWorks Professional Edition or higher.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A1****\\",\\n \\"Project\\": {\\n \\"Id\\": 28477242,\\n \\"Name\\": \\"sora_finance\\",\\n \\"DisplayName\\": \\"Sora financial analysis\\",\\n \\"Description\\": \\"Financial analysis group project data development\\",\\n \\"Owner\\": \\"207947397706614299\\",\\n \\"AliyunResourceGroupId\\": \\"rg-acfmzbn7pti3zfa\\",\\n \\"Status\\": \\"Available\\",\\n \\"PaiTaskEnabled\\": true,\\n \\"DevEnvironmentEnabled\\": true,\\n \\"DevRoleDisabled\\": false,\\n \\"AliyunResourceTags\\": [\\n {\\n \\"Key\\": \\"batch\\",\\n \\"Value\\": \\"blue\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'GetProject', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1FC02D76-4A94-5D97-B52C-00A031B95359\\",\\n \\"Success\\": true,\\n \\"Results\\": [\\n {\\n \\"Name\\": \\"entity_01\\",\\n \\"EntityType\\": \\"custom_entity-demo\\",\\n \\"Id\\": \\"custom_entity-demo:entity_01\\",\\n \\"Success\\": true,\\n \\"ErrorMessage\\": \\"The specified parameters are invalid.\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'ListProjects' => [ - 'summary' => 'Queries a list of DataWorks workspaces of the tenant to which your account belongs.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'BatchUpdateTasks' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '244496', - 'abilityTreeNodes' => [ - 'FEATUREdideYTM537', - ], - 'tenantRelevance' => 'publicInformation', + 'operationType' => 'update', + 'abilityTreeCode' => '250636', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB', 'FEATUREdideD0YY7B', 'FEATUREdideVFMENL'], ], 'parameters' => [ [ - 'name' => 'Ids', + 'name' => 'Tasks', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'The IDs of the DataWorks workspaces.'."\n", + 'description' => 'The list of tasks.', 'type' => 'array', 'items' => [ - 'description' => 'The ID of the DataWorks workspace. You can log on to the [DataWorks console](https://dataworks.console.aliyun.com/workspace/list) and go to the Workspace page to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123456', - ], - 'required' => false, - ], - ], - [ - 'name' => 'Names', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The names of the DataWorks workspaces.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The name of the DataWorks workspace. You can log on to the [DataWorks console](https://dataworks.console.aliyun.com/workspace/list) and go to the Workspace page to query the name.'."\n", - 'type' => 'string', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234', 'title' => ''], + 'EnvType' => [ + 'description' => 'The project environment.'."\n" + ."\n" + .'- Prod: Production'."\n" + ."\n" + .'- Dev: Development', + 'enumValueTitles' => [], + 'type' => 'string', + 'default' => 'Prod', + 'enum' => ['Prod', 'Dev'], + 'required' => false, + 'example' => 'Prod', + 'title' => '', + ], + 'Name' => ['description' => 'The name.', 'type' => 'string', 'required' => false, 'example' => 'SQL node', 'title' => ''], + 'Description' => ['description' => 'The description.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'Owner' => ['description' => 'The account ID of the task owner.', 'type' => 'string', 'required' => false, 'example' => '1000', 'title' => ''], + 'Timeout' => ['description' => 'The task execution timeout in seconds. The value should be greater than 3600.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3600', 'title' => ''], + 'RerunMode' => [ + 'description' => 'The rerun mode. Valid values:'."\n" + ."\n" + .'- AllDenied: The task cannot be rerun.'."\n" + ."\n" + .'- FailureAllowed: The task can be rerun only after it fails.'."\n" + ."\n" + .'- AllAllowed: The task can always be rerun.', + 'enumValueTitles' => [], + 'type' => 'string', + 'enum' => ['AllAllowed', 'FailureAllowed', 'AllDenied'], + 'required' => false, + 'example' => 'AllAllowed', + 'title' => '', + ], + 'RerunTimes' => ['description' => 'The number of retry attempts. Takes effect when the task is configured to allow reruns.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + 'RerunInterval' => ['description' => 'The retry interval in seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60', 'title' => ''], + 'Trigger' => [ + 'description' => 'The task trigger configurations.', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The trigger type. Valid values:'."\n" + ."\n" + .'- Scheduler: periodically triggered'."\n" + ."\n" + .'- Manual', + 'enumValueTitles' => [], + 'type' => 'string', + 'enum' => ['Scheduler', 'Manual'], + 'required' => false, + 'example' => 'Scheduler', + 'title' => '', + ], + 'Recurrence' => [ + 'description' => 'The running mode of the task after it is triggered. This parameter takes effect only if the Type parameter is set to Scheduler. Valid values:'."\n" + ."\n" + .'- Pause'."\n" + ."\n" + .'- Skip'."\n" + ."\n" + .'- Normal', + 'enumValueTitles' => [], + 'type' => 'string', + 'enum' => ['Normal', 'Skip', 'Pause'], + 'required' => false, + 'example' => 'Normal', + 'title' => '', + ], + 'Cron' => ['description' => 'The cron expression. Takes effect when type=Scheduler.', 'type' => 'string', 'required' => false, 'example' => '00 00 00 * * ?', 'title' => ''], + 'StartTime' => ['description' => 'The time when periodic triggering takes effect. This parameter takes effect only if the Type parameter is set to Scheduler. The value of this parameter is in the `yyyy-mm-dd hh:mm:ss` format.', 'type' => 'string', 'required' => false, 'example' => '1970-01-01 00:00:00', 'title' => ''], + 'EndTime' => ['description' => 'The expiration time of periodic triggering. Takes effect only when type is set to Scheduler. The value of this parameter is in the`yyyy-mm-dd hh:mm:ss` format.', 'type' => 'string', 'required' => false, 'example' => '9999-01-01 00:00:00', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'RuntimeResource' => [ + 'description' => 'Runtime environment configurations, such as resource group information.', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupId' => ['description' => 'The identifier of the scheduling resource group used in the task runtime configuration.', 'type' => 'string', 'required' => false, 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', 'title' => ''], + 'Image' => ['description' => 'The image ID used in the task runtime configuration.', 'type' => 'string', 'required' => false, 'example' => 'i-xxxxxx', 'title' => ''], + 'Cu' => ['description' => 'The default number of compute units (CUs) configured for task running.', 'type' => 'string', 'required' => false, 'example' => '0.25', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'DataSource' => [ + 'description' => 'Associated data source information.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The data source name.', 'type' => 'string', 'required' => false, 'example' => 'odps_test', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Tags' => [ + 'description' => 'The list of task tags.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => true, 'example' => 'key1', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'value1', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], 'required' => false, - 'example' => 'sora_finance', + 'description' => '', + 'title' => '', + 'example' => '', ], 'required' => false, + 'maxItems' => 50, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'AliyunResourceGroupId', + 'name' => 'Comment', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the Alibaba Cloud resource group to which the workspaces belong. You can log on to the [Resource Management console](https://resourcemanager.console.aliyun.com/resource-groups) and go to the Resource Group page to query the ID.'."\n" - ."\n" - .'This parameter is used to query the information about workspaces that belong to a specific resource group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfmzbn7pti3zff', - ], + 'schema' => ['description' => 'The remarks.', 'type' => 'string', 'required' => false, 'example' => 'this is a comment'."\n", 'title' => ''], ], - [ - 'name' => 'Status', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The status of the workspaces. Valid values:'."\n" - ."\n" - .'* Available'."\n" - .'* Initializing'."\n" - .'* InitFailed'."\n" - .'* Forbidden'."\n" - .'* Deleting'."\n" - .'* DeleteFailed'."\n" - .'* Frozen'."\n" - .'* Updating'."\n" - .'* UpdateFailed', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Available', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX', 'title' => ''], + 'SuccessInfo' => [ + 'description' => 'The result of the batch operation, which is in the MAP structure. The task ID serves as a key, and the result serves as a value.', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The task does not exist.', 'title' => ''], + ], + 'description' => 'The result.', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"SuccessInfo\\": {\\n \\"key\\": {\\n \\"Success\\": true,\\n \\"Message\\": \\"The task does not exist.\\"\\n }\\n }\\n}","type":"json"}]', + 'title' => 'BatchUpdateTasks', + 'summary' => 'Performs incremental updates on multiple tasks at a time.', + 'description' => 'DataWorks Basic Edition or higher is required.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'CancelAgentSession' => [ + 'summary' => 'Cancels an agent call in a specified session. This operation also supports interrupting an ongoing streaming response.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'DevEnvironmentEnabled', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether the development environment is enabled. Valid values:'."\n" - ."\n" - .'* true: The development environment is enabled. In this case, the development environment is isolated from the production environment in a workspace.'."\n" - .'* false: The development environment is disabled. In this case, only the production environment is used in a workspace.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdideEWGMTH'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ [ - 'name' => 'DevRoleDisabled', + 'name' => 'Jsonrpc', 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether the Develop role is disabled. Valid values:'."\n" - ."\n" - .'* false (default)'."\n" - .'* true'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The JSON-RPC version. Fixed value: 2.0.', 'type' => 'string', 'required' => false, 'example' => '2.0', 'title' => ''], ], [ - 'name' => 'PaiTaskEnabled', + 'name' => 'Id', 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether scheduling of Platform for AI (PAI) tasks is enabled. Valid values:'."\n" - ."\n" - .'* true: Scheduling of PAI tasks is enabled. In this case, you can create a PAI node in a DataWorks workspace and configure scheduling properties for the node to implement periodic scheduling of PAI tasks.'."\n" - .'* false: Scheduling of PAI tasks is disabled.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The ID passed by the requester. The value is returned as-is in the response.', 'type' => 'string', 'required' => false, 'example' => '676303114031776', 'title' => ''], ], [ - 'name' => 'AliyunResourceTags', + 'name' => 'Params', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'The tags.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The tag. You can log on to the [Resource Management console](https://resourcemanager.console.aliyun.com/tags) and go to the Tag page to query the tag key and tag value.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'batch', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'blue', - ], - ], - 'required' => false, + 'type' => 'object', + 'properties' => [ + 'SessionId' => ['description' => 'The ID of the session to cancel. This parameter is required.', 'type' => 'string', 'required' => false, 'example' => 'sess_0f12abc34', 'title' => ''], ], + 'description' => 'The business parameters of the request.', 'required' => false, - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - '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, - 'example' => '10', - 'default' => '10', + 'title' => '', + 'example' => '', ], ], ], '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' => '6D24AD9A-652F-59E2-AC1F-05029300F8A4', - ], - 'PagingInfo' => [ - 'description' => 'The pagination information.'."\n", + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '7CD3D216-5876-5DB1-A34A-396806F4A413'], + 'JsonRpcResponse' => [ 'type' => 'object', 'properties' => [ - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'Projects' => [ - 'description' => 'The workspaces.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The workspace.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123456', - ], - 'Name' => [ - 'description' => 'The name of the workspace.'."\n", - 'type' => 'string', - 'example' => 'sora_finance', - ], - 'DisplayName' => [ - 'description' => 'The display name of the workspace.'."\n", - 'type' => 'string', - 'example' => 'Sora financial analysis'."\n", - ], - 'Description' => [ - 'description' => 'The description of the workspace.'."\n", - 'type' => 'string', - 'example' => 'Financial analysis group project data development', - ], - 'Owner' => [ - 'description' => 'The ID of the Alibaba Cloud account to which the workspace belongs.'."\n", - 'type' => 'string', - 'example' => '123532153125', - ], - 'AliyunResourceGroupId' => [ - 'description' => 'The ID of the Alibaba Cloud resource group to which the workspace belongs.'."\n", - 'type' => 'string', - 'example' => 'rg-acfmzbn7pti3zfa', - ], - 'Status' => [ - 'description' => 'The status of the workspace. Valid values:'."\n" - ."\n" - .'* Available'."\n" - .'* Initializing'."\n" - .'* InitFailed'."\n" - .'* Forbidden'."\n" - .'* Deleting'."\n" - .'* DeleteFailed'."\n" - .'* Frozen'."\n" - .'* Updating'."\n" - .'* UpdateFailed'."\n", - 'type' => 'string', - 'example' => 'Available', - ], - 'PaiTaskEnabled' => [ - 'description' => 'Indicates whether scheduling of PAI tasks is enabled. Valid values:'."\n" - ."\n" - .'* true: Scheduling of PAI tasks is enabled. In this case, you can create a PAI node in a DataWorks workspace and configure scheduling properties for the node to implement periodic scheduling of PAI tasks.'."\n" - .'* false: Scheduling of PAI tasks is disabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'DevEnvironmentEnabled' => [ - 'description' => 'Indicates whether the development environment is enabled. Valid values:'."\n" - ."\n" - .'* true: The development environment is enabled. In this case, the development environment is isolated from the production environment in the workspace.'."\n" - .'* false: The development environment is disabled. In this case, only the production environment is used in the workspace.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'DevRoleDisabled' => [ - 'description' => 'Indicates whether the Develop role is disabled. Valid values:'."\n" - ."\n" - .'* false (default)'."\n" - .'* true'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'AliyunResourceTags' => [ - 'description' => 'The tags.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The tag.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'batch', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => 'blue', - ], - ], - ], - ], - ], + 'Jsonrpc' => ['description' => 'The JSON-RPC version. Fixed value: 2.0.', 'type' => 'string', 'example' => '2.0', 'title' => ''], + 'Id' => ['description' => 'The ID passed by the requester. The value is returned as-is in the response.', 'type' => 'string', 'example' => '7675839888324361477', 'title' => ''], + 'Result' => [ + 'type' => 'object', + 'properties' => [ + 'SessionId' => ['description' => 'The session ID.', 'type' => 'string', 'example' => 'session-d5d549fe4c2c4180a9814fb74190f502', 'title' => ''], ], + 'description' => 'The result object of the session cancellation.', + 'title' => '', + 'example' => '', ], ], + 'description' => 'The JSON-RPC response.', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => 'Schema of Response', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CancelAgentSession', + 'description' => '## Description'."\n" + ."\n" + .'- This operation is used to actively interrupt an ongoing session, especially when the session is generating a streaming response.'."\n" + ."\n" + .'- `sessionId` is a required parameter that identifies the specific session to cancel.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6D24AD9A-652F-59E2-AC1F-05029300F8A4\\",\\n \\"PagingInfo\\": {\\n \\"PageSize\\": 1,\\n \\"PageNumber\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Projects\\": [\\n {\\n \\"Id\\": 123456,\\n \\"Name\\": \\"sora_finance\\",\\n \\"DisplayName\\": \\"Sora financial analysis\\\\n\\",\\n \\"Description\\": \\"Financial analysis group project data development\\",\\n \\"Owner\\": \\"123532153125\\",\\n \\"AliyunResourceGroupId\\": \\"rg-acfmzbn7pti3zfa\\",\\n \\"Status\\": \\"Available\\",\\n \\"PaiTaskEnabled\\": true,\\n \\"DevEnvironmentEnabled\\": true,\\n \\"DevRoleDisabled\\": false,\\n \\"AliyunResourceTags\\": [\\n {\\n \\"Key\\": \\"batch\\",\\n \\"Value\\": \\"blue\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListProjects', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7CD3D216-5876-5DB1-A34A-396806F4A413\\",\\n \\"JsonRpcResponse\\": {\\n \\"Jsonrpc\\": \\"2.0\\",\\n \\"Id\\": \\"7675839888324361477\\",\\n \\"Result\\": {\\n \\"SessionId\\": \\"session-d5d549fe4c2c4180a9814fb74190f502\\"\\n }\\n }\\n}","type":"json"}]', ], - 'GetProjectRole' => [ - 'summary' => 'Queries the information about a role in a DataWorks workspace.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'CloneDataSource' => [ + 'summary' => 'Clones a data source to create a new data source with the same configurations.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '244504', - 'abilityTreeNodes' => [ - 'FEATUREdideYTM537', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '232442', + 'abilityTreeNodes' => ['FEATUREdideRWC5F7'], ], 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'Id', '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, - 'example' => '10002', - ], + 'schema' => ['description' => 'The data source ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1603612', 'title' => ''], ], [ - 'name' => 'Code', + 'name' => 'CloneDataSourceName', 'in' => 'query', - 'schema' => [ - 'description' => 'The code of the role in the DataWorks workspace. Valid values:'."\n" - ."\n" - .'* role_project_admin: workspace administrator'."\n" - .'* role_project_dev: developer'."\n" - .'* role_project_dg_admin: data governance administrator'."\n" - .'* role_project_guest: visitor'."\n" - .'* role_project_security: security administrator'."\n" - .'* role_project_deploy: deployer'."\n" - .'* role_project_owner: workspace owner'."\n" - .'* role_project_data_analyst: data analyst'."\n" - .'* role_project_pe: O\\&M engineer'."\n" - .'* role_project_erd: model designer'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [], - 'example' => 'role_project_guest', - ], + 'schema' => ['description' => 'The name of the destination data source The name can contain letters, digits, and underscores (\\_), and must start with a letter. It cannot exceed 60 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'demo_holo_datasource', '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' => '82F28E60-CF48-5EDF-AB25-D806847B97D1', - ], - 'ProjectRole' => [ - 'description' => 'The role in the DataWorks workspace.'."\n", - 'type' => 'object', - 'properties' => [ - 'ProjectId' => [ - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10002', - ], - 'Code' => [ - 'description' => 'The code of the role in the DataWorks workspace.'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'role_project_guest', - ], - 'Name' => [ - 'description' => 'The name of the role in the DataWorks workspace.'."\n", - 'type' => 'string', - 'example' => 'Visitors', - ], - 'Type' => [ - 'description' => 'The type of the role in the DataWorks workspace. Valid values:'."\n" - ."\n" - .'* UserCustom: user-defined role'."\n" - .'* System: system role'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'System', - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID. You can use this ID to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => 'FCD583B9-346B-5E75-82C1-4A7C192C48DB'], + 'Id' => ['description' => 'The ID of the cloned data source.', 'type' => 'integer', 'format' => 'int64', 'example' => '19715', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FCD583B9-346B-5E75-82C1-4A7C192C48DB\\",\\n \\"Id\\": 19715\\n}","type":"json"}]', + 'title' => 'CloneDataSource', + 'description' => '1. This operation is available for all DataWorks editions.'."\n" + ."\n" + .'2. To call this operation, you must have one of the following roles in DataWorks:'."\n" + ."\n" + .'- Tenant Owner, Workspace Administrator, Workspace Owner, and O\\&M', + 'changeSet' => [ + ['createdAt' => '2024-12-19T09:00:15.000Z', 'description' => 'Request parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82F28E60-CF48-5EDF-AB25-D806847B97D1\\",\\n \\"ProjectRole\\": {\\n \\"ProjectId\\": 10002,\\n \\"Code\\": \\"role_project_guest\\",\\n \\"Name\\": \\"Visitors\\",\\n \\"Type\\": \\"System\\"\\n }\\n}","type":"json"}]', - 'title' => 'GetProjectRole', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", - ], - 'ListProjectRoles' => [ - 'summary' => 'Queries the information about roles in a DataWorks workspace by page.', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:CloneDataSource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateAgent' => [ + 'summary' => 'Create Agent', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '244505', - 'abilityTreeNodes' => [ - 'FEATUREdideYTM537', - ], - 'tenantRelevance' => 'tenant', + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => 'TBD', + 'abilityTreeNodes' => ['FEATUREdideYTM537'], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'Name', '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" - ."\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, - 'example' => '21229', - ], + 'schema' => ['description' => 'The name of the Agent. It must be unique under the current account.'."\n", 'type' => 'string', 'required' => true, 'example' => 'my-agent', 'title' => ''], ], [ - 'name' => 'Codes', + 'name' => 'DisplayName', + 'in' => 'formData', + 'schema' => ['description' => 'The display name of the Agent.'."\n", 'type' => 'string', 'required' => false, 'example' => '我的助手', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['description' => 'The description of the Agent.'."\n", 'type' => 'string', 'required' => false, 'example' => '数据分析助手', 'title' => ''], + ], + [ + 'name' => 'Model', + 'in' => 'formData', + 'style' => 'json', + 'schema' => ['description' => 'The model configuration.'."\n", 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "modelName": "dataworks-public-bailian/qwen-max"'."\n" + .' }', 'title' => ''], + ], + [ + 'name' => 'SystemPrompt', + 'in' => 'formData', + 'schema' => ['description' => 'The system prompt.'."\n", 'type' => 'string', 'required' => false, 'example' => '你是一个数据分析助手。', 'title' => ''], + ], + [ + 'name' => 'Tools', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'The codes of roles in the DataWorks workspace.'."\n", + 'description' => 'The list of tools.'."\n", 'type' => 'array', - 'items' => [ - 'description' => 'The code of the role in the DataWorks workspace. Valid values:'."\n" - ."\n" - .'* role_project_admin: workspace administrator'."\n" - .'* role_project_dev: developer'."\n" - .'* role_project_dg_admin: data governance administrator'."\n" - .'* role_project_guest: visitor'."\n" - .'* role_project_security: security administrator'."\n" - .'* role_project_deploy: deployer'."\n" - .'* role_project_owner: workspace owner'."\n" - .'* role_project_data_analyst: data analyst'."\n" - .'* role_project_pe: O\\&M engineer'."\n" - .'* role_project_erd: model designer'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'role_project_guest', - ], + 'items' => ['description' => 'Tool information.', 'type' => 'string', 'required' => false, 'example' => '-', 'title' => ''], 'required' => false, + 'example' => '-', + 'title' => '', ], ], [ - 'name' => 'Names', + 'name' => 'Skills', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'The names of roles in the DataWorks workspace.'."\n", + 'description' => 'The list of skills.'."\n", 'type' => 'array', - 'items' => [ - 'description' => 'The name of the role in the DataWorks workspace.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Visitors', - ], + 'items' => ['description' => 'Skill configuration.', 'type' => 'string', 'required' => false, 'example' => '["my-skill"]', 'title' => ''], 'required' => false, + 'example' => '-', + 'title' => '', ], ], [ - 'name' => 'Type', + 'name' => 'CallableAgents', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The type of the role. Valid values:'."\n" - ."\n" - .'* UserCustom: user-defined role'."\n" - .'* System: system role'."\n", - 'type' => 'string', + 'description' => 'The list of sub-Agents that can be called by this Agent.'."\n", + 'type' => 'array', + 'items' => ['description' => 'Agent name.', 'type' => 'string', 'required' => false, 'example' => '["agent-name"]', 'title' => ''], 'required' => false, - 'enumValueTitles' => [], - 'example' => 'System', + 'example' => '-', + 'title' => '', ], ], [ - 'name' => 'PageNumber', + 'name' => 'Metadata', + 'in' => 'formData', + 'style' => 'json', + 'schema' => ['description' => 'Extended metadata (key-value pairs).'."\n", 'type' => 'object', 'required' => false, 'example' => '{}', 'title' => ''], + ], + [ + 'name' => 'Visibility', 'in' => 'formData', 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The visibility level.
'."\n" + .'`TENANT`: Visible within the account.
'."\n" + .'`PROJECT`: Visible to specified projects.
'."\n" + .'`USER`: Visible to specified users.'."\n", + 'type' => 'string', 'required' => false, - 'example' => '1', + 'enum' => ['TENANT', 'PROJECT', 'USER'], + 'example' => 'TENANT', + 'title' => '', ], ], [ - 'name' => 'PageSize', + 'name' => 'VisibilityScope', '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 visibility scope. The corresponding field is selected based on Visibility.'."\n", + 'type' => 'object', + 'properties' => [ + 'ProjectIds' => [ + 'description' => 'The list of visible project IDs. Takes effect when Visibility is `PROJECT`.'."\n", + 'type' => 'array', + 'items' => ['description' => 'List of workspace IDs.', 'type' => 'string', 'required' => false, 'example' => '[21791]', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'UserIds' => [ + 'description' => 'The list of visible user IDs. Takes effect when Visibility is `USER`.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The list of visible user IDs. Takes effect when Visibility is USER.', 'type' => 'string', 'required' => false, 'example' => '[]', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], 'required' => false, - 'example' => '10', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '61649187-0BCF-5E75-8D4B-64FDBEBBB447', - ], - 'PagingInfo' => [ - 'description' => 'The pagination information.'."\n", + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '824F80BA-1778-5D8A-BAFF-668A4D9C4CC7'], + 'Agent' => [ + 'description' => 'Details of the created Agent.', 'type' => 'object', 'properties' => [ - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'string', - 'example' => '42', - ], - 'ProjectRoles' => [ - 'description' => 'The roles in the DataWorks workspace.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The role in the DataWorks workspace.'."\n", - 'type' => 'object', - 'properties' => [ - 'ProjectId' => [ - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '21229', - ], - 'Code' => [ - 'description' => 'The code of the role in the DataWorks workspace.'."\n", - 'type' => 'string', - 'example' => 'role_project_guest'."\n", - ], - 'Name' => [ - 'description' => 'The name of the role.'."\n", - 'type' => 'string', - 'example' => 'Visitors', - ], - 'Type' => [ - 'description' => 'The type of the role in the DataWorks workspace.'."\n", - 'type' => 'string', - 'example' => 'System', - ], - ], - ], - ], + 'Name' => ['description' => 'The name of the Agent.'."\n", 'type' => 'string', 'example' => 'my-agent', 'title' => ''], + 'GmtCreateTime' => ['description' => 'The creation time (millisecond timestamp).'."\n", 'type' => 'string', 'format' => 'iso8601', 'example' => '1780555634000', 'title' => ''], + 'GmtModifiedTime' => ['description' => 'The last modification time (millisecond timestamp).'."\n", 'type' => 'string', 'format' => 'iso8601', 'example' => '1780555634000', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create Agent', + 'description' => '## Request Description'."\n" + .'- **Agent Name**: Must be unique under the current account.'."\n" + .'- **Model Configuration**: An optional parameter used to specify the model used by the Agent and its related settings.'."\n" + .'- **Visibility Level**: Defines who can access the Agent. Supports visibility within the account, to specified projects, or to specific users.'."\n" + .'- **Visibility Scope**: When `PROJECT` or `USER` is selected as the visibility level, the specific project ID or user ID list must be further specified.'."\n" + .'- **Other Parameters**: Items such as display name and description are optional and can be filled in based on actual needs.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"61649187-0BCF-5E75-8D4B-64FDBEBBB447\\",\\n \\"PagingInfo\\": {\\n \\"PageSize\\": \\"10\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"TotalCount\\": \\"42\\",\\n \\"ProjectRoles\\": [\\n {\\n \\"ProjectId\\": 21229,\\n \\"Code\\": \\"role_project_guest\\\\n\\",\\n \\"Name\\": \\"Visitors\\",\\n \\"Type\\": \\"System\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListProjectRoles', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"824F80BA-1778-5D8A-BAFF-668A4D9C4CC7\\",\\n \\"Agent\\": {\\n \\"Name\\": \\"my-agent\\",\\n \\"GmtCreateTime\\": \\"1780555634000\\",\\n \\"GmtModifiedTime\\": \\"1780555634000\\"\\n }\\n}","type":"json"}]', ], - 'CreateProjectMember' => [ - 'summary' => 'Adds a workspace member and assigns a workspace-level role to the member.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateAgentSession' => [ + 'summary' => 'Creates a new agent session and returns a session ID.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -5357,214 +3428,457 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', - 'abilityTreeCode' => '244498', - 'abilityTreeNodes' => [ - 'FEATUREdideYTM537', - ], - 'tenantRelevance' => 'tenant', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdideEWGMTH'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'Jsonrpc', '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" - ."\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, - 'example' => '24054', - ], + 'schema' => ['description' => 'The JSON-RPC version. The value is fixed at `2.0`.', 'type' => 'string', 'required' => false, 'example' => '2.0', 'title' => ''], ], [ - 'name' => 'UserId', + 'name' => 'Id', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the account that you want to add to the workspace as a member. You can log on to the [DataWorks console](https://dataworks.console.aliyun.com/product/ms_menu), choose More > Management Center in the left-side navigation pane, select the desired workspace on the Management Center page, and then click Go to Management Center. In the left-side navigation pane of the SettingCenter page, click **Tenant Members and Roles**. On the Tenant Members and Roles page, view the ID of the account that you want to add to the workspace as a member.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '123422344899', - ], + 'schema' => ['description' => 'The request ID provided by the client. This ID is returned in the response without modification.', 'type' => 'string', 'required' => false, 'example' => '4758330557805415712', 'title' => ''], ], [ - 'name' => 'RoleCodes', + 'name' => 'Params', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'The codes of the roles in the workspace. You can call the [ListProjectRoles](~~2853930~~) operation to query the codes of all roles in the workspace.'."\n" - ."\n" - .'This parameter specifies the roles that you can assign to a member when you add the member.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The code of a role in the workspace.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'role_project_guest', - ], - 'required' => true, - 'maxItems' => 10, - 'minItems' => 1, - ], - ], - ], - '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 query logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '2B2F0B26-9253-5780-B6DB-F1A886D44D6F', - ], - ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2B2F0B26-9253-5780-B6DB-F1A886D44D6F\\"\\n}","type":"json"}]', - 'title' => 'CreateProjectMember', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", - ], - 'DeleteProjectMember' => [ - 'summary' => 'Removes a workspace member and the workspace-level roles that are assigned to the member.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '244499', - 'abilityTreeNodes' => [ - 'FEATUREdideYTM537', - ], - 'tenantRelevance' => 'tenant', - ], - '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 query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '534752', - ], - ], - [ - 'name' => 'UserId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the account used by the member in the workspace. You can log on to the [DataWorks console](https://dataworks.console.aliyun.com/product/ms_menu), choose More > Management Center in the left-side navigation pane, select the desired workspace on the Management Center page, and then click Go to Management Center. In the left-side navigation pane of the SettingCenter page, click Tenant Members and Roles. On the **Tenant Members and Roles** page, view the ID of the account used by the member in the workspace.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '123422344899', + 'Meta' => [ + 'type' => 'object', + 'properties' => [ + 'Agent' => [ + 'type' => 'object', + 'properties' => [ + 'AgentName' => ['description' => 'The agent name to bind to the session. This parameter is required.', 'type' => 'string', 'required' => false, 'example' => 'chat_cli_chatbi', 'title' => ''], + ], + 'description' => 'The agent configuration for this session. The value must be one of the agents returned by the `ListAgents` API.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Config' => [ + 'type' => 'object', + 'properties' => [ + 'SessionSource' => ['description' => 'The identifier for the session source. This allows you to search for sessions by their source. For example, if you use an agent on multiple pages, such as Page A and Page B, you can use this parameter to filter and display only the sessions created on Page A. The identifier can be up to 128 characters and can contain letters, digits, hyphens (-), and underscores (\\_).', 'type' => 'string', 'required' => false, 'example' => 'openapi_sdk', 'title' => ''], + 'SessionTags' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SessionTagCode' => ['description' => 'The session tag. You can use session tags to filter sessions. For example, if your application calls the API with a fixed RAM sub-account but maintains its own user account system, you can pass a user\'s account ID as a tag. This allows you to filter the session list by your internal account IDs. The tag can be up to 128 characters and can contain letters, digits, hyphens (-), and underscores (\\_).', 'type' => 'string', 'required' => false, 'example' => 'chatbi', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => 'A list of session tags. You can use these tags to search and filter sessions.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The configuration parameters for the session, such as filters based on session source and session tags.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'InitialConfigOptions' => [ + 'type' => 'object', + 'properties' => [ + 'ExecutionLane' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'chat，cli', 'title' => ''], + 'Mode' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'yolo', 'title' => ''], + 'Skills' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'skill-name-1,skill-name2,skill-name-3', 'title' => ''], + 'ResourceGroupId' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => 'Serverless_res_group_123123123_564657857', 'title' => ''], + ], + 'description' => '', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The extended metadata, which includes information such as agent binding, session source, and session tags.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The business parameters.', + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], '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 query logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '1FF0465F-209C-5964-8F30-FAF21B677CC6', + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '8A9D5E6C-5817-5837-9715-6E3967EC6123'], + 'JsonRpcResponse' => [ + 'type' => 'object', + 'properties' => [ + 'Jsonrpc' => ['description' => 'The JSON-RPC version. The value is fixed at `2.0`.', 'type' => 'string', 'example' => '2.0', 'title' => ''], + 'Id' => ['description' => 'The request ID provided by the client. This ID is returned in the response without modification.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Result' => [ + 'type' => 'object', + 'properties' => [ + 'SessionId' => ['description' => 'The ID of the created session.', 'type' => 'string', 'example' => 'sess_0f12abc34', 'title' => ''], + ], + 'description' => 'The business data. This field is `null` if an error occurs.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The JSON-RPC response.', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => 'The response parameters.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1FF0465F-209C-5964-8F30-FAF21B677CC6\\"\\n}","type":"json"}]', - 'title' => 'DeleteProjectMember', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", - ], - 'GrantMemberProjectRoles' => [ - 'summary' => 'Assigns roles to members in a workspace.', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateAgentSession', + 'description' => '## Description'."\n" + ."\n" + .'- This API creates a new agent session.'."\n" + ."\n" + .'- You must specify the agent name to bind to the session using the `_meta.agent.agentName` parameter.'."\n" + ."\n" + .'- You can specify a session source identifier in the `_meta.config.sessionSource` parameter. This allows you to search for sessions by source later.'."\n" + ."\n" + .'- You can add session tags using the `_meta.config.sessionTags[].sessionTagCode` parameter.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataworks:CreateAgentSession', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8A9D5E6C-5817-5837-9715-6E3967EC6123\\",\\n \\"JsonRpcResponse\\": {\\n \\"Jsonrpc\\": \\"2.0\\",\\n \\"Id\\": \\"1\\",\\n \\"Result\\": {\\n \\"SessionId\\": \\"sess_0f12abc34\\"\\n }\\n }\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'CreateAlertRule' => [ + 'summary' => 'Creates a custom monitoring alert rule.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '244500', - 'abilityTreeNodes' => [ - 'FEATUREdideYTM537', - ], - 'tenantRelevance' => 'tenant', + 'operationType' => 'create', + 'abilityTreeCode' => '249177', + 'abilityTreeNodes' => ['FEATUREdideRJGWWC'], ], '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 query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '105149', - ], + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the rule.', 'type' => 'string', 'required' => true, 'example' => 'xm_create_test', 'title' => ''], ], [ - 'name' => 'UserId', - 'in' => 'formData', + 'name' => 'Owner', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the Alibaba Cloud account used by the owner of the rule.', 'type' => 'string', 'required' => true, 'example' => '279114181****', 'title' => ''], + ], + [ + 'name' => 'Enabled', + 'in' => 'query', + 'schema' => ['description' => 'Indicates whether the rule is enabled.', 'type' => 'boolean', 'required' => true, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'TriggerCondition', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://dataworks.console.aliyun.com/product/ms_menu), choose More > Management Center in the left-side navigation pane, select the desired workspace on the Management Center page, and then click Go to Management Center. In the left-side navigation pane of the SettingCenter page, click Tenant Members and Roles. On the Tenant Members and Roles page, view the IDs of the accounts used by the members in the workspace.'."\n", - 'type' => 'string', + 'description' => 'The alert triggering condition.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The alert type. Valid values:'."\n" + ."\n" + .'- Finished: An instance is successfully run.'."\n" + ."\n" + .'- UnFinished: An instance does not finish running before a specified point in time.'."\n" + ."\n" + .'- Error: An error occurs on an instance.'."\n" + ."\n" + .'- CycleUnfinished: An instance does not finish running as expected within a specific cycle.'."\n" + ."\n" + .'- Timeout: An instance times out.'."\n" + ."\n" + .'- InstanceTransferComplete: An instance is generated by the auto triggered node.'."\n" + ."\n" + .'- InstanceTransferFluctuate: The number of generated instances fluctuates.'."\n" + ."\n" + .'- ExhaustedError: An error persists after an instance is automatically rerun.'."\n" + ."\n" + .'- InstanceKeyword: An instance with errors contains specified keywords.'."\n" + ."\n" + .'- InstanceErrorCount: The number of instances on which an error occurs reaches a specified threshold.'."\n" + ."\n" + .'- InstanceErrorPercentage: The proportion of instances on which an error occurs in the workspace to the total number of instances reaches a specified threshold.'."\n" + ."\n" + .'- ResourceGroupPercentage: The usage rate of the resource group reaches a specified threshold.'."\n" + ."\n" + .'- ResourceGroupWaitCount: The number of instances that are waiting for resources in the resource group reaches a specified threshold.', 'type' => 'string', 'required' => false, 'example' => 'Error', 'title' => ''], + 'Extension' => [ + 'description' => 'The extended information about the rule. This parameter is required for specific types of alerts.', + 'type' => 'object', + 'properties' => [ + 'Error' => [ + 'description' => 'The configuration for an alert of the Error type.', + 'type' => 'object', + 'properties' => [ + 'StreamTaskIds' => [ + 'description' => 'The IDs of the real-time computing tasks. This parameter is required when you monitor real-time computing tasks.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the real-time computing task.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'AutoRerunAlertEnabled' => ['description' => 'Specifies whether to trigger an alert if a batch synchronization task is automatically rerun upon a failure.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Timeout' => [ + 'description' => 'The configuration for an alert of the Timeout type.', + 'type' => 'object', + 'properties' => [ + 'TimeoutInMinutes' => ['description' => 'The timeout period. Unit: minutes. Valid values: \\[1, 21600].', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'UnFinished' => [ + 'description' => 'The configuration for an alert of the UnFinished type.', + 'type' => 'object', + 'properties' => [ + 'UnFinishedTime' => ['description' => 'The latest completion time of the instance. The period is in the hh:mm format. Valid values of hh: \\[0,47]. Valid values of mm: \\[0,59].', 'type' => 'string', 'required' => false, 'example' => '30:00', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'CycleUnfinished' => [ + 'description' => 'The configuration for an alert of the CycleUnfinished type.', + 'type' => 'object', + 'properties' => [ + 'CycleAndTime' => [ + 'description' => 'The configurations of the scheduling cycle and timeout period of the instance.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CycleId' => ['description' => 'The ID of the scheduling cycle of the instance. Valid values: \\[1,288].', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'Time' => ['description' => 'The latest completion time of the instance within the scheduling cycle. The time is in the hh:mm format. Valid values of hh: \\[0,47]. Valid values of mm: \\[0,59].', 'type' => 'string', 'required' => false, 'example' => '12:00', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'InstanceErrorCount' => [ + 'description' => 'The configuration for an alert of the InstanceErrorCount type.', + 'type' => 'object', + 'properties' => [ + 'Count' => ['description' => 'The maximum number of instances on which an error occurs. Valid values: \\[1,10000].', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'InstanceErrorPercentage' => [ + 'description' => 'The configuration for an alert of the InstanceErrorPercentage type.', + 'type' => 'object', + 'properties' => [ + 'Percentage' => ['description' => 'The maximum percentage of instances on which an error occurs in the workspace to the total number of instances. Valid values: \\[1-100].', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'InstanceTransferFluctuate' => [ + 'description' => 'The configuration for an alert of the InstanceTransferFluctuate type.', + 'type' => 'object', + 'properties' => [ + 'Trend' => ['description' => 'The way in which the number of auto triggered node instances that are generated in your workspace fluctuates. Valid values:'."\n" + ."\n" + .'- abs: the absolute value. The number of instances increases or decreases.'."\n" + ."\n" + .'- increase: The number of instances increases.'."\n" + ."\n" + .'- decrease: The number of instances decreases.', 'type' => 'string', 'required' => false, 'example' => 'abs', 'title' => ''], + 'Percentage' => ['description' => 'The maximum percentage of fluctuation in the number of auto triggered node instances that are generated in your workspace. Valid values: \\[1-100].', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Target' => [ + 'description' => 'The monitored objects.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The type of the monitored objects. Valid values:'."\n" + ."\n" + .'- Task: node'."\n" + ."\n" + .'- Baseline: baseline'."\n" + ."\n" + .'- Project: workspace'."\n" + ."\n" + .'- BizProcess: workflow', 'type' => 'string', 'required' => false, 'example' => 'Task', 'title' => ''], + 'Ids' => [ + 'description' => 'The IDs of monitored objects.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the monitored object.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123123', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'AllowTasks' => [ + 'description' => 'The nodes that are not to be monitored.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the node that is not to be monitored.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], 'required' => true, - 'example' => '123422344899', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'RoleCodes', - 'in' => 'formData', + 'name' => 'Notification', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'The codes of the roles in the workspace. You can call the [ListProjectRoles](~~2853930~~) operation to query the codes of all roles in the workspace.'."\n" - ."\n" - .'You must configure this parameter to specify the roles that you want to assign to members in the workspace.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The code of a role in the workspace.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'role_project_guest', + 'description' => 'The configuration for the alert notification.', + 'type' => 'object', + 'properties' => [ + 'SilenceStartTime' => ['description' => 'The start time for silence. The time is in the HH:mm format.', 'type' => 'string', 'required' => false, 'example' => '00:00'."\n", 'title' => ''], + 'SilenceEndTime' => ['description' => 'The end time for silence. The time is in the HH:mm format.', 'type' => 'string', 'required' => false, 'example' => '00:00'."\n", 'title' => ''], + 'IntervalInMinutes' => ['description' => 'The interval at which an alert notification is sent. Unit: minutes. Valid values: \\[5,10000].', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], + 'Maximum' => ['description' => 'The maximum number of times an alert notification can be sent within a calendar day. Valid values: \\[1, 10000].', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + 'Channels' => [ + 'description' => 'The alert notification channels.', + 'type' => 'array', + 'items' => ['description' => 'The alert notification channel. Valid values:'."\n" + ."\n" + .'- Mail'."\n" + ."\n" + .'- Phone'."\n" + ."\n" + .'- Sms: text message'."\n" + ."\n" + .'- Dingding: DingTalk'."\n" + ."\n" + .'- Feishu: Lark'."\n" + ."\n" + .'- Weixin: WeCom'."\n" + ."\n" + .'- Webhook: custom webhook', 'type' => 'string', 'required' => false, 'example' => 'Sms', 'title' => ''], + 'required' => true, + 'title' => '', + 'example' => '', + ], + 'Receivers' => [ + 'description' => 'The alert recipients.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ReceiverType' => ['description' => 'The type of the alert recipient. Valid valves:'."\n" + ."\n" + .'- AliUid: Alibaba Cloud account ID.'."\n" + ."\n" + .'- Shift Schedules: the personnel in a shift schedule.'."\n" + ."\n" + .'- TaskOwner: the task owner. The task owner can receive custom alerts and event alerts.'."\n" + ."\n" + .'- Owner: the baseline owner. The baseline owner can receive baseline alerts.'."\n" + ."\n" + .'- WebhookUrl: URL of a custom webhook.'."\n" + ."\n" + .'- DingdingUrl: DingTalk webhook URL.'."\n" + ."\n" + .'- FeishuUrl: Lark webhook URL.'."\n" + ."\n" + .'- WeixinUrl: WeCom webhook URL.', 'type' => 'string', 'required' => false, 'example' => 'TaskOwner', 'title' => ''], + 'ReceiverValues' => [ + 'description' => 'The ID of the alert recipient.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the alert recipient. If the ReceiverType parameter is set to AliUid, set this parameter to an Alibaba Cloud account ID. If the ReceiverType parameter is set to ShiftSchedule, set this parameter to a shift schedule ID. If the ReceiverType parameter is set to WebhookUrl, DingdingUrl, FeishuUrl, or WeixinUrl, set this parameter to a corresponding URL.', 'type' => 'string', 'required' => false, 'example' => '123123123', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Extension' => ['description' => 'The additional configuration of the alert recipient. If the ReceiverType parameter is set to DingdingUrl, you can set this parameter to {"atAll":true} to remind all members in a DingTalk group.', 'type' => 'string', 'required' => false, 'example' => '{"atAll":true}'."\n", 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'title' => '', + 'example' => '', + ], ], - 'required' => true, - 'maxItems' => 10, - 'minItems' => 1, + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -5572,607 +3886,467 @@ 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. You can use the ID to query logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '2d9ced66-38ef-4923-baf6-391dd3a7e656', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'A6C6B486-E3A2-5D52-9E76-D9380485D946'."\n"], + 'Id' => ['description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123123', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2d9ced66-38ef-4923-baf6-391dd3a7e656\\"\\n}","type":"json"}]', - 'title' => 'GrantMemberProjectRoles', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", - ], - 'RevokeMemberProjectRoles' => [ - 'summary' => 'Revokes roles that are assigned to a member in a workspace.', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A6C6B486-E3A2-5D52-9E76-D9380485D946\\\\n\\",\\n \\"Id\\": 123123\\n}","type":"json"}]', + 'title' => 'CreateAlertRule', + 'changeSet' => [ + ['createdAt' => '2024-12-27T03:06:33.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'https', + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'CreateBusiness' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '244501', - 'abilityTreeNodes' => [ - 'FEATUREdideYTM537', - ], - 'tenantRelevance' => 'tenant', + 'operationType' => 'create', + 'abilityTreeCode' => '268146', + 'abilityTreeNodes' => ['FEATUREdide8FM783'], ], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://dataworks.console.aliyun.com/workspace/list) and go to the Workspace page to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '105149', - ], + 'schema' => ['description' => 'The ID of the DataWorks workspace.
'."\n" + .'You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console), go to the Workspace Management page, and view the ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10000', 'title' => ''], ], [ - 'name' => 'UserId', + 'name' => 'ProjectIdentifier', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the account used by the member in the workspace. You can log on to the [DataWorks console](https://dataworks.console.aliyun.com/product/ms_menu), choose More > Management Center in the left-side navigation pane, select the desired workspace on the Management Center page, and then click Go to Management Center. In the left-side navigation pane of the SettingCenter page, click Tenant Members and Roles. On the Tenant Members and Roles page, view the ID of the account used by the member in the workspace.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '123422344899'."\n", - ], + 'schema' => ['description' => 'The unique identifier of the DataWorks workspace, which is the English identifier displayed when you switch workspaces at the top of the Data Development page. You must specify either this parameter or the projectid parameter to identify the DataWorks project for this API call.', 'type' => 'string', 'required' => false, 'example' => 'dw_project', 'title' => ''], ], [ - 'name' => 'RoleCodes', + 'name' => 'BusinessName', + 'in' => 'formData', + 'schema' => ['description' => 'Name of the Business Process.
'."\n" + .'The name must be unique within the same project space.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'My business process', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['description' => 'Description of the Business Process.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => ['description' => 'The Alibaba Cloud account ID of the owner responsible for the Business Process.
'."\n" + .'You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console), move the mouse pointer over the profile picture in the upper-right corner of the menu bar, and view the Account ID. If this parameter is empty, the Alibaba Cloud account ID of the invoker is used by default.', 'type' => 'string', 'required' => false, 'example' => '1000000000001', 'title' => ''], + ], + [ + 'name' => 'UseType', 'in' => 'formData', - 'style' => 'json', 'schema' => [ - 'description' => 'The codes of the roles in the workspace. You can call the [ListProjectRoles](~~2853930~~) operation to query the codes of all roles in the workspace.'."\n" + 'description' => 'Function module to which the Business Process belongs. Valid values:'."\n" ."\n" - .'You must configure this parameter to specify the roles that you want to revoke from the member in the workspace.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The code of a role in the workspace.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'role_project_guest', - ], - 'required' => true, - 'maxItems' => 10, - 'minItems' => 1, + .'- NORMAL (Data Development)'."\n" + ."\n" + .'- MANUAL\\_BIZ (manually triggered workflow)', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'default' => 'NORMAL', + 'enum' => ['NORMAL', 'MANUAL_BIZ'], + 'example' => 'NORMAL', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'Return Result.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '676271D6-53B4-57BE-89FA-72F7AE1418DF', - ], + 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'RequestId' => ['description' => 'The unique ID of this request.
'."\n" + .'If an error occurs, you can use this ID to troubleshoot the issue.', '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 invocation succeeded. Valid values:'."\n" + ."\n" + .'- true: The invocation succeeded.'."\n" + ."\n" + .'- false: The invocation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'Error code. The value is as follows:'."\n" + ."\n" + .'- If the request succeeds, the ErrorCode field is not returned.'."\n" + ."\n" + .'- If the request fails, the ErrorCode field is returned.'."\n" + ."\n" + .'For more information, see the error code list in this topic.', 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], + 'BusinessId' => ['description' => 'Business Process ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '100001', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"676271D6-53B4-57BE-89FA-72F7AE1418DF\\"\\n}","type":"json"}]', - 'title' => 'RevokeMemberProjectRoles', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", - ], - 'GetProjectMember' => [ - 'summary' => 'Queries the details about a member in a workspace.', - '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.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', + 'staticInfo' => ['returnType' => 'synchronous'], + '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"}]', + 'title' => 'CreateBusiness', + 'summary' => 'Creates a workflow in DataStudio.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'CreateComponent' => [ + 'summary' => 'Creates components.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '244502', - 'abilityTreeNodes' => [ - 'FEATUREdideYTM537', - ], + 'abilityTreeCode' => '236012', + 'abilityTreeNodes' => ['FEATUREdideITYNXL'], + 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://dataworks.console.aliyun.com/workspace/list) 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, - 'example' => '88757', - ], + 'schema' => ['description' => 'The DataWorks workspace ID. You can call the [ListProjects](~~2852607~~) operation to obtain the ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000', 'title' => ''], ], [ - 'name' => 'UserId', + 'name' => 'Spec', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the account used by the member in the workspace. You can log on to the [DataWorks console](https://dataworks.console.aliyun.com/product/ms_menu), choose More > Management Center in the left-side navigation pane, select the desired workspace on the Management Center page, and then click Go to Management Center. In the left-side navigation pane of the SettingCenter page, click Tenant Members and Roles. On the Tenant Members and Roles page, view the ID of the account used by the member in the workspace.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '123422344899', - ], + 'schema' => ['description' => 'The FlowSpec information for this UDF function. For more information, see [FlowSpec](https://github.com/aliyun/dataworks-spec/blob/master/README_zh_CN.md).', 'type' => 'string', 'required' => true, 'example' => '{'."\n" + .' "kind": "Component",'."\n" + .' "name": "com1",'."\n" + .' "spec": {'."\n" + .' "components": ['."\n" + .' {'."\n" + .' "name": "test11",'."\n" + .' "id": "1234",'."\n" + .' "owner": "1234456",'."\n" + .' "description": "",'."\n" + .' "script": {'."\n" + .' "language": "odps-sql",'."\n" + .' "path": "test11",'."\n" + .' "content": "select \'@@{bizdate}\', \'@@{my_input_table}\'",'."\n" + .' "runtime": {'."\n" + .' "command": "SQL_COMPONENT"'."\n" + .' }'."\n" + .' },'."\n" + .' "inputs": ['."\n" + .' {'."\n" + .' "name": "bizdate",'."\n" + .' "type": "string"'."\n" + .' },'."\n" + .' {'."\n" + .' "name": "my_input_table",'."\n" + .' "type": "string"'."\n" + .' }'."\n" + .' ],'."\n" + .' "outputs": ['."\n" + .' {'."\n" + .' "name": "my_output_table1",'."\n" + .' "type": "string"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .'}', 'title' => ''], + ], + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request.', 'type' => 'string', 'required' => false, 'example' => '1AFAE64E-D1BE-432B-A9****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '8abcb91f-d266-4073-b907-2ed670378ed1', - ], - 'ProjectMember' => [ - 'description' => 'The details about the member in the workspace.'."\n", - 'type' => 'object', - 'properties' => [ - 'ProjectId' => [ - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '88757', - ], - 'UserId' => [ - 'description' => 'The ID of the account used by the member in the workspace.'."\n", - 'type' => 'string', - 'example' => '123422344899', - ], - 'Status' => [ - 'description' => 'The status of the member.'."\n" - ."\n" - .'* Normal'."\n" - .'* Forbidden'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'Roles' => [ - 'description' => 'The roles that are assigned to the member in the workspace.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The details about a role that is assigned to the member in the workspace.'."\n", - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The code of the role. Valid values:'."\n" - ."\n" - .'* role_project_admin: Workspace Administrator'."\n" - .'* role_project_dev: Develop'."\n" - .'* role_project_dg_admin: Data Governance Administrator'."\n" - .'* role_project_guest: Visitor'."\n" - .'* role_project_security: Security Administrator'."\n" - .'* role_project_deploy: Deploy'."\n" - .'* role_project_owner: Workspace Owner'."\n" - .'* role_project_data_analyst: Data Analyst'."\n" - .'* role_project_pe: O\\&M'."\n" - .'* role_project_erd: Model Designer'."\n", - 'type' => 'string', - 'example' => 'role_project_guest', - ], - 'Name' => [ - 'description' => 'The name of the role.'."\n", - 'type' => 'string', - 'example' => 'Visitors', - ], - 'Type' => [ - 'description' => 'The type of the role. Valid values:'."\n" - ."\n" - .'* UserCustom: custom role'."\n" - .'* System: built-in role'."\n", - 'type' => 'string', - 'example' => 'System', - ], - ], - ], - ], - 'UserName' => [ - 'type' => 'string', - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'adssd****'], + 'ComponentId' => ['description' => 'The ID of the dataset acceleration component. To obtain the component ID, see [ListComponents](~~2979566~~).', 'type' => 'string', 'example' => '123123123123123', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateComponent', + 'description' => '>'."\n" + ."\n" + .'This API does not support batch operations. If you specify multiple entities to be published, all entities except the first one are ignored.'."\n" + ."\n" + .'>', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8abcb91f-d266-4073-b907-2ed670378ed1\\",\\n \\"ProjectMember\\": {\\n \\"ProjectId\\": 88757,\\n \\"UserId\\": \\"123422344899\\",\\n \\"Status\\": \\"Normal\\",\\n \\"Roles\\": [\\n {\\n \\"Code\\": \\"role_project_guest\\",\\n \\"Name\\": \\"Visitors\\",\\n \\"Type\\": \\"System\\"\\n }\\n ],\\n \\"UserName\\": \\"\\"\\n }\\n}","type":"json"}]', - 'title' => 'GetProjectMember', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"adssd****\\",\\n \\"ComponentId\\": \\"123123123123123\\"\\n}","type":"json"}]', ], - 'ListProjectMembers' => [ - 'summary' => 'Queries details about members in a workspace.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateComputeResource' => [ + 'summary' => 'Creates a computing resource in the specified workspace. The resource can be for a development environment or a production environment.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '244503', - 'abilityTreeNodes' => [ - 'FEATUREdideYTM537', - ], + 'abilityTreeCode' => '232205', + 'abilityTreeNodes' => ['FEATUREdideRWC5F7'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'ProjectId', - 'in' => 'formData', + 'in' => 'query', + 'schema' => ['description' => 'The DataWorks workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'minimum' => '0', 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the computing resource. It can contain letters, digits, and underscores (\\_), cannot start with a digit or an underscore, and has a maximum length of 255 characters.', 'type' => 'string', 'required' => true, 'example' => 'demo_holo_cs', 'title' => ''], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => ['description' => 'The type of the computing resource. Multiple computing resource types are currently supported.', 'type' => 'string', 'required' => true, 'example' => 'hologres', 'title' => ''], + ], + [ + 'name' => 'ConnectionPropertiesMode', + '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 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', + 'description' => 'Depending on the added source category, different types may have specific subtypes subject to distinct parameter constraints. For example, Hologres computing resources support InstanceMode and UrlMode.', + 'type' => 'string', 'required' => true, - 'example' => '62136', + 'enum' => ['UrlMode', 'InstanceMode', 'CdhMode'], + 'title' => '', + 'example' => 'InstanceMode', ], ], [ - 'name' => 'UserIds', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The IDs of the accounts used by the members in the workspace. You can log on to the [DataWorks console](https://dataworks.console.aliyun.com/product/ms_menu), choose More > Management Center in the left-side navigation pane, select the desired workspace on the Management Center page, and then click Go to Management Center. In the left-side navigation pane of the SettingCenter page, click Tenant Members and Roles. On the Tenant Members and Roles page, view the IDs of the accounts used by the members in the workspace.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the account used by the member in the workspace.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123422344899', - ], - 'required' => false, - ], + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The description of the computing resource. The maximum length is 3000 characters.', 'type' => 'string', 'example' => 'demo_holo_cs', 'title' => '', 'required' => false], ], [ - 'name' => 'RoleCodes', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The codes of the roles in the workspace. You can call the [ListProjectRoles](~~2853930~~) operation to query the codes of all roles in the workspace.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The code of the role.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'role_project_guest', - ], - 'required' => false, - ], - ], - [ - '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, - 'example' => '10', - ], + 'name' => 'ConnectionProperties', + 'in' => 'query', + 'schema' => ['description' => 'The specific connection configuration of the computing resource, including the connection address, access identity, and environment information. The environment for the computing resource is a member attribute of this object. It includes DEV (development environment) and PROD (production environment). The value for EnvType is case-insensitive.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{ "EndpointMode": "custom", "Database": "testdb", "TaskSubmitter": "1107550004253538", "InstanceId": "hgprecn-cn-x0r3oun4k001", "SecurityProtocol": "authTypeNone", "RegionId": "cn-beijing", "EnvType": "Prod", "AuthType": "Executor" }', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '9FBBBB1F-DD5E-5D8E-8F50-37F77460F056', - ], - 'PagingInfo' => [ - 'description' => 'The pagination information.'."\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 entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '12', - ], - 'ProjectMembers' => [ - 'description' => 'The members in the workspace.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The details about a member in the workspace.'."\n", - 'type' => 'object', - 'properties' => [ - 'ProjectId' => [ - 'description' => 'The ID of the DataWorks workspace.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '62136', - ], - 'UserId' => [ - 'description' => 'The ID of the account used by the member.'."\n", - 'type' => 'string', - 'example' => '123422344899', - ], - 'Status' => [ - 'description' => 'The status of the member. Valid values:'."\n" - ."\n" - .'* Normal'."\n" - .'* Forbidden'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Normal', - ], - 'Roles' => [ - 'description' => 'The roles that are assigned to the member.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The details about a role that is assigned to the member.'."\n", - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The code of the role.'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'role_project_guest', - ], - 'Name' => [ - 'description' => 'The name of the role.'."\n", - 'type' => 'string', - 'example' => 'Visitors', - ], - 'Type' => [ - 'description' => 'The type of the role. Valid values:'."\n" - ."\n" - .'* UserCustom: user-defined role'."\n" - .'* System: system role'."\n", - 'type' => 'string', - 'example' => 'System', - ], - ], - ], - ], - 'UserName' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID. You can use the request ID to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'], + 'Id' => ['description' => 'Returns the ID of the created computing resource.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10001'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9FBBBB1F-DD5E-5D8E-8F50-37F77460F056\\",\\n \\"PagingInfo\\": {\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 12,\\n \\"ProjectMembers\\": [\\n {\\n \\"ProjectId\\": 62136,\\n \\"UserId\\": \\"123422344899\\",\\n \\"Status\\": \\"Normal\\",\\n \\"Roles\\": [\\n {\\n \\"Code\\": \\"role_project_guest\\",\\n \\"Name\\": \\"Visitors\\",\\n \\"Type\\": \\"System\\"\\n }\\n ],\\n \\"UserName\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListProjectMembers', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", - ], - 'TestDataSourceConnectivity' => [ - 'summary' => 'Tests the connectivity between a data source and a resource group.', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateComputeResource', + 'description' => 'DataWorks Basic Edition or a more advanced edition is required.'."\n" + .'You must have at least one of the following roles in the DataWorks workspace:'."\n" + .'Tenant Owner, Workspace Administrator, Project Owner, O\\&M', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:CreateComputeResource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"Id\\": 10001\\n}","type":"json"}]', + ], + 'CreateCustomAttribute' => [ + 'summary' => 'Creates a custom attribute definition.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '250948', - 'abilityTreeNodes' => [ - 'FEATUREdideRWC5F7', - ], + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdideX3KVYR'], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'ResourceGroupId', - 'in' => 'query', + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the custom attribute. The ID must match the regular expression `^custom-attribute:[A-Za-z][A-Za-z0-9_]{0,98}$`. The part after \\`custom-attribute:\\` must be less than 100 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'custom-attribute:biz_owner', 'title' => ''], + ], + [ + 'name' => 'DisplayName', + 'in' => 'formData', + 'schema' => ['description' => 'The display name of the custom attribute. The name must be less than 128 characters in length.', 'type' => 'string', 'required' => true, 'example' => '业务负责人', 'title' => ''], + ], + [ + 'name' => 'Type', + 'in' => 'formData', 'schema' => [ - 'title' => '资源组ID，即资源组的唯一标识符。', - 'description' => 'The resource group ID.'."\n", + 'description' => 'The type of the custom attribute. Valid values are ENUM, TEXT, and HYPERLINK.', 'type' => 'string', 'required' => true, - 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX', + 'example' => 'TEXT', + 'enum' => ['ENUM', 'TEXT', 'HYPERLINK'], + 'title' => '', ], ], [ - 'name' => 'DataSourceId', - 'in' => 'query', + 'name' => 'EntityTypes', + 'in' => 'formData', + 'style' => 'simple', 'schema' => [ - 'title' => '待测试连通性的数据源ID，数据源ID是数据源的唯一标识符。', - 'description' => 'The ID of the data source for which you want to test the network connectivity.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'type' => 'array', + 'items' => ['description' => 'The entity type.', 'type' => 'string', 'required' => false, 'example' => 'maxcompute-table', 'title' => ''], 'required' => true, - 'example' => '144544', + 'maxItems' => 100, + 'minItems' => 1, + 'title' => '', + 'description' => 'The list of applicable entity types. You can specify precise entity types or use wildcards such as `*-table` and `*-column`. Examples:'."\n" + ."\n" + .'- dataworks-project: a DataWorks workspace.'."\n" + ."\n" + .'- dataworks-dataset: a DataWorks dataset.'."\n" + ."\n" + .'- maxcompute-table: a MaxCompute table.'."\n" + ."\n" + .'- \\*-column: all field types.', + 'example' => '', ], ], [ - 'name' => 'ProjectId', - 'in' => 'query', + 'name' => 'ValueEnums', + 'in' => 'formData', + 'style' => 'simple', 'schema' => [ - 'title' => 'DataWorks项目空间ID。', - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10001', + 'type' => 'array', + 'items' => ['description' => 'The values of the enumeration.', 'type' => 'string', 'required' => false, 'example' => 'VALUE_1', 'title' => ''], + 'maxItems' => 100, + 'minItems' => 1, + 'title' => '', + 'description' => 'The enumeration values. This parameter is required when \\`Type\\` is set to \\`ENUM\\`. It is not supported for the TEXT and HYPERLINK types.', + 'required' => false, + 'example' => '', ], ], + [ + 'name' => 'DisplayEnabled', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to display the attribute on the product page. The default value is true.', 'type' => 'boolean', 'example' => 'true', 'title' => '', 'required' => false], + ], + [ + 'name' => 'SearchFilterEnabled', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether the attribute can be used as a filter on the Data Map search page. The default value is false. Currently, you can set this parameter to true only for attributes of the ENUM type.', 'type' => 'boolean', 'example' => 'false', 'title' => '', 'required' => false], + ], + [ + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => ['description' => 'The description of the custom attribute. The description must be less than 256 characters in length.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'test comment'], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '4CDF7B72-020B-542A-8465-21CFFA81****', - ], - 'Connectivity' => [ - 'description' => 'The details of the connectivity test.'."\n", - 'type' => 'object', - 'properties' => [ - 'ConnectState' => [ - 'title' => '测试后的连通性状态。'."\n" - .'枚举值：'."\n" - .'● Connectable：可连通'."\n" - .'● ConfigError：网络可通，但是配置有误'."\n" - .'● Unreachable：不可连通'."\n" - .'● Unsupport：其他不支持的场景，例如资源组处于初始化中', - 'description' => 'The result of the connectivity test. Valid values: Connectable: The network can be connected. ConfigError: The network can be connected, but the configurations are incorrect. Unreachable: The network cannot be connected. Unsupport: An error is reported due to other causes. For example, the desired resource group is being initialized.'."\n", - 'type' => 'string', - 'example' => 'Connectable', - ], - 'ConnectMessage' => [ - 'title' => '连通性测试失败时，具体的描述信息。'."\n" - .'连通性测试成功时，无该信息。', - 'description' => 'The error message returned if the connectivity test fails. No such a message is returned if the connectivity test is successful.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'DetailLogs' => [ - 'description' => 'The detailed logs of each step in the connectivity test.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'StartTime' => [ - 'description' => 'The start time of a step.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1730217600001', - ], - 'EndTime' => [ - 'description' => 'The end time of a step.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1730217604002', - ], - 'Code' => [ - 'description' => 'The code of the test item.'."\n", - 'type' => 'string', - 'example' => 'validate_input_parameters', - ], - 'Message' => [ - 'description' => 'The name of the step.'."\n", - 'type' => 'string', - 'example' => '', - ], - ], - 'description' => '', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '5A1E9EBB-FEA6-5BBB-B7BE-BFC0FB3F8C71'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'Result' => ['description' => 'The creation result.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], + 'title' => '', + 'description' => 'Schema of Response', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateCustomAttribute', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4CDF7B72-020B-542A-8465-21CFFA81****\\",\\n \\"Connectivity\\": {\\n \\"ConnectState\\": \\"Connectable\\",\\n \\"ConnectMessage\\": \\"连接数据库失败\\",\\n \\"DetailLogs\\": [\\n {\\n \\"StartTime\\": 1730217600001,\\n \\"EndTime\\": 1730217604002,\\n \\"Code\\": \\"validate_input_parameters\\",\\n \\"Message\\": \\"校验输入参数\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'TestDataSourceConnectivity', - 'description' => '1. This API operation is available for all DataWorks editions.'."\n" - .'2. Your account must be assigned one of the following roles of the desired workspace: Tenant Owner, Workspace Administrator, Deploy, Develop, Workspace Owner, and O\\&M'."\n", + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5A1E9EBB-FEA6-5BBB-B7BE-BFC0FB3F8C71\\",\\n \\"Success\\": true,\\n \\"Result\\": true\\n}","type":"json"}]', ], - 'CreateDataSource' => [ - 'summary' => 'Adds a data source to the development environment or production environment of a workspace.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateDIAlarmRule' => [ + 'summary' => 'Creates an alert rule for a synchronization task.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -6181,176 +4355,218 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'high', + 'operationType' => 'create', + 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '232205', - 'abilityTreeNodes' => [ - 'FEATUREdideRWC5F7', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '234126', + 'abilityTreeNodes' => ['FEATUREdideBP0OJZ'], ], 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'title' => 'Dataworks项目空间Id', - 'description' => 'The ID of the DataWorks workspace. You can log on to the [DataWorks console](https://dataworks.console.aliyun.com/overview) and go to the workspace management page to obtain the ID.'."\n" - ."\n" - .'This parameter is used to determine the DataWorks workspaces used for this API call.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'minimum' => '0', - 'example' => '2', - ], + 'schema' => ['description' => 'The description of the alert rule.', 'type' => 'string', 'example' => 'Alert description', 'title' => '', 'required' => false], ], [ - 'name' => 'Name', + 'name' => 'MetricType', 'in' => 'query', 'schema' => [ - 'title' => '数据源的名称，由字母、数字、下划线组合，且不能以数字和下划线开头，最长255 个字符', - 'description' => 'The name of the data source. The name can be up to 255 characters in length and can contain letters, digits, and underscores (\\_). The name must start with a letter.'."\n", + 'description' => 'The metric type in the alert rule. Valid values:'."\n" + ."\n" + .'- Heartbeat'."\n" + ."\n" + .'- FailoverCount'."\n" + ."\n" + .'- Delay'."\n" + ."\n" + .'- DdlReport'."\n" + ."\n" + .'- ResourceUtilization', 'type' => 'string', 'required' => true, - 'example' => 'demo_holo_datasource', + 'enum' => [], + 'title' => '', + 'example' => 'Heartbeat', ], ], [ - 'name' => 'Type', + 'name' => 'Enabled', 'in' => 'query', - 'schema' => [ - 'title' => '数据源的类型，目前已经支持数据源类型 70+', - 'description' => 'The type of the data source. More than 70 types of data sources are supported in DataWorks. For more information, see [Data source types](~~2852465~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'hologres', - ], + 'schema' => ['description' => 'Specifies whether to enable the alert rule. By default, the alert rule is disabled.', 'type' => 'boolean', 'required' => false, 'default' => 'false', 'title' => '', 'example' => 'true'], ], [ - 'name' => 'ConnectionPropertiesMode', + 'name' => 'DIJobId', 'in' => 'query', - 'schema' => [ - 'title' => '据源添加的类别，不同Type下会有不同的子类型，对应有不同的参数约束，以mysql数据源举例有：InstanceMode（实例模式）、UrlMode（连接串模式）', - 'description' => 'The mode in which you want to add the data source. The mode varies based on the data source type. Valid values for MySQL data sources:'."\n" - ."\n" - .'* InstanceMode: instance mode'."\n" - .'* UrlMode: connection string mode'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'UrlMode', - 'enum' => [ - 'UrlMode', - 'InstanceMode', - 'CdhMode', - ], - ], + 'schema' => ['description' => 'The ID of the synchronization task with which the alert rule is associated.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '1'], ], [ - 'name' => 'Description', + 'name' => 'ClientToken', 'in' => 'query', - 'schema' => [ - 'title' => '数据源描述信息，长度不超过 3000 个字符', - 'description' => 'The description of the data source. The description cannot exceed 3,000 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'this is a holo datasource', - ], + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'ABFUOEUOTRTRJKE'], ], [ - 'name' => 'ConnectionProperties', + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the alert rule.', 'type' => 'string', 'required' => true, 'example' => 'alartRule', 'title' => ''], + ], + [ + 'name' => 'TriggerConditions', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '数据源具体连接配置信息，包括连接地址、访问身份、环境信息等。数据源环境EnvType信息是此对象的成员属性，包括DEV（开发环境）和PROD（生产环境），EnvType取值不区分大小写。'."\n" - .'```'."\n", - 'description' => 'The connection configurations of the data source, including the connection address, access identity, and environment information. The envType parameter specifies the environment in which the data source is used. Valid values of the envType parameter:'."\n" - ."\n" - .'* Dev: development environment'."\n" - .'* Prod: production environment'."\n" - ."\n" - .'The parameters that you need to configure for the data source vary based on the mode in which the data source is added. For more information, see [Data source connection information (ConnectionProperties)](~~2852465~~).'."\n", - 'type' => 'string', + 'description' => 'The conditions that can trigger the alert rule.', + 'type' => 'array', + 'items' => [ + 'description' => 'The condition that can trigger the alert rule.', + 'type' => 'object', + 'properties' => [ + 'Severity' => ['description' => 'The severity level. Valid values:'."\n" + ."\n" + .'- Warning'."\n" + ."\n" + .'- Critical', 'type' => 'string', 'required' => false, 'example' => 'Warning', 'title' => ''], + 'Duration' => ['description' => 'The time interval for alert calculation. Unit: minutes.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', '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' => '10', 'title' => ''], + 'DdlTypes' => [ + 'description' => 'The types of DDL operations for which the alert rule takes effect.', + 'type' => 'array', + 'items' => ['description' => 'The type of the DDL operation for which the alert rule takes effect. This parameter is required only if the MetricType parameter is set to DdlReport. Valid values:'."\n" + ."\n" + .'- AlterAddColumn'."\n" + ."\n" + .'- AlterDropColumn'."\n" + ."\n" + .'- AlterRenameColumn'."\n" + ."\n" + .'- AlterRenameTable'."\n" + ."\n" + .'- AlterTableModify'."\n" + ."\n" + .'- DropTable'."\n" + ."\n" + .'- TruncateTable', 'type' => 'string', 'required' => false, 'example' => 'AlterAddColumn', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'DdlReportTags' => [ + 'description' => 'This parameter is deprecated and replaced by the DdlTypes parameter.', + 'type' => 'array', + 'items' => ['description' => 'This parameter is deprecated and replaced by the DdlTypes parameter.', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'AlterAddColumn', 'title' => ''], + 'deprecated' => true, + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => true, - 'docRequired' => true, - 'example' => '{'."\n" - .' "envType": "Prod",'."\n" - .' "regionId": "cn-beijing",'."\n" - .' "instanceId": "hgprecn-cn-x0r3oun4k001",'."\n" - .' "database": "testdb",'."\n" - .' "securityProtocol": "authTypeNone",'."\n" - .' "authType": "Executor",'."\n" - .' "authIdentity": "1107550004253538"'."\n" - .'}', + 'title' => '', + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'NotificationSettings', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The returned result.'."\n", + 'description' => 'The alert notification settings.', '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' => 'B62EC203-B39E-5DC1-B5B8-EB3C61707009', + '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', 'type' => 'string', 'required' => false, 'example' => 'Warning', 'title' => ''], + 'Channels' => [ + 'description' => 'The alert notification method. Valid values:'."\n" + ."\n" + .'- Mail'."\n" + ."\n" + .'- Phone'."\n" + ."\n" + .'- Sms'."\n" + ."\n" + .'- Ding', + 'type' => 'array', + 'items' => ['description' => 'The alert notification method. Valid values:'."\n" + ."\n" + .'- Mail'."\n" + ."\n" + .'- Phone'."\n" + ."\n" + .'- Sms'."\n" + ."\n" + .'- Ding', 'type' => 'string', 'required' => false, 'example' => 'Ding', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'Id' => [ - 'title' => '返回创建的数据源Id', - 'description' => 'The data source ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '22130', + 'NotificationReceivers' => [ + 'description' => 'The settings of alert notification recipients.', + 'type' => 'array', + 'items' => [ + 'description' => 'The settings of alert notification recipients.', + 'type' => 'object', + 'properties' => [ + 'ReceiverType' => ['description' => 'The recipient type. Valid values: AliyunUid, DingToken, FeishuToken, and WebHookUrl.', 'type' => 'string', 'required' => false, 'example' => 'DingToken', 'title' => ''], + 'ReceiverValues' => [ + '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' => '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' => false, + 'title' => '', + 'example' => '', ], + 'MuteInterval' => ['description' => 'The duration of the alert suppression interval. Default value: 5. Unit: minutes.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', 'title' => ''], + 'InhibitionInterval' => ['description' => 'This parameter is deprecated and replaced by the MuteInterval parameter.', 'type' => 'integer', 'format' => 'int32', 'deprecated' => true, 'required' => false, 'example' => '5', 'title' => ''], ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B62EC203-B39E-5DC1-B5B8-EB3C6****\\",\\n \\"Id\\": 22130\\n}","type":"json"}]', - 'title' => 'CreateDataSource', - 'description' => '1. This API operation is available for all DataWorks editions.'."\n" - .'2. You can call this operation only if you are assigned one of the following roles in DataWorks:'."\n" - ."\n" - .'* Tenant Owner, Workspace Administrator, Workspace Owner, and O\\&M'."\n", - ], - 'DeleteDataSource' => [ - 'summary' => 'Removes a data source by ID.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '232438', - 'abilityTreeNodes' => [ - 'FEATUREdideRWC5F7', - ], - ], - 'parameters' => [ - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => 'The data source ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', 'required' => true, - 'example' => '1234', + 'title' => '', + 'example' => '', ], ], ], @@ -6358,44 +4574,35 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The returned result.'."\n", + 'description' => 'Schema of Response', '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' => 'B56432E0-2112-5C97-88D0-AA0AE5C75C74', - ], - 'Success' => [ - 'description' => 'Whether the call is successful.'."\n" - .'- true: Successful'."\n" - .'- false: Failed', - 'type' => 'boolean', - 'example' => 'true', - ], + 'Id' => ['description' => 'The ID of the alert rule.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.', 'type' => 'string', 'example' => 'C636A747-7E4E-594D-94CD-2B****', 'title' => ''], + 'DIAlarmRuleId' => ['description' => 'This parameter is deprecated and is replaced by the Id parameter.', 'type' => 'string', 'deprecated' => true, 'title' => '', 'example' => '1'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B56432E0-2112-5C97-88D0-AA0AE5****\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'DeleteDataSource', - 'description' => '1. This API operation is available for all Dataworks editions.'."\n" - .'2. You can call this operation only if you are assigned one of the following roles in DataWorks:'."\n" - ."\n" - .'* Tenant Owner, Workspace Administrator, Workspace Owner, and O\\&M'."\n", - ], - 'UpdateDataSource' => [ - 'summary' => 'Modifies a data source by ID.', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Id\\": 1,\\n \\"RequestId\\": \\"C636A747-7E4E-594D-94CD-2B****\\",\\n \\"DIAlarmRuleId\\": \\"1\\"\\n}","type":"json"}]', + 'title' => 'CreateDIAlarmRule', + 'description' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-01-09T07:20:21.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-01-06T05:34:15.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'translator' => 'manual', + ], + 'CreateDIJob' => [ + 'summary' => 'Create a new version of a data integration task.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -6404,496 +4611,834 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'high', - 'chargeType' => 'free', - 'abilityTreeCode' => '232392', - 'abilityTreeNodes' => [ - 'FEATUREdideRWC5F7', - ], - 'tenantRelevance' => 'tenant', + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '234097', + 'abilityTreeNodes' => ['FEATUREdideBP0OJZ'], ], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'DestinationDataSourceType', 'in' => 'query', - 'schema' => [ - 'title' => '数据源Id', - 'description' => 'The data source ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '16033', - ], + 'schema' => ['description' => 'The type of the destination data source. Valid values: `Hologres`, `OSS-HDFS`, `OSS`, `MaxCompute`, `LogHub`, `StarRocks`, `DataHub`, `AnalyticDB for MySQL`, `Kafka`, and `Hive`.', 'type' => 'string', 'required' => false, 'example' => 'Hologres', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['description' => 'The description of the job.', 'type' => 'string', 'required' => false, 'example' => 'DI Job Demo', 'title' => ''], + ], + [ + 'name' => 'SourceDataSourceType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the source data source. Valid values: `PolarDB`, `MySQL`, `Kafka`, `LogHub`, `Hologres`, `Oracle`, `OceanBase`, `MongoDB`, `Redshift`, `Hive`, `SQL Server`, `Doris`, and `ClickHouse`.', 'type' => 'string', 'required' => false, 'example' => 'MySQL', 'title' => ''], ], [ 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'title' => 'Dataworks项目空间Id', - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '5678', - ], + 'schema' => ['description' => 'The ID of the DataWorks workspace for this API call. To obtain the workspace ID, log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace Management page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000', 'title' => ''], ], [ - 'name' => 'ConnectionPropertiesMode', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'title' => '数据源添加的类别，不同type下会有不同的子类型，对应有不同的参数schema约束，场景举例：InstanceMode 实例模式；UrlMode 连接串模式', - 'description' => 'The mode in which the data source is added. The mode varies based on the data source type. Valid values:'."\n" - ."\n" - .'* InstanceMode: instance mode'."\n" - .'* UrlMode: connection string mode'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'UrlMode', - 'enum' => [ - 'UrlMode', - 'InstanceMode', - 'CdhMode', - ], - ], + 'schema' => ['description' => 'The name of the job.', 'type' => 'string', 'required' => false, 'example' => 'mysql_to_holo_sync_8772', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'MigrationType', 'in' => 'query', - 'schema' => [ - 'title' => '数据源描述信息，长度不超过 3000 个字符', - 'description' => 'The description of the data source. The description cannot exceed 3,000 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test ', - ], + 'schema' => ['description' => 'The synchronization type. Valid values:'."\n" + ."\n" + .'- `FullAndRealtimeIncremental`: Full and real-time incremental synchronization for an entire database.'."\n" + ."\n" + .'- `RealtimeIncremental`: Real-time incremental synchronization for a single table.'."\n" + ."\n" + .'- `Full`: Full batch synchronization for an entire database.'."\n" + ."\n" + .'- `OfflineIncremental`: Incremental synchronization in batch mode.'."\n" + ."\n" + .'- `FullAndOfflineIncremental`: Full and incremental batch synchronization for an entire database.', 'type' => 'string', 'required' => false, 'example' => 'FullAndRealtimeIncremental', 'title' => ''], ], [ - 'name' => 'ConnectionProperties', + 'name' => 'JobType', 'in' => 'query', + 'schema' => ['description' => 'The job type. Valid values:'."\n" + ."\n" + .'- `DatabaseRealtimeMigration`: Synchronizes multiple tables from multiple source databases in real time (stream synchronization). This type supports full, incremental, or both full and incremental synchronization.'."\n" + ."\n" + .'- `DatabaseOfflineMigration`: Synchronizes multiple tables from multiple source databases in batches. This type supports full, incremental, or both full and incremental synchronization.'."\n" + ."\n" + .'- `SingleTableRealtimeMigration`: Synchronizes a single source table in real time (stream synchronization).', 'type' => 'string', 'required' => false, 'example' => 'DatabaseRealtimeMigration', 'title' => ''], + ], + [ + 'name' => 'SourceDataSourceSettings', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '数据源具体连接配置信息，包括连接地址、访问身份、环境信息等。数据源环境EnvType信息是此对象的成员属性，包括DEV（开发环境）和PROD（生产环境），不区分大小写。', - 'description' => 'The connection configurations of the data source, including the connection address, access identity, and environment information. The envType parameter specifies the environment in which the data source is used. Valid values of the envType parameter:'."\n" - ."\n" - .'* Dev: development environment'."\n" - .'* Prod: production environment'."\n" - ."\n" - .'The parameters that you need to configure for the data source vary based on the mode in which the data source is added. For more information, see [Data source connection information (ConnectionProperties)](~~2852465~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '{'."\n" - .' "envType": "Prod",'."\n" - .' "regionId": "cn-beijing",'."\n" - .' "instanceId": "hgprecn-cn-x0r3oun4k001",'."\n" - .' "database": "testdb",'."\n" - .' "securityProtocol": "authTypeNone",'."\n" - .' "authType": "Executor",'."\n" - .' "authIdentity": "1107550004253538"'."\n" - .'}', + 'description' => 'Settings for the source data sources.', + 'type' => 'array', + 'items' => [ + 'description' => 'The settings for a single source data source.', + 'type' => 'object', + 'properties' => [ + 'DataSourceName' => ['description' => 'The name of the data source.', 'type' => 'string', 'required' => false, 'example' => 'mysql_datasource_1', 'title' => ''], + 'DataSourceProperties' => [ + 'description' => 'The properties of the data source.', + 'type' => 'object', + 'properties' => [ + 'Encoding' => ['description' => 'The database encoding format.', 'type' => 'string', 'required' => false, 'example' => 'UTF-8', 'title' => ''], + 'Timezone' => ['description' => 'The time zone.', 'type' => 'string', 'required' => false, 'example' => 'Asia/Shanghai', 'title' => ''], + 'ConnectionProperties' => ['description' => 'Custom connection settings for the data source, such as instance ID, access credentials, and instance region. You must specify this parameter or `DataSourceName`.'."\n" + ."\n" + .'This parameter applies only when the data source is configured in instance mode (`ConnectionPropertiesMode`). The property format varies by data source. For more information, see [ConnectionProperties for data sources](~~2852465~~).', 'type' => 'string', 'example' => '{ "instanceId": "rm-2ze09gn3x6xxx", "password": "xxxx", "database": "agent", "username": "zmtest" "regionId": "cn-beijing" }', 'title' => '', 'required' => false], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'DestinationDataSourceSettings', + 'in' => 'formData', + 'style' => 'json', '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' => '102E8E24-0387-531D-8A75-1C0AE7DD03E5', - ], - 'Success' => [ - 'description' => 'Whether the data source has been modified:'."\n" - ."\n" - .'- true: Yes'."\n" - .'- false: no', - 'type' => 'boolean', - 'example' => 'true', + 'description' => 'Settings for the destination data sources.', + 'type' => 'array', + 'items' => [ + 'description' => 'The settings for a single destination data source.', + 'type' => 'object', + 'properties' => [ + 'DataSourceName' => ['description' => 'The name of the data source.', 'type' => 'string', 'required' => false, 'example' => 'holo_datasource_1', 'title' => ''], + 'DataSourceProperties' => [ + 'type' => 'object', + 'properties' => [ + 'ConnectionProperties' => ['description' => 'Custom connection settings for the data source, such as instance ID, access credentials, and instance region. You must specify this parameter or `DataSourceName`.'."\n" + ."\n" + .'This parameter applies only when the data source is configured in instance mode (`ConnectionPropertiesMode`). The property format varies by data source. For more information, see [ConnectionProperties for data sources](~~2852465~~).', 'type' => 'string', 'example' => '{ "instanceId": "rm-2ze09gn3x6xxx", "password": "xxxx", "database": "agent", "username": "zmtest" "regionId": "cn-beijing" }', 'title' => '', 'required' => false], + ], + 'description' => 'The properties of the data source.', + 'title' => '', + 'example' => '', + 'required' => false, + ], ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"102E8E24-0387-531D-8A75-1C0AE7DD03E5\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'UpdateDataSource', - 'description' => '1. This API operation is available for all DataWorks editions.'."\n" - .'2. You can call this operation only if you are assigned one of the following roles in DataWorks:'."\n" - ."\n" - .'* Tenant Owner, Tenant Administrator, Workspace Administrator, Workspace Owner, and O\\&M'."\n", - ], - 'CloneDataSource' => [ - 'summary' => 'Clones an existing data source.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '232442', - 'abilityTreeNodes' => [ - 'FEATUREdideRWC5F7', + 'name' => 'ResourceSettings', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The resource settings.', + 'type' => 'object', + 'properties' => [ + 'OfflineResourceSettings' => [ + 'description' => 'Resource settings for batch synchronization.', + 'type' => 'object', + 'properties' => [ + 'RequestedCu' => ['description' => 'The number of CUs for the resource group for data integration that is used for batch synchronization.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '2', 'title' => ''], + 'ResourceGroupIdentifier' => ['description' => 'The identifier of the resource group for data integration used for batch synchronization.', 'type' => 'string', 'required' => false, 'example' => 'S_res_group_111_222', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'RealtimeResourceSettings' => [ + 'description' => 'The resources for real-time synchronization.', + 'type' => 'object', + 'properties' => [ + 'RequestedCu' => ['description' => 'The number of CUs for the resource group for data integration that is used for real-time synchronization.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '2', 'title' => ''], + 'ResourceGroupIdentifier' => ['description' => 'The identifier of the resource group for data integration used for real-time synchronization.', 'type' => 'string', 'required' => false, 'example' => 'S_res_group_111_222', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'ScheduleResourceSettings' => [ + 'description' => 'The scheduling resources.', + 'type' => 'object', + 'properties' => [ + 'RequestedCu' => ['description' => 'The number of CUs for the scheduling resource group that is used for batch synchronization jobs.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '2', 'title' => ''], + 'ResourceGroupIdentifier' => ['description' => 'The identifier of the scheduling resource group used for batch synchronization jobs.', 'type' => 'string', 'required' => false, 'example' => 'S_res_group_222_333', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], ], - ], - 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'query', + 'name' => 'TransformationRules', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The data source ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '16036', + 'description' => 'A list of transformation rules for the objects to be synchronized.'."\n" + ."\n" + .'> \\[ { "RuleName":"my\\_database\\_rename\\_rule", "RuleActionType":"Rename", "RuleTargetType":"Schema", "RuleExpression":"{\\\\"expression\\\\":\\\\"${srcDatasoureName}\\_${srcDatabaseName}\\\\"}" } ]', + 'type' => 'array', + 'items' => [ + 'description' => 'A single transformation rule.', + 'type' => 'object', + 'properties' => [ + 'RuleActionType' => ['description' => 'The action type. Valid values:'."\n" + ."\n" + .'- `DefinePrimaryKey`: Defines a primary key.'."\n" + ."\n" + .'- `Rename`: Renames an object.'."\n" + ."\n" + .'- `AddColumn`: Adds a column.'."\n" + ."\n" + .'- `HandleDml`: Handles DML operations.'."\n" + ."\n" + .'- `DefineIncrementalCondition`: Defines an incremental condition.'."\n" + ."\n" + .'- `DefineCycleScheduleSettings`: Defines periodic scheduling settings.'."\n" + ."\n" + .'- `DefinePartitionKey`: Defines a partition key.', 'type' => 'string', 'required' => false, 'example' => 'Rename', 'title' => ''], + 'RuleExpression' => ['description' => 'The rule expression, specified as a JSON string.'."\n" + ."\n" + .'1. Renaming rule (`Rename`)'."\n" + ."\n" + .'- Example: `{"expression":"${srcDatasourceName}_${srcDatabaseName}_0922" }`'."\n" + ."\n" + .'- `expression`: The renaming expression. You can use the following variables: `${srcDatasourceName}` (name of the source data source), `${srcDatabaseName}` (name of the source database), and `${srcTableName}` (name of the source table).'."\n" + ."\n" + .'2. Rule for adding a column (`AddColumn`)'."\n" + ."\n" + .'- Example: `{"columns":[{"columnName":"my_add_column","columnValueType":"Constant","columnValue":"123"}]}`'."\n" + ."\n" + .'- If you do not specify this rule, no columns are added.'."\n" + ."\n" + .'- `columnName`: The name of the column to add.'."\n" + ."\n" + .'- `columnValueType`: The value type of the added column. Valid values: `Constant` and `Variable`.'."\n" + ."\n" + .'- `columnValue`: The value of the added column. If `columnValueType` is `Constant`, the value is a custom string constant. If `columnValueType` is `Variable`, the value is a built-in variable. Valid built-in variables include: `EXECUTE_TIME` (execution time, Long), `DB_NAME_SRC` (source database name, String), `DATASOURCE_NAME_SRC` (source data source name, String), `TABLE_NAME_SRC` (source table name, String), `DB_NAME_DEST` (destination database name, String), `DATASOURCE_NAME_DEST` (destination data source name, String), `TABLE_NAME_DEST` (destination table name, String), and `DB_NAME_SRC_TRANSED` (transformed database name, String).'."\n" + ."\n" + .'3. Rule for defining the primary key columns of a destination table (`DefinePrimaryKey`)'."\n" + ."\n" + .'- Example: `{"columns":["ukcolumn1","ukcolumn2"]}`'."\n" + ."\n" + .'- If you do not specify this rule, the primary key columns of the source table are used by default.'."\n" + ."\n" + .'- If the destination is an existing table, Data Integration does not modify its schema. If a specified primary key column does not exist in the destination table, the job fails to start and an error is reported.'."\n" + ."\n" + .'- If the destination table is automatically created, Data Integration automatically creates its schema with the defined primary key columns. If a specified primary key column does not exist in the source table, the job fails to start and an error is reported.'."\n" + ."\n" + .'4. DML handling rule (`HandleDml`)'."\n" + ."\n" + .'- Example: `{"dmlPolicies":[{"dmlType":"Delete","dmlAction":"Filter","filterCondition":"id > 1"}]}`'."\n" + ."\n" + .'- If you do not specify this rule, the default `dmlAction` is `Normal` for `Insert`, `Update`, and `Delete` operations.'."\n" + ."\n" + .'- `dmlType`: The DML operation type. Valid values: `Insert`, `Update`, and `Delete`.'."\n" + ."\n" + .'- `dmlAction`: The DML handling policy. Valid values: `Normal` (normal processing), `Ignore`, `Filter` (conditional processing, used when `dmlType` is `Update` or `Delete`), and `LogicalDelete` (logical deletion).'."\n" + ."\n" + .'- `filterCondition`: The DML filter condition, used when `dmlAction` is `Filter`.'."\n" + ."\n" + .'5. Incremental condition (`DefineIncrementalCondition`)'."\n" + ."\n" + .'- Example: `{"where":"id > 0"}`'."\n" + ."\n" + .'- Specifies the filter condition for incremental synchronization.'."\n" + ."\n" + .'6. Parameters for periodic scheduling (`DefineCycleScheduleSettings`)'."\n" + ."\n" + .'- Example: `{"cronExpress":" * * * * * *", "cycleType":"1"}`'."\n" + ."\n" + .'- Specifies the parameters for periodically scheduling a job.'."\n" + ."\n" + .'7. Rule to define a partition key (`DefinePartitionKey`)'."\n" + ."\n" + .'- Example: `{"columns":["id"]}`'."\n" + ."\n" + .'- Specifies a partition key.', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "expression": "${srcDatasoureName}_${srcDatabaseName}"'."\n" + .'}', 'title' => ''], + 'RuleName' => ['description' => 'The name of the rule. The rule name must be unique for a specific action type and target object type. Maximum length: 50 characters.', 'type' => 'string', 'required' => false, 'example' => 'rename_rule_1', 'title' => ''], + 'RuleTargetType' => ['description' => 'The type of the object to which the action applies. Valid values:'."\n" + ."\n" + .'- `Table`'."\n" + ."\n" + .'- `Schema`'."\n" + ."\n" + .'- `Database`', 'type' => 'string', 'required' => false, 'example' => 'Table', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'CloneDataSourceName', - 'in' => 'query', + 'name' => 'TableMappings', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The name of the destination data source The name can contain letters, digits, and underscores (\\_), and must start with a letter. It cannot exceed 60 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'demo_holo_datasource', + 'description' => 'Transformation mappings for the objects to be synchronized. Each mapping defines selection rules for a group of source objects and the transformation rules to apply to them.'."\n" + ."\n" + .'> \\[ { "SourceObjectSelectionRules":\\[ { "ObjectType":"Database", "Action":"Include", "ExpressionType":"Exact", "Expression":"biz\\_db" }, { "ObjectType":"Schema", "Action":"Include", "ExpressionType":"Exact", "Expression":"s1" }, { "ObjectType":"Table", "Action":"Include", "ExpressionType":"Exact", "Expression":"table1" } ], "TransformationRuleNames":\\[ { "RuleName":"my\\_database\\_rename\\_rule", "RuleActionType":"Rename", "RuleTargetType":"Schema" } ] } ]', + 'type' => 'array', + 'items' => [ + 'description' => 'A mapping that selects a set of source objects and specifies the transformation rules to apply.', + 'type' => 'object', + 'properties' => [ + 'SourceObjectSelectionRules' => [ + 'description' => 'Each rule can select a set of source objects to synchronize. Multiple rules combine to select one table.', + 'type' => 'array', + 'items' => [ + 'description' => 'A rule that selects source objects of a specific type, such as a database or table.', + 'type' => 'object', + 'properties' => [ + 'Action' => ['description' => 'The selection action. Valid values: `Include` and `Exclude`.', 'type' => 'string', 'required' => false, 'example' => 'Include', 'title' => ''], + 'Expression' => ['description' => 'The expression.', 'type' => 'string', 'required' => false, 'example' => 'mysql_table_1', 'title' => ''], + 'ExpressionType' => ['description' => 'The expression type. Valid values: `Exact` and `Regex`.', 'type' => 'string', 'required' => false, 'example' => 'Exact', 'title' => ''], + 'ObjectType' => ['description' => 'The object type. Valid values:'."\n" + ."\n" + .'- `Table`'."\n" + ."\n" + .'- `Schema`'."\n" + ."\n" + .'- `Database`', 'type' => 'string', 'required' => false, 'example' => 'Table', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'TransformationRules' => [ + 'description' => 'The names of the transformation rules to apply to the selected objects.', + 'type' => 'array', + 'items' => [ + 'description' => 'The transformation rule applied to the source object.', + 'type' => 'object', + 'properties' => [ + 'RuleName' => ['description' => 'The name of the transformation rule. The rule name must be unique for a specific action type and target object type. Maximum length: 50 characters.', 'type' => 'string', 'required' => false, 'example' => 'rename_rule_1', 'title' => ''], + 'RuleActionType' => ['description' => 'The action type. Valid values:'."\n" + ."\n" + .'- `DefinePrimaryKey`: Defines a primary key.'."\n" + ."\n" + .'- `Rename`: Renames an object.'."\n" + ."\n" + .'- `AddColumn`: Adds a column.'."\n" + ."\n" + .'- `HandleDml`: Handles DML operations.'."\n" + ."\n" + .'- `DefineIncrementalCondition`: Defines an incremental condition.'."\n" + ."\n" + .'- `DefineCycleScheduleSettings`: Defines periodic scheduling settings.'."\n" + ."\n" + .'- `DefinePartitionKey`: Defines a partition key.', 'type' => 'string', 'required' => false, 'example' => 'Rename', 'title' => ''], + 'RuleTargetType' => ['description' => 'The type of the object to which the action applies. Valid values:'."\n" + ."\n" + .'- `Table`'."\n" + ."\n" + .'- `Schema`'."\n" + ."\n" + .'- `Database`', 'type' => 'string', 'required' => false, 'example' => 'Table', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'JobSettings', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The settings for the synchronization job, including DDL processing policies, data type mappings between source and destination columns, and runtime parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request. It is used to locate logs and troubleshoot problems.', - 'type' => 'string', - 'example' => 'FCD583B9-346B-5E75-82C1-4A7C192C48DB', + 'ChannelSettings' => ['description' => 'Settings for data synchronization channels. You can configure special settings for specific channels. The following channels are supported: synchronization from Hologres to Hologres (Holo2Holo) and from Hologres to Kafka (Holo2Kafka).'."\n" + ."\n" + .'1. Holo2Kafka'."\n" + ."\n" + .'- Example: `{"destinationChannelSettings":{"kafkaClientProperties":[{"key":"linger.ms","value":"100"}],"keyColumns":["col3"],"writeMode":"canal"}}`'."\n" + .' `kafkaClientProperties`: Parameters for the Kafka producer.'."\n" + ."\n" + .'- `keyColumns`: The columns whose values are used as keys for data written to Kafka.'."\n" + ."\n" + .'- `writeMode`: The data format for writing to Kafka. Valid values: `json` and `canal`.'."\n" + ."\n" + .'2. Holo2Holo'."\n" + ."\n" + .'- Example: `{"destinationChannelSettings":{"conflictMode":"replace","dynamicColumnAction":"replay","writeMode":"replay"}}`'."\n" + ."\n" + .'- `conflictMode`: The conflict handling policy for writing data to Hologres. Valid values: `replace` (overwrite) and `ignore`.'."\n" + ."\n" + .'- `writeMode`: The method for writing data to Hologres. Valid values: `replay` and `insert`.'."\n" + ."\n" + .'- `dynamicColumnAction`: The method for handling dynamic columns when writing data to Hologres. Valid values: `replay`, `insert`, and `ignore`.', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "structInfo": "MANAGED",'."\n" + .' "storageType": "TEXTFILE",'."\n" + .' "writeMode": "APPEND",'."\n" + .' "partitionColumns": ['."\n" + .' {'."\n" + .' "columnName": "pt",'."\n" + .' "columnType": "STRING",'."\n" + .' "comment": ""'."\n" + .' }'."\n" + .' ],'."\n" + .' "fieldDelimiter": ""'."\n" + .'}', 'title' => ''], + 'ColumnDataTypeSettings' => [ + 'description' => 'Column data type mappings.'."\n" + ."\n" + .'> "ColumnDataTypeSettings":\\[ { "SourceDataType":"Bigint", "DestinationDataType":"Text" } ]', + 'type' => 'array', + 'items' => [ + 'description' => 'A mapping from a source data type to a destination data type.', + 'type' => 'object', + 'properties' => [ + 'DestinationDataType' => ['description' => 'The destination data type. For example: `bigint`, `boolean`, `string`, `text`, `datetime`, `timestamp`, `decimal`, or `binary`. Available data types vary by data source.', 'type' => 'string', 'required' => false, 'example' => 'text', 'title' => ''], + 'SourceDataType' => ['description' => 'The source data type. For example: `bigint`, `boolean`, `string`, `text`, `datetime`, `timestamp`, `decimal`, or `binary`. Available data types vary by data source.', 'type' => 'string', 'required' => false, 'example' => 'bigint', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'CycleScheduleSettings' => [ + 'description' => 'The periodic scheduling settings.', + 'type' => 'object', + 'properties' => [ + 'CycleMigrationType' => ['description' => 'The synchronization type for periodic scheduling. Valid values:'."\n" + ."\n" + .'- `Full`: Full synchronization.'."\n" + ."\n" + .'- `OfflineIncremental`: Incremental synchronization in batch mode.', 'type' => 'string', 'required' => false, 'example' => 'Full', 'title' => ''], + 'ScheduleParameters' => ['description' => 'The scheduling parameters.', 'type' => 'string', 'required' => false, 'example' => 'bizdate=$bizdate', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'DdlHandlingSettings' => [ + 'description' => 'DDL handling settings.'."\n" + ."\n" + .'> "DDLHandlingSettings":\\[ { "Type":"Insert", "Action":"Normal" } ]', + 'type' => 'array', + 'items' => [ + 'description' => 'A single DDL handling setting.', + 'type' => 'object', + 'properties' => [ + 'Action' => ['description' => 'The handling action. Valid values:'."\n" + ."\n" + .'- `Ignore`: Ignores the DDL message.'."\n" + ."\n" + .'- `Critical`: Reports an error.'."\n" + ."\n" + .'- `Normal`: Processes the DDL message normally.', 'type' => 'string', 'required' => false, 'example' => 'Critical', 'title' => ''], + 'Type' => ['description' => 'The DDL type. Valid values:'."\n" + ."\n" + .'- `RenameColumn`: Renames a column.'."\n" + ."\n" + .'- `ModifyColumn`: Modifies a column.'."\n" + ."\n" + .'- `CreateTable`: Creates a table.'."\n" + ."\n" + .'- `TruncateTable`: Truncates a table.'."\n" + ."\n" + .'- `DropTable`: Drops a table.'."\n" + ."\n" + .'- `DropColumn`: Drops a column.'."\n" + ."\n" + .'- `AddColumn`: Adds a column.', 'type' => 'string', 'required' => false, 'example' => 'AddColumn', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'Id' => [ - 'description' => 'The ID of the cloned data source.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '19715', + 'RuntimeSettings' => [ + 'description' => 'The runtime settings.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the setting. Valid values:'."\n" + ."\n" + .'- `src.offline.datasource.max.connection`: The maximum number of connections to the source of a batch synchronization job.'."\n" + ."\n" + .'- `dst.offline.truncate`: Specifies whether to truncate the destination table before a batch job starts.'."\n" + ."\n" + .'- `runtime.offline.speed.limit.enable`: Specifies whether to enable throttling for a batch synchronization job.'."\n" + ."\n" + .'- `runtime.offline.concurrent`: The concurrency level of a batch synchronization job.'."\n" + ."\n" + .'- `runtime.enable.auto.create.schema`: Specifies whether to automatically create a destination schema.'."\n" + ."\n" + .'- `runtime.realtime.concurrent`: The concurrency level of a real-time synchronization job.'."\n" + ."\n" + .'- `runtime.realtime.failover.minute.dataxcdc`: The wait time in minutes for a failover restart.'."\n" + ."\n" + .'- `runtime.realtime.failover.times.dataxcdc`: The number of failover restart attempts.', 'type' => 'string', 'required' => false, 'example' => 'runtime.offline.concurrent'."\n", 'title' => ''], + 'Value' => ['description' => 'The value of the setting.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + 'required' => false, + 'description' => 'A runtime setting.', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FCD583B9-346B-5E75-82C1-4A7C192C48DB\\",\\n \\"Id\\": 19715\\n}","type":"json"}]', - 'title' => 'CloneDataSource', - 'description' => '1. This API operation is available for all DataWorks editions.'."\n" - .'2. You can call this operation only if you are assigned one of the following roles in DataWorks:'."\n" - ."\n" - .'* Tenant Owner, Workspace Administrator, Workspace Owner, and O\\&M', - ], - 'GetDataSource' => [ - 'summary' => 'Queries a data source by ID.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '232399', - 'abilityTreeNodes' => [ - 'FEATUREdideRWC5F7', + 'name' => 'JobName', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is deprecated. Use the `Name` parameter instead.', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'mysql_to_holo_sync_8772', 'title' => ''], ], - ], - 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'Owner', 'in' => 'query', - 'schema' => [ - 'description' => 'The data source ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '16035', - ], + 'schema' => ['description' => 'The job owner.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '3726346'], + ], + [ + 'name' => 'FileSpec', + 'in' => 'formData', + 'schema' => ['description' => 'The code for a job created in script mode.', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "resourceSettings": {'."\n" + .' "realtimeResourceSettings": {'."\n" + .' "requestedCu": 2,'."\n" + .' "resourceGroupIdentifier": "Serverless_res_group_123_456"'."\n" + .' },'."\n" + .' "offlineResourceSettings": {'."\n" + .' "requestedCu": 2,'."\n" + .' "resourceGroupIdentifier": "Serverless_res_group_123_456"'."\n" + .' }'."\n" + .' },'."\n" + .' "tableMappings": ['."\n" + .' {'."\n" + .' "sourceObjectSelectionRules": ['."\n" + .' {'."\n" + .' "expression": "autotest_hologres",'."\n" + .' "action": "Include",'."\n" + .' "expressionType": "Exact",'."\n" + .' "objectType": "Datasource"'."\n" + .' },'."\n" + .' {'."\n" + .' "expression": "auto_holo_2661647",'."\n" + .' "action": "Include",'."\n" + .' "expressionType": "Exact",'."\n" + .' "objectType": "Table"'."\n" + .' },'."\n" + .' {'."\n" + .' "expression": "public",'."\n" + .' "action": "Include",'."\n" + .' "expressionType": "Exact",'."\n" + .' "objectType": "Schema"'."\n" + .' }'."\n" + .' ],'."\n" + .' "transformationRules": ['."\n" + .' {'."\n" + .' "ruleTargetType": "Table",'."\n" + .' "ruleActionType": "SourceSchema",'."\n" + .' "ruleName": "SourceSchema_Table_BStf8aXPSCJjOWGe"'."\n" + .' },'."\n" + .' {'."\n" + .' "ruleTargetType": "Schema",'."\n" + .' "ruleActionType": "Rename",'."\n" + .' "ruleName": "Rename_Schema_3qWNOIsljtInvKJy"'."\n" + .' },'."\n" + .' {'."\n" + .' "ruleTargetType": "Table",'."\n" + .' "ruleActionType": "Rename",'."\n" + .' "ruleName": "Rename_Table_o3PVQq1aIKDGoVVW"'."\n" + .' },'."\n" + .' {'."\n" + .' "ruleTargetType": "Table",'."\n" + .' "ruleActionType": "DefineDstTableSettings",'."\n" + .' "ruleName": "DefineDstTableSettings_Table_BhJltOmOCIc81fzi"'."\n" + .' },'."\n" + .' {'."\n" + .' "ruleTargetType": "Table",'."\n" + .' "ruleActionType": "ColumnMapping",'."\n" + .' "ruleName": "ColumnMapping_Table_nP4hJPX1wh2W3fpo"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' ],'."\n" + .' "sourceDataSourceSettings": ['."\n" + .' {'."\n" + .' "dataSourceProperties": {'."\n" + .' "timeZone": "Asia/Shanghai"'."\n" + .' },'."\n" + .' "dataSourceName": "autotest_hologres"'."\n" + .' }'."\n" + .' ],'."\n" + .' "jobSettings": {'."\n" + .' "runtimeSettings": ['."\n" + ."\n" + .' ],'."\n" + .' "ddlHandlingSettings": ['."\n" + ."\n" + .' ],'."\n" + .' "columnDataTypeSettings": ['."\n" + ."\n" + .' ],'."\n" + .' "cycleScheduleSettings": {'."\n" + ."\n" + .' },'."\n" + .' "channelSettings": {'."\n" + .' "destinationChannelSettings": {'."\n" + .' "conflictMode": "replace",'."\n" + .' "dynamicColumnAction": "replay",'."\n" + .' "writeMode": "replay"'."\n" + .' },'."\n" + .' "sourceChannelSettings": {'."\n" + ."\n" + .' }'."\n" + .' }'."\n" + .' },'."\n" + .' "destinationDataSourceType": "Hologres",'."\n" + .' "transformationRules": ['."\n" + .' {'."\n" + .' "ruleTargetType": "Table",'."\n" + .' "ruleName": "SourceSchema_Table_BStf8aXPSCJjOWGe",'."\n" + .' "ruleActionType": "SourceSchema",'."\n" + .' "ruleExpression": {'."\n" + .' "columns": ['."\n" + .' {'."\n" + .' "name": "id",'."\n" + .' "category": "normal",'."\n" + .' "type": "BIGINT"'."\n" + .' },'."\n" + .' {'."\n" + .' "name": "decimal",'."\n" + .' "category": "normal",'."\n" + .' "type": "DECIMAL"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' },'."\n" + .' {'."\n" + .' "ruleTargetType": "Schema",'."\n" + .' "ruleName": "Rename_Schema_3qWNOIsljtInvKJy",'."\n" + .' "ruleActionType": "Rename",'."\n" + .' "ruleExpression": {'."\n" + .' "expression": "public"'."\n" + .' }'."\n" + .' },'."\n" + .' {'."\n" + .' "ruleTargetType": "Table",'."\n" + .' "ruleName": "Rename_Table_o3PVQq1aIKDGoVVW",'."\n" + .' "ruleActionType": "Rename",'."\n" + .' "ruleExpression": {'."\n" + .' "expression": "auto_holo_2661647_dst"'."\n" + .' }'."\n" + .' },'."\n" + .' {'."\n" + .' "ruleTargetType": "Table",'."\n" + .' "ruleName": "DefineDstTableSettings_Table_BhJltOmOCIc81fzi",'."\n" + .' "ruleActionType": "DefineDstTableSettings",'."\n" + .' "ruleExpression": {'."\n" + .' "ddlString": "BEGIN;'."\n" + .'CREATE TABLE IF NOT EXISTS public.auto_holo_2661647_dst ('."\n" + .' id BIGINT PRIMARY KEY,'."\n" + .' "decimal" DECIMAL(38,18)'."\n" + .');'."\n" + .'CALL SET_TABLE_PROPERTY(\'public.auto_holo_2661647_dst\', \'time_to_live_in_seconds\', \'3153600000\');'."\n" + .'CALL SET_TABLE_PROPERTY(\'public.auto_holo_2661647_dst\', \'orientation\', \'column\');'."\n" + .'CALL SET_TABLE_PROPERTY(\'public.auto_holo_2661647_dst\', \'binlog.level\', \'replica\');'."\n" + .'CALL SET_TABLE_PROPERTY(\'public.auto_holo_2661647_dst\', \'binlog.ttl\', \'2592000\');'."\n" + .'CALL SET_TABLE_PROPERTY(\'public.auto_holo_2661647_dst\', \'bitmap_columns\', \'"text","char","varchar"\');'."\n" + .'CALL SET_TABLE_PROPERTY(\'public.auto_holo_2661647_dst\', \'dictionary_encoding_columns\', \'"text":auto,"bytea":auto,"char":auto,"varchar":auto\');'."\n" + .'CALL SET_TABLE_PROPERTY(\'public.auto_holo_2661647_dst\', \'distribution_key\', \'"id"\');'."\n" + .'COMMIT;'."\n" + .'",'."\n" + .' "ddlType": "STRUCT"'."\n" + .' }'."\n" + .' },'."\n" + .' {'."\n" + .' "ruleTargetType": "Table",'."\n" + .' "ruleName": "ColumnMapping_Table_nP4hJPX1wh2W3fpo",'."\n" + .' "ruleActionType": "ColumnMapping",'."\n" + .' "ruleExpression": {'."\n" + .' "columnMapping": ['."\n" + .' {'."\n" + .' "sourceColName": "id",'."\n" + .' "dstColName": "id"'."\n" + .' },'."\n" + .' {'."\n" + .' "sourceColName": "decimal",'."\n" + .' "dstColName": "decimal"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' }'."\n" + .' ],'."\n" + .' "migrationType": "FullAndRealtimeIncremental",'."\n" + .' "destinationDataSourceSettings": ['."\n" + .' {'."\n" + .' "dataSourceProperties": {'."\n" + ."\n" + .' },'."\n" + .' "dataSourceName": "autotest_hologres"'."\n" + .' }'."\n" + .' ],'."\n" + .' "sourceDataSourceType": "Hologres"'."\n" + .'}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '9252F32F-D855-549E-8898-61CF5A733050', - ], - 'DataSource' => [ - 'description' => 'The information about the data source.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The data source ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16738', - ], - 'ProjectId' => [ - 'description' => 'The ID of the workspace with which the data source is associated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '52660', - ], - 'Name' => [ - 'description' => 'The name of the data source.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'Type' => [ - 'description' => 'The type of the data source.'."\n", - 'type' => 'string', - 'example' => 'hologres', - ], - 'ConnectionProperties' => [ - 'description' => 'The connection configurations of the data source, including the connection address, access identity, and environment information. The envType parameter specifies the environment in which the data source is used. Valid values of the envType parameter:'."\n" - ."\n" - .'* Dev: development environment'."\n" - .'* Prod: production environment'."\n" - ."\n" - .'The parameters that you need to configure for the data source vary based on the mode in which the data source is added. For more information, see [Data source connection information (ConnectionProperties)](~~2852465~~).'."\n", - 'type' => 'any', - 'example' => '{'."\n" - .' "envType": "Prod",'."\n" - .' "regionId": "cn-beijing",'."\n" - .' "instanceId": "hgprecn-cn-x0r3oun4k001",'."\n" - .' "database": "testdb",'."\n" - .' "securityProtocol": "authTypeNone",'."\n" - .' "authType": "Executor",'."\n" - .' "authIdentity": "1107550004253538"'."\n" - .'}', - ], - 'ConnectionPropertiesMode' => [ - 'description' => 'The mode in which the data source is added. The mode varies based on the data source type. Valid values:'."\n" - ."\n" - .'* InstanceMode: instance mode'."\n" - .'* UrlMode: connection string mode'."\n" - .'* CdhMode: CDH cluster mode'."\n", - 'type' => 'string', - 'example' => 'UrlMode', - ], - 'Description' => [ - 'description' => 'The description of the data source.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'CreateTime' => [ - 'description' => 'The time when the data source was added. This value is a UNIX timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1698286929333', - ], - 'CreateUser' => [ - 'description' => 'The ID of the user who adds the data source.'."\n", - 'type' => 'string', - 'example' => '1107550004253538', - ], - 'ModifyTime' => [ - 'description' => 'The time when the data source was last modified. This value is a UNIX timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1698286929333', - ], - 'ModifyUser' => [ - 'description' => 'The ID of the user who modifies the data source.'."\n", - 'type' => 'string', - 'example' => '1107550004253538', - ], - 'QualifiedName' => [ - 'description' => 'The unique business key of the data source. For example, the unique business key of a Hologres data source is in the `${tenantOwnerId}:${regionId}:${type}:${instanceId}:${database}` format.'."\n", - 'type' => 'string', - 'example' => '1107550004253538:cn-beijing:holo:hgprecn-cn-x0r3oun4k001:testdb', - ], - ], - ], + 'Id' => ['description' => 'The data integration job ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '11792', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. Use this ID to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => '4F6AB6B3-41FB-5EBB-AFB2-0C98D49DA2BB', 'title' => ''], + 'DIJobId' => ['description' => 'This field is deprecated. Use the `Id` field instead.', 'type' => 'integer', 'format' => 'int64', 'deprecated' => true, 'example' => '11792', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9252F32F-D855-549E-8898-61CF5A733050\\",\\n \\"DataSource\\": {\\n \\"Id\\": 16738,\\n \\"ProjectId\\": 52660,\\n \\"Name\\": \\"test\\",\\n \\"Type\\": \\"hologres\\",\\n \\"ConnectionProperties\\": \\"{\\\\n\\\\t\\\\\\"envType\\\\\\": \\\\\\"Prod\\\\\\",\\\\n\\\\t\\\\\\"regionId\\\\\\": \\\\\\"cn-beijing\\\\\\",\\\\n \\\\\\"instanceId\\\\\\": \\\\\\"hgprecn-cn-x0r3oun4k001\\\\\\",\\\\n \\\\\\"database\\\\\\": \\\\\\"testdb\\\\\\",\\\\n \\\\\\"securityProtocol\\\\\\": \\\\\\"authTypeNone\\\\\\",\\\\n \\\\\\"authType\\\\\\": \\\\\\"Executor\\\\\\",\\\\n \\\\\\"authIdentity\\\\\\": \\\\\\"1107550004253538\\\\\\"\\\\n}\\",\\n \\"ConnectionPropertiesMode\\": \\"UrlMode\\",\\n \\"Description\\": \\"test\\",\\n \\"CreateTime\\": 1698286929333,\\n \\"CreateUser\\": \\"1107550004253538\\",\\n \\"ModifyTime\\": 1698286929333,\\n \\"ModifyUser\\": \\"1107550004253538\\",\\n \\"QualifiedName\\": \\"1107550004253538:cn-beijing:holo:hgprecn-cn-x0r3oun4k001:testdb\\"\\n }\\n}","type":"json"}]', - 'title' => 'GetDataSource', - 'description' => '1. This API operation is available for all DataWorks editions.'."\n" - .'2. You can call this operation only if you are assigned one of the following roles in DataWorks:'."\n" + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Id\\": 11792,\\n \\"RequestId\\": \\"4F6AB6B3-41FB-5EBB-AFB2-0C98D49DA2BB\\",\\n \\"DIJobId\\": 11792\\n}","type":"json"}]', + 'title' => 'CreateDIJob', + 'description' => '- This API requires DataWorks Basic Edition or a higher edition.'."\n" ."\n" - .'* Tenant Owner, Workspace Administrator, Deployment, Development, Project Owner, and O\\&M'."\n", - ], - 'ListDataSources' => [ - 'summary' => 'Queries a list of data sources based on the business information of data sources.', - 'methods' => [ - 'get', + .'- This API creates a data integration synchronization task. Key parameters include `SourceDataSourceSettings`, `DestinationDataSourceSettings`, and `MigrationType`. The `TransformationRules` parameter defines transformation rules for synchronized tables, such as adding columns or replacing table names. The `TableMappings` parameter specifies which tables to synchronize and their mapping rules. The `JobSettings` parameter configures task settings, including column mapping and scheduling.', + 'changeSet' => [ + ['createdAt' => '2025-03-27T08:15:26.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-01-06T05:34:16.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'CreateDataAssetTag' => [ + 'summary' => 'Creates a tag.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '232439', - 'abilityTreeNodes' => [ - 'FEATUREdideRWC5F7', - ], + 'operationType' => 'create', + 'riskType' => 'none', + 'abilityTreeCode' => '250989', + 'abilityTreeNodes' => ['FEATUREdideKQ371B'], ], '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, - 'example' => '17820', - ], - ], - [ - 'name' => 'Name', + 'name' => 'Key', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the data source. Fuzzy match by data source name is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'The tag key.', 'type' => 'string', 'required' => true, 'maxLength' => 128, 'minLength' => 1, 'pattern' => '^([^\\x00-\\xff]|[\\w.,;/@\\n-])+$', 'example' => 'key1', 'title' => ''], ], [ - 'name' => 'Types', + 'name' => 'Values', 'in' => 'query', - 'style' => 'simple', + 'style' => 'json', 'schema' => [ - 'description' => 'The data source types. This parameter specifies a filter condition. You can specify multiple data source types.'."\n", + 'description' => 'The tag values.', 'type' => 'array', - 'items' => [ - 'description' => 'The data source type.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mysql', - ], - 'required' => false, - ], - ], - [ - 'name' => 'EnvType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The environment in which the data sources are used. Valid values:'."\n" - ."\n" - .'* Dev: development environment'."\n" - .'* Prod: production environment'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Prod', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'items' => ['description' => 'The tag value.', 'type' => 'string', 'maxLength' => 128, 'minLength' => 0, 'pattern' => '^([^\\x00-\\xff]|[\\w.,;/@\\n-])+$', 'required' => false, 'example' => 'v1', 'title' => ''], 'required' => false, - 'example' => '1', + 'maxItems' => 20, + 'minItems' => 0, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'PageSize', + 'name' => 'Description', '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 description of the tag.', 'type' => 'string', 'maxLength' => 1024, 'minLength' => 0, 'required' => false, 'example' => 'This is a description', 'title' => ''], ], [ - 'name' => 'SortBy', + 'name' => 'ValueType', 'in' => 'query', 'schema' => [ - 'description' => 'The field that you want to use to sort the data sources. Valid values:'."\n" + 'description' => 'The type of the tag value. Valid values:'."\n" ."\n" - .'* CreateTime'."\n" - .'* Id'."\n" - .'* Name'."\n" + .'- Boolean'."\n" ."\n" - .'Default value: CreateTime'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Id', - ], - ], - [ - 'name' => 'Order', - 'in' => 'query', - 'schema' => [ - 'description' => 'The order in which you want to sort the data sources. Valid values:'."\n" + .'- Int'."\n" ."\n" - .'* Desc: descending order'."\n" - .'* Asc: ascending order'."\n" + .'- String'."\n" ."\n" - .'Default value: Desc'."\n", + .'- Double', + 'enumValueTitles' => [], 'type' => 'string', + 'enum' => ['Boolean', 'Int', 'String', 'Double'], 'required' => false, - 'example' => 'Asc', + 'example' => 'String', + 'title' => '', ], ], [ - 'name' => 'Tags', + 'name' => 'Managers', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The tag of the data source. This parameter specifies a filter condition.'."\n" - ."\n" - .'* You can specify multiple tags, which are in the logical AND relation. For example, you can query the data sources that contain the following tags: `["tag1", "tag2", "tag3"]`.'."\n" - .'* If you do not configure this parameter, tag-based filtering is not performed. You can specify up to 10 tags.'."\n", - 'type' => 'string', + 'description' => 'The tag administrators.', + 'type' => 'array', + 'items' => ['description' => 'The tag administrator.', 'type' => 'string', 'required' => false, 'example' => '12345', 'title' => ''], 'required' => false, - 'example' => '["tag1", "tag2", "tag3"] ', + 'maxItems' => 20, + 'minItems' => 0, + 'title' => '', + 'example' => '', ], ], ], @@ -6901,279 +5446,188 @@ 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' => '7BE1433F-6D55-5D86-9344-CA6F7DD19B13', - ], - 'PagingInfo' => [ - 'description' => 'The pagination information.'."\n", - 'type' => 'object', - 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '131', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'DataSources' => [ - 'description' => 'The data source groups. Each element in the array indicates a data source group. Each data source group contains data sources in the development environment (if any) and the production environment.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the data source group, including data sources in the development environment (if any) and the production environment. Data sources in the development environment and the production environment have the same data source name and data source type, but different data source IDs.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the data source.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'Type' => [ - 'description' => 'The type of the data source.'."\n", - 'type' => 'string', - 'example' => 'mysql', - ], - 'DataSource' => [ - 'description' => 'The data sources. Each element is the information of a single data source with a unique data source ID.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the data source.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the data source.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16035', - ], - 'ConnectionProperties' => [ - 'description' => 'The connection configurations of the data source, including the connection address, access identity, and environment information. The envType parameter specifies the environment in which the data source is used. Valid values of the envType parameter:'."\n" - ."\n" - .'* Dev: development environment'."\n" - .'* Prod: production environment'."\n" - ."\n" - .'The parameters that you need to configure for the data source vary based on the mode in which the data source is added. For more information, see [Data source connection information (ConnectionProperties)](~~2852465~~).'."\n", - 'type' => 'any', - 'example' => '{'."\n" - .' "envType": "Prod",'."\n" - .' "regionId": "cn-beijing",'."\n" - .' "instanceId": "hgprecn-cn-x0r3oun4k001",'."\n" - .' "database": "testdb",'."\n" - .' "securityProtocol": "authTypeNone",'."\n" - .' "authType": "Executor",'."\n" - .' "authIdentity": "1107550004253538"'."\n" - .'}', - ], - 'ConnectionPropertiesMode' => [ - 'description' => 'The mode in which the data source is added. The mode varies based on the data source type. Valid values:'."\n" - ."\n" - .'* InstanceMode: instance mode'."\n" - .'* UrlMode: connection string mode'."\n", - 'type' => 'string', - 'example' => 'UrlMode', - ], - 'Description' => [ - 'description' => 'The description of the data source.'."\n", - 'type' => 'string', - 'example' => 'test ', - ], - 'CreateTime' => [ - 'description' => 'The time when the data source was added. This value is a UNIX timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1648711113000', - ], - 'CreateUser' => [ - 'description' => 'The ID of the user who adds the data source.'."\n", - 'type' => 'string', - 'example' => '1624387842781448', - ], - 'ModifyTime' => [ - 'description' => 'The time when the data source was last modified. This value is a UNIX timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1648711113000', - ], - 'ModifyUser' => [ - 'description' => 'The ID of the user who modifies the data source.'."\n", - 'type' => 'string', - 'example' => '1624387842781448', - ], - 'QualifiedName' => [ - 'description' => 'The unique business key of the data source. For example, the unique business key of a Hologres data source is in the `${tenantOwnerId}:${regionId}:${type}:${instanceId}:${database}` format.'."\n", - 'type' => 'string', - 'example' => '1648711121000:cn-beijing:odps:yongxunQA_beijing_standard', - ], - ], - ], - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0bc1ec92159376'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7BE1433F-6D55-5D86-9344-CA6F7DD19B13\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 131,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"DataSources\\": [\\n {\\n \\"Name\\": \\"test\\",\\n \\"Type\\": \\"mysql\\",\\n \\"DataSource\\": [\\n {\\n \\"Id\\": 16035,\\n \\"ConnectionProperties\\": \\"{\\\\n\\\\t\\\\\\"envType\\\\\\": \\\\\\"Prod\\\\\\",\\\\n\\\\t\\\\\\"regionId\\\\\\": \\\\\\"cn-beijing\\\\\\",\\\\n \\\\\\"instanceId\\\\\\": \\\\\\"hgprecn-cn-x0r3oun4k001\\\\\\",\\\\n \\\\\\"database\\\\\\": \\\\\\"testdb\\\\\\",\\\\n \\\\\\"securityProtocol\\\\\\": \\\\\\"authTypeNone\\\\\\",\\\\n \\\\\\"authType\\\\\\": \\\\\\"Executor\\\\\\",\\\\n \\\\\\"authIdentity\\\\\\": \\\\\\"1107550004253538\\\\\\"\\\\n}\\",\\n \\"ConnectionPropertiesMode\\": \\"UrlMode\\",\\n \\"Description\\": \\"test \\",\\n \\"CreateTime\\": 1648711113000,\\n \\"CreateUser\\": \\"1624387842781448\\",\\n \\"ModifyTime\\": 1648711113000,\\n \\"ModifyUser\\": \\"1624387842781448\\",\\n \\"QualifiedName\\": \\"1648711121000:cn-beijing:odps:yongxunQA_beijing_standard\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListDataSources', - 'description' => '1. This API operation is available for all DataWorks editions.'."\n" - .'2. You can call this operation only if you are assigned one of the following roles in DataWorks:'."\n" - ."\n" - .'* Tenant Owner, Workspace Administrator, Deploy, Develop, Visitor, Workspace Owner, O\\&M, Model Designer, Security Administrator, Data Analyst, OpenPlatform Administrator, and Data Governance Administrator'."\n", - ], - 'CreateDataSourceSharedRule' => [ - 'summary' => 'Creates a rule for sharing a data source to other workspaces or RAM users.', - 'methods' => [ - 'post', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], + ], ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'CreateDataAssetTag', + 'description' => 'This API operation is available only for DataWorks Enterprise Edition or a more advanced edition.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'CreateDataQualityAlertRule' => [ + 'summary' => 'Creates a data quality monitoring alert rule in a project.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '235541', - 'abilityTreeNodes' => [ - 'FEATUREdideRWC5F7', - ], + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdide3WJOKE'], ], 'parameters' => [ [ - 'name' => 'DataSourceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The data source ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '144544', - ], - ], - [ - 'name' => 'TargetProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the workspace to which you want to share the data source. You cannot share the data source to the workspace with which the data source is associated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '106560', - ], + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10001', 'title' => ''], ], [ - 'name' => 'SharedUser', - 'in' => 'query', - 'schema' => [ - 'description' => 'The user with which you want to share the data source. If you do not configure this parameter, the data source is shared to an entire workspace.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1107550004253538', - ], + 'name' => 'Condition', + 'in' => 'formData', + 'schema' => ['description' => 'The alert condition of the data quality monitoring rule.', 'type' => 'string', 'required' => true, 'example' => 'results.any { r -> r.status == \'fail\' && r.rule.severity == \'High\' }', 'title' => ''], ], [ - 'name' => 'EnvType', - 'in' => 'query', - 'schema' => [ - 'description' => 'Share data sources to the target project environment, including'."\n" - .'- Dev (Development Environment)'."\n" - .'- Prod (production environment)', - 'type' => 'string', - 'required' => true, - 'example' => 'Dev', - ], - ], - ], - 'responses' => [ - 200 => [ + 'name' => 'Target', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The monitored target of the data quality monitoring rule.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request. It is used to locate logs and troubleshoot problems.', + 'Type' => [ + 'description' => 'The type of the monitored target. Only DataQualityScan is supported.', + 'enumValueTitles' => [], 'type' => 'string', - 'example' => '46F594E6-84AB-5FA5-8144-6F3D149961E1', - ], - 'Id' => [ - 'description' => 'The sharing rule ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '105412', + 'required' => true, + 'example' => 'DataQualityScan', + 'title' => '', ], - ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"46F594E6-84AB-5FA5-8144-6F3D149961E1\\",\\n \\"Id\\": 105412\\n}","type":"json"}]', - 'title' => 'CreateDataSourceSharedRule', - 'description' => '1. This API operation is available for all DataWorks editions.'."\n" - .'2. If you want to share a data source from Workspace A to Workspace B, you must have the permissions to share the data source in both workspaces. You can call this operation only if you are assigned one of the following roles in DataWorks:'."\n" - ."\n" - .'* Tenant Owner, Tenant Administrator, Workspace Administrator, and Workspace Owner', - ], - 'DeleteDataSourceSharedRule' => [ - 'summary' => 'Deletes a sharing rule of a data source by ID.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '235549', - 'abilityTreeNodes' => [ - 'FEATUREdideRWC5F7', + 'Ids' => [ + 'description' => 'The list of monitored target IDs. Currently, only one ID can be set.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the monitored target.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '113646', 'title' => ''], + 'required' => true, + 'title' => '', + 'example' => '', + ], + ], + 'required' => true, + 'title' => '', + 'example' => '', + ], ], - ], - 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'query', + 'name' => 'Notification', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '数据源分享记录Id', - 'description' => 'The sharing rule ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The list of alert channels.', + 'type' => 'object', + 'properties' => [ + 'Channels' => [ + 'description' => 'The list of alert channels. You can set both `Email` and `Sms` at the same time. In other cases, only one channel can be set.', + 'type' => 'array', + 'items' => [ + 'description' => 'Alert channels.'."\n" + ."\n" + .'- Dingding'."\n" + ."\n" + .'- Weixin'."\n" + ."\n" + .'- Mail'."\n" + ."\n" + .'- Sms'."\n" + ."\n" + .'- Phone'."\n" + ."\n" + .'- Webhook'."\n" + ."\n" + .'- Feishu', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => true, + 'enum' => ['Dingding', 'Weixin', 'Mail', 'Sms', 'Phone', 'Webhook', 'Feishu'], + 'example' => 'Sms', + 'title' => '', + ], + 'required' => true, + 'title' => '', + 'example' => '', + ], + 'Receivers' => [ + 'description' => 'The alert recipients.', + 'type' => 'array', + 'items' => [ + 'description' => 'The alert recipients.', + 'type' => 'object', + 'properties' => [ + 'Extension' => ['description' => 'Additional configurations required for the alert recipients. When ReceiverType is DingdingUrl, you can set `{"atAll":true}` to mention all members.', 'type' => 'string', 'required' => false, 'example' => '{"atAll":true}'."\n", 'title' => ''], + 'ReceiverType' => [ + 'description' => 'The type of alert recipients.'."\n" + ."\n" + .'- AliUid'."\n" + ."\n" + .'- WebhookUrl'."\n" + ."\n" + .'- DingdingUrl'."\n" + ."\n" + .'- WeixinUrl'."\n" + ."\n" + .'- FeishuUrl'."\n" + ."\n" + .'- TaskOwner'."\n" + ."\n" + .'- DataQualityScanOwner'."\n" + ."\n" + .'- ShiftSchedule', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => true, + 'enum' => ['AliUid', 'WebhookUrl', 'DingdingUrl', 'WeixinUrl', 'FeishuUrl', 'TaskOwner', 'DataQualityScanOwner', 'ShiftSchedule'], + 'example' => 'TaskOwner', + 'title' => '', + ], + 'ReceiverValues' => [ + 'description' => 'The value of alert recipients.', + 'type' => 'array', + 'items' => ['description' => 'The value of alert recipients.'."\n" + ."\n" + .'- If ReceiverType is AliUid, enter the Alibaba Cloud account ID.'."\n" + ."\n" + .'- If ReceiverType is ShiftSchedule, enter the shift schedule ID.'."\n" + ."\n" + .'- If ReceiverType is WebhookUrl / DingdingUrl / FeishuUrl / WeixinUrl, enter the corresponding URL.', 'type' => 'string', 'required' => false, 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=a30bae7******'."\n", 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => true, + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'title' => '', + 'example' => '', + ], + ], 'required' => true, - 'example' => '22127', + 'title' => '', + 'example' => '', ], ], ], @@ -7181,812 +5635,1422 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The returned data.'."\n", + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => '64B-587A-8CED-969E1973887FXXX-TT', - ], - 'Success' => [ - 'description' => 'Whether the data source sharing rule is deleted successfully. The value is as follows:'."\n" - .'-true: The request is successful.'."\n" - .'-false: The request failed.', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0bc14115***159376359'], + 'Id' => ['description' => 'The user-defined rule ID returned after the monitoring rule is successfully created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1010543619', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateDataQualityAlertRule', + 'description' => 'DataWorks Basic Edition or a higher edition is required.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"64B-587A-8CED-969E1973887F****\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'DeleteDataSourceSharedRule', - 'description' => '1. This API operation is available for all DataWorks editions.'."\n" - .'2. If you want to delete a sharing rule of a data source from Workspace A to Workspace B, you must have the permissions to share the data source in Workspace A or Workspace B. You can call this operation only if you are assigned one of the following roles in DataWorks:'."\n" - ."\n" - .'* Tenant Owner, Tenant Administrator, Workspace Administrator, and Workspace Owner', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115***159376359\\",\\n \\"Id\\": 1010543619\\n}","type":"json"}]', ], - 'ListDataSourceSharedRules' => [ - 'summary' => 'Queries a list of sharing rules of a data source.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'CreateDataQualityEvaluationTask' => [ + 'summary' => 'Creates a DataWorks data quality monitor.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'deprecated' => false, + 'operationType' => 'write', + 'deprecated' => true, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '235551', - 'abilityTreeNodes' => [ - 'FEATUREdideRWC5F7', - ], + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '248294', + 'abilityTreeNodes' => ['FEATUREdide3WJOKE'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'DataSourceId', - 'in' => 'query', + 'name' => 'Target', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '数据源Id', - 'description' => 'The data source ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'title' => '', + 'description' => 'The data quality monitoring object.', + 'type' => 'object', + 'properties' => [ + 'DatabaseType' => [ + 'title' => '', + 'description' => 'The type of the database to which the table belongs. Valid values:'."\n" + .'- maxcompute'."\n" + .'- hologres'."\n" + .'- cdh'."\n" + .'- analyticdb_for_mysql'."\n" + .'- starrocks'."\n" + .'- emr'."\n" + .'- analyticdb_for_postgresql', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'maxcompute', + ], + 'TableGuid' => ['title' => '', 'description' => 'The unique ID of the table in Data Map.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'odps.api_test.ods_openapi_log_d'], + 'PartitionSpec' => ['title' => '', 'description' => 'The partition settings of the partitioned table.', 'type' => 'string', 'maxLength' => 255, 'required' => false, 'example' => 'pt=$[yyyymmdd-1]'], + ], 'required' => true, - 'example' => '1', + 'docRequired' => true, + 'example' => '', ], ], [ - 'name' => 'TargetProjectId', - 'in' => 'query', + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The description of the quality monitoring task.', 'type' => 'string', 'maxLength' => 65535, 'required' => false, 'example' => 'OpenAPI create a data quality monitoring test'], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The name of the quality monitoring task.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'maxLength' => 255, 'example' => 'OpenAPI create a data quality monitoring test'."\n"], + ], + [ + 'name' => 'RuntimeConf', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The extended configuration, a JSON-formatted string. This setting takes effect only for EMR-type data quality monitors.'."\n" + .'- queue: The YARN queue used when running EMR data quality validation. The default is the queue configured for the current project.'."\n" + .'- sqlEngine: The SQL engine used when running EMR data validation.'."\n" + .' + HIVE_SQL'."\n" + .' + SPARK_SQL', 'type' => 'string', 'required' => false, 'example' => '{ "queue": "default", "sqlEngine": "SPARK_SQL" }'], + ], + [ + 'name' => 'Trigger', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '数据源分享到的目标项目空间ID，不支持分享到本项目', - 'description' => 'The ID of the workspace to which the data source is shared. You cannot share the data source to the workspace with which the data source is associated.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'title' => '', + 'description' => 'The trigger configuration of the data quality validation task.', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '', + 'description' => 'The trigger type of the quality monitoring task. Valid values:'."\n" + .'- ByManual: triggered manually. This is the default value.'."\n" + .'- ByScheduledTaskInstance: triggered by an associated scheduling task.', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'example' => 'ByScheduledTaskInstance', + ], + 'TaskIds' => [ + 'title' => '', + 'description' => 'The list of scheduling task IDs. This parameter is valid when Type is set to ByScheduledTaskInstance.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the scheduling task.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30001', 'title' => ''], + 'required' => false, + 'example' => '', + ], + ], 'required' => false, - 'example' => '1', + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['title' => '', '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 ID.'."\n" + ."\n" + .'This parameter specifies the DataWorks workspace used by this API call.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10000'], + ], + [ + 'name' => 'Hooks', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The hook settings.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '', + 'description' => 'The type of the hook. Currently only one type is supported:'."\n" + .'- BlockTaskInstance: blocks the scheduling task from continuing to run. If the data quality monitor is triggered by a scheduling task, after the monitor finishes running, Hook.Condition is evaluated to determine whether to block the scheduling task from continuing to run.', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'example' => 'BlockTaskInstance', + ], + 'Condition' => ['title' => '', 'description' => 'The trigger condition of the hook. The hook action is triggered when this condition is met. Currently only two forms of expressions are supported:'."\n" + .'1. Specify a single combination of rule severity and rule validation status, for example `${severity} == "High" AND ${status} == "Critical"`, which means the condition is met if among the executed rules there exists a rule whose severity is High and whose validation result is Critical.'."\n" + .'2. Specify multiple combinations of rule severity and rule validation status, for example `(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")`, which means the condition is met if among the executed rules there exists a rule whose severity is High and validation result is Critical, or a rule whose severity is Normal and validation result is Critical, or a rule whose severity is Normal and validation result is Error. The enumeration of severity in the expression is the same as severity in DataQualityRule, and the enumeration of status is the same as status in DataQualityResult.', 'type' => 'string', 'required' => false, 'example' => '(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")'], + ], + 'required' => false, + 'description' => 'Hook', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'Notifications', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'The notification subscription configuration.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'DataSourceSharedRules' => [ - 'description' => 'The sharing rules of the data source.'."\n", + 'Condition' => ['title' => '', 'description' => 'The trigger condition of the notification. The notification is triggered when this condition is met. Currently only two forms of expressions are supported:'."\n" + ."\n" + .'Specify a single combination of rule severity and rule validation status, for example `${severity} == "High" AND ${status} == "Critical"`, which means the condition is met if among the executed rules there exists a rule whose severity is High and whose validation result is Critical.'."\n" + .'Specify multiple combinations of rule severity and rule validation status, for example `(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")`, which means the condition is met if among the executed rules there exists a rule whose severity is High and validation result is Critical, or a rule whose severity is Normal and validation result is Critical, or a rule whose severity is Normal and validation result is Error. The enumeration of severity in the expression is the same as severity in DataQualityRule, and the enumeration of status is the same as status in DataQualityResult.', 'type' => 'string', 'required' => false, 'example' => '(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")'], + 'Notifications' => [ + 'title' => '', + 'description' => 'The notification settings.', 'type' => 'array', 'items' => [ - 'description' => 'The sharing rule of the data source.'."\n", 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => 'The rule ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'DataSourceId' => [ - 'description' => 'The data source ID. You can call the [ListDataSources](~~211431~~) operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'SharedDataSourceName' => [ - 'description' => 'The name of the data source in the destination workspace.'."\n", - 'type' => 'string', - 'example' => 'targetProject.datasource', - ], - 'SourceProjectId' => [ - 'description' => 'The ID of the workspace with which the data source is associated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', + 'NotificationReceivers' => [ + 'title' => '', + 'description' => 'The alert recipient settings.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ReceiverType' => [ + 'title' => '', + 'description' => 'The type of the alert recipient. Valid values:'."\n" + .'- WebhookUrl: a custom webhook URL.'."\n" + .'- FeishuUrl: a Lark (Feishu) alert URL.'."\n" + .'- DingdingUrl: a DingTalk alert URL.'."\n" + .'- WeixinUrl: a WeCom (Enterprise WeChat) alert URL.'."\n" + .'- AliUid: an Alibaba Cloud user ID.', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'example' => 'DingdingUrl', + ], + 'Extension' => ['title' => '', 'description' => 'Additional parameters used when sending alerts, in JSON format. Supported keys:'."\n" + .'- atAll: whether to mention all members (@all) in the group when sending a DingTalk alert. This key takes effect when ReceiverType is set to DingdingUrl.', 'type' => 'string', 'required' => false, 'example' => '{ "atAll": true }'], + 'ReceiverValues' => [ + 'title' => '', + 'description' => 'The alert recipients.', + 'type' => 'array', + 'items' => [ + 'description' => 'The value of the recipient.'."\n" + ."\n" + .'- When the recipient type is AliUid, the value is a specific Alibaba Cloud user ID.'."\n" + .'- When the recipient type is DingdingUrl, the value is the alert URL of a specific DingTalk chatbot.'."\n" + .'- When the recipient type is WeixinUrl, the value is the alert URL of a specific WeCom (Enterprise WeChat) chatbot.'."\n" + .'- When the recipient type is FeishuUrl, the value is the alert URL of a specific Lark (Feishu) chatbot.'."\n" + .'- When the recipient type is WebhookUrl, the value is the URL of a specific custom webhook.', + 'enumValueTitles' => [], + 'type' => 'string', + 'maxLength' => 255, + 'required' => false, + 'example' => 'https://api.fc.aliyuncs.com/webhook', + 'title' => '', + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'description' => 'The alert recipient settings.', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', ], - 'TargetProjectId' => [ - 'description' => 'The ID of the workspace to which the data source is shared.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', + 'NotificationChannels' => [ + 'title' => '', + 'description' => 'The notification methods.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Channels' => [ + 'title' => '', + 'description' => 'The notification methods.', + 'type' => 'array', + 'items' => [ + 'description' => 'The alert method. Valid values:'."\n" + .'- Mail: email'."\n" + .'- Sms: text message'."\n" + .'- Phone: phone call'."\n" + .'- Feishu: Lark (Feishu)'."\n" + .'- Weixin: WeChat'."\n" + .'- Dingding: DingTalk'."\n" + .'- Webhook: custom webhook', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'example' => 'Mail', + 'title' => '', + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'description' => 'The notification methods.', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', ], - 'SharedUser' => [ - 'description' => 'The user in the workspace to which the data source is shared. If the data source is shared to the entire workspace, this parameter is left empty.'."\n", + ], + 'required' => false, + 'description' => 'The notification settings.', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'DataSourceId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the data source. You can call [ListDataSources](~~211431~~) to obtain the ID of the data source.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'DataQualityRules', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The list of data quality rules associated with the data quality monitor. If DataQualityRule.Id is specified, the rule corresponding to that ID is associated with the newly created quality monitor. If not specified, a new rule is created from the other fields and associated with the newly created quality monitor.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the data quality rule.', 'type' => 'string', 'default' => '255', 'required' => false, 'example' => 'OpenAPI test rules', 'title' => ''], + 'Enabled' => ['description' => 'Specifies whether the quality rule is enabled.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'Severity' => [ + 'description' => 'The business severity level of the rule (corresponding to strong/weak rules in the console). Valid values:'."\n" + .'- Normal'."\n" + .'- High', + 'enumValueTitles' => [], + 'type' => 'string', + 'enum' => ['High', 'Normal'], + 'required' => false, + 'example' => 'High', + 'title' => '', + ], + 'Description' => ['description' => 'The description of the data quality rule.', 'type' => 'string', 'maxLength' => 500, 'required' => false, 'example' => 'OpenAPI test rules'."\n", 'title' => ''], + 'TemplateCode' => ['description' => 'The unique identifier of the rule template that the rule references.', 'type' => 'string', 'required' => false, 'example' => 'SYSTEM:field:null_value:fixed:0', 'title' => ''], + 'SamplingConfig' => [ + 'description' => 'The parameters required when collecting samples.', + 'type' => 'object', + 'properties' => [ + 'Metric' => [ + 'description' => 'The name of the sampling metric. Valid values:'."\n" + .'- Count: the number of rows in the table.'."\n" + .'- Min: the minimum value of the field.'."\n" + .'- Max: the maximum value of the field.'."\n" + .'- Avg: the average value of the field.'."\n" + .'- DistinctCount: the number of distinct values of the field.'."\n" + .'- DistinctPercent: the ratio of the number of distinct values of the field to the number of rows.'."\n" + .'- DuplicatedCount: the number of duplicate values of the field.'."\n" + .'- DuplicatedPercent: the ratio of the number of duplicate values of the field to the number of rows.'."\n" + .'- TableSize: the size of the table.'."\n" + .'- NullValueCount: the number of rows in which the field is null.'."\n" + .'- NullValuePercent: the ratio of rows in which the field is null.'."\n" + .'- GroupCount: after grouping by the field value, the count of rows for each value.'."\n" + .'- CountNotIn: the number of rows whose enumeration values do not match.'."\n" + .'- CountDistinctNotIn: the number of distinct values whose enumeration values do not match.'."\n" + .'- UserDefinedSql: collect samples using a custom SQL statement.', + 'enumValueTitles' => [], 'type' => 'string', - 'example' => '1', + 'required' => false, + 'example' => 'NullValueCount', + 'title' => '', ], - 'EnvType' => [ - 'description' => 'The environment to which the target data source belongs. The values are as follows:'."\n" - .'- Dev: the development environment.'."\n" - .'- Prod: the production environment.', + 'MetricParameters' => ['description' => 'The parameters required when collecting samples.', 'type' => 'string', 'required' => false, 'example' => '{ "Columns": [ "id", "name" ] , "SQL": "select count(1) from table;"}', 'title' => ''], + 'SettingConfig' => ['description' => 'The runtime parameter statements inserted and executed before the sampling statement is executed. The maximum length is 1000 characters. Only MaxCompute is currently supported.', 'type' => 'string', 'maxLength' => 1000, 'required' => false, 'example' => 'odps.sql.type.system.odps2=True,odps.sql.hive.compatible=True', 'title' => ''], + 'SamplingFilter' => ['description' => 'An additional filter condition applied during sampling to exclude data that is not of interest. The maximum length is 16,777,215 characters.', 'type' => 'string', 'required' => false, 'example' => 'status != \'Succeeded\'', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'CheckingConfig' => [ + 'description' => 'The sample validation settings.', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The method used to compute the threshold. Valid values:'."\n" + ."\n" + .'- Fixed'."\n" + .'- Fluctation'."\n" + .'- FluctationDiscreate'."\n" + .'- Auto'."\n" + .'- Average', + 'enumValueTitles' => [], 'type' => 'string', - 'example' => 'Dev', + 'required' => false, + 'example' => 'Fixed', + 'title' => '', ], - 'CreateTime' => [ - 'description' => 'The time when the rule was created. This value is a UNIX timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1724379762000', + 'ReferencedSamplesFilter' => ['description' => 'For some threshold types, reference samples must be queried and aggregated to derive the threshold used for comparison. This field uses an expression to describe how the reference samples are queried.', 'type' => 'string', 'required' => false, 'example' => '{"bizdate": ["-1"]}', 'title' => ''], + 'Thresholds' => [ + 'description' => 'The validation threshold settings.', + 'type' => 'object', + 'properties' => [ + 'Expected' => [ + 'description' => 'The expected threshold settings.', + 'type' => 'object', + 'properties' => [ + 'Operator' => [ + 'description' => 'The comparison operator. Valid values:'."\n" + .'- \\>'."\n" + .'- \\>='."\n" + .'- <'."\n" + .'- <='."\n" + .'- !='."\n" + .'- =', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'example' => '=', + 'title' => '', + ], + 'Value' => ['description' => 'The threshold value.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], + 'Expression' => ['description' => 'The threshold expression.'."\n" + ."\n" + .'Fluctuation-type rules must use expressions to specify the fluctuation threshold. For example:'."\n" + ."\n" + .'- Fluctuation increase greater than 0.01: $checkValue > 0.01'."\n" + .'- Fluctuation decrease greater than 0.01: $checkValue < -0.01'."\n" + .'- Absolute fluctuation rate: abs($checkValue) > 0.01'."\n" + ."\n" + .'Fixed-value rules can also use expressions to configure thresholds. If both are configured, the expression takes precedence over Operator and Value.', 'type' => 'string', 'required' => false, 'example' => '$checkValue > 0.01', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Warned' => [ + 'description' => 'The threshold settings for the normal warning level.', + 'type' => 'object', + 'properties' => [ + 'Operator' => [ + 'description' => 'The comparison operator. Valid values:'."\n" + .'- \\>'."\n" + .'- \\>='."\n" + .'- <'."\n" + .'- <='."\n" + .'- !='."\n" + .'- =', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'example' => '>', + 'title' => '', + ], + 'Value' => ['description' => 'The threshold value.', 'type' => 'string', 'required' => false, 'example' => '0.001', 'title' => ''], + 'Expression' => ['description' => 'The threshold expression.'."\n" + ."\n" + .'Fluctuation-type rules must use expressions to specify the fluctuation threshold. For example:'."\n" + ."\n" + .'- Fluctuation increase greater than 0.01: $checkValue > 0.01'."\n" + .'- Fluctuation decrease greater than 0.01: $checkValue < -0.01'."\n" + .'- Absolute fluctuation rate: abs($checkValue) > 0.01'."\n" + ."\n" + .'Fixed-value rules can also use expressions to configure thresholds. If both are configured, the expression takes precedence over Operator and Value.', 'type' => 'string', 'required' => false, 'example' => '$checkValue > 0.01', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Critical' => [ + 'description' => 'The threshold settings for the critical warning level.', + 'type' => 'object', + 'properties' => [ + 'Operator' => [ + 'description' => 'The comparison operator. Valid values:'."\n" + .'- \\>'."\n" + .'- \\>='."\n" + .'- <'."\n" + .'- <='."\n" + .'- !='."\n" + .'- =', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'example' => '>', + 'title' => '', + ], + 'Value' => ['description' => 'The threshold value.', 'type' => 'string', 'required' => false, 'example' => '0.01', 'title' => ''], + 'Expression' => ['description' => 'The threshold expression.'."\n" + ."\n" + .'Fluctuation-type rules must use expressions to specify the fluctuation threshold. For example:'."\n" + ."\n" + .'- Fluctuation increase greater than 0.01: $checkValue > 0.01'."\n" + .'- Fluctuation decrease greater than 0.01: $checkValue < -0.01'."\n" + .'- Absolute fluctuation rate: abs($checkValue) > 0.01'."\n" + ."\n" + .'Fixed-value rules can also use expressions to configure thresholds. If both are configured, the expression takes precedence over Operator and Value.', 'type' => 'string', 'required' => false, 'example' => '$checkValue > 0.01', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'CreateUser' => [ - 'description' => 'The ID of the user who creates the rule.'."\n", - 'type' => 'string', - 'example' => '1', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'ErrorHandlers' => [ + 'description' => 'The list of error handlers for issues detected by the quality rule validation.', + 'type' => 'array', + 'items' => [ + 'description' => 'An error handler for issues detected by the quality rule validation.', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The type of the handler. Valid values:'."\n" + ."\n" + .'- SaveErrorData: retains the problematic data.', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'example' => 'SaveErrorData', + 'title' => '', + ], + 'ErrorDataFilter' => ['description' => 'For custom SQL rules, the user must specify a SQL statement to filter the problematic data.', 'type' => 'string', 'required' => false, 'example' => 'SELECT * FROM ods_api_log WHERE status = \'Error\';', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'Id' => ['description' => 'The ID of the rule.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2176', 'title' => ''], ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2d9ce-38ef-4923-baf6-391a7e656'], + 'Id' => ['description' => 'The ID of the newly created data quality monitor.', 'type' => 'integer', 'format' => 'int64', 'example' => '10001', 'title' => ''], ], + 'example' => '', ], ], ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], + ], + ], 'staticInfo' => [ - 'returnType' => 'synchronous', + 'substitutions' => ['dataworks-public::2024-05-18::CreateDataQualityScan'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"DataSourceSharedRules\\": [\\n {\\n \\"Id\\": 101412,\\n \\"DataSourceId\\": 265133,\\n \\"SharedDataSourceName\\": \\"targetProject.datasource\\",\\n \\"SourceProjectId\\": 106560,\\n \\"TargetProjectId\\": 106561,\\n \\"SharedUser\\": \\"1107550004253538\\",\\n \\"EnvType\\": \\"Dev\\",\\n \\"CreateTime\\": 1724379762000,\\n \\"CreateUser\\": \\"1107550****\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListDataSourceSharedRules', - 'description' => '1. This API operation is available for all DataWorks editions.'."\n" - .'2. If you want to query the sharing rules of a data source that is associated with Workspace A, you must have the permissions to share the data source in Workspace A. You can call this operation only if you are assigned one of the following roles in DataWorks:'."\n" - ."\n" - .'* Tenant Owner, Tenant Administrator, Workspace Administrator, and Workspace Owner', - ], - 'DeleteComputeResource' => [ - 'summary' => 'Deletes the specified computing resource based on the computing resource ID.', - 'methods' => [ - 'get', - 'post', + 'title' => 'Creates a data quality monitor', + 'description' => 'DataWorks Basic Edition or higher is required.', + 'changeSet' => [ + ['createdAt' => '2025-03-31T05:58:07.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-03-27T06:36:24.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-01-15T08:15:09.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-12-23T06:29:09.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2d9ce-38ef-4923-baf6-391a7e656\\",\\n \\"Id\\": 10001\\n}","type":"json"}]', + ], + 'CreateDataQualityEvaluationTaskInstance' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'deprecated' => false, + 'deprecated' => true, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '232438', - 'abilityTreeNodes' => [ - 'FEATUREdideRWC5F7', - ], + 'abilityTreeCode' => '250253', + 'abilityTreeNodes' => ['FEATUREdideGK4B66'], ], 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'query', + 'name' => 'DataQualityEvaluationTaskId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the data quality evaluation task.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '2000011', 'title' => ''], + ], + [ + 'name' => 'RuntimeResource', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The computing resource ID, the unique identifier of the data source.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234', + 'description' => 'The resource group information. This parameter is required when you run a data quality evaluation on a non-MaxCompute data source.', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupId' => ['description' => 'The identifier of the scheduling resource group configured for the task to run.', 'type' => 'string', 'required' => false, 'example' => '63900680', 'title' => ''], + 'Cu' => ['description' => 'The CU consumption configured for the task to run. This parameter must be specified if a serverless resource group is used.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '0.25', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'Parameters', + 'in' => 'formData', + 'schema' => ['description' => 'The execution parameters of the data quality evaluation in the JSON format. The following keys are available:'."\n" + .'- triggerTime: the millisecond timestamp of the trigger time. This is the base time for the $[yyyymmdd] expression in the data range of data quality monitoring. This key is required.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{ "triggerTime": 1733284062000 }', 'title' => ''], + ], [ 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234', - ], + '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 ID.'."\n" + ."\n" + .'This parameter specifies the DataWorks workspace in which this API operation is performed.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10000', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Responses'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID. You can use the request ID to locate logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => 'B56432E0-2112-5C97-88D0-AA0AE5****'."\n", - ], - 'Success' => [ - 'description' => 'Indicates whether the call succeeded.'."\n" - ."\n" - .'* true: The call is successful.'."\n" - .'* false: The call failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'ecb967ec-c137-48****'], + 'Id' => ['description' => 'The ID of the data quality monitoring instance.', 'type' => 'integer', 'format' => 'int64', 'example' => '22130', 'title' => ''], ], + 'example' => '', ], ], ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], + ], + ], 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B56432E0-2112-5C97-88D0-AA0AE5****\\\\n\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'DeleteComputeResource', - 'description' => '1. This API operation is available for all DataWorks editions.'."\n" - .'2. You can call this operation only if you are assigned one of the following roles in DataWorks:'."\n" - .'3. Tenant Owner, Workspace Administrator, Workspace Owner, and O\\&M.'."\n", - ], - 'GetComputeResource' => [ - 'summary' => 'Queries the specified computing resource based on the computing resource ID.', - 'methods' => [ - 'get', - 'post', + 'substitutions' => ['dataworks-public::2024-05-18::CreateDataQualityScanRun'], ], - 'schemes' => [ - 'https', + 'title' => 'Creates a data quality evaluation monitoring instance', + 'summary' => 'Creates a data quality evaluation task instance.', + 'description' => 'You must purchase DataWorks Basic Edition or higher to use this operation.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ecb967ec-c137-48****\\",\\n \\"Id\\": 22130\\n}","type":"json"}]', + ], + 'CreateDataQualityRule' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, + 'operationType' => 'write', + 'deprecated' => true, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '232399', - 'abilityTreeNodes' => [ - 'FEATUREdideRWC5F7', - ], + 'abilityTreeCode' => '247801', + 'abilityTreeNodes' => ['FEATUREdide3WJOKE'], ], 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'query', + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the rule.', 'type' => 'string', 'required' => true, 'maxLength' => 255, 'example' => 'The table cannot be empty.', 'title' => ''], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the DataWorks workspace.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10726', 'title' => ''], + ], + [ + 'name' => 'Enabled', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to enable the data quality rule.', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'Severity', + 'in' => 'formData', 'schema' => [ - 'description' => 'The computing resource ID, which is the unique identifier for the resource.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '11792', + 'description' => 'The severity of the rule for the business (corresponding to the strong/weak rule on the page). Valid values:'."\n" + .'- Normal'."\n" + .'- High', + 'enumValueTitles' => [], + 'type' => 'string', + 'default' => 'Normal', + 'enum' => ['High', 'Normal'], + 'required' => false, + 'example' => 'Normal', + 'title' => '', ], ], [ - 'name' => 'ProjectId', - 'in' => 'query', + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['description' => 'The description of the rule. The maximum length is 500 characters.', 'type' => 'string', 'maxLength' => 500, 'required' => false, 'example' => 'this is a odps _sql task'."\n", 'title' => ''], + ], + [ + 'name' => 'Target', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The ID of the DataWorks workspace.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The object monitored by the rule.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The type of the monitored object.'."\n" + ."\n" + .'- Table', 'type' => 'string', 'docRequired' => false, 'required' => false, 'example' => 'Table', 'title' => ''], + 'DatabaseType' => ['description' => 'For a table-type dataset, the type of database to which the table belongs.'."\n" + .'- maxcompute'."\n" + .'- emr'."\n" + .'- cdh'."\n" + .'- hologres'."\n" + .'- analyticdb_for_postgresql'."\n" + .'- analyticdb_for_mysql'."\n" + .'- starrocks', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => 'maxcompute'."\n", 'title' => ''], + 'TableGuid' => ['description' => 'The unique ID of the table in Data Map on which the rule operates.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'odps.unit_test.tb_unit_test'."\n", 'title' => ''], + 'PartitionSpec' => ['description' => 'The partition settings of the partitioned table.', 'type' => 'string', 'required' => false, 'example' => 'ds=$[yyyymmdd-1]'."\n", 'title' => ''], + ], 'required' => true, - 'example' => '10003', + 'docRequired' => true, + 'title' => '', + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'TemplateCode', + 'in' => 'formData', + 'schema' => ['description' => 'The unique identifier of the rule template that the rule references.', 'type' => 'string', 'docRequired' => true, 'default' => 'SYSTEM:user_defined_sql', 'required' => true, 'example' => 'SYSTEM:table:table_count:fixed', 'title' => ''], + ], + [ + 'name' => 'SamplingConfig', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The returned result.'."\n", + 'description' => 'The settings required for sample collection.', + 'type' => 'object', + 'properties' => [ + 'Metric' => ['description' => 'The name of the metric to be sampled. You do not need to specify this parameter when a template is used.'."\n" + .'- Count: the number of rows in the table.'."\n" + .'- Min: the minimum value of the field.'."\n" + .'- Max: the maximum value of the field.'."\n" + .'- Avg: the average value of the field.'."\n" + .'- DistinctCount: the number of distinct values of the field.'."\n" + .'- DistinctPercent: the ratio of the number of distinct values of the field to the number of data rows.'."\n" + .'- DuplicatedCount: the number of duplicate values of the field.'."\n" + .'- DuplicatedPercent: the ratio of the number of duplicate values of the field to the number of data rows.'."\n" + .'- TableSize: the size of the table.'."\n" + .'- NullValueCount: the number of rows in which the field is null.'."\n" + .'- NullValuePercent: the ratio of rows in which the field is null.'."\n" + .'- GroupCount: the values aggregated by field value and the corresponding number of data rows for each value.'."\n" + .'- CountNotIn: the number of rows whose enum values do not match.'."\n" + .'- CountDistinctNotIn: the number of distinct values that do not match the enum values.'."\n" + .'- UserDefinedSql: collects samples by using a custom SQL statement.', 'type' => 'string', 'required' => false, 'example' => 'Count', 'title' => ''], + 'MetricParameters' => ['description' => 'The parameters required during sample collection.', 'type' => 'string', 'required' => false, 'example' => '{ "Columns": [ "id", "name" ] , "SQL": "select count(1) from table;"}', 'title' => ''], + 'SettingConfig' => ['description' => 'The runtime parameter setting statements to be inserted and executed before the sampling statement is executed. The maximum length is 1000 characters. Only MaxCompute is supported.', 'type' => 'string', 'maxLength' => 1000, 'required' => false, 'example' => 'SET odps.sql.udf.timeout=600s; '."\n" + .'SET odps.sql.python.version=cp27;', 'title' => ''], + 'SamplingFilter' => ['description' => 'The condition used to perform a secondary filter on the irrelevant data during sampling. The maximum length is 16777215 characters.', 'type' => 'string', 'required' => false, 'example' => 'id IS NULL'."\n", 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'CheckingConfig', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The sample check settings.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID. You can use the request ID to locate logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '9252F32F-D855-549E-8898-61CF5A733050', - ], - 'ComputeResource' => [ - 'description' => 'The details of the computing resource.'."\n", + 'Type' => ['description' => 'The threshold calculation method. You do not need to specify this parameter when a template is used.'."\n" + .'- Fixed'."\n" + .'- Fluctation'."\n" + .'- FluctationDiscreate'."\n" + .'- Auto'."\n" + .'- Average'."\n" + .'- Variance', 'type' => 'string', 'required' => false, 'example' => 'Fixed', 'title' => ''], + 'ReferencedSamplesFilter' => ['description' => 'Some types of thresholds require querying for reference samples and then summarizing the values of the reference samples to derive the threshold to be compared. An expression is used here to represent the query method for the reference samples.', 'type' => 'string', 'required' => false, 'example' => '{ "bizdate": [ "-1", "-7", "-1m" ] }'."\n", 'title' => ''], + 'Thresholds' => [ + 'description' => 'The threshold settings.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the computing resource.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16738', - ], - 'ProjectId' => [ - 'description' => 'The ID of the workspace to which the computing resource belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '52660', - ], - 'Name' => [ - 'description' => 'The name of the computing resource.'."\n", - 'type' => 'string', - 'example' => 'MyCs', - ], - 'Type' => [ - 'description' => 'The type of the computing resource.'."\n", - 'type' => 'string', - 'example' => 'hologres', - ], - 'ConnectionProperties' => [ - 'description' => 'The specific connection configuration details for the computing resource, including the connection address, access identity, and environment information. envType, which specifies the computing resource environment, is a property of this object. Valid values:'."\n" - ."\n" - .'* Dev'."\n" - .'* Prod Different types of computing resources have different attribute specifications under various configuration modes (ConnectionPropertiesMode).'."\n", - 'type' => 'any', - 'example' => '{'."\n" - .' "envType": "Prod",'."\n" - .' "regionId": "cn-beijing",'."\n" - .' "instanceId": "hgprecn-cn-x0r3oun4k001",'."\n" - .' "database": "testdb",'."\n" - .' "securityProtocol": "authTypeNone",'."\n" - .' "authType": "Executor",'."\n" - .' "authIdentity": "1107550004253538"'."\n" - .'}', - ], - 'ConnectionPropertiesMode' => [ - 'description' => 'The addition category of the computing resource. Different types will have different subtypes, each with corresponding parameter constraints. For instance:'."\n" - ."\n" - .'* InstanceMode: Instance mode'."\n" - .'* UrlMode: Connection String Mode'."\n" - .'* CdhMode: CDH mode'."\n", - 'type' => 'string', - 'example' => 'InstanceMode', - ], - 'Description' => [ - 'description' => 'The description of the computing resource.'."\n", - 'type' => 'string', - 'example' => 'My Description', - ], - 'CreateTime' => [ - 'description' => 'The creation time, in timestamp format.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1698286929333', - ], - 'CreateUser' => [ - 'description' => 'The ID of the creator.'."\n", - 'type' => 'string', - 'example' => '1107550004253538', - ], - 'ModifyTime' => [ - 'description' => 'The last modification time, in timestamp format.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1698286929333', - ], - 'ModifyUser' => [ - 'description' => 'The ID of the modifier.'."\n", - 'type' => 'string', - 'example' => '1107550004253538', + 'Expected' => [ + 'description' => 'The expected threshold settings.', + 'type' => 'object', + 'properties' => [ + 'Operator' => ['description' => 'The comparison operator:'."\n" + .'- \\>'."\n" + .'- \\>='."\n" + .'- \\<'."\n" + .'- \\<='."\n" + .'- !='."\n" + .'- =', 'type' => 'string', 'required' => false, 'example' => '>', 'title' => ''], + 'Value' => ['description' => 'The threshold value.', 'type' => 'string', 'required' => false, 'example' => '100.0', 'title' => ''], + 'Expression' => ['description' => 'The threshold expression.'."\n" + ."\n" + .'For a fluctuation-type rule, you must use an expression to represent the fluctuation threshold. Examples:'."\n" + ."\n" + .'- Fluctuation rises above 0.01: $checkValue > 0.01 '."\n" + .'- Fluctuation drops below -0.01: $checkValue < -0.01 '."\n" + .'- Absolute value of the fluctuation: abs($checkValue) > 0.01'."\n" + ."\n" + .'For a fixed-value type rule, you can also use an expression to configure the threshold. If both are configured at the same time, the expression takes precedence over Operator and Value.', 'type' => 'string', 'required' => false, 'example' => '$checkValue <= 0.01', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'QualifiedName' => [ - 'description' => 'The business unique key for the computing resource. For example, the format for Hologres is ${tenantOwnerId}:${regionId}:${type}:${instanceId}:${database}.'."\n", - 'type' => 'string', - 'example' => '1107550004253538:cn-beijing:holo:hgprecn-cn-x0r3oun4k001:testdb', + 'Warned' => [ + 'description' => 'The threshold settings for a normal warning.', + 'type' => 'object', + 'properties' => [ + 'Operator' => ['description' => 'The comparison operator:'."\n" + .'- \\>'."\n" + .'- \\>='."\n" + .'- \\<'."\n" + .'- \\<='."\n" + .'- !='."\n" + .'- =', 'type' => 'string', 'required' => false, 'example' => '>', 'title' => ''], + 'Value' => ['description' => 'The threshold value.', 'type' => 'string', 'required' => false, 'example' => '100.0', 'title' => ''], + 'Expression' => ['description' => 'The threshold expression.'."\n" + ."\n" + .'For a fluctuation-type rule, you must use an expression to represent the fluctuation threshold. Examples:'."\n" + ."\n" + .'- Fluctuation rises above 0.01: $checkValue > 0.01 '."\n" + .'- Fluctuation drops below -0.01: $checkValue < -0.01 '."\n" + .'- Absolute value of the fluctuation: abs($checkValue) > 0.01'."\n" + ."\n" + .'For a fixed-value type rule, you can also use an expression to configure the threshold. If both are configured at the same time, the expression takes precedence over Operator and Value.', 'type' => 'string', 'required' => false, 'example' => '$checkValue > 0.01'."\n", 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'WhetherDefault' => [ - 'description' => 'Specifies whether it is the default computing resource.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Critical' => [ + 'description' => 'The threshold settings for a critical warning.', + 'type' => 'object', + 'properties' => [ + 'Operator' => ['description' => 'The comparison operator:'."\n" + .'- \\>'."\n" + .'- \\>='."\n" + .'- \\<'."\n" + .'- \\<='."\n" + .'- !='."\n" + .'- =', 'type' => 'string', 'required' => false, 'example' => '>', 'title' => ''], + 'Value' => ['description' => 'The threshold value.', 'type' => 'string', 'required' => false, 'example' => '100.0', 'title' => ''], + 'Expression' => ['description' => 'The threshold expression.'."\n" + ."\n" + .'For a fluctuation-type rule, you must use an expression to represent the fluctuation threshold. Examples:'."\n" + ."\n" + .'- Fluctuation rises above 0.01: $checkValue > 0.01 '."\n" + .'- Fluctuation drops below -0.01: $checkValue < -0.01 '."\n" + .'- Absolute value of the fluctuation: abs($checkValue) > 0.01'."\n" + ."\n" + .'For a fixed-value type rule, you can also use an expression to configure the threshold. If both are configured at the same time, the expression takes precedence over Operator and Value.', 'type' => 'string', 'required' => false, 'example' => '$checkValue > 0.05', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'ErrorHandlers', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The list of issue handlers for the data quality rule check.', + 'type' => 'array', + 'items' => [ + 'description' => 'The issue handler for the data quality rule check.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The handler type:'."\n" + .'- SaveErrorData', 'type' => 'string', 'required' => false, 'example' => 'SaveErrorData', 'title' => ''], + 'ErrorDataFilter' => ['description' => 'For a custom SQL rule, you must specify an SQL statement to filter problematic data.', 'type' => 'string', 'required' => false, 'example' => 'SELECT * FROM tb_api_log WHERE id IS NULL'."\n", 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The ID of the API request.', 'type' => 'string', 'example' => '691CA452-D37A-4ED0-9441'."\n"], + 'Id' => ['description' => 'The ID of the rule.', 'type' => 'integer', 'format' => 'int64', 'example' => '19715', 'title' => ''], ], + 'example' => '', ], ], ], 'staticInfo' => [ - 'returnType' => 'synchronous', + 'substitutions' => ['dataworks-public::2024-05-18::CreateDataQualityScan'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9252F32F-D855-549E-8898-61CF5A733050\\",\\n \\"ComputeResource\\": {\\n \\"Id\\": 16738,\\n \\"ProjectId\\": 52660,\\n \\"Name\\": \\"MyCs\\",\\n \\"Type\\": \\"hologres\\",\\n \\"ConnectionProperties\\": \\"{\\\\n\\\\t\\\\\\"envType\\\\\\": \\\\\\"Prod\\\\\\",\\\\n\\\\t\\\\\\"regionId\\\\\\": \\\\\\"cn-beijing\\\\\\",\\\\n \\\\\\"instanceId\\\\\\": \\\\\\"hgprecn-cn-x0r3oun4k001\\\\\\",\\\\n \\\\\\"database\\\\\\": \\\\\\"testdb\\\\\\",\\\\n \\\\\\"securityProtocol\\\\\\": \\\\\\"authTypeNone\\\\\\",\\\\n \\\\\\"authType\\\\\\": \\\\\\"Executor\\\\\\",\\\\n \\\\\\"authIdentity\\\\\\": \\\\\\"1107550004253538\\\\\\"\\\\n}\\",\\n \\"ConnectionPropertiesMode\\": \\"InstanceMode\\",\\n \\"Description\\": \\"My Description\\",\\n \\"CreateTime\\": 1698286929333,\\n \\"CreateUser\\": \\"1107550004253538\\",\\n \\"ModifyTime\\": 1698286929333,\\n \\"ModifyUser\\": \\"1107550004253538\\",\\n \\"QualifiedName\\": \\"1107550004253538:cn-beijing:holo:hgprecn-cn-x0r3oun4k001:testdb\\",\\n \\"WhetherDefault\\": true\\n }\\n}","type":"json"}]', - 'title' => 'GetComputeResource', + 'title' => 'Create a data quality rule', + 'summary' => 'Creates a data quality rule.', + 'description' => 'You must purchase DataWorks Basic Edition or higher to use this feature.', + 'extraInfo' => 'Rule template code list:'."\n" + .'- Custom SQL: SYSTEM:user_defined_sql'."\n" + ."\n" + .'- Table row count greater than 0: SYSTEM:table:table_count:fixed:0'."\n" + .'- Table row count, fixed value: SYSTEM:table:table_count:fixed'."\n" + .'- Table row count, 1-day difference: SYSTEM:table:table_count_delta:fixed:1_bizdate'."\n" + .'- Table row count, difference from previous cycle: SYSTEM:table:table_count_delta:fixed:latest_bizdate'."\n" + .'- Table row count, fluctuation rate from previous cycle: SYSTEM:table:table_count:cycle:latest_bizdate'."\n" + .'- Table row count, 7-day average fluctuation rate: SYSTEM:table:table_count:avg:7_bizdate'."\n" + .'- Table row count, 30-day average fluctuation rate: SYSTEM:table:table_count:avg:1m_bizdate'."\n" + .'- Table row count, 1-day fluctuation rate: SYSTEM:table:table_count:flux:1_bizdate'."\n" + .'- Table row count, 7-day fluctuation rate: SYSTEM:table:table_count:flux:7_bizdate'."\n" + .'- Table row count, 30-day fluctuation rate: SYSTEM:table:table_count:flux:1m_bizdate'."\n" + .'- Table row count, 1/7/30-day fluctuation rate: SYSTEM:table:table_count:flux:1_7_1m_bizdate'."\n" + .'- Table row count, 1/7/30-day, 1st of this month, fluctuation rate: SYSTEM:table:table_count:flux:1_7_1m_1st_bizdate'."\n" + .'- Table row count, custom range: SYSTEM:table:count'."\n" + .'- Condition match percentage, custom range: SYSTEM:table:count_percent'."\n" + ."\n" + .'- Average value, 1-day fluctuation rate: SYSTEM:field:avg:cycle:1_bizdate'."\n" + .'- Average value, 1/7/30-day fluctuation rate: SYSTEM:field:avg:flux:1_7_1m_bizdate'."\n" + .'- Average value, custom range: SYSTEM:field:avg'."\n" + ."\n" + .'- Sum value, 1-day fluctuation rate: SYSTEM:field:sum:cycle:1_bizdate'."\n" + .'- Sum value, fluctuation rate from previous cycle: SYSTEM:field:sum:cycle:latest_bizdate'."\n" + .'- Sum value, 1/7/30-day fluctuation rate: SYSTEM:field:sum:flux:1_7_1m_bizdate'."\n" + .'- Sum value, custom range: SYSTEM:field:sum'."\n" + ."\n" + .'- Minimum value, 1-day fluctuation rate: SYSTEM:field:min:cycle:1_bizdate'."\n" + .'- Minimum value, fluctuation rate from previous cycle: SYSTEM:field:min:cycle:latest_bizdate'."\n" + .'- Minimum value, 1/7/30-day fluctuation rate: SYSTEM:field:min:flux:1_7_1m_bizdate'."\n" + .'- Minimum value, custom range: SYSTEM:field:min'."\n" + ."\n" + .'- Maximum value, 1-day fluctuation rate: SYSTEM:field:max:cycle:1_bizdate'."\n" + .'- Maximum value, fluctuation rate from previous cycle: SYSTEM:field:max:cycle:latest_bizdate'."\n" + .'- Maximum value, 1/7/30-day fluctuation rate: SYSTEM:field:max:flux:1_7_1m_bizdate'."\n" + .'- Maximum value, custom range: SYSTEM:field:max'."\n" + ."\n" + .'- Null value record count is 0: SYSTEM:field:null_value:fixed:0'."\n" + .'- Null value count, fixed value: SYSTEM:field:null_value:fixed'."\n" + .'- Null value count/total rows, fixed value: SYSTEM:field:null_value_percent:fixed'."\n" + ."\n" + .'- Field duplicate value is 0: SYSTEM:field:duplicated_count:fixed:0'."\n" + .'- Duplicate value count/total rows, fixed value: SYSTEM:field:duplicated_percent:fixed'."\n" + .'- Duplicate value count, fixed value: YSTEM:field:duplicated_count:fixed'."\n" + .'- Multi-field duplicate value is 0: SYSTEM:fields:duplicated_count:fixed:0'."\n" + ."\n" + .'- Discrete value (state value), fixed value: SYSTEM:field:all_discrete_count:fixed'."\n" + .'- Discrete value (group count and state value), 1/7/30-day fluctuation rate: SYSTEM:field:all_discrete_metrics:fluxdiscrete:1_7_1m_bizdate'."\n" + .'- Discrete value (group count), fixed value: SYSTEM:field:discrete_group_count:fixed'."\n" + .'- Discrete value (group count), 1-day fluctuation rate: SYSTEM:field:discrete_group_count:cycle:latest_bizdate'."\n" + ."\n" + .'- Table size, fixed value: SYSTEM:table:table_size:fixed'."\n" + .'- Table size, difference from previous cycle: SYSTEM:table:table_size_delta:fixed:latest_bizdate'."\n" + .'- Table size, difference compared with 1 day ago (bytes): SYSTEM:table:table_size_delta:fixed:1_bizdate'."\n" + .'- Table size, 1-day fluctuation rate: SYSTEM:table:table_size:flux:1_bizdate'."\n" + .'- Table size, 7-day fluctuation rate: SYSTEM:table:table_size:flux:7_bizdate'."\n" + .'- Table size, 30-day fluctuation rate: SYSTEM:table:table_size:flux:1m_bizdate'."\n" + ."\n" + .'- Distinct value count, fixed value: SYSTEM:field:count_distinct:fixed'."\n" + .'- Distinct value count, 1/7/30-day fluctuation rate: SYSTEM:field:count_distinct:flux:1_7_1m_bizdate'."\n" + .'- Distinct value count/total rows, fixed value: SYSTEM:field:count_distinct_percent:fixed'."\n" + ."\n" + .'- Table row count, dynamic threshold: SYSTEM:table:table_count:dynamic_threshold'."\n" + .'- Sum value, dynamic threshold: SYSTEM:field:sum:dynamic_threshold'."\n" + .'- Average value, dynamic threshold: SYSTEM:field:avg:dynamic_threshold'."\n" + .'- Maximum value, dynamic threshold: SYSTEM:field:max:dynamic_threshold'."\n" + .'- Minimum value, dynamic threshold: SYSTEM:field:min:dynamic_threshold'."\n" + .'- Unique value rate, dynamic threshold: SYSTEM:table:table_size:dynamic_threshold'."\n" + .'- Distinct value count, dynamic threshold: SYSTEM:table:distinct_count:dynamic_threshold'."\n" + .'- Discrete value (group count), dynamic threshold: SYSTEM:field:avg:dynamic_threshold'."\n" + .'- Discrete value (state value), dynamic threshold: SYSTEM:field:sum:dynamic_threshold'."\n" + .'- Discrete value (group count), dynamic threshold: SYSTEM:field:discrete_group_count:dynamic_threshold'."\n" + .'- Discrete value (state value), dynamic threshold: SYSTEM:field:discrete_value_count:dynamic_threshold', + 'changeSet' => [ + ['createdAt' => '2025-03-31T05:58:07.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-12-23T06:29:09.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-4ED0-9441\\\\n\\",\\n \\"Id\\": 19715\\n}","type":"json"}]', ], - 'UpdateComputeResource' => [ - 'summary' => 'Modifies the specified computing resource based on the computing resource ID.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateDataQualityRuleTemplate' => [ + 'summary' => 'Creates a rule template.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'deprecated' => false, + 'deprecated' => true, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '232392', - 'abilityTreeNodes' => [ - 'FEATUREdideRWC5F7', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '248081', + 'abilityTreeNodes' => ['FEATUREdideRGVRPF'], ], 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'title' => '数据源Id', - 'description' => 'The ID of the computing resource.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10001', - ], + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the rule template. It can be a combination of digits, English letters, Chinese characters, and half-width or full-width punctuation marks. The maximum length is 512 characters.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'maxLength' => 128, 'example' => 'Table row Count Verification'."\n", 'title' => ''], ], [ 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'title' => 'Dataworks项目空间Id', - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10001', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The DataWorks workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '12345', 'title' => ''], ], [ - 'name' => 'ConnectionPropertiesMode', - 'in' => 'query', + 'name' => 'VisibleScope', + 'in' => 'formData', 'schema' => [ - 'title' => '数据源添加的类别，不同type下会有不同的子类型，对应有不同的参数schema约束，场景举例：InstanceMode 实例模式；UrlMode 连接串模式', - 'description' => 'The category of the computing resource to be added. Different types have different subtypes and corresponding parameter schema constraints. Examples: InstanceMode and UrlMode.'."\n", + 'description' => 'The visibility scope of the template:'."\n" + .'- Tenant: available to the entire tenant'."\n" + .'- Project: available only in the current project', + 'enumValueTitles' => [], 'type' => 'string', 'required' => false, - 'example' => 'InstanceMode', - 'enum' => [ - 'UrlMode', - 'InstanceMode', - 'CdhMode', - ], + 'docRequired' => true, + 'default' => 'Project', + 'enum' => ['Project', 'Tenant'], + 'example' => 'Project', + 'title' => '', ], ], [ - 'name' => 'Description', - 'in' => 'query', + 'name' => 'DirectoryPath', + 'in' => 'formData', + 'schema' => ['description' => 'The category directory where the custom template is stored. Hierarchy levels are separated by slashes. Each level name can be up to 1024 characters long and cannot contain whitespace characters or slashes.', 'type' => 'string', 'required' => false, 'example' => '/ods/order_data'."\n", 'title' => ''], + ], + [ + 'name' => 'SamplingConfig', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '数据源描述信息，长度不超过 3000 个字符', - 'description' => 'The description of the computing resource. The maximum length is 3000 characters.'."\n", - 'type' => 'string', - 'required' => false, + 'description' => 'The settings required for sample collection.', + 'type' => 'object', + 'properties' => [ + 'Metric' => ['description' => 'The name of the metric to sample:'."\n" + .'- Count: number of table rows'."\n" + .'- Min: minimum field value'."\n" + .'- Max: maximum field value'."\n" + .'- Avg: average field value'."\n" + .'- DistinctCount: number of distinct field values'."\n" + .'- DistinctPercent: ratio of the number of distinct field values to the number of data rows'."\n" + .'- DuplicatedCount: number of duplicate field values'."\n" + .'- DuplicatedPercent: ratio of the number of duplicate field values to the number of data rows'."\n" + .'- TableSize: table size'."\n" + .'- NullValueCount: number of rows where the field is null'."\n" + .'- NullValuePercent: ratio of rows where the field is null'."\n" + .'- GroupCount: each value and the corresponding number of data rows after aggregating by field value'."\n" + .'- CountNotIn: number of rows whose enum value does not match'."\n" + .'- CountDistinctNotIn: number of distinct values whose enum value does not match'."\n" + .'- UserDefinedSql: sample collection via a custom SQL statement', 'type' => 'string', 'docRequired' => false, 'required' => false, 'example' => 'Count', 'title' => ''], + 'MetricParameters' => ['description' => 'The parameters required for sample collection.', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => '{"SQL": "select count(1) from table;"}'."\n", 'title' => ''], + 'SettingConfig' => ['description' => 'Runtime parameter setting statements to be inserted and executed before the sampling statement is executed. The maximum length is 1000 characters. Currently only MaxCompute is supported.', 'type' => 'string', 'maxLength' => 1000, 'required' => false, 'example' => 'SET odps.sql.udf.timeout=600s; '."\n" + .'SET odps.sql.python.version=cp27;'."\n", 'title' => ''], + ], + 'required' => true, + 'docRequired' => true, + 'title' => '', 'example' => '', ], ], [ - 'name' => 'ConnectionProperties', - 'in' => 'query', + 'name' => 'CheckingConfig', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '数据源具体连接配置信息，包括连接地址、访问身份、环境信息等。数据源环境EnvType信息是此对象的成员属性，包括DEV（开发环境）和PROD（生产环境），不区分大小写。', - 'description' => 'The specific connection configuration of the computing resource, including the connection address, access identity, and environment information. The environment type (EnvType) of the computing resource is a member attribute of this object, including DEV (development environment) and PROD (production environment). The value is not case-sensitive.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '{'."\n" - .' "envType": "Prod",'."\n" - .' "regionId": "cn-beijing",'."\n" - .' "instanceId": "hgprecn-cn-x0r3oun4k001",'."\n" - .' "database": "testdb",'."\n" - .' "securityProtocol": "authTypeNone",'."\n" - .' "authType": "Executor",'."\n" - .' "authIdentity": "1107550004253538"'."\n" - .'}', + 'description' => 'The sample validation settings.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The threshold calculation method:'."\n" + .'- Fixed'."\n" + .'- Fluctation'."\n" + .'- FluctationDiscreate'."\n" + .'- Auto'."\n" + .'- Average'."\n" + .'- Variance', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => 'Fixed', 'title' => ''], + 'ReferencedSamplesFilter' => ['description' => 'Some threshold types require querying reference samples and then aggregating the values of those reference samples to derive the threshold used for comparison. An expression is used here to describe how the reference samples are queried.', 'type' => 'string', 'required' => false, 'example' => '{ "bizdate": [ "-1", "-7", "-1m" ] }'."\n", 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The returned result.'."\n", + 'title' => '', + 'description' => 'The return value.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID. Used to locate logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => 'true', - 'false' => 'false', - ], - 'example' => 'true', - ], + 'RequestId' => ['title' => '', 'description' => 'The API request ID.', 'type' => 'string', 'example' => '691CA452-D37A-4ED0-9441'."\n"], + 'Code' => ['description' => 'The rule template Code.', 'type' => 'string', 'example' => 'UserDefined:3001', 'title' => ''], ], + 'example' => '', ], ], ], 'staticInfo' => [ + 'substitutions' => ['dataworks-public::2024-05-18::CreateDataQualityTemplate'], 'returnType' => 'synchronous', ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'UpdateComputeResource', - ], - 'ListComputeResources' => [ - 'summary' => 'Queries the list of computing resources that meet the specified business information.', - 'methods' => [ - 'get', - 'post', + 'title' => 'Create a data quality rule template', + 'description' => 'You must purchase DataWorks Basic Edition or above to use this feature.', + 'changeSet' => [ + ['createdAt' => '2025-03-31T05:58:07.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-12-23T06:29:09.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-4ED0-9441\\\\n\\",\\n \\"Code\\": \\"UserDefined:3001\\"\\n}","type":"json"}]', + ], + 'CreateDataQualityScan' => [ + 'summary' => 'Creates a data quality monitor.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '232439', - 'abilityTreeNodes' => [ - 'FEATUREdideRWC5F7', - ], + 'abilityTreeNodes' => ['FEATUREdide3WJOKE'], ], 'parameters' => [ + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['description' => 'The description of the data quality monitor.', 'type' => 'string', 'required' => false, 'example' => 'Daily data quality scanning of ods tables.', 'title' => ''], + ], [ 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the DataWorks workspace.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '21229', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The DataWorks workspace ID. You can log on to the DataWorks console and go to the workspace configuration page to obtain the workspace ID. This parameter is required to specify the target DataWorks workspace for this API operation.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '101', 'title' => ''], ], [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the computing resource.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'category name ', - ], + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the user who owns of the data quality monitor.', 'type' => 'string', 'required' => false, 'example' => '95279527****', 'title' => ''], ], [ - 'name' => 'Types', - 'in' => 'query', - 'style' => 'simple', + 'name' => 'Spec', + 'in' => 'formData', + 'schema' => ['description' => 'Spec code for the content of the data quality monitoring.', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "datasets": ['."\n" + .' {'."\n" + .' "type": "Table",'."\n" + .' "dataSource": {'."\n" + .' "name": "odps_first",'."\n" + .' "envType": "Prod"'."\n" + .' },'."\n" + .' "tables": ['."\n" + .' "ods_d_user_info"'."\n" + .' ],'."\n" + .' "filter": "pt = $[yyyymmdd-1]"'."\n" + .' }'."\n" + .' ],'."\n" + .' "rules": ['."\n" + .' {'."\n" + .' "assertion": "row_count > 0"'."\n" + .' }, {'."\n" + .' "templateId": "SYSTEM:field:null_value:fixed",'."\n" + .' "pass": "when = 0",'."\n" + .' "name": "The id cannot be empty.",'."\n" + .' "severity": "High",'."\n" + .' "identity": "a-customized-data-quality-rule-uuid"'."\n" + .' }'."\n" + .' ]'."\n" + .'}', 'title' => ''], + ], + [ + 'name' => 'Parameters', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The filter for computing resource types. You can configure multiple types for filtering.'."\n", + 'description' => 'The definition of execution parameters for the data quality monitoring.', 'type' => 'array', 'items' => [ - 'description' => 'The type of the computing resource.'."\n", - 'type' => 'string', + 'description' => 'The definition of execution parameters for the data quality monitoring.', + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => 'The parameter values.', 'type' => 'string', 'required' => false, 'example' => '$[yyyymmdd-1]', 'title' => ''], + 'Name' => ['description' => 'The parameter name.', 'type' => 'string', 'required' => false, 'example' => 'triggerTime', 'title' => ''], + ], 'required' => false, - 'example' => 'hologres', + 'title' => '', + 'example' => '', ], 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'EnvType', - 'in' => 'query', + 'name' => 'RuntimeResource', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The environment type of the computing resource. Valid values:'."\n" - ."\n" - .'* Dev'."\n" - .'* Prod'."\n", - 'type' => 'string', + 'description' => 'The resource group used during execution of the data quality monitoring.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => '0525242e-d0ee-4bda-bc73-765d82f6a34a', 'title' => ''], + 'Cu' => ['description' => 'The default number of CUs configured for task running.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.25', 'title' => ''], + 'Image' => ['description' => 'The ID of the image configured for task running.', 'type' => 'string', 'required' => false, 'example' => 'i-xxxxxx', 'title' => ''], + ], 'required' => false, - 'example' => 'Dev', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'PageNumber', - 'in' => 'query', + 'name' => 'ComputeResource', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The page number to query. The default value is 1, which indicates the first page.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The compute engine used at runtime. If not specified, the data source defined in the Spec is used.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the compute engine, which is a unique identifier.', 'type' => 'string', 'required' => false, 'example' => 'emr_first', 'title' => ''], + 'Runtime' => [ + 'description' => 'More settings for data quality monitoring at runtime.', + 'type' => 'object', + 'properties' => [ + 'Engine' => [ + 'description' => 'The type of the compute engine. Only EMR compute engines support these settings.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- Hive: Hive SQL'."\n" + ."\n" + .'- Spark: Spark SQL'."\n" + ."\n" + .'- Kyuubi', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'example' => 'Hive', + 'title' => '', + ], + 'SparkConf' => ['description' => 'Additional Spark engine parameters. Currently, only the spark.yarn.queue parameter is supported.', 'type' => 'object', 'required' => false, 'example' => 'spark.yarn.queue=dq_queue', 'title' => ''], + 'HiveConf' => ['description' => 'Additional Hive engine parameters. Currently, only the mapreduce.job.queuename parameter is supported.', 'type' => 'object', 'required' => false, 'example' => 'mapreduce.job.queuename=dq_queue', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'EnvType' => [ + 'description' => 'The workspace environment to which the compute engine belongs.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- Prod: production environment .'."\n" + ."\n" + .'- Dev: development environment.', + 'enumValueTitles' => [], + 'type' => 'string', + 'enum' => ['Prod', 'Dev'], + 'required' => false, + 'example' => 'Dev', + 'title' => '', + ], + ], 'required' => false, - 'example' => '1', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'PageSize', - 'in' => 'query', + 'name' => 'Trigger', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The number of entries per page. The default value is 10, and the maximum value is 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The trigger configurations of the data quality monitoring task.', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The trigger mode of the monitoring task.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- ByManual: Manual trigger. This is the default setting.'."\n" + ."\n" + .'- BySchedule: Triggered by a scheduled task instance.', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'example' => 'BySchedule', + 'title' => '', + ], + 'TaskIds' => [ + 'description' => 'If the trigger mode is set to BySchedule, the scheduling task ID must be specified.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the scheduling task.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1004979033', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], 'required' => false, - 'example' => '10', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'SortBy', - 'in' => 'query', + 'name' => 'Hooks', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The field to sort the computing resource list by. Supported fields include name, creation time, and computing resource ID.'."\n" - ."\n" - .'* CreateTime: Sorts by creation time'."\n" - .'* Id: Sorts by computing resource ID'."\n" - .'* Name: Sorts by computing resource name.'."\n" - .'* CreateTimeWithDefaultFirst: Sorts based on whether it is the default resource and by creation time, with the default computing resource listed first.'."\n" - ."\n" - .'Default value: CreateTime'."\n", - 'type' => 'string', + 'description' => 'The Hook configurations after the data quality monitoring run ends.', + 'type' => 'array', + 'items' => [ + 'description' => 'The Hook configurations after the data quality monitoring run ends.', + 'type' => 'object', + 'properties' => [ + 'Condition' => ['description' => 'The Hook trigger condition. The hook will run if the condition is met. Currently, only one type of expression syntax is supported:'."\n" + ."\n" + .'You can specify multiple combinations of rule severity levels and validation statuses using an expression such as `results.any { r -> r.status == \'Fail\' && r.rule.severity == \'Normal\' || r.status == \'Error\' && r.rule.severity == \'High\' || r.status == \'Warn\' && r.rule.severity == \'High\' }`. This expression means the condition is met if any executed rule has a result of Fail with severity Normal, Error with severity High, or Warn with severity High. In the condition expression, the values of severity and status are predefined enums. The values of severity must match those defined in the Spec, and the values of status must match those in DataQualityResult.', 'type' => 'string', 'required' => false, 'example' => 'results.any { r -> r.status == \'Fail\' && r.rule.severity == \'Normal\' || r.status == \'Error\' && r.rule.severity == \'High\' || r.status == \'Warn\' && r.rule.severity == \'High\' }', 'title' => ''], + 'Type' => [ + 'description' => 'The type of the Hook.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- BlockTaskInstance: Blocks the scheduling of the task instance.', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'example' => 'BlockTaskInstance', + 'title' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'CreateTimeWithDefaultFirst', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Order', - 'in' => 'query', - 'schema' => [ - 'description' => 'The sort direction of the computing resource list. Valid values:'."\n" - ."\n" - .'* Desc: descending order.'."\n" - .'* Asc: ascending order.'."\n" - ."\n" - .'Default value: Desc'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Asc', - ], + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['description' => 'The data quality monitoring name.', 'type' => 'string', 'required' => false, 'example' => 'data_quality_scan_001', 'title' => ''], + ], + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => ['description' => 'The idempotency token.', 'type' => 'string', 'required' => true, 'example' => 'a-customized-uuid', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The returned result.'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID. Used to locate logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX', - ], - 'PagingInfo' => [ - 'description' => 'Pagination information.'."\n", - 'type' => 'object', - 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of records.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'PageSize' => [ - 'description' => 'The number of records per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => 'The current page number.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ComputeResources' => [ - 'description' => 'The list of computing resources. Each element is a computing resource group that contains information about the development environment (if any) and the production environment.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Information about the computing resource group, which includes computing resources for the development environment (if any) and the production environment. The computing resources for the development and production environments have the same name and type but different IDs.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the computing resource.'."\n", - 'type' => 'string', - 'example' => 'cal_all_vemg_workflow_parallel', - ], - 'Type' => [ - 'description' => 'The type of the computing resource.'."\n", - 'type' => 'string', - 'example' => 'hologres', - ], - 'ComputeResource' => [ - 'description' => 'Details of a single computing resource.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Details of a single computing resource.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The computing resource ID, which is the unique identifier for the resource.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '8649832502405358603', - ], - 'ConnectionProperties' => [ - 'description' => 'The category of the added compute resource. Different types have different subtypes with corresponding parameter constraints. Examples: InstanceMode: The instance mode. UrlMode: The connection string mode.'."\n", - 'type' => 'any', - 'example' => '{\\n \\"clusterIdentifier\\": \\"c-da123456\\",\\n \\"database\\": \\"testdb\\",\\n \\"loginMode\\":\\"Anonymous\\",\\n \\"defaultFS\\":\\"127.0.0.1\\",\\n \\"envType\\": \\"Prod\\"\\n}', - ], - 'ConnectionPropertiesMode' => [ - 'description' => 'The specific connection configuration details for the computing resource, including the connection address, access identity, and environment information. envType, which specifies the computing resource environment, is a property of this object. Valid values:'."\n" - ."\n" - .'* Dev'."\n" - .'* Prod Different types of computing resources have different attribute specifications under different configuration modes (ConnectionPropertiesMode).'."\n", - 'type' => 'string', - 'example' => 'UrlMode', - ], - 'Description' => [ - 'description' => 'The unique identifier of the computing resource.'."\n", - 'type' => 'string', - 'example' => 'home_feed', - ], - 'CreateTime' => [ - 'description' => 'The creation time (timestamp).'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1624387842781448', - ], - 'CreateUser' => [ - 'description' => 'The creator ID.'."\n", - 'type' => 'string', - 'example' => '1648711113000', - ], - 'ModifyTime' => [ - 'description' => 'The last modified time of the computing resource (timestamp).'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1624387842781448', - ], - 'ModifyUser' => [ - 'description' => 'The modifier ID.'."\n", - 'type' => 'string', - 'example' => '1648711113000', - ], - 'WhetherDefault' => [ - 'description' => 'Specifies whether it is the default compute resource.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0000-ABCD-EFG****'], + 'Id' => ['description' => 'Returns the ID of the created data source sharing rule, which uniquely identifies the rule.', 'type' => 'integer', 'format' => 'int64', 'example' => '676303114031776', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateDataQualityScan', + 'description' => 'DataWorks Basic Edition or a higher edition is required.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 100,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"ComputeResources\\": [\\n {\\n \\"Name\\": \\"cal_all_vemg_workflow_parallel\\",\\n \\"Type\\": \\"hologres\\",\\n \\"ComputeResource\\": [\\n {\\n \\"Id\\": 8649832502405359000,\\n \\"ConnectionProperties\\": \\"{\\\\\\\\n \\\\\\\\\\\\\\"clusterIdentifier\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"c-da123456\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"database\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"testdb\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"loginMode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Anonymous\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"defaultFS\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"127.0.0.1\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"envType\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"Prod\\\\\\\\\\\\\\"\\\\\\\\n}\\",\\n \\"ConnectionPropertiesMode\\": \\"UrlMode\\",\\n \\"Description\\": \\"home_feed\\",\\n \\"CreateTime\\": 1624387842781448,\\n \\"CreateUser\\": \\"1648711113000\\",\\n \\"ModifyTime\\": 1624387842781448,\\n \\"ModifyUser\\": \\"1648711113000\\",\\n \\"WhetherDefault\\": true\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListComputeResources', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"Id\\": 676303114031776\\n}","type":"json"}]', ], - 'CreateComputeResource' => [ - 'summary' => 'Creates a computing resource in the specified workspace. The resource can be for a development environment or a production environment.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateDataQualityScanRun' => [ + 'summary' => 'Triggers the specified data quality scan and returns the run ID.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -7995,89 +7059,66 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '232205', - 'abilityTreeNodes' => [ - 'FEATUREdideRWC5F7', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREdide3WJOKE'], ], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'title' => 'Dataworks项目空间Id', - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'minimum' => '0', - 'example' => '2', - ], + 'name' => 'DataQualityScanId', + 'in' => 'formData', + 'schema' => ['description' => 'The data quality scan ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20000001', 'title' => ''], ], [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'title' => '数据源的名称，由字母、数字、下划线组合，且不能以数字和下划线开头，最长255 个字符', - 'description' => 'The name of the computing resource. It can contain letters, digits, and underscores (\\_), cannot start with a digit or an underscore, and has a maximum length of 255 characters.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'demo_holo_cs', - ], + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000', 'title' => ''], ], [ - 'name' => 'Type', - 'in' => 'query', + 'name' => 'Parameters', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '数据源的类型，目前已经支持数据源类型 70+', - 'description' => 'The type of the computing resource. Multiple computing resource types are currently supported.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'hologres', - ], - ], - [ - 'name' => 'ConnectionPropertiesMode', - 'in' => 'query', - 'schema' => [ - 'title' => '据源添加的类别，不同Type下会有不同的子类型，对应有不同的参数约束，以mysql数据源举例有：InstanceMode（实例模式）、UrlMode（连接串模式）', - 'description' => 'Depending on the added source category, different types may have specific subtypes subject to distinct parameter constraints. For example, Hologres computing resources support InstanceMode and UrlMode.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'InstanceMode', - 'enum' => [ - 'UrlMode', - 'InstanceMode', - 'CdhMode', + 'description' => 'The parameters for the run. The `triggerTime` parameter is required.', + 'type' => 'array', + 'items' => [ + 'description' => 'A runtime parameter.', + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => 'The parameter value.'."\n" + ."\n" + .'- If the parameter name is triggerTime, this value must be the trigger time as a timestamp.', 'type' => 'string', 'required' => false, 'example' => '1775812636', 'title' => ''], + 'Name' => ['description' => 'The name of the parameter. The only supported value is:'."\n" + ."\n" + .'- triggerTime'."\n" + ."\n" + .'No other scheduling parameters are currently supported.', 'type' => 'string', 'required' => false, 'example' => 'triggerTime', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], - ], - ], - [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'title' => '数据源描述信息，长度不超过 3000 个字符', - 'description' => 'The description of the computing resource. The maximum length is 3000 characters.'."\n", - 'type' => 'string', 'required' => false, - 'example' => 'demo_holo_cs', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ConnectionProperties', - 'in' => 'query', + 'name' => 'RuntimeResource', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '数据源具体连接配置信息，包括连接地址、访问身份、环境信息等。数据源环境EnvType信息是此对象的成员属性，包括DEV（开发环境）和PROD（生产环境），EnvType取值不区分大小写。'."\n" - .'```'."\n", - 'description' => 'The specific connection configuration of the computing resource, including the connection address, access identity, and environment information. The environment for the computing resource is a member attribute of this object. It includes DEV (development environment) and PROD (production environment). The value for EnvType is case-insensitive.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '{ "EndpointMode": "custom", "Database": "testdb", "TaskSubmitter": "1107550004253538", "InstanceId": "hgprecn-cn-x0r3oun4k001", "SecurityProtocol": "authTypeNone", "RegionId": "cn-beijing", "EnvType": "Prod", "AuthType": "Executor" }', + 'description' => 'Specifies the scheduling resource group used to run the data quality scan. This object uses the same data structure as the scheduling API.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'e9455a13-ff00-4965-833c-337546ba4854', 'title' => ''], + 'Cu' => ['description' => 'The number of compute units (CUs) to reserve from the resource group for the data quality scan.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.25', 'title' => ''], + 'Image' => ['description' => 'The image configuration for running the data quality scan on the resource group.', 'type' => 'string', 'required' => false, 'example' => 'i-xxxxxx', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -8085,364 +7126,291 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The returned result.'."\n", + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID. You can use the request ID to locate logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX', - ], - 'Id' => [ - 'title' => '返回创建的数据源Id', - 'description' => 'Returns the ID of the created computing resource.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10001', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0bc14115***159376359'], + 'Id' => ['description' => 'The run ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '248840', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateDataQualityScanRun', + 'description' => 'This operation is available only in DataWorks Basic Edition and later versions.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"Id\\": 10001\\n}","type":"json"}]', - 'title' => 'CreateComputeResource', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115***159376359\\",\\n \\"Id\\": 248840\\n}","type":"json"}]', ], - 'CreateResourceGroup' => [ - 'summary' => 'Creates a serverless resource group.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateDataQualityTemplate' => [ + 'summary' => 'Creates a data quality template.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '245182', - 'abilityTreeNodes' => [ - 'FEATUREdide2SV6DS', - ], - 'tenantRelevance' => 'tenant', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdide3WJOKE'], ], 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'ProjectId', 'in' => 'formData', - 'schema' => [ - 'title' => '创建通用资源组的名称，必须以字母开头，可包含字母、数字、下划线（_），最多128个字符', - 'description' => 'The name of the serverless resource group. The name can be a maximum of 128 characters in length and can contain letters, digits, and underscores (\\_). The name must start with a letter.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'common_resource_group', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000', 'title' => ''], ], [ - 'name' => 'Remark', + 'name' => 'Spec', 'in' => 'formData', - 'schema' => [ - 'title' => '创建通用资源组的备注，可包含字母、中文、数字、下划线（_），最多128个字符', - 'description' => 'The description of the serverless resource group. The description can be a maximum of 128 characters in length and can contain letters, digits, and underscores (\\_).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Create a serverless resource group for common tasks', - ], + 'schema' => ['description' => 'Detailed configuration Spec code of the rule template. For more information, see [Data quality Spec configuration description](~2963394~).', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "assertion": "anomaly detection fro id_not_null_cnt",'."\n" + .' "id_not_null_cnt": {'."\n" + .' "query": "SELECT COUNT(*) AS cnt FROM ${tableName} WHERE dt = \'$[yyyymmdd-1]\';"'."\n" + .' },'."\n" + .' "identity": "819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a"'."\n" + .'}', 'title' => ''], ], [ - 'name' => 'PaymentType', + 'name' => 'Owner', 'in' => 'formData', - 'schema' => [ - 'title' => '资源组的付费类型，PrePaid代表包年包月，PostPaid代表按量付费 ', - 'description' => 'The billing method of the serverless resource group. Valid values: PrePaid and PostPaid. The value PrePaid indicates the subscription billing method, and the value PostPaid indicates the pay-as-you-go billing method.'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [], - 'example' => 'PrePaid', - 'enum' => [ - 'PrePaid', - 'PostPaid', - ], - ], + 'schema' => ['description' => 'The owner ID.', 'type' => 'string', 'required' => false, 'example' => '1000000000001', 'title' => ''], ], - [ - 'name' => 'PaymentDurationUnit', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '付费时长单位，Month代表包月，Year代表包年', - 'description' => 'The unit of the subscription duration. Valid values: Month and Year.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Month', - 'enum' => [ - 'Month', - 'Year', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The API request ID, which is generated as a UUID.', 'type' => 'string', 'example' => '0bc14115***159376359'], + 'Id' => ['description' => 'The unique identifier of the newly created rule template.', 'type' => 'string', 'example' => 'USER-DEFINED:2001', 'title' => ''], ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateDataQualityTemplate', + 'description' => 'DataWorks Basic Edition or a higher edition is required.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115***159376359\\",\\n \\"Id\\": \\"USER-DEFINED:2001\\"\\n}","type":"json"}]', + ], + 'CreateDataSource' => [ + 'summary' => 'Adds a data source to the development environment or production environment of a workspace.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'PaymentDuration', - 'in' => 'formData', - 'schema' => [ - 'title' => '付费时长', - 'description' => 'The subscription duration.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'AutoRenewEnabled', - 'in' => 'formData', - 'schema' => [ - 'title' => '是否自动续费', - 'description' => 'Specifies whether to enable auto-renewal.'."\n", - 'type' => 'boolean', - 'required' => false, - 'default' => 'false', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '232205', + 'abilityTreeNodes' => ['FEATUREdideRWC5F7'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ [ - 'name' => 'Spec', - 'in' => 'formData', - 'schema' => [ - 'title' => '资源组规格,单位CU，当资源组付费模式为PRE_PAY时，必填', - 'description' => 'The specifications of the serverless resource group. Unit: CU. This parameter is required only if you set the PaymentType parameter to PrePaid.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2', - ], + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the DataWorks workspace. You can log on to the [DataWorks console](https://dataworks.console.aliyun.com/overview) and go to the workspace management page to obtain the ID.'."\n" + ."\n" + .'This parameter is used to determine the DataWorks workspaces used for this API call.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'minimum' => '0', 'example' => '2', 'title' => ''], ], [ - 'name' => 'VpcId', - 'in' => 'formData', - 'schema' => [ - 'title' => '默认绑定的VPC ID', - 'description' => 'The ID of the virtual private cloud (VPC) with which the serverless resource group is associated by default.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'vpc-m2et4f3oc8msfbccXXXXX', - ], + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the data source. The name can be up to 255 characters in length and can contain letters, digits, and underscores (\\_). The name must start with a letter.', 'type' => 'string', 'required' => true, 'example' => 'demo_holo_datasource', 'title' => ''], ], [ - 'name' => 'VswitchId', - 'in' => 'formData', - 'schema' => [ - 'title' => '默认绑定的交换机ID', - 'description' => 'The ID of the vSwitch with which the serverless resource group is associated by default.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'vsw-uf8usrhs7hjd9amsXXXXX', - ], + 'name' => 'Type', + 'in' => 'query', + 'schema' => ['description' => 'The type of the data source. More than 70 types of data sources are supported in DataWorks. For more information, see [Data source types](~~2852465~~).', 'type' => 'string', 'required' => true, 'example' => 'hologres', 'title' => ''], ], [ - 'name' => 'ClientToken', - 'in' => 'formData', + 'name' => 'ConnectionPropertiesMode', + 'in' => 'query', 'schema' => [ - 'title' => '客户端幂等性标识，用于保证创建通用资源组操作的幂等性', - 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n", + 'description' => 'The mode in which you want to add the data source. The mode varies based on the data source type. Valid values for MySQL data sources:'."\n" + ."\n" + .'- InstanceMode: instance mode'."\n" + ."\n" + .'- UrlMode: connection string mode', 'type' => 'string', 'required' => true, - 'example' => 'eb870033-74c8-4b1b-9664-04c4e7cc3465', + 'enum' => ['UrlMode', 'InstanceMode', 'CdhMode'], + 'title' => '', + 'example' => 'UrlMode', ], ], [ - 'name' => 'AliyunResourceGroupId', - 'in' => 'formData', - 'schema' => [ - 'title' => '阿里云资源组ID', - 'description' => 'The ID of the Alibaba Cloud resource group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-aek2kqofrgXXXXX', - ], + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The description of the data source. The description cannot exceed 3,000 characters in length.', 'type' => 'string', 'example' => 'this is a holo datasource', 'title' => '', 'required' => false], ], [ - 'name' => 'AliyunResourceTags', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '阿里云标签列表', - 'description' => 'The tags.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '阿里云标签', - 'description' => 'The tag.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => '标签Key', - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'key', - ], - 'Value' => [ - 'title' => '标签value', - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'value', - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'name' => 'ConnectionProperties', + 'in' => 'query', + 'schema' => ['description' => 'The connection configurations of the data source, including the connection address, access identity, and environment information. The envType parameter specifies the environment in which the data source is used. Valid values of the envType parameter:'."\n" + ."\n" + .'- Dev: development environment'."\n" + ."\n" + .'- Prod: production environment'."\n" + ."\n" + .'The parameters that you need to configure for the data source vary based on the mode in which the data source is added. For more information, see [Data source connection information (ConnectionProperties)](~~2852465~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{'."\n" + .' "envType": "Prod",'."\n" + .' "regionId": "cn-beijing",'."\n" + .' "instanceId": "hgprecn-cn-x0r3oun4k001",'."\n" + .' "database": "testdb",'."\n" + .' "securityProtocol": "authTypeNone",'."\n" + .' "authType": "Executor",'."\n" + .' "authIdentity": "1107550004253538"'."\n" + .'}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'title' => '是否请求成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - 'default' => 'true', - ], - 'ResourceGroupOrder' => [ - 'title' => '创建通用资源组的订单信息', - 'description' => 'The information about the order that is used to create the serverless resource group.'."\n", - 'type' => 'object', - 'properties' => [ - 'OrderId' => [ - 'title' => '创建通用资源组的订单ID', - 'description' => 'The ID of the order that is used to create the serverless resource group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2391982058XXXXX', - ], - 'OrderInstanceId' => [ - 'title' => '创建通用资源组的订单实例ID', - 'description' => 'The instance ID of the order that is used to create the serverless resource group.'."\n", - 'type' => 'string', - 'example' => 'c442b330-3b10-4584-959e-736e4edXXXXX', - ], - 'Id' => [ - 'title' => '创建通用资源组的唯一标识符', - 'description' => 'The ID of the serverless resource group.'."\n", - 'type' => 'string', - 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX', - ], - ], - ], - 'RequestId' => [ - 'title' => '请求的ID，用于定位日志，排查问题', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.', 'type' => 'string', 'example' => 'B62EC203-B39E-5DC1-B5B8-EB3C6****'], + 'Id' => ['description' => 'The data source ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '22130'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'asynchronous', - 'callback' => 'dataworks-public::2024-05-18::GetResourceGroup', - 'callbackInterval' => 5000, - 'maxCallbackTimes' => 10, - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ResourceGroupOrder\\": {\\n \\"OrderId\\": 0,\\n \\"OrderInstanceId\\": \\"c442b330-3b10-4584-959e-736e4edXXXXX\\",\\n \\"Id\\": \\"Serverless_res_group_524257424564736_6831777003XXXXX\\"\\n },\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]', - 'title' => 'CreateResourceGroup', - 'description' => '1. You can use this API operation only in DataWorks Basic Edition or an advanced edition.'."\n" - .'2. **Before you call this API operation, you must make sure that you have a good command of the billing details and [pricing](~~2680173~~) of serverless resource groups.', - ], - 'DeleteResourceGroup' => [ - 'summary' => 'Deletes a serverless resource group.', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateDataSource', + 'description' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:CreateDataSource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B62EC203-B39E-5DC1-B5B8-EB3C6****\\",\\n \\"Id\\": 22130\\n}","type":"json"}]', + ], + 'CreateDataSourceSharedRule' => [ + 'summary' => 'Creates a sharing rule for a data source to share it with other workspaces or RAM users.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '245171', - 'abilityTreeNodes' => [ - 'FEATUREdide2SV6DS', - ], - 'tenantRelevance' => 'tenant', + 'operationType' => 'get', + 'abilityTreeCode' => '235541', + 'abilityTreeNodes' => ['FEATUREdideRWC5F7'], ], 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'formData', - 'schema' => [ - 'title' => '资源组唯一标识', - 'description' => 'The ID of the resource group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX', - ], + 'name' => 'DataSourceId', + 'in' => 'query', + 'schema' => ['description' => 'The data source ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '144544', 'title' => ''], + ], + [ + 'name' => 'TargetProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the workspace to which you want to share the data source. You cannot share the data source to the workspace with which the data source is associated.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '106560', 'title' => ''], + ], + [ + 'name' => 'SharedUser', + 'in' => 'query', + 'schema' => ['description' => 'The user with which you want to share the data source. If you do not configure this parameter, the data source is shared to an entire workspace.', 'type' => 'string', 'required' => false, 'example' => '110755000****', 'title' => ''], + ], + [ + 'name' => 'EnvType', + 'in' => 'query', + 'schema' => ['description' => 'The environment of the target workspace to which the data source is shared. Valid values:'."\n" + ."\n" + .'- Dev: development environment'."\n" + ."\n" + .'- Prod: production environment', 'type' => 'string', 'required' => true, 'example' => 'Dev', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'title' => '是否请求成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - 'default' => 'true', - ], - 'RequestId' => [ - 'title' => '请求的ID，用于定位日志，排查问题', - 'description' => 'The request ID. You can use the ID to locate logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID. You can use this ID to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => '46F594E6-84AB-5FA5-8144-6F3D149961E1'], + 'Id' => ['description' => 'The sharing rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '105412', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]', - 'title' => 'DeleteResourceGroup', - 'description' => '1. You can use this API operation only in DataWorks Basic Edition or an advanced edition.'."\n" - .'2. **Before you call this API operation, you must make sure that you have a good command of the billing details and [pricing](~~2680173~~) of serverless resource groups.', - ], - 'UpdateResourceGroup' => [ - 'summary' => 'Updates basic information about a resource group.', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"46F594E6-84AB-5FA5-8144-6F3D149961E1\\",\\n \\"Id\\": 105412\\n}","type":"json"}]', + 'title' => 'CreateDataSourceSharedRule', + 'description' => '1. This operation is available for all DataWorks editions.'."\n" + ."\n" + .'2. To share a data source from Workspace A to Workspace B, you must have the data source sharing permissions in both workspaces. You must have one of the following roles in DataWorks:'."\n" + ."\n" + .'- Tenant Owner, Tenant Administrator, Workspace Administrator, and Workspace Owner', + 'changeSet' => [], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:CreateDataSourceSharedRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'CreateDataset' => [ + 'summary' => 'Creates a dataset. This operation is supported only in workspaces that the user has joined. Currently, only DataWorks datasets are supported. The maximum number of datasets allowed per tenant is 2,000.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -8451,58 +7419,140 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '245164', - 'abilityTreeNodes' => [ - 'FEATUREdide2SV6DS', - ], + 'abilityTreeNodes' => ['FEATUREdideXGTG91'], + 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The DataWorks workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '12345'], + ], + [ + 'name' => 'Origin', 'in' => 'formData', 'schema' => [ - 'title' => '通用资源组唯一标识', - 'description' => 'The ID of the resource group.'."\n", + 'description' => 'The source of the dataset. Currently, only DataWorks is supported.', + 'enumValueTitles' => ['DataWorks' => 'DataWorks'], 'type' => 'string', - 'required' => true, - 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX', + 'default' => 'DataWorks', + 'title' => '', + 'required' => false, + 'example' => 'DataWorks', ], ], [ 'name' => 'Name', 'in' => 'formData', + 'schema' => ['description' => 'The name of the dataset. It cannot be an empty string and must not exceed 128 characters in length.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'test_oss_dataset'], + ], + [ + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => ['description' => 'The description of the dataset. It must not exceed 1,024 characters in length.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'this is a comment'], + ], + [ + 'name' => 'DataType', + 'in' => 'formData', 'schema' => [ - 'title' => '要修改的通用资源组的名称', - 'description' => 'The new name that you want to change for the resource group.'."\n", + 'description' => 'The data type. Valid values:'."\n" + ."\n" + .'- COMMON: Common (Default)'."\n" + ."\n" + .'- PIC'."\n" + ."\n" + .'- TEXT'."\n" + ."\n" + .'- TABLE'."\n" + ."\n" + .'- VIDEO'."\n" + ."\n" + .'- AUDIO'."\n" + ."\n" + .'- INDEX', + 'enumValueTitles' => ['TABLE' => '', 'VIDEO' => '', 'COMMON' => '', 'TEXT' => '', 'PIC' => '', 'INDEX' => '', 'AUDIO' => ''], 'type' => 'string', + 'default' => 'COMMON', + 'title' => '', 'required' => false, - 'example' => 'common_resource_group', + 'example' => 'COMMON', ], ], [ - 'name' => 'Remark', + 'name' => 'StorageType', 'in' => 'formData', 'schema' => [ - 'title' => '要修改的通用资源组的备注', - 'description' => 'The new remarks that you want to modify for the resource group.'."\n", + 'description' => 'The storage type. Currently supported values:'."\n" + ."\n" + .'- OSS'."\n" + ."\n" + .'- NAS: General-purpose NAS file systems'."\n" + ."\n" + .'- EXTREMENAS: Extreme NAS file systems'."\n" + ."\n" + .'- DLF\\_LANCE: Data Lake Formation'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- NAS: General-purpose NAS file systems'."\n" + ."\n" + .'- MAXCOMPUTE: MaxCompute table'."\n" + ."\n" + .'- CPFS: Cloud Parallel File Storage'."\n" + ."\n" + .'- BMCPFS: CPFS for Lingjun'."\n" + ."\n" + .'- EXTREMENAS: Extreme NAS file systems'."\n" + ."\n" + .'- OSS: Object Storage Service'."\n" + ."\n" + .'- DLF\\_LANCE: Data Lake Formation.', + 'enumValueTitles' => ['NAS' => '', 'EXTREMENAS' => '', 'OSS' => '', 'DLF_LANCE' => ''], 'type' => 'string', - 'required' => false, - 'example' => 'Create a common resource group for common tasks', + 'required' => true, + 'title' => '', + 'example' => 'OSS', ], ], [ - 'name' => 'AliyunResourceGroupId', + 'name' => 'InitVersion', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '阿里云资源组ID', - 'description' => 'The ID of the new Alibaba Cloud resource group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-aek2kqofrgXXXXX', + 'title' => '', + 'description' => 'The initial version of the dataset.', + 'type' => 'object', + 'properties' => [ + 'Comment' => ['description' => 'The description. It must not exceed 1,024 characters in length.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'Initial Version'], + 'Url' => ['description' => 'URL', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'oss://test-oss-bucket/test_dir/'], + 'ImportInfo' => [ + 'title' => '', + 'description' => 'The storage import configuration for the dataset. The required configuration information varies by storage type.'."\n" + ."\n" + .'**NAS**'."\n" + ."\n" + .'For valid values, refer to the response of the file storage API DescribeFileSystems.'."\n" + ."\n" + .'```JSON'."\n" + .'{'."\n" + .'"fileSystemId": "3b6XXX89c9", // The file system ID.'."\n" + .'"fileSystemStorageType": "Performance" // The storage specification of the file system.'."\n" + .'"vpcId": "vpc-uf66oxxxrqge1t2gson7s" // The VPC ID of the mount point.'."\n" + .'}'."\n" + .'```', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['description' => 'The storage import configuration information for the dataset.', 'type' => 'string', 'example' => 'None', 'title' => ''], + 'example' => '', + ], + 'MountPath' => ['description' => 'The mount path. It must start with /mnt/. Default value: /mnt/data.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '/mnt/data'], + ], + 'required' => true, + 'example' => '', ], ], ], @@ -8510,68 +7560,102 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'title' => '是否请求成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - 'default' => 'true', - ], - 'RequestId' => [ - 'title' => '请求的ID，用于定位日志，排查问题', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '99EBE7CF-69C0-5089-BE3E-79563C31XXXX'], + 'Success' => ['description' => 'Indicates whether the creation was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'Id' => ['title' => 'ID', 'description' => 'ID', 'type' => 'string', 'example' => 'dataworks-dataset:3pXXXb8o0ngr07njhps1'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]', - 'title' => 'UpdateResourceGroup', - 'description' => 'You can use this API operation only in DataWorks Basic Edition or an advanced edition.'."\n", - ], - 'GetResourceGroup' => [ - 'summary' => 'Queries the information about a resource group based on its ID.', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateDataset', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataworks:CreateDataset', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"99EBE7CF-69C0-5089-BE3E-79563C31XXXX\\",\\n \\"Success\\": true,\\n \\"Id\\": \\"dataworks-dataset:3pXXXb8o0ngr07njhps1\\"\\n}","type":"json"}]', + ], + 'CreateDatasetVersion' => [ + 'summary' => 'Creates a dataset version. Currently supports DataWorks datasets only, with a maximum of 20 versions.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '245094', - 'abilityTreeNodes' => [ - 'FEATUREdide2SV6DS', - ], + 'abilityTreeNodes' => ['FEATUREdideXGTG91'], + 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'query', + 'name' => 'DatasetId', + 'in' => 'formData', + 'schema' => ['description' => 'The dataset ID. Currently supports DataWorks datasets only.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'dataworks-dataset:3pXXXb8o0ngr07njhps1'], + ], + [ + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => ['description' => 'The description for this dataset version. Maximum length: 1,024 characters.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'this is a comment'."\n"], + ], + [ + 'name' => 'Url', + 'in' => 'formData', + 'schema' => ['description' => 'URL', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'oss://test-oss-bucket/test_dir/'], + ], + [ + 'name' => 'MountPath', + 'in' => 'formData', + 'schema' => ['description' => 'The mount path, which must start with /mnt/. Default value: /mnt/data.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => '/mnt/data'], + ], + [ + 'name' => 'ImportInfo', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '通用资源组唯一标识', - 'description' => 'The ID of the resource group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX', + 'title' => '', + 'description' => 'The storage import configuration for the dataset. Required configuration varies by storage type.'."\n" + ."\n" + .'**NAS**'."\n" + ."\n" + .'For valid values, see the response from the file storage API DescribeFileSystems.'."\n" + ."\n" + .'```JSON'."\n" + .'{'."\n" + .'"fileSystemId": "3b6XXX89c9", // The file system ID.'."\n" + .'"fileSystemStorageType": "Performance" // The file system storage type.'."\n" + .'"vpcId": "vpc-uf66oxxxrqge1t2gson7s" // The VPC ID for the mount point.'."\n" + .'}'."\n" + .'```', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['description' => 'The dataset storage import configuration', 'type' => 'string', 'example' => 'None', 'title' => ''], + 'example' => '', ], ], ], @@ -8579,772 +7663,486 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'title' => '是否请求成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - 'default' => 'true', - ], - 'ResourceGroup' => [ - 'title' => '资源组详细信息', - 'description' => 'The details about the resource group.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '资源组唯一标识', - 'description' => 'The ID of the resource group.'."\n", - 'type' => 'string', - 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX', - ], - 'Name' => [ - 'title' => '资源组的名称', - 'description' => 'The name of the resource group.'."\n", - 'type' => 'string', - 'example' => 'common_resource_group', - ], - 'Remark' => [ - 'title' => '资源组的备注', - 'description' => 'The description of the resource group.'."\n", - 'type' => 'string', - 'example' => 'Create a common resource group for common tasks', - ], - 'PaymentType' => [ - 'title' => '资源组的付费类型，PrePaid代表包年包月，PostPaid代表按量付费 ', - 'description' => 'The billing method of the resource group. Valid values: PrePaid and PostPaid. The value PrePaid indicates the subscription billing method, and the value PostPaid indicates the pay-as-you-go billing method.'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'PrePaid', - 'enum' => [ - 'PrePaid', - 'PostPaid', - ], - ], - 'Status' => [ - 'title' => '通用资源组状态，Normal: 正常 (运行中/服务中)；Stop: 冻结 (已到期)；Deleted: 删除 (已释放/已销毁)；Creating: 创建中 (启动中)；CreateFailed: 创建失败 (启动失败)；Updating: 更新中 (扩容中/缩容中/变配中)；UpdateFailed: 更新失败 (扩容失败/升级失败)；Deleting: 删除中 (释放中/销毁中)；DeleteFailed: 删除失败 (释放失败/销毁失败)；Timeout: 超时。', - 'description' => 'The status of the resource group. Valid values:'."\n" - ."\n" - .'* Normal: The resource group is running or in use.'."\n" - .'* Stop: The resource group is expired.'."\n" - .'* Deleted: The resource group is released or destroyed.'."\n" - .'* Creating: The resource group is being created.'."\n" - .'* CreateFailed: The resource group fails to be created.'."\n" - .'* Updating: The resource group is being scaled in or out, or the configurations of the resource group are being changed.'."\n" - .'* UpdateFailed: The resource group fails to be scaled out or upgraded.'."\n" - .'* Deleting: The resource group is being released or destroyed.'."\n" - .'* DeleteFailed: The resource group fails to be released or destroyed.'."\n" - .'* Timeout: The operations that are performed on the resource group time out.'."\n" - .'* Freezed: The resource group is frozen.'."\n" - .'* Starting: The resource group is being started.'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Normal', - 'enum' => [ - 'Normal', - 'Stop', - 'Deleted', - 'Creating', - 'CreateFailed', - 'Updating', - 'UpdateFailed', - 'Deleting', - 'DeleteFailed', - 'Timeout', - ], - ], - 'Spec' => [ - 'title' => '资源组规格', - 'description' => 'The specifications of the resource group.'."\n", - 'type' => 'object', - 'properties' => [ - 'Standard' => [ - 'title' => '规格详情', - 'description' => 'The number of compute units (CUs) in the resource group.'."\n", - 'type' => 'string', - 'example' => '2CU', - ], - 'Amount' => [ - 'title' => '数量', - 'description' => 'The number of resources in the resource group.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - ], - ], - 'ResourceGroupType' => [ - 'title' => '资源组类型，CommonV2：通用2.0资源组；ExclusiveDataIntegration：独享数据集成资源组；ExclusiveScheduler：独享调度资源组；ExclusiveDataService：独享数据服务资源组', - 'description' => 'The type of the resource group. Valid values:'."\n" - ."\n" - .'* CommonV2: Serverless resource group.'."\n" - .'* ExclusiveDataIntegration: Exclusive resource group for Data Integration.'."\n" - .'* ExclusiveScheduler: Exclusive resource group for scheduling.'."\n" - .'* ExclusiveDataService: Exclusive resource group for DataService Studio.'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'CommonV2', - 'enum' => [ - 'CommonV2', - 'ExclusiveDataIntegration', - 'ExclusiveScheduler', - 'ExclusiveDataService', - ], - ], - 'OrderInstanceId' => [ - 'title' => '资源组的订单实例ID', - 'description' => 'The instance ID of the order that is used to create the resource group.'."\n", - 'type' => 'string', - 'example' => 'c442b330-3b10-4584-959e-736e4edXXXXX', - ], - 'CreateUser' => [ - 'title' => '创建该资源组的用户ID', - 'description' => 'The ID of the account that is used to create the resource group.'."\n", - 'type' => 'string', - 'example' => '11075500042XXXXX', - ], - 'CreateTime' => [ - 'title' => '创建时间，为64位时间戳', - 'description' => 'The time when the resource group was created. The value is a 64-bit timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1727055811000', - ], - 'DefaultVpcId' => [ - 'title' => '通用资源组绑定的默认VPC ID', - 'description' => 'The ID of the virtual private cloud (VPC) with which the resource group is associated by default.'."\n", - 'type' => 'string', - 'example' => 'vpc-m2et4f3oc8msfbccXXXXX', - ], - 'DefaultVswitchId' => [ - 'title' => '通用资源组绑定的默认交换机ID', - 'description' => 'The ID of the vSwitch with which the resource group is associated by default.'."\n", - 'type' => 'string', - 'example' => 'vsw-uf8usrhs7hjd9amsXXXXX', - ], - 'AliyunResourceGroupId' => [ - 'title' => '所属阿里云资源组ID', - 'description' => 'The ID of the Alibaba Cloud resource group.'."\n", - 'type' => 'string', - 'example' => 'rg-aek2kqofrgXXXXX', - ], - 'AliyunResourceTags' => [ - 'title' => '阿里云标签列表', - 'description' => 'The tags.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '阿里云标签', - 'description' => 'The tag.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => '标签key', - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'key', - ], - 'Value' => [ - 'title' => '标签value', - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => 'value', - ], - ], - ], - ], - ], - ], - 'RequestId' => [ - 'title' => '请求的ID，用于定位日志，排查问题', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n"], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'Id' => ['title' => 'ID', 'description' => 'ID', 'type' => 'string', 'example' => 'dataworks-datasetVersion:3pXXXb8o0ngr07njhps1'."\n" + .':2'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ResourceGroup\\": {\\n \\"Id\\": \\"Serverless_res_group_524257424564736_6831777003XXXXX\\",\\n \\"Name\\": \\"common_resource_group\\",\\n \\"Remark\\": \\"Create a common resource group for common tasks\\",\\n \\"PaymentType\\": \\"PrePaid\\",\\n \\"Status\\": \\"Normal\\",\\n \\"Spec\\": {\\n \\"Standard\\": \\"2CU\\",\\n \\"Amount\\": 1\\n },\\n \\"ResourceGroupType\\": \\"CommonV2\\",\\n \\"OrderInstanceId\\": \\"c442b330-3b10-4584-959e-736e4edXXXXX\\",\\n \\"CreateUser\\": \\"11075500042XXXXX\\",\\n \\"CreateTime\\": 1727055811000,\\n \\"DefaultVpcId\\": \\"vpc-m2et4f3oc8msfbccXXXXX\\",\\n \\"DefaultVswitchId\\": \\"vsw-uf8usrhs7hjd9amsXXXXX\\",\\n \\"AliyunResourceGroupId\\": \\"rg-aek2kqofrgXXXXX\\",\\n \\"AliyunResourceTags\\": [\\n {\\n \\"Key\\": \\"key\\",\\n \\"Value\\": \\"value\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]', - 'title' => 'GetResourceGroup', - 'description' => 'You can use this API operation only in DataWorks Basic Edition or an advanced edition.'."\n", - ], - 'ListResourceGroups' => [ - 'summary' => 'Queries a list of resource groups.', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateDatasetVersion', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataworks:CreateDatasetVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\\\n\\",\\n \\"Success\\": true,\\n \\"Id\\": \\"dataworks-datasetVersion:3pXXXb8o0ngr07njhps1\\\\n:2\\"\\n}","type":"json"}]', + ], + 'CreateFile' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '245169', - 'abilityTreeNodes' => [ - 'FEATUREdide2SV6DS', - ], - 'tenantRelevance' => 'tenant', + 'operationType' => 'create', + 'abilityTreeCode' => '267402', + 'abilityTreeNodes' => ['FEATUREdideHO4TQP', 'FEATUREdide8FM783'], ], 'parameters' => [ [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'title' => '资源组名称，用于模糊查询', - 'description' => 'The name of a resource group, which is used for fuzzy match.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Resource', - ], + 'name' => 'FileFolderPath', + 'in' => 'formData', + 'schema' => ['description' => 'The file path.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'Business_process/First_Business_Process/MaxCompute/Folder_1/Folder_2', 'title' => ''], ], [ 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'title' => '所属工作空间ID', - 'description' => 'The ID of the DataWorks workspace.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1000', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The DataWorks workspace ID. To obtain the workspace ID, log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and navigate to the workspace configuration page. 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' => true, 'example' => '10000', 'title' => ''], ], [ - 'name' => 'Statuses', - 'in' => 'query', - 'allowEmptyValue' => true, - 'style' => 'json', - 'schema' => [ - 'title' => '查询的资源组状态列表', - 'description' => 'The statuses of resource groups.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '查询的资源组状态，Normal: 正常 (运行中/服务中)；Stop: 冻结 (已到期)；Deleted: 删除 (已释放/已销毁)；Creating: 创建中 (启动中)；CreateFailed: 创建失败 (启动失败)；Updating: 更新中 (扩容中/缩容中/变配中)；UpdateFailed: 更新失败 (扩容失败/升级失败)；Deleting: 删除中 (释放中/销毁中)；DeleteFailed: 删除失败 (释放失败/销毁失败)；Timeout: 超时；Freezed: 冻结；Starting: 启动中。', - 'description' => 'The status of resource groups. Valid values:'."\n" - ."\n" - .'* Normal: The resource group is running or in use.'."\n" - .'* Stop: The resource group has expired.'."\n" - .'* Deleted: The resource group is released or destroyed.'."\n" - .'* Creating: The resource group is being created.'."\n" - .'* CreateFailed: The resource group fails to be created.'."\n" - .'* Updating: The resource group is being scaled in or out, or its configurations are being changed.'."\n" - .'* UpdateFailed: The resource group fails to be scaled out or upgraded.'."\n" - .'* Deleting: The resource group is being released or destroyed.'."\n" - .'* DeleteFailed: The resource group fails to be released or destroyed.'."\n" - .'* Timeout: The operations that are performed on the resource group time out.'."\n" - .'* Freezed: The resource group is frozen.'."\n" - .'* Starting'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Normal', - 'enum' => [ - 'Normal', - 'Stop', - 'Deleted', - 'Creating', - 'CreateFailed', - 'Updating', - 'UpdateFailed', - 'Deleting', - 'DeleteFailed', - 'Timeout', - 'Freezed', - 'Starting', - ], - ], - 'required' => false, - ], + 'name' => 'FileName', + 'in' => 'formData', + 'schema' => ['description' => 'The file name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'File name', 'title' => ''], ], [ - 'name' => 'ResourceGroupTypes', - 'in' => 'query', - 'allowEmptyValue' => true, - 'style' => 'json', - 'schema' => [ - 'title' => '查询的资源组类型列表，如果为空默认返回通用资源组', - 'description' => 'The types of resource groups to query. If you do not configure this parameter, only serverless resource groups are returned by default.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '查询的资源组类型，CommonV2：通用2.0资源组；ExclusiveDataIntegration：独享数据集成资源组；ExclusiveScheduler：独享调度资源组；ExclusiveDataService：独享数据服务资源组', - 'description' => 'Resource group types:'."\n" - ."\n" - .'* CommonV2: serverless resource group'."\n" - .'* ExclusiveDataIntegration: exclusive resource group for Data Integration'."\n" - .'* ExclusiveScheduler: exclusive resource group for scheduling'."\n" - .'* ExclusiveDataService: exclusive resource group for DataService Studio'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'CommonV2', - 'enum' => [ - 'CommonV2', - 'ExclusiveScheduler', - 'ExclusiveDataIntegration', - 'ExclusiveDataService', - ], - ], - 'required' => false, - ], + 'name' => 'FileDescription', + 'in' => 'formData', + 'schema' => ['description' => 'The description of the file.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'PaymentType', - 'in' => 'query', + 'name' => 'FileType', + 'in' => 'formData', + 'schema' => ['description' => 'The code type of the file. Different file types have different code. For more information, see [DataWorks node types](~~600169~~). You can call the [ListFileType](~~212428~~) operation to query the code types of files.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => ['description' => 'The Alibaba Cloud account ID of the file owner. If this parameter is not specified, the Alibaba Cloud account ID of the caller is used by default.', 'type' => 'string', 'required' => false, 'example' => '1000000000001', 'title' => ''], + ], + [ + 'name' => 'Content', + 'in' => 'formData', + 'schema' => ['description' => 'The file code content. Different code types (fileType) have different code formats. In Operation Center, you can find a task of the corresponding type, right-click it, and select View Code to view the specific code format.', 'type' => 'string', 'required' => false, 'example' => 'SHOW TABLES;', 'title' => ''], + ], + [ + 'name' => 'AutoRerunTimes', + 'in' => 'formData', + 'schema' => ['description' => 'The number of automatic reruns 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 at which the node is automatically rerun after a failure. Unit: milliseconds. Maximum value: 1800000 milliseconds (30 minutes).'."\n" + ."\n" + .'This parameter corresponds to the Rerun interval parameter in Properties > Schedule > Auto Rerun upon Failure for data development nodes in the [DataWorks console](https://workbench.data.aliyun.com/console). In the console, the unit of the rerun interval is minutes. Convert the time unit when you call this operation.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '120000', 'title' => ''], + ], + [ + 'name' => 'RerunMode', + 'in' => 'formData', 'schema' => [ - 'title' => '资源组的付费类型，PrePaid代表包年包月，PostPaid代表按量付费 ', - 'description' => 'The billing method of resource groups. Valid values:'."\n" + 'description' => 'The rerun policy. Valid values:'."\n" + ."\n" + .'- ALL\\_ALLOWED: Reruns are allowed regardless of whether the task succeeds or fails.'."\n" + ."\n" + .'- FAILURE\\_ALLOWED: Reruns are allowed only when the task fails.'."\n" ."\n" - .'* PrePaid'."\n" - .'* PostPaid'."\n", + .'- ALL\\_DENIED: Reruns are not allowed regardless of whether the task succeeds or fails.'."\n" + ."\n" + .'This parameter corresponds to the Support for Rerun setting in Scheduling > Scheduling Policies for Data Studio tasks in the [DataWorks console](https://workbench.data.aliyun.com/console).', + 'enumValueTitles' => [], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [], - 'example' => 'PrePaid', - 'enum' => [ - 'PrePaid', - 'PostPaid', - ], + 'default' => 'ALL_ALLOWED', + 'enum' => ['ALL_ALLOWED', 'FAILURE_ALLOWED', 'ALL_DENIED'], + 'example' => 'ALL_ALLOWED', + 'title' => '', ], ], [ - 'name' => 'AliyunResourceGroupId', - 'in' => 'query', + 'name' => 'Stop', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to skip execution. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false'."\n" + ."\n" + .'This parameter corresponds to the Skip Execution option in Properties > Schedule > Recurrence for data development nodes 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 Scheduling Parameter setting in Properties for data development nodes in the [DataWorks console](https://workbench.data.aliyun.com/console). For more information, see [Scheduling parameters](~~137548~~).', 'type' => 'string', 'required' => false, 'example' => 'a=x b=y', 'title' => ''], + ], + [ + 'name' => 'StartEffectDate', + 'in' => 'formData', + 'schema' => ['description' => 'The timestamp (in milliseconds) when automatic scheduling starts.'."\n" + ."\n" + .'This parameter corresponds to the start time of Effective Period in Scheduling > Scheduling Time for Data Studio tasks 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 timestamp (in milliseconds) when automatic scheduling stops.'."\n" + ."\n" + .'This parameter corresponds to the end time of Effective Period in Scheduling > Scheduling Time for Data Studio tasks 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 for scheduled execution. This parameter corresponds to the Cron Expression setting in Scheduling > Scheduling Time for Data Studio tasks in the [DataWorks console](https://workbench.data.aliyun.com/console). After you configure Scheduling Cycle and Scheduled Time, DataWorks automatically generates a cron expression.'."\n" + ."\n" + .'Examples:'."\n" + ."\n" + .'- Scheduled at 05:30 every day: `00 30 05 * * ?`'."\n" + ."\n" + .'- Scheduled at the 15th minute of every hour: `00 15 00-23/1 * * ?`'."\n" + ."\n" + .'- Scheduled every 10 minutes: `00 00/10 * * * ?`'."\n" + ."\n" + .'- Scheduled every 10 minutes between 08:00 and 17:00 every day: `00 00-59/10 8-17 * * * ?`'."\n" + ."\n" + .'- Scheduled at 00:20 on the 1st day of every month: `00 20 00 1 * ?`'."\n" + ."\n" + .'- Scheduled every 3 months starting from 00:10 on January 1: `00 10 00 1 1-12/3 ?`'."\n" + ."\n" + .'- Scheduled at 00:05 on every Tuesday and Friday: `00 05 00 * * 2,5`'."\n" + ."\n" + .'Due to the rules of the DataWorks scheduling system, cron expressions have the following restrictions:'."\n" + ."\n" + .'- The minimum scheduling interval is 5 minutes.'."\n" + ."\n" + .'- The earliest scheduling time each day is 00:05.', 'type' => 'string', 'required' => false, 'default' => 'day', 'example' => '00 05 00 * * ?', 'title' => ''], + ], + [ + 'name' => 'CycleType', + 'in' => 'formData', 'schema' => [ - 'title' => '阿里云资源组ID', - 'description' => 'Alibaba Cloud Resource Group ID', + 'description' => 'The type of scheduling cycle. Valid values: NOT\\_DAY (minute, hour) and DAY (day, week, month).'."\n" + ."\n" + .'This parameter corresponds to the Scheduling Cycle setting in Scheduling > Scheduling Time for Data Studio tasks in the [DataWorks console](https://workbench.data.aliyun.com/console).', + 'enumValueTitles' => [], 'type' => 'string', 'required' => false, - 'example' => 'rg-aek2kqofrgXXXXX', + 'default' => 'DAY', + 'enum' => ['DAY', 'NOT_DAY'], + 'example' => 'DAY', + 'title' => '', ], ], [ - 'name' => 'AliyunResourceTags', - 'in' => 'query', - 'allowEmptyValue' => true, - 'style' => 'json', + 'name' => 'DependentType', + 'in' => 'formData', 'schema' => [ - 'title' => '阿里云标签列表', - 'description' => 'Alibaba Cloud tag list', - 'type' => 'array', - 'items' => [ - 'title' => '阿里云标签', - 'description' => 'Alibaba Cloud label', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => '标签Key', - 'description' => 'Tag Key', - 'type' => 'string', - 'required' => false, - 'example' => 'key', - ], - 'Value' => [ - 'title' => '标签Value', - 'description' => 'Tag Value', - 'type' => 'string', - 'required' => false, - 'example' => 'value', - ], - ], - 'required' => false, - ], + 'description' => 'The dependency mode on the previous cycle. Valid values:'."\n" + ."\n" + .'- SELF: Depends on the current node.'."\n" + ."\n" + .'- CHILD: Depends on the child nodes.'."\n" + ."\n" + .'- USER\\_DEFINE: Depends on other nodes.'."\n" + ."\n" + .'- NONE: No dependencies. Does not depend on the previous cycle.'."\n" + ."\n" + .'- USER\\_DEFINE\\_AND\\_SELF: Depends on both the current node and other nodes in the previous cycle.'."\n" + ."\n" + .'- CHILD\\_AND\\_SELF: Depends on both the current node and its child nodes in the previous cycle.', + 'enumValueTitles' => [], + 'type' => 'string', 'required' => false, + 'default' => 'NONE', + 'enum' => ['NONE', 'USER_DEFINE', 'CHILD', 'SELF', 'USER_DEFINE_AND_SELF', 'CHILD_AND_SELF'], + 'example' => 'NONE', + 'title' => '', ], ], [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '分页大小', - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - 'default' => '100', - ], + 'name' => 'DependentNodeIdList', + 'in' => 'formData', + 'schema' => ['description' => 'The IDs of the nodes on which the current node depends. This parameter takes effect only when the DependentType parameter is set to USER\\_DEFINE. Separate multiple node IDs with commas (,).'."\n" + ."\n" + .'This parameter corresponds to the Other Nodes option in Properties > Dependencies > Cross-cycle Dependency (Original Previous-cycle Dependency) for data development nodes in the [DataWorks console](https://workbench.data.aliyun.com/console).', 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''], ], [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'title' => '分页页码', - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + 'name' => 'InputList', + 'in' => 'formData', + 'schema' => ['description' => 'The output names of the ancestor nodes on which the current node depends. Separate multiple output names with commas (,).'."\n" + ."\n" + .'This parameter corresponds to the Output Name of Ancestor Node setting in Properties > Dependencies for data development nodes 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' => 'SortBy', - 'in' => 'query', + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => ['description' => 'The DataWorks workspace name. To obtain the workspace name, log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and navigate to the workspace configuration page.'."\n" + ."\n" + .'You must specify either this parameter or ProjectId to identify the target DataWorks workspace for this API call.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'dw_project', 'title' => ''], + ], + [ + 'name' => 'ResourceGroupIdentifier', + 'in' => 'formData', + 'schema' => ['description' => 'The resource group for the task published from the file. To obtain the ID, log on to the [DataWorks console](https://workbench.data.aliyun.com/console), navigate to the workspace configuration page, and click Resource Groups in the left-side navigation pane to view the IDs of resource groups bound to the current workspace.', 'type' => 'string', 'required' => false, 'example' => 'S_res_group_559_1613715566828', 'title' => ''], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => ['description' => 'This parameter is deprecated.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '375827434852437', 'title' => ''], + ], + [ + 'name' => 'ConnectionName', + 'in' => 'formData', + 'schema' => ['description' => 'The data source used when the task published from the file 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 automatic parsing for the file. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false'."\n" + ."\n" + .'This parameter corresponds to the Analyze Code setting in Properties > Dependencies for data development nodes 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' => [ - 'title' => '排序字段列表，支持定时时间、开始时间等字段。格式为"排序字段+排序方式(Desc/Asc)"（Asc可以缺省）。排序字段的枚举值如下：'."\n" - .'● Id (Desc/Asc)：资源组ID'."\n" - .'● Name (Desc/Asc)：资源组名称'."\n" - .'● Remark (Desc/Asc)：资源组备注'."\n" - .'● Type (Desc/Asc)：资源组类型'."\n" - .'● Status (Desc/Asc)：资源组资源状态'."\n" - .'● Spec (Desc/Asc)：资源组规格'."\n" - .'● CreateUser (Desc/Asc)：创建人'."\n" - .'● CreateTime (Desc/Asc)：创建时间'."\n" - .'默认值为CreateTime Asc', - 'description' => 'The list of fields used for sorting. Fields such as TriggerTime and StartedTime are supported. You must configure this parameter in the Sorting field + Sort by (Desc/Asc). By default, results are sorted in ascending order. Valid values:'."\n" - ."\n" - .'* Id (Desc/Asc): the resource group ID'."\n" - .'* Name (Desc/Asc): the name of the resource group'."\n" - .'* Remark (Desc/Asc): the remarks of the resource group'."\n" - .'* Type (Desc/Asc): the type of the resource group'."\n" - .'* Status (Desc/Asc): the status of the resource group'."\n" - .'* Spec (Desc/Asc): the specifications of the resource group'."\n" - .'* CreateUser (Desc/Asc): the creator of the resource group'."\n" - .'* CreateTime (Desc/Asc): the time when the resource group is created'."\n" - ."\n" - .'Default value: CreateTime Asc'."\n", + 'description' => 'The scheduling type. Valid values:'."\n" + ."\n" + .'- NORMAL: Normal scheduled task.'."\n" + ."\n" + .'- MANUAL: Manually triggered node. Not scheduled for daily execution. Corresponds to nodes in manually triggered workflows.'."\n" + ."\n" + .'- PAUSE: Paused task.'."\n" + ."\n" + .'- SKIP: Dry-run task. Scheduled for daily execution but is directly marked as successful when scheduling starts.', + 'enumValueTitles' => [], 'type' => 'string', 'required' => false, - 'example' => 'CreateTime Asc', - 'default' => 'CreateTime Asc', + 'docRequired' => false, + 'enum' => ['NORMAL', 'MANUAL', 'PAUSE', 'SKIP'], + 'example' => 'NORMAL', + 'title' => '', ], ], + [ + 'name' => 'AdvancedSettings', + 'in' => 'formData', + 'schema' => ['description' => 'The advanced settings of the node.'."\n" + ."\n" + .'This parameter corresponds to the Advanced Settings section in the right-side navigation pane on the configuration tab of EMR Spark Streaming and EMR Streaming SQL nodes in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n" + ."\n" + .'Only EMR Spark Streaming and EMR Streaming SQL nodes support this parameter. The value 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 the node after the node is deployed.'."\n" + ."\n" + .'This parameter corresponds to the Start Method setting in Settings > Schedule in the right-side navigation pane on the configuration tab of EMR Spark Streaming and EMR Streaming SQL nodes 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 context parameters of the node. The value must be in the JSON format. For more information about the parameter structure, see the InputContextParameterList parameter in the response parameters of the [GetFile](~~173954~~) operation.'."\n" + ."\n" + .'This parameter corresponds to the Input Parameters setting in Properties > Input and Output Parameters for data development nodes 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 context parameters of the node. The value must be in the JSON format. For more information about the parameter structure, see the OutputContextParameterList parameter in the response parameters of the [GetFile](~~173954~~) operation.'."\n" + ."\n" + .'This parameter corresponds to the Output Parameters setting in Properties > Input and Output Parameters for data development nodes 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' => 'Specifies whether to inherit the dry-run status from the previous cycle. Valid values:'."\n" + ."\n" + .'- true: Inherit the dry-run status from the previous cycle.'."\n" + ."\n" + .'- false: Do not inherit the dry-run status from the previous cycle.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'CreateFolderIfNotExists', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to automatically create the directory specified by FileFolderPath if the directory does not exist. Valid values:'."\n" + ."\n" + .'- true: If the directory does not exist, automatically create it.'."\n" + ."\n" + .'- false: If the directory does not exist, the call fails.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'ApplyScheduleImmediately', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to apply the scheduling configuration immediately after the file is published.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'Timeout', + 'in' => 'formData', + 'schema' => ['description' => 'The timeout settings for scheduling configuration.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'ImageId', + 'in' => 'formData', + 'schema' => ['description' => 'The custom image ID.', 'type' => 'string', 'required' => false, 'example' => 'm-bp1h4b5a8ogkbll2f3tr', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'title' => '是否请求成功', - 'description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'PagingInfo' => [ - 'title' => '分页列表', - 'description' => 'The pagination information.'."\n", - 'type' => 'object', - 'properties' => [ - 'ResourceGroupList' => [ - 'title' => '获取到的资源组详情列表', - 'description' => 'The resource groups returned.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '资源组详细信息', - 'description' => 'The details about a resource group.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '资源组唯一标识', - 'description' => 'Unique identifier of a resource group', - 'type' => 'string', - 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX', - ], - 'Name' => [ - 'title' => '资源组的名称', - 'description' => 'The name of the resource group.', - 'type' => 'string', - 'example' => 'common_resource_group', - ], - 'Remark' => [ - 'title' => '资源组的备注', - 'description' => 'Remarks for resource groups', - 'type' => 'string', - 'example' => 'Create a common resource group for common tasks', - ], - 'PaymentType' => [ - 'title' => '资源组的付费类型，PrePaid代表包年包月，PostPaid代表按量付费 ', - 'description' => 'The billing method of the resource group. Valid values: PrePaid and PostPaid. The value PrePaid indicates the subscription billing method, and the value PostPaid indicates the pay-as-you-go billing method.'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'PrePaid', - 'enum' => [ - 'PrePaid', - 'PostPaid', - ], - ], - 'Status' => [ - 'title' => '资源组状态，Normal: 正常 (运行中/服务中)；Stop: 冻结 (已到期)；Deleted: 删除 (已释放/已销毁)；Creating: 创建中 (启动中)；CreateFailed: 创建失败 (启动失败)；Updating: 更新中 (扩容中/缩容中/变配中)；UpdateFailed: 更新失败 (扩容失败/升级失败)；Deleting: 删除中 (释放中/销毁中)；DeleteFailed: 删除失败 (释放失败/销毁失败)；Timeout: 超时；Freezed: 冻结；Starting: 启动中。', - 'description' => 'The status of the resource group. Valid values:'."\n" - ."\n" - .'* Normal: The resource group is running or in use.'."\n" - .'* Stop: The resource group is expired.'."\n" - .'* Deleted: The resource group is released or destroyed.'."\n" - .'* Creating: The resource group is being created.'."\n" - .'* CreateFailed: The resource group fails to be created.'."\n" - .'* Updating: The resource group is being scaled in or out, or the configurations of the resource group are being changed.'."\n" - .'* UpdateFailed: The resource group fails to be scaled out or upgraded.'."\n" - .'* Deleting: The resource group is being released or destroyed.'."\n" - .'* DeleteFailed: The resource group fails to be released or destroyed.'."\n" - .'* Timeout: The operations that are performed on the resource group time out.'."\n" - .'* Freezed: The resource group is frozen.'."\n" - .'* Starting: The resource group is being started.'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Normal', - 'enum' => [ - 'Normal', - 'Stop', - 'Deleted', - 'Creating', - 'CreateFailed', - 'Updating', - 'UpdateFailed', - 'Deleting', - 'DeleteFailed', - 'Timeout', - 'Freezed', - 'Starting', - ], - ], - 'Spec' => [ - 'title' => '资源组规格', - 'description' => 'Resource Group specifications', - 'type' => 'object', - 'properties' => [ - 'Standard' => [ - 'title' => '规格详情', - 'description' => 'Specification details', - 'type' => 'string', - 'example' => '2CU', - ], - 'Amount' => [ - 'title' => '数量', - 'description' => 'Quantity', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - ], - ], - 'ResourceGroupType' => [ - 'title' => '资源组类型，CommonV2：通用2.0资源组；ExclusiveDataIntegration：独享数据集成资源组；ExclusiveScheduler：独享调度资源组；ExclusiveDataService：独享数据服务资源组', - 'description' => 'Resource group types:'."\n" - ."\n" - .'* CommonV2: Serverless resource group'."\n" - .'* ExclusiveDataIntegration: Exclusive resource group for Data Integration'."\n" - .'* ExclusiveScheduler: Exclusive resource group for scheduling'."\n" - .'* ExclusiveDataService: Exclusive resource group for DataService Studio'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'CommonV2', - 'enum' => [ - 'CommonV2', - 'ExclusiveDataIntegration', - 'ExclusiveScheduler', - 'ExclusiveDataService', - ], - ], - 'OrderInstanceId' => [ - 'title' => '资源组的订单实例ID', - 'description' => 'The order instance ID of the resource group.', - 'type' => 'string', - 'example' => 'c442b330-3b10-4584-959e-736e4edXXXXX', - ], - 'CreateUser' => [ - 'title' => '创建该资源组的用户ID', - 'description' => 'The ID of the user who created the resource group.', - 'type' => 'string', - 'example' => '11075500042XXXXX', - ], - 'CreateTime' => [ - 'title' => '创建时间，为64位时间戳', - 'description' => 'The creation time, which is a 64-bit timestamp.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1727055811000', - ], - 'DefaultVpcId' => [ - 'title' => '通用资源组绑定的默认VPC ID', - 'description' => 'Default VPC ID bound to a common resource group', - 'type' => 'string', - 'example' => 'vpc-m2et4f3oc8msfbccXXXXX', - ], - 'DefaultVswicthId' => [ - 'title' => '通用资源组绑定的默认交换机ID', - 'description' => 'The default switch ID bound to the common resource group.', - 'type' => 'string', - 'example' => 'vsw-uf8usrhs7hjd9amsXXXXX', - ], - 'AliyunResourceGroupId' => [ - 'title' => '阿里云资源组ID', - 'description' => 'Alibaba Cloud Resource Group ID', - 'type' => 'string', - 'example' => 'rg-aek2kqofrgXXXXX', - ], - 'AliyunResourceTags' => [ - 'title' => '阿里云标签列表', - 'description' => 'Alibaba Cloud tag list', - 'type' => 'array', - 'items' => [ - 'title' => '阿里云标签', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => '标签键', - 'description' => 'Tag Key', - 'type' => 'string', - 'example' => 'Key', - ], - 'Value' => [ - 'title' => '标签值', - 'description' => 'Tag Value', - 'type' => 'string', - 'example' => 'Value', - ], - ], - ], - ], - ], - ], - ], - 'PageNumber' => [ - 'title' => '分页页码', - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'default' => '1', - ], - 'PageSize' => [ - 'title' => '分页大小', - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - 'default' => '100', - ], - 'TotalCount' => [ - 'title' => '全部数据条目', - 'description' => 'All data entries', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - ], - ], - 'RequestId' => [ - 'title' => '请求的ID，用于定位日志，排查问题', - 'description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The file ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000001', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. Use this ID to troubleshoot issues.', '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 call succeeded. Valid values:'."\n" + ."\n" + .'- true: The call succeeded.'."\n" + ."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"PagingInfo\\": {\\n \\"ResourceGroupList\\": [\\n {\\n \\"Id\\": \\"Serverless_res_group_524257424564736_6831777003XXXXX\\",\\n \\"Name\\": \\"common_resource_group\\",\\n \\"Remark\\": \\"创建用于普通任务的通用资源组\\",\\n \\"PaymentType\\": \\"PrePaid\\",\\n \\"Status\\": \\"Normal\\",\\n \\"Spec\\": {\\n \\"Standard\\": \\"2CU\\",\\n \\"Amount\\": 1\\n },\\n \\"ResourceGroupType\\": \\"CommonV2\\",\\n \\"OrderInstanceId\\": \\"c442b330-3b10-4584-959e-736e4edXXXXX\\",\\n \\"CreateUser\\": \\"11075500042XXXXX\\",\\n \\"CreateTime\\": 1727055811000,\\n \\"DefaultVpcId\\": \\"vpc-m2et4f3oc8msfbccXXXXX\\",\\n \\"DefaultVswicthId\\": \\"vsw-uf8usrhs7hjd9amsXXXXX\\",\\n \\"AliyunResourceGroupId\\": \\"rg-aek2kqofrgXXXXX\\",\\n \\"AliyunResourceTags\\": [\\n {\\n \\"Key\\": \\"Key\\",\\n \\"Value\\": \\"Value\\"\\n }\\n ]\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 100\\n },\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]', - 'title' => 'ListResourceGroups', - ], - 'DissociateProjectFromResourceGroup' => [ - 'summary' => 'Disassociates a resource group from a workspace.', - '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.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', + '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 Data Integration nodes.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'CreateFolder' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '245167', - 'abilityTreeNodes' => [ - 'FEATUREdide2SV6DS', - ], - 'tenantRelevance' => 'tenant', + 'operationType' => 'create', + 'abilityTreeCode' => '268606', + 'abilityTreeNodes' => ['FEATUREdide8FM783'], ], 'parameters' => [ [ - 'name' => 'ResourceGroupId', + 'name' => 'ProjectId', 'in' => 'formData', - 'schema' => [ - 'title' => '资源组唯一标识', - 'description' => 'The ID of the resource group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX', - ], + 'schema' => ['description' => 'The ID of the DataWorks workspace. You can obtain the workspace ID from the workspace configuration page in the DataWorks console. Either this parameter or **ProjectIdentifier** must be specified to determine which DataWorks workspace this API call operates on.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10000', 'title' => ''], ], [ - 'name' => 'ProjectId', + 'name' => 'ProjectIdentifier', 'in' => 'formData', - 'schema' => [ - 'title' => '解绑的工作空间ID', - 'description' => 'The ID of the workspace from which you want to disassociate the resource group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1000', - ], + 'schema' => ['description' => 'The name of the DataWorks workspace. You can obtain the workspace name from the workspace configuration page in the DataWorks console. Either this parameter or **ProjectId** must be specified to determine which DataWorks workspace this API call operates on.', 'type' => 'string', 'required' => false, 'example' => 'dw_project', 'title' => ''], + ], + [ + 'name' => 'FolderPath', + 'in' => 'formData', + 'schema' => ['description' => 'The path of the folder.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Business_process/System_Data/MaxCompute/import_layer', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'title' => '是否请求成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - 'default' => 'true', - ], - 'RequestId' => [ - 'title' => '请求的ID，用于定位日志，排查问题', - 'description' => 'The request ID. You can use the ID to locate logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', - ], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The unique identifier of the newly created folder.', 'type' => 'string', 'example' => 'bdfd68****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. Used for troubleshooting when errors occur.', '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 call succeeded. 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' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]', - 'title' => 'DissociateProjectFromResourceGroup', - 'description' => '1. You can use this API operation only in DataWorks Basic Edition or an advanced edition.'."\n" - .'2. Your account must be assigned one of the following roles of the desired workspace:'."\n" - ."\n" - .'* Tenant Owner, Workspace Administrator, Workspace Owner, and O\\&M'."\n", - ], - 'AssociateProjectToResourceGroup' => [ - 'summary' => 'Associates a resource group with a workspace.', - '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.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', + '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"}]', + 'title' => 'CreateFolder', + 'summary' => 'Creates a folder.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'CreateFunction' => [ + 'summary' => 'Creates a user-defined function (UDF) in DataStudio. The information about the UDF is described by using FlowSpec.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -9353,109 +8151,122 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '245168', - 'abilityTreeNodes' => [ - 'FEATUREdide2SV6DS', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '236012', + 'abilityTreeNodes' => ['FEATUREdideZOYJZL'], ], 'parameters' => [ [ - 'name' => 'ResourceGroupId', + 'name' => 'ProjectId', 'in' => 'formData', - 'schema' => [ - 'title' => '资源组唯一标识', - 'description' => 'The ID of the resource group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX', - ], + '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, 'example' => '12345', 'title' => ''], ], [ - 'name' => 'ProjectId', + 'name' => 'Spec', 'in' => 'formData', - 'schema' => [ - 'title' => '要绑定的工作空间ID', - 'description' => 'The ID of the DataWorks workspace with which you want to associate the resource group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1000', - ], + 'schema' => ['description' => 'The FlowSpec field information about the UDF. For more information, see [FlowSpec](https://github.com/aliyun/dataworks-spec/blob/master/README_zh_CN.md).', 'type' => 'string', 'required' => true, 'example' => '{'."\n" + .' "version": "1.1.0",'."\n" + .' "kind": "Function",'."\n" + .' "spec": {'."\n" + .' "functions": ['."\n" + .' {'."\n" + .' "name": "function name",'."\n" + .' "script": {'."\n" + .' "content": "{\\"name\\": \\"function name\\", \\"datasource\\": {\\"type\\": \\"ODPS\\", \\"name\\": \\"ODPS_first\\"}, \\"runtimeResource\\": {\\"resourceGroup\\": \\"s_res_group_xx_xxxx\\"}}",'."\n" + .' "path": "XXX/OpenAPI/function/function name",'."\n" + .' "runtime": {'."\n" + .' "command": "ODPS_FUNCTION"'."\n" + .' }'."\n" + .' },'."\n" + .' "datasource": {'."\n" + .' "name": "ODPS_first",'."\n" + .' "type": "ODPS"'."\n" + .' },'."\n" + .' "runtimeResource": {'."\n" + .' "resourceGroup": "S_res_group_XXXX_XXXX"'."\n" + .' }'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .'}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'title' => '是否请求成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - 'default' => 'true', - ], - 'RequestId' => [ - 'title' => '请求的ID，用于定位日志，排查问题', - 'description' => 'The request ID. You can use the ID to locate logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.', 'type' => 'string', 'example' => 'AE49C88D-5BEE-5ADD-8B8C-C4BBC0D7****'], + 'Id' => ['description' => 'The unique identifier of the UDF function.'."\n" + ."\n" + .'> Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.', 'type' => 'string', 'example' => '580667964888595XXXX', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]', - 'title' => 'AssociateProjectToResourceGroup', - 'description' => '1. You can use this API operation only in DataWorks Basic Edition or an advanced edition.'."\n" - .'2. Your account must be assigned one of the following roles of the desired workspace:'."\n" + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AE49C88D-5BEE-5ADD-8B8C-C4BBC0D7****\\",\\n \\"Id\\": \\"580667964888595XXXX\\"\\n}","type":"json"}]', + 'title' => 'CreateFunction', + 'description' => '>'."\n" ."\n" - .'* Tenant Owner, Workspace Administrator, Workspace Owner, and O\\&M'."\n", - ], - 'ListResourceGroupAssociateProjects' => [ - 'summary' => 'Gets the list of workspaces bound to a resource group.', - 'methods' => [ - 'get', - 'post', + .'This API does not support batch operations. If you define more than one UDF in the FlowSpec, all UDFs except the first one are ignored.'."\n" + ."\n" + .'>', + 'changeSet' => [ + ['createdAt' => '2025-01-13T07:36:03.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateIdentifyCredential' => [ + 'summary' => 'Creates an identity credential.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdide2SV6DS', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREdide23ZCHK'], ], 'parameters' => [ [ - 'name' => 'ResourceGroupId', - 'in' => 'query', + 'name' => 'IdentifyCredential', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '通用资源组唯一标识', - 'description' => 'The ID of the serverless resource group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Serverless_res_group_524257424564736_6831777003****', + 'description' => 'The user credential object.', + 'enumValueTitles' => [], + '$ref' => '#/components/schemas/IdentifyCredential', + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -9463,332 +8274,323 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'title' => '是否请求成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - 'default' => 'true', - ], - 'ProjectIdList' => [ - 'title' => '项目空间ID列表', - 'description' => 'The list of workspace IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '项目空间ID', - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - ], - 'RequestId' => [ - 'title' => '请求的ID，用于定位日志，排查问题', - 'description' => 'The request ID. You can use this ID to troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX'."\n", - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0000-ABCD-EFG****'], + 'Data' => ['description' => 'success true or false', 'type' => 'string', 'example' => '{ "HttpStatusCode": 200, "Success": true }', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ProjectIdList\\": [\\n 123\\n ],\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\\\n\\"\\n}","type":"json"}]', - 'title' => 'ListResourceGroupAssociateProjects', - 'description' => '1. This API operation is available for all DataWorks editions.'."\n" - .'2. **Make sure that the AliyunServiceRoleForDataWorks service-linked role is created before you call this operation.'."\n", - ], - 'ListResourceGroupMetricData' => [ - 'summary' => 'Queries the metric data of a resource group.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateIdentifyCredential', + 'description' => '>'."\n" + ."\n" + .'This operation does not support batch processing. If you specify multiple entities in the request parameters, only the first entity is processed and the rest are ignored.'."\n" + ."\n" + .'>', + 'requestParamsDescription' => 'Note:'."\n" + .'The UserType, DataSource.Type, and DataSource.Role parameters must be set to values within their respective enumeration ranges.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataworks:CreateIdentifyCredential', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"Data\\": \\"{ \\\\\\"HttpStatusCode\\\\\\": 200, \\\\\\"Success\\\\\\": true }\\"\\n}","type":"json"}]', + ], + 'CreateLineageRelationship' => [ + 'summary' => 'Registers a data lineage relationship in DataWorks Data Map. You can use this operation to establish lineage relationships between metadata entities managed by DataWorks, including table-to-table, column-to-column, table-to-column, and dataset-to-table scenarios. You can also establish lineage relationships between managed entities and custom entity objects registered by users. This operation is compatible with non-managed custom objects, but this approach is no longer recommended. Before calling this operation, make sure that the managed entities involved in the lineage registration already exist on the DataWorks platform.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdide2SV6DS', - ], - 'tenantRelevance' => 'tenant', + 'operationType' => 'create', + 'abilityTreeCode' => '268107', + 'abilityTreeNodes' => ['FEATUREdideE9OA4H'], ], 'parameters' => [ [ - 'name' => 'ResourceGroupId', - 'in' => 'formData', - 'schema' => [ - 'title' => '通用资源组唯一标识', - 'description' => 'The unique identifier for the general-purpose resource group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX', - ], + 'name' => 'SrcEntity', + 'in' => 'query', + 'style' => 'json', + 'schema' => ['description' => 'The source entity.', '$ref' => '#/components/schemas/LineageEntity', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'MetricName', - 'in' => 'formData', + 'name' => 'DstEntity', + 'in' => 'query', + 'style' => 'json', + 'schema' => ['description' => 'The destination entity.', '$ref' => '#/components/schemas/LineageEntity', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'Task', + 'in' => 'query', + 'style' => 'json', + 'schema' => ['description' => 'The task information.', '$ref' => '#/components/schemas/LineageTask', 'required' => false, 'title' => '', 'example' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '指标名称', - 'description' => 'The metric name. Valid values:'."\n" - ."\n" - .'* CUSpec: Maximum CU capacity of the resource group, in CUs.'."\n" - .'* CUUsage: CU usage of the resource group, in CUs.'."\n" - .'* CUUtilization: CU utilization of the resource group, in %.'."\n" - .'* SlotSpec: Maximum number of concurrent slots for resource group scheduling, in slots.'."\n" - .'* SlotUsage: Used concurrency for resource group scheduling, in slots.'."\n" - .'* SchedulerCUMaxSpec: Maximum CU quota for data computing, in CUs.'."\n" - .'* SchedulerCUUsage: CU usage for data computing, in CUs.'."\n" - .'* SchedulerCUMinSpec: Minimum guaranteed CUs for data computing, in CUs.'."\n" - .'* DataIntegrationCUMaxSpec: Maximum CU quota for Data Integration, in CUs.'."\n" - .'* DataIntegrationCUUsage: CU usage for Data Integration, in CUs.'."\n" - .'* DataIntegrationCUMinSpec: Minimum guaranteed CUs for Data Integration, in CUs.'."\n" - .'* DataServiceCUMaxSpec: Maximum CU quota for DataService Studio, in CUs.'."\n" - .'* DataServiceCUUsage: CU usage for DataService Studio, in CUs.'."\n" - .'* DataServiceCUMinSpec: Minimum guaranteed CUs for DataService Studio, in CUs.'."\n" - .'* ServerIdeCUMaxSpec: Maximum CU quota for personal development environment, in CUs.'."\n" - .'* ServerIdeCUUsage: CU usage for personal development environment, in CUs.'."\n" - .'* ServerIdeCUMinSpec: Minimum guaranteed CUs for personal development environment, in CUs.'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [], - 'example' => 'CUSpec', - 'enum' => [ - 'CUSpec', - 'CUUsage', - 'CUUtilization', - 'SlotSpec', - 'SlotUsage', - 'SchedulerCUMaxSpec', - 'SchedulerCUUsage', - 'SchedulerCUMinSpec', - 'DataIntegrationCUMaxSpec', - 'DataIntegrationCUUsage', - 'DataIntegrationCUMinSpec', - 'DataServiceCUMaxSpec', - 'DataServiceCUUsage', - 'DataServiceCUMinSpec', - 'ServerIdeCUMaxSpec', - 'ServerIdeCUUsage', - 'ServerIdeCUMinSpec', + 'title' => '', + 'description' => 'The response.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID. A unique identifier for the request.', 'type' => 'string', 'example' => 'C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490', 'title' => ''], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'Id' => ['description' => 'The lineage relationship ID.', 'type' => 'string', 'example' => '4as3dasf654a', 'title' => ''], ], + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490\\",\\n \\"Success\\": true,\\n \\"Id\\": \\"4as3dasf654a\\"\\n}","type":"json"}]', + 'title' => 'Register data lineage relationship in data map', + 'description' => '1. DataWorks Professional Edition or a higher edition is required.', + 'requestParamsDescription' => '## Entity object (SrcEntity / DstEntity)'."\n" + ."\n" + .'Describes the source and destination of a lineage relationship. You can register lineage relationships between the following types of entities:'."\n" + ."\n" + .'| Entity type | Pre-registration required | How to obtain the ID | Description |'."\n" + .'| --- | --- | --- | --- |'."\n" + .'| DataWorks collected table | No | Call `ListTables` or `GetTable` and use the `Id` in the response. | Applicable to tables already collected by the DataWorks platform or extended tables registered by users. |'."\n" + .'| DataWorks collected column | No | Call `ListColumns` or `GetColumn` and use the `Id` in the response. | Columns corresponding to collected tables. |'."\n" + .'| Dataset | No, if the dataset already exists. To create a dataset, call `CreateDataset` first. | Call `CreateDataset`, `ListDatasets`, or `GetDataset` and use the `Id` in the response. | Applicable to DataWorks dataset entities. |'."\n" + .'| Dataset version | No, if the version already exists. To create a version, call `CreateDatasetVersion` first. | Call `CreateDatasetVersion`, `ListDatasetVersions`, or `GetDatasetVersion` and use the `Id` in the response. | Applicable to specific versions of a dataset. |'."\n" + .'| User-registered custom entity object | Yes | Call `CreateMetaEntityDef` to create a custom entity definition, then call `BatchCreateMetaEntities` to create entity objects, and use the `Id` in the response. | Applicable to custom entities that need to be managed and queried in DataWorks. |'."\n" + .'| Non-managed custom object (not recommended) | No | The caller specifies an `Id` prefixed with `custom-` in the format `custom-{Type}:{Identifier}`. | Compatible with legacy usage but no longer recommended. For external reports, third-party system objects, and other custom objects, register them as DataWorks custom entity objects first and then register the lineage. |'."\n" + ."\n" + .'Additional notes:'."\n" + ."\n" + .'- For tables, columns, datasets, and dataset versions already collected by DataWorks, do not manually construct the `Id`. Use the `Id` returned by the corresponding `Get` or `List` API.'."\n" + .'- For custom objects, use the user-registered custom entity object approach. Complete the entity definition and entity object registration first:'."\n" + .' 1. Call `CreateMetaEntityDef` to create a custom entity definition.'."\n" + .' 2. Call `BatchCreateMetaEntities` to create specific entity objects.'."\n" + .' 3. Use the entity `Id` returned by `BatchCreateMetaEntities` as `SrcEntity.Id` or `DstEntity.Id`.'."\n" + .'- For non-managed custom objects, you do not need to call `CreateMetaEntityDef` or `BatchCreateMetaEntities`. Simply pass an entity `Id` prefixed with `custom-` and specify the `Name`. This approach is mainly for backward compatibility with legacy scenarios and is no longer recommended. For new integrations, use the registered custom entity object approach for easier querying, management, and custom attribute extension.'."\n" + .'- `SrcEntity.Attributes` and `DstEntity.Attributes` represent extended attributes of the entity endpoints. Place attributes of the lineage relationship itself in `Task.Attributes`.'."\n" + ."\n" + .'## Task information (Task)'."\n" + ."\n" + .'Describes the job or task that produces the lineage relationship.'."\n" + ."\n" + .'| Parameter | Type | Required | Description |'."\n" + .'| --- | --- | --- | --- |'."\n" + .'| Id | String | No | The unique identifier of the task. We recommend that you pass a stable value for idempotent registration, querying, and deletion. Only letters, digits, and underscores are supported. Maximum length: 64 characters. |'."\n" + .'| Type | String | Yes | The task type. Must start with `custom-`. Only letters, digits, underscores, and hyphens are supported. Maximum length: 64 characters. |'."\n" + .'| Attributes | Map | No | The task attributes. A maximum of 20 attributes are supported. Complex values must be serialized as JSON strings.
• Key: the attribute name (letters, digits, and underscores, ≤ 64 characters).
• Value: the attribute value (≤ 128 characters). |.'."\n" + ."\n" + .'## Request examples.'."\n" + ."\n" + .'### DataWorks collected table and custom entity object'."\n" + ."\n" + .'```json'."\n" + .'{'."\n" + .' "SrcEntity": {'."\n" + .' "Id": "custom_entity-customer_api:api_001",'."\n" + .' "Name": "api_001"'."\n" + .' },'."\n" + .' "DstEntity": {'."\n" + .' "Id": "mysql-table:rm-xxx::demo_db::demo_table",'."\n" + .' "Name": "demo_table"'."\n" + .' },'."\n" + .' "Task": {'."\n" + .' "Id": "api_to_table_001",'."\n" + .' "Type": "custom-lineage-task",'."\n" + .' "Attributes": {'."\n" + .' "scene": "api_to_table",'."\n" + .' "owner": "zhangsan"'."\n" + .' }'."\n" + .' }'."\n" + .'}'."\n" + .'```.'."\n" + ."\n" + .'### Non-managed custom object and DataWorks collected table'."\n" + ."\n" + .'> This approach is mainly for backward compatibility with legacy usage and is no longer recommended. For new integrations, register custom entity objects by using `CreateMetaEntityDef` and `BatchCreateMetaEntities` first, and then use the returned entity `Id` to register the lineage.'."\n" + ."\n" + .'```json'."\n" + .'{'."\n" + .' "SrcEntity": {'."\n" + .' "Id": "custom-report:report_001",'."\n" + .' "Name": "report_001"'."\n" + .' },'."\n" + .' "DstEntity": {'."\n" + .' "Id": "maxcompute-table:::demo_project:default:demo_table",'."\n" + .' "Name": "demo_table"'."\n" + .' },'."\n" + .' "Task": {'."\n" + .' "Id": "report_to_table_001",'."\n" + .' "Type": "custom-lineage-task",'."\n" + .' "Attributes": {'."\n" + .' "scene": "report_to_table"'."\n" + .' }'."\n" + .' }'."\n" + .'}'."\n" + .'```.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'CreateMcpServer' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'Period', - 'in' => 'formData', - 'schema' => [ - 'title' => '监控数据的统计周期。'."\n" - .'取值：60的倍数。'."\n" - .'单位：秒。', - 'description' => 'The statistical period for monitoring data.'."\n" - ."\n" - .'Value: A multiple of 60.'."\n" - ."\n" - .'Unit: Seconds.'."\n" - ."\n" - .'Default: 60.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '60', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => 'TBD', + 'abilityTreeNodes' => ['FEATUREdideYTM537'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ [ - 'name' => 'BeginTime', + 'name' => 'Name', 'in' => 'formData', - 'schema' => [ - 'title' => '开始时间。支持的格式：'."\n" - .'Unix 时间戳：从 1970 年 1 月 1 日开始所经过的毫秒数。'."\n" - .'BeginTime 和 EndTime 之间的间隔小于等于 31 天。', - 'description' => 'The start time.'."\n" - ."\n" - .'Supported format: Unix timestamp in milliseconds (the number of milliseconds that have elapsed since January 1, 1970).'."\n" - ."\n" - .'The interval between BeginTime and EndTime must be less than or equal to 31 days.'."\n" - ."\n" - .'Default: The current time minus 2 hours, expressed as a millisecond Unix timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'minimum' => '0', - 'example' => '1593950832000', - ], + 'schema' => ['description' => 'The name of the MCP Server. The name must be unique at the tenant level. It must start with a lowercase letter and contain only characters from `a-z`, `0-9`, `_`, and `-`.', 'type' => 'string', 'required' => true, 'example' => 'my-mcp-server', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'Config', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '结束时间。支持的格式：'."\n" - .'Unix 时间戳：从 1970 年 1 月 1 日开始所经过的毫秒数。'."\n" - .'BeginTime 和 EndTime 之间的间隔小于等于 31 天。', - 'description' => 'The end time.'."\n" - ."\n" - .'Supported format: Unix timestamp in milliseconds (the number of milliseconds that have elapsed since January 1, 1970).'."\n" - ."\n" - .'The interval between BeginTime and EndTime must be less than or equal to 31 days.'."\n" - ."\n" - .'Default: The current time, expressed as a millisecond Unix timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'type' => 'object', + 'properties' => [ + 'Url' => ['description' => 'The service address of the MCP Server. It must start with `https://`.', 'type' => 'string', 'required' => false, 'example' => 'https://example.com/mcp/sse', 'title' => ''], + 'Transport' => [ + 'description' => 'The transport protocol.', + 'type' => 'string', + 'enum' => ['STREAMABLE_HTTP', 'SSE'], + 'required' => false, + 'example' => 'SSE', + 'title' => '', + ], + 'CustomHeaders' => ['description' => 'The custom request headers, specified as key-value pairs. You cannot override reserved headers.', 'type' => 'object', 'required' => false, 'example' => '{}', 'title' => ''], + ], + 'description' => 'The connection configuration for the MCP Server.', 'required' => false, - 'minimum' => '0', - 'example' => '1750176000000', + 'example' => '-', + 'title' => '', ], ], [ - 'name' => 'NextToken', + 'name' => 'Visibility', 'in' => 'formData', 'schema' => [ - 'title' => '分页游标标识。'."\n" - .'说明：如果不设置该参数，则表示获取第一页的数据。当该参数有返回值时，说明还有下一页，您可以将返回的 NextToken 作为参数再次请求获得下一页的数据，直到返回为 Null 为止，表示获取到了所有的数据。', - 'description' => 'The pagination cursor.'."\n" - ."\n" - .'> If this parameter is not set, the first page of data is retrieved. If a value is returned for this parameter, it indicates that there is a next page. You can use the returned NextToken as a parameter to request the next page of data until it returns Null, which means all data has been retrieved.'."\n", + 'description' => 'The visibility level.', 'type' => 'string', 'required' => false, - 'example' => 'FFqBJBxE8I0PE0IUO6K69k7m2FfyWNNc2qQ9ReUkazhz9VA7dWZKlxBcjUwOV0imSM', + 'enum' => ['TENANT', 'PROJECT', 'USER'], + 'example' => 'TENANT', + 'title' => '', ], ], [ - 'name' => 'Length', + 'name' => 'VisibilityScope', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '每页显示的记录条数，用于分页查询。'."\n" - .'说明：单次请求 Length 的最大值为 1440。', - 'description' => 'The number of records to display on each page for paginated queries.'."\n" - ."\n" - .'> The maximum value of Length for a single request is 1440.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'type' => 'object', + 'properties' => [ + 'ProjectIds' => [ + 'type' => 'array', + 'items' => ['description' => 'The ID of a DataWorks workspace.', 'type' => 'string', 'required' => false, 'example' => '123456', 'title' => ''], + 'description' => 'The project IDs to which the MCP Server is visible. This parameter is required only when `Visibility` is set to `PROJECT`.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'UserIds' => [ + 'type' => 'array', + 'items' => ['description' => 'A user ID.', 'type' => 'string', 'required' => false, 'example' => '123456', 'title' => ''], + 'description' => 'The user IDs to which the MCP Server is visible. This parameter is required only when `Visibility` is set to `USER`.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The visibility scope. The required fields depend on the value of the `Visibility` parameter.', 'required' => false, - 'maximum' => '1440', - 'minimum' => '0', - 'example' => '100', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The returned result.'."\n", 'type' => 'object', 'properties' => [ - 'Success' => [ - 'title' => '是否请求成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - 'default' => 'true', - ], - 'MetricData' => [ - 'title' => '监控指标数据', - 'description' => 'Monitoring metric data.'."\n", + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'valueA'], + 'McpServer' => [ 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '资源组唯一标识', - 'description' => 'The unique identifier for the resource group.'."\n", - 'type' => 'string', - 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX'."\n", - ], - 'MetricName' => [ - 'title' => '指标名称', - 'description' => 'The metric name. Valid values:'."\n" - ."\n" - .'* CUSpec: Maximum CU capacity of the resource group, in CUs.'."\n" - .'* CUUsage: CU usage of the resource group, in CUs.'."\n" - .'* CUUtilization: CU utilization of the resource group, in %.'."\n" - .'* SlotSpec: Maximum number of concurrent slots for resource group scheduling, in slots.'."\n" - .'* SlotUsage: Used concurrency for resource group scheduling, in slots.'."\n" - .'* SchedulerCUMaxSpec: Maximum CU quota for data computing, in CUs.'."\n" - .'* SchedulerCUUsage: CU usage for data computing, in CUs.'."\n" - .'* SchedulerCUMinSpec: Minimum guaranteed CUs for data computing, in CUs.'."\n" - .'* DataIntegrationCUMaxSpec: Maximum CU quota for Data Integration, in CUs.'."\n" - .'* DataIntegrationCUUsage: CU usage for Data Integration, in CUs.'."\n" - .'* DataIntegrationCUMinSpec: Minimum guaranteed CUs for Data Integration, in CUs.'."\n" - .'* DataServiceCUMaxSpec: Maximum CU quota for DataService Studio, in CUs.'."\n" - .'* DataServiceCUUsage: CU usage for DataService Studio, in CUs.'."\n" - .'* DataServiceCUMinSpec: Minimum guaranteed CUs for DataService Studio, in CUs.'."\n" - .'* ServerIdeCUMaxSpec: Maximum CU quota for personal development environment, in CUs.'."\n" - .'* ServerIdeCUUsage: CU usage for personal development environment, in CUs.'."\n" - .'* ServerIdeCUMinSpec: Minimum guaranteed CUs for personal development environment, in CUs.'."\n", - 'type' => 'string', - 'example' => 'CUSpec', - ], - 'NextToken' => [ - 'title' => '分页游标标识', - 'description' => 'The pagination cursor.'."\n", - 'type' => 'string', - 'example' => 'tSBOXZcAmk+akxRkwRuXnGQEsIDODyd5ulPqgytNTbLp4bhb7fuvz13FXtm87Kfl', - ], - 'Metrics' => [ - 'title' => '指标数据列表', - 'description' => 'The list of metric data.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '指标数据', - 'description' => 'The metric data.'."\n", - 'type' => 'object', - 'properties' => [ - 'Value' => [ - 'title' => '指标数据值', - 'description' => 'The value of the metric data.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '1.0', - ], - 'Timestamp' => [ - 'title' => '时间戳', - 'description' => 'The timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1761184929633', - ], - ], - ], - ], + 'Name' => ['description' => 'The name of the MCP Server.', 'type' => 'string', 'example' => 'my-mcp-server', 'title' => ''], + 'GmtCreateTime' => ['description' => 'The time when the MCP Server was created.', 'type' => 'string', 'format' => 'iso8601', 'example' => '1780555634000', 'title' => ''], ], - ], - 'RequestId' => [ - 'title' => '请求的ID，用于定位日志，排查问题', - 'description' => 'The request ID, used for locating logs and troubleshooting.'."\n", - 'type' => 'string', - 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX'."\n", + 'description' => 'The created MCP Server.', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => 'Details of the created MCP Server.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateMcpServer', + 'summary' => 'Creates an MCP Server.', + 'description' => '## Usage notes'."\n" + ."\n" + .'- When you submit a request, the system verifies the availability of the MCP Server based on the connection configuration.'."\n" + ."\n" + .'- If the MCP Server connection is unavailable, the API returns an error message.'."\n" + ."\n" + .'- The `Name` must be unique at the tenant level, start with a lowercase letter, and contain only lowercase letters, digits, underscores (\\_), and hyphens (-).'."\n" + ."\n" + .'- The `Visibility` parameter specifies the visibility level of the MCP Server. Valid values are `TENANT` (visible within the tenant), `PROJECT` (visible to specified projects), and `USER` (visible to specified users). You must also provide the `VisibilityScope` parameter to define the scope based on the selected visibility level.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"MetricData\\": {\\n \\"Id\\": \\"Serverless_res_group_524257424564736_6831777003XXXXX\\\\n\\",\\n \\"MetricName\\": \\"CUSpec\\",\\n \\"NextToken\\": \\"tSBOXZcAmk+akxRkwRuXnGQEsIDODyd5ulPqgytNTbLp4bhb7fuvz13FXtm87Kfl\\",\\n \\"Metrics\\": [\\n {\\n \\"Value\\": 1,\\n \\"Timestamp\\": 1761184929633\\n }\\n ]\\n },\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\\\n\\"\\n}","type":"json"}]', - 'title' => 'ListResourceGroupMetricData', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"valueA\\",\\n \\"McpServer\\": {\\n \\"Name\\": \\"my-mcp-server\\",\\n \\"GmtCreateTime\\": \\"1780555634000\\"\\n }\\n}","type":"json"}]', ], - 'CreateRoute' => [ - 'summary' => 'Creates a route for a network.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateMetaCollection' => [ + 'summary' => 'Creates a collection in Data Map. Collections include categories, subcategories, data albums, and categories that are created in the data albums.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -9799,93 +8601,74 @@ 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '245176', - 'abilityTreeNodes' => [ - 'FEATUREdide2SV6DS', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '266523', + 'abilityTreeNodes' => ['FEATUREdideE9XYA6'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'NetworkId', - 'in' => 'formData', - 'schema' => [ - 'title' => '网络资源ID', - 'description' => 'The network ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1000', - ], + 'name' => 'ParentId', + 'in' => 'query', + 'schema' => ['description' => 'The parent collection ID.', 'type' => 'string', 'required' => false, 'example' => 'as78d756asd', 'title' => ''], ], [ - 'name' => 'DestinationCidr', - 'in' => 'formData', + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the collection.', 'type' => 'string', 'required' => true, 'example' => 'test_album', 'title' => ''], + ], + [ + 'name' => 'Type', + 'in' => 'query', 'schema' => [ - 'title' => '路由目的的CIDR', - 'description' => 'The CIDR blocks of the destination-based route.'."\n", + 'description' => 'The collection name.'."\n" + ."\n" + .'- Category'."\n" + ."\n" + .'- Album'."\n" + ."\n" + .'- AlbumCategory: Album subcategory.', + 'enumValueTitles' => [], 'type' => 'string', 'required' => true, - 'example' => '192.168.0.0/16', + 'enum' => ['Category', 'Album', 'AlbumCategory'], + 'example' => 'Category', + 'title' => '', ], ], [ - 'name' => 'ResourceGroupId', - 'in' => 'formData', - 'schema' => [ - 'title' => '所属通用资源组的唯一标识', - 'description' => 'Unique identifier of the serverless resource group.', - 'type' => 'string', - 'required' => false, - 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX', - ], + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The collection description.', 'type' => 'string', 'required' => false, 'example' => 'test comment', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'title' => '是否请求成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - 'default' => 'true', - ], - 'Id' => [ - 'title' => '创建的路由ID', - 'description' => 'The route ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - ], - 'RequestId' => [ - 'title' => '请求的ID，用于定位日志，排查问题', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'E6F0DBDD-5AD****'], + 'Id' => ['description' => 'The collection ID returned after a successful creation.', 'type' => 'string', 'example' => '4as3dasf654a', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Id\\": 1000,\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]', - 'title' => 'CreateRoute', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", - ], - 'DeleteRoute' => [ - 'summary' => 'Deletes a route from a network resource.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"Id\\": \\"4as3dasf654a\\"\\n}","type":"json"}]', + 'title' => 'CreateMetaCollection', + 'description' => '1. DataWorks Professional Edition or a higher edition is required.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'CreateMetaEntityDef' => [ + 'summary' => 'Creates a metadata entity definition. The definition can be for a pure custom type or an extended table type.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -9894,584 +8677,575 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'create', 'riskType' => 'none', - 'abilityTreeCode' => '245174', - 'abilityTreeNodes' => [ - 'FEATUREdide2SV6DS', - ], - 'tenantRelevance' => 'tenant', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdideX3KVYR'], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['description' => 'The type definition name. For a pure custom type, the name must match `^[a-z0-9][a-z0-9_]*$`. For an extended table type, the name must match `^[a-z0-9][a-z0-9_]*-table$`.', 'type' => 'string', 'required' => true, 'example' => 'biz_api', 'title' => ''], + ], + [ + 'name' => 'DisplayName', + 'in' => 'formData', + 'schema' => ['description' => 'The display name. The maximum length is 32 characters.', 'type' => 'string', 'required' => true, 'example' => 'Business API', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['description' => 'A description of the entity definition.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'description'], + ], + [ + 'name' => 'Extend', 'in' => 'formData', 'schema' => [ - 'title' => '网络资源的路由ID', - 'description' => 'The route ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1000', + 'description' => 'The extension mode. Valid values:'."\n" + ."\n" + .'- `NONE`: The default value. Specifies a pure custom type with user-defined attributes.'."\n" + ."\n" + .'- `TABLE`: Specifies an extended table type that references an existing table type in Data Map. Attribute definitions are not required for this type. You can create corresponding `Database` and `Table` objects for it.', + 'type' => 'string', + 'example' => 'NONE', + 'enum' => ['NONE', 'TABLE'], + 'title' => '', + 'required' => false, + ], + ], + [ + 'name' => 'AttributeDefs', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'type' => 'array', + 'items' => ['description' => 'An object that defines a single attribute for the entity.', '$ref' => '#/components/schemas/MetaEntityAttributeDef', 'required' => false, 'title' => '', 'example' => ''], + 'maxItems' => 100, + 'title' => '', + 'description' => 'A list of attribute definitions for the pure custom type. Do not specify this parameter if the `Extend` parameter is set to `TABLE`.', + 'required' => false, + 'example' => '[]', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Success' => [ - 'title' => '是否请求成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - 'default' => 'true', - ], - 'RequestId' => [ - 'title' => '请求的ID，用于定位日志，排查问题', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '0A04C673-BEFA-5803-94E5-89E2D9F8C567'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'EntityType' => ['description' => 'The unique identifier of the created entity type.', 'type' => 'string', 'title' => '', 'example' => 'custom_entity-biz_api'], ], + 'title' => '', + 'description' => 'The data returned.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateMetaEntityDef', + 'description' => 'This operation requires DataWorks Professional Edition or a higher edition.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065****\\"\\n}","type":"json"}]', - 'title' => 'DeleteRoute', - 'description' => 'This API operation is available for all DataWorks editions.', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0A04C673-BEFA-5803-94E5-89E2D9F8C567\\",\\n \\"Success\\": true,\\n \\"EntityType\\": \\"custom_entity-biz_api\\"\\n}","type":"json"}]', ], - 'UpdateRoute' => [ - 'summary' => 'Updates the information about a route.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateNetwork' => [ + 'summary' => 'Creates a network and associates the network with a general resource group.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '245175', - 'abilityTreeNodes' => [ - 'FEATUREdide2SV6DS', - ], + 'abilityTreeCode' => '245180', + 'abilityTreeNodes' => ['FEATUREdide2SV6DS'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'ResourceGroupId', 'in' => 'formData', - 'schema' => [ - 'title' => '网络资源的路由ID', - 'description' => 'The route ID of the network resource.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1000', - ], + 'schema' => ['description' => 'The ID of the serverless resource group.', 'type' => 'string', 'required' => true, 'example' => 'Serverless_res_group_524257424564736_6831777003****', 'title' => ''], ], [ - 'name' => 'DestinationCidr', + 'name' => 'VpcId', 'in' => 'formData', - 'schema' => [ - 'title' => '更新的路由目的的CIDR', - 'description' => 'The destination CIDR block of the route that you want to update.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '192.168.0.0/16', - 'enum' => [], - ], + 'schema' => ['description' => 'The ID of the virtual private cloud (VPC).', 'type' => 'string', 'required' => true, 'example' => 'vpc-m2et4f3oc8msfbccXXXXX', 'title' => ''], + ], + [ + 'name' => 'VswitchId', + 'in' => 'formData', + 'schema' => ['description' => 'The VSwitch ID.', 'type' => 'string', 'required' => true, 'example' => 'vsw-uf8usrhs7hjd9amsXXXXX', 'title' => ''], + ], + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => ['description' => 'The client token that is used to ensure the idempotence of the request.', 'type' => 'string', 'required' => true, 'example' => 'eb870033-74c8-4b1b-9664-04c4e7cc3465', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'title' => '是否请求成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - 'default' => 'true', - ], - 'RequestId' => [ - 'title' => '请求的ID，用于定位日志，排查问题', - 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', - ], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'example' => 'true'], + 'Id' => ['description' => 'The network ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065****\\"\\n}","type":"json"}]', - 'title' => 'UpdateRoute', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Id\\": 1000,\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]', + 'title' => 'CreateNetwork', 'description' => 'This API operation is available for all DataWorks editions.', - ], - 'GetRoute' => [ - 'summary' => 'Queries the information about a route based on its ID.', - 'methods' => [ - 'get', + 'changeSet' => [ + ['createdAt' => '2024-12-19T08:49:55.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataworks:CreateNetwork', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateNode' => [ + 'summary' => 'Creates a node in DataStudio. The information about the node is described by using FlowSpec.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '245172', - 'abilityTreeNodes' => [ - 'FEATUREdide2SV6DS', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '236773', + 'abilityTreeNodes' => ['FEATUREdideHO4TQP', 'FEATUREdide8FM783', 'FEATUREdideQUQUVB', 'FEATUREdideIQU97M'], ], 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'query', + '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" + ."\n" + .'You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456', 'title' => ''], + ], + [ + 'name' => 'ContainerId', + 'in' => 'formData', + 'schema' => ['description' => 'Specify this parameter if you want to create the node inside a container. This parameter represents the unique identifier of the container, which can be a workflow or a container node.'."\n" + ."\n" + .'> If this parameter is specified, the path field defined in FlowSpec is ignored.'."\n" + ."\n" + .'> Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.', 'type' => 'string', 'required' => false, 'example' => '23451286945488XXXX'."\n", 'title' => ''], + ], + [ + 'name' => 'Scene', + 'in' => 'formData', 'schema' => [ - 'title' => '路由ID', - 'description' => 'The route ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'Specify this parameter if you want to create the node inside a container. This parameter represents the unique identifier of the container, which can be a workflow or a container node.'."\n" + ."\n" + .'> If this parameter is specified, the path field defined in FlowSpec is ignored.'."\n" + ."\n" + .'> Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.', + 'enumValueTitles' => [], + 'type' => 'string', 'required' => true, - 'example' => '1000', + 'example' => 'DATAWORKS_PROJECT', + 'title' => '', ], ], + [ + 'name' => 'Spec', + 'in' => 'formData', + 'schema' => ['description' => 'The FlowSpec information that describes the node. For more information, see [FlowSpec](https://github.com/aliyun/alibabacloud-dataworks-tool-dflow).'."\n" + ."\n" + .'> How do I quickly obtain a FlowSpec template?'."\n" + ."\n" + .'- Go to Data Studio, open a node, click Version on the right side, find the latest version, and then click Scheduling Settings to obtain the FlowSpec description of the current node. You can use the FlowSpec description in the version to quickly build a template that meets your requirements.'."\n" + ."\n" + .'> How do I configure the node content?'."\n" + ."\n" + .'- Enter the code for the node in the $.spec.nodes\\[].script.content field.'."\n" + ."\n" + .'> How do I configure a batch synchronization node?'."\n" + ."\n" + .'- Write the script by referring to Step 4 in [Configure an offline sync task in the code editor](https://help.aliyun.com/zh/dataworks/user-guide/configure-a-batch-synchronization-node-by-using-the-code-editor), and then enter the script content in the $.spec.nodes\\[\\*].script.content field. Alternatively, you can create a batch synchronization node in the console and view its version information to obtain the script content.', 'type' => 'string', 'required' => true, 'example' => '{'."\n" + .' "version": "1.1.0",'."\n" + .' "kind": "Node",'."\n" + .' "spec": {'."\n" + .' "nodes": ['."\n" + .' {'."\n" + .' "recurrence": "Normal",'."\n" + .' "timeout": 0,'."\n" + .' "instanceMode": "T+1",'."\n" + .' "rerunMode": "Allowed",'."\n" + .' "rerunTimes": 3,'."\n" + .' "rerunInterval": 180000,'."\n" + .' "datasource": {'."\n" + .' "name": "odps_test"'."\n" + .' },'."\n" + .' "script": {'."\n" + .' "path": "XX/OpenAPI_Test/odpsSQL_Test",'."\n" + .' "runtime": {'."\n" + .' "command": "ODPS_SQL"'."\n" + .' },'."\n" + .' "content": "select now();"'."\n" + .' },'."\n" + .' "trigger": {'."\n" + .' "type": "Scheduler",'."\n" + .' "cron": "00 00 00 * * ?",'."\n" + .' "startTime": "1970-01-01 00:00:00",'."\n" + .' "endTime": "9999-01-01 00:00:00",'."\n" + .' "timezone": "Asia/Shanghai",'."\n" + .' "delaySeconds": 0'."\n" + .' },'."\n" + .' "runtimeResource": {'."\n" + .' "resourceGroup": "S_res_group_XXXX_XXXX"'."\n" + .' },'."\n" + .' "name": "odpsSQL_Test",'."\n" + .' "inputs": {'."\n" + .' "nodeOutputs": ['."\n" + .' {'."\n" + .' "data": "project_root",'."\n" + .' "artifactType": "NodeOutput"'."\n" + .' }'."\n" + .' ]'."\n" + .' },'."\n" + .' "outputs": {'."\n" + .' "nodeOutputs": ['."\n" + .' {'."\n" + .' "data": "output_data",'."\n" + .' "artifactType": "NodeOutput",'."\n" + .' "refTableName": "odpsSQL_Test"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .'}', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'title' => '是否请求成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - 'default' => 'true', - ], - 'Route' => [ - 'title' => '路由详细信息', - 'description' => 'The information about the route.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '路由ID', - 'description' => 'The route ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - ], - 'ResourceGroupId' => [ - 'title' => '所属资源组唯一标识', - 'description' => 'The resource group ID.'."\n", - 'type' => 'string', - 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX', - ], - 'ResourceId' => [ - 'title' => '所属网络资源唯一标识', - 'description' => 'The network resource ID.'."\n", - 'type' => 'string', - 'example' => 'ns-679XXXXX', - ], - 'DestinationCidr' => [ - 'title' => '目的路由CIDR', - 'description' => 'The CIDR block of the destination-based route.'."\n", - 'type' => 'string', - 'example' => '192.168.0.0/16', - ], - 'CreateTime' => [ - 'title' => '创建时间，为64位时间戳', - 'description' => 'The time when the route was created. The value is a 64-bit timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1727055811000', - ], - 'NetworkId' => [ - 'title' => '所属网络资源ID', - 'description' => 'The network ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - ], - ], - ], - 'RequestId' => [ - 'title' => '请求的ID，用于定位日志，排查问题', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'AFBB799F-8578-51C5-A766-E922EDB8XXXX'], + 'Id' => ['description' => 'The unique identifier of the Data Studio node.'."\n" + ."\n" + .'> This field is of the Long type in SDK versions prior to 8.0.0, and of the String type in SDK versions 8.0.0 and later. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.', 'type' => 'string', 'example' => '860438872620113XXXX', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Route\\": {\\n \\"Id\\": 1000,\\n \\"ResourceGroupId\\": \\"Serverless_res_group_524257424564736_6831777****\\",\\n \\"ResourceId\\": \\"ns-679XXXXX\\",\\n \\"DestinationCidr\\": \\"192.168.0.0/16\\",\\n \\"CreateTime\\": 1727055811000,\\n \\"NetworkId\\": 1000\\n },\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]', - 'title' => 'GetRoute', - 'description' => 'This API operation is available for all DataWorks editions.', - ], - 'ListRoutes' => [ - 'summary' => 'Queries a list of routes of a network resource.', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AFBB799F-8578-51C5-A766-E922EDB8XXXX\\",\\n \\"Id\\": \\"860438872620113XXXX\\"\\n}","type":"json"}]', + 'title' => 'CreateNode', + 'description' => '>'."\n" + ."\n" + .'This API does not support batch operations. If you define more than one node in the FlowSpec, all nodes except the first one are ignored.'."\n" + ."\n" + .'>', + 'changeSet' => [ + ['createdAt' => '2025-01-13T07:48:25.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-01-13T07:36:02.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'CreateParameter' => [ + 'summary' => 'Creates a parameter.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '245173', - 'abilityTreeNodes' => [ - 'FEATUREdide2SV6DS', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB'], + 'autoTest' => true, ], 'parameters' => [ [ - 'name' => 'ResourceGroupId', - 'in' => 'query', + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['description' => 'The parameter name. It must be unique within the workspace, be prefixed with `workspace.`, and not exceed 255 characters. The part of the name after the prefix must start with a letter and can contain only letters, digits, and underscores (\\_).', 'type' => 'string', 'required' => true, 'example' => 'workspace.para', 'title' => ''], + ], + [ + 'name' => 'Properties', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '通用资源组唯一标识', - 'description' => 'The ID of the resource group.'."\n", - 'type' => 'string', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EnvType' => [ + 'description' => 'The environment.'."\n" + ."\n" + .'- `Prod`: production environment'."\n" + ."\n" + .'- `Dev`: development environment', + 'type' => 'string', + 'example' => 'Prod', + 'enum' => ['Prod', 'Dev'], + 'required' => false, + 'title' => '', + ], + 'Value' => ['description' => 'The value of the parameter. The value can contain Chinese characters, letters, digits, and the following special characters: /, :, ., \\[, ], ,, \\, \', ", \\_, =, ?, space, carriage return, line feed, +, -, \\*, %, &, @, !, $, #, {, and }.', 'type' => 'string', 'example' => 'value123', 'required' => false, 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => true, - 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX', + 'description' => 'The value configurations for the parameter. A configuration for the production environment is required. If you provide duplicate configurations for an environment, only the first one is used.', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'NetworkId', - 'in' => 'query', + 'name' => 'Type', + 'in' => 'formData', 'schema' => [ - 'title' => '网络资源ID', - 'description' => 'The network ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1000', + 'description' => 'The type of the parameter.'."\n" + ."\n" + .'- `PlainConstant`: plaintext constant.'."\n" + ."\n" + .'- `SecretConstant`: secret constant.'."\n" + ."\n" + .'- `Variable`: variable.', + 'type' => 'string', + 'required' => true, + 'example' => 'PlainConstant', + 'enum' => ['PlainConstant', 'SecretConstant', 'Variable'], + 'title' => '', ], ], [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '分页大小', - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '100', - 'default' => '100', - ], + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The workspace ID. This parameter is required when `Scope` is set to `Project`.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1000', 'title' => ''], ], [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'title' => '分页页码', - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - 'default' => '1', - ], + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => ['description' => 'The account ID of the owner.', 'type' => 'string', 'required' => true, 'example' => '123456789', 'title' => ''], ], [ - 'name' => 'SortBy', - 'in' => 'query', + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['description' => 'The description of the parameter.', 'type' => 'string', 'example' => 'This is a test parameter.', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'Scope', + 'in' => 'formData', 'schema' => [ - 'title' => '排序字段列表，支持定时时间、开始时间等字段。格式为"排序字段+排序方式(Desc/Asc)"（Asc可以缺省）。排序字段的枚举值如下：'."\n" - .'● Id (Desc/Asc)：路由ID'."\n" - .'● DestinationCidr (Desc/Asc)：目的CIDR'."\n" - .'● CreateTime (Desc/Asc)：创建时间'."\n" - .'默认为CreateTime Asc'."\n", - 'description' => 'The fields used for sorting. Fields such as TriggerTime and StartedTime are supported. The value of this parameter is in the Sort field + Sort by (Desc/Asc) format. By default, results are sorted in ascending order. Valid values:'."\n" - ."\n" - .'* Id (Desc/Asc): the route ID'."\n" - .'* DestinationCidr (Desc/Asc): the destination CIDR block of the route'."\n" - .'* CreateTime (Desc/Asc): the time when the route is created'."\n" - ."\n" - .'Default value: CreateTime Asc.'."\n", + 'description' => 'The scope of the parameter. The default value is `Project`. No other values are currently supported.', 'type' => 'string', 'required' => false, - 'example' => 'CreateTime Asc', - 'default' => 'CreateTime Asc', + 'example' => 'Project', + 'default' => 'Project', + 'enum' => ['Project'], + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'Success' => [ - 'title' => '是否请求成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - 'default' => 'true', - ], - 'PagingInfo' => [ - 'title' => '分页列表', - 'description' => 'The pagination information.'."\n", - 'type' => 'object', - 'properties' => [ - 'RouteList' => [ - 'title' => '获取到的网络资源路由信息列表', - 'description' => 'The list of network resource routing information obtained.', - 'type' => 'array', - 'items' => [ - 'title' => '路由详细信息', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '路由ID', - 'description' => 'Route ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - ], - 'ResourceGroupId' => [ - 'title' => '所属资源组唯一标识符', - 'description' => 'Unique identifier of the resource group to which it belongs', - 'type' => 'string', - 'example' => 'Serverless_res_group_524257424564736_6831777003****', - ], - 'ResourceId' => [ - 'title' => '网络资源唯一标识符', - 'description' => 'Unique identifier of network resource', - 'type' => 'string', - 'example' => 'ns-679XXXXXX', - ], - 'DestinationCidr' => [ - 'title' => '路由目的CIDR', - 'description' => 'Route destination CIDR', - 'type' => 'string', - 'example' => '192.168.0.0/16', - ], - 'CreateTime' => [ - 'title' => '创建时间，为64位时间戳', - 'description' => 'The creation time, which is a 64-bit timestamp.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1727055811000', - ], - 'NetworkId' => [ - 'title' => '所属网络资源ID', - 'description' => 'Network Resource ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - ], - ], - ], - ], - 'PageNumber' => [ - 'title' => '分页页码', - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'default' => '1', - ], - 'PageSize' => [ - 'title' => '分页大小', - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - 'default' => '100', - ], - 'TotalCount' => [ - 'title' => '全部数据条目', - 'description' => 'All data entries', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - ], - ], - 'RequestId' => [ - 'title' => '请求的ID，用于定位日志，排查问题', - 'description' => 'The ID of the request. It is used to locate logs and troubleshoot problems.', - 'type' => 'string', - 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', - ], + 'Id' => ['description' => 'The parameter ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', 'title' => ''], ], + 'title' => '', + 'description' => 'Response schema', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateParameter', + 'description' => 'This operation requires DataWorks Professional Edition or a later edition.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"PagingInfo\\": {\\n \\"RouteList\\": [\\n {\\n \\"Id\\": 1000,\\n \\"ResourceGroupId\\": \\"Serverless_res_group_524257424564736_6831777003****\\",\\n \\"ResourceId\\": \\"ns-679XXXXXX\\",\\n \\"DestinationCidr\\": \\"192.168.0.0/16\\",\\n \\"CreateTime\\": 1727055811000,\\n \\"NetworkId\\": 1000\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 100\\n },\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]', - 'title' => 'ListRoutes', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Id\\": 123,\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]', + 'translator' => 'manual', ], - 'CreateNetwork' => [ - 'summary' => 'Creates a network and associates the network with a general resource group.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreatePipelineRun' => [ + 'summary' => 'Creates a publish process for an entity in the new-version DataStudio.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '245180', - 'abilityTreeNodes' => [ - 'FEATUREdide2SV6DS', - ], + 'abilityTreeCode' => '267910', + 'abilityTreeNodes' => ['FEATUREdide4AR6E0'], + 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'ResourceGroupId', + 'name' => 'ProjectId', 'in' => 'formData', - 'schema' => [ - 'title' => '所属通用资源组的唯一标识', - 'description' => 'The ID of the serverless resource group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX', - ], + 'schema' => ['title' => '', '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 configuration page to obtain the workspace ID.'."\n" + .'This parameter specifies the DataWorks workspace for this API call.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'pattern' => '', 'default' => '', 'example' => '10000'], ], [ - 'name' => 'VpcId', + 'name' => 'Type', 'in' => 'formData', - 'schema' => [ - 'title' => '网络资源的VPC ID', - 'description' => 'The ID of the virtual private cloud (VPC).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'vpc-m2et4f3oc8msfbccXXXXX', - ], + 'schema' => ['description' => 'Specifies whether the publish process is used to bring an entity online or offline.'."\n" + ."\n" + .'- Online: online'."\n" + ."\n" + .'- Offline: offline', 'type' => 'string', 'required' => true, 'example' => 'Online', 'title' => ''], ], [ - 'name' => 'VswitchId', + 'name' => 'ObjectIds', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '网络资源的交换机ID', - 'description' => 'The VSwitch ID.'."\n", - 'type' => 'string', + 'description' => 'The list of entity IDs that you want to publish in this publish process.'."\n" + .'>Only a single entity and its child entities can be published at a time. Only the first entity in this array and its child entities are published. Make sure that the length of this array is 1. Entities beyond the first one are ignored.>', + 'type' => 'array', + 'items' => ['description' => 'The ID of the entity that you want to publish, such as the ID of a Node or WorkflowDefinition entity.'."\n" + .'>A WorkflowDefinition can only be published as a whole. Publishing a single node within a workflow is not supported.>', 'type' => 'string', 'required' => false, 'example' => '476506242076571XXXX', 'title' => ''], 'required' => true, - 'example' => 'vsw-uf8usrhs7hjd9amsXXXXX', + 'maxItems' => 10, + 'minItems' => 1, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ClientToken', + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['description' => 'The description of the publish process.', 'type' => 'string', 'required' => false, 'example' => 'This is a OdpsSQL-node publishing process. The function is XXXX.', 'title' => ''], + ], + [ + 'name' => 'RunMode', 'in' => 'formData', 'schema' => [ - 'title' => '客户端幂等性标识，用于保证创建网络资源操作的幂等性', - 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n", + 'description' => 'The run mode of the publish process. Default value: Normal. If you set this parameter to Auto, the publish process is automatically driven to the specified stage. This parameter is used together with the AutoRunUntilStage parameter.'."\n" + ."\n" + .'Valid values:'."\n" + .'- Normal'."\n" + .'- Auto', 'type' => 'string', - 'required' => true, - 'example' => 'eb870033-74c8-4b1b-9664-04c4e7cc3465', + 'enum' => ['Normal', 'Auto'], + 'required' => false, + 'example' => 'Normal', + 'title' => '', ], ], + [ + 'name' => 'AutoRunUntilStage', + 'in' => 'formData', + 'schema' => ['description' => 'The code of the stage in the publish process. This parameter takes effect only when RunMode is set to Auto. After the publish process is created, it automatically runs to the specified stage.'."\n" + ."\n" + .'>The specified stage is automatically completed. For example, if you set this parameter to DEV, the automatic run stops after the DEV stage reaches the desired state.>', 'type' => 'string', 'required' => false, 'example' => 'DEV', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'title' => '是否请求成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - 'default' => 'true', - ], - 'Id' => [ - 'title' => '创建的网络资源ID', - 'description' => 'The network ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - ], - 'RequestId' => [ - 'title' => '请求的ID，用于定位日志，排查问题', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID. You can use the ID to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => '7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX'], + 'Id' => ['description' => 'The unique identifier of the publish process.', 'type' => 'string', 'example' => 'a7ef0634-20ec-4a7c-a214-54020f91XXXX'."\n", 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Id\\": 1000,\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]', - 'title' => 'CreateNetwork', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", - ], - 'DeleteNetwork' => [ - 'summary' => 'Disassociates and deletes a network from a general resource group.', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX\\",\\n \\"Id\\": \\"a7ef0634-20ec-4a7c-a214-54020f91XXXX\\\\n\\"\\n}","type":"json"}]', + 'title' => 'Create a publish process', + 'description' => '>This operation does not support batch operations. If you specify multiple publish entities in the parameters, all entities except the first one are ignored.>'."\n" + .'>This operation may not be available in earlier versions of the SDK. In this case, use the CreateDeployment operation. The parameters are the same as those described in this topic.>', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateProcessDefinition' => [ + 'summary' => 'Creates a new approval process definition, supporting custom configuration of approval rules and notification services.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -10480,282 +9254,399 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '245179', - 'abilityTreeNodes' => [ - 'FEATUREdide2SV6DS', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '243667', + 'abilityTreeNodes' => ['FEATUREdideYTM537'], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the process definition.'."\n", 'type' => 'string', 'required' => true, 'example' => '我的审批策略', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['description' => 'The description of the process definition.'."\n", 'type' => 'string', 'required' => true, 'example' => '这是一个示例策略', 'title' => ''], + ], + [ + 'name' => 'Type', + 'in' => 'formData', + 'schema' => ['description' => 'The type of the process definition. Valid values:'."\n" + ."\n" + .'1. MaxCompute'."\n" + .'2. DataService'."\n" + .'3. Extension'."\n" + .'4. Hologres', 'type' => 'string', 'required' => false, 'default' => 'MaxCompute', 'example' => 'Extension', 'title' => ''], + ], + [ + 'name' => 'SubType', + 'in' => 'formData', + 'schema' => ['description' => 'The subtype. Valid values:'."\n" + ."\n" + .'- Table'."\n" + .'- Column'."\n" + .'- Database'."\n" + .'- Schema'."\n" + .'- Default', 'type' => 'string', 'required' => false, 'default' => 'Table', 'example' => 'Table', 'title' => ''], + ], + [ + 'name' => 'Enabled', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to enable the process definition.'."\n", 'type' => 'boolean', 'default' => 'true', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'RuleConditions', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The list of condition rules.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The rule.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The condition type. Valid values:'."\n" + ."\n" + .'- `odpsProject`'."\n" + .'- `hologresInstanceId`'."\n" + .'- `sensibleLevel`'."\n" + .'- `tableGuid`'."\n" + .'- `projectId`', 'type' => 'string', 'required' => false, 'example' => 'odpsProject', 'title' => ''], + 'Scope' => ['description' => 'The stage at which the rule takes effect:'."\n" + .'- `Deployment`: used to determine whether the approval policy matches when a request is submitted.'."\n" + .'- `Running`: used to determine whether approval is exempted during the execution of the approval process. This value is supported only for the MaxCompute type.', 'type' => 'string', 'required' => false, 'example' => 'Deployment', 'title' => ''], + 'Expression' => ['description' => 'The condition expression in the format of ((#type==\'typeValue\')). Example: ((#odpsProject==\'PX_BEIJING_TEST\')).', 'type' => 'string', 'required' => false, 'example' => '((#odpsProject==\'PX_BEIJING_TEST\'))', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'minItems' => 1, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'NotificationServices', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The notification service declarations.', + 'type' => 'array', + 'items' => [ + 'description' => 'The notification service declaration.', + 'type' => 'object', + 'properties' => [ + 'Channel' => ['description' => 'The notification channel. Valid values:'."\n" + ."\n" + .'- Mail'."\n" + .'- Sms'."\n" + .'- DingRobot'."\n" + .'- Weixin', 'type' => 'string', 'required' => false, 'example' => 'DingRobot', 'title' => ''], + 'Extension' => ['description' => 'The extension information in JSON format. Example: `{"atAll":"true"}`, which specifies whether to mention all members.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"atAll":"true"}', 'title' => ''], + 'Receiver' => ['description' => 'The WebhookUrl that must be specified when Channel is set to DingRobot or Weixin.'."\n", 'type' => 'string', 'required' => false, 'example' => 'https://dingtalk.com', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'minItems' => 1, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'ApprovalNodes', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '删除的网络资源ID', - 'description' => 'The ID of the network that you want to delete.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The list of approval nodes.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The node.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the node.'."\n", 'type' => 'string', 'required' => false, 'example' => 'default-name', 'title' => ''], + 'AccountType' => ['description' => 'The type of approver for the node:'."\n" + .'- DataWorksProjectRole: workspace role.'."\n" + .'- DataWorksProjectMember: workspace member.'."\n" + .'- TableAdministrator: table owner.'."\n" + .'- TableOrProjectAdministrator: table or workspace administrator.'."\n" + .'- AliyunResourceOwner: Alibaba Cloud account.'."\n" + .'- MaxComputeRole: MaxCompute administrator.'."\n" + .'- DLFAdmin: DLF Legacy administrator.'."\n" + .'- DLFNextAdmin: DLF Next administrator.'."\n" + .'- TenantRole: tenant role.'."\n" + .'- EmrAdministrator: EMR administrator.'."\n" + .'- LindormAdministrator: Lindorm administrator.'."\n" + .'- AliyunRamUser: RAM user.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TableOrProjectAdministrator', 'title' => ''], + 'Assignees' => [ + 'description' => 'The semantics of this parameter varies based on the value of `AccountType`:'."\n" + .'- DataWorksProjectMember: the user ID of the workspace member.'."\n" + .'- DataWorksProjectRole: the code of the workspace role. If a custom workspace role is required, set this parameter to "custom-role" and further configure the role in ExtensionProperties.'."\n" + .'- MaxComputeRole: the MaxCompute role.'."\n" + .'- TenantRole: the code of the tenant role.'."\n" + .'- AliyunRamUser: the RAM user ID.', + 'type' => 'array', + 'items' => ['description' => 'The approver.', 'type' => 'string', 'required' => false, 'example' => '213463068144525171', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'ExtensionProperties' => [ + 'description' => 'The additional declarations required based on the value of `AccountType`:'."\n" + ."\n" + .'- DataWorksProjectMember: specify different workspace member user IDs. The key is the workspace ID, and the value is the user ID of the workspace member. Separate multiple user IDs with commas (,).'."\n" + ."\n" + .'- DataWorksProjectRole: specify different custom workspace role codes. The key is the workspace ID, and the value is the custom workspace role code. Separate multiple role codes with commas (,).'."\n" + ."\n" + .'- MaxComputeRole: specify the roles under a MaxCompute project. The key is the MaxCompute project name, and the value is the role name in MaxCompute. Separate multiple role names with commas (,).', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['description' => 'The extension description.', 'type' => 'any', 'example' => '{'."\n" + .' "449656": "role_project_admin,role_project_pe"'."\n" + .' }', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => true, - 'example' => '1000', + 'minItems' => 1, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => ['description' => 'The idempotency token. We recommend that you use a UUID.', 'type' => 'string', 'required' => false, 'example' => '0000-ABCD-EFG****', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'title' => '是否请求成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - 'default' => 'true', - ], - 'RequestId' => [ - 'title' => '请求的ID，用于定位日志，排查问题', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0bc5df3a17***903790e8e8a'], + 'Id' => ['description' => 'The ID of the process definition.', 'type' => 'string', 'example' => '1010543619', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateApprovalProcessDefinition', + 'description' => '## Usage notes'."\n" + .'- This API operation allows you to create a new approval process definition, including setting basic information such as the approval policy name, description, type, and subtype.'."\n" + .'- You can define a list of condition rules (RuleConditions) to specify the conditions under which the approval process is triggered.'."\n" + .'- Multiple notification services (NotificationServices) can be configured to send notifications to relevant personnel at different stages of the approval process.'."\n" + .'- The approval node list (ApprovalNodes) defines the nodes that must be traversed during the approval process and the approver information for each node.'."\n" + .'- You can choose whether to immediately enable the newly created approval process definition.'."\n" + .'- Note: Certain fields such as Type have specific value constraints. Refer to the constraint descriptions in the documentation.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065****\\"\\n}","type":"json"}]', - 'title' => 'DeleteNetwork', - 'description' => 'This API operation is available for all DataWorks editions.', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc5df3a17***903790e8e8a\\",\\n \\"Id\\": \\"1010543619\\"\\n}","type":"json"}]', ], - 'GetNetwork' => [ - 'summary' => 'Queries the information about a network resource.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'CreateProject' => [ + 'summary' => 'Creates a workspace.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '245177', - 'abilityTreeNodes' => [ - 'FEATUREdide2SV6DS', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '243667', + 'abilityTreeNodes' => ['FEATUREdideYTM537'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'query', + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the workspace.'."\n" + ."\n" + .'Limits:'."\n" + ."\n" + .'- The workspace name must be unqiue in a region.'."\n" + ."\n" + .'- The workspace name can contain letters, digits, and underscores (\\_), and must start with a letter.'."\n" + ."\n" + .'- The workspace name must be 3 to 28 characters in length.', 'type' => 'string', 'required' => true, 'example' => 'sora_finance', 'title' => ''], + ], + [ + 'name' => 'DisplayName', + 'in' => 'formData', + 'schema' => ['description' => 'The display name of the workspace.', 'type' => 'string', 'required' => true, 'example' => 'Sora financial analysis', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['description' => 'The description of the workspace.', 'type' => 'string', 'required' => false, 'example' => 'Financial analysis group project data development', 'title' => ''], + ], + [ + 'name' => 'AliyunResourceGroupId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the Alibaba Cloud resource group to which the workspace belongs. You can log on to the [Resource Management console](https://resourcemanager.console.aliyun.com/resource-groups) and go to the Resource Group page to query the ID.'."\n" + ."\n" + .'You must configure this parameter to specify an Alibaba Cloud resource group for the workspace that you want to create.', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmzbn7****', 'title' => ''], + ], + [ + 'name' => 'PaiTaskEnabled', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to enable scheduling of Platform for AI (PAI) tasks. Valid values:'."\n" + ."\n" + .'- true: enables scheduling of PAI tasks. In this case, you can create a PAI node in a DataWorks workspace and configure scheduling properties for the node to implement periodic scheduling of PAI tasks.'."\n" + ."\n" + .'- false: disables scheduling of PAI tasks.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'DevEnvironmentEnabled', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to enable the development environment. Valid values:'."\n" + ."\n" + .'- true : enables the development environment. In this case, the development environment is isolated from the production environment in the workspace.'."\n" + ."\n" + .'- false: disables the development environment. In this case, only the production environment is used in the workspace.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'AliyunResourceTags', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '网络资源ID', - 'description' => 'The network ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1000', + 'description' => 'The tags.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'batch', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'blue', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'DevRoleDisabled', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to disable the Develop role. Valid values:'."\n" + ."\n" + .'- false (default)'."\n" + ."\n" + .'- true', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'title' => '是否请求成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - 'default' => 'true', - ], - 'Network' => [ - 'title' => '获取到的网络资源详细信息', - 'description' => 'The information about the network resource.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '网络资源ID', - 'description' => 'The network ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - ], - 'ResourceGroupId' => [ - 'title' => '所属通用资源组的唯一标识', - 'description' => 'The ID of the serverless resource group.'."\n", - 'type' => 'string', - 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX', - ], - 'VpcId' => [ - 'title' => '网络资源的VPC ID', - 'description' => 'The ID of the virtual private cloud (VPC).'."\n", - 'type' => 'string', - 'example' => 'vpc-m2et4f3oc8msfbccXXXXX', - ], - 'VswitchId' => [ - 'title' => '网络资源的交换机ID', - 'description' => 'The VSwitch ID.'."\n", - 'type' => 'string', - 'example' => 'vsw-uf8usrhs7hjd9amsXXXXX', - ], - 'SecurityGroupId' => [ - 'title' => '网络资源的安全组ID', - 'description' => 'The security group ID.'."\n", - 'type' => 'string', - 'example' => 'sg-2ze13vamugr7jenXXXXX', - ], - 'Status' => [ - 'title' => '当前网络资源状态，Pending代表等待，Creating代表创建中，Running代表正常运行中，Deleting代表删除中，Deleted代表已删除', - 'description' => 'The status of the network resource. Valid values:'."\n" - ."\n" - .'* Pending: The network resource is waiting to be created.'."\n" - .'* Creating: The network resource is being created.'."\n" - .'* Running: The network resource is running as expected.'."\n" - .'* Deleting: The network resource is being deleted.'."\n" - .'* Deleted: The network resource is deleted.'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Running', - 'enum' => [ - 'Pending', - 'Running', - 'Deleting', - 'Deleted', - 'Creating', - ], - ], - 'CreateUser' => [ - 'title' => '创建该网络资源的用户ID', - 'description' => 'The ID of the user who creates the network resource.'."\n", - 'type' => 'string', - 'example' => '11075500042XXXXX', - ], - 'CreateTime' => [ - 'title' => '创建时间，为64位时间戳', - 'description' => 'The time when the network resource was created. The value is a 64-bit timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1727055811000', - ], - ], - ], - 'RequestId' => [ - 'title' => '请求的ID，用于定位日志，排查问题', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'AFBB799F-8578-51C5-A766-E922EDB8XXXX'."\n"], + 'ProjectId' => ['title' => 'project Id', 'description' => 'The workspace ID. Note: This parameter is deprecated and is replaced by the Id parameter.', 'type' => 'integer', 'format' => 'int64', 'deprecated' => true, 'example' => '123456'], + 'Id' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'asynchronous', 'callback' => 'dataworks-public::2024-05-18::GetProject', 'callbackInterval' => 100, 'maxCallbackTimes' => 3], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AFBB799F-8578-51C5-A766-E922EDB8XXXX\\\\n\\",\\n \\"ProjectId\\": 123456,\\n \\"Id\\": 123456\\n}","type":"json"}]', + 'title' => 'CreateProject', + 'description' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-01-07T09:51:48.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-10-17T08:04:45.000Z', 'description' => 'Request parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Network\\": {\\n \\"Id\\": 1000,\\n \\"ResourceGroupId\\": \\"Serverless_res_group_524257424564736_6831777003XXXXX\\",\\n \\"VpcId\\": \\"vpc-m2et4f3oc8msfbccXXXXX\\",\\n \\"VswitchId\\": \\"vsw-uf8usrhs7hjd9amsXXXXX\\",\\n \\"SecurityGroupId\\": \\"sg-2ze13vamugr7jenXXXXX\\",\\n \\"Status\\": \\"Running\\",\\n \\"CreateUser\\": \\"11075500042XXXXX\\",\\n \\"CreateTime\\": 1727055811000\\n },\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]', - 'title' => 'GetNetwork', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", - ], - 'ListNetworks' => [ - 'summary' => 'Queries a list of network resources of a serverless resource group.', - 'methods' => [ - 'get', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataworks:CreateProject', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'CreateProjectMember' => [ + 'summary' => 'Adds a workspace member and assigns a workspace-level role to the member.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '245178', - 'abilityTreeNodes' => [ - 'FEATUREdide2SV6DS', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '244498', + 'abilityTreeNodes' => ['FEATUREdideYTM537'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'ResourceGroupId', - 'in' => 'query', - 'schema' => [ - 'title' => '通用资源组唯一标识', - 'description' => 'The ID of the resource group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX', - ], - ], - [ - '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](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.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '24054', 'title' => ''], ], [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'name' => 'UserId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the account that you want to add to the workspace as a member. You can log on to the [DataWorks console](https://dataworks.console.aliyun.com/product/ms_menu), choose More > Management Center in the left-side navigation pane, select the desired workspace on the Management Center page, and then click Go to Management Center. In the left-side navigation pane of the SettingCenter page, click **Tenant Members and Roles**. On the Tenant Members and Roles page, view the ID of the account that you want to add to the workspace as a member.', 'type' => 'string', 'required' => true, 'example' => '123422344899', 'title' => ''], ], [ - 'name' => 'SortBy', - 'in' => 'query', + 'name' => 'RoleCodes', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '排序字段列表，支持定时时间、开始时间等字段。格式为"排序字段+排序方式(Desc/Asc)"（Asc可以缺省）。排序字段的枚举值如下：'."\n" - .'● Id (Desc/Asc)：网络ID'."\n" - .'● Status (Desc/Asc)：网络状态'."\n" - .'● CreateUser (Desc/Asc)：创建用户'."\n" - .'● CreateTime (Desc/Asc)：创建时间'."\n" - .'默认值为CreateTime Asc', - 'description' => 'The fields used for sorting. Fields such as TriggerTime and StartedTime are supported. The value of this parameter is in the Sort field + Sort by (Desc/Asc) format. By default, results are sorted in ascending order. Valid values:'."\n" - ."\n" - .'* Id (Desc/Asc): the network ID'."\n" - .'* Status (Desc/Asc): the network status'."\n" - .'* CreateUser (Desc/Asc): the user who created the network'."\n" - .'* CreateTime (Desc/Asc): the time when the network was created'."\n" + 'description' => 'The codes of the roles in the workspace. You can call the [ListProjectRoles](~~2853930~~) operation to query the codes of all roles in the workspace.'."\n" ."\n" - .'Default value: CreateTime Asc.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'CreateTime Asc', - 'default' => 'CreateTime Asc', + .'This parameter specifies the roles that you can assign to a member when you add the member.', + 'type' => 'array', + 'items' => ['description' => 'The code of a role in the workspace.', 'type' => 'string', 'required' => false, 'example' => 'role_project_guest', 'title' => ''], + 'required' => true, + 'maxItems' => 10, + 'minItems' => 1, + 'title' => '', + 'example' => '', ], ], ], @@ -10763,141 +9654,42 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'title' => '是否请求成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - 'default' => 'true', - ], - 'PagingInfo' => [ - 'title' => '分页列表', - 'description' => 'The pagination information.'."\n", - 'type' => 'object', - 'properties' => [ - 'NetworkList' => [ - 'title' => '获取到的通用资源组网络资源详细信息列表', - 'description' => 'The network resources of the serverless resource group.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '网络资源详细信息', - 'description' => 'The information about the network resource of the serverless resource group.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '网络资源ID', - 'description' => 'The network ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - ], - 'ResourceGroupId' => [ - 'title' => '所属通用资源组的唯一标识', - 'description' => 'The ID of the serverless resource group.'."\n", - 'type' => 'string', - 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX', - ], - 'VpcId' => [ - 'title' => '网络资源的VPC ID', - 'description' => 'The ID of the virtual private cloud (VPC).'."\n", - 'type' => 'string', - 'example' => 'vpc-m2et4f3oc8msfbccXXXXX', - ], - 'VswitchId' => [ - 'title' => '网络资源的交换机ID', - 'description' => 'The VSwitch ID.'."\n", - 'type' => 'string', - 'example' => 'vsw-uf8usrhs7hjd9amsXXXXX', - ], - 'SecurityGroupId' => [ - 'title' => '网络资源组的安全组ID', - 'description' => 'The security group ID.'."\n", - 'type' => 'string', - 'example' => 'sg-2ze13vamugr7jenXXXXX', - ], - 'Status' => [ - 'title' => '当前网络资源状态，Pending代表等待，Creating代表创建中，Running代表正常运行中，Deleting代表删除中，Deleted代表已删除', - 'description' => 'The status of the network resource. Valid values: Pending, Creating, Running, Deleting, and Deleted.'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Running', - 'enum' => [ - 'Pending', - 'Running', - 'Deleting', - 'Deleted', - 'Creating', - ], - ], - 'CreateUser' => [ - 'title' => '创建该网络资源的用户ID', - 'description' => 'The ID of the user who creates the network resource.'."\n", - 'type' => 'string', - 'example' => '11075500042XXXXX', - ], - 'CreateTime' => [ - 'title' => '创建时间，为64位时间戳', - 'description' => 'The time when the network resource was created. The value is a 64-bit timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1727055811000', - ], - ], - ], - ], - 'PageNumber' => [ - 'title' => '分页页码', - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - 'default' => '1', - ], - 'PageSize' => [ - 'title' => '分页大小', - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - 'default' => '100', - ], - 'TotalCount' => [ - 'title' => '全部数据条目', - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - ], - ], - 'RequestId' => [ - 'title' => '请求的ID，用于定位日志，排查问题', - 'description' => 'The ID of the request. It is used to locate logs and troubleshoot problems.', - 'type' => 'string', - 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.', 'type' => 'string', 'example' => '2B2F0B26-9253-5780-B6DB-F1A886D44D6F'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"PagingInfo\\": {\\n \\"NetworkList\\": [\\n {\\n \\"Id\\": 1000,\\n \\"ResourceGroupId\\": \\"Serverless_res_group_524257424564736_6831777003XXXXX\\",\\n \\"VpcId\\": \\"vpc-m2et4f3oc8msfbccXXXXX\\",\\n \\"VswitchId\\": \\"vsw-uf8usrhs7hjd9amsXXXXX\\",\\n \\"SecurityGroupId\\": \\"sg-2ze13vamugr7jenXXXXX\\",\\n \\"Status\\": \\"Running\\",\\n \\"CreateUser\\": \\"11075500042XXXXX\\",\\n \\"CreateTime\\": 1727055811000\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 100\\n },\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]', - 'title' => 'ListNetworks', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2B2F0B26-9253-5780-B6DB-F1A886D44D6F\\"\\n}","type":"json"}]', + 'title' => 'CreateProjectMember', 'description' => 'This API operation is available for all DataWorks editions.', - ], - 'CreateComponent' => [ - 'summary' => 'Creates components.', - 'methods' => [ - 'post', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataworks:CreateProjectMember', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateProjectRole' => [ + 'summary' => 'Creates a custom role for a workspace.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -10909,445 +9701,474 @@ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '236012', - 'abilityTreeNodes' => [ - 'FEATUREdideITYNXL', - ], + 'abilityTreeCode' => '244504', + 'abilityTreeNodes' => ['FEATUREdideYTM537'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The DataWorks workspace ID. You can call the [ListProjects](~~2852607~~) operation to obtain the ID.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10000', - ], + 'in' => 'query', + 'schema' => ['description' => 'The ID of the DataWorks workspace. You can log on to the [DataWorks console](https://dataworks.console.aliyun.com/workspace/list) and go to the workspace management page to obtain the ID.'."\n" + ."\n" + .'This parameter specifies the DataWorks workspace on which the API operation is performed.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12345', 'title' => ''], ], [ - 'name' => 'Spec', - 'in' => 'formData', + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The role name.', 'type' => 'string', 'required' => true, 'maxLength' => 30, 'example' => 'category_role', 'title' => ''], + ], + [ + 'name' => 'ModulePermissions', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The FlowSpec information for this UDF function. For more information, see [FlowSpec](https://github.com/aliyun/dataworks-spec/blob/master/README_zh_CN.md).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '{'."\n" - .' "kind": "Component",'."\n" - .' "name": "com1",'."\n" - .' "spec": {'."\n" - .' "components": ['."\n" - .' {'."\n" - .' "name": "test11",'."\n" - .' "id": "1234",'."\n" - .' "owner": "1234456",'."\n" - .' "description": "",'."\n" - .' "script": {'."\n" - .' "language": "odps-sql",'."\n" - .' "path": "test11",'."\n" - .' "content": "select \'@@{bizdate}\', \'@@{my_input_table}\'",'."\n" - .' "runtime": {'."\n" - .' "command": "SQL_COMPONENT"'."\n" - .' }'."\n" - .' },'."\n" - .' "inputs": ['."\n" - .' {'."\n" - .' "name": "bizdate",'."\n" - .' "type": "string"'."\n" - .' },'."\n" - .' {'."\n" - .' "name": "my_input_table",'."\n" - .' "type": "string"'."\n" - .' }'."\n" - .' ],'."\n" - .' "outputs": ['."\n" - .' {'."\n" - .' "name": "my_output_table1",'."\n" - .' "type": "string"'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .'}', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ModuleId' => [ + 'description' => 'The DataWorks module ID. Valid values:'."\n" + ."\n" + .'- 2: HoloStudio'."\n" + ."\n" + .'- 3: StreamStudio'."\n" + ."\n" + .'- 4: Deployment management'."\n" + ."\n" + .'- 6: Data Security Guard'."\n" + ."\n" + .'- 7: Data Map'."\n" + ."\n" + .'- 8: Data Service'."\n" + ."\n" + .'- 9: Data Integration'."\n" + ."\n" + .'- 10: Data Modeling (DataBlau DDM)'."\n" + ."\n" + .'- 11: Data Studio'."\n" + ."\n" + .'- 12: Data Quality'."\n" + ."\n" + .'- 13: Data Governance'."\n" + ."\n" + .'- 14: Operation Center'."\n" + ."\n" + .'- 15: Resource optimization'."\n" + ."\n" + .'- 16: Migration Assistant'."\n" + ."\n" + .'- 17: Data Analysis'."\n" + ."\n" + .'- 18: Approval center'."\n" + ."\n" + .'- 19: Security Center'."\n" + ."\n" + .'- 20: Intelligent Data Modeling', + 'enumValueTitles' => [2 => 'HoloStudio', 'StreamStudio', 'Deployment management', 6 => 'Data Security Guard', 'Data Map', 'Data Service', 'Data Integration', 'Data Modeling (DataBlau DDM)', 'Data Studio', 'Data Quality', 'Data Governance', 'Operation Center', 'Resource optimization', 'Migration Assistant', 'Data Analysis', 'Approval center', 'Security Center', 'Intelligent Data Modeling'], + 'type' => 'integer', + 'format' => 'int64', + 'title' => '', + 'required' => false, + 'example' => '2', + ], + 'PermissionType' => [ + 'description' => 'The permission type. Valid values:'."\n" + ."\n" + .'- Write: Read-only'."\n" + ."\n" + .'- Read: Edit'."\n" + ."\n" + .'- NotSet: Not controlled', + 'enumValueTitles' => ['Write' => 'Write', 'Read' => 'Read'], + 'type' => 'string', + 'required' => false, + 'example' => 'Write', + 'title' => '', + ], + ], + 'description' => 'A DataWorks module permission.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'description' => 'The list of DataWorks module permissions.', + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ 'name' => 'ClientToken', 'in' => 'formData', - 'schema' => [ - 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1AFAE64E-D1BE-432B-A9****', - ], + 'schema' => ['description' => 'The client token.', 'type' => 'string', 'required' => false, 'example' => '保留字段', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'adssd****', - ], - 'ComponentId' => [ - 'description' => 'The ID of the dataset acceleration component. To obtain the component ID, see [ListComponents](~~2979566~~).'."\n", - 'type' => 'string', - 'example' => '123123123123123', - ], + 'RequestId' => ['description' => 'The request ID, which is used to locate logs and troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => 'B313938A-4475-599B-98EB-A0875019FD5B'], + 'Code' => ['description' => 'The unique identifier of the role.', 'type' => 'string', 'example' => 'base_role_dte', 'title' => ''], ], + 'title' => '', + 'description' => 'The response.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateProjectRole', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"adssd****\\",\\n \\"ComponentId\\": \\"123123123123123\\"\\n}","type":"json"}]', - 'title' => 'CreateComponent', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B313938A-4475-599B-98EB-A0875019FD5B\\",\\n \\"Code\\": \\"base_role_dte\\"\\n}","type":"json"}]', ], - 'DeleteComponent' => [ - 'summary' => 'Deletes a component.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateResource' => [ + 'summary' => '\\\\> You cannot use this API operation to create multiple file resources at a time. If you specify multiple file resources by using FlowSpec, the system creates only the first specified resource.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '236013', - 'abilityTreeNodes' => [ - 'FEATUREdideITYNXL', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '235474', + 'abilityTreeNodes' => ['FEATUREdideJ3TPTK'], ], '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 query the ID.'."\n" - ."\n" - .'This parameter specifies the DataWorks workspace to which the API operation is applied.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1000', - ], + 'schema' => ['description' => 'The ID of the DataWorks workspace. To obtain the workspace ID, log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and navigate to the workspace configuration page.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '123456'], ], [ - 'name' => 'ComponentId', + 'name' => 'Spec', 'in' => 'formData', - 'schema' => [ - 'description' => 'The component ID. It can be used as a request parameter for querying the list of production studio components and modifying production studio components.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '123123123123', - ], + 'schema' => ['description' => 'The ID of the DataWorks workspace. To obtain the workspace ID, log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and navigate to the workspace configuration page.', 'type' => 'string', 'required' => true, 'example' => '{'."\n" + .' "version": "1.1.0",'."\n" + .' "kind": "Resource",'."\n" + .' "spec": {'."\n" + .' "fileResources": ['."\n" + .' {'."\n" + .' "name": "OpenAPITestResource.py",'."\n" + .' "script": {'."\n" + .' "content": "",'."\n" + .' "path": "XX/OpenAPITest/ResourcesTest/OpenAPITestResource.py",'."\n" + .' "runtime": {'."\n" + .' "command": "ODPS_PYTHON"'."\n" + .' }'."\n" + .' },'."\n" + .' "type": "python",'."\n" + .' "file": {'."\n" + .' "storage": {}'."\n" + .' },'."\n" + .' "datasource": {'."\n" + .' "name": "odps_first",'."\n" + .' "type": "odps"'."\n" + .' }'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .'}', 'title' => ''], + ], + [ + 'name' => 'ResourceFile', + 'in' => 'formData', + 'schema' => ['description' => 'The specific file stream or OSS download link contained in the resource.'."\n" + ."\n" + .'> This field allows users to provide a file stream or an OSS download link. When providing an OSS download link, ensure that the OSS link is publicly accessible. A presigned URL is recommended.', 'type' => 'string', 'isFileTransferUrl' => true, 'required' => false, 'example' => 'http://bucketname1.oss-cn-shanghai.aliyuncs.com/example', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EF****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'A5B97987-66EA-5563-9599-A2752292XXXX', 'type' => 'string', 'example' => 'A5B97987-66EA-5563-9599-A2752292****'], + 'Id' => ['description' => 'The unique identifier of the resource file.'."\n" + ."\n" + .'> This field is of type Long in SDK versions prior to 8.0.0, and of type String in SDK version 8.0.0 and later. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.', 'type' => 'string', 'example' => '631478864897630XXXX', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A5B97987-66EA-5563-9599-A2752292****\\",\\n \\"Id\\": \\"631478864897630XXXX\\"\\n}","type":"json"}]', + 'title' => 'CreateResource', + 'description' => '>'."\n" + ."\n" + .'This API does not support batch operations. If you define more than one resource file in the FlowSpec, all resource files except the first one are ignored.'."\n" + ."\n" + .'>', + 'changeSet' => [ + ['createdAt' => '2025-05-06T02:37:42.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-01-13T07:36:01.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EF****\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'DeleteComponent', - 'description' => '> A UDF that is deployed cannot be deleted. If you want to delete such a UDF, you must first undeploy the UDF.'."\n", - ], - 'GetComponent' => [ - 'summary' => 'Gets component information.', - 'methods' => [ - 'get', - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateResourceFile' => [ + 'summary' => 'Supports users in specifying their own files (such as JAR, PY, archive, or file) to create Data Development resource files.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '236011', - 'abilityTreeNodes' => [ - 'FEATUREdideITYNXL', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'operationType' => 'create', + 'abilityTreeCode' => '269305', + 'abilityTreeNodes' => ['FEATUREdide8FM783', 'FEATUREdideJ3TPTK'], ], 'parameters' => [ [ 'name' => 'ProjectId', - 'in' => 'query', - '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, - 'example' => '10000', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the DataWorks workspace. You can log on to the DataWorks console, go to the workspace configuration page, and obtain the workspace ID. This parameter is required to identify the DataWorks workspace for this API call.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '0', 'example' => '10000', 'title' => ''], ], [ - 'name' => 'ComponentId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The component ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1112312312312', - ], + 'name' => 'FileFolderPath', + 'in' => 'formData', + 'schema' => ['description' => 'The path of the file.', '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.', 'type' => 'string', 'required' => true, 'example' => 'Filename', 'title' => ''], + ], + [ + 'name' => 'FileType', + 'in' => 'formData', + 'schema' => ['description' => 'The code type of the file.'."\n" + ."\n" + .'Different file types correspond to different code types. For more information, see [DataWorks Node Types](~~600169~~).
'."\n" + .'You can also invoke the [ListFileType](~~212428~~) API to query the code types of files.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'minimum' => '0', 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'FileDescription', + 'in' => 'formData', + 'schema' => ['description' => 'The description of the file.', '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 Alibaba Cloud User ID of the caller is used by default.', 'type' => 'string', 'required' => false, 'example' => '1000000000001', 'title' => ''], + ], + [ + 'name' => 'Content', + 'in' => 'formData', + 'schema' => ['description' => 'The code content of the file. The code format varies depending on the code type (fileType). You can locate a job of the corresponding type in the Operation Center, right-click it, and select View Code to check the specific code format.', 'type' => 'string', 'required' => false, 'example' => 'SHOW TABLES;', 'title' => ''], + ], + [ + 'name' => 'ResourceFile', + 'in' => 'formData', + 'schema' => ['description' => 'The OSS URL for file upload 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' => 'The upload mode for the resource file. This parameter currently applies only to File-type files in MaxCompute. Valid values:'."\n" + ."\n" + .'- true: Downloadable resource mode.'."\n" + ."\n" + .'- false: Online-editable text mode.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'RegisterToCalcEngine', + 'in' => 'formData', + 'schema' => ['description' => 'Indicates whether to synchronize and upload the resource to the compute engine.', 'type' => 'boolean', 'required' => true, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'StorageURL', + 'in' => 'formData', + 'schema' => ['description' => 'The Storage Path of the resource file on the compute engine. This field is currently used only by EMR and CDH. The EMR format is \\[osshdfs]://path/to/object, and for CDH, the default value must be /user/admin/lib.', 'type' => 'string', 'required' => false, 'example' => 'oss://oss-cn-shanghai.aliyuncs.com/emr-test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'Component' => [ - 'description' => 'JSON serialization of the component module.'."\n", - 'type' => 'object', - 'properties' => [ - 'ComponentId' => [ - 'description' => 'The ID of the dataset acceleration component. For information on how to obtain the component ID, see [ListComponents](~~2979566~~).'."\n", - 'type' => 'string', - 'example' => '43cd873b-235c-44f8-be07-e4d4cf7e73b0', - ], - 'ProjectId' => [ - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '64623', - ], - 'Name' => [ - 'description' => 'Parameter'."\n", - 'type' => 'string', - 'example' => 'dim_whse_epet_warehouse_jz_storage_stock_lot_relation_id', - ], - 'Owner' => [ - 'description' => 'The ID of the task owner.'."\n", - 'type' => 'string', - 'example' => '207316543660665792', - ], - 'CreateTime' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'string', - 'format' => 'iso8601_normal', - 'example' => '2017-04-27T05:37:05Z', - ], - 'ModifyTime' => [ - 'description' => 'The modification time (millisecond-level timestamp).'."\n", - 'type' => 'string', - 'format' => 'iso8601_normal', - 'example' => '2024-01-26T07:44:21Z', - ], - 'Spec' => [ - 'description' => 'The FlowSpec information for this workflow. For more information, see [FlowSpec](https://github.com/aliyun/alibabacloud-dataworks-tool-dflow/).'."\n", - 'type' => 'string', - 'example' => '{'."\n" - .' "kind": "Component",'."\n" - .' "name": "com1",'."\n" - .' "spec": {'."\n" - .' "components": ['."\n" - .' {'."\n" - .' "name": "test11",'."\n" - .' "id": "8196828925037*****",'."\n" - .' "owner": "054664",'."\n" - .' "description": "",'."\n" - .' "script": {'."\n" - .' "language": "odps-sql",'."\n" - .' "path": "test11",'."\n" - .' "content": "select \'@@{bizdate}\', \'@@{my_input_table}\'",'."\n" - .' "runtime": {'."\n" - .' "command": "SQL_COMPONENT"'."\n" - .' }'."\n" - .' },'."\n" - .' "inputs": ['."\n" - .' {'."\n" - .' "name": "bizdate",'."\n" - .' "type": "string"'."\n" - .' },'."\n" - .' {'."\n" - .' "name": "my_input_table",'."\n" - .' "type": "string"'."\n" - .' }'."\n" - .' ],'."\n" - .' "outputs": ['."\n" - .' {'."\n" - .' "name": "my_output_table1",'."\n" - .' "type": "string"'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .'}', - ], - 'Description' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'None', - ], - 'RegionId' => [ - 'description' => 'The region ID, such as ap-southeast-1. The region ID is automatically parsed from your endpoint.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - ], - ], + 'Data' => ['description' => 'The ID of the file after successful creation.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000001', 'title' => ''], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The unique ID of this request. If an error occurs, you can use this ID to troubleshoot the issue.', 'type' => 'string', 'example' => '0000-ABCD-EFG'], ], + 'example' => '', ], ], ], 'errorCodes' => [ - 404 => [ - [ - 'errorCode' => 'InvalidComponent.NotFound', - 'errorMessage' => 'The specified Component does not exist.', - ], + 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' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create Resource File ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"Component\\": {\\n \\"ComponentId\\": \\"43cd873b-235c-44f8-be07-e4d4cf7e73b0\\",\\n \\"ProjectId\\": 64623,\\n \\"Name\\": \\"dim_whse_epet_warehouse_jz_storage_stock_lot_relation_id\\",\\n \\"Owner\\": \\"207316543660665792\\",\\n \\"CreateTime\\": \\"2017-04-27T05:37:05Z\\",\\n \\"ModifyTime\\": \\"2024-01-26T07:44:21Z\\",\\n \\"Spec\\": \\"{\\\\n \\\\\\"kind\\\\\\": \\\\\\"Component\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"com1\\\\\\",\\\\n \\\\\\"spec\\\\\\": {\\\\n \\\\\\"components\\\\\\": [\\\\n {\\\\n \\\\\\"name\\\\\\": \\\\\\"test11\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"8196828925037*****\\\\\\",\\\\n \\\\\\"owner\\\\\\": \\\\\\"054664\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"script\\\\\\": {\\\\n \\\\\\"language\\\\\\": \\\\\\"odps-sql\\\\\\",\\\\n \\\\\\"path\\\\\\": \\\\\\"test11\\\\\\",\\\\n \\\\\\"content\\\\\\": \\\\\\"select \'@@{bizdate}\', \'@@{my_input_table}\'\\\\\\",\\\\n \\\\\\"runtime\\\\\\": {\\\\n \\\\\\"command\\\\\\": \\\\\\"SQL_COMPONENT\\\\\\"\\\\n }\\\\n },\\\\n \\\\\\"inputs\\\\\\": [\\\\n {\\\\n \\\\\\"name\\\\\\": \\\\\\"bizdate\\\\\\",\\\\n \\\\\\"type\\\\\\": \\\\\\"string\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"name\\\\\\": \\\\\\"my_input_table\\\\\\",\\\\n \\\\\\"type\\\\\\": \\\\\\"string\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"outputs\\\\\\": [\\\\n {\\\\n \\\\\\"name\\\\\\": \\\\\\"my_output_table1\\\\\\",\\\\n \\\\\\"type\\\\\\": \\\\\\"string\\\\\\"\\\\n }\\\\n ]\\\\n }\\\\n ]\\\\n }\\\\n}\\",\\n \\"Description\\": \\"None\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n}","type":"json"}]', - 'title' => 'GetComponent', - 'description' => '1. This API operation is available for all DataWorks editions.'."\n", + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": 1000001,\\n \\"RequestId\\": \\"0000-ABCD-EFG\\"\\n}","type":"json"}]', ], - 'UpdateComponent' => [ - 'summary' => 'Updates components.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateResourceGroup' => [ + 'summary' => 'Creates a resource group.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '236014', - 'abilityTreeNodes' => [ - 'FEATUREdideITYNXL', - ], - 'autoTest' => true, + 'chargeType' => 'paid', + 'abilityTreeCode' => '245182', + 'abilityTreeNodes' => ['FEATUREdide2SV6DS'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'ComponentId', + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the general-purpose resource group. It must be up to 128 characters long, start with a letter, and contain only letters, digits, and underscores (\\_).', 'type' => 'string', 'required' => true, 'example' => 'common_resource_group', 'title' => ''], + ], + [ + 'name' => 'Remark', + 'in' => 'formData', + 'schema' => ['description' => 'The remark for the general-purpose resource group. It can be up to 128 characters long and can contain letters, Chinese characters, digits, and underscores (\\_).', 'type' => 'string', 'example' => 'Create a serverless resource group for common tasks', 'title' => '', 'required' => false], + ], + [ + 'name' => 'PaymentType', 'in' => 'formData', 'schema' => [ - 'description' => 'The component ID.'."\n", + 'description' => 'The billing method of the resource group. `PrePaid` indicates subscription, and `PostPaid` indicates pay-as-you-go.', + 'enumValueTitles' => [], 'type' => 'string', 'required' => true, - 'example' => '568780096083*******', + 'example' => 'PrePaid', + 'enum' => ['PrePaid', 'PostPaid'], + 'title' => '', ], ], [ - 'name' => 'Spec', + 'name' => 'PaymentDurationUnit', 'in' => 'formData', 'schema' => [ - 'description' => 'The FlowSpec information for this UDF function. For more information, see [FlowSpec](https://github.com/aliyun/dataworks-spec/blob/master/README_zh_CN.md).'."\n", + 'description' => 'The unit of the subscription duration. Valid values: `Month` and `Year`.', + 'enumValueTitles' => [], 'type' => 'string', - 'required' => true, - 'example' => '{'."\n" - .' "kind": "Component",'."\n" - .' "version": "1.1.2",'."\n" - .' "spec": {'."\n" - .' "components": ['."\n" - .' {'."\n" - .' "id": "568780096083*******",'."\n" - .' "script": {'."\n" - .' "content": "select \'@@{para1}\', \'@@{para2}\'"'."\n" - .' }'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .'}', + 'example' => 'Month', + 'enum' => ['Month', 'Year'], + 'title' => '', + 'required' => false, ], ], [ - 'name' => 'ProjectId', - 'in' => 'query', + 'name' => 'PaymentDuration', + 'in' => 'formData', + 'schema' => ['description' => 'The subscription duration.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => '', 'required' => false], + ], + [ + 'name' => 'AutoRenewEnabled', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to enable auto-renewal for the subscription.', 'type' => 'boolean', 'default' => 'false', 'title' => '', 'required' => false, 'example' => ''], + ], + [ + 'name' => 'Spec', + 'in' => 'formData', + 'schema' => ['description' => 'The specification of the resource group, in CUs. This parameter is required when `PaymentType` is set to `PrePaid`.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => '', 'required' => false], + ], + [ + 'name' => 'VpcId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the VPC to be bound by default.', 'type' => 'string', 'required' => true, 'example' => 'vpc-m2et4f3oc8m****', 'title' => ''], + ], + [ + 'name' => 'VswitchId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the vSwitch to be bound by default.', 'type' => 'string', 'required' => true, 'example' => 'vsw-uf8usrhs7hjd9****', 'title' => ''], + ], + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => ['description' => 'A client token to ensure the idempotence of the request.', 'type' => 'string', 'required' => true, 'example' => 'eb870033-74c8-4b1b-9664-04c4e7cc3465', 'title' => ''], + ], + [ + 'name' => 'AliyunResourceGroupId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the Alibaba Cloud resource group.', 'type' => 'string', 'example' => 'rg-aek2kqofrgXXXXX', 'title' => '', 'required' => false], + ], + [ + 'name' => 'AliyunResourceTags', + 'in' => 'formData', + 'style' => 'json', '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 query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10000', + 'title' => '', + 'description' => 'The list of Alibaba Cloud tags.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'An Alibaba Cloud tag.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'key', 'title' => '', 'required' => false], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'value', 'title' => '', 'required' => false], + ], + 'required' => false, + 'example' => '', + ], + 'required' => false, + 'example' => '', ], ], ], @@ -11355,348 +10176,135 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response.'."\n", + 'description' => 'The returned data.', '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', + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'example' => 'true'], + 'ResourceGroupOrder' => [ + 'title' => '', + 'description' => 'Information about the resource group creation order.', + 'type' => 'object', + 'properties' => [ + 'OrderId' => ['description' => 'The ID of the resource group creation order.', 'type' => 'integer', 'format' => 'int64', 'example' => '2391982058XXXXX', 'title' => ''], + 'OrderInstanceId' => ['description' => 'The instance ID of the resource group creation order.', 'type' => 'string', 'example' => 'c442b330-3b10-4584-959e-736e4edXXXXX', 'title' => ''], + 'Id' => ['description' => 'The unique identifier of the general-purpose resource group.', 'type' => 'string', 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX', 'title' => ''], + ], + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID. You can use this ID to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'asynchronous', 'callback' => 'dataworks-public::2024-05-18::GetResourceGroup', 'callbackInterval' => 5000, 'maxCallbackTimes' => 10], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ResourceGroupOrder\\": {\\n \\"OrderId\\": 0,\\n \\"OrderInstanceId\\": \\"c442b330-3b10-4584-959e-736e4edXXXXX\\",\\n \\"Id\\": \\"Serverless_res_group_524257424564736_6831777003XXXXX\\"\\n },\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]', + 'title' => 'CreateResourceGroup', + 'description' => '1. You must purchase DataWorks Basic Edition or higher to use this operation.'."\n" + ."\n" + .'2. **Before you call this operation, make sure that you understand how general-purpose resource groups in DataWorks are billed and review the [pricing](~~2680173~~).**'."\n" + ."\n" + .'3. **Before you call this operation, make sure that you have created the AliyunServiceRoleForDataWorks service-linked role.**', + 'changeSet' => [ + ['createdAt' => '2025-01-02T07:14:14.000Z', 'description' => 'Request parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'UpdateComponent', - 'description' => 'This operation is currently in beta. To join the beta testing, please submit a request. You can call this operation after we add you to the beta program.'."\n", - ], - 'ListComponents' => [ - 'summary' => 'Retrieves a list of components.', - 'methods' => [ - 'get', - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataworks:CreateResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'DwResourceGroup', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:dwresourcegroup/*'], + ], + ], + ], ], + ], + 'CreateRoute' => [ + 'summary' => 'Creates a route for a network.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'consumes' => [ - 'application/json', - ], - 'produces' => [ - 'application/json', - ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '236015', - 'abilityTreeNodes' => [ - 'FEATUREdideITYNXL', - ], + 'abilityTreeCode' => '245176', + 'abilityTreeNodes' => ['FEATUREdide2SV6DS'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the workspace associated with the data source. You can call the [ListProjects](~~178393~~) operation to obtain the workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '100001', - ], - ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the data source.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'xm_create_test', - ], + 'name' => 'NetworkId', + 'in' => 'formData', + 'schema' => ['description' => 'The network ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10001', 'title' => ''], ], [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number for pagination.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'name' => 'DestinationCidr', + 'in' => 'formData', + 'schema' => ['description' => 'The CIDR blocks of the destination-based route.', 'type' => 'string', 'required' => true, 'example' => '192.168.0.0/16', '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, - 'maximum' => '100', - 'minimum' => '10', - 'example' => '1000', - 'default' => '10', - ], + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => ['description' => 'Unique identifier of the serverless resource group.', 'type' => 'string', 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID. Use this ID for troubleshooting.'."\n", - 'type' => 'string', - 'example' => '952795279527ab****', - ], - 'PagingInfo' => [ - 'description' => 'The pagination information.'."\n", - 'type' => 'object', - 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - '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', - ], - 'Components' => [ - 'description' => 'The UID of the user who created the dataset acceleration component. In Alibaba Cloud, this is the RAM user ID (or the Alibaba Cloud account ID if created by the account itself).'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The UID of the user who created the dataset acceleration component. In Alibaba Cloud, this is the RAM user ID (or the Alibaba Cloud account ID if created by the account itself).'."\n", - 'type' => 'object', - 'properties' => [ - 'ModifyTime' => [ - 'description' => 'The timestamp when the publishing process was modified.'."\n", - 'type' => 'string', - 'format' => 'iso8601_normal', - 'example' => '2023-11-30T13:30:58Z', - ], - 'Script' => [ - 'title' => '脚本信息', - 'description' => 'The script information.'."\n", - 'type' => 'object', - 'properties' => [ - 'Path' => [ - 'title' => '脚本路径', - 'description' => 'The script path.'."\n", - 'type' => 'string', - 'example' => '/', - 'pattern' => '', - 'default' => '', - ], - 'Runtime' => [ - 'title' => '运行时', - 'description' => 'The runtime.'."\n", - 'type' => 'object', - 'properties' => [ - 'Command' => [ - 'title' => '命令', - 'description' => 'The command.'."\n", - 'type' => 'string', - 'example' => 'SQL_COMPONENT', - 'pattern' => '', - 'default' => '', - ], - ], - ], - 'Id' => [ - 'description' => 'ID'."\n", - 'type' => 'string', - 'example' => '348100', - ], - ], - ], - 'Owner' => [ - 'title' => '责任人', - 'description' => 'The owner.'."\n", - 'type' => 'string', - 'example' => '252675537980665607', - 'pattern' => '', - 'default' => '', - ], - 'Description' => [ - 'title' => '描述', - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'vpc peering management_staging', - 'pattern' => '', - 'default' => '', - ], - 'CreateTime' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'string', - 'format' => 'iso8601_normal', - 'example' => '2023-03-13 16:35:59', - ], - 'Outputs' => [ - 'title' => '输出参数', - 'description' => 'The output parameters.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The node output.'."\n", - 'type' => 'object', - 'properties' => [ - 'DefaultValue' => [ - 'title' => '默认值', - 'description' => 'The default value.'."\n", - 'type' => 'string', - 'example' => '32000', - 'pattern' => '', - 'default' => '', - ], - 'Type' => [ - 'title' => '参数类型', - 'description' => 'The parameter type.'."\n", - 'type' => 'string', - 'example' => 'string', - 'pattern' => '', - 'default' => '', - ], - 'Description' => [ - 'title' => '参数描述', - 'description' => 'The parameter description.'."\n", - 'type' => 'string', - 'example' => 'zdy', - 'pattern' => '', - 'default' => '', - ], - 'Name' => [ - 'title' => '参数名称', - 'description' => 'The parameter name.'."\n", - 'type' => 'string', - 'example' => 'auto_updateAlertRule_test_bULIRo', - 'pattern' => '', - 'default' => '', - ], - ], - ], - ], - 'ProjectId' => [ - 'description' => 'The DataWorks workspace ID. To obtain the workspace ID, log on to the DataWorks console and navigate to the workspace configuration page. You must specify either this parameter or ProjectIdentifier to identify the target DataWorks workspace for this API call.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '199925', - ], - 'ComponentId' => [ - 'description' => 'The component ID. This parameter can be used in requests to query, modify, or delete director components.'."\n", - 'type' => 'string', - 'example' => '12312313123', - ], - 'Inputs' => [ - 'title' => '输入参数', - 'description' => 'The input parameters.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The variable element.'."\n", - 'type' => 'object', - 'properties' => [ - 'DefaultValue' => [ - 'title' => '默认值', - 'description' => 'The default value of the variable.'."\n", - 'type' => 'string', - 'example' => 'mdb.shard.2x.2xlarge.d', - 'pattern' => '', - 'default' => '', - ], - 'Type' => [ - 'title' => '参数类型', - 'description' => 'The parameter type.'."\n", - 'type' => 'string', - 'example' => 'string', - 'pattern' => '', - 'default' => '', - ], - 'Description' => [ - 'title' => '参数描述', - 'description' => 'The parameter description.'."\n", - 'type' => 'string', - 'example' => 'None', - 'pattern' => '', - 'default' => '', - ], - 'Name' => [ - 'title' => '参数名称', - 'description' => 'The parameter name.'."\n", - 'type' => 'string', - 'example' => 'auto_updateAlertRule_test_bULIRo', - 'pattern' => '', - 'default' => '', - ], - ], - ], - ], - 'Name' => [ - 'title' => '资源名称', - 'description' => 'The resource name.'."\n", - 'type' => 'string', - 'example' => 'auto_updateAlertRule_test_lJd81f', - 'pattern' => '', - 'default' => '', - ], - ], - ], - ], - ], - ], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'example' => 'true'], + 'Id' => ['description' => 'The route ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Id\\": 1000,\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]', + 'title' => 'CreateRoute', + 'description' => 'This API operation is available for all DataWorks editions.', + 'changeSet' => [ + ['createdAt' => '2025-02-21T06:57:06.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-12-19T08:49:55.000Z', 'description' => 'Response parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"952795279527ab****\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Components\\": [\\n {\\n \\"ModifyTime\\": \\"2023-11-30T13:30:58Z\\",\\n \\"Script\\": {\\n \\"Path\\": \\"/\\",\\n \\"Runtime\\": {\\n \\"Command\\": \\"SQL_COMPONENT\\"\\n },\\n \\"Id\\": \\"348100\\"\\n },\\n \\"Owner\\": \\"252675537980665607\\",\\n \\"Description\\": \\"vpc peering management_staging\\",\\n \\"CreateTime\\": \\"2023-03-13 16:35:59\\",\\n \\"Outputs\\": [\\n {\\n \\"DefaultValue\\": \\"32000\\",\\n \\"Type\\": \\"string\\",\\n \\"Description\\": \\"zdy\\",\\n \\"Name\\": \\"auto_updateAlertRule_test_bULIRo\\"\\n }\\n ],\\n \\"ProjectId\\": 199925,\\n \\"ComponentId\\": \\"12312313123\\",\\n \\"Inputs\\": [\\n {\\n \\"DefaultValue\\": \\"mdb.shard.2x.2xlarge.d\\",\\n \\"Type\\": \\"string\\",\\n \\"Description\\": \\"None\\",\\n \\"Name\\": \\"auto_updateAlertRule_test_bULIRo\\"\\n }\\n ],\\n \\"Name\\": \\"auto_updateAlertRule_test_lJd81f\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListComponents', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", - ], - 'CreateNode' => [ - 'summary' => 'Creates a node in DataStudio. The information about the node is described by using FlowSpec.', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataworks:CreateRoute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateSecurityStrategy' => [ + 'summary' => 'Creates a new security control policy to configure various modules and submodules. Requires both DataWorks tenant administrator and security administrator permissions.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -11708,272 +10316,239 @@ 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '236773', - 'abilityTreeNodes' => [ - 'FEATUREdideHO4TQP', - 'FEATUREdide8FM783', - 'FEATUREdideQUQUVB', - 'FEATUREdideIQU97M', - ], + 'abilityTreeCode' => 'TBD', + 'abilityTreeNodes' => ['FEATUREdideYTM537'], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['description' => '**Strategy name**', 'type' => 'string', 'required' => true, 'example' => '默认数据分析策略', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['description' => '**Strategy description**', 'type' => 'string', 'required' => false, 'example' => '控制数据分析模块的查询结果安全行为', 'title' => ''], + ], + [ + 'name' => 'SchemaName', '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" - ."\n" - .'You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => '**Schema template name**', + 'type' => 'string', 'required' => true, - 'example' => '123456', + 'enum' => ['DataQuerySecurityStrategySchema', 'DataStudioSecurityStrategySchema', 'DataStudioMyCatalogSecurityStrategySchema'], + 'example' => 'DataQuerySecurityStrategySchema', + 'title' => '', ], ], [ - 'name' => 'ContainerId', + 'name' => 'ControlModule', 'in' => 'formData', 'schema' => [ - 'description' => 'Specify this parameter if you want to create the node inside a container. This parameter represents the unique identifier of the container, which can be a workflow or a container node.'."\n" - ."\n" - .'> If this parameter is specified, the path field defined in FlowSpec is ignored.'."\n" - ."\n" - .'> Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.'."\n", + 'description' => '**Control module**', 'type' => 'string', - 'required' => false, - 'example' => 'a7ef0634-20ec-4a7c-a214-54020f91XXXX'."\n", + 'required' => true, + 'enum' => ['DataQuery', 'DataStudio'], + 'example' => 'DataQuery', + 'title' => '', ], ], [ - 'name' => 'Scene', + 'name' => 'ControlSubModule', 'in' => 'formData', 'schema' => [ - 'description' => 'Specify this parameter if you want to create the node inside a container. This parameter represents the unique identifier of the container, which can be a workflow or a container node.'."\n" - ."\n" - .'> If this parameter is specified, the path field defined in FlowSpec is ignored.'."\n" - ."\n" - .'> Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.'."\n", + 'description' => '**Control submodule**', 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [], - 'example' => 'DATAWORKS_PROJECT', + 'required' => false, + 'enum' => ['MyCatalog'], + 'example' => 'MyCatalog', + 'title' => '', ], ], [ - 'name' => 'Spec', + 'name' => 'ControlDwScope', 'in' => 'formData', 'schema' => [ - 'description' => 'The FlowSpec information that describes the node. For more information, see [FlowSpec](https://github.com/aliyun/alibabacloud-dataworks-tool-dflow).'."\n" - ."\n" - .'> How do I quickly obtain a FlowSpec template?'."\n" - ."\n" - .'* Go to Data Studio, open a node, click Version on the right side, find the latest version, and then click Scheduling Settings to obtain the FlowSpec description of the current node. You can use the FlowSpec description in the version to quickly build a template that meets your requirements.'."\n" - ."\n" - .'> How do I configure the node content?'."\n" - ."\n" - .'* Enter the code for the node in the $.spec.nodes\\[].script.content field.'."\n" - ."\n" - .'> How do I configure a batch synchronization node?'."\n" - ."\n" - .'* Write the script by referring to Step 4 in [Configure an offline sync task in the code editor](https://help.aliyun.com/zh/dataworks/user-guide/configure-a-batch-synchronization-node-by-using-the-code-editor), and then enter the script content in the $.spec.nodes\\[\\*].script.content field. Alternatively, you can create a batch synchronization node in the console and view its version information to obtain the script content.', + 'description' => '**The control scope. Valid values: Workspace and Tenant.**', 'type' => 'string', 'required' => true, - 'example' => '{'."\n" - .' "version": "1.1.0",'."\n" - .' "kind": "Node",'."\n" - .' "spec": {'."\n" - .' "nodes": ['."\n" - .' {'."\n" - .' "id": "860438872620113XXXX",'."\n" - .' "recurrence": "Normal",'."\n" - .' "timeout": 0,'."\n" - .' "instanceMode": "T+1",'."\n" - .' "rerunMode": "Allowed",'."\n" - .' "rerunTimes": 3,'."\n" - .' "rerunInterval": 180000,'."\n" - .' "datasource": {'."\n" - .' "name": "ODPS_test",'."\n" - .' "type": "ODPS"'."\n" - .' },'."\n" - .' "script": {'."\n" - .' "path": "XX/OpenAPI test/odpsSQL test",'."\n" - .' "runtime": {'."\n" - .' "command": "ODPS_SQL"'."\n" - .' },'."\n" - .' "content": "select now();"'."\n" - .' },'."\n" - .' "trigger": {'."\n" - .' "type": "Scheduler",'."\n" - .' "cron": "00 00 00 * * ?",'."\n" - .' "startTime": "1970-01-01 00:00:00",'."\n" - .' "endTime": "9999-01-01 00:00:00",'."\n" - .' "timezone": "Asia/Shanghai",'."\n" - .' "delaySeconds": 0'."\n" - .' },'."\n" - .' "runtimeResource": {'."\n" - .' "resourceGroup": "S_res_group_XXXX_XXXX"'."\n" - .' },'."\n" - .' "name": "odpsSQL test",'."\n" - .' "inputs": {'."\n" - .' "nodeOutputs": ['."\n" - .' {'."\n" - .' "data": "lwttest_standard_root",'."\n" - .' "artifactType": "NodeOutput"'."\n" - .' }'."\n" - .' ]'."\n" - .' },'."\n" - .' "outputs": {'."\n" - .' "nodeOutputs": ['."\n" - .' {'."\n" - .' "data": "output_data",'."\n" - .' "artifactType": "NodeOutput",'."\n" - .' "refTableName": "odpsSQL test"'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .' }'."\n" - .' ],'."\n" - .' "flow": ['."\n" - .' {'."\n" - .' "nodeId": "860438872620113XXXX",'."\n" - .' "depends": ['."\n" - .' {'."\n" - .' "type": "Normal",'."\n" - .' "output": "project_root"'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .'}', + 'enum' => ['Tenant', 'Workspace'], + 'example' => 'Tenant', + 'title' => '', ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'Workspaces', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'type' => 'array', + 'items' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1853943', 'title' => ''], + 'description' => 'A list of associated workspace IDs.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'Content', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", + 'Name' => [ + 'description' => 'The `name` property of the `SecurityStrategySchema` associated with the current strategy.', 'type' => 'string', - 'example' => 'AFBB799F-8578-51C5-A766-E922EDB8XXXX', + 'required' => true, + 'enum' => ['DataQuerySecurityStrategySchema', 'DataStudioSecurityStrategySchema', 'DataStudioMyCatalogSecurityStrategySchema'], + 'example' => 'DataQuerySecurityStrategySchema', + 'title' => '', ], - 'Id' => [ - 'description' => 'The unique identifier of the Data Studio node.'."\n" - ."\n" - .'> This field is of the Long type in SDK versions prior to 8.0.0, and of the String type in SDK versions 8.0.0 and later. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.'."\n", + 'DisplayName' => ['description' => 'The `displayName` property of the `SecurityStrategySchema` associated with the current strategy.', 'type' => 'string', 'required' => false, 'example' => '数据分析', 'title' => ''], + 'DisplayNameEn' => ['description' => 'The `displayNameEn` property of the `SecurityStrategySchema` associated with the current strategy.', 'type' => 'string', 'required' => false, 'example' => 'Data Analysis', 'title' => ''], + 'ControlModule' => [ + 'description' => 'The control module. This corresponds to the `controlModule` property of the `SecurityStrategySchema` associated with the current strategy.', 'type' => 'string', - 'example' => '860438872620113XXXX', + 'required' => true, + 'enum' => ['DataQuery', 'DataStudio'], + 'example' => 'DataStudio', + 'title' => '', + ], + 'ControlSubModule' => [ + 'description' => 'The control submodule. This corresponds to the `controlSubModule` property of the `SecurityStrategySchema` associated with the current strategy.', + 'type' => 'string', + 'enum' => ['MyCatalog'], + 'required' => false, + 'example' => 'MyCatalog', + 'title' => '', + ], + 'ControlDwScope' => [ + 'description' => 'The control scope. This corresponds to the `controlDwScope` property of the `SecurityStrategySchema` associated with the current strategy.', + 'type' => 'string', + 'enum' => ['Tenant', 'Workspace'], + 'required' => false, + 'example' => 'Tenant', + 'title' => '', + ], + 'SystemPolicyName' => ['description' => 'The `systemPolicyName` property of the `SecurityStrategySchema` associated with the current strategy.', 'type' => 'string', 'required' => false, 'example' => 'SYSTEM_GENERATE_DEFAULT_DATA_QUERY', 'title' => ''], + 'SystemPolicyDisplayName' => ['description' => 'The `systemPolicyDisplayName` property of the `SecurityStrategySchema` associated with the current strategy.', 'type' => 'string', 'required' => false, 'example' => 'Default system generate data query policy', 'title' => ''], + 'Controllers' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Controller' => ['description' => 'The controller identifier. For valid values, see the list of controllers for each schema.', 'type' => 'string', 'required' => false, 'example' => 'viewCount', 'title' => ''], + 'DisplayName' => ['description' => 'The display name.', 'type' => 'string', 'required' => false, 'example' => '查询结果-单次展示记录值上限', 'title' => ''], + 'DisplayNameEn' => ['description' => 'The English display name.', 'type' => 'string', 'required' => false, 'example' => 'Query Results - Single Display Record Limit', 'title' => ''], + 'Enable' => ['description' => 'Specifies whether to enable this controller.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'ControllerValueType' => ['description' => 'The value type. Valid values: `Boolean`, `Integer`, `Long`, and `String`.', 'type' => 'string', 'required' => false, 'example' => 'Integer', 'title' => ''], + 'UserConfigValue' => ['description' => 'The user-configured value. The type of this value depends on the `ControllerValueType` parameter.', 'type' => 'any', 'required' => false, 'example' => '10', 'title' => ''], + 'BasicEditionDefaultValue' => ['description' => 'The default value for Basic Edition.', 'type' => 'any', 'required' => false, 'example' => '0', 'title' => ''], + 'StandardEditionDefaultValue' => ['description' => 'The default value for Standard Edition.', 'type' => 'any', 'required' => false, 'example' => '100000', 'title' => ''], + 'ProfessionalEditionDefaultValue' => ['description' => 'The default value for Professional Edition.', 'type' => 'any', 'required' => false, 'example' => '200000', 'title' => ''], + 'EnterpriseEditionDefaultValue' => ['description' => 'The default value for Enterprise Edition.', 'type' => 'any', 'required' => false, 'example' => '500000', 'title' => ''], + 'BasicEditionIntervalValue' => [ + 'type' => 'array', + 'items' => ['description' => 'An interval boundary value.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'description' => 'The valid value interval for Basic Edition, in the format `[min, max]`.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'StandardEditionIntervalValue' => [ + 'type' => 'array', + 'items' => ['description' => 'An interval boundary value.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100000', 'title' => ''], + 'description' => 'The valid value interval for Standard Edition, in the format `[min, max]`.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'ProfessionalEditionIntervalValue' => [ + 'type' => 'array', + 'items' => ['description' => 'An interval boundary value.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '200000', 'title' => ''], + 'description' => 'The valid value interval for Professional Edition, in the format `[min, max]`.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'EnterpriseEditionIntervalValue' => [ + 'type' => 'array', + 'items' => ['description' => 'An interval boundary value.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '500000', 'title' => ''], + 'description' => 'The valid value interval for Enterprise Edition, in the format `[min, max]`.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'A controller.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'description' => 'A list of controllers.'."\n" + ."\n" + .'**Note:** Valid controllers depend on the selected schema. For more information, see the controller definitions and the list of controllers for each schema.', + 'required' => false, + 'title' => '', + 'example' => '', ], ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AFBB799F-8578-51C5-A766-E922EDB8XXXX\\",\\n \\"Id\\": \\"860438872620113XXXX\\"\\n}","type":"json"}]', - 'title' => 'CreateNode', - 'description' => '> You cannot use this API operation to create multiple nodes at a time. If you specify multiple nodes by using FlowSpec, the system creates only the first specified node.'."\n", - ], - 'DeleteNode' => [ - 'summary' => 'Deletes a node from DataStudio.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '236786', - 'abilityTreeNodes' => [ - 'FEATUREdideHO4TQP', - 'FEATUREdide8FM783', - 'FEATUREdideQUQUVB', - 'FEATUREdideIQU97M', - ], - ], - '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 ID.'."\n" - ."\n" - .'You can use this parameter to specify the DataWorks workspace on which you want to perform the API operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', 'required' => true, - 'example' => '10000', + 'description' => 'The content of the strategy. This value is constrained by the `SecurityStrategySchema`.', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Id', + 'name' => 'ClientToken', 'in' => 'formData', - 'schema' => [ - 'description' => 'The unique identifier of the Data Studio node.'."\n" - ."\n" - .'> This field is of the Long type in SDK versions prior to 8.0.0, and of the String type in SDK versions 8.0.0 and later. This change does not affect normal SDK usage; the parameter will still be returned according to the type defined in the SDK. However, compilation failures may occur due to the type change only when upgrading the SDK across version 8.0.0. In this case, you must manually update the data type.', - 'type' => 'string', - 'required' => true, - 'example' => '860438872620113XXXX', - ], + 'schema' => ['description' => 'A client-generated token that ensures request idempotency, preventing duplicate operations if you retry the request.', 'type' => 'string', 'required' => false, 'example' => 'ABFUOEUOTRTRJKE', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameetrs.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'A1E54497-5122-505E-91C6-BAC14980XXXX', - ], - '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.', 'type' => 'string', 'title' => '', 'example' => '0bc5df3a17****903790e8e8a'], + 'Id' => ['description' => 'The security strategy ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '12345', 'title' => ''], ], + 'title' => '', + 'description' => 'The response schema.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateSecurityStrategy', + 'description' => '## Request'."\n" + ."\n" + .'- **SchemaName**: Select a schema that fits your business needs.'."\n" + ."\n" + .'- **ControlModule** and **ControlSubModule**: Specify the module and submodule for the policy, ensuring they match the selected schema.'."\n" + ."\n" + .'- **ControlDwScope**: Set the policy scope to either the tenant or workspace level.'."\n" + ."\n" + .'- **Workspaces**: If `ControlDwScope` is set to `Workspace`, provide the corresponding workspace IDs.'."\n" + ."\n" + .'- **Content.Controllers**: The controllers must match the definitions in the selected schema.'."\n" + ."\n" + .'- This operation cannot create system default policies.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A1E54497-5122-505E-91C6-BAC14980XXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'DeleteNode', - 'description' => '> A node that is deployed cannot be deleted. If you want to delete such a node, you must first undeploy the node.'."\n", + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc5df3a17****903790e8e8a\\",\\n \\"Id\\": 12345\\n}","type":"json"}]', ], - 'UpdateNode' => [ - 'summary' => 'Updates the basic information about a node in DataStudio. This API operation performs an incremental update. The update information is described by using FlowSpec.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateSkill' => [ + 'summary' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -11982,1394 +10557,5529 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '236780', - 'abilityTreeNodes' => [ - 'FEATUREdideHO4TQP', - 'FEATUREdide8FM783', - 'FEATUREdideQUQUVB', - 'FEATUREdideIQU97M', - ], + 'abilityTreeCode' => 'TBD', + 'abilityTreeNodes' => ['FEATUREdideYTM537'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'Name', '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, - 'example' => '10000', - ], + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => 'my-skill', 'title' => ''], ], [ - 'name' => 'Id', + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'example' => '数据分析技能', 'title' => ''], + ], + [ + 'name' => 'Visibility', 'in' => 'formData', 'schema' => [ - 'description' => 'The unique identifier of the Data Studio node.'."\n" - ."\n" - .'> This field is of the Long type in SDK versions prior to 8.0.0, and of the String type in SDK versions 8.0.0 and later. This change does not affect normal SDK usage; the parameter will still be returned according to the type defined in the SDK. However, compilation failures may occur due to the type change only when upgrading the SDK across version 8.0.0. In this case, you must manually update the data type.'."\n", 'type' => 'string', - 'required' => true, - 'example' => '652567824470354XXXX', + 'required' => false, + 'enum' => ['TENANT', 'PROJECT', 'USER'], + 'description' => '', + 'example' => 'TENANT', + 'title' => '', ], ], [ - 'name' => 'Spec', + 'name' => 'VersionNote', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'example' => '初版', 'title' => ''], + ], + [ + 'name' => 'SkillMdOverride', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'example' => '-', 'title' => ''], + ], + [ + 'name' => 'BundleUrl', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => false, 'description' => '', 'example' => 'https://example.com/skill.zip', 'title' => ''], + ], + [ + 'name' => 'Extra', + 'in' => 'formData', + 'style' => 'json', + 'schema' => ['type' => 'object', 'description' => '', 'required' => false, 'example' => '{"appId":"APP_CWJMV36CT9SAFW1QEHX7"}', 'title' => ''], + ], + [ + 'name' => 'VisibilityScope', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The unique identifier of the Data Studio node.'."\n" - ."\n" - .'> This field is of the Long type in SDK versions prior to 8.0.0, and of the String type in SDK versions 8.0.0 and later. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '{'."\n" - .' "version": "1.1.0",'."\n" - .' "kind": "Node",'."\n" - .' "spec": {'."\n" - .' "nodes": ['."\n" - .' {'."\n" - .' "id": "860438872620113XXXX",'."\n" - .' "recurrence": "Normal",'."\n" - .' "timeout": 0,'."\n" - .' "instanceMode": "T+1",'."\n" - .' "rerunMode": "Allowed",'."\n" - .' "rerunTimes": 3,'."\n" - .' "rerunInterval": 180000,'."\n" - .' "datasource": {'."\n" - .' "name": "odps_test",'."\n" - .' "type": "odps"'."\n" - .' },'."\n" - .' "script": {'."\n" - .' "path": "XX/OpenAPI_Test/odpsSQL_Test",'."\n" - .' "runtime": {'."\n" - .' "command": "ODPS_SQL"'."\n" - .' },'."\n" - .' "content": "select now();"'."\n" - .' },'."\n" - .' "trigger": {'."\n" - .' "type": "Scheduler",'."\n" - .' "cron": "00 00 00 * * ?",'."\n" - .' "startTime": "1970-01-01 00:00:00",'."\n" - .' "endTime": "9999-01-01 00:00:00",'."\n" - .' "timezone": "Asia/Shanghai",'."\n" - .' "delaySeconds": 0'."\n" - .' },'."\n" - .' "runtimeResource": {'."\n" - .' "resourceGroup": "S_res_group_XXXX_XXXX"'."\n" - .' },'."\n" - .' "name": "odpsSQL_Test",'."\n" - .' "inputs": {'."\n" - .' "nodeOutputs": ['."\n" - .' {'."\n" - .' "data": "lwttest_standard_root",'."\n" - .' "artifactType": "NodeOutput"'."\n" - .' }'."\n" - .' ]'."\n" - .' },'."\n" - .' "outputs": {'."\n" - .' "nodeOutputs": ['."\n" - .' {'."\n" - .' "data": "output_data",'."\n" - .' "artifactType": "NodeOutput",'."\n" - .' "refTableName": "odpsSQL_Test"'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .' }'."\n" - .' ],'."\n" - .' "flow": ['."\n" - .' {'."\n" - .' "nodeId": "860438872620113XXXX",'."\n" - .' "depends": ['."\n" - .' {'."\n" - .' "type": "Normal",'."\n" - .' "output": "project_root"'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .'}', + 'type' => 'object', + 'properties' => [ + 'ProjectIds' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => '12345', 'title' => ''], + 'description' => '', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'UserIds' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'required' => false, 'example' => '123456', 'title' => ''], + 'description' => '', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID. You can troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => '99EBE7CF-69C0-5089-BE3E-79563C31XXXX', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => '824F80BA-1778-5D8A-BAFF-668A4D9C4CC7'], + 'Skill' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['type' => 'string', 'description' => '', 'example' => 'my-skill', 'title' => ''], + 'GmtCreateTime' => ['type' => 'string', 'format' => 'iso8601', 'description' => '', 'example' => '1780555634000', 'title' => ''], + 'CreatorId' => ['type' => 'string', 'description' => '', 'example' => '123456', 'title' => ''], + 'ModifierId' => ['type' => 'string', 'description' => '', 'example' => '123456', 'title' => ''], + 'Description' => ['type' => 'string', 'description' => '', 'example' => '数据分析技能', 'title' => ''], + 'Visibility' => ['type' => 'string', 'description' => '', 'example' => 'TENANT', 'title' => ''], + 'VisibilityScope' => [ + 'type' => 'object', + 'properties' => [ + 'ProjectIds' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'example' => '123456', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'UserIds' => [ + 'type' => 'array', + 'items' => ['type' => 'string', 'description' => '', 'example' => '123456', 'title' => ''], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'Body' => ['type' => 'string', 'description' => '', 'example' => '-', 'title' => ''], + 'GmtModifiedTime' => ['type' => 'string', 'format' => 'iso8601', 'description' => '', 'example' => '12345678901', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '', + 'description' => '## 请求说明'."\n" + .'- `SkillMdOverride` 与 `BundleUrl` 参数二选一，必须提供其中之一。'."\n" + .'- `Visibility` 可设置为 `TENANT`、`PROJECT` 或 `USER`，分别表示账号内可见、指定项目可见或指定用户可见。'."\n" + .'- 当 `Visibility` 设置为 `PROJECT` 时，需要通过 `VisibilityScope.ProjectIds` 指定可见的项目 ID 列表；当设置为 `USER` 时，则需通过 `VisibilityScope.UserIds` 指定可见的用户 ID 列表。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"99EBE7CF-69C0-5089-BE3E-79563C31****\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'UpdateNode', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"824F80BA-1778-5D8A-BAFF-668A4D9C4CC7\\",\\n \\"Skill\\": {\\n \\"Name\\": \\"my-skill\\",\\n \\"GmtCreateTime\\": \\"1780555634000\\",\\n \\"CreatorId\\": \\"123456\\",\\n \\"ModifierId\\": \\"123456\\",\\n \\"Description\\": \\"数据分析技能\\",\\n \\"Visibility\\": \\"TENANT\\",\\n \\"VisibilityScope\\": {\\n \\"ProjectIds\\": [\\n \\"123456\\"\\n ],\\n \\"UserIds\\": [\\n \\"123456\\"\\n ]\\n },\\n \\"Body\\": \\"-\\",\\n \\"GmtModifiedTime\\": \\"12345678901\\"\\n }\\n}","type":"json"}]', ], - 'MoveNode' => [ - 'summary' => 'Moves a node to a path in DataStudio.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateUdfFile' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '236795', - 'abilityTreeNodes' => [ - 'FEATUREdideHO4TQP', - 'FEATUREdide8FM783', - 'FEATUREdideQUQUVB', - 'FEATUREdideIQU97M', - ], + 'operationType' => 'create', + 'abilityTreeCode' => '269313', + 'abilityTreeNodes' => ['FEATUREdide8FM783'], ], 'parameters' => [ + [ + 'name' => 'FileFolderPath', + 'in' => 'formData', + 'schema' => ['description' => 'The path to the folder containing the function file.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Business_process/First_Business_Process/function/string_processing', '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" - ."\n" - .'You can use this parameter to specify the DataWorks workspace on which you want to perform the API operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10000', - ], + 'schema' => ['description' => 'The DataWorks workspace ID. To find this, click the wrench icon in the upper-right corner and navigate to the workspace management page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10000', 'title' => ''], ], [ - 'name' => 'Id', + 'name' => 'FileName', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the node.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '652567824470354XXXX', - ], + 'schema' => ['description' => 'The function name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'StringConcat', 'title' => ''], ], [ - 'name' => 'Path', + 'name' => 'FunctionType', 'in' => 'formData', 'schema' => [ - 'description' => 'The unique identifier of the Data Studio node.'."\n" - ."\n" - .'> This field is of the Long type in SDK versions prior to 8.0.0, and of the String type in SDK versions 8.0.0 and later. This change does not affect normal SDK usage; the parameter will still be returned according to the type defined in the SDK. However, compilation failures may occur due to the type change only when upgrading the SDK across version 8.0.0. In this case, you must manually update the data type.'."\n", + 'description' => 'The function category, corresponding to the function type field in the Create Function form. Valid values: MATH (mathematical functions), AGGREGATE (aggregate functions), STRING (string processing functions), DATE (date processing functions), ANALYTIC (window functions), and OTHER (other functions).', 'type' => 'string', 'required' => true, - 'example' => 'root/demo', + 'docRequired' => true, + 'enum' => ['MATH', 'AGGREGATE', 'STRING', 'DATE', 'ANALYTIC', 'OTHER'], + 'example' => 'STRING', + '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' => 'C99E2BE6-9DEA-5C2E-8F51-1DDCFEADXXXX', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], + [ + 'name' => 'ClassName', + 'in' => 'formData', + 'schema' => ['description' => 'The class name where the function is defined, corresponding to the class name field in the Create Function form.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'com.alibaba.DataWorks.api.udf.StringConcat', 'title' => ''], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C99E2BE6-9DEA-5C2E-8F51-1DDCFEADXXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'MoveNode', - ], - 'RenameNode' => [ - 'summary' => 'Renames a node in DataStudio.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'Resources', + 'in' => 'formData', + 'schema' => ['description' => 'A comma-separated list of resource names referenced by the function, corresponding to the resource list field in the Create Function form.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'string-concat-1.0.0.jar,commons-lang-2.6.jar', 'title' => ''], ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '236794', - 'abilityTreeNodes' => [ - 'FEATUREdideHO4TQP', - 'FEATUREdide8FM783', - 'FEATUREdideQUQUVB', - 'FEATUREdideIQU97M', + [ + 'name' => 'UdfDescription', + 'in' => 'formData', + 'schema' => ['description' => 'The function purpose description, corresponding to the description field in the Create Function form.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'Concatenate several strings to generate a new string', 'title' => ''], ], - ], - 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'CmdDescription', '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, - 'example' => '12345', - ], + 'schema' => ['description' => 'The command format for invoking the function, corresponding to the command format field in the Create Function form.', 'type' => 'string', 'required' => false, 'example' => 'StringConcat(String... substrs)', 'title' => ''], ], [ - 'name' => 'Id', + 'name' => 'ParameterDescription', 'in' => 'formData', - 'schema' => [ - 'description' => 'The unique identifier of the Data Studio node.'."\n" - ."\n" - .'> This field is of the Long type in SDK versions prior to 8.0.0, and of the String type in SDK versions 8.0.0 and later. This change does not affect normal SDK usage; the parameter will still be returned according to the type defined in the SDK. However, compilation failures may occur due to the type change only when upgrading the SDK across version 8.0.0. In this case, you must manually update the data type.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '652567824470354XXXX', - ], + 'schema' => ['description' => 'The function parameter description, corresponding to the parameter description field in the Create Function form.', 'type' => 'string', 'required' => false, 'default' => '', 'example' => 'List of strings to be connected', 'title' => ''], ], [ - 'name' => 'Name', + 'name' => 'ReturnValue', 'in' => 'formData', - 'schema' => [ - 'description' => 'The unique identifier of the Data Studio node.'."\n" - ."\n" - .'> This field is of the Long type in SDK versions prior to 8.0.0, and of the String type in SDK versions 8.0.0 and later. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Rename', - ], + 'schema' => ['description' => 'The return value description, corresponding to the return value field in the Create Function form.', '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' => 'An example demonstrating how to call the function, corresponding to the example field in the Create Function form.', 'type' => 'string', 'required' => false, 'example' => 'StringConcat(\'a\', \'b\', \'c\')', 'title' => ''], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => ['description' => 'The unique identifier of the DataWorks workspace, which is the identifier at the top of the Data Studio page where you switch workspaces.', 'type' => 'string', 'required' => false, 'example' => 'dw_project', 'title' => ''], + ], + [ + 'name' => 'CreateFolderIfNotExists', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to automatically create the directory if the specified path (FileFolderPath) does not exist. Valid values:'."\n" + ."\n" + .'- true: Automatically creates the directory if it does not exist.'."\n" + ."\n" + .'- false: The call fails if the directory does not exist.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '4CDF7B72-020B-542A-8465-21CFFA81XXXX', - ], - '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.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The file ID after successful creation.', 'type' => 'integer', 'format' => 'int64', 'example' => '100000002', 'title' => ''], + 'RequestId' => ['description' => 'The unique ID for this request. Use this ID for troubleshooting if an error occurs.', '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 succeeded.'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4CDF7B72-020B-542A-8465-21CFFA81XXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'RenameNode', - ], - 'GetNode' => [ - 'summary' => 'Queries the information about a node in DataStudio.', - '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.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', + '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"}]', + 'title' => 'CreateUdfFile', + 'summary' => 'Creates a file for a function in DataStudio.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'CreateWorkflowDefinition' => [ + 'summary' => 'Creates a workflow in a directory of DataStudio.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '236761', - 'abilityTreeNodes' => [ - 'FEATUREdideHO4TQP', - 'FEATUREdide8FM783', - 'FEATUREdideQUQUVB', - 'FEATUREdideIQU97M', - ], + 'abilityTreeCode' => '234974', + 'abilityTreeNodes' => ['FEATUREdideHO4TQP', 'FEATUREdide8FM783', 'FEATUREdideQUQUVB', 'FEATUREdideIQU97M'], ], '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' => false, - 'example' => '10000', - ], + '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' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000', 'title' => ''], ], [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => 'The unique identifier of the Data Studio node.'."\n" - ."\n" - .'> This field is of type Long in SDK versions prior to 8.0.0, and of type String in SDK version 8.0.0 and later. This change does not affect the normal use of the SDK; parameters are still returned according to the type defined in the SDK. Compilation failures due to the type change may occur only when upgrading the SDK across version 8.0.0, in which case users need to manually correct the data type.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '860438872620113XXXX', - ], + 'name' => 'Spec', + 'in' => 'formData', + 'schema' => ['description' => 'The FlowSpec field information about the workflow. For more information, see [FlowSpec](https://github.com/aliyun/alibabacloud-dataworks-tool-dflow/).', 'type' => 'string', 'required' => true, 'example' => '{'."\n" + .' "kind": "CycleWorkflow",'."\n" + .' "version": "1.1.0",'."\n" + .' "spec": {'."\n" + .' "name": "OpenAPITestWorkflowDemo",'."\n" + .' "type": "CycleWorkflow",'."\n" + .' "workflows": ['."\n" + .' {'."\n" + .' "script": {'."\n" + .' "path": "XX/OpenAPITest/WorkflowTest/OpenAPITestWorkflowDemo",'."\n" + .' "runtime": {'."\n" + .' "command": "WORKFLOW"'."\n" + .' }'."\n" + .' },'."\n" + .' "trigger": {'."\n" + .' "type": "Scheduler",'."\n" + .' "cron": "00 02 00 * * ?",'."\n" + .' "startTime": "1970-01-01 00:00:00",'."\n" + .' "endTime": "9999-01-01 00:00:00",'."\n" + .' "timezone": "Asia/Shanghai",'."\n" + .' "delaySeconds": 0'."\n" + .' },'."\n" + .' "strategy": {'."\n" + .' "timeout": 0,'."\n" + .' "instanceMode": "T+1",'."\n" + .' "rerunMode": "Allowed",'."\n" + .' "rerunTimes": 3,'."\n" + .' "rerunInterval": 180000,'."\n" + .' "failureStrategy": "Break"'."\n" + .' },'."\n" + .' "name": "OpenAPITestWorkflowDemo",'."\n" + .' "outputs": {'."\n" + .' "nodeOutputs": ['."\n" + .' {'."\n" + .' "data": "workflow_output",'."\n" + .' "artifactType": "NodeOutput",'."\n" + .' "refTableName": "OpenAPITestWorkflowDemo"'."\n" + .' }'."\n" + .' ]'."\n" + .' },'."\n" + .' "dependencies": []'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .'}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX', - ], - 'Node' => [ - 'description' => 'Data Studio node details.'."\n", - 'type' => 'object', - 'properties' => [ - 'ProjectId' => [ - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000', - ], - 'Name' => [ - 'description' => 'The name of the node.'."\n", - 'type' => 'string', - 'example' => 'Node name', - ], - 'Owner' => [ - 'description' => 'The owner of the node.'."\n", - 'type' => 'string', - 'example' => '196596664824XXXX', - ], - 'CreateTime' => [ - 'description' => 'The time when the node was created. This value is a UNIX timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1700539206000', - ], - 'ModifyTime' => [ - 'description' => 'The time when the node was last modified. This value is a UNIX timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1700539206000', - ], - 'Spec' => [ - 'description' => 'The FlowSpec field information about this node. For more information, see [FlowSpec](https://github.com/aliyun/alibabacloud-dataworks-tool-dflow).'."\n", - 'type' => 'string', - 'example' => '{'."\n" - .' "version": "1.1.0",'."\n" - .' "kind": "Node",'."\n" - .' "spec": {'."\n" - .' "nodes": ['."\n" - .' {'."\n" - .' "recurrence": "Normal",'."\n" - .' "id": "860438872620113XXXX",'."\n" - .' "timeout": 0,'."\n" - .' "instanceMode": "T+1",'."\n" - .' "rerunMode": "Allowed",'."\n" - .' "rerunTimes": 3,'."\n" - .' "rerunInterval": 180000,'."\n" - .' "datasource": {'."\n" - .' "name": "odps_test",'."\n" - .' "type": "odps"'."\n" - .' },'."\n" - .' "script": {'."\n" - .' "language": "odps-sql",'."\n" - .' "path": "XX/OpenAPI_Test/ODPS_SQL_Test",'."\n" - .' "runtime": {'."\n" - .' "command": "ODPS_SQL",'."\n" - .' "commandTypeId": 10'."\n" - .' },'."\n" - .' "content": "select now();",'."\n" - .' "id": "853573334108680XXXX"'."\n" - .' },'."\n" - .' "trigger": {'."\n" - .' "type": "Scheduler",'."\n" - .' "id": "543680677872062XXXX",'."\n" - .' "cron": "00 00 00 * * ?",'."\n" - .' "startTime": "1970-01-01 00:00:00",'."\n" - .' "endTime": "9999-01-01 00:00:00",'."\n" - .' "timezone": "Asia/Shanghai",'."\n" - .' "delaySeconds": 0'."\n" - .' },'."\n" - .' "runtimeResource": {'."\n" - .' "resourceGroup": "S_res_group_XXXX_XXXX",'."\n" - .' "id": "623731286945488XXXX",'."\n" - .' "resourceGroupId": "7201XXXX"'."\n" - .' },'."\n" - .' "name": "ODPS_SQL_Test",'."\n" - .' "owner": "110755000425XXXX",'."\n" - .' "metadata": {'."\n" - .' "owner": "110755000425XXXX",'."\n" - .' "ownerName": "XXXXX@test.XXX.com",'."\n" - .' "projectId": "307XXX"'."\n" - .' },'."\n" - .' "inputs": {'."\n" - .' "nodeOutputs": ['."\n" - .' {'."\n" - .' "data": "lwttest_standard_root",'."\n" - .' "artifactType": "NodeOutput"'."\n" - .' }'."\n" - .' ]'."\n" - .' },'."\n" - .' "outputs": {'."\n" - .' "nodeOutputs": ['."\n" - .' {'."\n" - .' "data": "860438872620113XXXX",'."\n" - .' "artifactType": "NodeOutput",'."\n" - .' "refTableName": "ODPS_SQL_Test",'."\n" - .' "isDefault": true'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .' }'."\n" - .' ],'."\n" - .' "flow": ['."\n" - .' {'."\n" - .' "nodeId": "860438872620113XXXX",'."\n" - .' "depends": ['."\n" - .' {'."\n" - .' "type": "Normal",'."\n" - .' "output": "lwttest_standard_root"'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .' ]'."\n" - .' },'."\n" - .' "metadata": {'."\n" - .' "uuid": "860438872620113XXXX"'."\n" - .' }'."\n" - .'}', - ], - 'TaskId' => [ - 'description' => 'The ID of the corresponding scheduling task after the node is published.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '700006680527', - ], - 'Id' => [ - 'description' => 'The unique identifier of the Data Studio node.'."\n" - ."\n" - .'> Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.'."\n", - 'type' => 'string', - 'example' => '860438872620113XXXX'."\n", - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0EF298E5-0940-5AC7-9CB0-6502507****'], + 'Id' => ['description' => 'The unique identifier of the workflow.'."\n" + ."\n" + .'> This field is of the Long type in SDK versions prior to 8.0.0, and of the String type in SDK versions 8.0.0 and later. This change does not affect normal SDK usage; the parameter will still be returned according to the type defined in the SDK. However, compilation failures may occur due to the type change only when upgrading the SDK across version 8.0.0. In this case, you must manually update the data type.', 'type' => 'string', 'example' => '463497880880954XXXX', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0EF298E5-0940-5AC7-9CB0-6502507****\\",\\n \\"Id\\": \\"463497880880954XXXX\\"\\n}","type":"json"}]', + 'title' => 'CreateWorkflowDefinition', + 'description' => '>'."\n" + ."\n" + .'This API does not support batch operations. If you define more than one workflow definition in the FlowSpec, all workflow definitions except the first one are ignored. In addition, nodes defined within the workflow definition are also ignored. Call the CreateNode API to create internal nodes one by one.'."\n" + ."\n" + .'>', + 'changeSet' => [ + ['createdAt' => '2025-01-13T07:36:02.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"Node\\": {\\n \\"ProjectId\\": 10000,\\n \\"Name\\": \\"Node name\\",\\n \\"Owner\\": \\"196596664824XXXX\\",\\n \\"CreateTime\\": 1700539206000,\\n \\"ModifyTime\\": 1700539206000,\\n \\"Spec\\": \\"{\\\\n \\\\\\"version\\\\\\": \\\\\\"1.1.0\\\\\\",\\\\n \\\\\\"kind\\\\\\": \\\\\\"Node\\\\\\",\\\\n \\\\\\"spec\\\\\\": {\\\\n \\\\\\"nodes\\\\\\": [\\\\n {\\\\n \\\\\\"recurrence\\\\\\": \\\\\\"Normal\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"860438872620113XXXX\\\\\\",\\\\n \\\\\\"timeout\\\\\\": 0,\\\\n \\\\\\"instanceMode\\\\\\": \\\\\\"T+1\\\\\\",\\\\n \\\\\\"rerunMode\\\\\\": \\\\\\"Allowed\\\\\\",\\\\n \\\\\\"rerunTimes\\\\\\": 3,\\\\n \\\\\\"rerunInterval\\\\\\": 180000,\\\\n \\\\\\"datasource\\\\\\": {\\\\n \\\\\\"name\\\\\\": \\\\\\"odps_test\\\\\\",\\\\n \\\\\\"type\\\\\\": \\\\\\"odps\\\\\\"\\\\n },\\\\n \\\\\\"script\\\\\\": {\\\\n \\\\\\"language\\\\\\": \\\\\\"odps-sql\\\\\\",\\\\n \\\\\\"path\\\\\\": \\\\\\"XX/OpenAPI_Test/ODPS_SQL_Test\\\\\\",\\\\n \\\\\\"runtime\\\\\\": {\\\\n \\\\\\"command\\\\\\": \\\\\\"ODPS_SQL\\\\\\",\\\\n \\\\\\"commandTypeId\\\\\\": 10\\\\n },\\\\n \\\\\\"content\\\\\\": \\\\\\"select now();\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"853573334108680XXXX\\\\\\"\\\\n },\\\\n \\\\\\"trigger\\\\\\": {\\\\n \\\\\\"type\\\\\\": \\\\\\"Scheduler\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"543680677872062XXXX\\\\\\",\\\\n \\\\\\"cron\\\\\\": \\\\\\"00 00 00 * * ?\\\\\\",\\\\n \\\\\\"startTime\\\\\\": \\\\\\"1970-01-01 00:00:00\\\\\\",\\\\n \\\\\\"endTime\\\\\\": \\\\\\"9999-01-01 00:00:00\\\\\\",\\\\n \\\\\\"timezone\\\\\\": \\\\\\"Asia/Shanghai\\\\\\",\\\\n \\\\\\"delaySeconds\\\\\\": 0\\\\n },\\\\n \\\\\\"runtimeResource\\\\\\": {\\\\n \\\\\\"resourceGroup\\\\\\": \\\\\\"S_res_group_XXXX_XXXX\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"623731286945488XXXX\\\\\\",\\\\n \\\\\\"resourceGroupId\\\\\\": \\\\\\"7201XXXX\\\\\\"\\\\n },\\\\n \\\\\\"name\\\\\\": \\\\\\"ODPS_SQL_Test\\\\\\",\\\\n \\\\\\"owner\\\\\\": \\\\\\"110755000425XXXX\\\\\\",\\\\n \\\\\\"metadata\\\\\\": {\\\\n \\\\\\"owner\\\\\\": \\\\\\"110755000425XXXX\\\\\\",\\\\n \\\\\\"ownerName\\\\\\": \\\\\\"XXXXX@test.XXX.com\\\\\\",\\\\n \\\\\\"projectId\\\\\\": \\\\\\"307XXX\\\\\\"\\\\n },\\\\n \\\\\\"inputs\\\\\\": {\\\\n \\\\\\"nodeOutputs\\\\\\": [\\\\n {\\\\n \\\\\\"data\\\\\\": \\\\\\"lwttest_standard_root\\\\\\",\\\\n \\\\\\"artifactType\\\\\\": \\\\\\"NodeOutput\\\\\\"\\\\n }\\\\n ]\\\\n },\\\\n \\\\\\"outputs\\\\\\": {\\\\n \\\\\\"nodeOutputs\\\\\\": [\\\\n {\\\\n \\\\\\"data\\\\\\": \\\\\\"860438872620113XXXX\\\\\\",\\\\n \\\\\\"artifactType\\\\\\": \\\\\\"NodeOutput\\\\\\",\\\\n \\\\\\"refTableName\\\\\\": \\\\\\"ODPS_SQL_Test\\\\\\",\\\\n \\\\\\"isDefault\\\\\\": true\\\\n }\\\\n ]\\\\n }\\\\n }\\\\n ],\\\\n \\\\\\"flow\\\\\\": [\\\\n {\\\\n \\\\\\"nodeId\\\\\\": \\\\\\"860438872620113XXXX\\\\\\",\\\\n \\\\\\"depends\\\\\\": [\\\\n {\\\\n \\\\\\"type\\\\\\": \\\\\\"Normal\\\\\\",\\\\n \\\\\\"output\\\\\\": \\\\\\"lwttest_standard_root\\\\\\"\\\\n }\\\\n ]\\\\n }\\\\n ]\\\\n },\\\\n \\\\\\"metadata\\\\\\": {\\\\n \\\\\\"uuid\\\\\\": \\\\\\"860438872620113XXXX\\\\\\"\\\\n }\\\\n}\\",\\n \\"TaskId\\": 700006680527,\\n \\"Id\\": \\"860438872620113XXXX\\\\n\\"\\n }\\n}","type":"json"}]', - 'title' => 'GetNode', - ], - 'ListNodes' => [ - 'summary' => 'Queries a list of nodes in DataStudio. You can also specify filter conditions to query specific nodes.', - 'methods' => [ - 'get', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'CreateWorkflowInstances' => [ + 'summary' => 'Creates a workflow instance, such as a data backfill workflow instance, based on configurations.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '236792', - 'abilityTreeNodes' => [ - 'FEATUREdideHO4TQP', - ], + 'abilityTreeCode' => '259200', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB', 'FEATUREdideD0YY7B', 'FEATUREdideVFMENL'], ], '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, - 'example' => '12345', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '100', 'title' => ''], ], [ - 'name' => 'Scene', - 'in' => 'query', + 'name' => 'EnvType', + 'in' => 'formData', 'schema' => [ - 'description' => 'The location of the nodes in the left-side navigation pane of the Data Studio page, which is a filter condition. If you do not want to use this condition for filtering, you do not need to configure this parameter. Valid values:'."\n" + 'description' => 'The project environment. Valid values:'."\n" ."\n" - .'* DataworksProject'."\n" - .'* DataworksManualWorkflow'."\n" - .'* DataworksManualTask'."\n", + .'- Prod'."\n" + ."\n" + .'- Dev', + 'enumValueTitles' => [], 'type' => 'string', + 'default' => 'Prod', + 'enum' => ['Prod', 'Dev'], 'required' => false, - 'enumValueTitles' => [], - 'example' => 'DATAWORKS_PROJECT', + 'example' => 'Prod', + 'title' => '', ], ], [ - 'name' => 'ContainerId', - 'in' => 'query', - 'schema' => [ - 'description' => 'Leave this parameter empty if not specified. Filter condition: within a specified container. Specify the container ID. This parameter is independent of the resource group ID (ResourceGroupId).'."\n" - ."\n" - .'> Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '860438872620113XXXX', - ], + 'name' => 'WorkflowId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the workflow to which the instance belongs. This parameter is set to 1 for auto triggered tasks.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Recurrence', - 'in' => 'query', + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['description' => 'The name.', 'type' => 'string', 'required' => true, 'example' => 'WorkflowInstance1', 'title' => ''], + ], + [ + 'name' => 'Periods', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'Leave this parameter empty if not specified. Filter condition: within a specified container. Specify the container ID. This parameter is independent of the resource group ID (ResourceGroupId).'."\n" - ."\n" - .'> Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.'."\n", - 'type' => 'string', + 'description' => 'The configuration of the data backfilling period.', + 'type' => 'object', + 'properties' => [ + 'BizDates' => [ + 'description' => 'The data timestamps. You can specify up to seven data timestamps.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StartBizDate' => ['description' => 'The data timestamp at which the data starts to be backfilled. Configure this parameter in the `yyyy-mm-dd` format.', 'type' => 'string', 'required' => true, 'example' => '2024-11-20', 'title' => ''], + 'EndBizDate' => ['description' => 'The data timestamp at which data is no longer backfilled. Configure this parameter in the `yyyy-mm-dd` format.', 'type' => 'string', 'required' => true, 'example' => '2024-11-24', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'title' => '', + 'example' => '', + ], + 'StartTime' => ['description' => 'The start time of data backfill. Configure this parameter in the `hh:mm:ss` format. The time must be in the 24-hour clock. Default value: 00:00:00.'."\n" + ."\n" + .'If you configure this parameter, you must also configure the EndTime parameter.', 'type' => 'string', 'required' => false, 'example' => '00:00:00', 'title' => ''], + 'EndTime' => ['description' => 'The end time of data backfill. Configure this parameter in the `hh:mm:ss` format. The time must be in the 24-hour clock. Default value: 23:59:59.'."\n" + ."\n" + .'If you configure this parameter, you must also configure the StartTime parameter.', 'type' => 'string', 'required' => false, 'example' => '23:59:59', 'title' => ''], + ], 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Normal', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'RerunMode', - 'in' => 'query', + 'name' => 'Type', + 'in' => 'formData', 'schema' => [ - 'description' => 'The rerun property, which is a filter condition. If you do not want to use this condition for filtering, you do not need to configure this parameter. Valid values:'."\n" + 'description' => 'The type of the workflow instance. Valid values:'."\n" ."\n" - .'* Allowed: The nodes can be rerun regardless of whether they are successfully run or fail to run.'."\n" - .'* FailureAllowed: The nodes can be rerun only after they fail to run.'."\n" - .'* Denied: The nodes cannot be rerun regardless of whether they are successfully run or fail to run.'."\n", - 'type' => 'string', - 'required' => false, + .'- SupplementData: Data backfill. The usage of RootTaskIds and IncludeTaskIds varies based on the backfill mode. See the description of the DefaultRunProperties.Mode parameter.'."\n" + ."\n" + .'- ManualWorkflow: Manually triggered workflow. WorkflowId is required for a manual workflow. RootTaskIds is optional. If not specified, the system uses the default root task list of the manual workflow.'."\n" + ."\n" + .'- Manual: Manual task. You only need to specify RootTaskIds. This is the list of manual tasks to run.'."\n" + ."\n" + .'- SmokeTest: Smoke test. You only need to specify RootTaskIds. This is the list of test tasks to run.'."\n" + ."\n" + .'- TriggerWorkflow: Triggered Workflow You must specify the WorkflowId of the triggered workflow. IncludeTaskIds is optional. If you do not specify IncludeTaskIds, the entire workflow runs.', 'enumValueTitles' => [], - 'example' => 'Allowed', + 'type' => 'string', + 'required' => true, + 'enum' => ['ManualWorkflow', 'SupplementData', 'Manual', 'SmokeTest', 'TriggerWorkflow'], + 'example' => 'SupplementData', + 'title' => '', ], ], [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the node. Fuzzy search is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'name' => 'WorkflowParameters', + 'in' => 'formData', + 'schema' => ['description' => 'The workflow parameters. This parameter takes effect when a specific workflow is specified (`WorkflowId != 1`). For scheduled workflows and triggered workflows, the format is key=value, and these parameters have lower priority than task parameters. For manual workflows, the format is JSON, and these parameters have higher priority than task parameters.', 'type' => 'string', 'required' => false, 'example' => '"key=value" format:'."\n" + .'key1=value1 key2=value2'."\n" + .'JSON format:'."\n" + .'{"key1":"value1", "key2": "value2"}', 'title' => ''], ], [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number of the data to retrieve, used for pagination.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'name' => 'TaskParameters', + 'in' => 'formData', + 'schema' => ['description' => 'The task-specific parameters. The value is in the JSON format. The key specifies the task ID. You can call the GetTask operation to obtain the format of the value by querying the script parameters.', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "1001": "key1=val2 key2=val2", '."\n" + .' "1002": "key1=val2 key2=val2"'."\n" + .'}', 'title' => ''], ], [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number of the data to retrieve, used for pagination.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '10', - 'example' => '10', - 'default' => '10', - ], + 'name' => 'AutoStartEnabled', + 'in' => 'formData', + 'schema' => ['description' => 'The default value is true.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'DefaultRunProperties', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The runtime configuration.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", + 'RootTaskIds' => [ + 'description' => 'The list of root task IDs.'."\n" + ."\n" + .'- When Type is set to SupplementData, RootTaskIds is required unless Mode is set to Chain.'."\n" + ."\n" + .'- When Type is set to ManualWorkflow, RootTaskIds is optional. If it is not specified, the default root nodes of the manual workflow are used.'."\n" + ."\n" + .'- When Type is set to Manual, RootTaskIds is required and specifies the list of manual tasks to run.'."\n" + ."\n" + .'- When Type is set to SmokeTest, RootTaskIds is required and specifies the list of test tasks to run.', + 'type' => 'array', + 'items' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'IncludeTaskIds' => [ + 'description' => 'The IDs of the tasks to run.', + 'type' => 'array', + 'items' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'ExcludeTaskIds' => [ + 'description' => 'The IDs of the tasks not to run.', + 'type' => 'array', + 'items' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '4321', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'IncludeProjectIds' => [ + 'description' => 'The IDs of the projects to run.', + 'type' => 'array', + 'items' => ['description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'ExcludeProjectIds' => [ + 'description' => 'The IDs of the projects not to run.', + 'type' => 'array', + 'items' => ['description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '200', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Mode' => [ + 'description' => 'The data backfill mode. Default value: ManualSelection. Required when Type is set to SupplementData.'."\n" + ."\n" + .'- General: You can specify only one value for `RootTaskIds`. The `IncludeTaskIds` parameter is optional. If it\'s not specified, it defaults to including `RootTaskIds`.'."\n" + ."\n" + .'- ManualSelection: You can specify multiple values for `RootTaskIds`. The `IncludeTaskIds` parameter is optional. If it is not specified, it defaults to including `RootTaskIds`.'."\n" + ."\n" + .'- Chain: If you set the Mode parameter to Chain, leave the `RootTaskIds` parameter empty and set the `IncludeTaskIds` parameter to the start task ID and the end task ID.'."\n" + ."\n" + .'- AllDownstream: Only one `RootTaskId` can be specified.', + 'enumValueTitles' => [], 'type' => 'string', - 'example' => '2197B9C4-39CE-55EA-8EEA-FDBAE52DXXXX', + 'default' => 'ManualSelection', + 'enum' => ['General', 'ManualSelection', 'Chain', 'AllDownstream', 'Huge'], + 'required' => false, + 'example' => 'ManualSelection', + 'title' => '', ], - 'PagingInfo' => [ - 'description' => 'The pagination information.'."\n", + 'Analysis' => [ + 'description' => 'The analysis configuration. Required when Type = SupplementData.', + 'type' => 'object', + 'properties' => [ + 'Enabled' => ['description' => 'Specifies whether to enable the analysis feature. Required when Type = SupplementData.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'Blocked' => ['description' => 'Specifies whether to block execution if the analysis fails. Required when Type = SupplementData.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'RunPolicy' => [ + 'description' => 'The run policy. If the parameter is left empty, the task configuration is used.', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", + 'StartTime' => ['description' => 'The start time of running. Configure this parameter in the `hh:mm:ss` format (24-hour clock). This parameter is required if you configure the RunPolicy parameter.', 'type' => 'string', 'required' => false, 'example' => '00:00:00', 'title' => ''], + 'EndTime' => ['description' => 'The end time of running. Configure this parameter in the `hh:mm:ss` format (24-hour clock). This parameter is required if you configure the RunPolicy parameter. Valid values:', 'type' => 'string', 'required' => false, 'example' => '23:59:59', 'title' => ''], + 'Type' => [ + 'description' => 'The time period type. This parameter is required if you configure the RunPolicy parameter. Valid values:'."\n" + ."\n" + .'- Daily'."\n" + ."\n" + .'- Weekend', + 'enumValueTitles' => [], 'type' => 'string', - 'example' => '42', + 'required' => false, + 'enum' => ['Daily', 'Weekend'], + 'title' => '', + 'example' => 'Daily', ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", + 'Immediately' => ['description' => 'Specifies whether a task whose scheduled run time is in the future can be run immediately. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Alert' => [ + 'description' => 'The alert settings.', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The alerting policy. Valid values:'."\n" + ."\n" + .'- Success: Alerts on success.'."\n" + ."\n" + .'- Failure: Alerts on failure.'."\n" + ."\n" + .'- SuccessFailure: Alerts on both success and failure.', + 'enumValueTitles' => [], 'type' => 'string', - 'example' => '10', + 'enum' => ['Success', 'Failure', 'SuccessFailure'], + 'title' => '', + 'required' => false, + 'example' => 'Succes', ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", + 'NoticeType' => [ + 'description' => 'The alert notification method. Valid values:'."\n" + ."\n" + .'- Sms: SMS only.'."\n" + ."\n" + .'- Mail: Mail only.'."\n" + ."\n" + .'- SmsMail: SMS and mail.', + 'enumValueTitles' => [], 'type' => 'string', - 'example' => '1', + 'enum' => ['Sms', 'Mail', 'SmsMail'], + 'title' => '', + 'required' => false, + 'example' => 'Sms', ], - 'Nodes' => [ - 'description' => 'The list of nodes in Data Studio.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Information about nodes in Data Studio.'."\n", - 'type' => 'object', - 'properties' => [ - 'Description' => [ - 'title' => '描述', - 'description' => 'The description of the node.'."\n", - 'type' => 'string', - 'example' => 'Node description'."\n", - ], - 'Name' => [ - 'title' => '节点名', - 'description' => 'The name of the node.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'ProjectId' => [ - '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', - 'deprecated' => false, - 'example' => '33233', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Parallelism' => ['description' => 'The task concurrency. Values from 2 to 10 indicate concurrency. A value of 1 indicates sequential execution. Required when Type = SupplementData.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'title' => '', 'example' => '2'], + 'Order' => [ + 'description' => 'The execution order. Default value: Asc.'."\n" + ."\n" + .'- Asc: ascending by business date.'."\n" + ."\n" + .'- Desc: descending by business date.', + 'enumValueTitles' => [], + 'type' => 'string', + 'default' => 'Asc', + 'enum' => ['Asc', 'Desc'], + 'title' => '', + 'required' => false, + 'example' => 'Asc', + ], + 'RuntimeResource' => ['description' => 'The custom scheduling resource group ID. If left empty, the task configuration is used.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX'], + 'Priority' => ['description' => 'The execution priority, range: 1–11. A higher value indicates higher priority.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1'], + 'PriorityWeightStrategy' => [ + 'description' => 'The priority weighting policy.'."\n" + ."\n" + .'- `Disable` (default): Do not enable.'."\n" + ."\n" + .'- `Upstream`: The priority is based on the total weight of upstream nodes. The deeper the hierarchy, the higher the weight.', + 'type' => 'string', + 'enum' => ['Disable', 'Upstream'], + 'required' => false, + 'example' => 'Upstream', + 'title' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => ['description' => 'The reason for the creation.', 'type' => 'string', 'required' => false, 'example' => 'create for test', 'title' => ''], + ], + [ + 'name' => 'Tags', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The task tag list.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'tagValue', 'title' => ''], + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'tagKey', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'TagCreationPolicy', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The tag creation policy. Valid values:'."\n" + ."\n" + .'- Append: New tags are added on top of the existing tags of the manual workflow.'."\n" + ."\n" + .'- Overwrite: Existing tags of the manual workflow are not inherited. New tags are created directly.', + 'type' => 'string', + 'enum' => ['Append', 'Overwrite'], + 'required' => false, + 'example' => 'Append', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request. It is used to locate logs and troubleshoot problems.', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX', 'title' => ''], + 'OperationId' => ['description' => 'The ID of the operation. You can use this field to query the results of the creation operation through the GetCreateWorkflowInstancesResult interface.', 'type' => 'string', 'example' => 'e15ad21c-b0e9-4792-8f55-b037xxxxxxxx', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"OperationId\\": \\"e15ad21c-b0e9-4792-8f55-b037xxxxxxxx\\"\\n}","type":"json"}]', + 'title' => 'CreateWorkflowInstances', + 'description' => 'DataWorks Basic Edition or higher is required.', + 'changeSet' => [ + ['createdAt' => '2025-02-27T09:42:14.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataworks:CreateWorkflowInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DeleteAgent' => [ + 'summary' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => 'TBD', + 'abilityTreeNodes' => ['FEATUREdideYTM537'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => true, 'description' => '', 'example' => 'my-agent', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => '824F80BA-1778-5D8A-BAFF-668A4D9C4CC7'], + ], + 'title' => '', + 'description' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '', + 'description' => '## 请求说明'."\n" + .'该 API 用于从 DataWorks 中删除指定名称的 Agent。调用此接口时，必须提供要删除的 Agent 的名称。'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"824F80BA-1778-5D8A-BAFF-668A4D9C4CC7\\"\\n}","type":"json"}]', + ], + 'DeleteAlertRule' => [ + 'summary' => 'Deletes a custom monitoring alert rule.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '249142', + 'abilityTreeNodes' => ['FEATUREdideRJGWWC'], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '105412', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '8754EE08-4AA2-5F77-ADD7-754DBBDA9F75'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8754EE08-4AA2-5F77-ADD7-754DBBDA9F75\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'DeleteAlertRule', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'DeleteBusiness' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '268604', + 'abilityTreeNodes' => ['FEATUREdide8FM783'], + ], + '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 specify either this parameter or the ProjectIdentifier parameter to identify the DataWorks workspace when you call this operation.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10000', 'title' => ''], + ], + [ + '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 query the workspace name. You must specify either this parameter or the ProjectId parameter to identify the DataWorks workspace when you call this operation.', 'type' => 'string', 'required' => false, 'example' => 'dw_project', 'title' => ''], + ], + [ + 'name' => 'BusinessId', + 'in' => 'formData', + 'schema' => ['description' => 'The workflow ID. You can call the [ListBusiness](~~173945~~) operation to query the ID of a workflow by name.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1000001', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Responses', + '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 connection does not exist.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. Used to troubleshoot issues when 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 request was successful. Valid values:'."\n" + ."\n" + .'- true: success.'."\n" + ."\n" + .'- false: failure.', '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.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}","type":"json"}]', + 'title' => 'DeleteBusiness', + 'summary' => 'Deletes a workflow.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'DeleteCertificate' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '250936', + 'abilityTreeNodes' => ['FEATUREdideRWC5F7'], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The unique identifier of the certificate file.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '676303114031776', 'title' => ''], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the project to which the certificate file belongs.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '106560', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response schema.', + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the certificate file was successfully deleted.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'RequestId' => ['description' => 'The request ID. Use this ID to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => 'D9A61DC0-B922-421B-B706', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteCertificate', + 'summary' => 'Deletes a certificate file.', + 'description' => '1. This operation requires DataWorks Basic Edition or a later version.'."\n" + ."\n" + .'2. This operation requires one of the following roles in the DataWorks workspace: Tenant Owner, Workspace Administrator, Project Owner, or O\\&M.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"D9A61DC0-B922-421B-B706\\"\\n}","type":"json"}]', + ], + 'DeleteComponent' => [ + 'summary' => 'Deletes a component.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236013', + 'abilityTreeNodes' => ['FEATUREdideITYNXL'], + '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 query the ID.'."\n" + ."\n" + .'This parameter specifies the DataWorks workspace to which the API operation is applied.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1000', 'title' => ''], + ], + [ + 'name' => 'ComponentId', + 'in' => 'formData', + 'schema' => ['description' => 'The component ID. It can be used as a request parameter for querying the list of production studio components and modifying production studio components.', 'type' => 'string', 'required' => true, 'example' => '123123123123', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0000-ABCD-EF****'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteComponent', + 'description' => '>'."\n" + ."\n" + .'After a UDF is published, it cannot be deleted. You must unpublish the UDF before you can delete it.'."\n" + ."\n" + .'>', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dataworks:DeleteComponent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EF****\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'DeleteComputeResource' => [ + 'summary' => 'Deletes the specified computing resource based on the computing resource ID.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '232438', + 'abilityTreeNodes' => ['FEATUREdideRWC5F7'], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The computing resource ID, the unique identifier of the data source.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234', 'title' => ''], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Responses', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID. You can use the request ID to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => 'B56432E0-2112-5C97-88D0-AA0AE5****'."\n"], + 'Success' => ['description' => 'Indicates whether the call succeeded.'."\n" + ."\n" + .'- true: The call is successful.'."\n" + ."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteComputeResource', + 'description' => '1. DataWorks Basic Edition or a more advanced edition is required.'."\n" + ."\n" + .'2. You must have at least one of the following roles in the DataWorks workspace:'."\n" + ."\n" + .'3. Tenant Owner, Workspace Administrator, Project Owner, O\\&M', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:DeleteComputeResource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B56432E0-2112-5C97-88D0-AA0AE5****\\\\n\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'DeleteCustomAttribute' => [ + 'summary' => 'Deletes a custom attribute definition.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdideX3KVYR'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the custom attribute.', 'type' => 'string', 'required' => true, 'example' => 'custom-attribute:biz_owner', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'Id of the request', 'type' => 'string', 'title' => '', 'example' => '7B4D81F1-98CF-500C-8D25-2865EB652EA0'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'Result' => ['description' => 'The result of the deletion.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + ], + 'title' => '', + 'description' => 'Schema of Response', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteCustomAttribute', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B4D81F1-98CF-500C-8D25-2865EB652EA0\\",\\n \\"Success\\": true,\\n \\"Result\\": true\\n}","type":"json"}]', + ], + 'DeleteDIAlarmRule' => [ + 'summary' => 'Deletes an alert rule configured for a synchronization task.', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '234127', + 'abilityTreeNodes' => ['FEATUREdideBP0OJZ'], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the synchronization task.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'DIJobId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the synchronization task.', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'DIAlarmRuleId', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is deprecated. Use the Id parameter instead.', 'type' => 'integer', 'format' => 'int64', 'deprecated' => true, 'required' => false, 'example' => '2', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.', 'type' => 'string', 'title' => '', 'example' => 'C99E2BE6-9DEA-5C2E-8F51-1DDCFE****'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C99E2BE6-9DEA-5C2E-8F51-1DDCFE****\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'DeleteDIAlarmRule', + 'description' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-01-06T07:20:59.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-01-06T05:34:15.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'DeleteDIJob' => [ + 'summary' => 'Deletes a new-version synchronization task.', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '234098', + 'abilityTreeNodes' => ['FEATUREdideBP0OJZ'], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the synchronization task.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '11126', 'title' => ''], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The DataWorks workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '108864', 'title' => ''], + ], + [ + 'name' => 'DIJobId', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is deprecated. Use the Id parameter instead.', 'type' => 'integer', 'format' => 'int64', 'deprecated' => true, 'required' => false, 'example' => '11126', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'true', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. You can troubleshoot issues based on the ID.', 'type' => 'string', 'example' => 'D33D4A51-5845-579A-B4BA-FAADD0F****', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"D33D4A51-5845-579A-B4BA-FAADD0F****\\"\\n}","type":"json"}]', + 'title' => 'DeleteDIJob', + 'description' => 'This API operation is available for all DataWorks editions.', + 'changeSet' => [ + ['createdAt' => '2025-01-06T05:34:15.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-10-14T09:34:05.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'DeleteDataAssetTag' => [ + 'summary' => 'Deletes a tag.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'abilityTreeCode' => '250987', + 'abilityTreeNodes' => ['FEATUREdideKQ371B'], + ], + 'parameters' => [ + [ + 'name' => 'Key', + 'in' => 'query', + 'schema' => ['description' => 'The tag key.', 'type' => 'string', 'required' => true, 'maxLength' => 128, 'minLength' => 1, 'example' => 'key1', 'title' => ''], + ], + [ + 'name' => 'Values', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The tag values.', + 'type' => 'array', + 'items' => ['description' => 'The tag value.', 'type' => 'string', 'maxLength' => 128, 'minLength' => 0, 'required' => false, 'example' => 'v1', 'title' => ''], + 'required' => false, + 'maxItems' => 20, + 'minItems' => 0, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0bc141151593763597*****'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc141151593763597*****\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'DeleteDataAssetTag', + 'description' => 'This API operation is available only for DataWorks Enterprise Edition or a more advanced edition.', + 'changeSet' => [], + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + ], + 'DeleteDataQualityAlertRule' => [ + 'summary' => 'Deletes a data quality alert rule by ID.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdide3WJOKE'], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the data quality rule template.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => 'a7ef0634-20ec-4a7c-a214-54020f91XXXX', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0bc14115***159376359'], + 'Success' => ['description' => 'Indicates whether the alert rule is deleted.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteDataQualityAlertRule', + 'description' => 'DataWorks Basic Edition or a higher edition is required.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115***159376359\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'DeleteDataQualityEvaluationTask' => [ + 'summary' => 'Deletes a data quality monitoring task.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '250885', + 'abilityTreeNodes' => ['FEATUREdide3WJOKE'], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the data quality monitor.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '123123', 'title' => ''], + ], + [ + '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 Management page to obtain the ID.'."\n" + ."\n" + .'This parameter specifies the DataWorks workspace used for this API call.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '10000', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0bc1ec92159376****'], + 'Success' => ['description' => 'Indicates whether the deletion was successful. Valid values:'."\n" + .'- true: successful'."\n" + .'- false: failed', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], + ], + ], + 'staticInfo' => [ + 'substitutions' => ['dataworks-public::2024-05-18::DeleteDataQualityScan'], + 'returnType' => 'synchronous', + ], + 'title' => 'Delete a data quality monitor', + 'description' => 'You must purchase DataWorks Basic Edition or higher to use this feature.', + 'changeSet' => [ + ['createdAt' => '2025-03-31T05:58:07.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-12-23T06:29:09.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc1ec92159376****\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'DeleteDataQualityRule' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '247983', + 'abilityTreeNodes' => ['FEATUREdide3WJOKE'], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The rule ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '19715'], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The DataWorks workspace ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '17302'], + ], + ], + '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' => '691CA452-D37A-4ED0-9441'."\n"], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true'], + ], + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-4ED0-9441\\\\n\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'DeleteDataQualityRule', + 'summary' => 'Deletes a data quality monitoring rule.', + 'changeSet' => [ + ['createdAt' => '2025-03-31T05:58:07.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-12-23T06:29:09.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-12-19T08:30:40.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'DeleteDataQualityRuleTemplate' => [ + 'summary' => 'Deletes a custom data quality rule template.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '248058', + 'abilityTreeNodes' => ['FEATUREdideRGVRPF'], + ], + 'parameters' => [ + [ + 'name' => 'Code', + 'in' => 'query', + 'schema' => ['description' => 'The code of the rule template.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'USER_DEFINED:123', 'title' => ''], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The DataWorks workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '10001', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'The response.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '691CA452-D37A-4ED0-9441'."\n"], + 'Success' => ['description' => 'Indicates whether the deletion was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => ['dataworks-public::2024-05-18::DeleteDataQualityTemplate'], + 'returnType' => 'synchronous', + ], + 'title' => 'Delete a custom data quality rule template', + 'description' => 'You must purchase DataWorks Basic Edition or a higher edition to use this operation.', + 'changeSet' => [ + ['createdAt' => '2025-03-31T05:58:07.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-12-23T06:29:09.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-12-19T08:30:40.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-4ED0-9441\\\\n\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'DeleteDataQualityScan' => [ + 'summary' => 'Deletes a data quality monitor.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdide3WJOKE'], + ], + 'parameters' => [ + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['description' => 'The deprecated parameter. No configuration is required.', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the data quality monitor.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123123', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2197B9C4-39CE-55EA-8EEA-FDBAE52DXXXX'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteDataQualityScan', + 'description' => 'DataWorks Basic Edition or a higher edition is required.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2197B9C4-39CE-55EA-8EEA-FDBAE52DXXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'DeleteDataQualityTemplate' => [ + 'summary' => 'Deletes a data quality rule template by ID.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdide3WJOKE'], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the custom rule template.', 'type' => 'string', 'required' => false, 'example' => 'USER_DEFINED:2001', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The API request ID, which is generated as a UUID.', 'type' => 'string', 'example' => '0bc14115****159376359'], + 'Success' => ['description' => 'Deleted', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteDataQualityTemplate', + 'description' => '## Request description'."\n" + ."\n" + .'- **Id**: The unique identifier of a custom rule template, in the format of `USER_DEFINED:`.'."\n" + ."\n" + .'- **ProjectId**: The ID of the DataWorks workspace to which the rule template belongs.'."\n" + ."\n" + .'This operation removes a data quality rule template that is no longer needed. Make sure that the `Id` and `ProjectId` values are correct. Otherwise, the deletion may fail or cause unexpected data loss. Exercise caution when performing this operation and verify the template information before proceeding.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115****159376359\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'DeleteDataSource' => [ + 'summary' => 'Deletes a data source by data source ID.', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '232438', + 'abilityTreeNodes' => ['FEATUREdideRWC5F7'], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The data source ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234', '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. You can locate logs and troubleshoot issues based on the ID.', 'type' => 'string', 'example' => 'B56432E0-2112-5C97-88D0-AA0AE5****'], + 'Success' => ['description' => 'Whether the call is successful.'."\n" + ."\n" + .'- true: Successful'."\n" + ."\n" + .'- false: Failed', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B56432E0-2112-5C97-88D0-AA0AE5****\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'DeleteDataSource', + 'description' => '1. This operation is available for all DataWorks editions.'."\n" + ."\n" + .'2. To call this operation, you must have one of the following roles in DataWorks:'."\n" + ."\n" + .'- Tenant Owner, Workspace Administrator, Workspace Owner, and O\\&M', + 'changeSet' => [ + ['createdAt' => '2024-12-19T09:00:14.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:DeleteDataSource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DeleteDataSourceSharedRule' => [ + 'summary' => 'Deletes a data source sharing rule by rule ID.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '235549', + 'abilityTreeNodes' => ['FEATUREdideRWC5F7'], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The sharing rule ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '22127'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.', 'type' => 'string', 'example' => '64B-587A-8CED-969E1973887F****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the sharing rule was deleted. Valid values:'."\n" + .'-true: The sharing rule was deleted.'."\n" + .'-false: The sharing rule failed to be deleted.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"64B-587A-8CED-969E1973887F****\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'DeleteDataSourceSharedRule', + 'description' => '1. This operation is available for all DataWorks editions.'."\n" + ."\n" + .'2. To delete a sharing rule of a data source from Workspace A to Workspace B, you must have the data source sharing permissions in Workspace A or Workspace B. You must have one of the following roles in DataWorks:'."\n" + ."\n" + .'- Tenant Owner, Tenant Administrator, Workspace Administrator, and Workspace Owner', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:DeleteDataSourceSharedRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DeleteDataset' => [ + 'summary' => 'Delete a dataset. Only DataWorks datasets are supported. This operation cascades to delete all associated dataset versions. Requires dataset creator or workspace administrator permissions.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdideXGTG91'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The dataset ID. Only DataWorks datasets are supported.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'dataworks-dataset:3pXXXb8o0ngr07njhps1'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'AAC30B35-820D-5F3E-A42C-E96BB****'], + 'Success' => ['description' => 'Indicates whether the deletion succeeded.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteDataset', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dataworks:DeleteDataset', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AAC30B35-820D-5F3E-A42C-E96BB****\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'DeleteDatasetVersion' => [ + 'summary' => 'Deletes a dataset version. Only non-v1 DataWorks datasets are supported. To delete v1 datasets, use the DeleteDataset operation. Requires dataset creator or workspace administrator permissions.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdideXGTG91'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The dataset version ID. Only DataWorks datasets are supported.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => ' '."\n" + .'dataworks-datasetVersion:3pXXXb8o0ngr07njhps1'."\n" + .':2'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '6AABBBD3-F2E4-5860-8CF7-2E9CEE3BDXXX'], + 'Success' => ['description' => 'Indicates whether the deletion succeeded.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteDatasetVersion', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dataworks:DeleteDatasetVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6AABBBD3-F2E4-5860-8CF7-2E9CEE3BDXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'DeleteFile' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '268111', + 'abilityTreeNodes' => ['FEATUREdide8FM783'], + ], + '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 ID.'."\n" + ."\n" + .'You must specify either this parameter or the ProjectIdentifier parameter to identify the DataWorks workspace when you call this operation.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10000', '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 page to query the name.'."\n" + ."\n" + .'You must specify either this parameter or the ProjectId parameter to identify the DataWorks workspace when you call this operation.', '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 obtain the folder ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10000201', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'DeploymentId' => ['description' => 'If the file has already been submitted, the DeleteFile operation also triggers an asynchronous deletion process in the scheduling system. You must use the DeploymentId returned by the DeleteFile operation to call GetDeployment and poll the status of the triggered asynchronous deletion process.'."\n" + ."\n" + .'If this field is empty, the file has been deleted and no further polling is required.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000000001', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. Used for troubleshooting when an error occurs.', '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 call was successful. Valid values:'."\n" + ."\n" + .'- true: success.'."\n" + ."\n" + .'- false: failure.', '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' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + '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"}]', + '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.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'DeleteFolder' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '268607', + 'abilityTreeNodes' => ['FEATUREdide8FM783'], + ], + '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 specify either this parameter or the ProjectIdentifier parameter to identify the DataWorks workspace when you call this operation.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10000', 'title' => ''], + ], + [ + '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 query the workspace name. You must specify either this parameter or the ProjectId parameter to identify the DataWorks workspace when you call this operation.', 'type' => 'string', 'required' => false, 'example' => 'dw_project', 'title' => ''], + ], + [ + 'name' => 'FolderId', + 'in' => 'formData', + 'schema' => ['description' => 'The folder ID. You can call the [ListFolders](~~173955~~) operation to obtain the folder ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2eb6f9****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Responses.', + '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 connection does not exist.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. Used for troubleshooting when 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. Valid values:'."\n" + ."\n" + .'- true: success.'."\n" + ."\n" + .'- false: failure.', '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.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}","type":"json"}]', + 'title' => 'DeleteFolder', + 'summary' => 'Invoke DeleteFolder to delete a folder on the Data Development page.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'DeleteFunction' => [ + 'summary' => 'Deletes a user-defined function (UDF) in DataStudio.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236013', + 'abilityTreeNodes' => ['FEATUREdideZOYJZL'], + ], + '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 ID. You can use this parameter to specify the DataWorks workspace on which you want to perform the API operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000', 'title' => ''], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => 'The unique identifier of the UDF.'."\n" + ."\n" + .'> This field is of the Long type in SDK versions prior to 8.0.0, and of the String type in SDK versions 8.0.0 and later. This change does not affect normal SDK usage; the parameter will still be returned according to the type defined in the SDK. However, compilation failures may occur due to the type change only when upgrading the SDK across version 8.0.0. In this case, you must manually update the data type.', 'type' => 'string', 'required' => true, 'example' => '860438872620113XXXX', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '88198F19-A36B-52A9-AE44-4518A688XXXX'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"88198F19-A36B-52A9-AE44-4518A688XXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'DeleteFunction', + 'description' => '>'."\n" + ."\n" + .'After a UDF is published, it cannot be deleted. You must unpublish the UDF before you can delete it.'."\n" + ."\n" + .'>', + 'changeSet' => [ + ['createdAt' => '2025-01-13T07:35:59.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'DeleteLineageRelationship' => [ + 'summary' => 'Deletes a lineage in Data Map.', + 'methods' => ['delete', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'abilityTreeCode' => '268096', + 'abilityTreeNodes' => ['FEATUREdideE9XYA6'], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => 'The lineage ID. You can refer to the ListLineageRelationships operation.', 'type' => 'string', 'required' => true, 'example' => '4as3dasf654a', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '952795279527ab****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true: success.'."\n" + ."\n" + .'- false: failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"952795279527ab****\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'DeleteLineageRelationship', + 'description' => '1. DataWorks Professional Edition or a higher edition is required.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'DeleteMcpServer' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => 'TBD', + 'abilityTreeNodes' => ['FEATUREdideYTM537'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the MCP Server to delete.'."\n", 'type' => 'string', 'required' => true, 'example' => 'my-mcp-server', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '824F80BA-1778-5D8A-BAFF-668A4D9C4CC7'], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Delete MCP Server', + 'summary' => 'Delete MCP Server', + 'description' => '## Request Description'."\n" + ."\n" + .'This API allows you to delete the corresponding MCP Server instance based on the provided MCP Server name. Make sure you have the appropriate permissions and verify that the MCP Server name to be deleted is correct before calling.'."\n" + ."\n" + .'### Notes'."\n" + .'- The deletion operation is irreversible. Proceed with caution.'."\n" + .'- Ensure that you have sufficient permissions (`dataworks:DeleteMcpServer`) to perform this operation.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"824F80BA-1778-5D8A-BAFF-668A4D9C4CC7\\"\\n}","type":"json"}]', + ], + 'DeleteMetaCollection' => [ + 'summary' => 'Delete a collection object in the specified Data Map, including Data Map categories and data albums.'."\n" + .'When deleting a data album, the caller must have the AliyunDataWorksFullAccess permission or be the creator or administrator of the album.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'abilityTreeCode' => '266820', + 'abilityTreeNodes' => ['FEATUREdideE9XYA6'], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The collection ID.', 'type' => 'string', 'required' => true, 'example' => 'as78d756asd', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '45D14A7A-7C28-5547-AB0A-35FBCD9DE7B5'], + ], + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"45D14A7A-7C28-5547-AB0A-35FBCD9DE7B5\\"\\n}","type":"json"}]', + 'title' => 'Delete a Data Map collection object ', + 'description' => '1. You must purchase DataWorks Professional Edition or a higher edition to use this feature.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'DeleteMetaEntityDef' => [ + 'summary' => '', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdideX3KVYR'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'EntityType', + 'in' => 'formData', + 'schema' => ['type' => 'string', 'required' => true, 'example' => 'custom_entity-customer_api', 'title' => '', 'description' => ''], + ], + [ + 'name' => 'Force', + 'in' => 'formData', + 'schema' => ['type' => 'boolean', 'title' => '', 'description' => '', 'required' => false, 'example' => 'true'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['type' => 'string', 'title' => '', 'description' => '', 'example' => '3C1E755D-B606-57A4-9B9C-7B214E81354C'], + 'Success' => ['type' => 'boolean', 'title' => '', 'description' => '', 'example' => 'true'], + ], + 'title' => '', + 'description' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => '', + 'description' => '需要购买 DataWorks 专业版及以上版本才能使用。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3C1E755D-B606-57A4-9B9C-7B214E81354C\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'DeleteNetwork' => [ + 'summary' => 'Disassociates and deletes a network from a general resource group.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '245179', + 'abilityTreeNodes' => ['FEATUREdide2SV6DS'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the network that you want to delete.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1000', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'example' => 'true'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6A6CBE87-9F91-1323-B680-E7A7065****', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065****\\"\\n}","type":"json"}]', + 'title' => 'DeleteNetwork', + 'description' => 'This API operation is available for all DataWorks editions.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dataworks:DeleteNetwork', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DeleteNode' => [ + 'summary' => 'Deletes a node from DataStudio.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236786', + 'abilityTreeNodes' => ['FEATUREdideHO4TQP', 'FEATUREdide8FM783', 'FEATUREdideQUQUVB', 'FEATUREdideIQU97M'], + ], + '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 ID.'."\n" + ."\n" + .'You can use this parameter to specify the DataWorks workspace on which you want to perform the API operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000', 'title' => ''], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => 'The unique identifier of the Data Studio node.'."\n" + ."\n" + .'> This field is of the Long type in SDK versions prior to 8.0.0, and of the String type in SDK versions 8.0.0 and later. This change does not affect normal SDK usage; the parameter will still be returned according to the type defined in the SDK. However, compilation failures may occur due to the type change only when upgrading the SDK across version 8.0.0. In this case, you must manually update the data type.', 'type' => 'string', 'required' => true, 'example' => '860438872620113XXXX', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameetrs.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'A1E54497-5122-505E-91C6-BAC14980XXXX'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'true
'."\n" + .'false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A1E54497-5122-505E-91C6-BAC14980XXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'DeleteNode', + 'description' => '>'."\n" + ."\n" + .'After a node is published, it cannot be deleted. You must unpublish the node before you can delete it.'."\n" + ."\n" + .'>', + 'changeSet' => [ + ['createdAt' => '2025-01-13T07:36:02.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'DeleteParameter' => [ + 'summary' => 'Deletes a specified parameter.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB'], + 'autoTest' => true, + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the parameter.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12345', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Whether the request was successful.', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'example' => 'true'], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', 'title' => ''], + ], + 'title' => '', + 'description' => 'The response schema.', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteParameter', + 'description' => 'This operation is available only in DataWorks professional edition and later versions.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]', + ], + 'DeleteProcessDefinition' => [ + 'summary' => 'Deletes a process definition by the specified ID.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '244493', + 'abilityTreeNodes' => ['FEATUREdideYTM537'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => '**The ID of the process definition to delete.**', 'type' => 'string', 'required' => true, 'example' => 'f0d6d578-a305-40ac-ba1e-0a09f64cbc69', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '**The unique ID of the request.**', 'type' => 'string', 'title' => '', 'example' => '0bc5df3a17***903790e8e8a'], + ], + 'title' => '', + 'description' => 'Response schema.', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteProcessDefinition', + 'description' => '## Description'."\n" + ."\n" + .'- This API deletes a process definition by its ID.'."\n" + ."\n" + .'- This operation is irreversible. Proceed with caution.'."\n" + ."\n" + .'- Before calling this API, back up relevant data or confirm that the process definition is no longer required.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc5df3a17***903790e8e8a\\"\\n}","type":"json"}]', + ], + 'DeleteProject' => [ + 'summary' => 'Deletes a DataWorks workspace.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '244493', + 'abilityTreeNodes' => ['FEATUREdideYTM537'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the DataWorks workspace. You can obtain the workspace ID from the Workspace Management page in the [DataWorks console](https://dataworks.console.aliyun.com/workspace/list).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The Request ID. Use this ID to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => 'AFBB799F-8578-51C5-A766-E922EDB8XXXX'."\n"], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AFBB799F-8578-51C5-A766-E922EDB8XXXX\\\\n\\"\\n}","type":"json"}]', + 'title' => 'DeleteProject', + 'description' => 'To call this API, you must purchase DataWorks Basic Edition or a higher edition.'."\n" + ."\n" + .'Note: When you delete a workspace, the system moves it to the Recycle Bin. After a 14-day retention period, the system permanently purges the workspace. During this time, you cannot create a new workspace with the same name. You can find the deleted workspace in the Recycle Bin on the Workspace page in the console.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dataworks:DeleteProject', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DeleteProjectMember' => [ + 'summary' => 'Removes a workspace member and the workspace-level roles that are assigned to the member.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '244499', + 'abilityTreeNodes' => ['FEATUREdideYTM537'], + 'tenantRelevance' => 'tenant', + ], + '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 query the ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '534752', 'title' => ''], + ], + [ + 'name' => 'UserId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the account used by the member in the workspace. You can log on to the [DataWorks console](https://dataworks.console.aliyun.com/product/ms_menu), choose More > Management Center in the left-side navigation pane, select the desired workspace on the Management Center page, and then click Go to Management Center. In the left-side navigation pane of the SettingCenter page, click Tenant Members and Roles. On the **Tenant Members and Roles** page, view the ID of the account used by the member in the workspace.', 'type' => 'string', 'required' => true, 'example' => '123422344899', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.', 'type' => 'string', 'example' => '1FF0465F-209C-5964-8F30-FAF21B677CC6'], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1FF0465F-209C-5964-8F30-FAF21B677CC6\\"\\n}","type":"json"}]', + 'title' => 'DeleteProjectMember', + 'description' => 'This API operation is available for all DataWorks editions.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dataworks:DeleteProjectMember', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DeleteProjectRole' => [ + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '244504', + 'abilityTreeNodes' => ['FEATUREdideYTM537'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the DataWorks workspace. You can log on to the [DataWorks console](https://dataworks.console.aliyun.com/workspace/list) and go to the workspace management page to obtain the ID.'."\n" + ."\n" + .'This parameter specifies the DataWorks workspace on which the API operation is performed.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12345', 'title' => ''], + ], + [ + 'name' => 'Code', + 'in' => 'query', + 'schema' => ['description' => 'The unique identifier of the custom role.', 'type' => 'string', 'required' => true, 'example' => 'base_role_xxx', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID, which is used to locate logs and troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => '5BCD2252-F184-55A8-9675-337C43BE0CD1'], + ], + 'title' => '', + 'description' => 'The response parameters.', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteProjectRole', + 'summary' => 'Deletes a custom role from a workspace.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5BCD2252-F184-55A8-9675-337C43BE0CD1\\"\\n}","type":"json"}]', + ], + 'DeleteResource' => [ + 'summary' => 'Deletes a file resource from DataStudio.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235475', + 'abilityTreeNodes' => ['FEATUREdideJ3TPTK'], + ], + '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 ID. You can use this parameter to specify the DataWorks workspace on which you want to perform the API operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000', 'title' => ''], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => 'The unique identifier of the resource file.'."\n" + ."\n" + .'> This field is of the Long type in SDK versions prior to 8.0.0, and of the String type in SDK versions 8.0.0 and later. This change does not affect normal SDK usage; the parameter will still be returned according to the type defined in the SDK. However, compilation failures may occur due to the type change only when upgrading the SDK across version 8.0.0. In this case, you must manually update the data type.', 'type' => 'string', 'required' => true, 'example' => '860438872620113XXXX', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '88198F19-A36B-52A9-AE44-4518A688XXXX'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"88198F19-A36B-52A9-AE44-4518A688XXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'DeleteResource', + 'description' => '>'."\n" + ."\n" + .'After a file resource is published, it cannot be deleted. You must unpublish the file resource before you can delete it.'."\n" + ."\n" + .'>', + 'changeSet' => [ + ['createdAt' => '2025-01-13T07:36:00.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DeleteResourceGroup' => [ + 'summary' => 'Deletes a resource group.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '245171', + 'abilityTreeNodes' => ['FEATUREdide2SV6DS'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => 'The unique identifier of the resource group.', 'type' => 'string', 'required' => true, 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response schema.', + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'example' => 'true'], + 'RequestId' => ['description' => 'The Request ID. Use this ID to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]', + 'title' => 'DeleteResourceGroup', + 'description' => '1. This operation requires DataWorks Basic Edition or a later version.'."\n" + ."\n" + .'2. **Before you use this operation, ensure you understand the billing method and [pricing](~~2680173~~) for DataWorks resource groups.**'."\n" + ."\n" + .'3. **Before you use this operation, ensure you have created the Service-Linked Role AliyunServiceRoleForDataWorks.**', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dataworks:DeleteResourceGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DeleteRoute' => [ + 'summary' => 'Deletes a route from a network resource.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'abilityTreeCode' => '245174', + 'abilityTreeNodes' => ['FEATUREdide2SV6DS'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => 'The route ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1000', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'example' => 'true'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6A6CBE87-9F91-1323-B680-E7A7065****', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065****\\"\\n}","type":"json"}]', + 'title' => 'DeleteRoute', + 'description' => 'This API operation is available for all DataWorks editions.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dataworks:DeleteRoute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DeleteSecurityStrategy' => [ + 'summary' => 'Deletes a security strategy by its ID. To call this operation, you must have DataWorks tenant administrator and security administrator permissions.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => 'TBD', + 'abilityTreeNodes' => ['FEATUREdideYTM537'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the security strategy.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '0bc5df3a17****903790e8e8a'], + ], + 'title' => '', + 'description' => 'The response data.', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteSecurityStrategy', + 'description' => '## Usage notes'."\n" + ."\n" + .'- You can delete a security strategy by providing its ID.'."\n" + ."\n" + .'- You cannot delete a system strategy.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc5df3a17****903790e8e8a\\"\\n}","type":"json"}]', + ], + 'DeleteSkill' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => 'TBD', + 'abilityTreeNodes' => ['FEATUREdideYTM537'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the Skill to delete.'."\n", 'type' => 'string', 'required' => true, 'example' => 'my-skill', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '824F80BA-1778-5D8A-BAFF-668A4D9C4CC7'], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Delete Skill', + 'summary' => 'Delete Skill', + 'description' => '## Request Description'."\n" + ."\n" + .'This API is used to delete a Skill with the specified name from DataWorks. The exact name of the Skill to delete must be provided when invoking this API.'."\n" + ."\n" + .'### Notes'."\n" + .'- Ensure that you have sufficient permissions to perform the delete operation.'."\n" + .'- The delete operation is irreversible. Use it with caution.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"824F80BA-1778-5D8A-BAFF-668A4D9C4CC7\\"\\n}","type":"json"}]', + ], + 'DeleteTask' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '247745', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB'], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234', 'title' => ''], + ], + [ + 'name' => 'ProjectEnv', + 'in' => 'query', + 'schema' => [ + 'description' => 'The environment of the workspace.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- Prod: production environment'."\n" + ."\n" + .'- Dev: development environment', + 'enumValueTitles' => ['Prod' => '', 'Dev' => ''], + 'type' => 'string', + 'default' => 'Prod', + 'enum' => ['Prod', 'Dev'], + 'required' => false, + 'example' => 'Prod', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n", 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\\\n\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'DeleteTask', + 'summary' => 'Deletes a task.', + 'description' => 'This API operation is available for all DataWorks editions.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'DeleteWorkflow' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '253458', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB', 'FEATUREdideD0YY7B', 'FEATUREdideVFMENL'], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The workflow ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234', 'title' => ''], + ], + [ + 'name' => 'EnvType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The environment of the workspace. Valid values:'."\n" + ."\n" + .'- Prod: production environment'."\n" + ."\n" + .'- Dev: development environment', + 'enumValueTitles' => [], + 'type' => 'string', + 'default' => 'Prod', + 'enum' => ['Prod', 'Dev'], + 'required' => false, + 'example' => 'Prod', + 'title' => '', + ], + ], + [ + 'name' => 'ClientUniqueCode', + 'in' => 'formData', + 'schema' => ['description' => 'The unique code of the client. This parameter is used to create a workflow asynchronously and implement the idempotence of the workflow. If you do not specify this parameter when you create the workflow, the system automatically generates a unique code. The unique code is uniquely associated with the workflow ID. If you specify this parameter when you update or delete the workflow, the value of this parameter must be the unique code that is used to create the workflow.', 'type' => 'string', 'required' => false, 'example' => 'Workflow_0bc5213917368545132902xxxxxxxx', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'DeleteWorkflow', + 'summary' => 'Deletes a workflow.', + 'description' => 'This API operation is available for all DataWorks editions.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'DeleteWorkflowDefinition' => [ + 'summary' => 'Deletes a workflow from DataStudio.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '234975', + 'abilityTreeNodes' => ['FEATUREdideHO4TQP', 'FEATUREdide8FM783', 'FEATUREdideQUQUVB', 'FEATUREdideIQU97M'], + ], + '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 query the ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000', 'title' => ''], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => 'The unique identifier of the Data Studio workflow.'."\n" + ."\n" + .'> This field is of the Long type in SDK versions prior to 8.0.0, and of the String type in SDK versions 8.0.0 and later. This change does not affect normal SDK usage; the parameter will still be returned according to the type defined in the SDK. However, compilation failures may occur due to the type change only when upgrading the SDK across version 8.0.0. In this case, you must manually update the data type.', 'type' => 'string', 'required' => true, 'example' => '860438872620113XXXX', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B17730C0-D959-548A-AE23-E754177CXXXX', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B17730C0-D959-548A-AE23-E754177CXXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'DeleteWorkflowDefinition', + 'description' => '>'."\n" + ."\n" + .'After a workflow definition is published, it cannot be deleted. You must unpublish the workflow definition before you can delete it.'."\n" + ."\n" + .'>', + 'changeSet' => [ + ['createdAt' => '2025-01-13T07:36:01.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'DeployFile' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '268115', + 'abilityTreeNodes' => ['FEATUREdide8FM783'], + ], + '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 specify either this parameter or the ProjectIdentifier parameter to identify the DataWorks workspace when you call this operation.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10000', 'title' => ''], + ], + [ + '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 query the workspace name. You must specify either this parameter or the ProjectId parameter to identify the DataWorks workspace when you call this operation.', '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 obtain the ID. You need to configure either this parameter or the NodeId parameter.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '10000001', 'title' => ''], + ], + [ + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => ['description' => 'The description of the deployment.', 'type' => 'string', 'required' => false, 'example' => 'First release task', 'title' => ''], + ], + [ + 'name' => 'NodeId', + 'in' => 'formData', + 'schema' => ['description' => 'The task ID of the file to be deployed in the scheduling system. You need to configure either this parameter or the FileId parameter.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2000001', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response.', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The deployment package ID. You must specify this ID as a parameter when you call the [GetDeployment](~~173950~~) operation to query the details of the deployment.', 'type' => 'integer', 'format' => 'int64', 'example' => '30000001', '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 call was successful. Valid values:'."\n" + ."\n" + .'- true: success.'."\n" + ."\n" + .'- false: failure.', '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' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + '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' => 'Publish a file to the production environment.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'DetachDataQualityRulesFromEvaluationTask' => [ + 'summary' => 'Removes the association between a data quality rule and a data quality monitoring task.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '250890', + 'abilityTreeNodes' => ['FEATUREdide3WJOKE'], + ], + '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 Settings page to obtain the workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10002', 'title' => ''], + ], + [ + 'name' => 'DataQualityEvaluationTaskId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the associated data quality monitoring task.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10000', 'title' => ''], + ], + [ + 'name' => 'DataQualityRuleIds', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The list of data quality rule IDs.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the data quality rule.', 'type' => 'integer', 'format' => 'int64', 'docRequired' => true, 'required' => true, 'example' => '200001', 'title' => ''], + 'required' => true, + 'docRequired' => true, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '8abcb91f-d266-4073-b907-2ed6****'], + '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' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => ['dataworks-public::2024-05-18::UpdateDataQualityScan'], + 'returnType' => 'synchronous', + ], + 'title' => 'Remove the association between a data quality rule and a monitoring task', + 'description' => 'You must purchase DataWorks Basic Edition or a higher edition to use this feature.', + 'changeSet' => [ + ['createdAt' => '2024-12-23T06:29:09.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8abcb91f-d266-4073-b907-2ed6****\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'DisableProcessDefinition' => [ + 'summary' => 'Disables the specified approval process definition.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '244492', + 'abilityTreeNodes' => ['FEATUREdideYTM537'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => 'The process definition ID.', 'type' => 'string', 'required' => false, 'example' => '11792', 'title' => ''], + ], + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => ['description' => 'An idempotence token used to make the request idempotent. A universally unique identifier (UUID) is recommended.', 'type' => 'string', 'required' => false, 'example' => '1AFAE64E-D1BE-432B-A9*****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '0bc5df3a17***903790e8e8a'], + ], + 'title' => '', + 'description' => 'The response data.', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DisableProcessDefinition', + 'description' => '## Request'."\n" + ."\n" + .'- This API disables the specified approval process definition.'."\n" + ."\n" + .'- A disabled approval process definition remains inactive until it is re-enabled.'."\n" + ."\n" + .'- You must provide a valid process definition ID as a path parameter.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc5df3a17***903790e8e8a\\"\\n}","type":"json"}]', + ], + 'DissociateProjectFromImage' => [ + 'summary' => 'Disassociates an image from a workspace.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '245182', + 'abilityTreeNodes' => ['FEATUREdide2SV6DS'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the image.', 'type' => 'string', 'required' => true, 'example' => 'Custom_image_xxxx_xxxx', 'title' => ''], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '100000001', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Whether the request was successful.', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'example' => 'true'], + 'Data' => ['description' => 'Whether the image was successfully disassociated from the workspace.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. Use this ID to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', 'title' => ''], + ], + 'title' => '', + 'description' => 'The response body.', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DissociateProjectFromImage', + 'description' => '1. This operation requires DataWorks Basic Edition or a later version.'."\n" + ."\n" + .'2. **Before calling this operation, ensure you have created the AliyunServiceRoleForDataWorks service-linked role.**', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Data\\": true,\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]', + ], + 'DissociateProjectFromResourceGroup' => [ + 'summary' => 'Disassociates a resource group from a workspace.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '245167', + 'abilityTreeNodes' => ['FEATUREdide2SV6DS'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => ['description' => 'The unique identifier of the resource group.', 'type' => 'string', 'required' => true, 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX', 'title' => ''], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the workspace to disassociate.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1000', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'example' => 'true'], + 'RequestId' => ['description' => 'The request ID, which is used to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]', + 'title' => 'Disassociate a resource group from a workspace', + 'description' => '1. This operation requires a subscription to DataWorks Basic Edition or a higher edition.'."\n" + ."\n" + .'2. You must have one of the following roles in the DataWorks workspace:'."\n" + ."\n" + .'- tenant owner, workspace administrator, project owner, or operator', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:DissociateProjectFromResourceGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'EnableProcessDefinition' => [ + 'summary' => 'Enables a process definition with the specified ID.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '244493', + 'abilityTreeNodes' => ['FEATUREdideYTM537'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => '**process definition ID**', 'type' => 'string', 'required' => false, 'example' => 'f0d6d578-a305-40ac-ba1e-0a09f64cbc69', 'title' => ''], + ], + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => ['description' => 'The idempotence token. A UUID is recommended.', 'type' => 'string', 'required' => false, 'example' => '1AFAE64E-D1BE-432B-A9****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => '**request ID**', 'type' => 'string', 'title' => '', 'example' => '0bc5df3a17***903790e8e8a'], + ], + 'description' => 'The **response body**, which contains fields such as RequestId, Message, and Code.', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'EnableProcessDefinition', + 'description' => '## Request'."\n" + ."\n" + .'This API enables an existing process definition. You must provide the process definition ID as a path parameter.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc5df3a17***903790e8e8a\\"\\n}","type":"json"}]', + ], + 'EstablishRelationTableToBusiness' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '269310', + 'abilityTreeNodes' => ['FEATUREdideEPPSOE'], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the DataWorks workspace. You can click the wrench icon in the top-right corner to access the workspace management page and view the ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10000', 'title' => ''], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => ['description' => 'The unique identifier of the DataWorks workspace. This is the identifier shown in the workspace switcher at the top of the Data Studio page.'."\n" + ."\n" + .'Either this parameter or ProjectId must be specified to determine which DataWorks workspace this API call operates on.', 'type' => 'string', 'required' => false, 'example' => 'dw', 'title' => ''], + ], + [ + 'name' => 'BusinessId', + 'in' => 'formData', + 'schema' => ['description' => 'The workflow ID. You can call the [ListBusiness](~~173945~~) operation to obtain the workflow ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1000001', 'title' => ''], + ], + [ + 'name' => 'TableGuid', + 'in' => 'formData', + 'schema' => ['description' => 'The UUID of the table. You can call the [SearchMetaTables](~~173919~~) operation to obtain the table UUID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'odps.dw_project.tb1', 'title' => ''], + ], + [ + 'name' => 'FolderId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the folder. You can call the [GetFolder](~~173952~~) or [ListFolders](~~173955~~) operation to obtain the folder ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '2eb6f9****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The response.', + '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 connection does not exist.', 'title' => ''], + 'RequestId' => ['description' => 'The unique ID of this request. You can use this ID to troubleshoot issues if errors occur.', '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 succeeded. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', '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.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}","type":"json"}]', + '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.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'ExecPipelineRunStage' => [ + 'summary' => 'Executes a stage in a process.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '267908', + 'abilityTreeNodes' => ['FEATUREdide4AR6E0'], + ], + '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.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000', 'title' => ''], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the process.', 'type' => 'string', 'required' => true, 'example' => 'a7ef0634-20ec-4a7c-a214-54020f91XXXX', 'title' => ''], + ], + [ + 'name' => 'Code', + 'in' => 'formData', + 'schema' => ['description' => 'The code of the stage in the process. You can call the GetDeployment operation to query the code.', 'type' => 'string', 'required' => true, 'example' => 'DEV_CHECK', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'AFBB799F-8578-51C5-A766-E922EDB8XXXX'."\n"], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false'."\n" + ."\n" + .' \\*\\*'."\n" + ."\n" + .' **Note:** The value of this parameter indicates only whether the stage is triggered but does not indicate whether the execution of the stage is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AFBB799F-8578-51C5-A766-E922EDB8XXXX\\\\n\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'ExecPipelineRunStage', + 'description' => '> The stages in a process are sequential. For more information, see the GetDeployment operation. Skipping or repeating a stage is not allowed.'."\n" + ."\n" + .'> The execution of a stage is asynchronous. The response of this operation indicates only whether a stage is triggered but does not indicate whether the execution of the stage is successful. You can call the GetDeployment operation to check whether the execution is successful.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'ExecuteAdhocWorkflowInstance' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '259719', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB', 'FEATUREdideD0YY7B', 'FEATUREdideVFMENL'], + ], + 'parameters' => [ + [ + 'name' => 'EnvType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The environment of the workspace. Valid values:'."\n" + ."\n" + .'- Prod: production environment'."\n" + ."\n" + .'- Dev: development environment', + 'enumValueTitles' => [], + 'type' => 'string', + 'default' => 'Prod', + 'enum' => ['Prod', 'Dev'], + 'required' => false, + 'example' => 'Prod', + 'title' => '', + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the workflow instance.', 'type' => 'string', 'required' => true, 'example' => 'WorkflowInstance1', 'title' => ''], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '100', 'title' => ''], + ], + [ + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => ['description' => 'The account ID of the owner.', 'type' => 'string', 'required' => true, 'example' => '1000', 'title' => ''], + ], + [ + 'name' => 'BizDate', + 'in' => 'formData', + 'schema' => ['description' => 'The data timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1710239005403', 'title' => ''], + ], + [ + 'name' => 'Tasks', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The tasks.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the task.', 'type' => 'string', 'required' => true, 'example' => 'SQL node.', 'title' => ''], + 'Type' => ['description' => 'The type of the task.', 'type' => 'string', 'required' => true, 'example' => 'ODPS_SQL', 'title' => ''], + 'Owner' => ['description' => 'The account ID of the owner.', 'type' => 'string', 'required' => true, 'example' => '1000', 'title' => ''], + 'Timeout' => ['description' => 'The timeout period of task running. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3600', 'title' => ''], + 'Script' => [ + 'description' => 'The script information.', + 'type' => 'object', + 'properties' => [ + 'Content' => ['description' => 'The script content.', 'type' => 'string', 'required' => false, 'example' => 'echo "helloWorld"', 'title' => ''], + 'Parameters' => ['description' => 'The script parameters.', 'type' => 'string', 'required' => false, 'example' => 'para1=$bizdate', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'RuntimeResource' => [ + 'description' => 'The configurations of the runtime environment, such as the resource group information.', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupId' => ['description' => 'The ID of the resource group for scheduling configured for task running.', 'type' => 'string', 'required' => true, 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', 'title' => ''], + 'Image' => ['description' => 'The ID of the image configured for task running.', 'type' => 'string', 'required' => false, 'example' => 'i-xxxxxx', 'title' => ''], + 'Cu' => ['description' => 'The default number of compute units (CUs) configured for task running.', 'type' => 'string', 'required' => false, 'example' => '0.25', 'title' => ''], + ], + 'required' => true, + 'title' => '', + 'example' => '', + ], + 'DataSource' => [ + 'description' => 'The information about the associated data source.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the data source.', 'type' => 'string', 'required' => false, 'example' => 'mysql_test', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Inputs' => [ + 'description' => 'The input information.', + 'type' => 'object', + 'properties' => [ + 'Variables' => [ + 'description' => 'The variables.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the variable.', 'type' => 'string', 'required' => false, 'example' => 'key1', 'title' => ''], + 'Value' => ['description' => 'The value of the variable. You must configure this parameter in the `The ancestor output: The output variable name of the ancestor task` format.', 'type' => 'string', 'required' => false, 'example' => 'upstream_task_output:key1', 'title' => ''], ], - 'Owner' => [ - 'title' => '责任人', - 'description' => 'The owner of nodes in Data Studio.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => '110755000425XXXX', - 'pattern' => '', - 'default' => '', + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Outputs' => [ + 'description' => 'The output information.', + 'type' => 'object', + 'properties' => [ + 'TaskOutputs' => [ + 'description' => 'The task outputs.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Output' => ['description' => 'The identifier of the output.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'pre.odps_sql_demo_0'], ], - 'CreateTime' => [ - 'title' => '创建时间', - 'description' => 'The timestamp when the node in Data Studio was created.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'deprecated' => false, - 'example' => '1722910655000', - 'pattern' => '', - 'default' => '', + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Variables' => [ + 'description' => 'The variables.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the variable.', 'type' => 'string', 'required' => false, 'example' => 'key1', 'title' => ''], + 'Type' => [ + 'description' => 'The type. Valid values:'."\n" + ."\n" + .'- System'."\n" + ."\n" + .'- Constant'."\n" + ."\n" + .'- NodeOutput'."\n" + ."\n" + .'- PassThrough', + 'enumValueTitles' => [], + 'type' => 'string', + 'enum' => ['System', 'Constant', 'NodeOutput', 'PassThrough'], + 'title' => '', + 'required' => false, + 'example' => 'Constant', + ], + 'Value' => ['description' => 'The value of the variable.', 'type' => 'string', 'required' => false, 'example' => 'value1', 'title' => ''], ], - 'ModifyTime' => [ - 'title' => '修改时间', - 'description' => 'The timestamp when the node in DataStudio was last modified.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'deprecated' => false, - 'example' => '1722910655000', - 'pattern' => '', - 'default' => '', + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Dependencies' => [ + 'description' => 'The dependency information.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UpstreamOutput' => ['description' => 'The identifier of the output of the ancestor task.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'pre.odps_sql_demo_0'], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'ClientUniqueCode' => ['description' => 'The unique code of the client. This code uniquely identifies a task.', 'type' => 'string', 'required' => true, 'example' => 'Task_0bc5213917368545132902xxxxxxxx', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX', 'title' => ''], + 'WorkflowInstanceId' => ['description' => 'The workflow instance ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"WorkflowInstanceId\\": 1234\\n}","type":"json"}]', + 'title' => 'ExecuteAdhocWorkflowInstance', + 'summary' => 'Create a temporary workflow instance based on configurations.', + 'description' => 'This API operation is available for all DataWorks editions.', + 'changeSet' => [ + ['createdAt' => '2025-03-20T11:25:09.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-02-11T02:31:27.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataworks:ExecuteAdhocWorkflowInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'FindBestMatchSecurityStrategy' => [ + 'summary' => 'Find the security policy that best matches the given conditions.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => 'TBD', + 'abilityTreeNodes' => ['FEATUREdideYTM537'], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ControlModule', + 'in' => 'query', + 'schema' => [ + 'description' => 'Control module, used to match the security policy type.', + 'enumValueTitles' => ['DataStudio' => 'DataStudio', 'DataQuery' => 'DataQuery'], + 'type' => 'string', + 'required' => false, + 'default' => 'DataQuery', + 'enum' => ['DataQuery', 'DataStudio'], + 'example' => 'DataQuery', + 'title' => '', + ], + ], + [ + 'name' => 'ControlSubModule', + 'in' => 'query', + 'schema' => [ + 'description' => 'Control sub-module, used to match the security policy type.', + 'enumValueTitles' => ['MyCatalog' => 'MyCatalog'], + 'type' => 'string', + 'enum' => ['MyCatalog'], + 'required' => false, + 'example' => 'MyCatalog', + 'title' => '', + ], + ], + [ + 'name' => 'WorkspaceId', + 'in' => 'query', + 'schema' => ['description' => '**Workspace ID**, used to precisely match workspace-level policies.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12345', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => '**API request ID**'."\n", 'type' => 'string', 'example' => '0bc5df3a17***903790e8e8a'], + 'Data' => [ + 'description' => 'Data object.', + 'type' => 'object', + 'properties' => [ + 'SecurityStrategy' => [ + 'description' => 'Security policy.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => '**Policy ID**'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '16', 'title' => ''], + 'Name' => ['description' => '**Policy name**'."\n", 'type' => 'string', 'example' => '默认数据分析策略', 'title' => ''], + 'Description' => ['description' => '**Policy description**'."\n", 'type' => 'string', 'example' => '控制数据分析模块的查询结果安全行为', 'title' => ''], + 'SchemaName' => [ + 'description' => '**Schema template name**'."\n", + 'type' => 'string', + 'enum' => ['DataQuerySecurityStrategySchema', 'DataStudioSecurityStrategySchema', 'DataStudioMyCatalogSecurityStrategySchema'], + 'example' => 'DataQuerySecurityStrategySchema', + 'title' => '', + ], + 'ControlModule' => [ + 'description' => '**Control module**'."\n", + 'type' => 'string', + 'enum' => ['DataQuery', 'DataStudio'], + 'example' => 'DataQuery', + 'title' => '', + ], + 'ControlSubModule' => [ + 'description' => '**Control sub-module**', + 'type' => 'string', + 'enum' => ['MyCatalog'], + 'example' => 'MyCatalog', + 'title' => '', + ], + 'ControlDwScope' => [ + 'description' => '**Control scope** (Workspace/Tenant).', + 'type' => 'string', + 'enum' => ['Tenant', 'Workspace'], + 'example' => 'Tenant', + 'title' => '', + ], + 'Workspaces' => [ + 'description' => '**Associated workspace ID list**', + 'type' => 'array', + 'items' => ['description' => 'Workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '12345', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Enabled' => ['description' => '**Whether enabled**', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Content' => [ + 'description' => '**Policy content**. Refer to the StrategyContent definition.', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '**Schema name**'."\n", + 'type' => 'string', + 'enum' => ['DataQuerySecurityStrategySchema', 'DataStudioSecurityStrategySchema', 'DataStudioMyCatalogSecurityStrategySchema'], + 'example' => 'DataQuerySecurityStrategySchema', + 'title' => '', + ], + 'DisplayName' => ['description' => '**Display name**'."\n", 'type' => 'string', 'example' => '数据分析', 'title' => ''], + 'DisplayNameEn' => ['description' => '**English display name**'."\n", 'type' => 'string', 'example' => 'Data Query', 'title' => ''], + 'ControlModule' => [ + 'description' => '**Control module**'."\n", + 'type' => 'string', + 'enum' => ['DataQuery', 'DataStudio'], + 'example' => 'DataQuery', + 'title' => '', + ], + 'ControlSubModule' => [ + 'description' => '**Control sub-module**'."\n", + 'type' => 'string', + 'enum' => ['MyCatalog'], + 'example' => 'MyCatalog', + 'title' => '', + ], + 'ControlDwScope' => [ + 'description' => '**Control scope**'."\n", + 'type' => 'string', + 'enum' => ['Tenant', 'Workspace'], + 'example' => 'Tenant', + 'title' => '', + ], + 'SystemPolicyName' => ['description' => 'System policy name (when not empty, the system automatically creates a default policy).'."\n", 'type' => 'string', 'example' => 'SYSTEM_GENERATE_DEFAULT_DATA_QUERY', 'title' => ''], + 'SystemPolicyDisplayName' => ['description' => 'System policy display name.'."\n", 'type' => 'string', 'example' => 'Default system generate data query policy', 'title' => ''], + 'Controllers' => [ + 'description' => 'Controller list.'."\n" + ."\n" + .'Note: Valid controllers depend on the selected Schema. Refer to the Controller definition and the controller list of each Schema.', + 'type' => 'array', + 'items' => [ + 'description' => 'Controller.', + 'type' => 'object', + 'properties' => [ + 'Controller' => ['description' => 'Controller identifier. For values, see the controller list of each Schema.'."\n", 'type' => 'string', 'example' => 'viewCount', 'title' => ''], + 'DisplayName' => ['description' => 'Display name.'."\n", 'type' => 'string', 'example' => '查询结果-单次展示记录值上限', 'title' => ''], + 'DisplayNameEn' => ['description' => '**English display name**'."\n", 'type' => 'string', 'example' => 'Query Results - Single Display Record Limit', 'title' => ''], + 'Enable' => ['description' => '**Whether this controller is enabled**'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ControllerValueType' => ['description' => '**Value type (Boolean/Integer/Long/String)**'."\n", 'type' => 'string', 'example' => 'Integer', 'title' => ''], + 'UserConfigValue' => ['description' => '**User-configured value. The type depends on ControllerValueType.**'."\n", 'type' => 'any', 'example' => '20', 'title' => ''], + 'BasicEditionDefaultValue' => ['description' => '**Basic Edition default value**'."\n", 'type' => 'any', 'example' => '0', 'title' => ''], + 'StandardEditionDefaultValue' => ['description' => '**Standard Edition default value**'."\n", 'type' => 'any', 'example' => '10000', 'title' => ''], + 'ProfessionalEditionDefaultValue' => ['description' => 'Professional Edition default value.'."\n", 'type' => 'any', 'example' => '200000', 'title' => ''], + 'EnterpriseEditionDefaultValue' => ['description' => 'Enterprise Edition default value.'."\n", 'type' => 'any', 'example' => '500000', 'title' => ''], + 'BasicEditionIntervalValue' => [ + 'description' => 'Basic Edition valid value range [min, max].'."\n", + 'type' => 'array', + 'items' => ['description' => 'Range start/end value.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'StandardEditionIntervalValue' => [ + 'description' => 'Standard Edition valid value range [min, max].'."\n", + 'type' => 'array', + 'items' => ['description' => 'Range start/end value.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'ProfessionalEditionIntervalValue' => [ + 'description' => 'Professional Edition valid value range [min, max].'."\n", + 'type' => 'array', + 'items' => ['description' => 'Range start/end value.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'EnterpriseEditionIntervalValue' => [ + 'description' => 'Enterprise Edition valid value range [min, max].'."\n", + 'type' => 'array', + 'items' => ['description' => 'Range start/end value.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], ], - 'DataSource' => [ - 'title' => '数据源', - 'description' => 'The data source.'."\n", + 'title' => '', + 'example' => '', + ], + 'OriginPolicyId' => ['description' => 'System default policy source ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''], + 'Creator' => ['description' => 'Creator user ID.'."\n", 'type' => 'string', 'example' => '203322746501002787', 'title' => ''], + 'Updater' => ['description' => 'Last updater user ID.'."\n", 'type' => 'string', 'example' => '207947397706614297', 'title' => ''], + 'CreateTime' => ['description' => 'Creation time.', 'type' => 'string', 'example' => '2026-05-25T20:46:19', 'title' => ''], + 'UpdateTime' => ['description' => 'Update time.', 'type' => 'string', 'example' => '2026-05-25T20:46:19', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Edition' => ['description' => 'Purchased DataWorks edition.'."\n", 'type' => 'string', 'example' => 'STANDARD', 'title' => ''], + 'EditionDisplayName' => ['description' => 'Purchased DataWorks edition name.'."\n", 'type' => 'string', 'example' => '标准版', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Match Best Security Policy', + 'description' => '## Request Description'."\n" + .'This API is used to find the most suitable security policy based on the provided control module, sub-module, and workspace ID. If a workspace ID is provided, the policy at the specified workspace level is matched first; otherwise, the tenant-level policy is returned. Note that system policies cannot be deleted or modified.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc5df3a17***903790e8e8a\\",\\n \\"Data\\": {\\n \\"SecurityStrategy\\": {\\n \\"Id\\": 16,\\n \\"Name\\": \\"默认数据分析策略\\",\\n \\"Description\\": \\"控制数据分析模块的查询结果安全行为\\",\\n \\"SchemaName\\": \\"DataQuerySecurityStrategySchema\\",\\n \\"ControlModule\\": \\"DataQuery\\",\\n \\"ControlSubModule\\": \\"MyCatalog\\",\\n \\"ControlDwScope\\": \\"Tenant\\",\\n \\"Workspaces\\": [\\n 12345\\n ],\\n \\"Enabled\\": true,\\n \\"Content\\": {\\n \\"Name\\": \\"DataQuerySecurityStrategySchema\\",\\n \\"DisplayName\\": \\"数据分析\\",\\n \\"DisplayNameEn\\": \\"Data Query\\",\\n \\"ControlModule\\": \\"DataQuery\\",\\n \\"ControlSubModule\\": \\"MyCatalog\\",\\n \\"ControlDwScope\\": \\"Tenant\\",\\n \\"SystemPolicyName\\": \\"SYSTEM_GENERATE_DEFAULT_DATA_QUERY\\",\\n \\"SystemPolicyDisplayName\\": \\"Default system generate data query policy\\",\\n \\"Controllers\\": [\\n {\\n \\"Controller\\": \\"viewCount\\",\\n \\"DisplayName\\": \\"查询结果-单次展示记录值上限\\",\\n \\"DisplayNameEn\\": \\"Query Results - Single Display Record Limit\\",\\n \\"Enable\\": true,\\n \\"ControllerValueType\\": \\"Integer\\",\\n \\"UserConfigValue\\": \\"20\\",\\n \\"BasicEditionDefaultValue\\": \\"0\\",\\n \\"StandardEditionDefaultValue\\": \\"10000\\",\\n \\"ProfessionalEditionDefaultValue\\": \\"200000\\",\\n \\"EnterpriseEditionDefaultValue\\": \\"500000\\",\\n \\"BasicEditionIntervalValue\\": [\\n 0\\n ],\\n \\"StandardEditionIntervalValue\\": [\\n 0\\n ],\\n \\"ProfessionalEditionIntervalValue\\": [\\n 0\\n ],\\n \\"EnterpriseEditionIntervalValue\\": [\\n 0\\n ]\\n }\\n ]\\n },\\n \\"OriginPolicyId\\": 12,\\n \\"Creator\\": \\"203322746501002787\\",\\n \\"Updater\\": \\"207947397706614297\\",\\n \\"CreateTime\\": \\"2026-05-25T20:46:19\\",\\n \\"UpdateTime\\": \\"2026-05-25T20:46:19\\"\\n },\\n \\"Edition\\": \\"STANDARD\\",\\n \\"EditionDisplayName\\": \\"标准版\\"\\n }\\n}","type":"json"}]', + ], + 'GetAgent' => [ + 'summary' => 'Retrieves agent details by name.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => 'TBD', + 'abilityTreeNodes' => ['FEATUREdideYTM537'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the skill to retrieve.', 'type' => 'string', 'required' => true, 'example' => 'my-skill', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '824F80BA-1778-5D8A-BAFF-668A4D9C4CC7'], + 'Agent' => [ + 'type' => 'object', + 'properties' => [ + 'CreatorId' => ['description' => 'The creator ID.', 'type' => 'string', 'example' => '123456', 'title' => ''], + 'ModifierId' => ['description' => 'The ID of the last modifier.', 'type' => 'string', 'example' => '123456', 'title' => ''], + 'Name' => ['description' => '**The agent name.**', 'type' => 'string', 'example' => 'my-agent', 'title' => ''], + 'DisplayName' => ['description' => '**The display name.**', 'type' => 'string', 'example' => '我的助手', 'title' => ''], + 'Description' => ['description' => '**The description.**', 'type' => 'string', 'example' => '数据分析助手', 'title' => ''], + 'Model' => [ + 'type' => 'object', + 'properties' => [ + 'ModelName' => ['description' => 'The model name.', 'type' => 'string', 'example' => 'qwen3-max', 'title' => ''], + 'Temperature' => ['description' => 'The temperature.', 'type' => 'number', 'format' => 'double', 'example' => '1', 'title' => ''], + 'TopP' => ['description' => 'The top-p.', 'type' => 'number', 'format' => 'double', 'example' => '1', 'title' => ''], + 'MaxTokens' => ['description' => 'The maximum number of tokens to generate in one response.', 'type' => 'integer', 'format' => 'int32', 'example' => '8192', 'title' => ''], + 'Stream' => ['description' => 'Indicates whether streaming output is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Config' => ['description' => 'Additional configuration for the model.', 'type' => 'object', 'example' => '{}', 'title' => ''], + ], + 'description' => '**The model configuration.**', + 'title' => '', + 'example' => '', + ], + 'SystemPrompt' => ['description' => '**The system prompt.**', 'type' => 'string', 'example' => '你是一个数据分析助手。', 'title' => ''], + 'Tools' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Kind' => ['description' => '**The tool type.**', 'type' => 'string', 'example' => 'builtin', 'title' => ''], + 'BuiltinName' => ['description' => '**The name of the built-in tool. This parameter applies only when `Kind` is set to `builtin`.**', 'type' => 'string', 'example' => 'builtin_sql', 'title' => ''], + 'McpServerName' => ['description' => '**The name of the associated MCP server. This parameter applies only when `Kind` is set to `mcp`.**', 'type' => 'string', 'example' => 'server-name', 'title' => ''], + 'McpItems' => [ + 'type' => 'array', + 'items' => ['description' => 'The name of a tool. If the `McpItems` array is empty or not provided, all tools are selected by default.', 'type' => 'string', 'example' => 'search_table', 'title' => ''], + 'description' => '**The selected MCP tool items. This parameter applies only when `Kind` is set to `mcp`.**', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '**A list of tools.**', + 'title' => '', + 'example' => '', + ], + 'Skills' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The skill name.', 'type' => 'string', 'example' => 'my-skill', 'title' => ''], + 'Version' => ['description' => 'The skill version.', 'type' => 'integer', 'format' => 'int32', 'example' => '-', 'title' => ''], + ], + 'description' => '-', + 'title' => '', + 'example' => '', + ], + 'description' => 'A list of skills.', + 'title' => '', + 'example' => '', + ], + 'CallableAgents' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The sub-agent name.', 'type' => 'string', 'example' => 'sub-agent', 'title' => ''], + 'DisplayName' => ['description' => 'The sub-agent display name.', 'type' => 'string', 'example' => '子助手', 'title' => ''], + 'Version' => ['description' => 'The sub-agent version.', 'type' => 'integer', 'format' => 'int32', 'example' => '-', 'title' => ''], + 'Source' => ['description' => 'The sub-agent source.', 'type' => 'string', 'example' => 'custom', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => 'A list of callable sub-agents.', + 'title' => '', + 'example' => '', + ], + 'RequiredRuntime' => [ + 'type' => 'array', + 'items' => ['description' => 'A runtime dependency.', 'type' => 'string', 'example' => '-', 'title' => ''], + 'description' => 'The runtime dependencies.', + 'title' => '', + 'example' => '', + ], + 'Metadata' => ['description' => '**Additional metadata.**', 'type' => 'object', 'example' => '{}', 'title' => ''], + 'Visibility' => ['description' => '**The visibility level.**', 'type' => 'string', 'example' => 'TENANT', 'title' => ''], + 'VisibilityScope' => [ + 'type' => 'object', + 'properties' => [ + 'ProjectIds' => [ + 'type' => 'array', + 'items' => ['description' => 'A project ID.', 'type' => 'string', 'example' => 'proj_001', 'title' => ''], + 'description' => 'A list of project IDs that can view the agent.', + 'title' => '', + 'example' => '', + ], + 'UserIds' => [ + 'type' => 'array', + 'items' => ['description' => 'A user ID.', 'type' => 'string', 'example' => '123456', 'title' => ''], + 'description' => 'A list of user IDs that can view the agent.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The visibility scope.', + 'title' => '', + 'example' => '', + ], + 'GmtCreateTime' => ['description' => 'The creation time, as a Unix timestamp in milliseconds.', 'type' => 'string', 'format' => 'iso8601', 'example' => '1780555634000', 'title' => ''], + 'GmtModifiedTime' => ['description' => 'The last modification time, as a Unix timestamp in milliseconds.', 'type' => 'string', 'format' => 'iso8601', 'example' => '1780555634000', 'title' => ''], + ], + 'description' => 'The agent details.', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'description' => 'The response parameters.', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetAgent', + 'description' => '## Request'."\n" + ."\n" + .'This API uses an agent\'s name, provided as a parameter, to retrieve its detailed configuration, including the model configuration, system prompt, and tool list.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"824F80BA-1778-5D8A-BAFF-668A4D9C4CC7\\",\\n \\"Agent\\": {\\n \\"CreatorId\\": \\"123456\\",\\n \\"ModifierId\\": \\"123456\\",\\n \\"Name\\": \\"my-agent\\",\\n \\"DisplayName\\": \\"我的助手\\",\\n \\"Description\\": \\"数据分析助手\\",\\n \\"Model\\": {\\n \\"ModelName\\": \\"qwen3-max\\",\\n \\"Temperature\\": 1,\\n \\"TopP\\": 1,\\n \\"MaxTokens\\": 8192,\\n \\"Stream\\": true,\\n \\"Config\\": {}\\n },\\n \\"SystemPrompt\\": \\"你是一个数据分析助手。\\",\\n \\"Tools\\": [\\n {\\n \\"Kind\\": \\"builtin\\",\\n \\"BuiltinName\\": \\"builtin_sql\\",\\n \\"McpServerName\\": \\"server-name\\",\\n \\"McpItems\\": [\\n \\"search_table\\"\\n ]\\n }\\n ],\\n \\"Skills\\": [\\n {\\n \\"Name\\": \\"my-skill\\",\\n \\"Version\\": 0\\n }\\n ],\\n \\"CallableAgents\\": [\\n {\\n \\"Name\\": \\"sub-agent\\",\\n \\"DisplayName\\": \\"子助手\\",\\n \\"Version\\": 0,\\n \\"Source\\": \\"custom\\"\\n }\\n ],\\n \\"RequiredRuntime\\": [\\n \\"-\\"\\n ],\\n \\"Metadata\\": {},\\n \\"Visibility\\": \\"TENANT\\",\\n \\"VisibilityScope\\": {\\n \\"ProjectIds\\": [\\n \\"proj_001\\"\\n ],\\n \\"UserIds\\": [\\n \\"123456\\"\\n ]\\n },\\n \\"GmtCreateTime\\": \\"1780555634000\\",\\n \\"GmtModifiedTime\\": \\"1780555634000\\"\\n }\\n}","type":"json"}]', + ], + 'GetAgentSessionArtifactMeta' => [ + 'summary' => 'Retrieves the metadata and content of an artifact based on a session ID and artifact path.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdideEWGMTH'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Jsonrpc', + 'in' => 'formData', + 'schema' => ['description' => 'The JSON-RPC version. The value is `2.0`.', 'type' => 'string', 'required' => false, 'example' => '2.0', 'title' => ''], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => 'A client-provided ID that is echoed in the response.', 'type' => 'string', 'required' => false, 'example' => '900335678024', 'title' => ''], + ], + [ + 'name' => 'Params', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'SessionId' => ['description' => 'The ID of the session.', 'type' => 'string', 'required' => false, 'example' => 'sess_0f12abc34', 'title' => ''], + 'ArtifactPath' => ['description' => 'The path of the artifact.', 'type' => 'string', 'required' => false, 'example' => 'mock/mock_report.md', 'title' => ''], + ], + 'description' => 'The container for business parameters.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request. You can use it to trace the request in logs.', 'type' => 'string', 'title' => '', 'example' => 'CE70C54F-A3BD-5C19-88EF-2A7D3451C449'], + 'JsonRpcResponse' => [ + 'type' => 'object', + 'properties' => [ + 'Jsonrpc' => ['description' => 'The JSON-RPC version. The value is `2.0`.', 'type' => 'string', 'example' => '2.0', 'title' => ''], + 'Id' => ['description' => 'The ID from the original request.', 'type' => 'string', 'example' => '300010555', 'title' => ''], + 'Result' => [ + 'type' => 'object', + 'properties' => [ + 'ArtifactPath' => ['description' => 'The path of the artifact.', 'type' => 'string', 'example' => 'mock/mock_report.md', 'title' => ''], + 'ArtifactName' => ['description' => 'The name of the artifact.', 'type' => 'string', 'example' => 'mock_report.md', 'title' => ''], + 'ArtifactContent' => ['description' => 'The content of the artifact.', 'type' => 'string', 'example' => 'This is md content', 'title' => ''], + ], + 'description' => 'Contains the metadata and content of the artifact.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The JSON-RPC response object.', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'description' => 'The response schema.', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetAgentSessionArtifactMeta', + 'description' => '## Description'."\n" + ."\n" + .'- This operation retrieves the metadata and content of a single artifact based on `SessionId` and `ArtifactPath`.'."\n" + ."\n" + .'- `SessionId` and `ArtifactPath` are required.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CE70C54F-A3BD-5C19-88EF-2A7D3451C449\\",\\n \\"JsonRpcResponse\\": {\\n \\"Jsonrpc\\": \\"2.0\\",\\n \\"Id\\": \\"300010555\\",\\n \\"Result\\": {\\n \\"ArtifactPath\\": \\"mock/mock_report.md\\",\\n \\"ArtifactName\\": \\"mock_report.md\\",\\n \\"ArtifactContent\\": \\"This is md content\\"\\n }\\n }\\n}","type":"json"}]', + ], + 'GetAgentSessionTokenUsage' => [ + 'summary' => 'Retrieves the cumulative AI token usage for a specified session.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdideEWGMTH'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Jsonrpc', + 'in' => 'formData', + 'schema' => ['description' => 'The JSON-RPC version. The value is always 2.0.', 'type' => 'string', 'required' => false, 'example' => '2.0', 'title' => ''], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => 'The ID provided by the requester, which is echoed in the response.', 'type' => 'string', 'required' => false, 'example' => '1033814166', 'title' => ''], + ], + [ + 'name' => 'Params', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'SessionId' => ['description' => 'The session ID. Required.', 'type' => 'string', 'required' => false, 'example' => 'sess_0f12abc34', 'title' => ''], + ], + 'description' => 'Business parameters.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'B313938A-4475-599B-98EB-A0875019FD5B'], + 'JsonRpcResponse' => [ + 'type' => 'object', + 'properties' => [ + 'Jsonrpc' => ['description' => 'The JSON-RPC version. The value is always 2.0.', 'type' => 'string', 'example' => '2.0', 'title' => ''], + 'Id' => ['description' => 'The ID provided by the requester, which is echoed in the response.', 'type' => 'string', 'example' => '8212598228302533855', 'title' => ''], + 'Result' => [ + 'type' => 'object', + 'properties' => [ + 'PromptTokens' => ['description' => '**Cumulative number of prompt tokens consumed.**', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''], + 'CompletionTokens' => ['description' => '**Cumulative number of completion tokens generated.**', 'type' => 'integer', 'format' => 'int64', 'example' => '2000', 'title' => ''], + 'ThoughtsTokens' => ['description' => 'Cumulative number of tokens used for thoughts.', 'type' => 'integer', 'format' => 'int64', 'example' => '3000', 'title' => ''], + 'TotalTokens' => ['description' => 'The cumulative number of all tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '2000', 'title' => ''], + 'CachedTokens' => ['description' => 'The cumulative number of cache-hit tokens.', 'type' => 'integer', 'format' => 'int64', 'example' => '4000', 'title' => ''], + ], + 'description' => 'Token usage result.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The JSON-RPC result.', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'description' => 'Schema of Response', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetAgentSessionTokenUsage', + 'description' => '## Description'."\n" + ."\n" + .'- This operation retrieves usage statistics for AI tokens in a specified session. It provides a breakdown of tokens for prompts, completions, and thoughts, as well as the total token count and the number of cache-hit tokens.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B313938A-4475-599B-98EB-A0875019FD5B\\",\\n \\"JsonRpcResponse\\": {\\n \\"Jsonrpc\\": \\"2.0\\",\\n \\"Id\\": \\"8212598228302533855\\",\\n \\"Result\\": {\\n \\"PromptTokens\\": 1000,\\n \\"CompletionTokens\\": 2000,\\n \\"ThoughtsTokens\\": 3000,\\n \\"TotalTokens\\": 2000,\\n \\"CachedTokens\\": 4000\\n }\\n }\\n}","type":"json"}]', + ], + 'GetAlertRule' => [ + 'summary' => 'Queries a custom alert monitoring rule.', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '249232', + 'abilityTreeNodes' => ['FEATUREdideRJGWWC'], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The rule ID.', 'type' => 'string', 'required' => false, 'example' => '28547072', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '8abcb91f-d266-4073-b907-2ed****'], + 'AlertRule' => [ + 'description' => 'The information about the rule.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '16035', 'title' => ''], + 'Name' => ['description' => 'The name of the rule.', 'type' => 'string', 'example' => 'error_rule', 'title' => ''], + 'Owner' => ['description' => 'The ID of the Alibaba Cloud account used by the owner of the rule.', 'type' => 'string', 'example' => '279961421580845157', 'title' => ''], + 'Enabled' => ['description' => 'Indicates whether the rule is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Notification' => [ + 'description' => 'The configuration for the alert notification.', + 'type' => 'object', + 'properties' => [ + 'SilenceStartTime' => ['description' => 'The start time for silence. The time is in the HH:mm:ss format.', 'type' => 'string', 'example' => '00:00:00', 'title' => ''], + 'SilenceEndTime' => ['description' => 'The end time for silence. The time is in the HH:mm:ss format.', 'type' => 'string', 'example' => '00:00:00', 'title' => ''], + 'IntervalInMinutes' => ['description' => 'The interval at which an alert notification is sent. Unit: minutes. Valid values: \\[5,10000].', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'Maximum' => ['description' => 'The maximum number of times an alert notification can be sent within a calendar day. Valid values: \\[1, 10000].', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'Channels' => [ + 'description' => 'The alert notification channels.', + 'type' => 'array', + 'items' => ['description' => 'The alert notification channel. Valid values:'."\n" + ."\n" + .'- Mail'."\n" + ."\n" + .'- Phone'."\n" + ."\n" + .'- Sms: text message'."\n" + ."\n" + .'- Dingding: DingTalk'."\n" + ."\n" + .'- Feishu: Lark'."\n" + ."\n" + .'- Weixin: WeCom'."\n" + ."\n" + .'- Webhook: custom webhook', 'type' => 'string', 'example' => 'Sms', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Receivers' => [ + 'description' => 'The alert recipients.', + 'type' => 'array', + 'items' => [ 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => '数据源名称', - 'description' => 'The name of the data source.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'odps_first', - 'pattern' => '', - 'default' => '', - ], - 'Type' => [ - 'title' => '数据源类型', - 'description' => 'The type of the data source.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'odps', - 'pattern' => '', - 'default' => '', + 'ReceiverType' => ['description' => 'The type of the alert recipient. Valid valves:'."\n" + ."\n" + .'- AliUid: Alibaba Cloud account ID.'."\n" + ."\n" + .'- Shift Schedules: the personnel in a shift schedule.'."\n" + ."\n" + .'- TaskOwner: the task owner. The task owner can receive custom alerts and event alerts.'."\n" + ."\n" + .'- Owner: the baseline owner. The baseline owner can receive baseline alerts.'."\n" + ."\n" + .'- WebhookUrl: URL of a custom webhook.'."\n" + ."\n" + .'- DingdingUrl: DingTalk webhook URL.'."\n" + ."\n" + .'- FeishuUrl: Lark webhook URL.'."\n" + ."\n" + .'- WeixinUrl: WeCom webhook URL.', 'type' => 'string', 'example' => 'WebhookUrl', 'title' => ''], + 'ReceiverValues' => [ + 'description' => 'The alert recipients.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the alert recipient. If the ReceiverType parameter is set to AliUid, set this parameter to an Alibaba Cloud account ID. If the ReceiverType parameter is set to ShiftSchedule, set this parameter to a shift schedule ID. If the ReceiverType parameter is set to WebhookUrl, DingdingUrl, FeishuUrl, or WeixinUrl, set this parameter to a corresponding URL.', 'type' => 'string', 'example' => '123123123', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'Extension' => ['description' => 'The additional configuration of the alert recipient. If the ReceiverType parameter is set to DingdingUrl, you can set this parameter to {"atAll":true} to remind all members in a DingTalk group.', 'type' => 'string', 'example' => '{"atAll":true}', 'title' => ''], ], - 'deprecated' => false, - ], - 'TaskId' => [ - 'title' => '调度任务Id', - 'description' => 'The ID of the scheduling task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'deprecated' => false, - 'example' => '88888888888', - 'pattern' => '', - 'default' => '', + 'description' => '', + 'title' => '', + 'example' => '', ], - 'Tags' => [ - 'title' => '标签信息', - 'description' => 'The tag information (not in use).'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '单个标签', - 'description' => 'The single tag (not in use).'."\n", + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'TriggerCondition' => [ + 'description' => 'The alert triggering condition.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The alert type. Valid values:'."\n" + ."\n" + .'- Finished: An instance is successfully run.'."\n" + ."\n" + .'- UnFinished: An instance does not finish running before a specified point in time.'."\n" + ."\n" + .'- Error: An error occurs on an instance.'."\n" + ."\n" + .'- CycleUnfinished: An instance does not finish running as expected within a specific cycle.'."\n" + ."\n" + .'- Timeout: An instance times out.'."\n" + ."\n" + .'- InstanceTransferComplete: An instance is generated by the auto triggered node.'."\n" + ."\n" + .'- InstanceTransferFluctuate: The number of generated instances fluctuates.'."\n" + ."\n" + .'- ExhaustedError: An error persists after an instance is automatically rerun.'."\n" + ."\n" + .'- InstanceKeyword: An instance with errors contains specified keywords.'."\n" + ."\n" + .'- InstanceErrorCount: The number of instances on which an error occurs reaches a specified threshold.'."\n" + ."\n" + .'- InstanceErrorPercentage: The proportion of instances on which an error occurs in the workspace to the total number of instances reaches a specified threshold.'."\n" + ."\n" + .'- ResourceGroupPercentage: The usage rate of the resource group reaches a specified threshold.'."\n" + ."\n" + .'- ResourceGroupWaitCount: The number of instances that are waiting for resources in the resource group reaches a specified threshold.', 'type' => 'string', 'example' => 'Error', 'title' => ''], + 'Extension' => [ + 'description' => 'The extended information about the rule. This parameter is required for specific types of alerts.', + 'type' => 'object', + 'properties' => [ + 'Error' => [ + 'description' => 'The configuration for an alert of the Error type.', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'title' => '标签键', - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'null', - 'pattern' => '', - 'default' => '', - ], - 'Value' => [ - 'title' => '标签值', - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'null', - 'pattern' => '', - 'default' => '', + 'StreamTaskIds' => [ + 'description' => 'The IDs of the real-time computing tasks. This parameter is required when you monitor real-time computing tasks.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the real-time computing task.', 'type' => 'integer', 'format' => 'int64', 'example' => '123123', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'AutoRerunAlertEnabled' => ['description' => 'Indicates whether an alert is triggered if a batch synchronization task is automatically rerun upon a failure.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], ], - 'deprecated' => false, + 'title' => '', + 'example' => '', ], - 'deprecated' => false, - ], - 'Strategy' => [ - 'title' => '调度策略', - 'description' => 'The scheduling policy.'."\n", - 'type' => 'object', - 'properties' => [ - 'Timeout' => [ - 'title' => '超时时间', - 'description' => 'Timeout.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'deprecated' => false, - 'example' => '0', - 'pattern' => '', - 'default' => '', - ], - 'InstanceMode' => [ - 'title' => '生成实例的模式', - 'description' => 'The instance generation mode. Valid values:'."\n" - ."\n" - .'* T+1'."\n" - .'* Immediately'."\n", - 'type' => 'string', - 'deprecated' => false, - 'enumValueTitles' => [], - 'example' => 'T+1', - 'pattern' => '', - 'default' => '', - 'enum' => [ - 'T+1', - 'Immediately', - ], - ], - 'RerunMode' => [ - 'title' => '允许重跑的模式', - 'description' => 'The rerun mode. Valid values:'."\n" - ."\n" - .'* Allowed'."\n" - .'* Denied'."\n" - .'* FailureAllowed'."\n", - 'type' => 'string', - 'deprecated' => false, - 'enumValueTitles' => [], - 'example' => 'Allowed', - 'pattern' => '', - 'default' => '', - 'enum' => [ - 'Allowed', - 'Denied', - 'FailureAllowed', - ], - ], - 'RerunTimes' => [ - 'title' => '重试次数', - 'description' => 'The number of reruns.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'deprecated' => false, - 'example' => '3', - 'pattern' => '', - 'default' => '', - ], - 'RerunInterval' => [ - 'title' => '重试时间间隔', - 'description' => 'The rerun interval. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'deprecated' => false, - 'example' => '180000', - 'pattern' => '', - 'default' => '', + 'Timeout' => [ + 'description' => 'The configuration for an alert of the Timeout type.', + 'type' => 'object', + 'properties' => [ + 'TimeoutInMinutes' => ['description' => 'The timeout period. Unit: minutes. Valid values: \\[1, 21600].', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'deprecated' => false, - ], - 'Outputs' => [ - 'title' => '节点输出', - 'description' => 'The output of the node.'."\n", - 'type' => 'object', - 'properties' => [ - 'Variables' => [ - 'title' => '变量列表', - 'description' => 'The variable list.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '变量元素', - 'description' => 'The variable.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '变量名', - 'description' => 'The name of the variable.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'output'."\n", - 'pattern' => '', - 'default' => '', - ], - 'ArtifactType' => [ - 'title' => '制品类型', - 'description' => 'The artifact type.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'Variable', - 'pattern' => '', - 'default' => '', - ], - 'Scope' => [ - 'title' => '范围', - 'description' => 'The variable scope. Valid values:'."\n" - ."\n" - .'* NodeParameter'."\n" - .'* NodeContext'."\n" - .'* Workflow'."\n" - .'* Workspace'."\n", - 'type' => 'string', - 'deprecated' => false, - 'enumValueTitles' => [], - 'example' => 'NodeParameter', - 'pattern' => '', - 'default' => '', - ], - 'Type' => [ - 'title' => '类型', - 'description' => 'The variable type. Valid values:'."\n" - ."\n" - .'* NoKvVariableExpression'."\n" - .'* Constant'."\n" - .'* PassThrough'."\n" - .'* System'."\n" - .'* NodeOutput'."\n", - 'type' => 'string', - 'deprecated' => false, - 'enumValueTitles' => [], - 'example' => 'Constant', - 'pattern' => '', - 'default' => '', - ], - 'Value' => [ - 'title' => '变量值', - 'description' => 'The variable value.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => '111', - 'pattern' => '', - 'default' => '', - ], - 'Node' => [ - 'title' => '变量所属节点', - 'description' => 'The node to which the variable belongs.'."\n", - 'type' => 'object', - 'properties' => [ - 'Output' => [ - 'title' => '节点输出', - 'description' => 'The output of the node.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => '860438872620113XXXX', - 'pattern' => '', - 'default' => '', - ], - ], - 'deprecated' => false, - ], - 'Id' => [ - 'description' => 'The variable ID.'."\n" - ."\n" - .'> Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => '623731286945488XXXX', - 'title' => '', - ], - ], - 'deprecated' => false, - ], - 'deprecated' => false, - ], - 'NodeOutputs' => [ - 'title' => '节点输出列表', - 'description' => 'The node output list.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '节点输出项', - 'description' => 'The node output item.'."\n", - 'type' => 'object', - 'properties' => [ - 'Data' => [ - 'title' => '节点输出', - 'description' => 'The output of the node.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => '860438872620113XXXX', - 'pattern' => '', - 'default' => '', - ], - ], - 'deprecated' => false, - ], - 'deprecated' => false, - ], - 'Tables' => [ - 'title' => '表列表', - 'description' => 'The table list.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '表输出项', - 'description' => 'The table output item.'."\n", - 'type' => 'object', - 'properties' => [ - 'Guid' => [ - 'title' => '表id', - 'description' => 'The table ID.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'odps.autotest.test_output_table_1', - 'pattern' => '', - 'default' => '', - ], - ], - 'deprecated' => false, - ], - 'deprecated' => false, + 'UnFinished' => [ + 'description' => 'The configuration for an alert of the UnFinished type.', + 'type' => 'object', + 'properties' => [ + 'UnFinishedTime' => ['description' => 'The latest completion time of the instance. The period is in the hh:mm format. Valid values of hh: \\[0,47]. Valid values of mm: \\[0,59].', 'type' => 'string', 'example' => '12:00', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'deprecated' => false, - ], - 'Inputs' => [ - 'title' => '节点输入', - 'description' => 'The node input.'."\n", - 'type' => 'object', - 'properties' => [ - 'Variables' => [ - 'title' => '变量列表', - 'description' => 'The variable list.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '变量元素', - 'description' => 'The variable.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '变量名', - 'description' => 'The name of the variable.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'input', - 'pattern' => '', - 'default' => '', - ], - 'ArtifactType' => [ - 'title' => '制品类型', - 'description' => 'The artifact type.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'Variable', - 'pattern' => '', - 'default' => '', - ], - 'Scope' => [ - 'title' => '范围', - 'description' => 'The scope of the variable. Valid values:'."\n" - ."\n" - .'* WorkSpace'."\n" - .'* NodeParameter'."\n" - .'* NodeContext'."\n" - .'* Workflow'."\n", - 'type' => 'string', - 'deprecated' => false, - 'enumValueTitles' => [], - 'example' => 'NodeParameter', - 'pattern' => '', - 'default' => '', - ], - 'Type' => [ - 'title' => '类型', - 'description' => 'The type of the variable. Valid values:'."\n" - ."\n" - .'* NoKvVariableExpression'."\n" - .'* Constant'."\n" - .'* PassThrough'."\n" - .'* System'."\n" - .'* NodeOutput'."\n", - 'type' => 'string', - 'deprecated' => false, - 'enumValueTitles' => [], - 'example' => 'Constant', - 'pattern' => '', - 'default' => '', - ], - 'Value' => [ - 'title' => '变量值', - 'description' => 'The variable value.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => '222', - 'pattern' => '', - 'default' => '', - ], - 'Node' => [ - 'title' => '变量所属节点', - 'description' => 'The node to which the variable belongs.'."\n", - 'type' => 'object', - 'properties' => [ - 'Output' => [ - 'title' => '节点输出', - 'description' => 'The output of the node.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => '623731286945488XXXX', - 'pattern' => '', - 'default' => '', - ], - ], - 'deprecated' => false, - ], - 'Id' => [ - 'description' => 'The variable ID.'."\n" - ."\n" - .'> Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => '543211286945488XXXX', - 'title' => '', + 'CycleUnfinished' => [ + 'description' => 'The configuration for an alert of the CycleUnfinished type.', + 'type' => 'object', + 'properties' => [ + 'CycleAndTime' => [ + 'description' => 'The configurations of the scheduling cycle and timeout period of the instance.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CycleId' => ['description' => 'The ID of the scheduling cycle of the instance. Valid values: \\[1,288].', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Time' => ['description' => 'The latest completion time of the instance within the scheduling cycle. The time is in the hh:mm format. Valid values of hh: \\[0,47]. Valid values of mm: \\[0,59].', 'type' => 'string', 'example' => '12:00', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'deprecated' => false, + 'title' => '', + 'example' => '', ], - 'deprecated' => false, ], - 'NodeOutputs' => [ - 'title' => '节点输出列表', - 'description' => 'The node output list.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '节点输出项', - 'description' => 'The node output item.'."\n", - 'type' => 'object', - 'properties' => [ - 'Data' => [ - 'title' => '节点输出', - 'description' => 'The output of the node.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => '623731286945488XXXX', - 'pattern' => '', - 'default' => '', - ], - ], - 'deprecated' => false, - ], - 'deprecated' => false, + 'title' => '', + 'example' => '', + ], + 'InstanceErrorCount' => [ + 'description' => 'The configuration for an alert of the InstanceErrorCount type.', + 'type' => 'object', + 'properties' => [ + 'Count' => ['description' => 'The maximum number of instances on which an error occurs. Valid values: \\[1,10000].', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], ], - 'Tables' => [ - 'title' => '表列表', - 'description' => 'The table list.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '表输出项', - 'description' => 'The table output item.'."\n", - 'type' => 'object', - 'properties' => [ - 'Guid' => [ - 'title' => '表id', - 'description' => 'The table ID.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'odps.autotest.test_output_table_1', - 'pattern' => '', - 'default' => '', - ], - ], - 'deprecated' => false, - ], - 'deprecated' => false, + 'title' => '', + 'example' => '', + ], + 'InstanceErrorPercentage' => [ + 'description' => 'The configuration for an alert of the InstanceErrorPercentage type.', + 'type' => 'object', + 'properties' => [ + 'Percentage' => ['description' => 'The maximum percentage of instances on which an error occurs in the workspace to the total number of instances. Valid values: \\[1-100].', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'deprecated' => false, - ], - 'Trigger' => [ - 'title' => '触发器', - 'description' => 'The trigger.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '类型', - 'description' => 'The trigger type.'."\n" + 'InstanceTransferFluctuate' => [ + 'description' => 'The configuration for an alert of the InstanceTransferFluctuate type.', + 'type' => 'object', + 'properties' => [ + 'Trend' => ['description' => 'The way in which the number of auto triggered node instances that are generated in your workspace fluctuates. Valid values:'."\n" ."\n" - .'Valid values:'."\n" + .'- abs: the absolute value. The number of instances increases or decreases.'."\n" ."\n" - .'* Scheduler: Periodic scheduling'."\n" - .'* Manual: Manual trigger'."\n" - .'* Streaming: Streaming task'."\n", - 'type' => 'string', - 'deprecated' => false, - 'enumValueTitles' => [], - 'example' => 'Scheduler', - 'pattern' => '', - 'default' => '', - ], - 'Cron' => [ - 'title' => 'cron表达式', - 'description' => 'The cron expression for scheduling.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => '00 00 00 * * ?', - 'pattern' => '', - 'default' => '', - ], - 'StartTime' => [ - 'title' => '开始时间', - 'description' => 'The start time of the validity period of the trigger.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => '1970-01-01 00:00:00', - 'pattern' => '', - 'default' => '', - ], - 'EndTime' => [ - 'title' => '结束时间', - 'description' => 'The end time of the validity period of the trigger.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => '9999-01-01 00:00:00', - 'pattern' => '', - 'default' => '', - ], - 'Timezone' => [ - 'title' => '时区', - 'description' => 'The time zone.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'Asia/Shanghai', - 'pattern' => '', - 'default' => '', - ], - 'Id' => [ - 'description' => 'The trigger ID.'."\n" + .'- increase: The number of instances increases.'."\n" ."\n" - .'> Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => '543680677872062XXXX', - 'title' => '', + .'- decrease: The number of instances decreases.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'Percentage' => ['description' => 'The maximum percentage of fluctuation in the number of auto triggered node instances that are generated in your workspace. Valid values: \\[1-100].', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'deprecated' => false, ], - 'Script' => [ - 'title' => '脚本信息', - 'description' => 'The script information.'."\n", + 'title' => '', + 'example' => '', + ], + 'Target' => [ + 'description' => 'The monitored objects.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The type of the monitored objects. Valid values:'."\n" + ."\n" + .'- Task: node'."\n" + ."\n" + .'- Baseline: baseline'."\n" + ."\n" + .'- project: workspace'."\n" + ."\n" + .'- BizProcess: workflow', 'type' => 'string', 'example' => 'Task', 'title' => ''], + 'Ids' => [ + 'description' => 'The IDs of monitored objects.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the monitored object.', 'type' => 'integer', 'format' => 'int64', 'example' => '32570', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'AllowTasks' => [ + 'description' => 'The nodes that are not to be monitored.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the node that is not to be monitored.', 'type' => 'integer', 'format' => 'int64', 'example' => '123123', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8abcb91f-d266-4073-b907-2ed****\\",\\n \\"AlertRule\\": {\\n \\"Id\\": 16035,\\n \\"Name\\": \\"error_rule\\",\\n \\"Owner\\": \\"279961421580845157\\",\\n \\"Enabled\\": true,\\n \\"Notification\\": {\\n \\"SilenceStartTime\\": \\"00:00:00\\",\\n \\"SilenceEndTime\\": \\"00:00:00\\",\\n \\"IntervalInMinutes\\": 30,\\n \\"Maximum\\": 3,\\n \\"Channels\\": [\\n \\"Sms\\"\\n ],\\n \\"Receivers\\": [\\n {\\n \\"ReceiverType\\": \\"WebhookUrl\\",\\n \\"ReceiverValues\\": [\\n \\"123123123\\"\\n ],\\n \\"Extension\\": \\"{\\\\\\"atAll\\\\\\":true}\\"\\n }\\n ]\\n },\\n \\"TriggerCondition\\": {\\n \\"Type\\": \\"Error\\",\\n \\"Extension\\": {\\n \\"Error\\": {\\n \\"StreamTaskIds\\": [\\n 123123\\n ],\\n \\"AutoRerunAlertEnabled\\": false\\n },\\n \\"Timeout\\": {\\n \\"TimeoutInMinutes\\": 10\\n },\\n \\"UnFinished\\": {\\n \\"UnFinishedTime\\": \\"12:00\\"\\n },\\n \\"CycleUnfinished\\": {\\n \\"CycleAndTime\\": [\\n {\\n \\"CycleId\\": 1,\\n \\"Time\\": \\"12:00\\"\\n }\\n ]\\n },\\n \\"InstanceErrorCount\\": {\\n \\"Count\\": 10\\n },\\n \\"InstanceErrorPercentage\\": {\\n \\"Percentage\\": 10\\n },\\n \\"InstanceTransferFluctuate\\": {\\n \\"Trend\\": \\"10\\",\\n \\"Percentage\\": 10\\n }\\n },\\n \\"Target\\": {\\n \\"Type\\": \\"Task\\",\\n \\"Ids\\": [\\n 32570\\n ],\\n \\"AllowTasks\\": [\\n 123123\\n ]\\n }\\n }\\n }\\n}","type":"json"}]', + 'title' => 'GetAlertRule', + 'changeSet' => [ + ['createdAt' => '2024-12-27T03:06:33.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'GetApplicationContents' => [ + 'summary' => 'Queries the content of resource permission applications under the specified process instance ID.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => 'TBD', + 'abilityTreeNodes' => ['FEATUREdideYTM537'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ProcessInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The approval process instance ID of the submitted application.'."\n", 'type' => 'string', 'required' => true, 'example' => '332066440109224007', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID, which is used for locating logs and troubleshooting.', 'type' => 'string', 'example' => '34267E2E-0335-1A60-A1F0-ADA530890CBA'], + 'Data' => [ + 'description' => 'The process instance and associated application content.', + 'type' => 'object', + 'properties' => [ + 'ProcessInstanceId' => ['description' => 'The process instance ID.'."\n", 'type' => 'string', 'example' => '332066440109224007', 'title' => ''], + 'DefSchema' => [ + 'description' => 'The resource type.'."\n" + ."\n" + .'Note: The resource types supported for applications are constrained by [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).name.'."\n" + ."\n" + .'See also: [ResourceSchema documentation on the international site](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)', + 'enumValueTitles' => ['MaxCompute' => 'MaxCompute', 'LINDORM' => 'LINDORM', 'EMR_ON_ECS_HIVE' => 'EMR_ON_ECS_HIVE', 'DLF_V1' => 'DLF_V1', 'HOLOGRES' => 'HOLOGRES', 'SEVERLESS_STARROCKS' => 'SEVERLESS_STARROCKS', 'DATAWORKS_ENTITY' => 'DATAWORKS_ENTITY', 'DLF_NEXT' => 'DLF_NEXT'], + 'type' => 'string', + 'example' => 'MaxCompute', + 'title' => '', + ], + 'Reason' => ['description' => 'The application reason.'."\n", 'type' => 'string', 'example' => '业务需要', 'title' => ''], + 'ApplicationTime' => ['description' => 'The time when the application was submitted, as a millisecond timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1779675618000', 'title' => ''], + 'Status' => [ + 'description' => 'The approval status. Valid values:'."\n" + ."\n" + .'- WaitApproval: Pending approval.'."\n" + .'- Confirmed: Pending authorization.'."\n" + .'- RejectApproval: Approval rejected.'."\n" + .'- AuthorizeSucceed: Authorization succeeded.'."\n" + .'- AuthorizeFailed: Authorization failed.'."\n" + .'- Deleted: Deleted.'."\n" + .'- Canceled: Canceled.', + 'enumValueTitles' => ['WaitApproval' => 'Pending Approval', 'AuthorizeSucceed' => 'Authorization Succeeded', 'AuthorizeFailed' => 'Authorization Failed', 'Confirmed' => 'Pending Authorization', 'Deleted' => 'Deleted', 'RejectApproval' => 'Approval Rejected'], + 'type' => 'string', + 'example' => 'WaitApproval', + 'title' => '', + ], + 'Contents' => [ + 'description' => 'The list of application contents.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of an application content.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The unique identifier of the application content.', 'type' => 'string', 'example' => 'Y9H7AKFmjhWzLYdZNDZA5', 'title' => ''], + 'ProcessInstanceId' => ['description' => 'The approval process instance ID of the submitted application.'."\n", 'type' => 'string', 'example' => '777799223', 'title' => ''], + 'TenantId' => ['description' => 'The tenant ID.'."\n", 'type' => 'string', 'example' => '69973837489', 'title' => ''], + 'ResourceName' => ['description' => 'The minimum-permission resource type.'."\n" + ."\n" + .'Note: The minimum-permission resource type is constrained by [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).resources[*].isValidLeaf being true.'."\n" + ."\n" + .'See also: [ResourceSchema documentation on the international site](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)', 'type' => 'string', 'example' => 'table', 'title' => ''], + 'DefSchema' => [ + 'description' => 'The resource type.'."\n" + ."\n" + .'Note: The resource types supported for applications are constrained by [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).name.'."\n" + ."\n" + .'See also: [ResourceSchema documentation on the international site](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)', + 'enumValueTitles' => ['MaxCompute' => 'MaxCompute', 'LINDORM' => 'LINDORM', 'EMR_ON_ECS_HIVE' => 'EMR_ON_ECS_HIVE', 'DLF_V1' => 'DLF_V1', 'HOLOGRES' => 'HOLOGRES', 'SEVERLESS_STARROCKS' => 'SEVERLESS_STARROCKS', 'DATAWORKS_ENTITY' => 'DATAWORKS_ENTITY', 'DLF_NEXT' => 'DLF_NEXT'], + 'type' => 'string', + 'example' => 'MaxCompute', + 'title' => '', + ], + 'AuthMethod' => ['description' => 'The authorization method. Currently, only SEVERLESS_STARROCKS supports specifying the authorization method: ranger or starrocksManager.'."\n" + ."\n" + .'Note: Different resources support different authorization methods, all constrained by [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).authMethods.'."\n" + ."\n" + .'See also: [ResourceSchema documentation on the international site](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)', 'type' => 'string', 'example' => 'ranger', 'title' => ''], + 'Resource' => [ + 'description' => 'The resource declaration. The resource description is constrained by [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).'."\n" + ."\n" + .'See also: [ResourceSchema documentation on the international site](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)', 'type' => 'object', 'properties' => [ - 'Path' => [ - 'title' => '脚本路径', - 'description' => 'The script path.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'root/demo', - 'pattern' => '', - 'default' => '', - ], - 'Runtime' => [ - 'title' => '运行时', - 'description' => 'The runtime.'."\n", - 'type' => 'object', - 'properties' => [ - 'Command' => [ - 'title' => '命令', - 'description' => 'The command used to distinguish node types.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'ODPS_SQL', - 'pattern' => '', - 'default' => '', - ], - ], - 'deprecated' => false, - ], - 'Id' => [ - 'description' => 'The ID of the script.'."\n" + 'DefSchema' => [ + 'description' => 'The resource type.'."\n" + ."\n" + .'Note: The resource types supported for applications are constrained by [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).name.'."\n" ."\n" - .'> This field is of type Long in SDK versions prior to 8.0.0, and of type String in SDK version 8.0.0 and later. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.'."\n", + .'See also: [ResourceSchema documentation on the international site](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)', + 'enumValueTitles' => ['MaxCompute' => 'MaxCompute', 'LINDORM' => 'LINDORM', 'EMR_ON_ECS_HIVE' => 'EMR_ON_ECS_HIVE', 'DLF_V1' => 'DLF_V1', 'HOLOGRES' => 'HOLOGRES', 'SEVERLESS_STARROCKS' => 'SEVERLESS_STARROCKS', 'DATAWORKS_ENTITY' => 'DATAWORKS_ENTITY', 'DLF_NEXT' => 'DLF_NEXT'], 'type' => 'string', - 'deprecated' => false, - 'example' => '853573334108680XXXX', + 'example' => 'MaxCompute', 'title' => '', ], + 'DefVersion' => ['description' => 'The resource parsing version, which is constrained by [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).version.'."\n" + ."\n" + .'See also: [ResourceSchema documentation on the international site](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)', 'type' => 'string', 'example' => 'v1.0.0', 'title' => ''], + 'MetaData' => ['description' => 'The resource metadata declaration.'."\n" + ."\n" + .'Note: The metadata is constrained by [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).resources. A valid resource declaration must include the full-path metadata declaration from level 0 to the validLeaf level.'."\n" + ."\n" + .'See also: [ResourceSchema documentation on the international site](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)', 'type' => 'string', 'example' => '"{\\"schema\\":\\"default\\",\\"threeTierModel\\":false,\\"workspace\\":\\"449656\\",\\"project\\":\\"sync_destination\\",\\"table\\":\\"order_table\\",\\"tenant\\":\\"524997424564736\\"}"', 'title' => ''], ], - 'deprecated' => false, - 'required' => false, + 'title' => '', + 'example' => '', ], - 'RuntimeResource' => [ - 'title' => '资源组信息', - 'description' => 'The information about the resource group.'."\n", + 'Grantee' => [ + 'description' => 'The grantee description.'."\n" + ."\n" + .'Note: The grantee principal types supported by the system are constrained by [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).authPrincipal.'."\n" + ."\n" + .'See also: [ResourceSchema documentation on the international site](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)', 'type' => 'object', 'properties' => [ - 'ResourceGroupId' => [ - 'title' => '资源组id', - 'description' => 'The resource group ID.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'S_resgrop_xxx', - 'pattern' => '', - 'default' => '', - ], - 'ResourceGroup' => [ - 'description' => 'The identifier of the resource group. You can call the [ListResourceGroups](~~173913~~) operation to query the identifier of the resource group.'."\n", + 'PrincipalType' => [ + 'description' => 'The grantee principal type. Valid values:'."\n" + ."\n" + .'- RamUser'."\n" + .'- RamRole'."\n" + .'- DlfRole', + 'enumValueTitles' => ['DlfRole' => 'DlfRole', 'RamUser' => 'RamUser', 'RamRole' => 'RamRole'], 'type' => 'string', - 'example' => 'S_res_group_XXXX', + 'example' => 'RamRole', + 'title' => '', ], + 'PrincipalId' => ['description' => 'The grantee principal ID. The ID has different meanings depending on the principal type:'."\n" + ."\n" + .'- RamUser: DataWorks UserId.'."\n" + ."\n" + .'- RamRole: DataWorks UserId prefixed with "ROLE_".'."\n" + ."\n" + .'- DlfRole: DlfNext role name.', 'type' => 'string', 'example' => 'ROLE_3133343434', 'title' => ''], ], - 'deprecated' => false, + 'title' => '', + 'example' => '', ], - 'Recurrence' => [ - 'description' => 'The scheduling type.'."\n" + 'AccessTypes' => [ + 'description' => 'The list of requested permissions.'."\n" ."\n" - .'Valid values:'."\n" + .'Note: Different levels of resources support different permission application types, all constrained by [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).isValidLeaf, accessTypeRestrictions, and authMethodAccessTypes.'."\n" ."\n" - .'* Normal: The node is scheduled as expected.'."\n" - .'* Pause: The node is paused, and the running of its descendant nodes is blocked.'."\n" - .'* Skip: The node is dry run. The system does not actually run the node but directly prompts that the node is successfully run. The running duration of the node is 0 seconds. In addition, the node does not occupy resources or block the running of its descendant nodes.'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Normal', + .'See also: [ResourceSchema documentation on the international site](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)', + 'type' => 'array', + 'items' => ['description' => 'The operation permission.', 'type' => 'string', 'example' => 'select', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'FinalAccessTypes' => [ + 'description' => 'The list of resource operation permissions that are finally approved.', + 'type' => 'array', + 'items' => ['description' => 'The approved operation permission.', 'type' => 'string', 'example' => 'select', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'Id' => [ - 'description' => 'The unique identifier of the Data Studio node.'."\n" + 'ExpirationTime' => ['description' => 'The permission expiration date, as a millisecond timestamp.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1785835708000', 'title' => ''], + 'Status' => [ + 'description' => 'The approval status. Valid values:'."\n" ."\n" - .'> This field is of the Long type in SDK versions prior to 8.0.0, and of the String type in SDK versions 8.0.0 and later. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.'."\n", - 'type' => 'string', - 'example' => '860438872620113XXXX', + .'- WaitApproval: Pending approval.'."\n" + .'- Confirmed: Pending authorization.'."\n" + .'- RejectApproval: Approval rejected.'."\n" + .'- AuthorizeSucceed: Authorization succeeded.'."\n" + .'- AuthorizeFailed: Authorization failed.'."\n" + .'- Deleted: Deleted.'."\n" + .'- Canceled: Canceled.', + 'enumValueTitles' => ['WaitApproval' => 'Pending Approval', 'AuthorizeSucceed' => 'Authorization Succeeded', 'AuthorizeFailed' => 'Authorization Failed', 'Confirmed' => 'Pending Authorization', 'Deleted' => 'Deleted During Approval', 'RejectApproval' => 'Approval Rejected'], + 'type' => 'string', + 'example' => 'Deleted', + 'title' => '', ], + 'CreateTime' => ['description' => 'The creation time.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1773972024000', 'title' => ''], + 'UpdateTime' => ['description' => 'The update time.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1773972024000', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Get Resource Permission Application Details', + 'description' => '## Request Description'."\n" + .'- This API is used to query the details of resource permission applications based on the provided `ProcessInstanceId`.'."\n" + .'- A valid `ProcessInstanceId` parameter must be provided in the request.'."\n" + .'- The response includes the basic information, status, and the list of specific application contents.'."\n" + .'- Each application content includes detailed resource information, the grantee, the requested operation permissions, and more.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"34267E2E-0335-1A60-A1F0-ADA530890CBA\\",\\n \\"Data\\": {\\n \\"ProcessInstanceId\\": \\"332066440109224007\\",\\n \\"DefSchema\\": \\"MaxCompute\\",\\n \\"Reason\\": \\"业务需要\\",\\n \\"ApplicationTime\\": 1779675618000,\\n \\"Status\\": \\"WaitApproval\\",\\n \\"Contents\\": [\\n {\\n \\"Id\\": \\"Y9H7AKFmjhWzLYdZNDZA5\\",\\n \\"ProcessInstanceId\\": \\"777799223\\",\\n \\"TenantId\\": \\"69973837489\\",\\n \\"ResourceName\\": \\"table\\",\\n \\"DefSchema\\": \\"MaxCompute\\",\\n \\"AuthMethod\\": \\"ranger\\",\\n \\"Resource\\": {\\n \\"DefSchema\\": \\"MaxCompute\\",\\n \\"DefVersion\\": \\"v1.0.0\\",\\n \\"MetaData\\": \\"\\\\\\"{\\\\\\\\\\\\\\"schema\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"default\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"threeTierModel\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"workspace\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"449656\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"project\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"sync_destination\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"table\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"order_table\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"tenant\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"524997424564736\\\\\\\\\\\\\\"}\\\\\\"\\"\\n },\\n \\"Grantee\\": {\\n \\"PrincipalType\\": \\"RamRole\\",\\n \\"PrincipalId\\": \\"ROLE_3133343434\\"\\n },\\n \\"AccessTypes\\": [\\n \\"select\\"\\n ],\\n \\"FinalAccessTypes\\": [\\n \\"select\\"\\n ],\\n \\"ExpirationTime\\": 1785835708000,\\n \\"Status\\": \\"Deleted\\",\\n \\"CreateTime\\": 1773972024000,\\n \\"UpdateTime\\": 1773972024000\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'GetBusiness' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '268608', + 'abilityTreeNodes' => ['FEATUREdide8FM783'], + ], + '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 specify either this parameter or the ProjectIdentifier parameter to identify the DataWorks workspace when you call this operation.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10000', 'title' => ''], + ], + [ + '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 query the workspace name. You must specify either this parameter or the ProjectId parameter to identify the DataWorks workspace when you call this operation.', 'type' => 'string', 'required' => false, 'example' => 'dw_project', 'title' => ''], + ], + [ + 'name' => 'BusinessId', + 'in' => 'formData', + 'schema' => ['description' => 'The workflow ID. You can call the [ListBusiness](~~173945~~) operation to obtain the folder ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1000000111', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Responses.', + '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 connection does not exist.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. Used for troubleshooting when 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. Valid values:'."\n" + ."\n" + .'- true: success.'."\n" + ."\n" + .'- false: failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'Details of the workflow.', + 'type' => 'object', + 'properties' => [ + 'Owner' => ['description' => 'The Alibaba Cloud account ID of the workflow owner.', 'type' => 'string', 'example' => '20000****', 'title' => ''], + 'Description' => ['description' => 'The description of the workflow.', 'type' => 'string', 'example' => 'This is my first business process.', 'title' => ''], + 'ProjectId' => ['description' => 'The ID of the workspace where the workflow resides.', 'type' => 'string', 'example' => '10000', 'title' => ''], + 'BusinessId' => ['description' => 'The workflow ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000001', 'title' => ''], + 'BusinessName' => ['description' => 'The name of the workflow. Workflow names must be unique within the same workspace.', 'type' => 'string', 'example' => 'The first business process', 'title' => ''], + 'UseType' => ['description' => 'The functional module to which the workflow belongs. Valid values: NORMAL (Data Studio) and MANUAL\\_BIZ (Manually Triggered Workflow)', 'type' => 'string', 'example' => 'NORMAL', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + '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\\": \\"2197B9C4-39CE-55EA-8EEA-FDBAE52DXXXX\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": \\"42\\",\\n \\"PageSize\\": \\"10\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"Nodes\\": [\\n {\\n \\"Description\\": \\"Node description\\\\n\\",\\n \\"Name\\": \\"test\\",\\n \\"ProjectId\\": 33233,\\n \\"Owner\\": \\"110755000425XXXX\\",\\n \\"CreateTime\\": 1722910655000,\\n \\"ModifyTime\\": 1722910655000,\\n \\"DataSource\\": {\\n \\"Name\\": \\"odps_first\\",\\n \\"Type\\": \\"odps\\"\\n },\\n \\"TaskId\\": 88888888888,\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"null\\",\\n \\"Value\\": \\"null\\"\\n }\\n ],\\n \\"Strategy\\": {\\n \\"Timeout\\": 0,\\n \\"InstanceMode\\": \\"T+1\\",\\n \\"RerunMode\\": \\"Allowed\\",\\n \\"RerunTimes\\": 3,\\n \\"RerunInterval\\": 180000\\n },\\n \\"Outputs\\": {\\n \\"Variables\\": [\\n {\\n \\"Name\\": \\"output\\\\n\\",\\n \\"ArtifactType\\": \\"Variable\\",\\n \\"Scope\\": \\"NodeParameter\\",\\n \\"Type\\": \\"Constant\\",\\n \\"Value\\": \\"111\\",\\n \\"Node\\": {\\n \\"Output\\": \\"860438872620113XXXX\\"\\n },\\n \\"Id\\": \\"623731286945488XXXX\\"\\n }\\n ],\\n \\"NodeOutputs\\": [\\n {\\n \\"Data\\": \\"860438872620113XXXX\\"\\n }\\n ],\\n \\"Tables\\": [\\n {\\n \\"Guid\\": \\"odps.autotest.test_output_table_1\\"\\n }\\n ]\\n },\\n \\"Inputs\\": {\\n \\"Variables\\": [\\n {\\n \\"Name\\": \\"input\\",\\n \\"ArtifactType\\": \\"Variable\\",\\n \\"Scope\\": \\"NodeParameter\\",\\n \\"Type\\": \\"Constant\\",\\n \\"Value\\": \\"222\\",\\n \\"Node\\": {\\n \\"Output\\": \\"623731286945488XXXX\\"\\n },\\n \\"Id\\": \\"543211286945488XXXX\\"\\n }\\n ],\\n \\"NodeOutputs\\": [\\n {\\n \\"Data\\": \\"623731286945488XXXX\\"\\n }\\n ],\\n \\"Tables\\": [\\n {\\n \\"Guid\\": \\"odps.autotest.test_output_table_1\\"\\n }\\n ]\\n },\\n \\"Trigger\\": {\\n \\"Type\\": \\"Scheduler\\",\\n \\"Cron\\": \\"00 00 00 * * ?\\",\\n \\"StartTime\\": \\"1970-01-01 00:00:00\\",\\n \\"EndTime\\": \\"9999-01-01 00:00:00\\",\\n \\"Timezone\\": \\"Asia/Shanghai\\",\\n \\"Id\\": \\"543680677872062XXXX\\"\\n },\\n \\"Script\\": {\\n \\"Path\\": \\"root/demo\\",\\n \\"Runtime\\": {\\n \\"Command\\": \\"ODPS_SQL\\"\\n },\\n \\"Id\\": \\"853573334108680XXXX\\"\\n },\\n \\"RuntimeResource\\": {\\n \\"ResourceGroupId\\": \\"123456XXX\\",\\n \\"ResourceGroup\\": \\"S_res_group_XXXX\\"\\n },\\n \\"Recurrence\\": \\"Normal\\",\\n \\"Id\\": \\"860438872620113XXXX\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListNodes', + '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"}]', + 'title' => 'GetBusiness', + 'summary' => 'Queries the information about a workflow.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], ], - 'ListNodeDependencies' => [ - 'summary' => 'Queries a list of descendant nodes of a node in DataStudio.', - 'methods' => [ - 'get', + 'GetCatalog' => [ + 'summary' => 'Queries the information about a catalog in Data Map. Only catalogs of the Data Lake Formation (DLF) and StarRocks metadata crawlers are supported.', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'abilityTreeCode' => '267969', + 'abilityTreeNodes' => ['FEATUREdideE9XYA6'], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['title' => 'ID', 'description' => 'The catalog entity ID. Currently supports dlf and starrocks types. You can refer to the results returned by the ListCatalogs operation and the [Concepts related to metadata entities](~~2880092~~).'."\n" + ."\n" + .'- For the DLF type, the format is `dlf-catalog::catalog_id`.'."\n" + ."\n" + .'- For the StarRocks type, the format is `starrocks-catalog:(instance_id|encoded_jdbc_url):catalog_name`.'."\n" + ."\n" + .'>
`catalog_id`: The ID of the DLF catalog.
'."\n" + .'> `instance_id`: The instance ID, required if the data source is registered in instance mode.
'."\n" + .'> `encoded_jdbc_url`: The URL-encoded JDBC connection string. Required if the data source is registered in connection string mode.
'."\n" + .'> `catalog_name`: The name of the StarRocks catalog.', 'type' => 'string', 'required' => true, 'example' => 'dlf-catalog::catalog_id'], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Responses.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1AFAE64E-D1BE-432B-A9****'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'Catalog' => ['description' => 'Catalog information.', '$ref' => '#/components/schemas/Catalog', 'title' => '', 'example' => ''], + ], + 'example' => '', + ], + ], ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AFAE64E-D1BE-432B-A9****\\",\\n \\"Success\\": true,\\n \\"Catalog\\": {\\n \\"Id\\": \\"dlf-catalog:123456XXX:test_catalog\\\\nstarrocks-catalog:c-abc123xxx:default_catalog\\",\\n \\"Name\\": \\"default_catalog\\",\\n \\"Comment\\": \\"this is a comment\\\\n\\",\\n \\"Type\\": \\"Internal\\",\\n \\"CreateTime\\": 1722073854000,\\n \\"ModifyTime\\": 1722073854000,\\n \\"ParentMetaEntityId\\": \\"dlf\\\\nstarrocks:c-abc123xxx\\"\\n }\\n}","type":"json"}]', + 'title' => 'GetCatalog', + 'description' => '1. DataWorks Basic Edition or a higher edition is required.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetCatalog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetCertificate' => [ + 'summary' => 'You can view authentication files.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -13378,1603 +16088,2368 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '236793', - 'abilityTreeNodes' => [ - 'FEATUREdideHO4TQP', - 'FEATUREdide8FM783', - 'FEATUREdideQUQUVB', - 'FEATUREdideIQU97M', - ], + 'abilityTreeCode' => '250938', + 'abilityTreeNodes' => ['FEATUREdideRWC5F7'], ], 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The unique ID of the certificate file.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '676303114031776'], + ], [ 'name' => 'ProjectId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the project to which the certificate file belongs.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1065601', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ '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, - 'example' => '10001', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID. Use this ID to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => '0000-ABCD-EFG****', 'title' => ''], + 'Certificate' => [ + 'description' => 'The details of the certificate.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The unique ID of the certificate file.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '676303114031776'], + 'Name' => ['description' => 'The file name.', 'type' => 'string', 'title' => '', 'example' => 'ca1.crt'], + 'ProjectId' => ['description' => 'The ID of the project to which the certificate file belongs.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '177161'], + 'Description' => ['description' => 'The description.', 'type' => 'string', 'title' => '', 'example' => 'This is a file'], + 'CreateUser' => ['description' => 'The ID of the user who created the certificate file.', 'type' => 'string', 'title' => '', 'example' => '1107550004253538'], + 'CreateTime' => ['description' => 'The time when the file was created. This is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1730217600000'], + 'FileSizeInBytes' => ['description' => 'The file size in bytes.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '77549'], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetCertificate', + 'description' => '1. This feature is available only in DataWorks Basic Edition and later versions.'."\n" + ."\n" + .'2. You must have at least one of the following roles in the DataWorks project: Tenant Owner, Space Administrator, Deployment, Developer, Project Owner, or O\\&M.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"Certificate\\": {\\n \\"Id\\": 676303114031776,\\n \\"Name\\": \\"ca1.crt\\",\\n \\"ProjectId\\": 177161,\\n \\"Description\\": \\"This is a file\\",\\n \\"CreateUser\\": \\"1107550004253538\\",\\n \\"CreateTime\\": 1730217600000,\\n \\"FileSizeInBytes\\": 77549\\n }\\n}","type":"json"}]', + ], + 'GetColumn' => [ + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '268005', + 'abilityTreeNodes' => ['FEATUREdideE9XYA6'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID. You can obtain this value from the response of the ListColumns operation. For more information, see [Metadata entity concepts](~~2880092~~).'."\n" + ."\n" + .'The format is `${EntityType}:${InstanceID or encoded URL}:${DataCatalogIdentifier}:${DatabaseName}:${SchemaName}:${TableName}:${ColumnName}`. Use an empty string as a placeholder for levels that do not exist.'."\n" + ."\n" + .'> For MaxCompute and DLF types, use an empty string as a placeholder for the instance ID. For MaxCompute, the database name is the MaxCompute project name. Projects with the three-layer model enabled must include the schema name. For projects without the three-layer model, use an empty string as a placeholder for the schema name.'."\n" + ."\n" + .'> For StarRocks, the data catalog identifier is the catalog name. For DLF, the data catalog identifier is the catalog ID. Other types do not support the catalog level. Use an empty string as a placeholder.'."\n" + ."\n" + .'The following are ID format examples for common types:'."\n" + ."\n" + .'`maxcompute-column:::project_name:[schema_name]:table_name:column_name`'."\n" + ."\n" + .'`dlf-column::catalog_id:database_name::table_name:column_name`'."\n" + ."\n" + .'`hms-column:instance_id::database_name::table_name:column_name`'."\n" + ."\n" + .'`holo-column:instance_id::database_name:schema_name:table_name:column_name`'."\n" + ."\n" + .'`mysql-column:(instance_id|encoded_jdbc_url)::database_name::table_name:column_name`'."\n" + ."\n" + .'> Other parameters: '."\n" + .'`instance_id`: The instance ID. This parameter is required when the data source is registered in instance mode. '."\n" + .'`encoded_jdbc_url`: The URL-encoded JDBC connection string. This parameter is required when the data source is registered by using a connection string. '."\n" + .'`catalog_id`: The DLF catalog ID. '."\n" + .'`project_name`: The MaxCompute project name. '."\n" + .'`database_name`: The database name. '."\n" + .'`schema_name`: The schema name. For MaxCompute, this parameter is required only when the three-layer model is enabled for the project. If the three-layer model is not enabled, use an empty string as a placeholder. '."\n" + .'`table_name`: The table name. '."\n" + .'`column_name`: The column name.', 'type' => 'string', 'required' => true, 'example' => 'maxcompute-column:::project_name:[schema_name]:table_name:column_name'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The unique identifier of the Data Studio node.'."\n" - ."\n" - .'> Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '860438872620113XXXX', + 'title' => '', + 'description' => 'The response.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'Column' => ['description' => 'The column list.', '$ref' => '#/components/schemas/Column', 'title' => '', 'example' => ''], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Get data map table column information', + 'summary' => 'Retrieves the details of a specified column in a Data Map table.', + 'description' => '1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'PageNumber', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetColumn', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx\\",\\n \\"Success\\": true,\\n \\"Column\\": {\\n \\"Id\\": \\"maxcompute-column:::project_name:[schema_name]:table_name:column_name\\",\\n \\"Name\\": \\"column_name\\",\\n \\"Comment\\": \\"字段1\\",\\n \\"TableId\\": \\"maxcompute-table:::project_name:[schema_name]:table_name\\",\\n \\"Position\\": 1,\\n \\"Type\\": \\"bigint\\",\\n \\"PrimaryKey\\": false,\\n \\"PartitionKey\\": false,\\n \\"ForeignKey\\": false,\\n \\"BusinessMetadata\\": {\\n \\"Description\\": \\"字段1的业务描述\\",\\n \\"CustomAttributes\\": {\\n \\"key\\": [\\n \\"张三\\"\\n ]\\n }\\n },\\n \\"StatisticsInfos\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n}","type":"json"}]', + ], + 'GetComponent' => [ + 'summary' => 'Gets component information.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236011', + 'abilityTreeNodes' => ['FEATUREdideITYNXL'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + '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.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000', 'title' => ''], + ], + [ + 'name' => 'ComponentId', 'in' => 'query', + 'schema' => ['description' => 'The component ID.', 'type' => 'string', 'required' => true, 'example' => '1112312312312', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The unique identifier of the Data Studio node.'."\n" - ."\n" - .'> This field is of the Long type in SDK versions prior to 8.0.0, and of the String type in SDK versions 8.0.0 and later. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '1', - 'default' => '1', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0000-ABCD-EFG****'], + 'Component' => [ + 'description' => 'JSON serialization of the component module.', + 'type' => 'object', + 'properties' => [ + 'ComponentId' => ['description' => 'The ID of the dataset acceleration component. For information on how to obtain the component ID, see [ListComponents](~~2979566~~).', 'type' => 'string', 'example' => '43cd873b-235c-44f8-be07-e4d4cf7e73b0', 'title' => ''], + 'ProjectId' => ['description' => 'The DataWorks workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '64623', 'title' => ''], + 'Name' => ['description' => 'Parameter', 'type' => 'string', 'example' => 'dim_whse_epet_warehouse_jz_storage_stock_lot_relation_id', 'title' => ''], + 'Owner' => ['description' => 'The ID of the task owner.', 'type' => 'string', 'example' => '207316543660665792', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '2017-04-27T05:37:05Z', 'title' => ''], + 'ModifyTime' => ['description' => 'The modification time (millisecond-level timestamp).', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '2024-01-26T07:44:21Z', 'title' => ''], + 'Spec' => ['description' => 'The FlowSpec information for this workflow. For more information, see [FlowSpec](https://github.com/aliyun/alibabacloud-dataworks-tool-dflow/).', 'type' => 'string', 'example' => '{'."\n" + .' "kind": "Component",'."\n" + .' "name": "com1",'."\n" + .' "spec": {'."\n" + .' "components": ['."\n" + .' {'."\n" + .' "name": "test11",'."\n" + .' "id": "8196828925037*****",'."\n" + .' "owner": "054664",'."\n" + .' "description": "",'."\n" + .' "script": {'."\n" + .' "language": "odps-sql",'."\n" + .' "path": "test11",'."\n" + .' "content": "select \'@@{bizdate}\', \'@@{my_input_table}\'",'."\n" + .' "runtime": {'."\n" + .' "command": "SQL_COMPONENT"'."\n" + .' }'."\n" + .' },'."\n" + .' "inputs": ['."\n" + .' {'."\n" + .' "name": "bizdate",'."\n" + .' "type": "string"'."\n" + .' },'."\n" + .' {'."\n" + .' "name": "my_input_table",'."\n" + .' "type": "string"'."\n" + .' }'."\n" + .' ],'."\n" + .' "outputs": ['."\n" + .' {'."\n" + .' "name": "my_output_table1",'."\n" + .' "type": "string"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .'}', 'title' => ''], + 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'None', 'title' => ''], + 'RegionId' => ['description' => 'The region ID, such as ap-southeast-1. The region ID is automatically parsed from your endpoint.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], ], + ], + 'errorCodes' => [ + 404 => [ + ['errorCode' => 'InvalidComponent.NotFound', 'errorMessage' => 'The specified Component does not exist.', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetComponent', + 'description' => '1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'PageSize', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetComponent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"Component\\": {\\n \\"ComponentId\\": \\"43cd873b-235c-44f8-be07-e4d4cf7e73b0\\",\\n \\"ProjectId\\": 64623,\\n \\"Name\\": \\"dim_whse_epet_warehouse_jz_storage_stock_lot_relation_id\\",\\n \\"Owner\\": \\"207316543660665792\\",\\n \\"CreateTime\\": \\"2017-04-27T05:37:05Z\\",\\n \\"ModifyTime\\": \\"2024-01-26T07:44:21Z\\",\\n \\"Spec\\": \\"{\\\\n \\\\\\"kind\\\\\\": \\\\\\"Component\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"com1\\\\\\",\\\\n \\\\\\"spec\\\\\\": {\\\\n \\\\\\"components\\\\\\": [\\\\n {\\\\n \\\\\\"name\\\\\\": \\\\\\"test11\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"8196828925037*****\\\\\\",\\\\n \\\\\\"owner\\\\\\": \\\\\\"054664\\\\\\",\\\\n \\\\\\"description\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"script\\\\\\": {\\\\n \\\\\\"language\\\\\\": \\\\\\"odps-sql\\\\\\",\\\\n \\\\\\"path\\\\\\": \\\\\\"test11\\\\\\",\\\\n \\\\\\"content\\\\\\": \\\\\\"select \'@@{bizdate}\', \'@@{my_input_table}\'\\\\\\",\\\\n \\\\\\"runtime\\\\\\": {\\\\n \\\\\\"command\\\\\\": \\\\\\"SQL_COMPONENT\\\\\\"\\\\n }\\\\n },\\\\n \\\\\\"inputs\\\\\\": [\\\\n {\\\\n \\\\\\"name\\\\\\": \\\\\\"bizdate\\\\\\",\\\\n \\\\\\"type\\\\\\": \\\\\\"string\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"name\\\\\\": \\\\\\"my_input_table\\\\\\",\\\\n \\\\\\"type\\\\\\": \\\\\\"string\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"outputs\\\\\\": [\\\\n {\\\\n \\\\\\"name\\\\\\": \\\\\\"my_output_table1\\\\\\",\\\\n \\\\\\"type\\\\\\": \\\\\\"string\\\\\\"\\\\n }\\\\n ]\\\\n }\\\\n ]\\\\n }\\\\n}\\",\\n \\"Description\\": \\"None\\",\\n \\"RegionId\\": \\"cn-hangzhou\\"\\n }\\n}","type":"json"}]', + ], + 'GetComputeResource' => [ + 'summary' => 'Queries the specified computing resource based on the computing resource ID.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '232399', + 'abilityTreeNodes' => ['FEATUREdideRWC5F7'], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The computing resource ID, which is the unique identifier for the resource.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11792', 'title' => ''], + ], + [ + 'name' => 'ProjectId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the DataWorks workspace.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10003', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The page number, starting from 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '10', - 'example' => '10', - 'default' => '10', + 'title' => 'Schema of Response', + 'description' => 'The returned result.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID. You can use the request ID to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => '9252F32F-D855-549E-8898-61CF5A733050'], + 'ComputeResource' => [ + 'description' => 'The details of the computing resource.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the computing resource.', 'type' => 'integer', 'format' => 'int64', 'example' => '16738', 'title' => ''], + 'ProjectId' => ['description' => 'The ID of the workspace to which the computing resource belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '52660', 'title' => ''], + 'Name' => ['description' => 'The name of the computing resource.', 'type' => 'string', 'example' => 'MyCs', 'title' => ''], + 'Type' => ['description' => 'The type of the computing resource.', 'type' => 'string', 'example' => 'hologres', 'title' => ''], + 'ConnectionProperties' => ['description' => 'The specific connection configuration details for the computing resource, including the connection address, access identity, and environment information. envType, which specifies the computing resource environment, is a property of this object. Valid values:'."\n" + ."\n" + .'- Dev'."\n" + ."\n" + .'- Prod Different types of computing resources have different attribute specifications under various configuration modes (ConnectionPropertiesMode).', 'type' => 'any', 'example' => '{'."\n" + .' "envType": "Prod",'."\n" + .' "regionId": "cn-beijing",'."\n" + .' "instanceId": "hgprecn-cn-x0r3oun4k001",'."\n" + .' "database": "testdb",'."\n" + .' "securityProtocol": "authTypeNone",'."\n" + .' "authType": "Executor",'."\n" + .' "authIdentity": "1107550004253538"'."\n" + .'}', 'title' => ''], + 'ConnectionPropertiesMode' => ['description' => 'The addition category of the computing resource. Different types will have different subtypes, each with corresponding parameter constraints. For instance:'."\n" + ."\n" + .'- InstanceMode: Instance mode'."\n" + ."\n" + .'- UrlMode: Connection String Mode'."\n" + ."\n" + .'- CdhMode: CDH mode', 'type' => 'string', 'example' => 'InstanceMode', 'title' => ''], + 'Description' => ['description' => 'The description of the computing resource.', 'type' => 'string', 'example' => 'My Description', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time, in timestamp format.', 'type' => 'integer', 'format' => 'int64', 'example' => '1698286929333', 'title' => ''], + 'CreateUser' => ['description' => 'The ID of the creator.', 'type' => 'string', 'example' => '1107550004253538', 'title' => ''], + 'ModifyTime' => ['description' => 'The last modification time, in timestamp format.', 'type' => 'integer', 'format' => 'int64', 'example' => '1698286929333', 'title' => ''], + 'ModifyUser' => ['description' => 'The ID of the modifier.', 'type' => 'string', 'example' => '1107550004253538', 'title' => ''], + 'QualifiedName' => ['description' => 'The business unique key for the computing resource. For example, the format for Hologres is ${tenantOwnerId}:${regionId}:${type}:${instanceId}:${database}.', 'type' => 'string', 'example' => '1107550004253538:cn-beijing:holo:hgprecn-cn-x0r3oun4k001:testdb', 'title' => ''], + 'WhetherDefault' => ['description' => 'Specifies whether it is the default computing resource.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetComputeResource', + 'description' => '1. DataWorks Basic Edition or a more advanced edition is required.'."\n" + ."\n" + .'2. You must have at least one of the following roles in the DataWorks workspace:'."\n" + ."\n" + .'- Tenant Owner, Workspace Administrator, Deploy, Developer, Project Owner, O\\&M', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetComputeResource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9252F32F-D855-549E-8898-61CF5A733050\\",\\n \\"ComputeResource\\": {\\n \\"Id\\": 16738,\\n \\"ProjectId\\": 52660,\\n \\"Name\\": \\"MyCs\\",\\n \\"Type\\": \\"hologres\\",\\n \\"ConnectionProperties\\": \\"{\\\\n\\\\t\\\\\\"envType\\\\\\": \\\\\\"Prod\\\\\\",\\\\n\\\\t\\\\\\"regionId\\\\\\": \\\\\\"cn-beijing\\\\\\",\\\\n \\\\\\"instanceId\\\\\\": \\\\\\"hgprecn-cn-x0r3oun4k001\\\\\\",\\\\n \\\\\\"database\\\\\\": \\\\\\"testdb\\\\\\",\\\\n \\\\\\"securityProtocol\\\\\\": \\\\\\"authTypeNone\\\\\\",\\\\n \\\\\\"authType\\\\\\": \\\\\\"Executor\\\\\\",\\\\n \\\\\\"authIdentity\\\\\\": \\\\\\"1107550004253538\\\\\\"\\\\n}\\",\\n \\"ConnectionPropertiesMode\\": \\"InstanceMode\\",\\n \\"Description\\": \\"My Description\\",\\n \\"CreateTime\\": 1698286929333,\\n \\"CreateUser\\": \\"1107550004253538\\",\\n \\"ModifyTime\\": 1698286929333,\\n \\"ModifyUser\\": \\"1107550004253538\\",\\n \\"QualifiedName\\": \\"1107550004253538:cn-beijing:holo:hgprecn-cn-x0r3oun4k001:testdb\\",\\n \\"WhetherDefault\\": true\\n }\\n}","type":"json"}]', + ], + 'GetCreateWorkflowInstancesResult' => [ + 'summary' => 'Queries the result of asynchronously creating a workflow instance.', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '259199', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB', 'FEATUREdideD0YY7B', 'FEATUREdideVFMENL'], + ], + 'parameters' => [ + [ + 'name' => 'OperationId', + 'in' => 'query', + 'schema' => ['description' => 'The operation ID. This parameter is used to query the result of asynchronously creating a workflow instance. You can call the CreateWorkflowInstances operation to query the ID.', 'type' => 'string', 'required' => true, 'example' => 'e15ad21c-b0e9-4792-8f55-b037xxxxxxxx', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '204EAF68-CCE3-5112-8DA0-E7A60F02XXXX', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'], + 'Result' => [ + 'description' => 'The creation result of the workflow instance.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The creation status. Valid values:'."\n" + ."\n" + .'- Creating'."\n" + ."\n" + .'- Created'."\n" + ."\n" + .'- CreateFailure', 'type' => 'string', 'example' => 'Created', 'title' => ''], + 'FailureMessage' => ['description' => 'The error message. This parameter is returned only if the creation fails.', 'type' => 'string', 'example' => 'Invalid Param xxx', 'title' => ''], + 'WorkflowInstanceIds' => [ + 'description' => 'The workflow instance IDs. This parameter is returned only if the creation is successful.', + 'type' => 'array', + 'items' => ['description' => 'The workflow instance ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'WorkflowTaskInstanceIds' => [ + 'description' => 'The list of task instance IDs corresponding to the workflow instance. This field is returned after successful creation.', + 'type' => 'array', + 'items' => ['description' => 'The task instance ID corresponding to the workflow instance.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'UnifiedWorkflowInstanceIds' => [ + 'description' => 'Unified workflow instance ID. For all task instances triggered under the same data timestamp in a single trigger, the value of this field is identical. This field is returned after successful creation.', + 'type' => 'array', + 'items' => ['description' => 'Unified workflow instance ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], + ], + 'example' => '', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"Result\\": {\\n \\"Status\\": \\"Created\\",\\n \\"FailureMessage\\": \\"Invalid Param xxx\\",\\n \\"WorkflowInstanceIds\\": [\\n 1234\\n ],\\n \\"WorkflowTaskInstanceIds\\": [\\n 1234\\n ],\\n \\"UnifiedWorkflowInstanceIds\\": [\\n 1234\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'GetCreateWorkflowInstancesResult', + 'description' => 'You must purchase DataWorks Basic Edition or a higher edition to use this feature.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetCreateWorkflowInstancesResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'GetCustomAttribute' => [ + 'summary' => 'Retrieves a custom attribute definition.', + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdideX3KVYR'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The custom attribute ID. The ID must match the regular expression `^custom-attribute:[A-Za-z][A-Za-z0-9_]{0,98}$`. The part after \'custom-attribute:\' must be less than 100 characters long.', 'type' => 'string', 'required' => true, 'example' => 'custom-attribute:biz_owner', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'BA51C9E6-0CBC-5BB9-92BD-0C4FE66E1717'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'CustomAttribute' => ['description' => 'The custom attribute definition.', '$ref' => '#/components/schemas/CustomAttribute', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'description' => 'The response schema.', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetCustomAttribute', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BA51C9E6-0CBC-5BB9-92BD-0C4FE66E1717\\",\\n \\"Success\\": true,\\n \\"CustomAttribute\\": {\\n \\"Id\\": \\"custom-attribute:biz_owner\\",\\n \\"DisplayName\\": \\"业务负责人\\",\\n \\"Type\\": \\"TEXT\\",\\n \\"EntityTypes\\": [\\n \\"maxcompute-table\\"\\n ],\\n \\"ValueEnums\\": [\\n \\"VALUE_1\\"\\n ],\\n \\"SearchFilterEnabled\\": false,\\n \\"DisplayEnabled\\": true,\\n \\"Comment\\": \\"this is a comment\\",\\n \\"CreateTime\\": 1750817692000,\\n \\"ModifyTime\\": 1763380628000\\n }\\n}","type":"json"}]', + ], + 'GetDIJob' => [ + 'summary' => 'View data integration tasks.', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '234096', + 'abilityTreeNodes' => ['FEATUREdideBP0OJZ'], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the DI job.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '11588', 'title' => ''], + ], + [ + 'name' => 'WithDetails', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to return the detailed configuration, including `TransformationRules`, `TableMappings`, and `JobSettings`. This configuration is returned by default.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The DataWorks workspace ID. You can call the `ListProjects` operation to obtain the workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000', 'title' => ''], + ], + [ + 'name' => 'DIJobId', + 'in' => 'query', + 'schema' => ['description' => 'This field is deprecated. Use the `Id` field instead.', 'type' => 'integer', 'format' => 'int64', 'deprecated' => true, 'required' => false, 'example' => '11588', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID. You can use this ID to locate logs and troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => 'C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490'], 'PagingInfo' => [ - 'description' => 'The pagination information.'."\n", + 'description' => 'The details of the data integration job.', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'string', - 'example' => '90', + 'Id' => ['description' => 'The job ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '32601', 'title' => ''], + 'Description' => ['description' => 'The description of the job.', 'type' => 'string', 'example' => 'description', 'title' => ''], + 'DestinationDataSourceSettings' => [ + 'description' => 'The settings for the destination data source.', + 'type' => 'array', + 'items' => [ + 'description' => 'The properties for a destination data source.', + 'type' => 'object', + 'properties' => [ + 'DataSourceName' => ['description' => 'The name of the destination data source.', 'type' => 'string', 'example' => 'dw_mysql', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'string', - 'example' => '10', + 'DestinationDataSourceType' => ['description' => 'The type of the destination data source. Valid values: `Hologres`, `OSS-HDFS`, `OSS`, `MaxCompute`, `LogHub`, `StarRocks`, `DataHub`, `AnalyticDB for MySQL`, `Kafka`, and `Hive`.', 'type' => 'string', 'example' => 'Hologres', 'title' => ''], + 'JobName' => ['description' => 'The name of the job.', 'type' => 'string', 'example' => 'imp_ods_dms_det_dealer_info_df', 'title' => ''], + 'JobSettings' => [ + 'description' => 'The job settings.', + 'type' => 'object', + 'properties' => [ + 'ChannelSettings' => ['description' => 'The settings for channel-related jobs. You can configure special settings for specific channels. The following channels are supported: Holo2Holo (data synchronization from Hologres to Hologres) and Holo2Kafka (data synchronization from Hologres to Kafka).'."\n" + ."\n" + .'1. Holo2Kafka'."\n" + ."\n" + .'- Example: `{"destinationChannelSettings":{"kafkaClientProperties":[{"key":"linger.ms","value":"100"}],"keyColumns":["col3"],"writeMode":"canal"}}`'."\n" + ."\n" + .'- `kafkaClientProperties`: The parameters for the Kafka producer, used when writing data to Kafka.'."\n" + ."\n" + .'- `keyColumns`: The columns whose values are used as the key for Kafka records.'."\n" + ."\n" + .'- `writeMode`: The format for writing data to Kafka. Valid values: `json` and `canal`.'."\n" + ."\n" + .'2. Holo2Holo'."\n" + ."\n" + .'- Example: `{"destinationChannelSettings":{"conflictMode":"replace","dynamicColumnAction":"replay","writeMode":"replay"}}`'."\n" + ."\n" + .'- `conflictMode`: The conflict handling policy for writing data to Hologres. Valid values: `replace` (overwrite) and `ignore` (ignore).'."\n" + ."\n" + .'- `writeMode`: The method for writing data to Hologres. Valid values: `replay` and `insert`.'."\n" + ."\n" + .'- `dynamicColumnAction`: The method for handling dynamic columns when writing data to Hologres. Valid values: `replay`, `insert`, and `ignore`.', 'type' => 'string', 'example' => '{"structInfo":"MANAGED","storageType":"TEXTFILE","writeMode":"APPEND","partitionColumns":[{"columnName":"pt","columnType":"STRING","comment":""}],"fieldDelimiter":""}', 'title' => ''], + 'ColumnDataTypeSettings' => [ + 'description' => 'The column data type mappings.', + 'type' => 'array', + 'items' => [ + 'description' => 'A column data type mapping.', + 'type' => 'object', + 'properties' => [ + 'DestinationDataType' => ['description' => 'The data type in the destination, such as `bigint`, `boolean`, `string`, `text`, `datetime`, `timestamp`, `decimal`, and `binary`. Data types vary depending on the data source.', 'type' => 'string', 'example' => 'text', 'title' => ''], + 'SourceDataType' => ['description' => 'The data type in the source, such as `bigint`, `boolean`, `string`, `text`, `datetime`, `timestamp`, `decimal`, and `binary`. Data types vary depending on the data source.', 'type' => 'string', 'example' => 'bigint', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'CycleScheduleSettings' => [ + 'description' => 'The settings for periodic scheduling.', + 'type' => 'object', + 'properties' => [ + 'CycleMigrationType' => ['description' => 'The synchronization type for periodic scheduling. Valid values:'."\n" + ."\n" + .'- `Full`: full'."\n" + ."\n" + .'- `OfflineIncremental`: offline incremental', 'type' => 'string', 'example' => 'Full', 'title' => ''], + 'ScheduleParameters' => ['description' => 'The scheduling parameters.', 'type' => 'string', 'example' => 'bizdate=$bizdate'."\n", 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'DdlHandlingSettings' => [ + 'description' => 'An array of settings for handling DDL messages. Each element specifies a DDL message type and the corresponding handling rule.', + 'type' => 'array', + 'items' => [ + 'description' => 'The rule for handling a DDL message type.', + 'type' => 'object', + 'properties' => [ + 'Action' => ['description' => 'The handling action. Valid values:'."\n" + ."\n" + .'- `Ignore`: Ignores the DDL message.'."\n" + ."\n" + .'- `Critical`: Reports an error.'."\n" + ."\n" + .'- `Normal`: Processes the DDL message.', 'type' => 'string', 'example' => 'Ignore', 'title' => ''], + 'Type' => ['description' => 'The DDL message type. Valid values:'."\n" + ."\n" + .'- `RenameColumn`'."\n" + ."\n" + .'- `ModifyColumn`'."\n" + ."\n" + .'- `CreateTable`'."\n" + ."\n" + .'- `TruncateTable`'."\n" + ."\n" + .'- `DropTable`', 'type' => 'string', 'example' => 'CreateTable', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'RuntimeSettings' => [ + 'description' => 'The runtime settings.', + 'type' => 'array', + 'items' => [ + 'description' => 'A runtime setting.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the setting. Valid values:'."\n" + ."\n" + .'- `src.offline.datasource.max.connection`: the maximum number of connections to the source for an offline batch job.'."\n" + ."\n" + .'- `dst.offline.truncate`: Whether to truncate the destination table before the offline batch job starts.'."\n" + ."\n" + .'- `runtime.offline.speed.limit.enable`: Whether to enable throttling for an offline batch job.'."\n" + ."\n" + .'- `runtime.offline.concurrent`: the concurrency level for an offline batch synchronization job.'."\n" + ."\n" + .'- `runtime.enable.auto.create.schema`: Whether to automatically create a schema at the destination.'."\n" + ."\n" + .'- `runtime.realtime.concurrent`: the concurrency level for a real-time job.'."\n" + ."\n" + .'- `runtime.realtime.failover.minute.dataxcdc`: The wait duration (in minutes) before restarting a failed instance.'."\n" + ."\n" + .'- `runtime.realtime.failover.times.dataxcdc`: The maximum number of retries for a failed instance.', 'type' => 'string', 'example' => 'runtime.offline.concurrent'."\n", 'title' => ''], + 'Value' => ['description' => 'The value of the setting.', 'type' => 'string', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'string', - 'example' => '1', + 'MigrationType' => ['description' => 'The synchronization type. Valid values:'."\n" + ."\n" + .'- `FullAndRealtimeIncremental`: one-time full synchronization and real-time incremental synchronization (for an entire database).'."\n" + ."\n" + .'- `RealtimeIncremental`: real-time incremental synchronization (for a single table).'."\n" + ."\n" + .'- `Full`: one-time full synchronization (for an entire database).'."\n" + ."\n" + .'- `OfflineIncremental`: offline incremental synchronization (for an entire database).'."\n" + ."\n" + .'- `FullAndOfflineIncremental`: one-time full synchronization and offline incremental synchronization (for an entire database).', 'type' => 'string', 'example' => 'FullAndRealtimeIncremental', 'title' => ''], + 'JobType' => ['description' => 'The job type.'."\n" + ."\n" + .'- `DatabaseRealtimeMigration`: real-time synchronization of multiple tables from multiple source databases. This type supports full, incremental, or both full and incremental synchronization.'."\n" + ."\n" + .'- `DatabaseOfflineMigration`: batch synchronization of multiple tables from multiple source databases. This type supports full, incremental, or both full and incremental synchronization.'."\n" + ."\n" + .'- `SingleTableRealtimeMigration`: real-time synchronization of a single source table.', 'type' => 'string', 'example' => 'DatabaseRealtimeMigration', 'title' => ''], + 'ProjectId' => ['description' => 'The ID of the DataWorks workspace for the API call. You can obtain the workspace ID from the Workspace Configuration page in the [DataWorks console](https://workbench.data.aliyun.com/console).', 'type' => 'integer', 'format' => 'int64', 'example' => '98330', 'title' => ''], + 'ResourceSettings' => [ + 'description' => 'The resource settings.', + 'type' => 'object', + 'properties' => [ + 'OfflineResourceSettings' => [ + 'description' => 'The resource settings for the offline synchronization job.', + 'type' => 'object', + 'properties' => [ + 'RequestedCu' => ['description' => 'The number of CUs from the data integration resource group for the offline synchronization job.', 'type' => 'number', 'format' => 'double', 'example' => '2.0', 'title' => ''], + 'ResourceGroupIdentifier' => ['description' => 'The name of the data integration resource group used by the offline synchronization job.', 'type' => 'string', 'example' => 'di_resourcegroup_v1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'RealtimeResourceSettings' => [ + 'description' => 'The resource settings for the real-time synchronization job.', + 'type' => 'object', + 'properties' => [ + 'RequestedCu' => ['description' => 'The number of CUs from the data integration resource group for the real-time synchronization job.', 'type' => 'number', 'format' => 'double', 'example' => '2.0', 'title' => ''], + 'ResourceGroupIdentifier' => ['description' => 'The name of the data integration resource group used by the real-time job.', 'type' => 'string', 'example' => 'di_resourcegroup_v1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'ScheduleResourceSettings' => [ + 'description' => 'The scheduling resource settings.', + 'type' => 'object', + 'properties' => [ + 'RequestedCu' => ['description' => 'The number of CUs from the scheduling resource group for the offline scheduling job.', 'type' => 'number', 'format' => 'double', 'example' => '2.0', 'title' => ''], + 'ResourceGroupIdentifier' => ['description' => 'The name of the scheduling resource group used by the offline scheduling job.', 'type' => 'string', 'example' => 'schedual_resourcegroup_v1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], - 'Nodes' => [ - 'description' => 'The list of dependent nodes.'."\n", + 'SourceDataSourceSettings' => [ + 'description' => 'The settings for the source data source.', 'type' => 'array', 'items' => [ - 'description' => 'The element in the list of dependent nodes.'."\n", + 'description' => 'The settings for a source data source.', 'type' => 'object', 'properties' => [ - 'Description' => [ - 'title' => '描述', - 'description' => 'The description of the node.'."\n", - 'type' => 'string', - 'example' => 'Node description', - ], - 'Name' => [ - 'title' => '节点名', - 'description' => 'The name of the node.'."\n", - 'type' => 'string', - 'example' => 'Node name', - ], - 'ProjectId' => [ - 'description' => 'The ID of the workspace to which the node belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'deprecated' => false, - 'example' => '65133', - ], - 'Owner' => [ - 'title' => '责任人', - 'description' => 'The owner of the node.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => '110755000425XXXX', - 'pattern' => '', - 'default' => '', - ], - 'CreateTime' => [ - 'title' => '创建时间', - 'description' => 'The timestamp when the node was created.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'deprecated' => false, - 'example' => '1724505917000', - 'pattern' => '', - 'default' => '', - ], - 'ModifyTime' => [ - 'title' => '修改时间', - 'description' => 'The timestamp when the node was last modified.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'deprecated' => false, - 'example' => '1724505917000', - 'pattern' => '', - 'default' => '', - ], - 'DataSource' => [ - 'title' => '数据源', - 'description' => 'The data source.'."\n", + 'DataSourceName' => ['description' => 'The name of the data source.', 'type' => 'string', 'example' => 'dw_mysql', 'title' => ''], + 'DataSourceProperties' => [ + 'description' => 'The properties of the data source.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => '数据源名称', - 'description' => 'The name of the data source.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'odps_first', - 'pattern' => '', - 'default' => '', - ], - 'Type' => [ - 'title' => '数据源类型', - 'description' => 'The type of the data source.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'odps', - 'pattern' => '', - 'default' => '', - ], + 'Encoding' => ['description' => 'The encoding of the database.', 'type' => 'string', 'example' => 'UTF-8'."\n", 'title' => ''], + 'Timezone' => ['description' => 'The time zone.', 'type' => 'string', 'example' => 'GMT+8'."\n", 'title' => ''], ], - 'deprecated' => false, - ], - 'TaskId' => [ - 'title' => '调度任务Id', - 'description' => 'The ID of the scheduling task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'deprecated' => false, - 'example' => '580667964888595XXXX', - 'pattern' => '', - 'default' => '', + 'title' => '', + 'example' => '', ], - 'Tags' => [ - 'title' => '标签信息', - 'description' => 'The tags. This parameter is not in use.'."\n", + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'SourceDataSourceType' => ['description' => 'The type of the source data source. Valid values: `PolarDB`, `MySQL`, `Kafka`, `LogHub`, `Hologres`, `Oracle`, `OceanBase`, `MongoDB`, `RedShift`, `Hive`, `SQLServer`, `Doris`, and `ClickHouse`.', 'type' => 'string', 'example' => 'Mysql', 'title' => ''], + 'TableMappings' => [ + 'description' => 'A list of mappings for object transformation. Each element in the list describes a set of selection rules for source objects and a set of transformation rules that apply to the selected objects.'."\n" + ."\n" + .'> \\['."\n" + .'> {'."\n" + .'> "SourceObjectSelectionRules":\\['."\n" + .'> {'."\n" + .'> "ObjectType":"Database",'."\n" + .'> "Action":"Include",'."\n" + .'> "ExpressionType":"Exact",'."\n" + .'> "Expression":"biz\\_db"'."\n" + .'> },'."\n" + .'> {'."\n" + .'> "ObjectType":"Schema",'."\n" + .'> "Action":"Include",'."\n" + .'> "ExpressionType":"Exact",'."\n" + .'> "Expression":"s1"'."\n" + .'> },'."\n" + .'> {'."\n" + .'> "ObjectType":"Table",'."\n" + .'> "Action":"Include",'."\n" + .'> "ExpressionType":"Exact",'."\n" + .'> "Expression":"table1"'."\n" + .'> }'."\n" + .'> ],'."\n" + .'> "TransformationRuleNames":\\['."\n" + .'> {'."\n" + .'> "RuleName":"my\\_database\\_rename\\_rule",'."\n" + .'> "RuleActionType":"Rename",'."\n" + .'> "RuleTargetType":"Schema"'."\n" + .'> }'."\n" + .'> ]'."\n" + .'> }'."\n" + .'> ]', + 'type' => 'array', + 'items' => [ + 'description' => 'A mapping that defines the source objects and the transformation rules to apply.', + 'type' => 'object', + 'properties' => [ + 'SourceObjectSelectionRules' => [ + 'description' => 'Each rule selects a set of source objects to be synchronized. A combination of multiple rules selects one table.', 'type' => 'array', 'items' => [ - 'title' => '单个标签', - 'description' => 'The tag. This parameter is not in use.'."\n", + 'description' => 'Each rule can select different types of source objects to be synchronized, such as a source database or a source table.', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'title' => '标签键', - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'null', - 'pattern' => '', - 'default' => '', - ], - 'Value' => [ - 'title' => '标签值', - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'null', - 'pattern' => '', - 'default' => '', - ], - ], - 'deprecated' => false, - ], - 'deprecated' => false, - ], - 'Strategy' => [ - 'title' => '调度策略', - 'description' => 'The scheduling policy.'."\n", - 'type' => 'object', - 'properties' => [ - 'Timeout' => [ - 'title' => '超时时间', - 'description' => 'The timeout period. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'deprecated' => false, - 'example' => '0', - 'pattern' => '', - 'default' => '', - ], - 'InstanceMode' => [ - 'title' => '生成实例的模式', - 'description' => 'The instance generation mode.'."\n" + 'Action' => ['description' => 'The selection action. Valid values: `Include` and `Exclude`.', 'type' => 'string', 'example' => 'Include', 'title' => ''], + 'Expression' => ['description' => 'The expression.', 'type' => 'string', 'example' => 'mysql_table_1', 'title' => ''], + 'ExpressionType' => ['description' => 'The expression type. Valid values: `Exact` and `Regex`.', 'type' => 'string', 'example' => 'Exact', 'title' => ''], + 'ObjectType' => ['description' => 'The object type. Valid values:'."\n" ."\n" - .'* T+1'."\n" - .'* Immediately'."\n", - 'type' => 'string', - 'deprecated' => false, - 'enumValueTitles' => [], - 'example' => 'T+1', - 'pattern' => '', - 'default' => '', - 'enum' => [ - 'T+1', - 'Immediately', - ], - ], - 'RerunMode' => [ - 'title' => '允许重跑的模式', - 'description' => 'The rerun mode.'."\n" + .'- `Table`'."\n" ."\n" - .'* Allowed'."\n" - .'* Denied'."\n" - .'* FailureAllowed'."\n", - 'type' => 'string', - 'deprecated' => false, - 'enumValueTitles' => [], - 'example' => 'Allowed', - 'pattern' => '', - 'default' => '', - 'enum' => [ - 'Allowed', - 'Denied', - 'FailureAllowed', - ], - ], - 'RerunTimes' => [ - 'title' => '重试次数', - 'description' => 'The number of retries after failure.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'deprecated' => false, - 'example' => '3', - 'pattern' => '', - 'default' => '', - ], - 'RerunInterval' => [ - 'title' => '重试时间间隔', - 'description' => 'The interval between retries after failure. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'deprecated' => false, - 'example' => '180000', - 'pattern' => '', - 'default' => '', - ], - ], - 'deprecated' => false, - ], - 'Outputs' => [ - 'title' => '节点输出', - 'description' => 'The output of the node.'."\n", - 'type' => 'object', - 'properties' => [ - 'Variables' => [ - 'title' => '变量列表', - 'description' => 'The variables.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '变量元素', - 'description' => 'The variable.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '变量名', - 'description' => 'The variable name.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'output', - 'pattern' => '', - 'default' => '', - ], - 'ArtifactType' => [ - 'title' => '制品类型', - 'description' => 'The artifact type.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'Variable', - 'pattern' => '', - 'default' => '', - ], - 'Scope' => [ - 'title' => '范围', - 'description' => 'The scope of the variable. Valid values:'."\n" - ."\n" - .'* NodeParameter'."\n" - .'* NodeContext'."\n" - .'* Workflow'."\n" - .'* Workspace'."\n", - 'type' => 'string', - 'deprecated' => false, - 'enumValueTitles' => [], - 'example' => 'NodeParameter', - 'pattern' => '', - 'default' => '', - ], - 'Type' => [ - 'title' => '类型', - 'description' => 'The type of the variable. Valid values:'."\n" - ."\n" - .'* NoKvVariableExpression'."\n" - .'* Constant'."\n" - .'* PassThrough'."\n" - .'* System'."\n" - .'* NodeOutput'."\n", - 'type' => 'string', - 'deprecated' => false, - 'enumValueTitles' => [], - 'example' => 'Constant', - 'pattern' => '', - 'default' => '', - ], - 'Value' => [ - 'title' => '变量值', - 'description' => 'The variable name.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => '111', - 'pattern' => '', - 'default' => '', - ], - 'Node' => [ - 'title' => '变量所属节点', - 'description' => 'The node to which the variable belongs.'."\n", - 'type' => 'object', - 'properties' => [ - 'Output' => [ - 'title' => '节点输出', - 'description' => 'The node output corresponding to the variable.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => '463497880880954XXXX', - 'pattern' => '', - 'default' => '', - ], - ], - 'deprecated' => false, - ], - 'Id' => [ - 'description' => 'The variable ID.'."\n" - ."\n" - .'> Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => '543217824470354XXXX', - 'title' => '', - ], - ], - 'deprecated' => false, - ], - 'deprecated' => false, - ], - 'NodeOutputs' => [ - 'title' => '节点输出列表', - 'description' => 'The node output list.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '节点输出项', - 'description' => 'The node output item.'."\n", - 'type' => 'object', - 'properties' => [ - 'Data' => [ - 'title' => '节点输出', - 'description' => 'The output of the node.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => '463497880880954XXXX', - 'pattern' => '', - 'default' => '', - ], - ], - 'deprecated' => false, - ], - 'deprecated' => false, - ], - 'Tables' => [ - 'title' => '表列表', - 'description' => 'The table list.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '表输出项', - 'description' => 'The table output item.'."\n", - 'type' => 'object', - 'properties' => [ - 'Guid' => [ - 'title' => '表id', - 'description' => 'The table ID.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'odps.autotest.test_output_table_1', - 'pattern' => '', - 'default' => '', - ], - ], - 'deprecated' => false, - ], - 'deprecated' => false, - ], - ], - 'deprecated' => false, - ], - 'Inputs' => [ - 'title' => '节点输入', - 'description' => 'The node input.'."\n", - 'type' => 'object', - 'properties' => [ - 'Variables' => [ - 'title' => '变量列表', - 'description' => 'The variable list.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '变量元素', - 'description' => 'The variable.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '变量名', - 'description' => 'The name of the variable.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'input', - 'pattern' => '', - 'default' => '', - ], - 'ArtifactType' => [ - 'title' => '制品类型', - 'description' => 'The artifact type.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'Variable', - 'pattern' => '', - 'default' => '', - ], - 'Scope' => [ - 'title' => '范围', - 'description' => 'The scope of the variable. Valid values:'."\n" - ."\n" - .'* NodeParameter'."\n" - .'* NodeContext'."\n" - .'* Workflow'."\n" - .'* Workspace'."\n", - 'type' => 'string', - 'deprecated' => false, - 'enumValueTitles' => [], - 'example' => 'NodeParameter', - 'pattern' => '', - 'default' => '', - ], - 'Type' => [ - 'title' => '类型', - 'description' => 'The type of the variable.'."\n" - ."\n" - .'* NoKvVariableExpression'."\n" - .'* Constant'."\n" - .'* PassThrough'."\n" - .'* System'."\n" - .'* NodeOutput'."\n", - 'type' => 'string', - 'deprecated' => false, - 'enumValueTitles' => [], - 'example' => 'Constant', - 'pattern' => '', - 'default' => '', - ], - 'Value' => [ - 'title' => '变量值', - 'description' => 'The variable name.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => '111', - 'pattern' => '', - 'default' => '', - ], - 'Node' => [ - 'title' => '变量所属节点', - 'description' => 'The node to which the variable belongs.'."\n", - 'type' => 'object', - 'properties' => [ - 'Output' => [ - 'title' => '节点输出', - 'description' => 'The output of the node.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => '860438872620113XXXX', - 'pattern' => '', - 'default' => '', - ], - ], - 'deprecated' => false, - ], - 'Id' => [ - 'description' => 'The variable ID.'."\n" - ."\n" - .'> Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => '543218872620113XXXX', - 'title' => '', - ], - ], - 'deprecated' => false, - ], - 'deprecated' => false, - ], - 'NodeOutputs' => [ - 'title' => '节点输出列表', - 'description' => 'The node output list.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '节点输出项', - 'description' => 'The node output item.'."\n", - 'type' => 'object', - 'properties' => [ - 'Data' => [ - 'title' => '节点输出', - 'description' => 'The output of the node.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => '860438872620113XXXX', - 'pattern' => '', - 'default' => '', - ], - ], - 'deprecated' => false, - ], - 'deprecated' => false, - ], - 'Tables' => [ - 'title' => '表列表', - 'description' => 'The table list.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => '表输出项', - 'description' => 'The table output item.'."\n", - 'type' => 'object', - 'properties' => [ - 'Guid' => [ - 'title' => '表id', - 'description' => 'The table ID.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'odps.autotest.test_output_table_1', - 'pattern' => '', - 'default' => '', - ], - ], - 'deprecated' => false, - ], - 'deprecated' => false, + .'- `Schema`'."\n" + ."\n" + .'- `Database`', 'type' => 'string', 'example' => 'Table', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'deprecated' => false, + 'title' => '', + 'example' => '', ], - 'Trigger' => [ - 'title' => '触发器', - 'description' => 'The trigger.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '类型', - 'description' => 'The trigger type.'."\n" + 'TransformationRules' => [ + 'description' => 'An array of object transformation rule definitions.', + 'type' => 'array', + 'items' => [ + 'description' => 'A transformation rule that is applied to the source object.', + 'type' => 'object', + 'properties' => [ + 'RuleName' => ['description' => 'The name of the rule. The rule name must be unique for a specific action type (`RuleActionType`) and target type (`RuleTargetType`).', 'type' => 'string', 'example' => 'rename_rule_1', 'title' => ''], + 'RuleActionType' => ['description' => 'The action type. Valid values:'."\n" ."\n" - .'Valid values:'."\n" + .'- `DefinePrimaryKey`'."\n" ."\n" - .'* Scheduler: Periodic scheduling.'."\n" - .'* Manual: Manual scheduling.'."\n" - .'* Streaming: Streaming scheduler.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'enumValueTitles' => [], - 'example' => 'Scheduler', - 'pattern' => '', - 'default' => '', - ], - 'Cron' => [ - 'title' => 'cron表达式', - 'description' => 'The cron expression for scheduling.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => '00 00 00 * * ?', - 'pattern' => '', - 'default' => '', - ], - 'StartTime' => [ - 'title' => '开始时间', - 'description' => 'The effective start time of the schedule, in the format yyyy-MM-dd HH:mm:ss.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => '1970-01-01 00:00:00', - 'pattern' => '', - 'default' => '', - ], - 'EndTime' => [ - 'title' => '结束时间', - 'description' => 'The effective end time of the schedule, in the format yyyy-MM-dd HH:mm:ss.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => '9999-01-01 00:00:00', - 'pattern' => '', - 'default' => '', - ], - 'Timezone' => [ - 'title' => '时区', - 'description' => 'The time zone.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'Asia/Shanghai', - 'pattern' => '', - 'default' => '', - ], - 'Id' => [ - 'description' => 'The unique identifier of the trigger.'."\n" + .'- `Rename`'."\n" ."\n" - .'> Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => '543680677872062XXXX', - 'title' => '', - ], - ], - 'deprecated' => false, - ], - 'Script' => [ - 'title' => '脚本信息', - 'description' => 'The script information.'."\n", - 'type' => 'object', - 'properties' => [ - 'Path' => [ - 'title' => '脚本路径', - 'description' => 'The script path.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'root/demo', - 'pattern' => '', - 'default' => '', - ], - 'Runtime' => [ - 'title' => '运行时', - 'description' => 'Runtime'."\n", - 'type' => 'object', - 'properties' => [ - 'Command' => [ - 'title' => '命令', - 'description' => 'The command used to distinguish node types.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'ODPS_SQL', - 'pattern' => '', - 'default' => '', - ], - ], - 'deprecated' => false, - ], - 'Id' => [ - 'description' => 'The ID of the script.'."\n" + .'- `AddColumn`'."\n" ."\n" - .'> This field is of type Long in SDK versions prior to 8.0.0, and of type String in SDK version 8.0.0 and later. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => '853573334108680XXXX', - 'title' => '', - ], - ], - 'deprecated' => false, - 'required' => false, - ], - 'RuntimeResource' => [ - 'title' => '资源组信息', - 'description' => 'The information about the resource group.'."\n", - 'type' => 'object', - 'properties' => [ - 'ResourceGroupId' => [ - 'title' => '资源组id', - 'description' => 'The resource group ID.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'S_res_group_XXXX_XXXX', - 'pattern' => '', - 'default' => '', + .'- `HandleDml`', 'type' => 'string', 'example' => 'AddColumn', 'title' => ''], + 'RuleTargetType' => ['description' => 'The target object type of the action. Valid values:'."\n" + ."\n" + .'- `Table`'."\n" + ."\n" + .'- `Schema`'."\n" + ."\n" + .'- `Database`', 'type' => 'string', 'example' => 'Table', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'deprecated' => false, - ], - 'Recurrence' => [ - 'description' => 'The scheduling type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Normal: Nodes are scheduled as expected.'."\n" - .'* Pause: Nodes are paused, and the running of their descendant nodes is blocked.'."\n" - .'* Skip: Nodes are dry run. The system does not actually run the nodes but directly prompts that the nodes are successfully run. The running duration of the nodes is 0 seconds. In addition, the nodes do not occupy resources or block the running of their descendant nodes.'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Normal', - ], - 'Id' => [ - 'description' => 'The unique identifier of the Data Studio node.'."\n" - ."\n" - .'> Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.'."\n", - 'type' => 'string', - 'example' => '723932906364267XXXX', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'TransformationRules' => [ + 'description' => 'A list of definitions for object transformation rules.'."\n" + ."\n" + .'> \\['."\n" + .'> {'."\n" + .'> "RuleName":"my\\_database\\_rename\\_rule",'."\n" + .'> "RuleActionType":"Rename",'."\n" + .'> "RuleTargetType":"Schema",'."\n" + .'> "RuleExpression":"{\\\\"expression\\\\":\\\\"${srcDatasoureName}\\_${srcDatabaseName}\\\\"}"'."\n" + .'> }'."\n" + .'> ]', + 'type' => 'array', + 'items' => [ + 'description' => 'A definition for an object transformation rule.', + 'type' => 'object', + 'properties' => [ + 'RuleActionType' => ['description' => 'The action type. Valid values:'."\n" + ."\n" + .'- `DefinePrimaryKey`'."\n" + ."\n" + .'- `Rename`'."\n" + ."\n" + .'- `AddColumn`'."\n" + ."\n" + .'- `HandleDml`'."\n" + ."\n" + .'- `DefineIncrementalCondition`'."\n" + ."\n" + .'- `DefineCycleScheduleSettings`'."\n" + ."\n" + .'- `DefinePartitionKey`', 'type' => 'string', 'example' => 'Rename', 'title' => ''], + 'RuleExpression' => ['description' => 'The rule expression, in JSON string format.'."\n" + ."\n" + .'1. Rename rule (`Rename`)'."\n" + ."\n" + .'- Example: `{"expression":"${srcDatasourceName}_${srcDatabaseName}_0922"}`'."\n" + ."\n" + .'- `expression`: The expression for the rename transformation rule. The expression supports the following variables: `${srcDatasourceName}` (source data source name), `${srcDatabaseName}` (source database name), and `${srcTableName}` (source table name).'."\n" + ."\n" + .'2. Add column rule (`AddColumn`)'."\n" + ."\n" + .'- Example: `{"columns":[{"columnName":"my_add_column","columnValueType":"Constant","columnValue":"123"}]}`'."\n" + ."\n" + .'- If you do not specify this parameter, no columns are added or copied by default.'."\n" + ."\n" + .'- `columnName`: The name of the column to add.'."\n" + ."\n" + .'- `columnValueType`: The value type of the added column. Valid values: `Constant` and `Variable`.'."\n" + ."\n" + .'- `columnValue`: The value of the added column. If `columnValueType` is `Constant`, the value is a custom string constant. If `columnValueType` is `Variable`, the value is a built-in variable. Valid built-in variables: `EXECUTE_TIME` (execution time, Long), `DB_NAME_SRC` (source database name, String), `DATASOURCE_NAME_SRC` (source data source name, String), `TABLE_NAME_SRC` (source table name, String), `DB_NAME_DEST` (destination database name, String), `DATASOURCE_NAME_DEST` (destination data source name, String), `TABLE_NAME_DEST` (destination table name, String), and `DB_NAME_SRC_TRANSED` (converted database name, String).'."\n" + ."\n" + .'3. Define primary key rule (`DefinePrimaryKey`)'."\n" + ."\n" + .'- Example: `{"columns":["ukcolumn1","ukcolumn2"]}`'."\n" + ."\n" + .'- By default, the primary key columns from the source table are used.'."\n" + ."\n" + .'- If the destination table already exists, the data integration system does not modify the table schema. If the specified primary key columns are not in the destination table, the job fails to start.'."\n" + ."\n" + .'- If the destination table is automatically created, the data integration system automatically creates the table schema that includes the defined primary key columns. If the specified primary key columns are not in the destination table, the job fails to start.'."\n" + ."\n" + .'4. DML handling rule (`HandleDml`)'."\n" + ."\n" + .'- Example: `{"dmlPolicies":[{"dmlType":"Delete","dmlAction":"Filter","filterCondition":"id > 1"}]}`'."\n" + ."\n" + .'- If you do not specify this parameter, the default value `Normal` is used for Insert, Update, and Delete operations.'."\n" + ."\n" + .'- `dmlType`: The DML operation type. Valid values: `Insert`, `Update`, and `Delete`.'."\n" + ."\n" + .'- `dmlAction`: The DML handling policy. Valid values: `Normal` (process normally), `Ignore` (ignore), `Filter` (process conditionally, used when `dmlType` is `Update` or `Delete`), and `LogicalDelete` (logically delete).'."\n" + ."\n" + .'- `filterCondition`: The DML filter condition. This parameter is used when `dmlAction` is `Filter`.'."\n" + ."\n" + .'5. Define incremental condition rule (`DefineIncrementalCondition`)'."\n" + ."\n" + .'- Example: `{"where":"id > 0"}`'."\n" + ."\n" + .'- Specifies the filter condition for incremental synchronization.'."\n" + ."\n" + .'6. Define cycle schedule settings rule (`DefineCycleScheduleSettings`)'."\n" + ."\n" + .'- Example: `{"cronExpress":" * * * * * *", "cycleType":"1"}`'."\n" + ."\n" + .'- Specifies the scheduling parameters for a periodic job.'."\n" + ."\n" + .'7. Define partition key rule (`DefinePartitionKey`)'."\n" + ."\n" + .'- Example: `{"columns":["id"]}`'."\n" + ."\n" + .'- Specifies the partition key.', 'type' => 'string', 'example' => '{"expression":"${srcDatasoureName}_${srcDatabaseName}"}', 'title' => ''], + 'RuleName' => ['description' => 'The name of the rule. The rule name must be unique for a specific action type (`RuleActionType`) and target type (`RuleTargetType`).', 'type' => 'string', 'example' => 'rename_rule_1', 'title' => ''], + 'RuleTargetType' => ['description' => 'The target object type of the action. Valid values:'."\n" + ."\n" + .'- `Table`'."\n" + ."\n" + .'- `Schema`'."\n" + ."\n" + .'- `Database`', 'type' => 'string', 'example' => 'Table', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'JobStatus' => ['description' => 'The status of the job. Valid values:'."\n" + ."\n" + .'- `Finished`: The job is complete.'."\n" + ."\n" + .'- `Failed`: The job failed.'."\n" + ."\n" + .'- `Running`: The job is running.'."\n" + ."\n" + .'- `Initialized`: The job is initialized but has not started.'."\n" + ."\n" + .'- `Stopping`: The job is being stopped.'."\n" + ."\n" + .'- `Stop`: The job is stopped.', 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'DIJobId' => ['description' => 'This field is deprecated. Use the `Id` field instead.', 'type' => 'string', 'deprecated' => true, 'example' => '32601', 'title' => ''], + 'Owner' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => 'The data returned.', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetDIJob', + 'description' => 'This operation requires DataWorks Basic Edition or later.', + 'changeSet' => [ + ['createdAt' => '2025-03-27T08:15:26.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-01-06T05:34:14.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2024-10-15T07:52:06.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-10-15T06:50:20.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-10-14T09:34:05.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490\\",\\n \\"PagingInfo\\": {\\n \\"Id\\": 32601,\\n \\"Description\\": \\"description\\",\\n \\"DestinationDataSourceSettings\\": [\\n {\\n \\"DataSourceName\\": \\"dw_mysql\\"\\n }\\n ],\\n \\"DestinationDataSourceType\\": \\"Hologres\\",\\n \\"JobName\\": \\"imp_ods_dms_det_dealer_info_df\\",\\n \\"JobSettings\\": {\\n \\"ChannelSettings\\": \\"{\\\\\\"structInfo\\\\\\":\\\\\\"MANAGED\\\\\\",\\\\\\"storageType\\\\\\":\\\\\\"TEXTFILE\\\\\\",\\\\\\"writeMode\\\\\\":\\\\\\"APPEND\\\\\\",\\\\\\"partitionColumns\\\\\\":[{\\\\\\"columnName\\\\\\":\\\\\\"pt\\\\\\",\\\\\\"columnType\\\\\\":\\\\\\"STRING\\\\\\",\\\\\\"comment\\\\\\":\\\\\\"\\\\\\"}],\\\\\\"fieldDelimiter\\\\\\":\\\\\\"\\\\\\"}\\",\\n \\"ColumnDataTypeSettings\\": [\\n {\\n \\"DestinationDataType\\": \\"text\\",\\n \\"SourceDataType\\": \\"bigint\\"\\n }\\n ],\\n \\"CycleScheduleSettings\\": {\\n \\"CycleMigrationType\\": \\"Full\\",\\n \\"ScheduleParameters\\": \\"bizdate=$bizdate\\\\n\\"\\n },\\n \\"DdlHandlingSettings\\": [\\n {\\n \\"Action\\": \\"Ignore\\",\\n \\"Type\\": \\"CreateTable\\"\\n }\\n ],\\n \\"RuntimeSettings\\": [\\n {\\n \\"Name\\": \\"runtime.offline.concurrent\\\\n\\",\\n \\"Value\\": \\"1\\"\\n }\\n ]\\n },\\n \\"MigrationType\\": \\"FullAndRealtimeIncremental\\",\\n \\"JobType\\": \\"DatabaseRealtimeMigration\\",\\n \\"ProjectId\\": 98330,\\n \\"ResourceSettings\\": {\\n \\"OfflineResourceSettings\\": {\\n \\"RequestedCu\\": 2,\\n \\"ResourceGroupIdentifier\\": \\"di_resourcegroup_v1\\"\\n },\\n \\"RealtimeResourceSettings\\": {\\n \\"RequestedCu\\": 2,\\n \\"ResourceGroupIdentifier\\": \\"di_resourcegroup_v1\\"\\n },\\n \\"ScheduleResourceSettings\\": {\\n \\"RequestedCu\\": 2,\\n \\"ResourceGroupIdentifier\\": \\"schedual_resourcegroup_v1\\"\\n }\\n },\\n \\"SourceDataSourceSettings\\": [\\n {\\n \\"DataSourceName\\": \\"dw_mysql\\",\\n \\"DataSourceProperties\\": {\\n \\"Encoding\\": \\"UTF-8\\\\n\\",\\n \\"Timezone\\": \\"GMT+8\\\\n\\"\\n }\\n }\\n ],\\n \\"SourceDataSourceType\\": \\"Mysql\\",\\n \\"TableMappings\\": [\\n {\\n \\"SourceObjectSelectionRules\\": [\\n {\\n \\"Action\\": \\"Include\\",\\n \\"Expression\\": \\"mysql_table_1\\",\\n \\"ExpressionType\\": \\"Exact\\",\\n \\"ObjectType\\": \\"Table\\"\\n }\\n ],\\n \\"TransformationRules\\": [\\n {\\n \\"RuleName\\": \\"rename_rule_1\\",\\n \\"RuleActionType\\": \\"AddColumn\\",\\n \\"RuleTargetType\\": \\"Table\\"\\n }\\n ]\\n }\\n ],\\n \\"TransformationRules\\": [\\n {\\n \\"RuleActionType\\": \\"Rename\\",\\n \\"RuleExpression\\": \\"{\\\\\\"expression\\\\\\":\\\\\\"${srcDatasoureName}_${srcDatabaseName}\\\\\\"}\\",\\n \\"RuleName\\": \\"rename_rule_1\\",\\n \\"RuleTargetType\\": \\"Table\\"\\n }\\n ],\\n \\"JobStatus\\": \\"Running\\",\\n \\"DIJobId\\": \\"32601\\",\\n \\"Owner\\": \\"\\"\\n }\\n}","type":"json"}]', + ], + 'GetDIJobLog' => [ + 'summary' => 'Obtains logs generated for a synchronization task.', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235251', + 'abilityTreeNodes' => ['FEATUREdideBP0OJZ'], + 'autoTest' => false, + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the synchronization task.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '6153616438', 'title' => ''], + ], + [ + 'name' => 'FailoverId', + 'in' => 'query', + 'schema' => ['description' => 'The failover ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'DIJobId', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is deprecated. Use the Id parameter instead.', 'type' => 'integer', 'format' => 'int64', 'deprecated' => true, 'required' => false, 'example' => '10000', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The page number of the pagination query. The value is a positive integer greater than or equal to 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'NodeType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the node. This parameter is applicable only to the tasks that are run on serverless resource groups. Valid values:'."\n" + ."\n" + .'- **MASTER**: the master node, which is used to query the logs of JobManagers.'."\n" + ."\n" + .'- **WORKER**: the worker node, which is used to query the logs of TaskManagers.', 'type' => 'string', 'required' => false, 'example' => 'MASTER', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The logs that are returned.', + 'type' => 'object', + 'properties' => [ + 'Log' => ['description' => 'The log.', 'type' => 'string', 'title' => '', 'example' => '>>>>>>>> stdout:n++++++++++++++++++executing sql: create database if not exists jindo_test location \'oss://pangbei-hdfs/tmp/hive\' n++n'], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.', 'type' => 'string', 'example' => '1AFAE64E-D1BE-432B-A9****'], + ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"204EAF68-CCE3-5112-8DA0-E7A60F02XXXX\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": \\"90\\",\\n \\"PageSize\\": \\"10\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"Nodes\\": [\\n {\\n \\"Description\\": \\"Node description\\",\\n \\"Name\\": \\"Node name\\",\\n \\"ProjectId\\": 65133,\\n \\"Owner\\": \\"110755000425XXXX\\",\\n \\"CreateTime\\": 1724505917000,\\n \\"ModifyTime\\": 1724505917000,\\n \\"DataSource\\": {\\n \\"Name\\": \\"odps_first\\",\\n \\"Type\\": \\"odps\\"\\n },\\n \\"TaskId\\": 0,\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"null\\",\\n \\"Value\\": \\"null\\"\\n }\\n ],\\n \\"Strategy\\": {\\n \\"Timeout\\": 0,\\n \\"InstanceMode\\": \\"T+1\\",\\n \\"RerunMode\\": \\"Allowed\\",\\n \\"RerunTimes\\": 3,\\n \\"RerunInterval\\": 180000\\n },\\n \\"Outputs\\": {\\n \\"Variables\\": [\\n {\\n \\"Name\\": \\"output\\",\\n \\"ArtifactType\\": \\"Variable\\",\\n \\"Scope\\": \\"NodeParameter\\",\\n \\"Type\\": \\"Constant\\",\\n \\"Value\\": \\"111\\",\\n \\"Node\\": {\\n \\"Output\\": \\"463497880880954XXXX\\"\\n },\\n \\"Id\\": \\"543217824470354XXXX\\"\\n }\\n ],\\n \\"NodeOutputs\\": [\\n {\\n \\"Data\\": \\"463497880880954XXXX\\"\\n }\\n ],\\n \\"Tables\\": [\\n {\\n \\"Guid\\": \\"odps.autotest.test_output_table_1\\"\\n }\\n ]\\n },\\n \\"Inputs\\": {\\n \\"Variables\\": [\\n {\\n \\"Name\\": \\"input\\",\\n \\"ArtifactType\\": \\"Variable\\",\\n \\"Scope\\": \\"NodeParameter\\",\\n \\"Type\\": \\"Constant\\",\\n \\"Value\\": \\"111\\",\\n \\"Node\\": {\\n \\"Output\\": \\"860438872620113XXXX\\"\\n },\\n \\"Id\\": \\"543218872620113XXXX\\"\\n }\\n ],\\n \\"NodeOutputs\\": [\\n {\\n \\"Data\\": \\"860438872620113XXXX\\"\\n }\\n ],\\n \\"Tables\\": [\\n {\\n \\"Guid\\": \\"odps.autotest.test_output_table_1\\"\\n }\\n ]\\n },\\n \\"Trigger\\": {\\n \\"Type\\": \\"Scheduler\\",\\n \\"Cron\\": \\"00 00 00 * * ?\\",\\n \\"StartTime\\": \\"1970-01-01 00:00:00\\",\\n \\"EndTime\\": \\"9999-01-01 00:00:00\\",\\n \\"Timezone\\": \\"Asia/Shanghai\\",\\n \\"Id\\": \\"543680677872062XXXX\\"\\n },\\n \\"Script\\": {\\n \\"Path\\": \\"root/demo\\",\\n \\"Runtime\\": {\\n \\"Command\\": \\"ODPS_SQL\\"\\n },\\n \\"Id\\": \\"853573334108680XXXX\\"\\n },\\n \\"RuntimeResource\\": {\\n \\"ResourceGroupId\\": \\"S_res_group_XXXX_XXXX\\"\\n },\\n \\"Recurrence\\": \\"Normal\\",\\n \\"Id\\": \\"723932906364267XXXX\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListNodeDependencies', - ], - 'CreateWorkflowDefinition' => [ - 'summary' => 'Creates a workflow in a directory of DataStudio.', - 'methods' => [ - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Log\\": \\">>>>>>>> stdout:n++++++++++++++++++executing sql: create database if not exists jindo_test location \'oss://pangbei-hdfs/tmp/hive\' n++n\\",\\n \\"RequestId\\": \\"1AFAE64E-D1BE-432B-A9****\\"\\n}","type":"json"}]', + 'title' => 'GetDIJobLog', + 'description' => 'This API operation is available for all DataWorks editions.', + 'changeSet' => [ + ['createdAt' => '2025-02-17T09:05:50.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-01-06T05:34:14.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'GetDataQualityAlertRule' => [ + 'summary' => 'Retrieves the details of a data quality alert rule by rule ID.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '234974', - 'abilityTreeNodes' => [ - 'FEATUREdideHO4TQP', - 'FEATUREdide8FM783', - 'FEATUREdideQUQUVB', - 'FEATUREdideIQU97M', - ], + 'abilityTreeNodes' => ['FEATUREdide3WJOKE'], ], '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 query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10000', - ], - ], - [ - 'name' => 'Spec', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The FlowSpec field information about the workflow. For more information, see [FlowSpec](https://github.com/aliyun/alibabacloud-dataworks-tool-dflow/).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '{'."\n" - .' "kind": "CycleWorkflow",'."\n" - .' "version": "1.1.0",'."\n" - .' "spec": {'."\n" - .' "name": "OpenAPITestWorkflowDemo",'."\n" - .' "type": "CycleWorkflow",'."\n" - .' "workflows": ['."\n" - .' {'."\n" - .' "script": {'."\n" - .' "path": "XX/OpenAPITest/WorkflowTest/OpenAPITestWorkflowDemo",'."\n" - .' "runtime": {'."\n" - .' "command": "WORKFLOW"'."\n" - .' }'."\n" - .' },'."\n" - .' "trigger": {'."\n" - .' "type": "Scheduler",'."\n" - .' "cron": "00 02 00 * * ?",'."\n" - .' "startTime": "1970-01-01 00:00:00",'."\n" - .' "endTime": "9999-01-01 00:00:00",'."\n" - .' "timezone": "Asia/Shanghai",'."\n" - .' "delaySeconds": 0'."\n" - .' },'."\n" - .' "strategy": {'."\n" - .' "timeout": 0,'."\n" - .' "instanceMode": "T+1",'."\n" - .' "rerunMode": "Allowed",'."\n" - .' "rerunTimes": 3,'."\n" - .' "rerunInterval": 180000,'."\n" - .' "failureStrategy": "Break"'."\n" - .' },'."\n" - .' "name": "OpenAPITestWorkflowDemo",'."\n" - .' "inputs": {},'."\n" - .' "outputs": {'."\n" - .' "nodeOutputs": ['."\n" - .' {'."\n" - .' "data": "workflow_output",'."\n" - .' "artifactType": "NodeOutput",'."\n" - .' "refTableName": "OpenAPITestWorkflowDemo"'."\n" - .' }'."\n" - .' ]'."\n" - .' },'."\n" - .' "nodes": [],'."\n" - .' "dependencies": []'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .'}', - ], + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The data quality monitoring alert rule ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '113642', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0EF298E5-0940-5AC7-9CB0-65025070XXXX', - ], - 'Id' => [ - 'description' => 'The unique identifier of the workflow.'."\n" - ."\n" - .'> Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.'."\n", - 'type' => 'string', - 'example' => '463497880880954XXXX', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0bc14115****159376359'], + 'DataQualityAlertRule' => [ + 'description' => 'Data quality monitoring alert rules.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the data quality monitoring alert rule.', 'type' => 'integer', 'format' => 'int64', 'example' => '21045', 'title' => ''], + 'Condition' => ['description' => 'Alert conditions of the data quality monitoring alert rule.', 'type' => 'string', 'example' => 'results.any { r -> r.status == \'fail\' && r.rule.severity == \'High\' }', 'title' => ''], + 'ProjectId' => ['description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '90912', 'title' => ''], + 'Target' => [ + 'description' => 'The monitored target of the data quality monitoring alert rule.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The type of the monitored target. Only `DataQualityScan` is supported.', 'type' => 'string', 'example' => 'DataQualityScan', 'title' => ''], + 'Ids' => [ + 'description' => 'The list of monitored target IDs.', + 'type' => 'array', + 'items' => ['description' => 'The monitored target ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '113647', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'Notification' => [ + 'description' => 'Alert notification settings.', + 'type' => 'object', + 'properties' => [ + 'Channels' => [ + 'description' => 'In Channels, you can set both Email and Sms at the same time. In other cases, only one channel can be set.', + 'type' => 'array', + 'items' => [ + 'description' => 'Alert channels.'."\n" + ."\n" + .'- Dingding'."\n" + ."\n" + .'- Mail'."\n" + ."\n" + .'- Weixin'."\n" + ."\n" + .'- Feishu'."\n" + ."\n" + .'- Phone'."\n" + ."\n" + .'- Sms'."\n" + ."\n" + .'- Webhook', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'Dingding', + 'title' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Receivers' => [ + 'description' => 'The alert recipients.', + 'type' => 'array', + 'items' => [ + 'description' => 'The alert recipients.', + 'type' => 'object', + 'properties' => [ + 'Extension' => ['description' => 'Additional configurations required for the alert recipients. When ReceiverType is DingdingUrl, you can set `{"atAll":true}` to mention all members.', 'type' => 'string', 'example' => '{"atAll":true}', 'title' => ''], + 'ReceiverType' => [ + 'description' => 'The type of alert recipients.'."\n" + ."\n" + .'- ShiftSchedule'."\n" + ."\n" + .'- WebhookUrl'."\n" + ."\n" + .'- FeishuUrl'."\n" + ."\n" + .'- TaskOwner'."\n" + ."\n" + .'- WeixinUrl'."\n" + ."\n" + .'- DingdingUrl'."\n" + ."\n" + .'- DataQualityScanOwner'."\n" + ."\n" + .'- AliUid', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'TaskOwner', + 'title' => '', + ], + 'ReceiverValues' => [ + 'description' => 'The value of alert recipients.', + 'type' => 'array', + 'items' => ['description' => 'The value of alert recipients.'."\n" + ."\n" + .'- If ReceiverType is AliUid, enter the Alibaba Cloud account ID.'."\n" + ."\n" + .'- If ReceiverType is ShiftSchedule, enter the shift schedule ID.'."\n" + ."\n" + .'- If ReceiverType is WebhookUrl, DingdingUrl, FeishuUrl, or WeixinUrl, enter the corresponding URL.', 'type' => 'string', 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=a30bae7******', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0EF298E5-0940-5AC7-9CB0-6502507****\\",\\n \\"Id\\": \\"463497880880954XXXX\\"\\n}","type":"json"}]', - 'title' => 'CreateWorkflowDefinition', - 'description' => '> You cannot use this API operation to create multiple workflows at a time. If you specify multiple workflows by using FlowSpec, the system creates only the first specified workflow. Other specified workflows and the nodes in the workflows are ignored. You can call the CreateNode operation to create a node.'."\n", - ], - 'ImportWorkflowDefinition' => [ - 'summary' => 'Imports a workflow and its child nodes that are specified by the FlowSpec field to DataStudio.', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetDataQualityAlertRule', + 'description' => 'DataWorks Basic Edition or a higher edition is required.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetDataQualityAlertRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115****159376359\\",\\n \\"DataQualityAlertRule\\": {\\n \\"Id\\": 21045,\\n \\"Condition\\": \\"results.any { r -> r.status == \'fail\' && r.rule.severity == \'High\' }\\",\\n \\"ProjectId\\": 90912,\\n \\"Target\\": {\\n \\"Type\\": \\"DataQualityScan\\",\\n \\"Ids\\": [\\n 113647\\n ]\\n },\\n \\"Notification\\": {\\n \\"Channels\\": [\\n \\"Dingding\\"\\n ],\\n \\"Receivers\\": [\\n {\\n \\"Extension\\": \\"{\\\\\\"atAll\\\\\\":true}\\",\\n \\"ReceiverType\\": \\"TaskOwner\\",\\n \\"ReceiverValues\\": [\\n \\"https://oapi.dingtalk.com/robot/send?access_token=a30bae7******\\"\\n ]\\n }\\n ]\\n }\\n }\\n}","type":"json"}]', + ], + 'GetDataQualityEvaluationTask' => [ + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, + 'operationType' => 'read', + 'deprecated' => true, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '246297', - 'abilityTreeNodes' => [ - 'FEATUREdideHO4TQP', - 'FEATUREdide8FM783', - 'FEATUREdideQUQUVB', - 'FEATUREdideIQU97M', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '250883', + 'abilityTreeNodes' => ['FEATUREdide3WJOKE'], + 'tenantRelevance' => 'tenant', ], '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 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, - 'example' => '123456', - ], - ], - [ - 'name' => 'Spec', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The FlowSpec information for this workflow. For more information, see [FlowSpec](https://github.com/aliyun/alibabacloud-dataworks-tool-dflow/).'."\n" - ."\n" - .'> How to quickly obtain a FlowSpec template?'."\n" - ."\n" - .'* Open a workflow in Data Studio, then click "Show Spec" in the top-right corner to retrieve the FlowSpec description for the current workflow. You can use this FlowSpec description to quickly build a template that meets your requirements.'."\n" - ."\n" - .'> This interface supports creating both the workflow and its internal nodes simultaneously. Therefore, please pay close attention to the ID specified in the FlowSpec. If the provided ID already exists, the operation will be treated as an update. A create operation is performed only if the ID is omitted or does not exist.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '{'."\n" - .' "version": "1.1.0",'."\n" - .' "kind": "CycleWorkflow",'."\n" - .' "spec": {'."\n" - .' "name": "Asynchronous_Workflow_Creation_Test",'."\n" - .' "id": "632647691239009XXXX",'."\n" - .' "type": "CycleWorkflow",'."\n" - .' "workflows": ['."\n" - .' {'."\n" - .' "script": {'."\n" - .' "path": "XX/OpenAPI_Test/Workflow_Test/Asynchronous_Workflow_Creation_Test",'."\n" - .' "runtime": {'."\n" - .' "command": "WORKFLOW"'."\n" - .' }'."\n" - .' },'."\n" - .' "id": "632647691239009XXXX",'."\n" - .' "trigger": {'."\n" - .' "type": "Scheduler",'."\n" - .' "cron": "00 03 00 * * ?",'."\n" - .' "startTime": "1970-01-01 00:00:00",'."\n" - .' "endTime": "9999-01-01 00:00:00",'."\n" - .' "timezone": "Asia/Shanghai",'."\n" - .' "delaySeconds": 0'."\n" - .' },'."\n" - .' "strategy": {'."\n" - .' "timeout": 0,'."\n" - .' "instanceMode": "T+1",'."\n" - .' "rerunMode": "Allowed",'."\n" - .' "rerunTimes": 3,'."\n" - .' "rerunInterval": 180000,'."\n" - .' "failureStrategy": "Break"'."\n" - .' },'."\n" - .' "name": "Asynchronous_Workflow_Creation_Test",'."\n" - .' "inputs": {},'."\n" - .' "outputs": {'."\n" - .' "nodeOutputs": ['."\n" - .' {'."\n" - .' "data": "632647691239009XXXX",'."\n" - .' "artifactType": "NodeOutput",'."\n" - .' "refTableName": "Asynchronous_Workflow_Creation_Test"'."\n" - .' }'."\n" - .' ]'."\n" - .' },'."\n" - .' "nodes": ['."\n" - .' {'."\n" - .' "recurrence": "Normal",'."\n" - .' "id": "742981001612325XXXX",'."\n" - .' "timeout": 0,'."\n" - .' "instanceMode": "T+1",'."\n" - .' "rerunMode": "Allowed",'."\n" - .' "rerunTimes": 3,'."\n" - .' "rerunInterval": 180000,'."\n" - .' "script": {'."\n" - .' "path": "XX/OpenAPI_Test/Workflow_Test/Asynchronous_Workflow_Creation_Test/111",'."\n" - .' "runtime": {'."\n" - .' "command": "ODPS_SQL"'."\n" - .' },'."\n" - .' "content": "select now();\\n"'."\n" - .' },'."\n" - .' "trigger": {'."\n" - .' "type": "Scheduler",'."\n" - .' "cron": "00 24 00 * * ?",'."\n" - .' "startTime": "1970-01-01 00:00:00",'."\n" - .' "endTime": "9999-01-01 00:00:00",'."\n" - .' "timezone": "Asia/Shanghai",'."\n" - .' "delaySeconds": 0'."\n" - .' },'."\n" - .' "name": "111",'."\n" - .' "inputs": {},'."\n" - .' "outputs": {'."\n" - .' "nodeOutputs": ['."\n" - .' {'."\n" - .' "data": "742981001612325XXXX",'."\n" - .' "artifactType": "NodeOutput",'."\n" - .' "refTableName": "111"'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .' },'."\n" - .' {'."\n" - .' "recurrence": "Normal",'."\n" - .' "id": "595182137303408XXXX",'."\n" - .' "timeout": 0,'."\n" - .' "instanceMode": "T+1",'."\n" - .' "rerunMode": "Allowed",'."\n" - .' "rerunTimes": 3,'."\n" - .' "rerunInterval": 180000,'."\n" - .' "script": {'."\n" - .' "path": "XX/OpenAPI_Test/Workflow_Test/Asynchronous_Workflow_Creation_Test/222",'."\n" - .' "runtime": {'."\n" - .' "command": "ODPS_SQL"'."\n" - .' },'."\n" - .' "content": "select now();\\n select 1;"'."\n" - .' },'."\n" - .' "trigger": {'."\n" - .' "type": "Scheduler",'."\n" - .' "cron": "00 00 00 * * ?",'."\n" - .' "startTime": "1970-01-01 00:00:00",'."\n" - .' "endTime": "9999-01-01 00:00:00",'."\n" - .' "timezone": "Asia/Shanghai",'."\n" - .' "delaySeconds": 0'."\n" - .' },'."\n" - .' "name": "222",'."\n" - .' "inputs": {},'."\n" - .' "outputs": {'."\n" - .' "nodeOutputs": ['."\n" - .' {'."\n" - .' "data": "595182137303408XXXX",'."\n" - .' "artifactType": "NodeOutput",'."\n" - .' "refTableName": "222" '."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .' }'."\n" - .' ],'."\n" - .' "dependencies": ['."\n" - .' {'."\n" - .' "nodeId": "595182137303408XXXX",'."\n" - .' "depends": ['."\n" - .' {'."\n" - .' "type": "Normal",'."\n" - .' "output": "742981001612325XXXX",'."\n" - .' "refTableName": "111"'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .'}', - ], + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'Data quality monitoring ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'example' => '1006455182', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '7C352CB7-CD88-50CF-9D0D-E81BDF020E7F', - ], - 'AsyncJob' => [ - 'description' => 'The status information of the asynchronous task.'."\n", + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF'], + 'DataQualityEvaluationTask' => [ + 'description' => 'Data quality monitoring details.', 'type' => 'object', 'properties' => [ - 'Completed' => [ - 'description' => 'Indicates whether the asynchronous task is complete.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'CreateTime' => [ - 'description' => 'The time when the asynchronous task was created. This value is a UNIX timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1706581425000', - ], - 'Error' => [ - 'description' => 'The error message returned if the asynchronous task fails.'."\n", - 'type' => 'string', - 'example' => 'target folder already exists: XXXX', - ], - 'Id' => [ - 'description' => 'The ID of the asynchronous task.'."\n", - 'type' => 'string', - 'example' => '1234567691239009XXXX', - ], - 'Progress' => [ - 'description' => 'The progress of the asynchronous task. Valid values: 0 to 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', + 'Target' => [ + 'title' => '', + 'description' => 'Data quality monitoring object.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '', 'description' => 'Monitoring object type.'."\n" + .'- Table: Table.', 'type' => 'string', 'example' => 'Table'], + 'DatabaseType' => [ + 'title' => '', + 'description' => 'Database type to which the table belongs:'."\n" + .'- maxcompute'."\n" + .'- hologres'."\n" + .'- cdh'."\n" + .'- analyticdb_for_mysql'."\n" + .'- starrocks'."\n" + .'- emr'."\n" + .'- analyticdb_for_postgresql', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'maxcompute', + ], + 'TableGuid' => ['title' => '', 'description' => 'Unique ID of the table in Data Map.', 'type' => 'string', 'example' => 'odps.meta_open_api_test_sz.test_partition_tbl'], + 'PartitionSpec' => ['description' => 'Partition range setting for data quality monitoring.', 'type' => 'string', 'example' => 'pt=$[yyyymmdd-1]', 'title' => ''], + ], + 'example' => '', ], - 'Response' => [ - 'description' => 'The response.'."\n" - ."\n" - .'> The workflow ID is returned.'."\n", - 'type' => 'string', - 'example' => '632647691239009XXXX', + 'Description' => ['title' => '', 'description' => 'Description of the quality monitoring task.', 'type' => 'string', 'example' => 'The description of the quality monitoring task.'], + 'Trigger' => [ + 'title' => '', + 'description' => 'Trigger configuration of the data quality validation task.', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '', + 'description' => 'Quality monitoring trigger type:'."\n" + ."\n" + .'- ByManual: Manual trigger'."\n" + .'- ByScheduledTaskInstance: Scheduled task trigger'."\n" + .'- ByQualityNode: Quality node trigger', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'ByScheduledTaskInstance', + ], + 'TaskIds' => [ + 'title' => '', + 'description' => 'List of scheduled task IDs. Valid when Type is ByScheduledTaskInstance.', + 'type' => 'array', + 'items' => ['description' => 'Scheduled task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '30001', 'title' => ''], + 'example' => '', + ], + ], + 'example' => '', ], - 'Status' => [ - 'description' => 'The status of the asynchronous task.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Running: The asynchronous task is running.'."\n" - .'* Success: The asynchronous task is complete.'."\n" - .'* Fail: The asynchronous task fails.'."\n" - .'* Cancel: The asynchronous task is canceled.'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Running', + 'RuntimeConf' => ['title' => '', 'description' => 'Extended configuration. A JSON-formatted string. Only takes effect for EMR-type data quality monitoring.'."\n" + ."\n" + .'- queue: The YARN queue used when executing EMR data quality validation. Defaults to the queue configured for the current project.'."\n" + .'- sqlEngine: The SQL engine used when executing EMR data validation.'."\n" + .' + HIVE_SQL'."\n" + .' + SPARK_SQL', 'type' => 'string', 'example' => '{ "queue": "default", "sqlEngine": "SPARK_SQL" }'."\n"], + 'Id' => ['title' => '', 'description' => 'Data quality monitoring ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '2178'], + 'Name' => ['title' => '', 'description' => 'Name of the quality monitoring task.', 'type' => 'string', 'required' => true, 'example' => 'OpenAPI create a data quality monitoring test'], + 'ProjectId' => ['title' => '', 'description' => 'Workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '2626'], + 'Hooks' => [ + 'title' => '', + 'description' => 'Callback settings.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '', + 'description' => 'Hook type. Currently, only one type is supported:'."\n" + ."\n" + .'- BlockTaskInstance: Blocks the scheduled task from continuing to run. When data quality monitoring is triggered by a scheduled task, after the data quality monitoring completes, Hook.Condition is used to determine whether to block the scheduled task from continuing to run.', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'BlockTaskInstance', + ], + 'Condition' => ['title' => '', 'description' => 'Hook trigger condition. When this condition is met, the hook action is triggered. Currently, only two types of conditional expressions are supported:'."\n" + ."\n" + .'- Specify a single group of rule severity type and rule validation status, e.g., `${severity} == "High" AND ${status} == "Critical"`, which means the condition is met if any executed rule with severity High has a validation result of Critical.'."\n" + .'- Specify multiple groups of rule severity types and rule validation statuses, e.g., `(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")`, which means the condition is met if any executed rule has severity High with validation result Critical, or severity Normal with validation result Critical, or severity Normal with validation result Error. The severity enum in the conditional expression is consistent with the severity enum in DataQualityRule, and the status enum is consistent with the status in DataQualityResult.', 'type' => 'string', 'example' => '(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")'], + ], + 'description' => 'Hook', + 'title' => '', + 'example' => '', + ], + 'example' => '', ], - 'Type' => [ - 'description' => 'The type of the asynchronous task.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Create: The asynchronous task is used to create an object.'."\n" - .'* Cancel: The asynchronous task is used to cancel an operation.'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Create', + 'Notifications' => [ + 'title' => '', + 'description' => 'Notification subscription configuration.', + 'type' => 'object', + 'properties' => [ + 'Condition' => ['title' => '', 'description' => 'Notification trigger condition. When this condition is met, the message notification is triggered. Currently, only two types of conditional expressions are supported:'."\n" + ."\n" + .'- Specify a single group of rule severity type and rule validation status, e.g., `${severity} == "High" AND ${status} == "Critical"`, which means the condition is met if any executed rule with severity High has a validation result of Critical.'."\n" + .'- Specify multiple groups of rule severity types and rule validation statuses, e.g., `(${severity} == "High"AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")`, which means the condition is met if any executed rule has severity High with validation result Critical, or severity Normal with validation result Critical, or severity Normal with validation result Error. The severity enum in the conditional expression is consistent with the severity enum in DataQualityRule, and the status enum is consistent with the status in DataQualityResult.', 'type' => 'string', 'example' => '(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")'], + 'Notifications' => [ + 'title' => '', + 'description' => 'Notification settings.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NotificationReceivers' => [ + 'title' => '', + 'description' => 'Alert receiver settings.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ReceiverType' => [ + 'title' => '', + 'description' => 'Additional parameter settings when sending alerts. JSON format. Supported keys are as follows:'."\n" + ."\n" + .'- atAll: Whether to @everyone in the group when sending DingTalk alerts. Takes effect when ReceiverType is DingdingUrl.', + 'enumValueTitles' => ['WebhookUrl' => 'Custom webhook URL', 'FeishuUrl' => 'Lark notification URL', 'DingdingUrl' => 'DingTalk group robot URL', 'WeixinUrl' => 'WeCom notification URL', 'AliUid' => 'User ID'], + 'type' => 'string', + 'example' => 'DingdingUrl', + ], + 'Extension' => ['title' => '', 'description' => 'Extended information.', 'type' => 'string', 'example' => '{ "atAll": true }'."\n"], + 'ReceiverValues' => [ + 'title' => '', + 'description' => 'Alert receiver.', + 'type' => 'array', + 'items' => ['description' => 'Receiver value.'."\n" + ."\n" + .'- When the receiver type is Alibaba Cloud ID, the receiver value is the specific Alibaba Cloud user ID.'."\n" + .'- When the receiver type is DingdingUrl, the receiver value is the specific alert URL of the DingTalk robot.'."\n" + .'- When the receiver type is WeixinUrl, the receiver value is the specific alert URL of WeCom.'."\n" + .'- When the receiver type is FeishuUrl, the receiver value is the specific alert URL of Lark.'."\n" + .'- When the receiver type is WebhookUrl, the receiver value is the specific alert URL of the custom Webhook.', 'type' => 'string', 'example' => 'https://api.fc.aliyuncs.com/webhook'."\n", 'title' => ''], + 'example' => '', + ], + ], + 'description' => 'Alert receiver settings', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'NotificationChannels' => [ + 'title' => '', + 'description' => 'Notification method.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Channels' => [ + 'title' => '', + 'description' => 'Notification method.', + 'type' => 'array', + 'items' => [ + 'description' => 'Alert method'."\n" + ."\n" + .'- Mail - Email'."\n" + .'- Sms - SMS'."\n" + .'- Phone - Phone'."\n" + .'- Feishu - Lark'."\n" + .'- Weixin - WeCom'."\n" + .'- Dingding - DingTalk'."\n" + .'- Webhook - Custom Webhook', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'Mail', + 'title' => '', + ], + 'example' => '', + ], + ], + 'description' => 'Notification method', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'description' => 'Notification settings', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', ], + 'DataSourceId' => ['description' => 'Data source ID used by the quality monitoring task.', 'type' => 'integer', 'format' => 'int64', 'example' => '45238', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'staticInfo' => [ - 'returnType' => 'asynchronous', - 'callback' => 'dataworks-public::2024-05-18::GetJobStatus', - 'callbackInterval' => 1000, - 'maxCallbackTimes' => 10, + 'substitutions' => ['dataworks-public::2024-05-18::CreateDataQualityScan'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7C352CB7-CD88-50CF-9D0D-E81BDF020E7F\\",\\n \\"AsyncJob\\": {\\n \\"Completed\\": false,\\n \\"CreateTime\\": 1706581425000,\\n \\"Error\\": \\"target folder already exists: XXXX\\",\\n \\"Id\\": \\"1234567691239009XXXX\\",\\n \\"Progress\\": 0,\\n \\"Response\\": \\"632647691239009XXXX\\",\\n \\"Status\\": \\"Running\\",\\n \\"Type\\": \\"Create\\"\\n }\\n}","type":"json"}]', - 'title' => 'ImportWorkflowDefinition', - 'description' => '> '."\n" - ."\n" - .'* You cannot use this API operation to import multiple workflows at a time. If you specify multiple workflows by using FlowSpec, the system imports only the first specified workflow.'."\n" - ."\n" - .'* ImportWorkflowDefinition is an asynchronous operation. After you send a request, an asynchronous task is generated, and the system returns the ID of the asynchronous task. You can call the GetJobStatus operation to query the status of the asynchronous task.'."\n", - ], - 'DeleteWorkflowDefinition' => [ - 'summary' => 'Deletes a workflow from DataStudio.', - 'methods' => [ - 'post', + 'title' => 'Query data quality monitoring details', + 'summary' => 'Query the details of a data quality validation task.', + 'description' => 'Available only with DataWorks Basic Edition or higher.', + 'changeSet' => [ + ['createdAt' => '2025-01-15T08:15:09.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-12-23T06:29:09.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF\\",\\n \\"DataQualityEvaluationTask\\": {\\n \\"Target\\": {\\n \\"Type\\": \\"Table\\",\\n \\"DatabaseType\\": \\"maxcompute\\",\\n \\"TableGuid\\": \\"odps.meta_open_api_test_sz.test_partition_tbl\\",\\n \\"PartitionSpec\\": \\"pt=$[yyyymmdd-1]\\"\\n },\\n \\"Description\\": \\"The description of the quality monitoring task.\\",\\n \\"Trigger\\": {\\n \\"Type\\": \\"ByScheduledTaskInstance\\",\\n \\"TaskIds\\": [\\n 30001\\n ]\\n },\\n \\"RuntimeConf\\": \\"{ \\\\\\"queue\\\\\\": \\\\\\"default\\\\\\", \\\\\\"sqlEngine\\\\\\": \\\\\\"SPARK_SQL\\\\\\" }\\\\n\\",\\n \\"Id\\": 2178,\\n \\"Name\\": \\"OpenAPI create a data quality monitoring test\\",\\n \\"ProjectId\\": 2626,\\n \\"Hooks\\": [\\n {\\n \\"Type\\": \\"BlockTaskInstance\\",\\n \\"Condition\\": \\"(${severity} == \\\\\\"High\\\\\\" AND ${status} == \\\\\\"Critical\\\\\\") OR (${severity} == \\\\\\"Normal\\\\\\" AND ${status} == \\\\\\"Critical\\\\\\") OR (${severity} == \\\\\\"Normal\\\\\\" AND ${status} == \\\\\\"Error\\\\\\")\\"\\n }\\n ],\\n \\"Notifications\\": {\\n \\"Condition\\": \\"(${severity} == \\\\\\"High\\\\\\" AND ${status} == \\\\\\"Critical\\\\\\") OR (${severity} == \\\\\\"Normal\\\\\\" AND ${status} == \\\\\\"Critical\\\\\\") OR (${severity} == \\\\\\"Normal\\\\\\" AND ${status} == \\\\\\"Error\\\\\\")\\",\\n \\"Notifications\\": [\\n {\\n \\"NotificationReceivers\\": [\\n {\\n \\"ReceiverType\\": \\"DingdingUrl\\",\\n \\"Extension\\": \\"{ \\\\\\"atAll\\\\\\": true }\\\\n\\",\\n \\"ReceiverValues\\": [\\n \\"https://api.fc.aliyuncs.com/webhook\\\\n\\"\\n ]\\n }\\n ],\\n \\"NotificationChannels\\": [\\n {\\n \\"Channels\\": [\\n \\"Mail\\"\\n ]\\n }\\n ]\\n }\\n ]\\n },\\n \\"DataSourceId\\": 45238\\n }\\n}","type":"json"}]', + ], + 'GetDataQualityEvaluationTaskInstance' => [ + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, + 'operationType' => 'read', + 'deprecated' => true, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '234975', - 'abilityTreeNodes' => [ - 'FEATUREdideHO4TQP', - 'FEATUREdide8FM783', - 'FEATUREdideQUQUVB', - 'FEATUREdideIQU97M', - ], + 'abilityTreeCode' => '250220', + 'abilityTreeNodes' => ['FEATUREdideGK4B66'], ], '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 query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10000', - ], - ], [ 'name' => 'Id', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The unique identifier of the Data Studio workflow.'."\n" - ."\n" - .'> This field is of the Long type in SDK versions prior to 8.0.0, and of the String type in SDK versions 8.0.0 and later. This change does not affect normal SDK usage; the parameter will still be returned according to the type defined in the SDK. However, compilation failures may occur due to the type change only when upgrading the SDK across version 8.0.0. In this case, you must manually update the data type.', - 'type' => 'string', - 'required' => true, - 'example' => '860438872620113XXXX', - ], + 'in' => 'query', + 'schema' => ['description' => 'The instance ID of the data quality monitoring task.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '7227550902', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B17730C0-D959-548A-AE23-E754177CXXXX', - ], - '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. Used to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => '8abcb91f-d266-4073-b907-2ed67****', 'title' => ''], + 'DataQualityEvaluationTaskInstance' => [ + 'description' => 'The details of the data quality monitoring instance.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The instance status of the data quality monitoring task. Valid values:'."\n" + .'- Running: The check is in progress.'."\n" + .'- Error: A rule check encountered an error.'."\n" + .'- Passed: All rule checks passed.'."\n" + .'- Warned: A rule triggered a normal alert threshold.'."\n" + .'- Critical: A rule triggered a critical alert threshold.', 'type' => 'string', 'example' => 'Passed', 'title' => ''], + 'Task' => [ + 'description' => 'The data quality monitoring task.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the data quality monitoring task.', 'type' => 'string', 'example' => 'Data quality OpenAPI monitoring test'."\n", 'title' => ''], + 'Notifications' => [ + 'description' => 'The notification settings.', + 'type' => 'object', + 'properties' => [ + 'Condition' => ['description' => 'The cause that triggers a notification. When this condition is met, a message notification is sent. Only two types of conditional expressions are supported:'."\n" + ."\n" + .'- Specify a single combination of rule severity and rule check status. For example, `${severity} == "High" AND ${status} == "Critical"` means that the condition is met if any rule with a severity of High has a check result of Critical. '."\n" + .'- Specify multiple combinations of rule severity and rule check status. For example, `(${severity} == "High"AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")` means that the condition is met if any rule with a severity of High has a check result of Critical, or any rule with a severity of Normal has a check result of Critical, or any rule with a severity of Normal has a check result of Error. The severity enumeration values in the conditional expression are consistent with the severity enumeration values in DataQualityRule, and the status enumeration values are consistent with the status values in DataQualityResult.', 'type' => 'string', 'example' => '${severity} == "High" AND ${status} == "Critical"', 'title' => ''], + 'Notifications' => [ + 'description' => 'The alert methods.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NotificationReceivers' => [ + 'description' => 'The notification recipients.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ReceiverType' => ['description' => 'The type of the alert recipient.', 'type' => 'string', 'example' => 'DingdingUrl', 'title' => ''], + 'Extension' => ['description' => 'The additional parameter settings for sending alerts, in JSON format. The following keys are supported:'."\n" + ."\n" + .'- atAll: Specifies whether to @everyone in the group when sending a DingTalk alert. This parameter takes effect only when ReceiverType is set to DingdingUrl.', 'type' => 'string', 'example' => '{ "atAll": true }', 'title' => ''], + 'ReceiverValues' => [ + 'description' => 'The alert recipients.', + 'type' => 'array', + 'items' => ['description' => 'The recipient value.'."\n" + ."\n" + .'- If the recipient type is Alibaba Cloud ID, the value is the Alibaba Cloud user ID.'."\n" + .'- If the recipient type is DingdingUrl, the value is the webhook URL of the DingTalk chatbot.'."\n" + .'- If the recipient type is WeixinUrl, the value is the webhook URL of the WeCom chatbot.'."\n" + .'- If the recipient type is FeishuUrl, the value is the webhook URL of the Lark chatbot.'."\n" + .'- If the recipient type is WebhookUrl, the value is the webhook URL of a custom webhook.', 'type' => 'string', 'example' => 'https://api.fc.aliyuncs.com/webhook', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'NotificationChannels' => [ + 'description' => 'The notification channels.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Channels' => [ + 'description' => 'The notification channels.', + 'type' => 'array', + 'items' => ['description' => 'The alert method. Valid values:'."\n" + ."\n" + .'- Mail: email.'."\n" + .'- Sms: text message.'."\n" + .'- Phone: phone call.'."\n" + .'- Feishu: Lark.'."\n" + .'- Weixin: WeChat.'."\n" + .'- Dingding: DingTalk.'."\n" + .'- Webhook: custom webhook.', 'type' => 'string', 'example' => 'Mail', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'Hooks' => [ + 'description' => 'The callback settings.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The hook type. Only one type is supported:'."\n" + ."\n" + .'- BlockTaskInstance: Blocks the scheduling node from continuing to run. If the data quality monitoring task is triggered by a scheduling node, after the data quality monitoring task is completed, the system determines whether to block the scheduling node from continuing to run based on Hook.Condition.', 'type' => 'string', 'example' => 'BlockTaskInstance', 'title' => ''], + 'Condition' => ['description' => 'The cause that triggers the hook action. When this condition is met, the hook action is triggered. Only two types of conditional expressions are supported:'."\n" + ."\n" + .'- Specify a single combination of rule severity and rule check status. For example, `${severity} == "High" AND ${status} == "Critical"` means that the condition is met if any rule with a severity of High has a check result of Critical.'."\n" + .'- Specify multiple combinations of rule severity and rule check status. For example, `(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")` means that the condition is met if any rule with a severity of High has a check result of Critical, or any rule with a severity of Normal has a check result of Critical, or any rule with a severity of Normal has a check result of Error. The severity enumeration values in the conditional expression are consistent with the severity enumeration values in DataQualityRule, and the status enumeration values are consistent with the status values in DataQualityResult.', 'type' => 'string', 'example' => '(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'RuntimeConf' => ['description' => 'The extension configuration, a JSON-formatted character string. This parameter takes effect only for EMR-type data quality monitoring tasks.'."\n" + ."\n" + .'- queue: The YARN queue used to execute EMR data validation. The default value is the queue configured for the current project.'."\n" + .'- sqlEngine: The SQL engine used to execute EMR data validation. Valid values:'."\n" + .' - HIVE_SQL'."\n" + .' - SPARK_SQL.', 'type' => 'string', 'example' => '{ "queue": "default" }', 'title' => ''], + 'Trigger' => [ + 'description' => 'The trigger configuration of the data quality check task.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The trigger type of the quality monitoring task. Valid values:'."\n" + .'- ByManual: Manual trigger. This is the default value.'."\n" + .'- ByScheduledTaskInstance: Triggered by an associated scheduling node.', 'type' => 'string', 'example' => 'ByScheduledTaskInstance', 'title' => ''], + 'TaskIds' => [ + 'description' => 'The list of scheduling node IDs. This parameter is valid only when Type is set to ByScheduledTaskInstance.', + 'type' => 'array', + 'items' => ['description' => 'The scheduling node ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '70006236752324', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'Target' => [ + 'description' => 'The monitored object of the data quality check task. Refer to the DataQualityTarget example.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The monitored object type. Valid values:'."\n" + .'- Table: table.', 'type' => 'string', 'example' => 'Table', 'title' => ''], + 'DatabaseType' => ['description' => 'The type of the database to which the table belongs.', 'type' => 'string', 'example' => 'maxcompute', 'title' => ''], + 'TableGuid' => ['description' => 'The unique ID of the table in DataWorks Data Map.', 'type' => 'string', 'example' => 'odps.api_trace.ods_d_api_log', 'title' => ''], + 'PartitionSpec' => ['description' => 'The partition range to monitor.', 'type' => 'string', 'example' => 'pt=$[yyyymmdd-1]', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Description' => ['description' => 'The description of the data quality monitoring task.', 'type' => 'string', 'example' => 'OpenAPI quality monitoring test', 'title' => ''], + 'Id' => ['description' => 'The ID of the data quality monitoring task.', 'type' => 'integer', 'format' => 'int64', 'example' => '28544990', 'title' => ''], + 'ProjectId' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '20629', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Parameters' => ['description' => 'The execution parameters for the data quality check, in JSON format. The following keys are available:'."\n" + .'- triggerTime: the millisecond-level timestamp of the trigger time. This is the base time for the $[yyyymmdd] expression in the data range of the data quality monitoring task. This key is required.', 'type' => 'string', 'example' => '{ "triggerTime": 1733284062000 }'."\n", 'title' => ''], + 'FinishTime' => ['description' => 'The end time of the instance execution.', 'type' => 'integer', 'format' => 'int64', 'example' => '1716344665000', 'title' => ''], + 'TriggerContext' => ['description' => 'The context information when the instance is triggered, in JSON format. The following keys may be included:'."\n" + .'- TriggerClient: the trigger source of the data quality monitoring instance, such as CWF2 (scheduling system). More values may be added in the future.'."\n" + .'- TriggerClientId: the ID of a specific business resource in the source system. For example, when TriggerClient is CWF2, this field records the scheduling task ID.', 'type' => 'string', 'example' => '{ "triggerClient": "CWF2", "triggerClientId": 70001238945 }', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1716344665000', 'title' => ''], + 'Id' => ['description' => 'The data quality monitoring instance ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '7234231689', 'title' => ''], + 'ProjectId' => ['description' => 'The workspace ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '98330', 'title' => ''], + 'Results' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'Status' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'CreateTime' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'TaskInstanceId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'Sample' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Details' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ReferencedValue' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'CheckedValue' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Status' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'Rule' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'Name' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ProjectId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + 'Enabled' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + 'Severity' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Description' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'TemplateCode' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Target' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'DatabaseType' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'TableGuid' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'SamplingConfig' => [ + 'type' => 'object', + 'properties' => [ + 'Metric' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'MetricParameters' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'SettingConfig' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'SamplingFilter' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'CheckingConfig' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ReferencedSamplesFilter' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Thresholds' => [ + 'type' => 'object', + 'properties' => [ + 'Expected' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Operator' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Expression' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'Warned' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Operator' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Expression' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'Critical' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Operator' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Expression' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'ErrorHandlers' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'ErrorDataFilter' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B17730C0-D959-548A-AE23-E754177CXXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'DeleteWorkflowDefinition', - 'description' => '> A workflow that is deployed cannot be deleted. If you want to delete such a workflow, you must first undeploy the workflow.'."\n", - ], - 'UpdateWorkflowDefinition' => [ - 'summary' => 'Updates the basic information about a workflow in DataStudio. This API operation performs an incremental update. The update information is described by using FlowSpec.', - 'methods' => [ - 'post', + 'substitutions' => ['dataworks-public::2024-05-18::GetDataQualityScanRun'], ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], + 'title' => 'Retrieve data quality check task instance details.', + 'summary' => 'Retrieves the details of a data quality check task instance.', + 'description' => 'DataWorks Basic Edition or a higher edition is required to use this operation.', + 'changeSet' => [ + ['createdAt' => '2025-03-31T05:58:07.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-12-23T06:29:09.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-12-19T09:25:09.000Z', 'description' => 'Request parameters changed'], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '234976', - 'abilityTreeNodes' => [ - 'FEATUREdideHO4TQP', - 'FEATUREdide8FM783', - 'FEATUREdideQUQUVB', - 'FEATUREdideIQU97M', - ], + 'flowControl' => [ + 'flowControlList' => [], ], - '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 query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10001', - ], - ], - [ - 'name' => 'Id', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The unique identifier of the Data Studio workflow.'."\n" - ."\n" - .'> This field is of the Long type in SDK versions prior to 8.0.0, and of the String type in SDK versions 8.0.0 and later. This change does not affect normal SDK usage; the parameter will still be returned according to the type defined in the SDK. However, compilation failures may occur due to the type change only when upgrading the SDK across version 8.0.0. In this case, you must manually update the data type.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '652567824470354XXXX', - ], - ], + 'ramActions' => [ [ - 'name' => 'Spec', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The unique identifier of the Data Studio workflow.'."\n" - ."\n" - .'> Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. However, compilation failures may occur due to the type change only when upgrading the SDK across version 8.0.0. In this case, you must manually update the data type.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '{'."\n" - .' "kind": "CycleWorkflow",'."\n" - .' "version": "1.1.0",'."\n" - .' "spec": {'."\n" - .' "name": "OpenAPI Test Workflow Demo",'."\n" - .' "type": "CycleWorkflow",'."\n" - .' "id": "652567824470354XXXX",'."\n" - .' "workflows": ['."\n" - .' {'."\n" - .' "id": "652567824470354XXXX",'."\n" - .' "script": {'."\n" - .' "path": "XX/OpenAPI_Test/Workflow_Test/OpenAPI_Test_Workflow_Demo",'."\n" - .' "runtime": {'."\n" - .' "command": "WORKFLOW"'."\n" - .' }'."\n" - .' },'."\n" - .' "trigger": {'."\n" - .' "type": "Scheduler",'."\n" - .' "cron": "00 02 00 * * ?",'."\n" - .' "startTime": "1970-01-01 00:00:00",'."\n" - .' "endTime": "9999-01-01 00:00:00",'."\n" - .' "timezone": "Asia/Shanghai",'."\n" - .' "delaySeconds": 0'."\n" - .' },'."\n" - .' "strategy": {'."\n" - .' "timeout": 0,'."\n" - .' "instanceMode": "T+1",'."\n" - .' "rerunMode": "Allowed",'."\n" - .' "rerunTimes": 3,'."\n" - .' "rerunInterval": 180000,'."\n" - .' "failureStrategy": "Break"'."\n" - .' },'."\n" - .' "name": "OpenAPI Test Workflow Demo",'."\n" - .' "inputs": {},'."\n" - .' "outputs": {'."\n" - .' "nodeOutputs": ['."\n" - .' {'."\n" - .' "data": "workflow_output",'."\n" - .' "artifactType": "NodeOutput",'."\n" - .' "refTableName": "OpenAPI_Test_Workflow_Demo"'."\n" - .' }'."\n" - .' ]'."\n" - .' },'."\n" - .' "nodes": [],'."\n" - .' "dependencies": []'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .'}', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => '20BF7E80-668A-5620-8AD8-879B8FEAXXXX', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20BF7E80-668A-5620-8AD8-879B8FEA****\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'UpdateWorkflowDefinition', - 'description' => '> You cannot use this API operation to create multiple workflows at a time. If you specify multiple workflows in the FlowSpec filed, only the first workflow is created. Other specified workflows and the nodes in the workflows are ignored. You can call the UpdateNode operation to update a node.'."\n", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8abcb91f-d266-4073-b907-2ed67****\\",\\n \\"DataQualityEvaluationTaskInstance\\": {\\n \\"Status\\": \\"Passed\\",\\n \\"Task\\": {\\n \\"Name\\": \\"Data quality OpenAPI monitoring test\\\\n\\",\\n \\"Notifications\\": {\\n \\"Condition\\": \\"${severity} == \\\\\\"High\\\\\\" AND ${status} == \\\\\\"Critical\\\\\\"\\",\\n \\"Notifications\\": [\\n {\\n \\"NotificationReceivers\\": [\\n {\\n \\"ReceiverType\\": \\"DingdingUrl\\",\\n \\"Extension\\": \\"{ \\\\\\"atAll\\\\\\": true }\\",\\n \\"ReceiverValues\\": [\\n \\"https://api.fc.aliyuncs.com/webhook\\"\\n ]\\n }\\n ],\\n \\"NotificationChannels\\": [\\n {\\n \\"Channels\\": [\\n \\"Mail\\"\\n ]\\n }\\n ]\\n }\\n ]\\n },\\n \\"Hooks\\": [\\n {\\n \\"Type\\": \\"BlockTaskInstance\\",\\n \\"Condition\\": \\"(${severity} == \\\\\\"High\\\\\\" AND ${status} == \\\\\\"Critical\\\\\\") OR (${severity} == \\\\\\"Normal\\\\\\" AND ${status} == \\\\\\"Critical\\\\\\") OR (${severity} == \\\\\\"Normal\\\\\\" AND ${status} == \\\\\\"Error\\\\\\")\\"\\n }\\n ],\\n \\"RuntimeConf\\": \\"{ \\\\\\"queue\\\\\\": \\\\\\"default\\\\\\" }\\",\\n \\"Trigger\\": {\\n \\"Type\\": \\"ByScheduledTaskInstance\\",\\n \\"TaskIds\\": [\\n 70006236752324\\n ]\\n },\\n \\"Target\\": {\\n \\"Type\\": \\"Table\\",\\n \\"DatabaseType\\": \\"maxcompute\\",\\n \\"TableGuid\\": \\"odps.api_trace.ods_d_api_log\\",\\n \\"PartitionSpec\\": \\"pt=$[yyyymmdd-1]\\"\\n },\\n \\"Description\\": \\"OpenAPI quality monitoring test\\",\\n \\"Id\\": 28544990,\\n \\"ProjectId\\": 20629\\n },\\n \\"Parameters\\": \\"{ \\\\\\"triggerTime\\\\\\": 1733284062000 }\\\\n\\",\\n \\"FinishTime\\": 1716344665000,\\n \\"TriggerContext\\": \\"{ \\\\\\"triggerClient\\\\\\": \\\\\\"CWF2\\\\\\", \\\\\\"triggerClientId\\\\\\": 70001238945 }\\",\\n \\"CreateTime\\": 1716344665000,\\n \\"Id\\": 7234231689,\\n \\"ProjectId\\": 98330,\\n \\"Results\\": [\\n {\\n \\"Id\\": 0,\\n \\"Status\\": \\"\\",\\n \\"CreateTime\\": 0,\\n \\"TaskInstanceId\\": 0,\\n \\"Sample\\": \\"\\",\\n \\"Details\\": [\\n {\\n \\"ReferencedValue\\": \\"\\",\\n \\"CheckedValue\\": \\"\\",\\n \\"Status\\": \\"\\"\\n }\\n ],\\n \\"Rule\\": {\\n \\"Id\\": 0,\\n \\"Name\\": \\"\\",\\n \\"ProjectId\\": 0,\\n \\"Enabled\\": false,\\n \\"Severity\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"TemplateCode\\": \\"\\",\\n \\"Target\\": {\\n \\"Type\\": \\"\\",\\n \\"DatabaseType\\": \\"\\",\\n \\"TableGuid\\": \\"\\"\\n },\\n \\"SamplingConfig\\": {\\n \\"Metric\\": \\"\\",\\n \\"MetricParameters\\": \\"\\",\\n \\"SettingConfig\\": \\"\\",\\n \\"SamplingFilter\\": \\"\\"\\n },\\n \\"CheckingConfig\\": {\\n \\"Type\\": \\"\\",\\n \\"ReferencedSamplesFilter\\": \\"\\",\\n \\"Thresholds\\": {\\n \\"Expected\\": {\\n \\"Value\\": \\"\\",\\n \\"Operator\\": \\"\\",\\n \\"Expression\\": \\"\\"\\n },\\n \\"Warned\\": {\\n \\"Value\\": \\"\\",\\n \\"Operator\\": \\"\\",\\n \\"Expression\\": \\"\\"\\n },\\n \\"Critical\\": {\\n \\"Value\\": \\"\\",\\n \\"Operator\\": \\"\\",\\n \\"Expression\\": \\"\\"\\n }\\n }\\n },\\n \\"ErrorHandlers\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"ErrorDataFilter\\": \\"\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', ], - 'MoveWorkflowDefinition' => [ - 'summary' => 'Moves a workflow to a path in DataStudio.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetDataQualityRule' => [ + 'summary' => 'Queries the details of a data quality rule.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, + 'operationType' => 'read', + 'deprecated' => true, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '235450', - 'abilityTreeNodes' => [ - 'FEATUREdideHO4TQP', - 'FEATUREdide8FM783', - 'FEATUREdideQUQUVB', - 'FEATUREdideIQU97M', - ], + 'abilityTreeCode' => '247799', + 'abilityTreeNodes' => ['FEATUREdide3WJOKE'], ], '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 ID. This parameter indicates the DataWorks workspace to which the API operation is applied.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10001', - ], - ], [ 'name' => 'Id', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The unique identifier of the Data Studio workflow.'."\n" - ."\n" - .'> This field is of the Long type in SDK versions prior to 8.0.0, and of the String type in SDK versions 8.0.0 and later. This change does not affect normal SDK usage; the parameter will still be returned according to the type defined in the SDK. However, compilation failures may occur due to the type change only when upgrading the SDK across version 8.0.0. In this case, you must manually update the data type.', - 'type' => 'string', - 'required' => true, - 'example' => '543217824470354XXXX', - ], - ], - [ - 'name' => 'Path', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The unique identifier of the workflow.'."\n" - ."\n" - .'> Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'root/demo', - ], + 'in' => 'query', + 'schema' => ['description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '19715', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '05ADAF4F-7709-5FB1-B606-3513483FXXXX', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '691CA452-D37A-4ED0-****'], + 'DataQualityRule' => [ + 'description' => 'The details of the rule.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '16033', 'title' => ''], + 'Name' => ['description' => 'The name of the rule.', 'type' => 'string', 'example' => 'The table cannot be empty.'."\n", 'title' => ''], + 'ProjectId' => ['description' => 'The DataWorks workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1948', 'title' => ''], + 'Enabled' => ['description' => 'Specifies whether the rule is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Severity' => ['description' => 'The severity of the rule for the business (corresponds to strong/weak rules on the page). Valid values:'."\n" + .'- Normal'."\n" + .'- High', 'type' => 'string', 'example' => 'High', 'title' => ''], + 'Description' => ['description' => 'The description of the rule. The maximum length is 500 characters.', 'type' => 'string', 'example' => 'this is a odps _sql task'."\n", 'title' => ''], + 'Target' => [ + 'description' => 'The object monitored by the rule.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The type of the monitored object.'."\n" + ."\n" + .'- Table', 'type' => 'string', 'example' => 'Table', 'title' => ''], + 'DatabaseType' => ['description' => 'For a Table-type dataset, the type of database to which the table belongs.'."\n" + .'- maxcompute'."\n" + .'- emr'."\n" + .'- cdh'."\n" + .'- hologres'."\n" + .'- analyticdb_for_postgresql'."\n" + .'- analyticdb_for_mysql'."\n" + .'- starrocks', 'type' => 'string', 'example' => 'maxcompute', 'title' => ''], + 'TableGuid' => ['description' => 'The unique ID of the table on which the rule takes effect in Data Map.', 'type' => 'string', 'example' => 'odps.unit_test.tb_unit_test'."\n", 'title' => ''], + 'PartitionSpec' => ['description' => 'The partition settings of the partitioned table.', 'type' => 'string', 'example' => 'ds=$[yyyymmdd-1]'."\n", 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'TemplateCode' => ['description' => 'The unique identifier of the rule template referenced by the rule.', 'type' => 'string', 'example' => 'SYSTEM:table:table_count:fixed', 'title' => ''], + 'SamplingConfig' => [ + 'description' => 'The settings required for sample collection.', + 'type' => 'object', + 'properties' => [ + 'Metric' => ['description' => 'The name of the sampling metric:'."\n" + .'- Count: the number of table rows'."\n" + .'- Min: the minimum value of the field'."\n" + .'- Max: the maximum value of the field'."\n" + .'- Avg: the average value of the field'."\n" + .'- DistinctCount: the number of distinct values of the field'."\n" + .'- DistinctPercent: the ratio of the number of distinct values of the field to the number of data rows'."\n" + .'- DuplicatedCount: the number of duplicate values of the field'."\n" + .'- DuplicatedPercent: the ratio of the number of duplicate values of the field to the number of data rows'."\n" + .'- TableSize: the size of the table'."\n" + .'- NullValueCount: the number of rows in which the field is null'."\n" + .'- NullValuePercent: the proportion of rows in which the field is null'."\n" + .'- GroupCount: the number of data rows corresponding to each value after aggregation by field value'."\n" + .'- CountNotIn: the number of rows in which the enum value does not match'."\n" + .'- CountDistinctNotIn: the number of distinct values in which the enum value does not match'."\n" + .'- UserDefinedSql: performs sample collection by using a custom SQL statement', 'type' => 'string', 'example' => 'Max', 'title' => ''], + 'MetricParameters' => ['description' => 'The parameters required for sample collection.', 'type' => 'string', 'example' => '{ "Columns": [ "id", "name" ] , "SQL": "select count(1) from table;"}', 'title' => ''], + 'SettingConfig' => ['description' => 'The runtime parameter setting statements that are inserted and executed before the specific sampling statement is executed. The maximum length is 1,000 characters. Currently, only MaxCompute is supported.', 'type' => 'string', 'example' => 'SET odps.sql.udf.timeout=600s; '."\n" + .'SET odps.sql.python.version=cp27;'."\n", 'title' => ''], + 'SamplingFilter' => ['description' => 'The condition used to perform secondary filtering on data that you do not focus on during sampling. The maximum length is 16,777,215 characters.', 'type' => 'string', 'example' => 'id IS NULL'."\n", 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'CheckingConfig' => [ + 'description' => 'The sample check settings.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The threshold calculation method:'."\n" + .'- Fixed'."\n" + .'- Fluctation'."\n" + .'- FluctationDiscreate'."\n" + .'- Auto'."\n" + .'- Average'."\n" + .'- Variance', 'type' => 'string', 'example' => 'Fixed', 'title' => ''], + 'ReferencedSamplesFilter' => ['description' => 'Some types of thresholds require querying reference samples and then aggregating the values of the reference samples to derive the threshold used for comparison. An expression is used here to indicate the way in which the reference samples are queried.', 'type' => 'string', 'example' => '{ "bizdate": [ "-1", "-7", "-1m" ] }'."\n", 'title' => ''], + 'Thresholds' => [ + 'description' => 'The threshold settings.', + 'type' => 'object', + 'properties' => [ + 'Expected' => [ + 'description' => 'The expected threshold settings.', + 'type' => 'object', + 'properties' => [ + 'Operator' => ['description' => 'The comparison operator:'."\n" + .'- \\>'."\n" + .'- \\>='."\n" + .'- <'."\n" + .'- <='."\n" + .'- !='."\n" + .'- =', 'type' => 'string', 'example' => '>', 'title' => ''], + 'Value' => ['description' => 'The threshold value.', 'type' => 'string', 'example' => '100.0', 'title' => ''], + 'Expression' => ['description' => 'The threshold expression.', 'type' => 'string', 'example' => '$checkValue <= 0.01', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Warned' => [ + 'description' => 'The threshold settings for normal warnings.', + 'type' => 'object', + 'properties' => [ + 'Operator' => ['description' => 'The comparison operator:'."\n" + .'- \\>'."\n" + .'- \\>='."\n" + .'- <'."\n" + .'- <='."\n" + .'- !='."\n" + .'- =', 'type' => 'string', 'example' => '>', 'title' => ''], + 'Value' => ['description' => 'The threshold value.', 'type' => 'string', 'example' => '100.0', 'title' => ''], + 'Expression' => ['description' => 'The threshold expression.', 'type' => 'string', 'example' => '$checkValue > 0.01', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Critical' => [ + 'description' => 'The threshold settings for critical warnings.', + 'type' => 'object', + 'properties' => [ + 'Operator' => ['description' => 'The comparison operator:'."\n" + .'- \\>'."\n" + .'- \\>='."\n" + .'- <'."\n" + .'- <='."\n" + .'- !='."\n" + .'- =', 'type' => 'string', 'example' => '>', 'title' => ''], + 'Value' => ['description' => 'The threshold value.', 'type' => 'string', 'example' => '100.0', 'title' => ''], + 'Expression' => ['description' => 'The threshold expression.', 'type' => 'string', 'example' => '$checkValue > 0.05', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'ErrorHandlers' => [ + 'description' => 'The list of issue handlers for quality rule checks.', + 'type' => 'array', + 'items' => [ + 'description' => 'The issue handler for quality rule checks.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The handler type:'."\n" + .'- SaveErrorData', 'type' => 'string', 'example' => 'SaveErrorData'."\n", 'title' => ''], + 'ErrorDataFilter' => ['description' => 'If the rule is a custom SQL rule, you must specify an SQL statement to filter the problem data.', 'type' => 'string', 'example' => 'SELECT * FROM tb_api_log WHERE id IS NULL'."\n", 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"05ADAF4F-7709-5FB1-B606-3513483FXXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'MoveWorkflowDefinition', - ], - 'RenameWorkflowDefinition' => [ - 'summary' => 'Renames a workflow in DataStudio.', - 'methods' => [ - 'post', + 'substitutions' => ['dataworks-public::2024-05-18::GetDataQualityScan'], ], - 'schemes' => [ - 'https', + 'title' => 'Queries the details of a data quality rule', + 'description' => 'You must purchase DataWorks Basic Edition or above to use this feature.', + 'extraInfo' => 'List of rule template codes:'."\n" + .'- Custom SQL: SYSTEM:user_defined_sql'."\n" + ."\n" + .'- Table row count greater than 0: SYSTEM:table:table_count:fixed:0'."\n" + .'- Table row count, fixed value: SYSTEM:table:table_count:fixed'."\n" + .'- Table row count, 1-day difference: SYSTEM:table:table_count_delta:fixed:1_bizdate'."\n" + .'- Table row count, previous-cycle difference: SYSTEM:table:table_count_delta:fixed:latest_bizdate'."\n" + .'- Table row count, previous-cycle fluctuation rate: SYSTEM:table:table_count:cycle:latest_bizdate'."\n" + .'- Table row count, 7-day average fluctuation rate: SYSTEM:table:table_count:avg:7_bizdate'."\n" + .'- Table row count, 30-day average fluctuation rate: SYSTEM:table:table_count:avg:1m_bizdate'."\n" + .'- Table row count, 1-day fluctuation rate: SYSTEM:table:table_count:flux:1_bizdate'."\n" + .'- Table row count, 7-day fluctuation rate: SYSTEM:table:table_count:flux:7_bizdate'."\n" + .'- Table row count, 30-day fluctuation rate: SYSTEM:table:table_count:flux:1m_bizdate'."\n" + .'- Table row count, 1-, 7-, and 30-day fluctuation rates: SYSTEM:table:table_count:flux:1_7_1m_bizdate'."\n" + .'- Table row count, 1-, 7-, and 30-day, and 1st of current month fluctuation rates: SYSTEM:table:table_count:flux:1_7_1m_1st_bizdate'."\n" + .'- Table row count, custom range: SYSTEM:table:count'."\n" + .'- Condition-match ratio, custom range: SYSTEM:table:count_percent'."\n" + ."\n" + .'- Average value, 1-day fluctuation rate: SYSTEM:field:avg:cycle:1_bizdate'."\n" + .'- Average value, 1-, 7-, and 30-day fluctuation rates: SYSTEM:field:avg:flux:1_7_1m_bizdate'."\n" + .'- Average value, custom range: SYSTEM:field:avg'."\n" + ."\n" + .'- Sum value, 1-day fluctuation rate: SYSTEM:field:sum:cycle:1_bizdate'."\n" + .'- Sum value, previous-cycle fluctuation rate: SYSTEM:field:sum:cycle:latest_bizdate'."\n" + .'- Sum value, 1-, 7-, and 30-day fluctuation rates: SYSTEM:field:sum:flux:1_7_1m_bizdate'."\n" + .'- Sum value, custom range: SYSTEM:field:sum'."\n" + ."\n" + .'- Minimum value, 1-day fluctuation rate: SYSTEM:field:min:cycle:1_bizdate'."\n" + .'- Minimum value, previous-cycle fluctuation rate: SYSTEM:field:min:cycle:latest_bizdate'."\n" + .'- Minimum value, 1-, 7-, and 30-day fluctuation rates: SYSTEM:field:min:flux:1_7_1m_bizdate'."\n" + .'- Minimum value, custom range: SYSTEM:field:min'."\n" + ."\n" + .'- Maximum value, 1-day fluctuation rate: SYSTEM:field:max:cycle:1_bizdate'."\n" + .'- Maximum value, previous-cycle fluctuation rate: SYSTEM:field:max:cycle:latest_bizdate'."\n" + .'- Maximum value, 1-, 7-, and 30-day fluctuation rates: SYSTEM:field:max:flux:1_7_1m_bizdate'."\n" + .'- Maximum value, custom range: SYSTEM:field:max'."\n" + ."\n" + .'- Null value record count is 0: SYSTEM:field:null_value:fixed:0'."\n" + .'- Null value count, fixed value: SYSTEM:field:null_value:fixed'."\n" + .'- Null value count/total row count, fixed value: SYSTEM:field:null_value_percent:fixed'."\n" + ."\n" + .'- Field duplicate value count is 0: SYSTEM:field:duplicated_count:fixed:0'."\n" + .'- Duplicate value count/total row count, fixed value: SYSTEM:field:duplicated_percent:fixed'."\n" + .'- Duplicate value count, fixed value: YSTEM:field:duplicated_count:fixed'."\n" + .'- Multi-field duplicate value count is 0: SYSTEM:fields:duplicated_count:fixed:0'."\n" + ."\n" + .'- Discrete value (state value), fixed value: SYSTEM:field:all_discrete_count:fixed'."\n" + .'- Discrete value (group count and state value), 1-, 7-, and 30-day fluctuation rates: SYSTEM:field:all_discrete_metrics:fluxdiscrete:1_7_1m_bizdate'."\n" + .'- Discrete value (group count), fixed value: SYSTEM:field:discrete_group_count:fixed'."\n" + .'- Discrete value (group count), 1-day fluctuation rate: SYSTEM:field:discrete_group_count:cycle:latest_bizdate'."\n" + ."\n" + .'- Table size, fixed value: SYSTEM:table:table_size:fixed'."\n" + .'- Table size, previous-cycle difference: SYSTEM:table:table_size_delta:fixed:latest_bizdate'."\n" + .'- Table size, difference from 1 day ago (bytes): SYSTEM:table:table_size_delta:fixed:1_bizdate'."\n" + .'- Table size, 1-day fluctuation rate: SYSTEM:table:table_size:flux:1_bizdate'."\n" + .'- Table size, 7-day fluctuation rate: SYSTEM:table:table_size:flux:7_bizdate'."\n" + .'- Table size, 30-day fluctuation rate: SYSTEM:table:table_size:flux:1m_bizdate'."\n" + ."\n" + .'- Distinct value count, fixed value: SYSTEM:field:count_distinct:fixed'."\n" + .'- Distinct value count, 1-, 7-, and 30-day fluctuation rates: SYSTEM:field:count_distinct:flux:1_7_1m_bizdate'."\n" + .'- Distinct value count/total row count, fixed value: SYSTEM:field:count_distinct_percent:fixed'."\n" + ."\n" + .'- Table row count, dynamic threshold: SYSTEM:table:table_count:dynamic_threshold'."\n" + .'- Sum value, dynamic threshold: SYSTEM:field:sum:dynamic_threshold'."\n" + .'- Average value, dynamic threshold: SYSTEM:field:avg:dynamic_threshold'."\n" + .'- Maximum value, dynamic threshold: SYSTEM:field:max:dynamic_threshold'."\n" + .'- Minimum value, dynamic threshold: SYSTEM:field:min:dynamic_threshold'."\n" + .'- Distinct value ratio, dynamic threshold: SYSTEM:table:table_size:dynamic_threshold'."\n" + .'- Distinct value count, dynamic threshold: SYSTEM:table:distinct_count:dynamic_threshold'."\n" + .'- Discrete value (group count), dynamic threshold: SYSTEM:field:avg:dynamic_threshold'."\n" + .'- Discrete value (state value), dynamic threshold: SYSTEM:field:sum:dynamic_threshold'."\n" + .'- Discrete value (group count), dynamic threshold: SYSTEM:field:discrete_group_count:dynamic_threshold'."\n" + .'- Discrete value (state value), dynamic threshold: SYSTEM:field:discrete_value_count:dynamic_threshold', + 'changeSet' => [ + ['createdAt' => '2024-12-23T06:29:09.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-12-19T09:25:09.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-12-19T08:30:40.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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-4ED0-****\\",\\n \\"DataQualityRule\\": {\\n \\"Id\\": 16033,\\n \\"Name\\": \\"The table cannot be empty.\\\\n\\",\\n \\"ProjectId\\": 1948,\\n \\"Enabled\\": true,\\n \\"Severity\\": \\"High\\",\\n \\"Description\\": \\"this is a odps _sql task\\\\n\\",\\n \\"Target\\": {\\n \\"Type\\": \\"Table\\",\\n \\"DatabaseType\\": \\"maxcompute\\",\\n \\"TableGuid\\": \\"odps.unit_test.tb_unit_test\\\\n\\",\\n \\"PartitionSpec\\": \\"ds=$[yyyymmdd-1]\\\\n\\"\\n },\\n \\"TemplateCode\\": \\"SYSTEM:table:table_count:fixed\\",\\n \\"SamplingConfig\\": {\\n \\"Metric\\": \\"Max\\",\\n \\"MetricParameters\\": \\"{ \\\\\\"Columns\\\\\\": [ \\\\\\"id\\\\\\", \\\\\\"name\\\\\\" ] , \\\\\\"SQL\\\\\\": \\\\\\"select count(1) from table;\\\\\\"}\\",\\n \\"SettingConfig\\": \\"SET odps.sql.udf.timeout=600s; \\\\nSET odps.sql.python.version=cp27;\\\\n\\",\\n \\"SamplingFilter\\": \\"id IS NULL\\\\n\\"\\n },\\n \\"CheckingConfig\\": {\\n \\"Type\\": \\"Fixed\\",\\n \\"ReferencedSamplesFilter\\": \\"{ \\\\\\"bizdate\\\\\\": [ \\\\\\"-1\\\\\\", \\\\\\"-7\\\\\\", \\\\\\"-1m\\\\\\" ] }\\\\n\\",\\n \\"Thresholds\\": {\\n \\"Expected\\": {\\n \\"Operator\\": \\">\\",\\n \\"Value\\": \\"100.0\\",\\n \\"Expression\\": \\"$checkValue <= 0.01\\"\\n },\\n \\"Warned\\": {\\n \\"Operator\\": \\">\\",\\n \\"Value\\": \\"100.0\\",\\n \\"Expression\\": \\"$checkValue > 0.01\\"\\n },\\n \\"Critical\\": {\\n \\"Operator\\": \\">\\",\\n \\"Value\\": \\"100.0\\",\\n \\"Expression\\": \\"$checkValue > 0.05\\"\\n }\\n }\\n },\\n \\"ErrorHandlers\\": [\\n {\\n \\"Type\\": \\"SaveErrorData\\\\n\\",\\n \\"ErrorDataFilter\\": \\"SELECT * FROM tb_api_log WHERE id IS NULL\\\\n\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'GetDataQualityRuleTemplate' => [ + 'summary' => 'Queries the details of a data quality rule template.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, + 'operationType' => 'read', + 'deprecated' => true, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '235462', - 'abilityTreeNodes' => [ - 'FEATUREdideHO4TQP', - 'FEATUREdideQUQUVB', - 'FEATUREdideLJFKLG', - 'FEATUREdideIQU97M', - ], + 'abilityTreeCode' => '247999', + 'abilityTreeNodes' => ['FEATUREdideRGVRPF'], ], '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. You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10000', - ], - ], - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => 'The unique identifier of the Data Studio workflow.'."\n" - ."\n" - .'> This field is of the Long type in SDK versions prior to 8.0.0, and of the String type in SDK versions 8.0.0 and later. This change does not affect normal SDK usage; the parameter will still be returned according to the type defined in the SDK. However, compilation failures may occur due to the type change only when upgrading the SDK across version 8.0.0. In this case, you must manually update the data type.', - 'type' => 'string', - 'required' => true, - 'example' => '463497880880954XXXX', - ], - ], - [ - 'name' => 'Name', + 'name' => 'Code', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique identifier of the workflow.'."\n" - ."\n" - .'> Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Rename', - ], + 'schema' => ['description' => 'The code of the rule template.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'USER_DEFINED:123', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID. You can troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => '975BD43D-C421-595C-A29C-565A8AD5XXXX', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '691CA452-D37A-4E****'], + 'DataQualityRuleTemplate' => [ + 'description' => 'The details of the rule template.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The code of the rule template.', 'type' => 'string', 'example' => 'USER_DEFINED:123', 'title' => ''], + 'Name' => ['description' => 'The name of the rule template. The name can be a combination of digits, letters, Chinese characters, and half-width or full-width punctuation marks. The name can be a maximum of 512 characters in length.', 'type' => 'string', 'example' => 'Table row Count Verification', 'title' => ''], + 'ProjectId' => ['description' => 'The ID of the DataWorks workspace.', 'type' => 'integer', 'format' => 'int64', 'example' => '4020', 'title' => ''], + 'SamplingConfig' => [ + 'description' => 'The settings required for sample collection.', + 'type' => 'object', + 'properties' => [ + 'Metric' => ['description' => 'The name of the metric to be sampled:'."\n" + .'- Count: the number of rows in the table.'."\n" + .'- Min: the minimum value of the field.'."\n" + .'- Max: the maximum value of the field.'."\n" + .'- Avg: the average value of the field.'."\n" + .'- DistinctCount: the number of distinct values of the field.'."\n" + .'- DistinctPercent: the ratio of the number of distinct values of the field to the number of data rows.'."\n" + .'- DuplicatedCount: the number of duplicate values of the field.'."\n" + .'- DuplicatedPercent: the ratio of the number of duplicate values of the field to the number of data rows.'."\n" + .'- TableSize: the size of the table.'."\n" + .'- NullValueCount: the number of rows in which the field is null.'."\n" + .'- NullValuePercent: the percentage of rows in which the field is null.'."\n" + .'- GroupCount: the number of data rows corresponding to each value after aggregation by field value.'."\n" + .'- CountNotIn: the number of rows whose enumerated values do not match.'."\n" + .'- CountDistinctNotIn: the number of distinct values whose enumerated values do not match.'."\n" + .'- UserDefinedSql: collects samples by using a custom SQL statement.', 'type' => 'string', 'example' => 'Max', 'title' => ''], + 'MetricParameters' => ['description' => 'The parameters required for sample collection.', 'type' => 'string', 'example' => '{"SQL": "select count(1) from table;"}', 'title' => ''], + 'SettingConfig' => ['description' => 'The runtime parameter setting statements that are inserted and executed before the specific sampling statement is executed. The setting can be a maximum of 1,000 characters in length. Only MaxCompute is supported.', 'type' => 'string', 'example' => 'SET odps.sql.udf.timeout=600s; '."\n" + .'SET odps.sql.python.version=cp27;'."\n", 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'CheckingConfig' => [ + 'description' => 'The sample verification settings.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The threshold calculation method:'."\n" + .'- Fixed'."\n" + .'- Fluctation'."\n" + .'- FluctationDiscreate'."\n" + .'- Auto'."\n" + .'- Average'."\n" + .'- Variance', 'type' => 'string', 'example' => 'Fixed', 'title' => ''], + 'ReferencedSamplesFilter' => ['description' => 'Some types of thresholds require you to query reference samples and aggregate the values of the reference samples to obtain the threshold for comparison. An expression is used to indicate the query method of reference samples.', 'type' => 'string', 'example' => '{ "bizdate": [ "-1", "-7", "-1m" ] }'."\n", 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'VisibleScope' => ['description' => 'The scope in which the template is available:'."\n" + .'- Tenant: available to the entire tenant.'."\n" + .'- Project: available only in the current project.', 'type' => 'string', 'example' => 'Project', 'title' => ''], + 'DirectoryPath' => ['description' => 'The category directory in which the custom template is stored. Levels are separated by forward slashes (/). Each level name can be a maximum of 1,024 characters in length and cannot contain whitespace characters or forward slashes (/).', 'type' => 'string', 'example' => '/ods/order_data', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'staticInfo' => [ + 'substitutions' => ['dataworks-public::2024-05-18::GetDataQualityTemplate'], 'returnType' => 'synchronous', ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"975BD43D-C421-595C-A29C-565A8AD5XXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'RenameWorkflowDefinition', - ], - 'GetWorkflowDefinition' => [ - 'summary' => 'Queries the information about a workflow.', - 'methods' => [ - 'get', + 'title' => 'Queries the details of a data quality rule template', + 'description' => 'You can call this operation only if you have purchased DataWorks Basic Edition or a more advanced edition.', + 'changeSet' => [ + ['createdAt' => '2024-12-23T06:29:09.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-12-19T09:25:09.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-12-19T08:30:40.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-4E****\\",\\n \\"DataQualityRuleTemplate\\": {\\n \\"Code\\": \\"USER_DEFINED:123\\",\\n \\"Name\\": \\"Table row Count Verification\\",\\n \\"ProjectId\\": 4020,\\n \\"SamplingConfig\\": {\\n \\"Metric\\": \\"Max\\",\\n \\"MetricParameters\\": \\"{\\\\\\"SQL\\\\\\": \\\\\\"select count(1) from table;\\\\\\"}\\",\\n \\"SettingConfig\\": \\"SET odps.sql.udf.timeout=600s; \\\\nSET odps.sql.python.version=cp27;\\\\n\\"\\n },\\n \\"CheckingConfig\\": {\\n \\"Type\\": \\"Fixed\\",\\n \\"ReferencedSamplesFilter\\": \\"{ \\\\\\"bizdate\\\\\\": [ \\\\\\"-1\\\\\\", \\\\\\"-7\\\\\\", \\\\\\"-1m\\\\\\" ] }\\\\n\\"\\n },\\n \\"VisibleScope\\": \\"Project\\",\\n \\"DirectoryPath\\": \\"/ods/order_data\\"\\n }\\n}","type":"json"}]', + ], + 'GetDataQualityScan' => [ + 'summary' => 'Gets data quality monitoring details.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -14986,1024 +18461,1039 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '234973', - 'abilityTreeNodes' => [ - 'FEATUREdideHO4TQP', - 'FEATUREdide8FM783', - 'FEATUREdideQUQUVB', - 'FEATUREdideIQU97M', - ], + 'abilityTreeNodes' => ['FEATUREdide3WJOKE'], ], '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' => false, - 'example' => '10000', - ], - ], [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the workflow.'."\n", - 'type' => 'string', - 'format' => 'int64', - 'required' => true, - 'example' => '860438872620113XXXX', - ], - ], - [ - 'name' => 'IncludeScriptContent', - 'in' => 'query', - 'schema' => [ - 'description' => '查询结果是否包含工作流内部节点的脚本内容（对于内容较多的节点，可能存在较长的网络传输延时）。', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The ID of the monitor.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10001', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'F2BDD628-8A21-5BD1-B930-1A2D5989XXXX', - ], - 'WorkflowDefinition' => [ - 'description' => 'The information about the workflow.'."\n", + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '204EAF68-CCE3-5112-8DA0-E7A60F02XXXX'], + 'DataQualityScan' => [ + 'description' => 'Data quality monitoring details.', 'type' => 'object', 'properties' => [ - 'ProjectId' => [ - 'description' => 'The ID of the workspace to which the workflow belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '307XXX', - ], - 'Name' => [ - 'description' => 'The name of the workflow.'."\n", - 'type' => 'string', - 'example' => 'OpenAPI test workflow Demo', + 'Id' => ['description' => 'The data quality monitoring ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10001', 'title' => ''], + 'Name' => ['description' => 'The data quality monitor name.', 'type' => 'string', 'example' => 'data_quality_scan_001', 'title' => ''], + 'Description' => ['description' => 'The data quality monitor description.', 'type' => 'string', 'example' => 'aily data quality scanning of ods tables.', 'title' => ''], + 'ProjectId' => ['description' => 'The workspace ID where the data quality monitor resides. You can obtain the workspace ID by calling the [ListProjects](~~2780068~~) operation.', 'type' => 'integer', 'format' => 'int64', 'example' => '101', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time of the data quality monitor.', 'type' => 'integer', 'format' => 'int64', 'example' => '1731550150000', 'title' => ''], + 'ModifyTime' => ['description' => 'Last modified time of the data quality monitor.', 'type' => 'integer', 'format' => 'int64', 'example' => '1731550150000', 'title' => ''], + 'CreateUser' => ['description' => 'The ID of the user who creates the data quality monitor.', 'type' => 'string', 'example' => '2374924198591250', 'title' => ''], + 'ModifyUser' => ['description' => 'The ID of the user who last modifies the data quality monitor.', 'type' => 'string', 'example' => '23482597582479', 'title' => ''], + 'Owner' => ['description' => 'The ID of the user who owns the data quality monitor.', 'type' => 'string', 'example' => '231263586109857423', 'title' => ''], + 'Spec' => ['description' => 'Spec code for the content of the data quality monitoring.', 'type' => 'string', 'example' => '{'."\n" + .' "datasets": ['."\n" + .' {'."\n" + .' "type": "Table",'."\n" + .' "dataSource": {'."\n" + .' "name": "odps_first",'."\n" + .' "envType": "Prod"'."\n" + .' },'."\n" + .' "tables": ['."\n" + .' "ods_d_user_info"'."\n" + .' ],'."\n" + .' "filter": "pt = $[yyyymmdd-1]"'."\n" + .' }'."\n" + .' ],'."\n" + .' "rules": ['."\n" + .' {'."\n" + .' "assertion": "row_count > 0"'."\n" + .' }, {'."\n" + .' "templateId": "SYSTEM:field:null_value:fixed",'."\n" + .' "pass": "when = 0",'."\n" + .' "name": "The id cannot be empty.",'."\n" + .' "severity": "High",'."\n" + .' "identity": "a-customized-data-quality-rule-uuid"'."\n" + .' }'."\n" + .' ]'."\n" + .'}', 'title' => ''], + 'Parameters' => [ + 'description' => 'The definition of execution parameters for the data quality monitor.', + 'type' => 'array', + 'items' => [ + 'description' => 'The parameter information.', + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => 'The parameter name.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'Name' => ['description' => 'The parameter value.', 'type' => 'string', 'example' => 'e2e_autolabel', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'Owner' => [ - 'description' => 'The owner of the workflow.'."\n", - 'type' => 'string', - 'example' => '110755000425XXXX', + 'ComputeResource' => [ + 'description' => 'The compute engine used at runtime. Optional. If not specified, the data source defined in the Spec is used.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the compute engine, which is a unique identifier.', 'type' => 'string', 'example' => 'polardb_to_holo', 'title' => ''], + 'Runtime' => [ + 'description' => 'More settings for data quality monitor at runtime.', + 'type' => 'object', + 'properties' => [ + 'Engine' => [ + 'description' => 'The type of the compute engine. Only EMR compute engines support these settings.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- Hive: Hive SQL'."\n" + ."\n" + .'- Spark: Spark SQL'."\n" + ."\n" + .'- Kyuubi', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'Hive', + 'title' => '', + ], + 'HiveConf' => ['description' => 'Additional Hive engine parameters. Currently, only the mapreduce.job.queuename parameter is supported.', 'type' => 'object', 'example' => 'mapreduce.job.queuename=dq_queue', 'title' => ''], + 'SparkConf' => ['description' => 'Additional Spark engine parameters. Currently, only the spark.yarn.queue parameter is supported.', 'type' => 'object', 'example' => 'spark.yarn.queue=dq_queue'."\n", 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'EnvType' => [ + 'description' => 'The workspace environment to which the compute engine belongs.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- Prod: production environment .'."\n" + ."\n" + .'- Dev: development environment.', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'Prod', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', ], - 'CreateTime' => [ - 'description' => 'The time when the workflow was created. This value is a UNIX timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1708481905000', + 'RuntimeResource' => [ + 'description' => 'The resource group used during the running of the data quality monitor.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => '122878', 'title' => ''], + 'Cu' => ['description' => 'Reserved compute units (CU) for the resource group.', 'type' => 'number', 'format' => 'float', 'example' => '10', 'title' => ''], + 'Image' => ['description' => 'The image ID used in the runtime configuration.', 'type' => 'string', 'example' => 'hp-tlp-e2e-repo-registry-vpc.cn-heyuan-acdr-1.cr.aliyuncs.com/hp-service/worker:9b28b6d-202506091008', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'ModifyTime' => [ - 'description' => 'The time when the workflow was last modified. This value is a UNIX timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1708481905000'."\n", + 'Trigger' => [ + 'description' => 'The trigger configurations of the data quality monitoring task.', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The trigger mode of the monitoring task.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- ByManual: Manual trigger. This is the default setting.'."\n" + ."\n" + .'- BySchedule: Triggered by a scheduled task instance.', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'BySchedule', + 'title' => '', + ], + 'TaskIds' => [ + 'description' => 'If the trigger mode is set to BySchedule, the scheduling task ID must be specified.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the scheduling task.', 'type' => 'integer', 'format' => 'int64', 'example' => '1023777390', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], - 'Spec' => [ - 'description' => 'The FlowSpec field information about the workflow. For more information, see [FlowSpec](https://github.com/aliyun/alibabacloud-dataworks-tool-dflow/).'."\n", - 'type' => 'string', - 'example' => '{'."\n" - .' "metadata": {'."\n" - .' "tenantId": "52425742456XXXX",'."\n" - .' "projectId": "307XXXX",'."\n" - .' "uuid": "463497880880954XXXX"'."\n" - .' },'."\n" - .' "kind": "CycleWorkflow",'."\n" - .' "version": "1.1.0",'."\n" - .' "spec": {'."\n" - .' "name": "OpenAPI_Test_Workflow_Demo",'."\n" - .' "id": "463497880880954XXXX",'."\n" - .' "type": "CycleWorkflow",'."\n" - .' "owner": "110755000425XXXX",'."\n" - .' "workflows": ['."\n" - .' {'."\n" - .' "script": {'."\n" - .' "path": "XX/OpenAPI_Test/Workflow_Test/OpenAPI_Test_Workflow_Demo",'."\n" - .' "runtime": {'."\n" - .' "command": "WORKFLOW"'."\n" - .' },'."\n" - .' "id": "698002781368644XXXX"'."\n" - .' },'."\n" - .' "id": "463497880880954XXXX",'."\n" - .' "trigger": {'."\n" - .' "type": "Scheduler",'."\n" - .' "id": "652567824470354XXXX",'."\n" - .' "cron": "00 02 00 * * ?",'."\n" - .' "startTime": "1970-01-01 00:00:00",'."\n" - .' "endTime": "9999-01-01 00:00:00",'."\n" - .' "timezone": "Asia/Shanghai",'."\n" - .' "delaySeconds": 0'."\n" - .' },'."\n" - .' "strategy": {'."\n" - .' "timeout": 0,'."\n" - .' "instanceMode": "T+1",'."\n" - .' "rerunMode": "Allowed",'."\n" - .' "rerunTimes": 3,'."\n" - .' "rerunInterval": 180000,'."\n" - .' "failureStrategy": "Break"'."\n" - .' },'."\n" - .' "name": "OpenAPI_Test_Workflow_Demo",'."\n" - .' "owner": "110755000425XXXX",'."\n" - .' "metadata": {'."\n" - .' "owner": "110755000425XXXX",'."\n" - .' "ownerName": "XXXX@test.XXXX.com",'."\n" - .' "tenantId": "52425742456XXXX",'."\n" - .' "project": {'."\n" - .' "mode": "STANDARD",'."\n" - .' "projectId": "307303",'."\n" - .' "projectIdentifier": "lwttest_standard",'."\n" - .' "projectName": "XXXX",'."\n" - .' "projectOwnerId": "110755000425XXXX",'."\n" - .' "simple": false,'."\n" - .' "tenantId": "52425742456XXXX"'."\n" - .' },'."\n" - .' "projectId": "307XXXX"'."\n" - .' },'."\n" - .' "inputs": {},'."\n" - .' "outputs": {'."\n" - .' "nodeOutputs": ['."\n" - .' {'."\n" - .' "data": "463497880880954XXXX",'."\n" - .' "artifactType": "NodeOutput",'."\n" - .' "refTableName": "OpenAPI_Test_Workflow_Demo",'."\n" - .' "isDefault": true'."\n" - .' }'."\n" - .' ]'."\n" - .' },'."\n" - .' "nodes": [],'."\n" - .' "dependencies": []'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .'}', - ], - 'WorkflowId' => [ - 'description' => 'The ID of the workflow on the scheduling side after publishing.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '700006657495', - ], - 'Id' => [ - 'description' => 'The ID of the workflow.'."\n", - 'type' => 'string', - 'format' => 'int64', - 'example' => '463497880880954XXXX', + 'Hooks' => [ + 'description' => 'The Hook configurations after the data quality monitoring run ends.', + 'type' => 'array', + 'items' => [ + 'description' => 'The Hook configurations after the data quality monitoring run ends.', + 'type' => 'object', + 'properties' => [ + 'Condition' => ['description' => 'The Hook trigger condition. The hook will run if the condition is met. Currently, only one type of expression syntax is supported:'."\n" + ."\n" + .'- You can specify multiple combinations of rule severity levels and validation statuses using an expression such as `results.any { r -> r.status == \'Fail\' && r.rule.severity == \'Normal\' || r.status == \'Error\' && r.rule.severity == \'High\' || r.status == \'Warn\' && r.rule.severity == \'High\' }`. This expression means the condition is met if any executed rule has a result of Fail with severity Normal, Error with severity High, or Warn with severity High. In the condition expression, the values of severity and status are predefined enums. The values of severity must match those defined in the Spec, and the values of status must match those in DataQualityResult.', 'type' => 'string', 'example' => 'results.any { r -> r.status == \'Fail\' && r.rule.severity == \'Normal\' || r.status == \'Error\' && r.rule.severity == \'High\' || r.status == \'Warn\' && r.rule.severity == \'High\' }', 'title' => ''], + 'Type' => [ + 'description' => 'The type of the Hook.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- BlockTaskInstance: BlockTaskInstance: Blocks the scheduling of the task instance.', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'BlockTaskInstance', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], - ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2BDD628-8A21-5BD1-B930-1A2D5989XXXX\\",\\n \\"WorkflowDefinition\\": {\\n \\"ProjectId\\": 0,\\n \\"Name\\": \\"OpenAPI test workflow Demo\\",\\n \\"Owner\\": \\"110755000425XXXX\\",\\n \\"CreateTime\\": 1708481905000,\\n \\"ModifyTime\\": 1708481905000,\\n \\"Spec\\": \\"{\\\\n \\\\\\"metadata\\\\\\": {\\\\n \\\\\\"tenantId\\\\\\": \\\\\\"52425742456XXXX\\\\\\",\\\\n \\\\\\"projectId\\\\\\": \\\\\\"307XXXX\\\\\\",\\\\n \\\\\\"uuid\\\\\\": \\\\\\"463497880880954XXXX\\\\\\"\\\\n },\\\\n \\\\\\"kind\\\\\\": \\\\\\"CycleWorkflow\\\\\\",\\\\n \\\\\\"version\\\\\\": \\\\\\"1.1.0\\\\\\",\\\\n \\\\\\"spec\\\\\\": {\\\\n \\\\\\"name\\\\\\": \\\\\\"OpenAPI_Test_Workflow_Demo\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"463497880880954XXXX\\\\\\",\\\\n \\\\\\"type\\\\\\": \\\\\\"CycleWorkflow\\\\\\",\\\\n \\\\\\"owner\\\\\\": \\\\\\"110755000425XXXX\\\\\\",\\\\n \\\\\\"workflows\\\\\\": [\\\\n {\\\\n \\\\\\"script\\\\\\": {\\\\n \\\\\\"path\\\\\\": \\\\\\"XX/OpenAPI_Test/Workflow_Test/OpenAPI_Test_Workflow_Demo\\\\\\",\\\\n \\\\\\"runtime\\\\\\": {\\\\n \\\\\\"command\\\\\\": \\\\\\"WORKFLOW\\\\\\"\\\\n },\\\\n \\\\\\"id\\\\\\": \\\\\\"698002781368644XXXX\\\\\\"\\\\n },\\\\n \\\\\\"id\\\\\\": \\\\\\"463497880880954XXXX\\\\\\",\\\\n \\\\\\"trigger\\\\\\": {\\\\n \\\\\\"type\\\\\\": \\\\\\"Scheduler\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"652567824470354XXXX\\\\\\",\\\\n \\\\\\"cron\\\\\\": \\\\\\"00 02 00 * * ?\\\\\\",\\\\n \\\\\\"startTime\\\\\\": \\\\\\"1970-01-01 00:00:00\\\\\\",\\\\n \\\\\\"endTime\\\\\\": \\\\\\"9999-01-01 00:00:00\\\\\\",\\\\n \\\\\\"timezone\\\\\\": \\\\\\"Asia/Shanghai\\\\\\",\\\\n \\\\\\"delaySeconds\\\\\\": 0\\\\n },\\\\n \\\\\\"strategy\\\\\\": {\\\\n \\\\\\"timeout\\\\\\": 0,\\\\n \\\\\\"instanceMode\\\\\\": \\\\\\"T+1\\\\\\",\\\\n \\\\\\"rerunMode\\\\\\": \\\\\\"Allowed\\\\\\",\\\\n \\\\\\"rerunTimes\\\\\\": 3,\\\\n \\\\\\"rerunInterval\\\\\\": 180000,\\\\n \\\\\\"failureStrategy\\\\\\": \\\\\\"Break\\\\\\"\\\\n },\\\\n \\\\\\"name\\\\\\": \\\\\\"OpenAPI_Test_Workflow_Demo\\\\\\",\\\\n \\\\\\"owner\\\\\\": \\\\\\"110755000425XXXX\\\\\\",\\\\n \\\\\\"metadata\\\\\\": {\\\\n \\\\\\"owner\\\\\\": \\\\\\"110755000425XXXX\\\\\\",\\\\n \\\\\\"ownerName\\\\\\": \\\\\\"XXXX@test.XXXX.com\\\\\\",\\\\n \\\\\\"tenantId\\\\\\": \\\\\\"52425742456XXXX\\\\\\",\\\\n \\\\\\"project\\\\\\": {\\\\n \\\\\\"mode\\\\\\": \\\\\\"STANDARD\\\\\\",\\\\n \\\\\\"projectId\\\\\\": \\\\\\"307303\\\\\\",\\\\n \\\\\\"projectIdentifier\\\\\\": \\\\\\"lwttest_standard\\\\\\",\\\\n \\\\\\"projectName\\\\\\": \\\\\\"XXXX\\\\\\",\\\\n \\\\\\"projectOwnerId\\\\\\": \\\\\\"110755000425XXXX\\\\\\",\\\\n \\\\\\"simple\\\\\\": false,\\\\n \\\\\\"tenantId\\\\\\": \\\\\\"52425742456XXXX\\\\\\"\\\\n },\\\\n \\\\\\"projectId\\\\\\": \\\\\\"307XXXX\\\\\\"\\\\n },\\\\n \\\\\\"inputs\\\\\\": {},\\\\n \\\\\\"outputs\\\\\\": {\\\\n \\\\\\"nodeOutputs\\\\\\": [\\\\n {\\\\n \\\\\\"data\\\\\\": \\\\\\"463497880880954XXXX\\\\\\",\\\\n \\\\\\"artifactType\\\\\\": \\\\\\"NodeOutput\\\\\\",\\\\n \\\\\\"refTableName\\\\\\": \\\\\\"OpenAPI_Test_Workflow_Demo\\\\\\",\\\\n \\\\\\"isDefault\\\\\\": true\\\\n }\\\\n ]\\\\n },\\\\n \\\\\\"nodes\\\\\\": [],\\\\n \\\\\\"dependencies\\\\\\": []\\\\n }\\\\n ]\\\\n }\\\\n}\\",\\n \\"WorkflowId\\": 700006657495,\\n \\"Id\\": \\"463497880880954XXXX\\"\\n }\\n}","type":"json"}]', - 'title' => 'GetWorkflowDefinition', - ], - 'ListWorkflowDefinitions' => [ - 'summary' => 'Queries a list of workflows in DataStudio. You can also specify filter conditions to query specific workflows.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '235375', - 'abilityTreeNodes' => [ - 'FEATUREdideHO4TQP', - 'FEATUREdide8FM783', - 'FEATUREdideQUQUVB', - 'FEATUREdideIQU97M', - ], - ], - '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, - 'example' => '10000', - ], - ], - [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'description' => 'Filter condition: The type of the workflow. The default value is CycleWorkflow.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* CycleWorkflow'."\n" - .'* ManualWorkflow'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'CycleWorkflow', - 'default' => 'CycleWorkflow', - ], - ], - [ - 'name' => 'Owner', - 'in' => 'query', - 'schema' => [ - 'description' => 'Filter condition: The type of the workflow. The default value is CycleWorkflow.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* CycleWorkflow'."\n" - .'* ManualWorkflow'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '110755000425XXXX', + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetDataQualityScan', + 'description' => 'DataWorks Basic Edition or a higher edition is required.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the workflow. Fuzzy search is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetDataQualityScan', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"204EAF68-CCE3-5112-8DA0-E7A60F02XXXX\\",\\n \\"DataQualityScan\\": {\\n \\"Id\\": 10001,\\n \\"Name\\": \\"data_quality_scan_001\\",\\n \\"Description\\": \\"aily data quality scanning of ods tables.\\",\\n \\"ProjectId\\": 101,\\n \\"CreateTime\\": 1731550150000,\\n \\"ModifyTime\\": 1731550150000,\\n \\"CreateUser\\": \\"2374924198591250\\",\\n \\"ModifyUser\\": \\"23482597582479\\",\\n \\"Owner\\": \\"231263586109857423\\",\\n \\"Spec\\": \\"{\\\\n \\\\\\"datasets\\\\\\": [\\\\n {\\\\n \\\\\\"type\\\\\\": \\\\\\"Table\\\\\\",\\\\n \\\\\\"dataSource\\\\\\": {\\\\n \\\\\\"name\\\\\\": \\\\\\"odps_first\\\\\\",\\\\n \\\\\\"envType\\\\\\": \\\\\\"Prod\\\\\\"\\\\n },\\\\n \\\\\\"tables\\\\\\": [\\\\n \\\\\\"ods_d_user_info\\\\\\"\\\\n ],\\\\n \\\\\\"filter\\\\\\": \\\\\\"pt = $[yyyymmdd-1]\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"rules\\\\\\": [\\\\n {\\\\n \\\\\\"assertion\\\\\\": \\\\\\"row_count > 0\\\\\\"\\\\n }, {\\\\n \\\\\\"templateId\\\\\\": \\\\\\"SYSTEM:field:null_value:fixed\\\\\\",\\\\n \\\\\\"pass\\\\\\": \\\\\\"when = 0\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"The id cannot be empty.\\\\\\",\\\\n \\\\\\"severity\\\\\\": \\\\\\"High\\\\\\",\\\\n \\\\\\"identity\\\\\\": \\\\\\"a-customized-data-quality-rule-uuid\\\\\\"\\\\n }\\\\n ]\\\\n}\\",\\n \\"Parameters\\": [\\n {\\n \\"Value\\": \\"10\\",\\n \\"Name\\": \\"e2e_autolabel\\"\\n }\\n ],\\n \\"ComputeResource\\": {\\n \\"Name\\": \\"polardb_to_holo\\",\\n \\"Runtime\\": {\\n \\"Engine\\": \\"Hive\\",\\n \\"HiveConf\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SparkConf\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"EnvType\\": \\"Prod\\"\\n },\\n \\"RuntimeResource\\": {\\n \\"Id\\": \\"122878\\",\\n \\"Cu\\": 10,\\n \\"Image\\": \\"hp-tlp-e2e-repo-registry-vpc.cn-heyuan-acdr-1.cr.aliyuncs.com/hp-service/worker:9b28b6d-202506091008\\"\\n },\\n \\"Trigger\\": {\\n \\"Type\\": \\"BySchedule\\",\\n \\"TaskIds\\": [\\n 1023777390\\n ]\\n },\\n \\"Hooks\\": [\\n {\\n \\"Condition\\": \\"results.any { r -> r.status == \'Fail\' && r.rule.severity == \'Normal\' || r.status == \'Error\' && r.rule.severity == \'High\' || r.status == \'Warn\' && r.rule.severity == \'High\' }\\",\\n \\"Type\\": \\"BlockTaskInstance\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'GetDataQualityScanRun' => [ + 'summary' => 'Creates a data quality monitoring run instance.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number of the data to retrieve, used for pagination.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdide3WJOKE'], + ], + 'parameters' => [ [ - 'name' => 'PageSize', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number of the data to retrieve, used for pagination.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '10', - 'example' => '10', - 'default' => '10', - ], + 'schema' => ['description' => 'The data quality monitoring run record ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1006059507', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '8C3ED0C5-ABAB-55E1-854B-DAC02B11XXXX', - ], - 'PagingInfo' => [ - 'description' => 'The pagination information.'."\n", + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0bc14115****159376359'], + 'DataQualityScanRun' => [ + 'description' => 'Data quality monitoring running records.', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '227', - ], - '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', + 'Id' => ['description' => 'The running record ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1016440997', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the data quality monitor starts running.', 'type' => 'integer', 'format' => 'int64', 'example' => '1706247622000', 'title' => ''], + 'FinishTime' => ['description' => 'The time when the data quality monitor stops.', 'type' => 'integer', 'format' => 'int64', 'example' => '1706247622000', 'title' => ''], + 'Status' => [ + 'description' => 'The current running status.'."\n" + ."\n" + .'- Pass'."\n" + ."\n" + .'- Running'."\n" + ."\n" + .'- Error'."\n" + ."\n" + .'- Warn'."\n" + ."\n" + .'- Fail', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'Fail', + 'title' => '', ], - 'WorkflowDefinitions' => [ - 'description' => 'The workflows.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ProjectId' => [ - 'title' => '所属项目空间', - 'description' => 'The ID of the DataWorks workspace to which the workflow belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'deprecated' => false, - 'required' => true, - 'example' => '4710', - 'pattern' => '', - 'default' => '', - ], - 'Owner' => [ - 'title' => '责任人', - 'description' => 'Owner'."\n", - 'type' => 'string', - 'deprecated' => false, - 'required' => false, - 'example' => '110755000425XXXX', - 'pattern' => '', - 'default' => '', - ], - 'CreateTime' => [ - 'title' => '创建时间', - 'description' => 'The timestamp when the workflow was created.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'deprecated' => false, - 'required' => false, - 'example' => '1698057323000', - 'pattern' => '', - 'default' => '', + 'Scan' => [ + 'description' => 'The snapshot of the data quality monitor configuration at the start of the validation.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The data quality monitor ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '21077', 'title' => ''], + 'Name' => ['description' => 'The name of the data quality validation task. It can contain digits, letters, Chinese characters, and both half-width and full-width punctuation marks, with a maximum length of 255 characters.', 'type' => 'string', 'example' => 'Hourly partition quality monitoring', 'title' => ''], + 'Description' => ['description' => 'The description of the data quality validation task. Maximum length: 65,535 characters.', 'type' => 'string', 'example' => 'This is a hourly run data quality evaluation plan.', 'title' => ''], + 'ProjectId' => ['description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '164024', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time of the data quality monitor.', 'type' => 'integer', 'format' => 'int64', 'example' => '1706247622000', 'title' => ''], + 'ModifyTime' => ['description' => 'The last update time of the data quality monitor.', 'type' => 'integer', 'format' => 'int64', 'example' => '1706247622000', 'title' => ''], + 'CreateUser' => ['description' => 'The creator of the data quality monitor.', 'type' => 'string', 'example' => '7892346529452', 'title' => ''], + 'ModifyUser' => ['description' => 'The last updater of the data quality monitor.', 'type' => 'string', 'example' => '7892346529452', 'title' => ''], + 'Owner' => ['description' => 'The owner of the data quality monitor.', 'type' => 'string', 'example' => '7892346529452', 'title' => ''], + 'Spec' => ['description' => 'The data quality monitor Spec. For more information, see [Data quality Spec configuration description](~~2963394~~).', 'type' => 'string', 'example' => '{'."\n" + .' "datasets": ['."\n" + .' {'."\n" + .' "type": "Table",'."\n" + .' "dataSource": {'."\n" + .' "name": "odps_first",'."\n" + .' "envType": "Prod"'."\n" + .' },'."\n" + .' "tables": ['."\n" + .' "ods_d_user_info"'."\n" + .' ],'."\n" + .' "filter": "pt = $[yyyymmdd-1]"'."\n" + .' }'."\n" + .' ],'."\n" + .' "rules": ['."\n" + .' {'."\n" + .' "assertion": "row_count > 0"'."\n" + .' }, {'."\n" + .' "templateId": "SYSTEM:field:null_value:fixed",'."\n" + .' "pass": "when = 0",'."\n" + .' "name": "The id cannot be empty.",'."\n" + .' "severity": "High",'."\n" + .' "identity": "a-customized-data-quality-rule-uuid"'."\n" + .' }'."\n" + .' ]'."\n" + .'}', 'title' => ''], + 'Parameters' => [ + 'description' => 'The parameter settings of the data quality monitor.', + 'type' => 'array', + 'items' => [ + 'description' => 'The parameter settings of the data quality monitor.', + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => 'The parameter value.', 'type' => 'string', 'example' => '$[yyyy-mm-dd-1]', 'title' => ''], + 'Name' => ['description' => 'The parameter name.', 'type' => 'string', 'example' => 'dt', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'ModifyTime' => [ - 'title' => '修改时间', - 'description' => 'The timestamp when the workflow was last modified.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'deprecated' => false, - 'required' => false, - 'example' => '1698057323000', - 'pattern' => '', - 'default' => '', + 'title' => '', + 'example' => '', + ], + 'ComputeResource' => [ + 'description' => 'The computing resource settings of the data quality monitor.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the computing resource, which corresponds to the Name attribute in the ComputeResource data structure of the computing resource API.', 'type' => 'string', 'example' => 'emr_cluster_001', 'title' => ''], + 'Runtime' => [ + 'description' => 'The additional runtime settings of the data quality monitor.', + 'type' => 'object', + 'properties' => [ + 'Engine' => [ + 'description' => 'The type of the compute engine. Only EMR compute engines support these settings.'."\n" + ."\n" + .'- Hive'."\n" + ."\n" + .'- Spark'."\n" + ."\n" + .'- Kyuubi', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'Hive', + 'title' => '', + ], + 'SparkConf' => ['description' => 'Additional parameters for the Spark engine. Currently, only spark.yarn.queue is supported to specify the queue.', 'type' => 'object', 'example' => 'spark.yarn.queue=dq_queue'."\n", 'title' => ''], + 'HiveConf' => ['description' => 'Additional parameters for the Hive engine. Currently, only mapreduce.job.queuename is supported to specify the queue.', 'type' => 'object', 'example' => 'mapreduce.job.queuename=dq_queue'."\n", 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'EnvType' => [ + 'description' => 'The workspace environment to which the compute engine belongs.'."\n" + ."\n" + .'- Prod'."\n" + ."\n" + .'- Dev', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'Dev', + 'title' => '', + ], ], - 'Description' => [ - 'title' => '描述', - 'description' => 'Description'."\n", - 'type' => 'string', - 'deprecated' => false, - 'required' => false, - 'example' => 'Workflow description', - 'pattern' => '', - 'default' => '', + 'title' => '', + 'example' => '', + ], + 'RuntimeResource' => [ + 'description' => 'The resource group used for running the data quality monitor.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => '60597', 'title' => ''], + 'Cu' => ['description' => 'Reserved CUs for the resource group.', 'type' => 'number', 'format' => 'float', 'example' => '1', 'title' => ''], + 'Image' => ['description' => 'The image ID of the run configuration.', 'type' => 'string', 'example' => 'i-xxxx', 'title' => ''], ], - 'Type' => [ - 'title' => '工作流类型', - 'description' => 'The type of the workflow.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* CycleWorkflow'."\n" - .'* ManualWorkflow'."\n", - 'type' => 'string', - 'deprecated' => false, - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'CycleWorkflow', - 'pattern' => '', - 'default' => '', - 'enum' => [ - 'CycleWorkflow', - 'ManualWorkflow', + 'title' => '', + 'example' => '', + ], + 'Trigger' => [ + 'description' => 'The trigger configurations of the data quality monitor.', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The trigger method of the data quality monitor.'."\n" + ."\n" + .'- ByManual'."\n" + ."\n" + .'- BySchedule', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'BySchedule', + 'title' => '', + ], + 'TaskIds' => [ + 'description' => 'If the trigger mode is set to BySchedule, the scheduling task ID must be specified.', + 'type' => 'array', + 'items' => ['description' => 'The scheduling task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1014217266', 'title' => ''], + 'title' => '', + 'example' => '', ], ], - 'Script' => [ - 'title' => '脚本信息', - 'description' => 'The script information.'."\n", + 'title' => '', + 'example' => '', + ], + 'Hooks' => [ + 'description' => 'The hook configurations after the data quality monitor stops.', + 'type' => 'array', + 'items' => [ + 'description' => 'The hook configurations after the data quality monitor stops.', 'type' => 'object', 'properties' => [ - 'Path' => [ - 'title' => '脚本路径', - 'description' => 'The script path.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'XX/OpenAPI_test/workflow_test/OpenAPI_test_workflow_Demo', - 'pattern' => '', - 'default' => '', - ], - 'Runtime' => [ - 'title' => '运行时', - 'description' => 'Runtime'."\n", - 'type' => 'object', - 'properties' => [ - 'Command' => [ - 'title' => '命令', - 'description' => 'Command'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'WORKFLOW', - 'pattern' => '', - 'default' => '', - ], - ], - 'deprecated' => false, - ], - 'Id' => [ - 'description' => 'The ID of the script.'."\n" + 'Condition' => ['description' => 'The hook trigger condition. Currently, only one type of expression syntax is supported:'."\n" + ."\n" + .'- Specify combinations of severity levels and validation statuses for multiple rules, such as `results.any { r -> r.status == \'Fail\' && r.rule.severity == \'Normal\' || r.status == \'Error\' && r.rule.severity == \'High\' || r.status == \'Warn\' && r.rule.severity == \'High\' }`. This means the hook is triggered if any executed rule has Fail with Normal severity, Error with High severity, or Warn with High severity. In the conditional expression, the severity value matches that in the Spec code, and the status value matches that in DataQualityResult.', 'type' => 'string', 'example' => 'results.any { r -> r.status == \'fail\' && r.rule.severity == \'High\' }', 'title' => ''], + 'Type' => [ + 'description' => 'The type of the hook.'."\n" ."\n" - .'> This field is of type Long in SDK versions prior to 8.0.0, and of type String in SDK version 8.0.0 and later. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures due to the type change may occur only when upgrading the SDK across version 8.0.0, in which case users need to manually correct the data type.'."\n", + .'- BlockTaskInstance', + 'enumValueTitles' => [], 'type' => 'string', - 'deprecated' => false, - 'example' => '698002781368644XXXX', + 'example' => 'BlockTaskInstance', 'title' => '', ], ], - 'deprecated' => false, - 'required' => false, - ], - 'Name' => [ - 'title' => '名称', - 'description' => 'The name of the workflow.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'required' => false, - 'example' => 'OpenAPI test workflow Demo', - 'pattern' => '', - 'default' => '', + 'title' => '', + 'example' => '', ], - 'Id' => [ - 'description' => 'The unique identifier of the workflow.'."\n" + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'Parameters' => [ + 'description' => 'The parameter settings used during the actual running.', + 'type' => 'array', + 'items' => [ + 'description' => 'Parameter settings.', + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => 'The parameter value.', 'type' => 'string', 'example' => '$[yyyy-mm-dd-1]', 'title' => ''], + 'Name' => ['description' => 'The parameter name.', 'type' => 'string', 'example' => 'dt', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Results' => [ + 'description' => 'The validation results of each rule.', + 'type' => 'array', + 'items' => [ + 'description' => 'The validation result of the rule.', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The validation result status.'."\n" + ."\n" + .'- Pass'."\n" + ."\n" + .'- Running'."\n" + ."\n" + .'- Error'."\n" ."\n" - .'> Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.'."\n", + .'- Warn'."\n" + ."\n" + .'- Fail', + 'enumValueTitles' => [], 'type' => 'string', - 'deprecated' => false, - 'example' => '463497880880954XXXX', + 'example' => 'Fail', + 'title' => '', + ], + 'Details' => [ + 'description' => 'The information about the data quality check.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the data quality check.', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => 'The final comparison result status.'."\n" + ."\n" + .'- Pass'."\n" + ."\n" + .'- Error'."\n" + ."\n" + .'- Warn'."\n" + ."\n" + .'- Fail', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'Fail', + 'title' => '', + ], + 'ReferenceValue' => ['description' => 'The reference sample used as the baseline for calculating the CheckedValue.', 'type' => 'string', 'example' => '0.0', 'title' => ''], + 'CheckValue' => ['description' => 'The final value used for comparison with the threshold.', 'type' => 'string', 'example' => '100.0', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], 'title' => '', + 'example' => '', ], + 'Sample' => ['description' => 'The sample value used in the validation.', 'type' => 'string', 'example' => '{'."\n" + .' "value": "100.0"'."\n" + .'}'."\n", 'title' => ''], + 'CreateTime' => ['description' => 'The time when the validation result is generated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1725506795000', 'title' => ''], + 'Rule' => ['description' => 'The snapshot of the rule Spec at the start of the validation.', 'type' => 'string', 'example' => '{'."\n" + .' "templateId": "SYSTEM:field:null_value:fixed",'."\n" + .' "pass": "when = 0",'."\n" + .' "name": "The id cannot be empty.",'."\n" + .' "severity": "High",'."\n" + .' "identity": "a-customized-data-quality-rule-uuid"'."\n" + .'}', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8C3ED0C5-ABAB-55E1-854B-DAC02B11XXXX\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 227,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"WorkflowDefinitions\\": [\\n {\\n \\"ProjectId\\": 4710,\\n \\"Owner\\": \\"110755000425XXXX\\",\\n \\"CreateTime\\": 1698057323000,\\n \\"ModifyTime\\": 1698057323000,\\n \\"Description\\": \\"Workflow description\\",\\n \\"Type\\": \\"CycleWorkflow\\",\\n \\"Script\\": {\\n \\"Path\\": \\"XX/OpenAPI_test/workflow_test/OpenAPI_test_workflow_Demo\\",\\n \\"Runtime\\": {\\n \\"Command\\": \\"WORKFLOW\\"\\n },\\n \\"Id\\": \\"698002781368644XXXX\\"\\n },\\n \\"Name\\": \\"OpenAPI test workflow Demo\\",\\n \\"Id\\": \\"463497880880954XXXX\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListWorkflowDefinitions', - ], - 'CreateResource' => [ - 'summary' => '\\> You cannot use this API operation to create multiple file resources at a time. If you specify multiple file resources by using FlowSpec, the system creates only the first specified resource.', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetDataQualityScanRun', + 'description' => 'DataWorks Basic Edition or a higher edition is required.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetDataQualityScanRun', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115****159376359\\",\\n \\"DataQualityScanRun\\": {\\n \\"Id\\": 1016440997,\\n \\"CreateTime\\": 1706247622000,\\n \\"FinishTime\\": 1706247622000,\\n \\"Status\\": \\"Fail\\",\\n \\"Scan\\": {\\n \\"Id\\": 21077,\\n \\"Name\\": \\"Hourly partition quality monitoring\\",\\n \\"Description\\": \\"This is a hourly run data quality evaluation plan.\\",\\n \\"ProjectId\\": 164024,\\n \\"CreateTime\\": 1706247622000,\\n \\"ModifyTime\\": 1706247622000,\\n \\"CreateUser\\": \\"7892346529452\\",\\n \\"ModifyUser\\": \\"7892346529452\\",\\n \\"Owner\\": \\"7892346529452\\",\\n \\"Spec\\": \\"{\\\\n \\\\\\"datasets\\\\\\": [\\\\n {\\\\n \\\\\\"type\\\\\\": \\\\\\"Table\\\\\\",\\\\n \\\\\\"dataSource\\\\\\": {\\\\n \\\\\\"name\\\\\\": \\\\\\"odps_first\\\\\\",\\\\n \\\\\\"envType\\\\\\": \\\\\\"Prod\\\\\\"\\\\n },\\\\n \\\\\\"tables\\\\\\": [\\\\n \\\\\\"ods_d_user_info\\\\\\"\\\\n ],\\\\n \\\\\\"filter\\\\\\": \\\\\\"pt = $[yyyymmdd-1]\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"rules\\\\\\": [\\\\n {\\\\n \\\\\\"assertion\\\\\\": \\\\\\"row_count > 0\\\\\\"\\\\n }, {\\\\n \\\\\\"templateId\\\\\\": \\\\\\"SYSTEM:field:null_value:fixed\\\\\\",\\\\n \\\\\\"pass\\\\\\": \\\\\\"when = 0\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"The id cannot be empty.\\\\\\",\\\\n \\\\\\"severity\\\\\\": \\\\\\"High\\\\\\",\\\\n \\\\\\"identity\\\\\\": \\\\\\"a-customized-data-quality-rule-uuid\\\\\\"\\\\n }\\\\n ]\\\\n}\\",\\n \\"Parameters\\": [\\n {\\n \\"Value\\": \\"$[yyyy-mm-dd-1]\\",\\n \\"Name\\": \\"dt\\"\\n }\\n ],\\n \\"ComputeResource\\": {\\n \\"Name\\": \\"emr_cluster_001\\",\\n \\"Runtime\\": {\\n \\"Engine\\": \\"Hive\\",\\n \\"SparkConf\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"HiveConf\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"EnvType\\": \\"Dev\\"\\n },\\n \\"RuntimeResource\\": {\\n \\"Id\\": \\"60597\\",\\n \\"Cu\\": 1,\\n \\"Image\\": \\"i-xxxx\\"\\n },\\n \\"Trigger\\": {\\n \\"Type\\": \\"BySchedule\\",\\n \\"TaskIds\\": [\\n 1014217266\\n ]\\n },\\n \\"Hooks\\": [\\n {\\n \\"Condition\\": \\"results.any { r -> r.status == \'fail\' && r.rule.severity == \'High\' }\\",\\n \\"Type\\": \\"BlockTaskInstance\\"\\n }\\n ]\\n },\\n \\"Parameters\\": [\\n {\\n \\"Value\\": \\"$[yyyy-mm-dd-1]\\",\\n \\"Name\\": \\"dt\\"\\n }\\n ],\\n \\"Results\\": [\\n {\\n \\"Status\\": \\"Fail\\",\\n \\"Details\\": [\\n {\\n \\"Status\\": \\"Fail\\",\\n \\"ReferenceValue\\": \\"0.0\\",\\n \\"CheckValue\\": \\"100.0\\"\\n }\\n ],\\n \\"Sample\\": \\"{\\\\n \\\\\\"value\\\\\\": \\\\\\"100.0\\\\\\"\\\\n}\\\\n\\",\\n \\"CreateTime\\": 1725506795000,\\n \\"Rule\\": \\"{\\\\n \\\\\\"templateId\\\\\\": \\\\\\"SYSTEM:field:null_value:fixed\\\\\\",\\\\n \\\\\\"pass\\\\\\": \\\\\\"when = 0\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"The id cannot be empty.\\\\\\",\\\\n \\\\\\"severity\\\\\\": \\\\\\"High\\\\\\",\\\\n \\\\\\"identity\\\\\\": \\\\\\"a-customized-data-quality-rule-uuid\\\\\\"\\\\n}\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'GetDataQualityScanRunLog' => [ + 'summary' => 'Queries the log of a specific task instance that monitors data quality.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '235474', - 'abilityTreeNodes' => [ - 'FEATUREdideJ3TPTK', - ], + 'abilityTreeNodes' => ['FEATUREdide3WJOKE'], ], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'title' => '项目id', - 'description' => 'The ID of the DataWorks workspace. To obtain the workspace ID, log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and navigate to the workspace configuration page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123456', - 'pattern' => '', - 'default' => '', - ], - ], - [ - 'name' => 'Spec', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the DataWorks workspace. To obtain the workspace ID, log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and navigate to the workspace configuration page.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '{'."\n" - .' "version": "1.1.0",'."\n" - .' "kind": "Resource",'."\n" - .' "spec": {'."\n" - .' "fileResources": ['."\n" - .' {'."\n" - .' "name": "OpenAPITestResource.py",'."\n" - .' "script": {'."\n" - .' "content": "",'."\n" - .' "path": "XX/OpenAPITest/ResourcesTest/OpenAPITestResource.py",'."\n" - .' "runtime": {'."\n" - .' "command": "ODPS_PYTHON"'."\n" - .' }'."\n" - .' },'."\n" - .' "type": "python",'."\n" - .' "file": {'."\n" - .' "storage": {}'."\n" - .' },'."\n" - .' "datasource": {'."\n" - .' "name": "odps_first",'."\n" - .' "type": "odps"'."\n" - .' }'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .'}', - ], + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the data quality monitor run record.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10001', 'title' => ''], ], [ - 'name' => 'ResourceFile', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The specific file stream or OSS download link contained in the resource.'."\n" - ."\n" - .'> This field allows users to provide a file stream or an OSS download link. When providing an OSS download link, ensure that the OSS link is publicly accessible. A presigned URL is recommended.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http://bucketname1.oss-cn-shanghai.aliyuncs.com/example', - 'isFileTransferUrl' => true, - ], + 'name' => 'Offset', + 'in' => 'query', + 'schema' => ['description' => 'The starting position of the log, in bytes, relative to the beginning of the file. Each query returns a maximum of 512 KB of content.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '200', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'A5B97987-66EA-5563-9599-A2752292XXXX', - 'type' => 'string', - 'example' => 'The ID of the file resource.'."\n", - ], - 'Id' => [ - 'description' => 'The unique identifier of the resource file.'."\n" - ."\n" - .'> This field is of type Long in SDK versions prior to 8.0.0, and of type String in SDK version 8.0.0 and later. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.'."\n", - 'type' => 'string', - 'example' => '631478864897630XXXX', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0bc14115***159376359'], + 'LogSegment' => [ + 'description' => 'The task log information.', + 'type' => 'object', + 'properties' => [ + 'Log' => ['description' => 'The task log.', 'type' => 'string', 'example' => 'Running on Serverless_resource_group_xxxxx'."\n" + .'Begin to check rule ***', 'title' => ''], + 'NextOffset' => ['description' => 'The starting offset of the next log segment. A value of -1 indicates that all logs have been read.', 'type' => 'integer', 'format' => 'int64', 'example' => '512000', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A5B97987-66EA-5563-9599-A2752292****\\",\\n \\"Id\\": \\"631478864897630XXXX\\"\\n}","type":"json"}]', - 'title' => 'CreateResource', - 'description' => 'Private', - ], - 'DeleteResource' => [ - 'summary' => 'Deletes a file resource from DataStudio.', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetDataQualityScanRunLog', + 'description' => 'DataWorks Basic Edition or a higher edition is required.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetDataQualityScanRunLog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115***159376359\\",\\n \\"LogSegment\\": {\\n \\"Log\\": \\"Running on Serverless_resource_group_xxxxx\\\\nBegin to check rule ***\\",\\n \\"NextOffset\\": 512000\\n }\\n}","type":"json"}]', + ], + 'GetDataQualityTemplate' => [ + 'summary' => 'Retrieves the details of a data quality rule template by template ID.', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '235475', - 'abilityTreeNodes' => [ - 'FEATUREdideJ3TPTK', - ], + 'abilityTreeNodes' => ['FEATUREdide3WJOKE'], ], '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 ID. You can use this parameter to specify the DataWorks workspace on which you want to perform the API operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10000', - ], - ], [ 'name' => 'Id', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The unique identifier of the resource file.'."\n" - ."\n" - .'> This field is of the Long type in SDK versions prior to 8.0.0, and of the String type in SDK versions 8.0.0 and later. This change does not affect normal SDK usage; the parameter will still be returned according to the type defined in the SDK. However, compilation failures may occur due to the type change only when upgrading the SDK across version 8.0.0. In this case, you must manually update the data type.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '860438872620113XXXX', - ], + 'in' => 'query', + 'schema' => ['description' => 'The data quality rule template ID.', 'type' => 'string', 'required' => false, 'example' => 'a7ef0634-20ec-4a7c-a214-54020f91XXXX', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '88198F19-A36B-52A9-AE44-4518A688XXXX', - ], - '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 API request ID, which is generated as a UUID.', 'type' => 'string', 'example' => '0bc14115***159376359'], + 'DataQualityTemplate' => [ + 'description' => 'The data quality rule template.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the data quality rule template.', 'type' => 'string', 'example' => '10001', 'title' => ''], + 'ProjectId' => ['description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '97535', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the data quality rule template was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1606724043000', 'title' => ''], + 'ModifyTime' => ['description' => 'The time when the data quality rule template was updated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1606724043000', 'title' => ''], + 'CreateUser' => ['description' => 'The creator of the data quality rule template.', 'type' => 'string', 'example' => '238428342865', 'title' => ''], + 'ModifyUser' => ['description' => 'The last updater of the data quality rule template.', 'type' => 'string', 'example' => '238428342865', 'title' => ''], + 'Spec' => ['description' => 'Specific configurations of the data quality rule template. For more information, see [Data quality Spec configuration description](~2963394~).', 'type' => 'string', 'example' => '{'."\n" + .' "assertion": "anomaly detection fro id_not_null_cnt",'."\n" + .' "id_not_null_cnt": {'."\n" + .' "query": "SELECT COUNT(*) AS cnt FROM ${tableName} WHERE dt = \'$[yyyymmdd-1]\';"'."\n" + .' },'."\n" + .' "identity": "819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a"'."\n" + .'}', 'title' => ''], + 'Owner' => ['description' => 'The owner of the data quality rule template.', 'type' => 'string', 'example' => '238428342865', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"88198F19-A36B-52A9-AE44-4518A688XXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'DeleteResource', - 'description' => '> A file resource that is deployed cannot be deleted. If you want to delete such a file resource, you must first undeploy the file resource.'."\n", - ], - 'UpdateResource' => [ - 'summary' => 'Updates the basic information about a file resource in DataStudio. This API operation performs an incremental update. The update information is described by using FlowSpec.', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetDataQualityTemplate', + 'description' => 'DataWorks Basic Edition or a higher edition is required.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetDataQualityTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115***159376359\\",\\n \\"DataQualityTemplate\\": {\\n \\"Id\\": \\"10001\\",\\n \\"ProjectId\\": 97535,\\n \\"CreateTime\\": 1606724043000,\\n \\"ModifyTime\\": 1606724043000,\\n \\"CreateUser\\": \\"238428342865\\",\\n \\"ModifyUser\\": \\"238428342865\\",\\n \\"Spec\\": \\"{\\\\n \\\\\\"assertion\\\\\\": \\\\\\"anomaly detection fro id_not_null_cnt\\\\\\",\\\\n \\\\\\"id_not_null_cnt\\\\\\": {\\\\n \\\\\\"query\\\\\\": \\\\\\"SELECT COUNT(*) AS cnt FROM ${tableName} WHERE dt = \'$[yyyymmdd-1]\';\\\\\\"\\\\n },\\\\n \\\\\\"identity\\\\\\": \\\\\\"819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a\\\\\\"\\\\n}\\",\\n \\"Owner\\": \\"238428342865\\"\\n }\\n}","type":"json"}]', + ], + 'GetDataSource' => [ + 'summary' => 'Retrieves the details of a data source by data source ID.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '235476', - 'abilityTreeNodes' => [ - 'FEATUREdideJ3TPTK', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '232399', + 'abilityTreeNodes' => ['FEATUREdideRWC5F7'], ], '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 query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10000', - ], - ], [ 'name' => 'Id', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The unique identifier of the Data Studio file resource.'."\n" - ."\n" - .'> This field is of type Long in SDK versions prior to 8.0.0, and of type String in SDK version 8.0.0 and later. This change does not affect the normal use of the SDK; parameters are still returned according to the type defined in the SDK. Compilation failures due to the type change may occur only when upgrading the SDK across version 8.0.0, in which case users need to manually correct the data type.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '543217824470354XXXX', - ], - ], - [ - 'name' => 'Spec', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The unique identifier of the Data Studio file resource.'."\n" - ."\n" - .'> Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '{'."\n" - .' "version": "1.1.0",'."\n" - .' "kind": "Resource",'."\n" - .' "spec": {'."\n" - .' "fileResources": ['."\n" - .' {'."\n" - .' "name": "OpenAPI_Test_Resource.py",'."\n" - .' "script": {'."\n" - .' "content": "",'."\n" - .' "path": "XX/OpenAPI_Test/Resources_Test/OpenAPI_Test_Resource.py",'."\n" - .' "runtime": {'."\n" - .' "command": "ODPS_PYTHON"'."\n" - .' }'."\n" - .' },'."\n" - .' "type": "python",'."\n" - .' "file": {'."\n" - .' "storage": {}'."\n" - .' },'."\n" - .' "datasource": {'."\n" - .' "name": "odps_first",'."\n" - .' "type": "odps"'."\n" - .' }'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .'}', - ], - ], - [ - 'name' => 'ResourceFile', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The specific file stream or OSS download link contained in the resource.'."\n" - ."\n" - .'> This field allows users to provide a file stream or an OSS download link. When providing an OSS download link, ensure that the OSS link is publicly accessible. A presigned URL is recommended.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http://bucketname1.oss-cn-shanghai.aliyuncs.com/example', - 'isFileTransferUrl' => true, - ], + 'in' => 'query', + 'schema' => ['description' => 'The data source ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '16035', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID. You can troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => '4CDF7B72-020B-542A-8465-21CFFA81XXXX', - ], - '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.', 'type' => 'string', 'example' => '9252F32F-D855-549E-8898-61CF5A733050'], + 'DataSource' => [ + 'description' => 'The information about the data source.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The data source ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '16738', 'title' => ''], + 'ProjectId' => ['description' => 'The ID of the workspace with which the data source is associated.', 'type' => 'integer', 'format' => 'int64', 'example' => '52660', 'title' => ''], + 'Name' => ['description' => 'The name of the data source.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'Type' => ['description' => 'The type of the data source.', 'type' => 'string', 'example' => 'hologres', 'title' => ''], + 'ConnectionProperties' => ['description' => 'The connection configurations of the data source, including the connection address, access identity, and environment information. The envType parameter specifies the environment in which the data source is used. Valid values of the envType parameter:'."\n" + ."\n" + .'- Dev: development environment'."\n" + ."\n" + .'- Prod: production environment'."\n" + ."\n" + .'The parameters that you need to configure for the data source vary based on the mode in which the data source is added. For more information, see [Data source connection information (ConnectionProperties)](~~2852465~~).', 'type' => 'any', 'example' => '{'."\n" + .' "envType": "Prod",'."\n" + .' "regionId": "cn-beijing",'."\n" + .' "instanceId": "hgprecn-cn-x0r3oun4k001",'."\n" + .' "database": "testdb",'."\n" + .' "securityProtocol": "authTypeNone",'."\n" + .' "authType": "Executor",'."\n" + .' "authIdentity": "1107550004253538"'."\n" + .'}', 'title' => ''], + 'ConnectionPropertiesMode' => ['description' => 'The mode in which the data source is added. The mode varies based on the data source type. Valid values:'."\n" + ."\n" + .'- InstanceMode: instance mode'."\n" + ."\n" + .'- UrlMode: connection string mode'."\n" + ."\n" + .'- CdhMode: CDH cluster mode', 'type' => 'string', 'example' => 'UrlMode', 'title' => ''], + 'Description' => ['description' => 'The description of the data source.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the data source was added. This value is a UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1698286929333', 'title' => ''], + 'CreateUser' => ['description' => 'The ID of the user who adds the data source.', 'type' => 'string', 'example' => '1107550004253538', 'title' => ''], + 'ModifyTime' => ['description' => 'The time when the data source was last modified. This value is a UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1698286929333', 'title' => ''], + 'ModifyUser' => ['description' => 'The ID of the user who modifies the data source.', 'type' => 'string', 'example' => '1107550004253538', 'title' => ''], + 'QualifiedName' => ['description' => 'The unique business key of the data source. For example, the unique business key of a Hologres data source is in the `${tenantOwnerId}:${regionId}:${type}:${instanceId}:${database}` format.', 'type' => 'string', 'example' => '1107550004253538:cn-beijing:holo:hgprecn-cn-x0r3oun4k001:testdb', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4CDF7B72-020B-542A-8465-21CFFA81****\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'UpdateResource', - ], - 'MoveResource' => [ - 'summary' => 'Moves a file resource to a path in DataStudio.', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9252F32F-D855-549E-8898-61CF5A733050\\",\\n \\"DataSource\\": {\\n \\"Id\\": 16738,\\n \\"ProjectId\\": 52660,\\n \\"Name\\": \\"test\\",\\n \\"Type\\": \\"hologres\\",\\n \\"ConnectionProperties\\": \\"{\\\\n\\\\t\\\\\\"envType\\\\\\": \\\\\\"Prod\\\\\\",\\\\n\\\\t\\\\\\"regionId\\\\\\": \\\\\\"cn-beijing\\\\\\",\\\\n \\\\\\"instanceId\\\\\\": \\\\\\"hgprecn-cn-x0r3oun4k001\\\\\\",\\\\n \\\\\\"database\\\\\\": \\\\\\"testdb\\\\\\",\\\\n \\\\\\"securityProtocol\\\\\\": \\\\\\"authTypeNone\\\\\\",\\\\n \\\\\\"authType\\\\\\": \\\\\\"Executor\\\\\\",\\\\n \\\\\\"authIdentity\\\\\\": \\\\\\"1107550004253538\\\\\\"\\\\n}\\",\\n \\"ConnectionPropertiesMode\\": \\"UrlMode\\",\\n \\"Description\\": \\"test\\",\\n \\"CreateTime\\": 1698286929333,\\n \\"CreateUser\\": \\"1107550004253538\\",\\n \\"ModifyTime\\": 1698286929333,\\n \\"ModifyUser\\": \\"1107550004253538\\",\\n \\"QualifiedName\\": \\"1107550004253538:cn-beijing:holo:hgprecn-cn-x0r3oun4k001:testdb\\"\\n }\\n}","type":"json"}]', + 'title' => 'GetDataSource', + 'description' => '1. This operation is available for all DataWorks editions.'."\n" + ."\n" + .'2. To call this operation, you must have one of the following roles in DataWorks:'."\n" + ."\n" + .'- Tenant Owner, Workspace Administrator, Deployment, Development, Project Owner, and O\\&M', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetDataSource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetDatabase' => [ + 'summary' => 'Queries the information about a specific database in Data Map.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '235504', - 'abilityTreeNodes' => [ - 'FEATUREdideJ3TPTK', - ], + 'abilityTreeCode' => '267986', + 'abilityTreeNodes' => ['FEATUREdideE9XYA6'], ], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'formData', + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['title' => 'ID', 'description' => 'Database entity ID. You can refer to the response of the ListDatabases operation and [Concepts related to metadata entities](~~2880092~~).'."\n" + ."\n" + .'The format: `${EntityType}:${Instance ID or escaped URL}:${Catalog identifier}:${Database name}`. Use empty strings as placeholders for levels that do not exist.'."\n" + ."\n" + .'> For StarRocks, the catalog identifier is the catalog name. For DLF, the catalog identifier is the catalog ID. For other types, the catalog-level hierarchy is not supported, and an empty string can be used as a placeholder.'."\n" + ."\n" + .'Examples of common ID formats'."\n" + ."\n" + .'- `dlf-database::catalog_id:database_name`'."\n" + ."\n" + .'- `holo-database:instance_id::database_name`'."\n" + ."\n" + .'- `mysql-database:(instance_id|encoded_jdbc_url)::database_name`'."\n" + ."\n" + .'>'."\n" + ."\n" + .'- `catalog_id`: The ID of the DLF catalog.'."\n" + ."\n" + .'- `instance_id`: The instance ID, which is required when the data source is registered in instance mode.'."\n" + ."\n" + .'- `encoded_jdbc_url`: The encoded JDBC connection string, which is required when the data source is registered in connection-string mode.'."\n" + ."\n" + .'- `database_name`: The database name.', 'type' => 'string', 'required' => true, 'example' => 'dlf-database::catalog_id:database_name'], + ], + ], + 'responses' => [ + 200 => [ '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 can use this parameter to specify the DataWorks workspace on which you want to perform the API operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10000', + 'title' => 'Schema of Response', + 'description' => 'The response.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1AFAE64E-D1BE-432B-A9****'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'Database' => ['description' => 'The database details.', '$ref' => '#/components/schemas/Database', 'title' => '', 'example' => ''], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AFAE64E-D1BE-432B-A9****\\",\\n \\"Success\\": true,\\n \\"Database\\": {\\n \\"Id\\": \\"holo-database:h-xxxx::test_db\\",\\n \\"Name\\": \\"test_db\\",\\n \\"Comment\\": \\"test comment\\",\\n \\"LocationUri\\": \\"oss://test-bucket/test_db\\",\\n \\"ParentMetaEntityId\\": \\"holo:h-xxxx\\",\\n \\"CreateTime\\": 1736852168000,\\n \\"ModifyTime\\": 1736852168000\\n }\\n}","type":"json"}]', + 'title' => 'GetDatabase', + 'description' => '1. DataWorks Basic Edition or a higher edition is required.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'Id', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The unique identifier of the Data Studio file resource.'."\n" - ."\n" - .'> This field is of the Long type in SDK versions prior to 8.0.0, and of the String type in SDK versions 8.0.0 and later. This change does not affect normal SDK usage; the parameter will still be returned according to the type defined in the SDK. However, compilation failures may occur due to the type change only when upgrading the SDK across version 8.0.0. In this case, you must manually update the data type.', - 'type' => 'string', - 'required' => true, - 'example' => '652567824470354XXXX', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetDatabase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'GetDataset' => [ + 'summary' => 'Gets the details of a dataset.', + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdideXGTG91'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ [ - 'name' => 'Path', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The unique identifier of the Data Studio file resource.'."\n" - ."\n" - .'> Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. However, compilation failures may occur due to the type change only when upgrading the SDK across version 8.0.0. In this case, you must manually update the data type.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'root/demo', - ], + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The dataset ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'dataworks-dataset:3pXXXb8o0ngr07njhps1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The schema of the response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'F332BED4-DD73-5972-A9C2-642BA6CFXXXX', - ], - '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 ID of the request.', 'type' => 'string', 'example' => '204EAF68-CCE3-5112-8DA0-E7A60F02XXXX'], + 'Success' => ['description' => 'Indicates whether the request succeeded.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'Dataset' => ['description' => 'The dataset information.', '$ref' => '#/components/schemas/Dataset', 'title' => '', 'example' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F332BED4-DD73-5972-A9C2-642BA6CFXXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'MoveResource', - ], - 'RenameResource' => [ - 'summary' => 'Renames a file resource in DataStudio.', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetDataset', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetDataset', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"204EAF68-CCE3-5112-8DA0-E7A60F02XXXX\\",\\n \\"Success\\": true,\\n \\"Dataset\\": {\\n \\"Id\\": \\"dataworks-dataset:1gxxxqjx155usz3hrv\\",\\n \\"Name\\": \\"test_dataset\\",\\n \\"Comment\\": \\"测试数据集\\",\\n \\"ProjectId\\": 123456,\\n \\"Origin\\": \\"DataWorks\\",\\n \\"DataType\\": \\"COMMON\\",\\n \\"StorageType\\": \\"OSS\\",\\n \\"CreatorId\\": \\"210484359\\",\\n \\"Readme\\": \\"## introduction\\",\\n \\"LatestVersion\\": {\\n \\"Id\\": \\"dataworks-datasetVersion:0gfxxxjx155usz3hrv:1\\",\\n \\"DatasetId\\": \\"dataworks-datasetVersion:0gfxxxjx155usz3hrv\\",\\n \\"Comment\\": \\"初始版本\\",\\n \\"CreatorId\\": \\"17815XXX61016173\\",\\n \\"VersionNumber\\": 1,\\n \\"StorageType\\": \\"OSS\\",\\n \\"Url\\": \\"oss://test-oss-bucket/test_dir/\\",\\n \\"MountPath\\": \\"/mnt/data\\",\\n \\"CreateTime\\": 1736756055000,\\n \\"ModifyTime\\": 1736756055000,\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"ImportInfo\\": {\\n \\"key\\": \\"None\\"\\n }\\n },\\n \\"CreateTime\\": 1736756055000,\\n \\"ModifyTime\\": 1736756055000,\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'GetDatasetVersion' => [ + 'summary' => 'Gets information for a given dataset version.', + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '235503', - 'abilityTreeNodes' => [ - 'FEATUREdideJ3TPTK', - ], + 'abilityTreeNodes' => ['FEATUREdideXGTG91'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], '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 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, - 'example' => '10000', - ], - ], [ 'name' => 'Id', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The unique identifier of the Data Studio file resource.'."\n" - ."\n" - .'> This field is of the Long type in SDK versions prior to 8.0.0, and of the String type in SDK versions 8.0.0 and later. This change does not affect normal SDK usage; the parameter will still be returned according to the type defined in the SDK. However, compilation failures may occur due to the type change only when upgrading the SDK across version 8.0.0. In this case, you must manually update the data type.', - 'type' => 'string', - 'required' => true, - 'example' => '543217824470354XXXX', - ], - ], - [ - 'name' => 'Name', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The unique identifier of the Data Studio file resource.'."\n" - ."\n" - .'> Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Rename', - ], + 'in' => 'query', + 'schema' => ['description' => 'The dataset version ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => ' '."\n" + .'dataworks-datasetVersion:3pXXXb8o0ngr07njhps1'."\n" + .':2'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '4CDF7B72-020B-542A-8465-21CFFA8XXXXX', - ], - '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' => 'Id of the request', 'type' => 'string', 'example' => '4CDF7B72-020B-542A-8465-21CFFA8XXXXX'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'DatasetVersion' => ['description' => 'The dataset version.', '$ref' => '#/components/schemas/DatasetVersion', 'title' => '', 'example' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4CDF7B72-020B-542A-8465-21CFFA8XXXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'RenameResource', - ], - 'GetResource' => [ - 'summary' => 'Queries the information about a file resource.', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetDatasetVersion', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetDatasetVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4CDF7B72-020B-542A-8465-21CFFA8XXXXX\\",\\n \\"Success\\": true,\\n \\"DatasetVersion\\": {\\n \\"Id\\": \\"dataworks-datasetVersion:0gfxxxjx155usz3hrv:1\\",\\n \\"DatasetId\\": \\"dataworks-datasetVersion:0gfxxxjx155usz3hrv\\",\\n \\"Comment\\": \\"初始版本\\",\\n \\"CreatorId\\": \\"17815XXX61016173\\",\\n \\"VersionNumber\\": 1,\\n \\"StorageType\\": \\"OSS\\",\\n \\"Url\\": \\"oss://test-oss-bucket/test_dir/\\",\\n \\"MountPath\\": \\"/mnt/data\\",\\n \\"CreateTime\\": 1736756055000,\\n \\"ModifyTime\\": 1736756055000,\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"ImportInfo\\": {\\n \\"key\\": \\"None\\"\\n }\\n }\\n}","type":"json"}]', + ], + 'GetDeploymentPackage' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -16013,147 +19503,134 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '235473', - 'abilityTreeNodes' => [ - 'FEATUREdideJ3TPTK', - ], + 'abilityTreeCode' => '269309', + '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' => false, - 'example' => '10000', - ], + '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 ID. This parameter identifies the DataWorks workspace for this API call.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10000', 'title' => ''], ], [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => 'The unique identifier of the file resource.'."\n" - ."\n" - .'> This field is of type Long in SDK versions prior to 8.0.0, and of type String in SDK version 8.0.0 and later. This change does not affect the normal use of the SDK; parameters are still returned according to the type defined in the SDK. Compilation failures due to the type change may occur only when upgrading the SDK across version 8.0.0, in which case users need to manually correct the data type.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '860438872620113XXXX', - 'title' => '', - ], + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => ['description' => 'The unique identifier of the DataWorks workspace. This is the identifier shown in the workspace switcher at the top of the Data Studio page.'."\n" + ."\n" + .'Either this parameter or ProjectId must be specified to determine which DataWorks workspace this API call operates on.', 'type' => 'string', 'required' => false, 'example' => 'dw_project', 'title' => ''], + ], + [ + 'name' => 'DeploymentId', + 'in' => 'formData', + 'schema' => ['description' => 'The deployment package ID. This ID is generated when you call [SubmitFile](~~173944~~) or [DeployFile](~~173956~~).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1000000001', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'E871F6C0-2EFF-5790-A00D-C57543EEXXXX', - ], - 'Resource' => [ - 'description' => 'File resource details.'."\n", + '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. Use this ID to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => '0bc1ec92159376****', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call succeeded. Valid values:'."\n" + ."\n" + .'- **true**'."\n" + ."\n" + .'- **false**', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The deployment package details.', 'type' => 'object', 'properties' => [ - 'ProjectId' => [ - 'description' => 'The ID of the workspace to which the file resource belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000', - ], - 'Name' => [ - 'description' => 'The name of the file resource.'."\n", - 'type' => 'string', - 'example' => 'OpenAPI_Test_Resource. py', - ], - 'Owner' => [ - 'description' => 'The owner of the file resource.'."\n", - 'type' => 'string', - 'example' => '110755000425XXXX', - ], - 'CreateTime' => [ - 'description' => 'The time when the file resource was created. This value is a UNIX timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1700539206000', - ], - 'ModifyTime' => [ - 'description' => 'The time when the file resource was last modified. This value is a UNIX timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1700539206000', + 'Deployment' => [ + 'description' => 'The deployment package details.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The current status of the deployment package. Valid values: 0 (ready), 1 (succeeded), and 2 (failed).', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ErrorMessage' => ['description' => 'The detailed error message when the deployment package fails (status is 2).', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'FromEnvironment' => ['description' => 'The environment where the deployment is executed. Valid values: 0 (local) and 1 (development).', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ToEnvironment' => ['description' => 'The target environment for the deployment. Valid values: 1 (development) and 2 (production).', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'CheckingStatus' => ['description' => 'The validation status of nodes in the deployment package. For packages deployed to the development environment (toEnviroment=1), you can only proceed to deploy to production if the package Status is 1 (succeeded) and CheckingStatus is empty (validation complete).'."\n" + ."\n" + .'- 7: Validation failed'."\n" + ."\n" + .'- 8: Validation in progress', 'type' => 'integer', 'format' => 'int32', 'example' => '7', 'title' => ''], + 'CreateTime' => ['description' => 'The timestamp (in milliseconds) when the deployment package was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1593877765000', 'title' => ''], + 'HandlerId' => ['description' => 'The Alibaba Cloud account ID of the user who executed the deployment.', 'type' => 'string', 'example' => '2003****', 'title' => ''], + 'CreatorId' => ['description' => 'The Alibaba Cloud account ID of the user who created the deployment package.', 'type' => 'string', 'example' => '20030****', 'title' => ''], + 'ExecuteTime' => ['description' => 'The timestamp (in milliseconds) when the deployment started.', 'type' => 'integer', 'format' => 'int64', 'example' => '1593877765000', 'title' => ''], + 'Name' => ['description' => 'The deployment package name, displayed on the Deploy Center > Deployment Packages page.', 'type' => 'string', 'example' => 'ods_user_info_d-2020-07-04_20030****', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'Spec' => [ - 'description' => 'The FlowSpec field information about the file resource. For more information, see [FlowSpec](https://github.com/aliyun/alibabacloud-dataworks-tool-dflow).'."\n", - 'type' => 'string', - 'example' => '{'."\n" - .' "version": "1.1.0",'."\n" - .' "kind": "Resource",'."\n" - .' "spec": {'."\n" - .' "fileResources": ['."\n" - .' {'."\n" - .' "name": "OpenAPI_Test_Resource.py",'."\n" - .' "id": "631478864897630XXXX",'."\n" - .' "script": {'."\n" - .' "content": "",'."\n" - .' "path": "XX/OpenAPI_Test/Resource_Test/OpenAPI_Test_Resource.py",'."\n" - .' "runtime": {'."\n" - .' "command": "ODPS_PYTHON"'."\n" - .' }'."\n" - .' },'."\n" - .' "type": "python",'."\n" - .' "file": {'."\n" - .' "storage": {}'."\n" - .' },'."\n" - .' "datasource": {'."\n" - .' "name": "odps_first",'."\n" - .' "type": "odps"'."\n" - .' },'."\n" - .' "metadata": {'."\n" - .' "owner": "110755000425XXXX"'."\n" - .' }'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .'}', - ], - 'Id' => [ - 'description' => 'The unique identifier of the file resource.'."\n" - ."\n" - .'> Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.'."\n", - 'type' => 'string', - 'example' => '860438872620113XXXX', + 'DeployedItems' => [ + 'description' => 'The deployment item details.', + 'type' => 'array', + 'items' => [ + 'description' => 'The deployment item details.', + 'type' => 'object', + 'properties' => [ + 'FileId' => ['description' => 'The file ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '5076****', 'title' => ''], + 'FileVersion' => ['description' => 'The file version.', 'type' => 'integer', 'format' => 'int64', 'example' => '7', 'title' => ''], + 'Status' => ['description' => '- UNPUBLISHED(0)'."\n" + ."\n" + .'- SUCCESS(1)'."\n" + ."\n" + .'- ERROR(2)'."\n" + ."\n" + .'- CLONED(3)'."\n" + ."\n" + .'- DEPLOY\\_ERROR(4)'."\n" + ."\n" + .'- CLONING(5)'."\n" + ."\n" + .'- REJECT(6)', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E871F6C0-2EFF-5790-A00D-C57543EEXXXX\\",\\n \\"Resource\\": {\\n \\"ProjectId\\": 10000,\\n \\"Name\\": \\"OpenAPI_Test_Resource. py\\",\\n \\"Owner\\": \\"110755000425XXXX\\",\\n \\"CreateTime\\": 1700539206000,\\n \\"ModifyTime\\": 1700539206000,\\n \\"Spec\\": \\"{\\\\n \\\\\\"version\\\\\\": \\\\\\"1.1.0\\\\\\",\\\\n \\\\\\"kind\\\\\\": \\\\\\"Resource\\\\\\",\\\\n \\\\\\"spec\\\\\\": {\\\\n \\\\\\"fileResources\\\\\\": [\\\\n {\\\\n \\\\\\"name\\\\\\": \\\\\\"OpenAPI_Test_Resource.py\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"631478864897630XXXX\\\\\\",\\\\n \\\\\\"script\\\\\\": {\\\\n \\\\\\"content\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"path\\\\\\": \\\\\\"XX/OpenAPI_Test/Resource_Test/OpenAPI_Test_Resource.py\\\\\\",\\\\n \\\\\\"runtime\\\\\\": {\\\\n \\\\\\"command\\\\\\": \\\\\\"ODPS_PYTHON\\\\\\"\\\\n }\\\\n },\\\\n \\\\\\"type\\\\\\": \\\\\\"python\\\\\\",\\\\n \\\\\\"file\\\\\\": {\\\\n \\\\\\"storage\\\\\\": {}\\\\n },\\\\n \\\\\\"datasource\\\\\\": {\\\\n \\\\\\"name\\\\\\": \\\\\\"odps_first\\\\\\",\\\\n \\\\\\"type\\\\\\": \\\\\\"odps\\\\\\"\\\\n },\\\\n \\\\\\"metadata\\\\\\": {\\\\n \\\\\\"owner\\\\\\": \\\\\\"110755000425XXXX\\\\\\"\\\\n }\\\\n }\\\\n ]\\\\n }\\\\n}\\",\\n \\"Id\\": \\"860438872620113XXXX\\"\\n }\\n}","type":"json"}]', - 'title' => 'GetResource', - ], - 'ListResources' => [ - 'summary' => 'Queries a list of file resources in DataStudio. You can also specify filter conditions to query specific file resources.', - '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.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', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"You have no permission.\\",\\n \\"RequestId\\": \\"0bc1ec92159376****\\",\\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"}]', + 'title' => 'GetDeploymentPackage', + 'summary' => 'Queries the information about a deployment package.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'GetFile' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -16162,865 +19639,1415 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '235477', - 'abilityTreeNodes' => [ - 'FEATUREdideJ3TPTK', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '267409', + '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, - 'example' => '10002', - ], - ], - [ - 'name' => 'Owner', - 'in' => 'query', - 'schema' => [ - '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.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '110755000425XXXX', - ], - ], - [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'description' => 'The resource type. This parameter specifies a filter condition.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Python'."\n" - .'* Jar'."\n" - .'* Archive'."\n" - .'* File'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Archive' => 'Archive', - 'Jar' => 'Jar', - 'File' => 'File', - 'Python' => 'Python', - ], - 'example' => 'python', - ], + '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 configuration page to obtain the workspace ID.'."\n" + ."\n" + .'You must specify either this parameter or the ProjectIdentifier parameter to identify the DataWorks workspace for this API call.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10000', 'title' => ''], ], [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the file resource. Supports fuzzy search.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + '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 configuration page to obtain the workspace name.'."\n" + ."\n" + .'You must specify either this parameter or the ProjectId parameter to identify the DataWorks workspace for this API call.', 'type' => 'string', 'required' => false, 'example' => 'dw_project', 'title' => ''], ], [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number of the data to retrieve, used for pagination.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'name' => 'FileId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the file. You can invoke the [ListFiles](~~173942~~) API to query the ID of the corresponding file.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100000001', 'title' => ''], ], [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number of the data to retrieve, used for pagination.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '10', - 'example' => '10', - 'default' => '10', - ], + 'name' => 'NodeId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the scheduling node. You can invoke the [ListFiles](~~173942~~) API to obtain the node ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '200000001', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '99EBE7CF-69C0-5089-BE3E-79563C31XXXX', - ], - 'PagingInfo' => [ - 'description' => 'The pagination information.'."\n", + 'HttpStatusCode' => ['description' => 'HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'ErrorMessage' => ['description' => 'Error message.', 'type' => 'string', 'example' => 'The connection does not exist.', 'title' => ''], + 'RequestId' => ['description' => 'Request ID. Used for troubleshooting when a fault occurs.', 'type' => 'string', 'example' => '0000-ABCD-EFG****', 'title' => ''], + 'ErrorCode' => ['description' => 'Error code.', 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the invocation succeeded. Valid values:'."\n" + ."\n" + .'- true: The invocation succeeded.'."\n" + ."\n" + .'- false: Failed to invoke.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'Details of the file.', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '131', - ], - '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', + 'File' => [ + 'description' => 'Basic information about the file.', + 'type' => 'object', + 'properties' => [ + 'CommitStatus' => ['description' => 'The current commit status of the file. Valid values:'."\n" + ."\n" + .'- 0: The latest code has not been submitted.'."\n" + ."\n" + .'- 1: The latest code has been submitted.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'AutoParsing' => ['description' => 'Indicates whether automatic parsing is enabled for the file. Valid values:'."\n" + ."\n" + .'- true: The code in the file is automatically parsed.'."\n" + ."\n" + .'- false: The code in the file is not automatically parsed.'."\n" + ."\n" + .'This parameter corresponds to the "Code Parsing" option in the DataWorks console (https\\://workbench.data.aliyun.com/console) when you select "Same Cycle" under Schedule Configuration > Schedule Dependency for a Data Development job.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Owner' => ['description' => 'Alibaba Cloud User ID of the file owner.', 'type' => 'string', 'example' => '7775674356****', 'title' => ''], + 'CreateTime' => ['description' => 'UNIX timestamp when the file was created, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1593879116000', 'title' => ''], + 'FileType' => ['description' => 'The code type of the file. Different file types use different code. For more information, see [DataWorks Edge Zone Collection](~~600169~~).', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'CurrentVersion' => ['description' => 'Version number of the latest submitted version of the file.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'BizId' => ['description' => 'The ID of the Business Process to which the file belongs. This field is deprecated. Use the BusinessId field instead.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000001', 'title' => ''], + 'LastEditUser' => ['description' => 'The Alibaba Cloud User ID of the user who last edited the file.', 'type' => 'string', 'example' => '424732****'."\n", 'title' => ''], + 'FileName' => ['description' => 'Name of the file.', 'type' => 'string', 'example' => 'ods_user_info_d', 'title' => ''], + 'ConnectionName' => ['description' => 'The name of the data source used when executing the job corresponding to the file.', 'type' => 'string', 'example' => 'odps_source', 'title' => ''], + 'UseType' => ['description' => 'The function module to which the file belongs. Valid values:'."\n" + ."\n" + .'- NORMAL: Data Development.'."\n" + ."\n" + .'- MANUAL: One-time task.'."\n" + ."\n" + .'- MANUAL\\_BIZ: Manually triggered workflow.'."\n" + ."\n" + .'- SKIP: Dry-run scheduling in Data Development.'."\n" + ."\n" + .'- ADHOCQUERY: Ad-hoc query.'."\n" + ."\n" + .'- COMPONENT: Widget Management.', 'type' => 'string', 'example' => 'NORMAL', 'title' => ''], + 'FileFolderId' => ['description' => 'The ID of the folder to which the file belongs.', 'type' => 'string', 'example' => '2735c2****', 'title' => ''], + 'ParentId' => ['description' => 'If the current file is an internal file of a composite edge zone file, this field identifies the ID of the corresponding composite edge zone file.', 'type' => 'integer', 'format' => 'int64', 'example' => '-1', 'title' => ''], + 'CreateUser' => ['description' => 'The Alibaba Cloud User ID of the file creator.', 'type' => 'string', 'example' => '424732****'."\n", 'title' => ''], + 'IsMaxCompute' => ['description' => 'Indicates whether the resource file needs to be uploaded to MaxCompute.'."\n" + .'Configure this parameter only when the file is a MaxCompute resource file.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'BusinessId' => ['description' => 'The Business Process ID of the file.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000001', 'title' => ''], + 'FileDescription' => ['description' => 'The description of the file.', 'type' => 'string', 'example' => 'My first DataWorks file', 'title' => ''], + 'DeletedStatus' => ['description' => 'The deletion status of the file. Valid values:'."\n" + ."\n" + .'- NORMAL: Not deleted.'."\n" + ."\n" + .'- RECYCLE\\_BIN: In the recycle bin.'."\n" + ."\n" + .'- DELETED: Deleted.', 'type' => 'string', 'example' => 'RECYCLE', 'title' => ''], + 'LastEditTime' => ['description' => 'The UNIX timestamp of the most recent edit to the file, in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1593879116000', 'title' => ''], + 'Content' => ['description' => 'The code of the file.', 'type' => 'string', 'example' => 'SHOW TABLES;', 'title' => ''], + 'NodeId' => ['description' => 'The ID of the scheduling task generated in the CDN mapping system after the file is submitted.', 'type' => 'integer', 'format' => 'int64', 'example' => '300001', 'title' => ''], + 'AdvancedSettings' => ['description' => 'Advanced configuration of the job.'."\n" + ."\n" + .'This parameter corresponds to "Advanced Settings" in the right-side navigation bar on the editing page of an EMR Data Development job in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n" + ."\n" + .'> Currently, EMR Shell jobs do not support advanced parameters.'."\n" + ."\n" + .'For details about advanced parameters for different EMR job types, see [EMR Job Development](~~473077~~).', 'type' => 'string', 'example' => '{\\"priority\\":\\"1\\",\\"ENABLE_SPARKSQL_JDBC\\":false,\\"FLOW_SKIP_SQL_ANALYZE\\":false,\\"queue\\":\\"default\\"}', 'title' => ''], + 'FileId' => ['description' => 'The ID of the file.', 'type' => 'integer', 'format' => 'int64', 'example' => '100000001', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'Resources' => [ - 'description' => 'The returned resource list.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The elements in the resource list.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '资源名称', - 'description' => 'The resource name.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'math.py', - 'pattern' => '', - 'default' => '', - ], - 'ProjectId' => [ - 'title' => '项目id', - 'description' => 'The ID of the DataWorks workspace. To obtain the workspace ID, log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and navigate to the workspace configuration page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'deprecated' => false, - 'example' => '344247', - 'pattern' => '', - 'default' => '', - ], - 'Owner' => [ - 'title' => '责任人', - 'description' => 'The owner of the file resource.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => '110755000425XXXX', - 'pattern' => '', - 'default' => '', - ], - 'CreateTime' => [ - 'description' => 'The time when the file resource was created. This value is a UNIX timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1724505917000', - ], - 'ModifyTime' => [ - 'title' => '修改时间', - 'description' => 'The timestamp when the file resource was last modified.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'deprecated' => false, - 'example' => '1724505917000', - 'pattern' => '', - 'default' => '', - ], - 'DataSource' => [ - 'title' => '数据源', - 'description' => 'The data source.'."\n", + 'NodeConfiguration' => [ + 'description' => 'The schedule configuration of the file.', + 'type' => 'object', + 'properties' => [ + 'RerunMode' => ['description' => 'Rerun property. Valid values:'."\n" + ."\n" + .'- ALL\\_ALLOWED: The job can be rerun regardless of whether it previously Succeeded or failed.'."\n" + ."\n" + .'- FAILURE\\_ALLOWED: The job cannot be rerun if it previously Succeeded, but can be rerun if it previously failed.'."\n" + ."\n" + .'- ALL\\_DENIED: The job cannot be rerun regardless of whether it previously Succeeded or failed.'."\n" + ."\n" + .'This parameter corresponds to the "Scan Configuration > Time Properties > Rerun Property" setting for a Data Development job in the [DataWorks console](https://workbench.data.aliyun.com/console).', 'type' => 'string', 'example' => 'ALL_ALLOWED', 'title' => ''], + 'SchedulerType' => ['description' => 'The schedule type. Valid values:'."\n" + ."\n" + .'- NORMAL: Normal scheduling task.'."\n" + ."\n" + .'- MANUAL: One-time task, which is not included in regular scheduling and corresponds to a node in a manually triggered workflow.'."\n" + ."\n" + .'- PAUSE: Paused task.'."\n" + ."\n" + .'- SKIP: Dry-run task, which is included in regular scheduling but is immediately marked as Succeeded when scheduled.', 'type' => 'string', 'example' => 'NORMAL', 'title' => ''], + 'Stop' => ['description' => 'Indicates whether to skip execution. Valid values:'."\n" + ."\n" + .'- true: Skip execution.'."\n" + ."\n" + .'- false: Do not skip execution.'."\n" + ."\n" + .'This parameter corresponds to the setting "Schedule Type" under "Schedule Configuration > Time Properties" for a Data Development job in the [DataWorks console](https://workbench.data.aliyun.com/console), when it is set to "skip execution".', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'ParaValue' => ['description' => 'Schedule parameter.'."\n" + ."\n" + .'This parameter corresponds to the "Scan Configuration > Parameters" setting for a Data Development job in the [DataWorks console](https://workbench.data.aliyun.com/console). You can refer to the [Schedule Parameters](~~137548~~) documentation for configuration details.', 'type' => 'string', 'example' => 'a=x b=y', 'title' => ''], + 'StartEffectDate' => ['description' => 'The UNIX timestamp (in milliseconds) indicating when automatic scheduling starts.'."\n" + ."\n" + .'This parameter corresponds to the start time (as a UNIX timestamp in milliseconds) configured under "Schedule Configuration > Time Properties > Effective Date" for a Data Development job in the [DataWorks console](https://workbench.data.aliyun.com/console).', 'type' => 'integer', 'format' => 'int64', 'example' => '936923400000', 'title' => ''], + 'EndEffectDate' => ['description' => 'The UNIX timestamp, in milliseconds, when automatic scheduling stops.'."\n" + ."\n" + .'This parameter corresponds to the millisecond UNIX timestamp of the end time configured in the "Scan Configuration > Time Properties > Effective Date" setting for a Data Development job in the [DataWorks console](https://workbench.data.aliyun.com/console).', 'type' => 'integer', 'format' => 'int64', 'example' => '4155787800000', 'title' => ''], + 'CycleType' => ['description' => 'The type of recurrence, including NOT\\_DAY (minute, hour) and DAY (day, week, month).'."\n" + ."\n" + .'This parameter corresponds to "Schedule Configuration > Time Properties > Recurrence" for a Data Development job in the [DataWorks console](https://workbench.data.aliyun.com/console).', 'type' => 'string', 'example' => 'DAY', 'title' => ''], + 'DependentNodeIdList' => ['description' => 'When the DependentType parameter is set to USER\\_DEFINE, this parameter specifies the IDs of the nodes on which the current file depends. Separate multiple node IDs with commas (,).'."\n" + ."\n" + .'This parameter corresponds to the configuration when, in the [DataWorks console](https://workbench.data.aliyun.com/console), the "Schedule Configuration > Schedule Dependency" of a Data Development job is set to "Previous Cycle" and the dependency option is set to "Other Nodes".', 'type' => 'string', 'example' => '5,10,15,20', 'title' => ''], + 'ResourceGroupId' => ['description' => 'The resource group used when the file is published as a Job and executed. You can call [ListResourceGroups](~~173913~~) to obtain the list of available resource groups in the workspace.', 'type' => 'integer', 'format' => 'int64', 'example' => '375827434852437', 'title' => ''], + 'DependentType' => ['description' => 'The method of depending on the previous cycle. Valid values:'."\n" + ."\n" + .'- SELF: The dependency is the current node itself.'."\n" + ."\n" + .'- CHILD: The dependency is direct child nodes.'."\n" + ."\n" + .'- USER\\_DEFINE: The dependency is other specified nodes.'."\n" + ."\n" + .'- NONE: No dependency is selected, meaning the node does not depend on the previous cycle.', 'type' => 'string', 'example' => 'USER_DEFINE', 'title' => ''], + 'AutoRerunTimes' => ['description' => 'The number of automatic reruns after an error.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'AutoRerunIntervalMillis' => ['description' => 'The time interval between automatic reruns after an error, in milliseconds.'."\n" + ."\n" + .'This parameter corresponds to the "Rerun Interval" setting under "Schedule Configuration > Time Properties > Auto Rerun on Error" for a Data Development job in the [DataWorks console](https://workbench.data.aliyun.com/console).
'."\n" + .'Note that the time unit for "Rerun Interval" in the console is minutes; convert the time accordingly when invoking the API.', 'type' => 'integer', 'format' => 'int32', 'example' => '120000', 'title' => ''], + 'CronExpress' => ['description' => 'The Cron Expression for timed scheduling of the file.', 'type' => 'string', 'example' => '00 05 00 * * ?', 'title' => ''], + 'InputList' => [ + 'description' => 'Information about outputs from upstream files on which this file depends.', + 'type' => 'array', + 'items' => [ + 'description' => 'Information about outputs from upstream files on which this file depends.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => '数据源名称', - 'description' => 'The name of the data source.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'odps_first', - 'pattern' => '', - 'default' => '', - ], - 'Type' => [ - 'title' => '数据源类型', - 'description' => 'The type of the data source.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'odps', - 'pattern' => '', - 'default' => '', - ], + 'Input' => ['description' => 'The output name of the upstream file on which this file depends.'."\n" + ."\n" + .'This parameter corresponds to "Parent Node Output Name" when "Same Cycle" is selected under "Schedule Configuration > Schedule Dependency" for a Data Development job in the [DataWorks console](https://workbench.data.aliyun.com/console).', 'type' => 'string', 'example' => 'project.001_out', 'title' => ''], + 'ParseType' => ['description' => 'The method for configuring file dependencies. Valid values:'."\n" + ."\n" + .'- MANUAL: Manually configured.'."\n" + ."\n" + .'- AUTO: Automatically parsed.', 'type' => 'string', 'example' => 'MANUAL', 'title' => ''], ], - 'deprecated' => false, + 'title' => '', + 'example' => '', ], - 'Script' => [ - 'title' => '脚本信息', - 'description' => 'The script information.'."\n", + 'title' => '', + 'example' => '', + ], + 'OutputList' => [ + 'description' => 'Output information of the file.', + 'type' => 'array', + 'items' => [ + 'description' => 'Output information of the file.', 'type' => 'object', 'properties' => [ - 'Path' => [ - 'title' => '脚本路径', - 'description' => 'The script path.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'root/demo', - 'pattern' => '', - 'default' => '', - ], - 'Runtime' => [ - 'title' => '运行时', - 'description' => 'Runtime'."\n", - 'type' => 'object', - 'properties' => [ - 'Command' => [ - 'title' => '命令', - 'description' => 'Command. This parameter indicates the file type.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'ODPS_PYTHON', - 'pattern' => '', - 'default' => '', - ], - ], - 'deprecated' => false, - ], - 'Id' => [ - 'description' => 'The ID of the script.'."\n" - ."\n" - .'> This field is of type Long in SDK versions prior to 8.0.0, and of type String in SDK version 8.0.0 and later. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => '123348864897630XXXX', - 'title' => '', - ], - ], - 'deprecated' => false, - 'required' => false, - ], - 'Type' => [ - 'title' => '资源类型', - 'description' => 'The resource type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Python'."\n" - .'* Jar'."\n" - .'* Archive'."\n" - .'* File'."\n", - 'type' => 'string', - 'deprecated' => false, - 'enumValueTitles' => [ - 'Archive' => 'Archive', - 'Jar' => 'Jar', - 'File' => 'File', - 'Python' => 'Python', - ], - 'example' => 'jar', - 'pattern' => '', - 'default' => '', - 'enum' => [ - 'jar', - 'python', - 'file', - 'archive', + 'RefTableName' => ['description' => 'Output value of the file.'."\n" + ."\n" + .'This parameter corresponds to the value in the "Output Table" column when "Same Cycle" is selected under "Scan Configuration > Schedule Dependency" for a Data Development job in the [DataWorks console](https://workbench.data.aliyun.com/console).', 'type' => 'string', 'example' => 'ods_user_info_d', 'title' => ''], + 'Output' => ['description' => 'Output name of the file.'."\n" + ."\n" + .'This parameter corresponds to the value in the "Output Name" column when "Same Cycle" is selected under "Scan Configuration > Schedule Dependency" for a Data Development job in the [DataWorks console](https://workbench.data.aliyun.com/console).', 'type' => 'string', 'example' => 'dw_project.002_out', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'SourceType' => [ - 'title' => '文件资源来源存储类型', - 'description' => 'The source storage type of the file resource.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Local'."\n" - .'* OSS'."\n", - 'type' => 'string', - 'deprecated' => false, - 'enumValueTitles' => [ - 'Local' => 'Local', - 'Oss' => 'Oss', - ], - 'example' => 'local', - 'pattern' => '', - 'default' => '', - 'enum' => [ - 'local', - 'oss', + 'title' => '', + 'example' => '', + ], + 'StartImmediately' => ['description' => 'Indicates whether to start immediately after publishing.'."\n" + ."\n" + .'This parameter corresponds to the "Start Method" setting under "Configuration > Time Properties" in the right-side navigation bar on the editing page for EMR Spark Streaming and EMR Streaming SQL Data Development jobs in the [DataWorks console](https://workbench.data.aliyun.com/console).', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'InputParameters' => [ + 'description' => 'Return Result.', + 'type' => 'array', + 'items' => [ + 'description' => 'Return Result.', + 'type' => 'object', + 'properties' => [ + 'ParameterName' => ['description' => 'The parameter name of the input parameter in the node context. You can reference this parameter in code by using the ${...} syntax.'."\n" + ."\n" + .'This parameter corresponds to the "Parameter Name" field under "Schedule Configuration > Node Context > Input Parameters of This Node" in the [DataWorks console](https://workbench.data.aliyun.com/console).', 'type' => 'string', 'example' => 'input', 'title' => ''], + 'ValueSource' => ['description' => 'The value source of the input parameter in the node context.'."\n" + ."\n" + .'This parameter corresponds to the "Value Source" field under "Schedule Configuration > Node Context > Input Parameters of This Node" in the [DataWorks console](https://workbench.data.aliyun.com/console).', 'type' => 'string', 'example' => 'project_001.parent_node:outputs', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'SourcePath' => [ - 'title' => '文件目标存储路径', - 'description' => 'Source path of the file resource. This parameter is empty if the type is Local.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'XXX/unknown/ide/1/XXX/20240820200851_963a9da676de44ef8d06a6576a8c4d6a.py', - 'pattern' => '', - 'default' => '', - ], - 'TargetType' => [ - 'title' => '文件目标存储类型', - 'description' => 'The destination storage type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Gateway'."\n" - .'* OSS'."\n" - .'* HDFS'."\n", - 'type' => 'string', - 'deprecated' => false, - 'enumValueTitles' => [ - 'Gateway' => 'Gateway', - 'Hdfs' => 'Hdfs', - 'Oss' => 'Oss', - ], - 'example' => 'oss', - 'pattern' => '', - 'default' => '', - 'enum' => [ - 'gateway', - 'oss', - 'hdfs', + 'title' => '', + 'example' => '', + ], + 'OutputParameters' => [ + 'description' => 'Return Result.', + 'type' => 'array', + 'items' => [ + 'description' => 'Return Result.', + 'type' => 'object', + 'properties' => [ + 'ParameterName' => ['description' => 'The parameter name of the output parameter in the node context.'."\n" + ."\n" + .'This parameter corresponds to the "Parameter Name" field under "Schedule Configuration > Node Context > Output Parameters of This Node" for a Data Development job in the [DataWorks console](https://workbench.data.aliyun.com/console).', 'type' => 'string', 'example' => 'output', 'title' => ''], + 'Value' => ['description' => 'The expression of the output parameter in the edge zone context.'."\n" + ."\n" + .'This parameter corresponds to the "Value" field in the "Scan Configuration > Edge Zone Context > Output Parameters of This Node" section for a Data Development job in the [DataWorks console](https://workbench.data.aliyun.com/console).', 'type' => 'string', 'example' => '${bizdate}', 'title' => ''], + 'Type' => ['description' => 'The type of the expression for the edge zone context output parameter. Valid values are as follows:'."\n" + ."\n" + .'- 1: constant'."\n" + ."\n" + .'- 2: variable'."\n" + ."\n" + .'- 3: pass-through variable from a parameter node'."\n" + ."\n" + .'This parameter corresponds to the "Type" field in the "Scan Configuration > Edge Zone Context > Output Parameters of This Node" section for a Data Development job in the [DataWorks console](https://workbench.data.aliyun.com/console).', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Description' => ['description' => 'The description of the output parameter in the edge zone context.', 'type' => 'string', 'example' => 'It\'s a context output parameter.', 'title' => ''], ], - ], - 'TargetPath' => [ - 'title' => '文件来源路径', - 'description' => 'The destination storage path.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'XXX/unknown/ide/1/XXX/20240820200851_963a9da676de44ef8d06a6576a8c4d6a.py', - 'pattern' => '', - 'default' => '', - ], - 'Id' => [ - 'description' => 'The unique identifier of the file resource.'."\n" - ."\n" - .'> Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.'."\n", - 'type' => 'string', - 'example' => '631478864897630XXXX', 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'ApplyScheduleImmediately' => ['description' => 'Whether to apply the schedule configuration immediately after publishing.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'IgnoreParentSkipRunningProperty' => ['description' => 'Schedule Configuration > Previous Cycle > Whether to ignore the upstream dry-run property.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'Timeout' => ['description' => 'Timeout definition for scheduling configuration.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ImageId' => ['description' => 'Custom image ID', 'type' => 'string', 'example' => 'm-bp1h4b5a8ogkbll2f3tr', 'title' => ''], ], + 'title' => '', + 'example' => '', + ], + 'ResourceDownloadLink' => [ + 'description' => 'Resource download link.', + 'type' => 'object', + 'properties' => [ + 'downloadLink' => ['description' => 'Link for downloading the resource.', 'type' => 'string', 'example' => 'http://xx', '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.', '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' => 'Obtain the details of a file ', + 'summary' => 'Retrieves the details of a file.', + '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 \\"File\\": {\\n \\"CommitStatus\\": 0,\\n \\"AutoParsing\\": true,\\n \\"Owner\\": \\"7775674356****\\",\\n \\"CreateTime\\": 1593879116000,\\n \\"FileType\\": 10,\\n \\"CurrentVersion\\": 3,\\n \\"BizId\\": 1000001,\\n \\"LastEditUser\\": \\"424732****\\\\n\\",\\n \\"FileName\\": \\"ods_user_info_d\\",\\n \\"ConnectionName\\": \\"odps_source\\",\\n \\"UseType\\": \\"NORMAL\\",\\n \\"FileFolderId\\": \\"2735c2****\\",\\n \\"ParentId\\": -1,\\n \\"CreateUser\\": \\"424732****\\\\n\\",\\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}","type":"json"}]', + ], + 'GetFileVersion' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '269314', + 'abilityTreeNodes' => ['FEATUREdide8FM783'], + ], + 'parameters' => [ + [ + 'name' => 'FileId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the file. You can obtain the ID of the desired file by calling [ListFiles](~~173942~~).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1000001', 'title' => ''], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the DataWorks workspace. You can click the wrench icon in the upper-right corner of the page to go to the Workspace Management page and view it.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '1000011', 'title' => ''], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => ['description' => 'The unique identifier of the DataWorks workspace, which is the English identifier displayed at the top of the Data Development page when you switch workspaces.'."\n" + ."\n" + .'You must specify either this parameter or the ProjectId parameter to identify the DataWorks workspace for this API call.', 'type' => 'string', 'required' => false, 'example' => 'dw_project', 'title' => ''], + ], + [ + 'name' => 'FileVersion', + 'in' => 'formData', + 'schema' => ['description' => 'The version of the file to query.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '2', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => '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 unique ID of this request. If an error occurs, you can troubleshoot the issue using this ID.', 'type' => 'string', 'example' => '0000-ABCD-EFG****', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the API call succeeded.'."\n" + ."\n" + .'- true: Succeeded.'."\n" + ."\n" + .'- false: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'Version details of the file.', + 'type' => 'object', + 'properties' => [ + 'FileContent' => ['description' => 'The code of the file for this version.', 'type' => 'string', 'example' => 'SHOW TABLES;', 'title' => ''], + 'IsCurrentProd' => ['description' => 'Indicates whether this file version is the latest version in the current production environment.'."\n" + ."\n" + .'- true: It is the latest version.'."\n" + ."\n" + .'- false: It is not the latest version.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Status' => ['description' => 'Current status of the file version. Valid values:'."\n" + ."\n" + .'- COMMITTING (Submitting)'."\n" + ."\n" + .'- COMMITTED or CHECK\\_OK (Submitted)'."\n" + ."\n" + .'- PACKAGED (Preparing for publish)'."\n" + ."\n" + .'- DEPLOYING (In Publish)'."\n" + ."\n" + .'- DEPLOYED (Published)'."\n" + ."\n" + .'- CANCELLED (Publish canceled)', 'type' => 'string', 'example' => 'COMMITTED', 'title' => ''], + 'NodeContent' => ['description' => 'The scan configuration at the time this file version was generated.', 'type' => 'string', 'example' => '{"cycleType":0,"cronExpress":"00 05 00 * * ?"}', 'title' => ''], + 'CommitUser' => ['description' => 'User ID of the Alibaba Cloud user who generated this file version.', 'type' => 'string', 'example' => ' '."\n" + .'7384234****'."\n", 'title' => ''], + 'Comment' => ['description' => 'Description of this file version.', 'type' => 'string', 'example' => 'Second version submission', 'title' => ''], + 'FilePropertyContent' => ['description' => 'Basic information of the file used to generate this file version.', 'type' => 'string', 'example' => '{"fileName":"ods_user_info_d","fileType":10}', 'title' => ''], + 'FileName' => ['description' => 'File name used to generate this file version.', 'type' => 'string', 'example' => 'ods_user_info_d', 'title' => ''], + 'UseType' => ['description' => 'Function module to which the file belongs. Valid values:'."\n" + ."\n" + .'- 0: NORMAL (Data Development)'."\n" + ."\n" + .'- 1: MANUAL (one-time task)'."\n" + ."\n" + .'- 2: MANUAL\\_BIZ (manual pipeline)'."\n" + ."\n" + .'- 3: SKIP (Dry-Run scheduling in Data Development)'."\n" + ."\n" + .'- 10: ADHOCQUERY (Ad Hoc Query)'."\n" + ."\n" + .'- 30: COMPONENT (widget Management)', 'type' => 'string', 'example' => '0', 'title' => ''], + 'ChangeType' => ['description' => 'The change type of this file version, including CREATE, UPDATE, and DELETE.', 'type' => 'string', 'example' => 'UPDATE', 'title' => ''], + 'FileVersion' => ['description' => 'The version of the file.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'CommitTime' => ['description' => 'UNIX timestamp (in milliseconds) when the file version was generated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1593881265000', 'title' => ''], + 'NodeId' => ['description' => 'The ID of the scheduling task corresponding to the generation of this file version.', 'type' => 'integer', 'format' => 'int64', 'example' => '3000001', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"99EBE7CF-69C0-5089-BE3E-79563C31XXXX\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 131,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Resources\\": [\\n {\\n \\"Name\\": \\"math.py\\",\\n \\"ProjectId\\": 344247,\\n \\"Owner\\": \\"110755000425XXXX\\",\\n \\"CreateTime\\": 1724505917000,\\n \\"ModifyTime\\": 1724505917000,\\n \\"DataSource\\": {\\n \\"Name\\": \\"odps_first\\",\\n \\"Type\\": \\"odps\\"\\n },\\n \\"Script\\": {\\n \\"Path\\": \\"root/demo\\",\\n \\"Runtime\\": {\\n \\"Command\\": \\"ODPS_PYTHON\\"\\n },\\n \\"Id\\": \\"123348864897630XXXX\\"\\n },\\n \\"Type\\": \\"Jar\\",\\n \\"SourceType\\": \\"Local\\",\\n \\"SourcePath\\": \\"XXX/unknown/ide/1/XXX/20240820200851_963a9da676de44ef8d06a6576a8c4d6a.py\\",\\n \\"TargetType\\": \\"Oss\\",\\n \\"TargetPath\\": \\"XXX/unknown/ide/1/XXX/20240820200851_963a9da676de44ef8d06a6576a8c4d6a.py\\",\\n \\"Id\\": \\"631478864897630XXXX\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListResources', - ], - 'CreateFunction' => [ - 'summary' => 'Creates a user-defined function (UDF) in DataStudio. The information about the UDF is described by using FlowSpec.', - '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.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' => 'Obtain the details of a file version', + 'summary' => 'Invoke GetFileVersion to obtain the version details of a file.', + '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\\": \\"\\\\t\\\\n7384234****\\\\n\\",\\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' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '236012', - 'abilityTreeNodes' => [ - 'FEATUREdideZOYJZL', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '268603', + 'abilityTreeNodes' => ['FEATUREdide8FM783'], ], '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 query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '12345', - ], + 'schema' => ['description' => 'The ID of the DataWorks workspace. You can obtain the workspace ID from the workspace configuration page in the DataWorks console. Either this parameter or ProjectIdentifier must be specified to determine which DataWorks workspace this API call operates on.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '1000011', 'title' => ''], ], [ - 'name' => 'Spec', + 'name' => 'ProjectIdentifier', 'in' => 'formData', - 'schema' => [ - 'description' => 'The FlowSpec field information about the UDF. For more information, see [FlowSpec](https://github.com/aliyun/dataworks-spec/blob/master/README_zh_CN.md).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '{'."\n" - .' "version": "1.1.0",'."\n" - .' "kind": "Function",'."\n" - .' "spec": {'."\n" - .' "functions": ['."\n" - .' {'."\n" - .' "name": "function name",'."\n" - .' "script": {'."\n" - .' "content": "{\\"name\\": \\"function name\\", \\"datasource\\": {\\"type\\": \\"ODPS\\", \\"name\\": \\"ODPS_first\\"}, \\"runtimeResource\\": {\\"resourceGroup\\": \\"s_res_group_xx_xxxx\\"}}",'."\n" - .' "path": "XXX/OpenAPI/function/function name",'."\n" - .' "runtime": {'."\n" - .' "command": "ODPS_FUNCTION"'."\n" - .' }'."\n" - .' },'."\n" - .' "datasource": {'."\n" - .' "name": "ODPS_first",'."\n" - .' "type": "ODPS"'."\n" - .' },'."\n" - .' "runtimeResource": {'."\n" - .' "resourceGroup": "S_res_group_XXXX_XXXX"'."\n" - .' }'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .'}', - ], + 'schema' => ['description' => 'The name of the DataWorks workspace. You can obtain the workspace name from the workspace configuration page in the DataWorks console. Either this parameter or ProjectId must be specified to determine which DataWorks workspace this API call operates on.', 'type' => 'string', 'required' => false, 'example' => 'dw_project', 'title' => ''], + ], + [ + 'name' => 'FolderId', + 'in' => 'formData', + 'schema' => ['description' => 'The folder ID. Either this parameter or FolderPath must be specified. 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 folder path. Either this parameter or FolderId must be specified. 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' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response.', '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' => 'AE49C88D-5BEE-5ADD-8B8C-C4BBC0D7XXXX', - ], - 'Id' => [ - 'description' => 'The unique identifier of the UDF function.'."\n" - ."\n" - .'> Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.'."\n", - 'type' => 'string', - 'example' => '580667964888595XXXX', + '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. Used for troubleshooting when errors occur.', '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.'."\n" + ."\n" + .'- **true**'."\n" + ."\n" + .'- **false**', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'Details about the folder.', + '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' => '2735****', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AE49C88D-5BEE-5ADD-8B8C-C4BBC0D7****\\",\\n \\"Id\\": \\"580667964888595XXXX\\"\\n}","type":"json"}]', - 'title' => 'CreateFunction', - 'description' => '> You cannot use this API operation to create multiple UDFs at a time. If you specify multiple UDFs by using FlowSpec, the system creates only the first specified UDF.'."\n", - ], - 'DeleteFunction' => [ - 'summary' => 'Deletes a user-defined function (UDF) in DataStudio.', - '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.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', + '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' => 'Queries the information about a folder.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'GetFunction' => [ + 'summary' => 'Queries the information about a user-defined function (UDF) in DataStudio.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '236013', - 'abilityTreeNodes' => [ - 'FEATUREdideZOYJZL', - ], + 'abilityTreeCode' => '236011', + 'abilityTreeNodes' => ['FEATUREdideZOYJZL'], ], '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 ID. You can use this parameter to specify the DataWorks workspace on which you want to perform the API operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - '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 query 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' => false, 'example' => '10000', 'title' => ''], ], [ 'name' => 'Id', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The unique identifier of the UDF.'."\n" - ."\n" - .'> This field is of the Long type in SDK versions prior to 8.0.0, and of the String type in SDK versions 8.0.0 and later. This change does not affect normal SDK usage; the parameter will still be returned according to the type defined in the SDK. However, compilation failures may occur due to the type change only when upgrading the SDK across version 8.0.0. In this case, you must manually update the data type.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '860438872620113XXXX', - ], + 'in' => 'query', + 'schema' => ['description' => 'The unique identifier of the UDF function.'."\n" + ."\n" + .'> This field is of type Long in SDK versions prior to 8.0.0, and of type String in SDK version 8.0.0 and later. This change does not affect the normal use of the SDK; parameters are still returned according to the type defined in the SDK. Compilation failures due to the type change may occur only when upgrading the SDK across version 8.0.0, in which case users need to manually correct the data type.', 'type' => 'string', 'required' => true, 'example' => '86043887262011****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '88198F19-A36B-52A9-AE44-4518A688XXXX', - ], - '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.', 'type' => 'string', 'example' => '6CF95929-6D12-5A88-8CC3-4B2F4C2EXXXX'], + 'Function' => [ + 'description' => 'UDF function details.', + 'type' => 'object', + 'properties' => [ + 'ProjectId' => ['description' => 'The ID of the DataWorks workspace to which the UDF belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'title' => ''], + 'Name' => ['description' => 'The name of the UDF.', 'type' => 'string', 'example' => 'Function name', 'title' => ''], + 'Owner' => ['description' => 'The owner of the UDF.', 'type' => 'string', 'example' => '110755000425XXXX', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the UDF was created. This value is a UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1724505917000', 'title' => ''], + 'ModifyTime' => ['description' => 'The time when the UDF was last modified. This value is a UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1724506661000', 'title' => ''], + 'Spec' => ['description' => 'The FlowSpec field information about the UDF. For more information, see [FlowSpec](https://github.com/aliyun/dataworks-spec/blob/master/README_zh_CN.md).', 'type' => 'string', 'example' => '{'."\n" + .' "version": "1.1.0",'."\n" + .' "kind": "Function",'."\n" + .' "spec": {'."\n" + .' "functions": ['."\n" + .' {'."\n" + .' "name": "Function_Name",'."\n" + .' "id": "580667964888595XXXX",'."\n" + .' "script": {'."\n" + .' "content": "{ \\"uuid\\": \\"580667964888595XXXX\\", \\"name\\": \\"Function_Name\\", \\"datasource\\": { \\"type\\": \\"odps\\", \\"name\\": \\"odps_first\\" }, \\"runtimeResource\\": { \\"resourceGroup\\": \\"S_res_group_XXXX_XXXX\\", \\"resourceGroupId\\": 6591XXXX }}",'."\n" + .' "path": "XXX/OpenAPI/Function/Function_Name",'."\n" + .' "runtime": {'."\n" + .' "command": "ODPS_FUNCTION"'."\n" + .' }'."\n" + .' },'."\n" + .' "datasource": {'."\n" + .' "name": "odps_first",'."\n" + .' "type": "odps"'."\n" + .' },'."\n" + .' "runtimeResource": {'."\n" + .' "resourceGroup": "S_res_group_XXXX_XXXX",'."\n" + .' "id": "723932906364267XXXX",'."\n" + .' "resourceGroupId": "6591XXXX"'."\n" + .' },'."\n" + .' "metadata": {'."\n" + .' "owner": "110755000425XXXX"'."\n" + .' }'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .'}', 'title' => ''], + 'Id' => ['description' => 'The unique identifier of the UDF function.'."\n" + ."\n" + .'> Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.', 'type' => 'string', 'example' => '860438872620113XXXX'."\n", 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6CF95929-6D12-5A88-8CC3-4B2F4C2EXXXX\\",\\n \\"Function\\": {\\n \\"ProjectId\\": 10000,\\n \\"Name\\": \\"Function name\\",\\n \\"Owner\\": \\"110755000425XXXX\\",\\n \\"CreateTime\\": 1724505917000,\\n \\"ModifyTime\\": 1724506661000,\\n \\"Spec\\": \\"{\\\\n \\\\\\"version\\\\\\": \\\\\\"1.1.0\\\\\\",\\\\n \\\\\\"kind\\\\\\": \\\\\\"Function\\\\\\",\\\\n \\\\\\"spec\\\\\\": {\\\\n \\\\\\"functions\\\\\\": [\\\\n {\\\\n \\\\\\"name\\\\\\": \\\\\\"Function_Name\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"580667964888595XXXX\\\\\\",\\\\n \\\\\\"script\\\\\\": {\\\\n \\\\\\"content\\\\\\": \\\\\\"{ \\\\\\\\\\\\\\"uuid\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"580667964888595XXXX\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"name\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"Function_Name\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"datasource\\\\\\\\\\\\\\": { \\\\\\\\\\\\\\"type\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"odps\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"name\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"odps_first\\\\\\\\\\\\\\" }, \\\\\\\\\\\\\\"runtimeResource\\\\\\\\\\\\\\": { \\\\\\\\\\\\\\"resourceGroup\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"S_res_group_XXXX_XXXX\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"resourceGroupId\\\\\\\\\\\\\\": 6591XXXX }}\\\\\\",\\\\n \\\\\\"path\\\\\\": \\\\\\"XXX/OpenAPI/Function/Function_Name\\\\\\",\\\\n \\\\\\"runtime\\\\\\": {\\\\n \\\\\\"command\\\\\\": \\\\\\"ODPS_FUNCTION\\\\\\"\\\\n }\\\\n },\\\\n \\\\\\"datasource\\\\\\": {\\\\n \\\\\\"name\\\\\\": \\\\\\"odps_first\\\\\\",\\\\n \\\\\\"type\\\\\\": \\\\\\"odps\\\\\\"\\\\n },\\\\n \\\\\\"runtimeResource\\\\\\": {\\\\n \\\\\\"resourceGroup\\\\\\": \\\\\\"S_res_group_XXXX_XXXX\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"723932906364267XXXX\\\\\\",\\\\n \\\\\\"resourceGroupId\\\\\\": \\\\\\"6591XXXX\\\\\\"\\\\n },\\\\n \\\\\\"metadata\\\\\\": {\\\\n \\\\\\"owner\\\\\\": \\\\\\"110755000425XXXX\\\\\\"\\\\n }\\\\n }\\\\n ]\\\\n }\\\\n}\\",\\n \\"Id\\": \\"860438872620113XXXX\\\\n\\"\\n }\\n}","type":"json"}]', + 'title' => 'GetFunction', + 'changeSet' => [ + ['createdAt' => '2025-01-13T07:35:59.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"88198F19-A36B-52A9-AE44-4518A688XXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'DeleteFunction', - 'description' => '> A UDF that is deployed cannot be deleted. If you want to delete such a UDF, you must first undeploy the UDF.'."\n", - ], - 'UpdateFunction' => [ - 'summary' => 'Updates the basic information about a user-defined function (UDF) in DataStudio. This API operation performs an incremental update. The update information is described by using FlowSpec.', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + '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' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '236014', - 'abilityTreeNodes' => [ - 'FEATUREdideZOYJZL', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '269311', + '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.', 'type' => 'string', 'required' => true, 'example' => '8abcb91f-d266-4073-b907-2ed67****1', 'title' => ''], + ], [ 'name' => 'ProjectId', 'in' => 'formData', + 'schema' => ['description' => 'The DataWorks workspace ID. You can obtain the ID from the message.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ '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, - 'example' => '10000', + 'title' => 'Schema of Response', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', '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.', + '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.', + 'type' => 'object', + 'properties' => [ + 'FileId' => ['description' => 'The file ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234123', 'title' => ''], + 'DataSourceName' => ['description' => 'The name of the data source with which the file is associated.', 'type' => 'string', 'example' => 'odps_source', 'title' => ''], + 'Content' => ['description' => 'The code in the file of the current version.', 'type' => 'string', 'example' => 'SHOW TABLES;', 'title' => ''], + 'FileType' => ['description' => 'The file type. The code for files varies based on the file type. For more information, see [DataWorks nodes](~~600169~~).', 'type' => 'integer', 'format' => 'int64', 'example' => '10', '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.', + 'type' => 'object', + 'properties' => [ + 'Owner' => ['description' => 'The file owner.', 'type' => 'string', 'example' => '7384234****', 'title' => ''], + 'FileType' => ['description' => 'The file type. The code for files varies based on the file type. For more information, see [DataWorks nodes](~~600169~~).', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'CurrentVersion' => ['description' => 'The latest version number of the file.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'BusinessId' => ['description' => 'The ID of the workflow to which the file belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '74328', 'title' => ''], + 'FileName' => ['description' => 'The name of the file.', 'type' => 'string', 'example' => 'hello_dataworks.sql', 'title' => ''], + 'DataSourceName' => ['description' => 'The name of the data source with which the file is associated.', '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" + ."\n" + .'- MANUAL: The file is used for a manually triggered node.'."\n" + ."\n" + .'- MANUAL\\_BIZ: The file is used for a manually triggered workflow.'."\n" + ."\n" + .'- SKIP: The file is used for a dry-run node in DataStudio.'."\n" + ."\n" + .'- ADHOCQUERY: The file is used for an ad hoc query.'."\n" + ."\n" + .'- COMPONENT: The file is used for a script template.', '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.', 'type' => 'string', 'example' => 'aldurie78l2falure', 'title' => ''], + 'ParentFileId' => ['description' => 'The ID of the do-while node or for-each node that corresponds to the file.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234122', 'title' => ''], + 'Content' => ['description' => 'The code in the file of the current version.', 'type' => 'string', 'example' => 'SHOW TABLES;', 'title' => ''], + 'NodeId' => ['description' => 'The ID of the node that is scheduled.', 'type' => 'integer', 'format' => 'int64', 'example' => '421429', 'title' => ''], + 'FileId' => ['description' => 'The file ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234123', 'title' => ''], + ], + '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.', + 'type' => 'object', + 'properties' => [ + 'FileId' => ['description' => 'The file ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234123', 'title' => ''], + 'Content' => ['description' => 'The code in the file of the current version.', '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.', 'type' => 'string', 'example' => '7384234****', 'title' => ''], + 'FileType' => ['description' => 'The file type. The code for files varies based on the file type. For more information, see [DataWorks nodes](~~600169~~).', '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.', 'type' => 'string', 'example' => 'UPDATE', 'title' => ''], + 'FileName' => ['description' => 'The name of the file.', 'type' => 'string', 'example' => 'hello_dataworks.sql', 'title' => ''], + 'NodeId' => ['description' => 'The ID of the node that is scheduled.', 'type' => 'integer', 'format' => 'int64', 'example' => '421429', 'title' => ''], + 'Comment' => ['description' => 'The description of the file version.', '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" + ."\n" + .'- MANUAL: The file is used for a manually triggered node.'."\n" + ."\n" + .'- MANUAL\\_BIZ: The file is used for a manually triggered workflow.'."\n" + ."\n" + .'- SKIP: The file is used for a dry-run node in DataStudio.'."\n" + ."\n" + .'- ADHOCQUERY: The file is used for an ad hoc query.'."\n" + ."\n" + .'- COMPONENT: The file is used for a script template.', 'type' => 'string', 'example' => 'NORMAL', 'title' => ''], + 'FilePropertyContent' => [ + 'description' => 'The details of the file.', + 'type' => 'object', + 'properties' => [ + 'DataSourceName' => ['description' => 'The name of the data source with which the file is associated.', 'type' => 'string', 'example' => 'odps_source', 'title' => ''], + 'ParentFileId' => ['description' => 'The ID of the do-while node or for-each node that corresponds to the file.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234122', 'title' => ''], + 'BusinessId' => ['description' => 'The ID of the workflow to which the file belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '74328', 'title' => ''], + 'CurrentVersion' => ['description' => 'The latest version number of the file.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Owner' => ['description' => 'The file owner.', '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.', 'type' => 'string', 'example' => 'aldurie78l2falure', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'NodeConfiguration' => [ + 'description' => 'The scheduling properties of the node that corresponds to the file.', + '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" + ."\n" + .'- FAILURE\\_ALLOWED: The node can be rerun only after it fails to run.'."\n" + ."\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).', '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" + ."\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" + .'- 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' => 'NORMAL', 'title' => ''], + 'ParaValue' => ['description' => 'The scheduling parameters of the node.'."\n" + ."\n" + .'This parameter corresponds to the Scheduling Parameter section of the Properties tab on the DataStudio page in the [DataWorks console](https://workbench.data.aliyun.com/console). For more information about the configurations of scheduling parameters, see [Configure scheduling parameters](~~137548~~).', '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 on the DataStudio page in the [DataWorks console](https://workbench.data.aliyun.com/console).', '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 on the DataStudio page in the [DataWorks console](https://workbench.data.aliyun.com/console).', '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.', 'type' => 'integer', 'format' => 'int64', 'example' => '375827434852437', 'title' => ''], + 'AutoRerunTimes' => ['description' => 'The number of times that the node corresponding to the file can be rerun.', 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'AutoRerunIntervalMillis' => ['description' => 'The interval at which the node corresponding to the file is rerun. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '120000', 'title' => ''], + 'CronExpress' => ['description' => 'The cron expression that is used to schedule the node corresponding to the file.', 'type' => 'string', 'example' => '00 05 00 * * ?', 'title' => ''], + 'InputList' => [ + 'description' => 'The output information about the parent files on which the current file depends.', + 'type' => 'array', + 'items' => [ + 'description' => 'The output information about the parent file on which the current file depends.', + '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 on the DataStudio page in the [DataWorks console](https://workbench.data.aliyun.com/console).', '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" + ."\n" + .'- AUTO: Scheduling dependencies are automatically parsed.', 'type' => 'string', 'example' => 'MANUAL', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'OutputList' => [ + 'description' => 'The output information about the current file.', + 'type' => 'array', + 'items' => [ + 'description' => 'The output information about the current file.', + '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 on the DataStudio page in the [DataWorks console](https://workbench.data.aliyun.com/console).', '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 on the DataStudio page in the [DataWorks console](https://workbench.data.aliyun.com/console).', '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" + ."\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.', '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.', + 'type' => 'object', + 'properties' => [ + 'Env' => ['description' => 'The environment in which the table is used. Valid values:'."\n" + ."\n" + .'- DEV'."\n" + ."\n" + .'- PROD', 'type' => 'string', 'example' => 'DEV', 'title' => ''], + 'LifeCycle' => ['description' => 'The lifecycle of the table. Unit: day.', 'type' => 'integer', 'format' => 'int64', 'example' => '7', 'title' => ''], + 'TableName' => ['description' => 'The name of the table.', 'type' => 'string', 'example' => 'tb_hello', 'title' => ''], + 'DataSourceName' => ['description' => 'The name of the data source to which the table belongs.', 'type' => 'string', 'example' => 'odps_source', 'title' => ''], + 'Columns' => [ + 'description' => 'The columns in the table.', + 'type' => 'array', + 'items' => [ + 'description' => 'The column in the table.', + 'type' => 'object', + 'properties' => [ + 'ColumnName' => ['description' => 'The name of the column.', 'type' => 'string', 'example' => 'ID', 'title' => ''], + 'ColumnType' => ['description' => 'The data type of the column.', 'type' => 'string', 'example' => 'BIGINT', 'title' => ''], + 'IsPartitionColumn' => ['description' => 'Indicates whether the column is a partition key column. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Comment' => ['description' => 'The remarks of the column.', 'type' => 'string', 'example' => 'ID', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Comment' => ['description' => 'The remarks of the table.', 'type' => 'string', 'example' => 'A new table', 'title' => ''], + 'Location' => ['description' => 'The path of the table.', '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' => ''], + ], + ], + '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"}]', + 'title' => 'GetIDEEventDetail', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'GetImage' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '245169', + 'abilityTreeNodes' => ['FEATUREdide2SV6DS'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ [ 'name' => 'Id', - 'in' => 'formData', + 'in' => 'query', + 'schema' => ['description' => 'The image ID.', 'type' => 'string', 'required' => true, 'example' => 'Custom_image_xxxx_xxxx', 'title' => ''], + ], + [ + 'name' => 'ImageVersion', + 'in' => 'query', + 'schema' => ['description' => 'The image version. If you do not specify this parameter, the latest version is returned.', 'type' => 'string', 'example' => '1', 'title' => '', 'required' => false], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The unique identifier of the UDF.'."\n" - ."\n" - .'> This field is of the Long type in SDK versions prior to 8.0.0, and of the String type in SDK versions 8.0.0 and later. This change does not affect normal SDK usage; the parameter will still be returned according to the type defined in the SDK.. However, compilation failures may occur due to the type change only when upgrading the SDK across version 8.0.0. In this case, you must manually update the data type.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '463497880880954XXXX', + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'Image' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The image ID.', 'type' => 'string', 'example' => 'Custom_image_xxxx_xxxx', 'title' => ''], + 'Name' => ['description' => 'The image name.', 'type' => 'string', 'example' => 'dataworks_image', 'title' => ''], + 'Version' => ['description' => 'The image version.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Description' => ['description' => 'The image description.', 'type' => 'string', 'example' => 'Test image created by xxx', 'title' => ''], + 'Creator' => ['description' => 'The ID of the creator.', 'type' => 'string', 'example' => '123', 'title' => ''], + 'Modifier' => ['description' => 'The ID of the modifier.', 'type' => 'string', 'example' => '123', 'title' => ''], + 'CreatedTime' => ['description' => 'The creation time, represented as a 64-bit timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1727055811000', 'title' => ''], + 'LastModifiedTime' => ['description' => 'The last modification time, represented as a 64-bit timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1727055811000', 'title' => ''], + 'Official' => ['description' => 'Indicates whether the image is an official image.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Accessibility' => [ + 'description' => 'The image visibility:'."\n" + ."\n" + .'- Public: Visible to all users.'."\n" + ."\n" + .'- Private: Visible only to the creator.', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'Public', + 'enum' => ['Tenant', 'Project', 'Public'], + 'title' => '', + ], + 'Status' => [ + 'description' => 'The image status:'."\n" + ."\n" + .'- Disabled: The image is disabled.'."\n" + ."\n" + .'- Expired: The image has expired.'."\n" + ."\n" + .'- Available: The image is available.'."\n" + ."\n" + .'- ReadOnly: The image is read-only.', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'Available', + 'title' => '', + ], + 'PublishStage' => [ + 'description' => 'The publish stage:'."\n" + ."\n" + .'- Untest: Not tested.'."\n" + ."\n" + .'- Testing: Being tested.'."\n" + ."\n" + .'- TestFailed: Test failed.'."\n" + ."\n" + .'- Unpublished: Not published.'."\n" + ."\n" + .'- Publishing: Being published.'."\n" + ."\n" + .'- Published: Published.'."\n" + ."\n" + .'- PublishFailed: Publish failed.'."\n" + ."\n" + .'- Building: Being built.'."\n" + ."\n" + .'- BuildSuccess: Build succeeded.'."\n" + ."\n" + .'- BuildFailed: Build failed.'."\n" + ."\n" + .'- Accelerating: Being accelerated.'."\n" + ."\n" + .'- AccelerateSuccess: Acceleration succeeded.'."\n" + ."\n" + .'- AccelerateFailed: Acceleration failed.', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'Published', + 'title' => '', + ], + 'Supported' => [ + 'type' => 'object', + 'properties' => [ + 'Module' => ['description' => 'The supported module:'."\n" + ."\n" + .'- Scheduler: Scheduling.', 'type' => 'string', 'title' => '', 'example' => 'Scheduler'], + 'TaskTypes' => [ + 'type' => 'array', + 'items' => ['description' => 'The supported task types:'."\n" + ."\n" + .'- Shell'."\n" + ."\n" + .'- Python'."\n" + ."\n" + .'- ServerIDE'."\n" + ."\n" + .'- Notebook'."\n" + ."\n" + .'- PyODPS 2'."\n" + ."\n" + .'- PyODPS 3', 'type' => 'string', 'title' => '', 'example' => 'Shell'], + 'title' => '', + 'description' => 'The list of supported task types.', + 'example' => '', + ], + ], + 'title' => '', + 'description' => 'The supported modules and task types.', + 'example' => '', + ], + 'IsDefault' => ['description' => 'Indicates whether the image is the default image.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'EnableSyncMaxCompute' => ['description' => 'Indicates whether synchronization to MaxCompute is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'ProviderType' => ['description' => 'The image provider type:'."\n" + ."\n" + .'- ACR: ACR image repository.'."\n" + ."\n" + .'- DataWorks: DataWorks official image.', 'type' => 'string', 'example' => 'ACR', 'title' => ''], + 'ProviderImageId' => ['description' => 'The image ID assigned by the provider.', 'type' => 'string', 'example' => 'acr_image_id', 'title' => ''], + 'ImageUri' => ['description' => 'The image URI.', 'type' => 'string', 'example' => 'registry.cn-hangzhou.aliyuncs.com/xxx/xxx:tag', 'title' => ''], + 'Namespace' => ['description' => 'The namespace.', 'type' => 'string', 'example' => 'namespace', 'title' => ''], + 'Size' => ['description' => 'The image size.', 'type' => 'string', 'example' => '1GB', 'title' => ''], + 'AcrInstanceId' => ['description' => 'The ACR instance ID.', 'type' => 'string', 'example' => 'cri-xxx', 'title' => ''], + 'ImageTag' => ['description' => 'The image tag.', 'type' => 'string', 'example' => 'v1.0.0', 'title' => ''], + 'RepositoryName' => ['description' => 'The repository name.', 'type' => 'string', 'example' => 'repo_name', 'title' => ''], + 'ImageVpcUri' => ['description' => 'The image VPC URI.', 'type' => 'string', 'example' => 'registry-vpc.cn-hangzhou.aliyuncs.com/xxx/xxx:tag', 'title' => ''], + 'AcrEndpoint' => ['description' => 'ACR Endpoint', 'type' => 'string', 'example' => 'registry.cn-hangzhou.aliyuncs.com', 'title' => ''], + 'AcrAssociatedVpcId' => ['description' => 'The VPC ID associated with the ACR instance.', 'type' => 'string', 'example' => 'vpc-xxx', 'title' => ''], + 'BuildConfig' => [ + 'type' => 'object', + 'properties' => [ + 'BuildType' => ['description' => 'The build type.', 'type' => 'string', 'example' => 'PackageInstallation', 'title' => ''], + 'PackageInstallationScripts' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The script type.', 'type' => 'string', 'example' => 'Python3', 'title' => ''], + 'Content' => ['description' => 'The script content. If the content consists of package names, separate them with commas (,).', 'type' => 'string', 'example' => 'requests', 'title' => ''], + ], + 'description' => 'A pre-installation script.', + 'title' => '', + 'example' => '', + ], + 'description' => 'The list of pre-installation scripts.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The image build configuration.', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'description' => 'The image details.', + 'example' => '', + ], + 'RequestId' => ['description' => 'The request ID, which is used to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', 'title' => ''], + ], + 'title' => '', + 'description' => 'Schema of Response', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetImage', + 'summary' => 'Gets the details of an image by its ID.', + 'description' => '1. A subscription to DataWorks Basic Edition or a higher edition is required.'."\n" + ."\n" + .'2. **Make sure that you have created the service-linked role AliyunServiceRoleForDataWorks before you call this operation.**', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'Spec', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The unique identifier of the UDF.'."\n" - ."\n" - .'> Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '{'."\n" - .' "version": "1.1.0",'."\n" - .' "kind": "Function",'."\n" - .' "spec": {'."\n" - .' "functions": ['."\n" - .' {'."\n" - .' "name": "FunctionName",'."\n" - .' "script": {'."\n" - .' "content": "{\\"name\\": \\"FunctionName\\", \\"datasource\\": {\\"type\\": \\"odps\\", \\"name\\": \\"odps_first\\"}, \\"runtimeResource\\": {\\"resourceGroup\\": \\"S_res_group_XXXX_XXXX\\"}}",'."\n" - .' "path": "XXX/OpenAPI/Function/FunctionName",'."\n" - .' "runtime": {'."\n" - .' "command": "ODPS_FUNCTION"'."\n" - .' }'."\n" - .' },'."\n" - .' "datasource": {'."\n" - .' "name": "odps_first",'."\n" - .' "type": "odps"'."\n" - .' },'."\n" - .' "runtimeResource": {'."\n" - .' "resourceGroup": "S_res_group_XXXX_XXXX"'."\n" - .' }'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .'}', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetImage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Image\\": {\\n \\"Id\\": \\"Custom_image_xxxx_xxxx\\",\\n \\"Name\\": \\"dataworks_image\\",\\n \\"Version\\": \\"1\\",\\n \\"Description\\": \\"Test image created by xxx\\",\\n \\"Creator\\": \\"123\\",\\n \\"Modifier\\": \\"123\\",\\n \\"CreatedTime\\": 1727055811000,\\n \\"LastModifiedTime\\": 1727055811000,\\n \\"Official\\": true,\\n \\"Accessibility\\": \\"Public\\",\\n \\"Status\\": \\"Available\\",\\n \\"PublishStage\\": \\"Published\\",\\n \\"Supported\\": {\\n \\"Module\\": \\"Scheduler\\",\\n \\"TaskTypes\\": [\\n \\"Shell\\"\\n ]\\n },\\n \\"IsDefault\\": false,\\n \\"EnableSyncMaxCompute\\": false,\\n \\"ProviderType\\": \\"ACR\\",\\n \\"ProviderImageId\\": \\"acr_image_id\\",\\n \\"ImageUri\\": \\"registry.cn-hangzhou.aliyuncs.com/xxx/xxx:tag\\",\\n \\"Namespace\\": \\"namespace\\",\\n \\"Size\\": \\"1GB\\",\\n \\"AcrInstanceId\\": \\"cri-xxx\\",\\n \\"ImageTag\\": \\"v1.0.0\\",\\n \\"RepositoryName\\": \\"repo_name\\",\\n \\"ImageVpcUri\\": \\"registry-vpc.cn-hangzhou.aliyuncs.com/xxx/xxx:tag\\",\\n \\"AcrEndpoint\\": \\"registry.cn-hangzhou.aliyuncs.com\\",\\n \\"AcrAssociatedVpcId\\": \\"vpc-xxx\\",\\n \\"BuildConfig\\": {\\n \\"BuildType\\": \\"PackageInstallation\\",\\n \\"PackageInstallationScripts\\": [\\n {\\n \\"Type\\": \\"Python3\\",\\n \\"Content\\": \\"requests\\"\\n }\\n ]\\n }\\n },\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]', + ], + 'GetJobStatus' => [ + 'summary' => 'Queries the status information of an asynchronous task. After you call an asynchronous operation, an asynchronous task is generated. You can call the GetJobStatus operation to query the status of the asynchronous task.', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '248471', + 'abilityTreeNodes' => ['FEATUREdide63BO88'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'JobId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the asynchronous task that is generated after you call an asynchronous operation.', 'type' => 'string', 'required' => true, 'example' => '70ecdaec-bf21-4c11-8ecb-4f77453ceea8', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID. You can troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => '12123960-CB2C-5086-868E-C6C1D024XXXX', - ], - '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.', 'type' => 'string', 'example' => '5E2BFE96-C0E0-5A98-85C8-633EC803198D'], + 'JobStatus' => [ + 'description' => 'The real-time status information of the asynchronous task.', + 'type' => 'object', + 'properties' => [ + 'JobId' => ['description' => 'The ID of the asynchronous task.', 'type' => 'string', 'example' => 'C664CDE3-9C0B-5792-B17F-6C543783BBBC', 'title' => ''], + 'JobType' => ['description' => 'The type of the asynchronous task. Valid values:'."\n" + ."\n" + .'- **Create**: The asynchronous task is used to create an object.'."\n" + ."\n" + .'- **Update**: The asynchronous task is used to update an object.'."\n" + ."\n" + .'- **Cancel**: The asynchronous task is used to cancel an operation.', 'type' => 'string', 'example' => 'Create', 'title' => ''], + 'Completed' => ['description' => 'Indicates whether the asynchronous task is complete. Valid values: True False', 'type' => 'string', 'example' => 'False', 'title' => ''], + 'Status' => ['description' => 'The status of the asynchronous task. Valid values:'."\n" + ."\n" + .'- **Success**'."\n" + ."\n" + .'- **Fail**'."\n" + ."\n" + .'- **Cancel**'."\n" + ."\n" + .'- **Running**', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Error' => ['description' => 'The error message returned if the asynchronous task fails.', 'type' => 'string', 'example' => 'Not Found', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the asynchronous task was created.', 'type' => 'string', 'example' => '1729063449802', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"12123960-CB2C-5086-868E-C6C1D024****\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'UpdateFunction', - ], - 'MoveFunction' => [ - 'summary' => 'Moves a user-defined function (UDF) to a path in DataStudio.', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5E2BFE96-C0E0-5A98-85C8-633EC803198D\\",\\n \\"JobStatus\\": {\\n \\"JobId\\": \\"C664CDE3-9C0B-5792-B17F-6C543783BBBC\\",\\n \\"JobType\\": \\"Create\\",\\n \\"Completed\\": \\"False\\",\\n \\"Status\\": \\"Success\\",\\n \\"Error\\": \\"Not Found\\",\\n \\"CreateTime\\": \\"1729063449802\\"\\n }\\n}","type":"json"}]', + 'title' => 'GetJobStatus', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetJobStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetLineageRelationship' => [ + 'summary' => 'Retrieves details for a specific lineage relationship in the data map.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '236059', - 'abilityTreeNodes' => [ - 'FEATUREdideZOYJZL', - ], + 'abilityTreeCode' => '268092', + 'abilityTreeNodes' => ['FEATUREdideE9XYA6'], ], '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 ID.'."\n" - ."\n" - .'This parameter indicates the DataWorks workspace to which the API operation is applied.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '12345', - ], - ], [ 'name' => 'Id', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The unique identifier of the UDF.'."\n" - ."\n" - .'> This field is of the Long type in SDK versions prior to 8.0.0, and of the String type in SDK versions 8.0.0 and later. This change does not affect normal SDK usage; the parameter will still be returned according to the type defined in the SDK.. However, compilation failures may occur due to the type change only when upgrading the SDK across version 8.0.0. In this case, you must manually update the data type.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '543217824470354XXXX', - ], - ], - [ - 'name' => 'Path', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The unique identifier of the UDF.'."\n" - ."\n" - .'> Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect normal SDK usage; the parameter will still be returned according to the type defined in the SDK.. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'root/demo', - ], + 'in' => 'query', + 'schema' => ['description' => 'The lineage relationship ID. You can get this ID from the response to the ListLineageRelationships operation.', 'type' => 'string', 'required' => true, 'example' => '4as3dasf654a', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '48C0E2F0-52BA-5888-BDFA-28F1B9AFXXXX', - ], - '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.', 'type' => 'string', 'example' => '58D5334A-B013-430E', 'title' => ''], + 'LineageRelationship' => ['description' => 'The lineage relationship object.', '$ref' => '#/components/schemas/LineageRelationship', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"48C0E2F0-52BA-5888-BDFA-28F1B9AFXXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'MoveFunction', - ], - 'RenameFunction' => [ - 'summary' => 'Renames a user-defined function (UDF) in DataStudio.', - 'methods' => [ - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"58D5334A-B013-430E\\",\\n \\"LineageRelationship\\": {\\n \\"SrcEntity\\": {\\n \\"Id\\": \\"maxcompute-table:123456XXX::test_project::test_tbl\\\\ndlf-table:123456XXX:test_catalog:test_db::test_tbl\\\\nhms-table:c-abc123xxx::test_db::test_tbl\\\\nholo-table:h-abc123xxx::test_db:test_schema:test_tbl\\\\ncustom-api:api123\\\\ncustom-table:table456\\",\\n \\"Name\\": \\"test_tbl\\",\\n \\"Attributes\\": {\\n \\"key\\": \\"key1:value1\\"\\n }\\n },\\n \\"DstEntity\\": {\\n \\"Id\\": \\"maxcompute-table:123456XXX::test_project::test_tbl\\\\ndlf-table:123456XXX:test_catalog:test_db::test_tbl\\\\nhms-table:c-abc123xxx::test_db::test_tbl\\\\nholo-table:h-abc123xxx::test_db:test_schema:test_tbl\\\\ncustom-api:api123\\\\ncustom-table:table456\\",\\n \\"Name\\": \\"test_tbl\\",\\n \\"Attributes\\": {\\n \\"key\\": \\"key1:value1\\"\\n }\\n },\\n \\"Task\\": {\\n \\"Id\\": \\"12345\\",\\n \\"Type\\": \\"custom-sql\\",\\n \\"Attributes\\": {\\n \\"key\\": \\"key1:value21\\"\\n }\\n },\\n \\"Id\\": \\"maxcompute-table.p.table:custom-table.xxx:custom-sql.123\\",\\n \\"CreateTime\\": 1743040581000\\n }\\n}","type":"json"}]', + 'title' => 'GetLineageRelationship', + 'description' => '1. This operation is available only for DataWorks Standard Edition or later.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetLineageRelationship', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetMcpServer' => [ + 'summary' => 'Returns the details of an MCP Server.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '236048', - 'abilityTreeNodes' => [ - 'FEATUREdideZOYJZL', - ], + 'abilityTreeCode' => 'TBD', + 'abilityTreeNodes' => ['FEATUREdideYTM537'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], '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 query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10002', - ], - ], - [ - 'name' => 'Id', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The unique identifier of the Data Studio UDF.'."\n" - ."\n" - .'> This field is of the Long type in SDK versions prior to 8.0.0, and of the String type in SDK versions 8.0.0 and later. This change does not affect normal SDK usage; the parameter will still be returned according to the type defined in the SDK. However, compilation failures may occur due to the type change only when upgrading the SDK across version 8.0.0. In this case, you must manually update the data type.', - 'type' => 'string', - 'required' => true, - 'example' => '543217824470354XXXX', - ], - ], [ 'name' => 'Name', 'in' => 'formData', - 'schema' => [ - 'description' => 'The unique identifier of the Data Studio UDF.'."\n" - ."\n" - .'> Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Rename', - ], + 'schema' => ['description' => 'The name of the MCP Server to retrieve.', 'type' => 'string', 'required' => true, 'example' => 'my-mcp-server', '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' => '1ED4C97F-BA2A-57C5-BA7C-8853627EXXXX', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '824F80BA-1778-5D8A-BAFF-668A4D9C4CC7'], + 'McpServer' => [ + 'type' => 'object', + 'properties' => [ + 'CreatorId' => ['description' => 'The creator ID.', 'type' => 'string', 'example' => '123456', 'title' => ''], + 'ModifierId' => ['description' => 'The modifier ID.', 'type' => 'string', 'example' => '123456', 'title' => ''], + 'Name' => ['description' => 'The MCP Server name.', 'type' => 'string', 'example' => 'my-mcp-server', 'title' => ''], + 'Config' => [ + 'type' => 'object', + 'properties' => [ + 'Url' => ['description' => 'The service address of the MCP Server.', 'type' => 'string', 'example' => 'https://example.com/mcp/sse', 'title' => ''], + 'Transport' => ['description' => 'The transport protocol.', 'type' => 'string', 'example' => 'SSE', 'title' => ''], + 'CustomHeaders' => ['description' => 'The custom headers.', 'type' => 'object', 'example' => '{}', 'title' => ''], + ], + 'description' => 'The connection configuration for the MCP Server.', + 'title' => '', + 'example' => '', + ], + 'Visibility' => ['description' => 'The visibility level. Valid values: TENANT (visible within the account), PROJECT (visible to specified projects), and USER (visible to specified users).', 'type' => 'string', 'example' => 'TENANT', 'title' => ''], + 'GmtCreateTime' => ['description' => 'The creation time, provided as a timestamp in milliseconds.', 'type' => 'string', 'format' => 'iso8601', 'example' => '1780555634000', 'title' => ''], + 'GmtModifiedTime' => ['description' => 'The modification time, provided as a timestamp in milliseconds.', 'type' => 'string', 'format' => 'iso8601', 'example' => '1780555634000', 'title' => ''], + ], + 'description' => 'The MCP Server configuration.', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => 'The response schema.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetMcpServer', + 'description' => '## Description'."\n" + ."\n" + .'This API returns the detailed configuration of a specific MCP Server by name. The response includes the creator ID, modifier ID, service address, and transport protocol. You must provide the exact name of the MCP Server in the request.'."\n" + ."\n" + .'### Notes'."\n" + ."\n" + .'- Ensure you have the required permissions to call this API.'."\n" + ."\n" + .'- The MCP Server name is case-sensitive.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1ED4C97F-BA2A-57C5-BA7C-8853627EXXXX\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', - 'title' => 'RenameFunction', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"824F80BA-1778-5D8A-BAFF-668A4D9C4CC7\\",\\n \\"McpServer\\": {\\n \\"CreatorId\\": \\"123456\\",\\n \\"ModifierId\\": \\"123456\\",\\n \\"Name\\": \\"my-mcp-server\\",\\n \\"Config\\": {\\n \\"Url\\": \\"https://example.com/mcp/sse\\",\\n \\"Transport\\": \\"SSE\\",\\n \\"CustomHeaders\\": {}\\n },\\n \\"Visibility\\": \\"TENANT\\",\\n \\"GmtCreateTime\\": \\"1780555634000\\",\\n \\"GmtModifiedTime\\": \\"1780555634000\\"\\n }\\n}","type":"json"}]', ], - 'GetFunction' => [ - 'summary' => 'Queries the information about a user-defined function (UDF) in DataStudio.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'GetMetaCollection' => [ + 'summary' => 'Queries the information about a collection in Data Map. Collections include categories and data albums.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -17030,147 +21057,71 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '236011', - 'abilityTreeNodes' => [ - 'FEATUREdideZOYJZL', - ], + 'abilityTreeCode' => '266716', + 'abilityTreeNodes' => ['FEATUREdideE9XYA6'], ], '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' => false, - 'example' => '10000', - ], - ], [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique identifier of the UDF function.'."\n" - ."\n" - .'> This field is of type Long in SDK versions prior to 8.0.0, and of type String in SDK version 8.0.0 and later. This change does not affect the normal use of the SDK; parameters are still returned according to the type defined in the SDK. Compilation failures due to the type change may occur only when upgrading the SDK across version 8.0.0, in which case users need to manually correct the data type.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '860438872620113XXXX', - ], + 'schema' => ['description' => 'The collection ID.', 'type' => 'string', 'required' => true, 'example' => 'as78d756asd', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '6CF95929-6D12-5A88-8CC3-4B2F4C2EXXXX', - ], - 'Function' => [ - 'description' => 'UDF function details.'."\n", + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1AFAE64E-D1BE-432B-A9****'], + 'MetaCollection' => [ + 'description' => 'The collection details.', 'type' => 'object', 'properties' => [ - 'ProjectId' => [ - 'description' => 'The ID of the DataWorks workspace to which the UDF belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000', - ], - 'Name' => [ - 'description' => 'The name of the UDF.'."\n", - 'type' => 'string', - 'example' => 'Function name', - ], - 'Owner' => [ - 'description' => 'The owner of the UDF.'."\n", - 'type' => 'string', - 'example' => '110755000425XXXX', - ], - 'CreateTime' => [ - 'description' => 'The time when the UDF was created. This value is a UNIX timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1724505917000', - ], - 'ModifyTime' => [ - 'description' => 'The time when the UDF was last modified. This value is a UNIX timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1724506661000', - ], - 'Spec' => [ - 'description' => 'The FlowSpec field information about the UDF. For more information, see [FlowSpec](https://github.com/aliyun/dataworks-spec/blob/master/README_zh_CN.md).'."\n", - 'type' => 'string', - 'example' => '{'."\n" - .' "version": "1.1.0",'."\n" - .' "kind": "Function",'."\n" - .' "spec": {'."\n" - .' "functions": ['."\n" - .' {'."\n" - .' "name": "Function_Name",'."\n" - .' "id": "580667964888595XXXX",'."\n" - .' "script": {'."\n" - .' "content": "{ \\"uuid\\": \\"580667964888595XXXX\\", \\"name\\": \\"Function_Name\\", \\"datasource\\": { \\"type\\": \\"odps\\", \\"name\\": \\"odps_first\\" }, \\"runtimeResource\\": { \\"resourceGroup\\": \\"S_res_group_XXXX_XXXX\\", \\"resourceGroupId\\": 6591XXXX }}",'."\n" - .' "path": "XXX/OpenAPI/Function/Function_Name",'."\n" - .' "runtime": {'."\n" - .' "command": "ODPS_FUNCTION"'."\n" - .' }'."\n" - .' },'."\n" - .' "datasource": {'."\n" - .' "name": "odps_first",'."\n" - .' "type": "odps"'."\n" - .' },'."\n" - .' "runtimeResource": {'."\n" - .' "resourceGroup": "S_res_group_XXXX_XXXX",'."\n" - .' "id": "723932906364267XXXX",'."\n" - .' "resourceGroupId": "6591XXXX"'."\n" - .' },'."\n" - .' "metadata": {'."\n" - .' "owner": "110755000425XXXX"'."\n" - .' }'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .'}', - ], - 'Id' => [ - 'description' => 'The unique identifier of the UDF function.'."\n" - ."\n" - .'> Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.'."\n", - 'type' => 'string', - 'example' => '860438872620113XXXX'."\n", + 'Id' => ['description' => 'The collection ID.', 'type' => 'string', 'example' => 'as78d756asd', 'title' => ''], + 'Type' => ['description' => 'The collection type. Valid values:'."\n" + ."\n" + .'- Category'."\n" + ."\n" + .'- Album'."\n" + ."\n" + .'- AlbumCategory: Album subcategory.', 'type' => 'string', 'example' => 'Category', 'title' => ''], + 'ParentId' => ['description' => 'The parent collection ID. This parameter can be empty.', 'type' => 'string', 'example' => '4as3dasf654a', 'title' => ''], + 'Name' => ['description' => 'The collection name.', 'type' => 'string', 'example' => 'test_category', 'title' => ''], + 'Description' => ['description' => 'The collection description.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1668568601000', 'title' => ''], + 'ModifyTime' => ['description' => 'The last modified time in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1668568601000', 'title' => ''], + 'CreateUser' => ['description' => 'The ID of the creator.', 'type' => 'string', 'example' => '456789', 'title' => ''], + 'Administrators' => [ + 'description' => 'The list of administrator IDs. Valid only for the album type. The IDs must belong to users in the same tenant. Multiple IDs can be specified.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the administrator.', 'type' => 'integer', 'format' => 'int64', 'example' => '765432', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AFAE64E-D1BE-432B-A9****\\",\\n \\"MetaCollection\\": {\\n \\"Id\\": \\"as78d756asd\\",\\n \\"Type\\": \\"Category\\",\\n \\"ParentId\\": \\"4as3dasf654a\\",\\n \\"Name\\": \\"test_category\\",\\n \\"Description\\": \\"test\\",\\n \\"CreateTime\\": 1668568601000,\\n \\"ModifyTime\\": 1668568601000,\\n \\"CreateUser\\": \\"456789\\",\\n \\"Administrators\\": [\\n 765432\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'GetMetaCollection', + 'description' => '1. DataWorks Professional Edition or a higher edition is required.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6CF95929-6D12-5A88-8CC3-4B2F4C2EXXXX\\",\\n \\"Function\\": {\\n \\"ProjectId\\": 10000,\\n \\"Name\\": \\"Function name\\",\\n \\"Owner\\": \\"110755000425XXXX\\",\\n \\"CreateTime\\": 1724505917000,\\n \\"ModifyTime\\": 1724506661000,\\n \\"Spec\\": \\"{\\\\n \\\\\\"version\\\\\\": \\\\\\"1.1.0\\\\\\",\\\\n \\\\\\"kind\\\\\\": \\\\\\"Function\\\\\\",\\\\n \\\\\\"spec\\\\\\": {\\\\n \\\\\\"functions\\\\\\": [\\\\n {\\\\n \\\\\\"name\\\\\\": \\\\\\"Function_Name\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"580667964888595XXXX\\\\\\",\\\\n \\\\\\"script\\\\\\": {\\\\n \\\\\\"content\\\\\\": \\\\\\"{ \\\\\\\\\\\\\\"uuid\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"580667964888595XXXX\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"name\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"Function_Name\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"datasource\\\\\\\\\\\\\\": { \\\\\\\\\\\\\\"type\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"odps\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"name\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"odps_first\\\\\\\\\\\\\\" }, \\\\\\\\\\\\\\"runtimeResource\\\\\\\\\\\\\\": { \\\\\\\\\\\\\\"resourceGroup\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"S_res_group_XXXX_XXXX\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"resourceGroupId\\\\\\\\\\\\\\": 6591XXXX }}\\\\\\",\\\\n \\\\\\"path\\\\\\": \\\\\\"XXX/OpenAPI/Function/Function_Name\\\\\\",\\\\n \\\\\\"runtime\\\\\\": {\\\\n \\\\\\"command\\\\\\": \\\\\\"ODPS_FUNCTION\\\\\\"\\\\n }\\\\n },\\\\n \\\\\\"datasource\\\\\\": {\\\\n \\\\\\"name\\\\\\": \\\\\\"odps_first\\\\\\",\\\\n \\\\\\"type\\\\\\": \\\\\\"odps\\\\\\"\\\\n },\\\\n \\\\\\"runtimeResource\\\\\\": {\\\\n \\\\\\"resourceGroup\\\\\\": \\\\\\"S_res_group_XXXX_XXXX\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"723932906364267XXXX\\\\\\",\\\\n \\\\\\"resourceGroupId\\\\\\": \\\\\\"6591XXXX\\\\\\"\\\\n },\\\\n \\\\\\"metadata\\\\\\": {\\\\n \\\\\\"owner\\\\\\": \\\\\\"110755000425XXXX\\\\\\"\\\\n }\\\\n }\\\\n ]\\\\n }\\\\n}\\",\\n \\"Id\\": \\"860438872620113XXXX\\\\n\\"\\n }\\n}","type":"json"}]', - 'title' => 'GetFunction', + 'ramActions' => [], ], - 'ListFunctions' => [ - 'summary' => 'Queries a list of user-defined functions (UDFs) in DataStudio. You can also specify filter conditions to query specific UDFs.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'GetMetaEntity' => [ + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -17179,733 +21130,519 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '236015', - 'abilityTreeNodes' => [ - 'FEATUREdideZOYJZL', - ], + 'abilityTreeNodes' => ['FEATUREdideX3KVYR'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], '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, - 'example' => '12345', - ], + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => 'The entity ID.', 'type' => 'string', 'required' => true, 'example' => 'custom_entity-customer_api:api_001', 'title' => ''], ], - [ - 'name' => 'Owner', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The ID of the owner of the UDF. This parameter specifies a filter condition.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '110755000425XXXX', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '0A04C673-BEFA-5803-94E5-89E2D9F8C567'], + 'Success' => ['description' => 'Indicates whether the request succeeded.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'MetaEntity' => ['description' => 'The custom entity object.', '$ref' => '#/components/schemas/MetaEntity', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'description' => 'The response schema.', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetMetaEntity', + 'summary' => 'Retrieves the details of a custom entity.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0A04C673-BEFA-5803-94E5-89E2D9F8C567\\",\\n \\"Success\\": true,\\n \\"MetaEntity\\": {\\n \\"Id\\": \\"custom_entity-customer_api:api_001\\",\\n \\"EntityType\\": \\"custom_entity-customer_api\\",\\n \\"Name\\": \\"api_001\\",\\n \\"Comment\\": \\"this is a comment\\",\\n \\"OwnerId\\": \\"207924799988354\\",\\n \\"CustomAttributes\\": {\\n \\"key\\": [\\n \\"张三\\"\\n ]\\n },\\n \\"MetaEntityDef\\": {\\n \\"Name\\": \\"biz_api\\",\\n \\"EntityType\\": \\"custom_entity-biz_api\\",\\n \\"DisplayName\\": \\"业务API\\",\\n \\"Description\\": \\"test\\",\\n \\"AttributeDefs\\": [\\n {\\n \\"Name\\": \\"apiCode\\",\\n \\"DisplayName\\": \\"API编码\\",\\n \\"Type\\": \\"STRING\\",\\n \\"IsOptional\\": true,\\n \\"SearchFilterEnabled\\": false,\\n \\"DisplayEnabled\\": true,\\n \\"AllowedValues\\": [\\n \\"LABEL_1\\"\\n ],\\n \\"Description\\": \\"层级描述\\"\\n }\\n ],\\n \\"Extend\\": \\"NONE\\",\\n \\"CreateTime\\": 1780553640613,\\n \\"ModifyTime\\": 1780553640613\\n },\\n \\"CreateTime\\": 1780553640613,\\n \\"ModifyTime\\": 1763380628000,\\n \\"Attributes\\": {\\n \\"key\\": \\"v1\\"\\n }\\n }\\n}","type":"json"}]', + ], + 'GetMetaEntityDef' => [ + 'summary' => 'Retrieves the details of a custom entity definition.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'description' => 'The user-defined function (UDF) type. This parameter specifies a filter condition.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Math: mathematical operation function'."\n" - .'* Aggregate: aggregate function'."\n" - .'* String: string processing function'."\n" - .'* Date: date function'."\n" - .'* Analytic: window function'."\n" - .'* Other: other functions'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'MATH', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdideX3KVYR'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ [ - 'name' => 'Name', - 'in' => 'query', + 'name' => 'EntityType', + 'in' => 'formData', + 'schema' => ['description' => 'The entity type. The value must match the regular expression `^custom_(?:entity-[A-Za-z0-9_]+|[A-Za-z0-9_]+-(?:database|table|column))$`.', 'type' => 'string', 'required' => true, 'example' => 'custom_entity-customer_api', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Filter criteria: UDF name. Supports fuzzy search.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'C636A747-7E4E-594D-94CD-2B4F8A9A9A63'], + 'Success' => ['description' => 'Indicates whether the request succeeded.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'MetaEntityDef' => ['description' => 'The custom entity definition.', '$ref' => '#/components/schemas/MetaEntityDef', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'description' => 'The response schema.', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetMetaEntityDef', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C636A747-7E4E-594D-94CD-2B4F8A9A9A63\\",\\n \\"Success\\": true,\\n \\"MetaEntityDef\\": {\\n \\"Name\\": \\"biz_api\\",\\n \\"EntityType\\": \\"custom_entity-biz_api\\",\\n \\"DisplayName\\": \\"业务API\\",\\n \\"Description\\": \\"test\\",\\n \\"AttributeDefs\\": [\\n {\\n \\"Name\\": \\"apiCode\\",\\n \\"DisplayName\\": \\"API编码\\",\\n \\"Type\\": \\"STRING\\",\\n \\"IsOptional\\": true,\\n \\"SearchFilterEnabled\\": false,\\n \\"DisplayEnabled\\": true,\\n \\"AllowedValues\\": [\\n \\"LABEL_1\\"\\n ],\\n \\"Description\\": \\"层级描述\\"\\n }\\n ],\\n \\"Extend\\": \\"NONE\\",\\n \\"CreateTime\\": 1780553640613,\\n \\"ModifyTime\\": 1780553640613\\n }\\n}","type":"json"}]', + ], + 'GetNetwork' => [ + 'summary' => 'Queries the information about a network resource.', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: 1. Minimum value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '245177', + 'abilityTreeNodes' => ['FEATUREdide2SV6DS'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ [ - 'name' => 'PageSize', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: 1. Minimum value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '10', - 'example' => '10', - 'default' => '10', - ], + 'schema' => ['description' => 'The network ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1000', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '89FB2BF0-EB00-5D03-9C34-05931001XXXX', - ], - 'PagingInfo' => [ - 'description' => 'The pagination information.'."\n", + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'example' => 'true'], + 'Network' => [ + 'title' => '', + 'description' => 'The information about the network resource.', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '294', - ], - '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', - ], - 'Functions' => [ - 'description' => 'The function list.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Information about the elements in the function list.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '资源名称', - 'description' => 'The UDF name.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'Function name', - 'pattern' => '', - 'default' => '', - ], - 'CreateTime' => [ - 'title' => '创建时间', - 'description' => 'The timestamp when the UDF was created.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'deprecated' => false, - 'example' => '1655953028000', - 'pattern' => '', - 'default' => '', - ], - 'ProjectId' => [ - 'title' => '项目Id', - 'description' => 'The ID of the project to which the UDF belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'deprecated' => false, - 'example' => '307XXX', - 'pattern' => '', - 'default' => '', - ], - 'Owner' => [ - 'title' => '责任人', - 'description' => 'The owner of the UDF.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => '110755000425XXXX', - 'pattern' => '', - 'default' => '', - ], - 'Type' => [ - 'title' => '函数类型', - 'description' => 'The UDF type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Math: Mathematical operation functions'."\n" - .'* Aggregate: Aggregation functions'."\n" - .'* String: String processing functions'."\n" - .'* Date: Date functions'."\n" - .'* Analytic: Window functions'."\n" - .'* Other: Other functions'."\n", - 'type' => 'string', - 'deprecated' => false, - 'enumValueTitles' => [], - 'example' => 'MATH', - 'pattern' => '', - 'default' => '', - ], - 'ModifyTime' => [ - 'title' => '修改时间', - 'description' => 'The modification time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'deprecated' => false, - 'example' => '1655953028000'."\n", - 'pattern' => '', - 'default' => '', - ], - 'ClassName' => [ - 'title' => '函数实现类名', - 'description' => 'The fully qualified class name of the UDF.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'com.demo.Main', - 'pattern' => '', - 'default' => '', - ], - 'ArmResource' => [ - 'title' => 'ARM集群资源文件列表', - 'description' => 'The list of resource files for the ARM cluster.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'xxx.jar,yyy.jar', - 'pattern' => '', - 'default' => '', - ], - 'FileResource' => [ - 'title' => '函数的实现代码', - 'description' => 'The implementation code of the function and the list of resource files.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'xxx.jar,yyy.jar', - 'pattern' => '', - 'default' => '', - ], - 'Description' => [ - 'title' => '描述', - 'description' => 'The general description of the function.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'Description', - 'pattern' => '', - 'default' => '', - ], - 'CommandDescription' => [ - 'title' => '命令描述', - 'description' => 'The command description.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'testUdf(xx,yy)', - 'pattern' => '', - 'default' => '', - ], - 'ParameterDescription' => [ - 'title' => '命令描述', - 'description' => 'The parameter description.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'xx: parameter information XXX'."\n" - .'yy: parameter information YYY', - 'pattern' => '', - 'default' => '', - ], - 'ReturnValueDescription' => [ - 'title' => '返回值说明', - 'description' => 'The return value description.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'The return value is a string.', - 'pattern' => '', - 'default' => '', - ], - 'ExampleDescription' => [ - 'title' => '示例说明', - 'description' => 'The example description.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'Example description >>> select tsetUdf(xx,yy);'."\n" - .'abc', - 'pattern' => '', - 'default' => '', - ], - 'EmbeddedCodeType' => [ - 'title' => '嵌套代码类型', - 'description' => 'The nested code type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Python2'."\n" - .'* Python3'."\n" - .'* Java8'."\n" - .'* Java11'."\n" - .'* Java17'."\n", - 'type' => 'string', - 'deprecated' => false, - 'enumValueTitles' => [], - 'example' => 'Python2', - 'pattern' => '', - 'default' => '', - ], - 'EmbeddedResourceType' => [ - 'title' => '嵌套资源类型', - 'description' => 'The nested resource type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* File: General resource file.'."\n" - .'* Embedded: Embedded resource.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'enumValueTitles' => [], - 'example' => 'File', - 'pattern' => '', - 'default' => '', - ], - 'EmbeddedCode' => [ - 'title' => '嵌套函数代码内容', - 'description' => 'Content of the nested function code'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'print(\'hello,world!\')', - 'pattern' => '', - 'default' => '', - ], - 'DatabaseName' => [ - 'title' => '数据库名', - 'description' => 'The database name. This parameter is used only when the function type is EMR Function.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'odps_first', - 'pattern' => '', - 'default' => '', - ], - 'DataSource' => [ - 'title' => '数据源', - 'description' => 'Data source information of the UDF.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '数据源名称', - 'description' => 'The name of the data source.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'odps_first', - 'pattern' => '', - 'default' => '', - ], - 'Type' => [ - 'title' => '数据源类型', - 'description' => 'The type of the data source.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'odps', - 'pattern' => '', - 'default' => '', - ], - ], - 'deprecated' => false, - ], - 'Script' => [ - 'title' => '脚本信息', - 'description' => 'Script information of the UDF.'."\n", - 'type' => 'object', - 'properties' => [ - 'Path' => [ - 'title' => '脚本路径', - 'description' => 'The script path.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'XXX/OpenAPI/function/function_name', - 'pattern' => '', - 'default' => '', - ], - 'Runtime' => [ - 'title' => '运行时', - 'description' => 'Runtime'."\n", - 'type' => 'object', - 'properties' => [ - 'Command' => [ - 'title' => '命令', - 'description' => 'Command'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'ODPS_FUNCTION', - 'pattern' => '', - 'default' => '', - ], - ], - 'deprecated' => false, - ], - 'Id' => [ - 'description' => 'The ID of the script.'."\n" - ."\n" - .'> This field is of type Long in SDK versions prior to 8.0.0, and of type String in SDK version 8.0.0 and later. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. However, compilation failures may occur due to the type change only when upgrading the SDK across version 8.0.0. In this case, you must manually update the data type.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => '652567824470354XXXX', - 'title' => '', - ], - ], - 'deprecated' => false, - 'required' => false, - ], - 'RuntimeResource' => [ - 'title' => '运行时资源组信息', - 'description' => 'The runtime resource group information.'."\n", - 'type' => 'object', - 'properties' => [ - 'ResourceGroupId' => [ - 'title' => '运行时资源组Id', - 'description' => 'The runtime resource group ID.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'S_resgrop_xxx', - 'pattern' => '', - 'default' => '', - ], - ], - 'deprecated' => false, - ], - 'Id' => [ - 'description' => 'The unique identifier of the UDF.'."\n" - ."\n" - .'> Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.'."\n", - 'type' => 'string', - 'example' => '580667964888595XXXX', - 'title' => '', - ], - ], - ], + 'Id' => ['description' => 'The network ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''], + 'ResourceGroupId' => ['description' => 'The ID of the serverless resource group.', 'type' => 'string', 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX', 'title' => ''], + 'VpcId' => ['description' => 'The ID of the virtual private cloud (VPC).', 'type' => 'string', 'example' => 'vpc-m2et4f3oc8msfbccXXXXX', 'title' => ''], + 'VswitchId' => ['description' => 'The VSwitch ID.', 'type' => 'string', 'example' => 'vsw-uf8usrhs7hjd9amsXXXXX', 'title' => ''], + 'SecurityGroupId' => ['description' => 'The security group ID.', 'type' => 'string', 'example' => 'sg-2ze13vamugr7jenXXXXX', 'title' => ''], + 'Status' => [ + 'description' => 'The status of the network resource. Valid values:'."\n" + ."\n" + .'- Pending: The network resource is waiting to be created.'."\n" + ."\n" + .'- Creating: The network resource is being created.'."\n" + ."\n" + .'- Running: The network resource is running as expected.'."\n" + ."\n" + .'- Deleting: The network resource is being deleted.'."\n" + ."\n" + .'- Deleted: The network resource is deleted.', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'Running', + 'enum' => ['Pending', 'Running', 'Deleting', 'Deleted', 'Creating'], + 'title' => '', ], + 'CreateUser' => ['description' => 'The ID of the user who creates the network resource.', 'type' => 'string', 'example' => '11075500042XXXXX', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the network resource was created. The value is a 64-bit timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1727055811000', 'title' => ''], ], + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"89FB2BF0-EB00-5D03-9C34-05931001XXXX\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 294,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Functions\\": [\\n {\\n \\"Name\\": \\"Function name\\",\\n \\"CreateTime\\": 1655953028000,\\n \\"ProjectId\\": 0,\\n \\"Owner\\": \\"110755000425XXXX\\",\\n \\"Type\\": \\"Math\\",\\n \\"ModifyTime\\": 1655953028000,\\n \\"ClassName\\": \\"com.demo.Main\\",\\n \\"ArmResource\\": \\"xxx.jar,yyy.jar\\",\\n \\"FileResource\\": \\"xxx.jar,yyy.jar\\",\\n \\"Description\\": \\"Description\\",\\n \\"CommandDescription\\": \\"testUdf(xx,yy)\\",\\n \\"ParameterDescription\\": \\"xx: parameter information XXX\\\\nyy: parameter information YYY\\",\\n \\"ReturnValueDescription\\": \\"The return value is a string.\\",\\n \\"ExampleDescription\\": \\"Example description >>> select tsetUdf(xx,yy);\\\\nabc\\",\\n \\"EmbeddedCodeType\\": \\"Python2\\",\\n \\"EmbeddedResourceType\\": \\"File\\",\\n \\"EmbeddedCode\\": \\"print(\'hello,world!\')\\",\\n \\"DatabaseName\\": \\"EMR_lake\\",\\n \\"DataSource\\": {\\n \\"Name\\": \\"odps_first\\",\\n \\"Type\\": \\"odps\\"\\n },\\n \\"Script\\": {\\n \\"Path\\": \\"XXX/OpenAPI/function/function_name\\",\\n \\"Runtime\\": {\\n \\"Command\\": \\"ODPS_FUNCTION\\"\\n },\\n \\"Id\\": \\"652567824470354XXXX\\"\\n },\\n \\"RuntimeResource\\": {\\n \\"ResourceGroupId\\": \\"S_resgrop_xxx\\"\\n },\\n \\"Id\\": \\"580667964888595XXXX\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListFunctions', - ], - 'CreatePipelineRun' => [ - 'summary' => 'Creates a deployment process for entities in the Data Studio (new version).', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Network\\": {\\n \\"Id\\": 1000,\\n \\"ResourceGroupId\\": \\"Serverless_res_group_524257424564736_6831777003XXXXX\\",\\n \\"VpcId\\": \\"vpc-m2et4f3oc8msfbccXXXXX\\",\\n \\"VswitchId\\": \\"vsw-uf8usrhs7hjd9amsXXXXX\\",\\n \\"SecurityGroupId\\": \\"sg-2ze13vamugr7jenXXXXX\\",\\n \\"Status\\": \\"Running\\",\\n \\"CreateUser\\": \\"11075500042XXXXX\\",\\n \\"CreateTime\\": 1727055811000\\n },\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]', + 'title' => 'GetNetwork', + 'description' => 'This API operation is available for all DataWorks editions.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetNetwork', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetNode' => [ + 'summary' => 'Queries the information about a node in DataStudio.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '267910', - 'abilityTreeNodes' => [ - 'FEATUREdide4AR6E0', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236761', + 'abilityTreeNodes' => ['FEATUREdideHO4TQP', 'FEATUREdide8FM783', 'FEATUREdideQUQUVB', 'FEATUREdideIQU97M'], ], 'parameters' => [ [ - '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. You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10000', - 'pattern' => '', - 'default' => '', - ], - ], - [ - 'name' => 'Type', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether to deploy or undeploy the entity. Valid values:'."\n" - ."\n" - .'* Online: deploys the entity.'."\n" - .'* Offline: undeploys the entity.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Online', - ], - ], - [ - 'name' => 'ObjectIds', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The IDs of entities to which you want to apply the process.'."\n" - ."\n" - .'> A process can be applied to only a single entity and its child entities. If you specify multiple entities in the array, the process is applied only to the first entity in the array and its child entities. Make sure that the array in your request contains only one element. Extra elements will be ignored.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the entity to which you want to apply the process, such as the ID of a node or a workflow.'."\n" - ."\n" - .'> A process can be applied to a workflow as a whole. The process cannot be applied to a single node of the workflow.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '476506242076571XXXX', - ], - 'required' => true, - 'maxItems' => 10, - 'minItems' => 1, - ], - ], - [ - 'name' => 'Description', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The description of the process.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'This is a OdpsSQL-node publishing process. The function is XXXX.', - ], + '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.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000', 'title' => ''], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The unique identifier of the Data Studio node.'."\n" + ."\n" + .'> This field is of type Long in SDK versions prior to 8.0.0, and of type String in SDK version 8.0.0 and later. This change does not affect the normal use of the SDK; parameters are still returned according to the type defined in the SDK. Compilation failures due to the type change may occur only when upgrading the SDK across version 8.0.0, in which case users need to manually correct the data type.', 'type' => 'string', 'required' => true, 'example' => '86043887262011****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX', - ], - 'Id' => [ - 'description' => 'The ID of the process.'."\n", - 'type' => 'string', - 'example' => 'a7ef0634-20ec-4a7c-a214-54020f91XXXX'."\n", + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'], + 'Node' => [ + 'description' => 'Data Studio node details.', + 'type' => 'object', + 'properties' => [ + 'ProjectId' => ['description' => 'The DataWorks workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'title' => ''], + 'Name' => ['description' => 'The name of the node.', 'type' => 'string', 'example' => 'Node name', 'title' => ''], + 'Owner' => ['description' => 'The owner of the node.', 'type' => 'string', 'example' => '196596664824XXXX', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the node was created. This value is a UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1700539206000', 'title' => ''], + 'ModifyTime' => ['description' => 'The time when the node was last modified. This value is a UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1700539206000', 'title' => ''], + 'Spec' => ['description' => 'The FlowSpec field information about this node. For more information, see [FlowSpec](https://github.com/aliyun/alibabacloud-dataworks-tool-dflow).', 'type' => 'string', 'example' => '{'."\n" + .' "version": "1.1.0",'."\n" + .' "kind": "Node",'."\n" + .' "spec": {'."\n" + .' "nodes": ['."\n" + .' {'."\n" + .' "recurrence": "Normal",'."\n" + .' "id": "860438872620113XXXX",'."\n" + .' "timeout": 0,'."\n" + .' "instanceMode": "T+1",'."\n" + .' "rerunMode": "Allowed",'."\n" + .' "rerunTimes": 3,'."\n" + .' "rerunInterval": 180000,'."\n" + .' "datasource": {'."\n" + .' "name": "odps_test",'."\n" + .' "type": "odps"'."\n" + .' },'."\n" + .' "script": {'."\n" + .' "language": "odps-sql",'."\n" + .' "path": "XX/OpenAPI_Test/ODPS_SQL_Test",'."\n" + .' "runtime": {'."\n" + .' "command": "ODPS_SQL",'."\n" + .' "commandTypeId": 10'."\n" + .' },'."\n" + .' "content": "select now();",'."\n" + .' "id": "853573334108680XXXX"'."\n" + .' },'."\n" + .' "trigger": {'."\n" + .' "type": "Scheduler",'."\n" + .' "id": "543680677872062XXXX",'."\n" + .' "cron": "00 00 00 * * ?",'."\n" + .' "startTime": "1970-01-01 00:00:00",'."\n" + .' "endTime": "9999-01-01 00:00:00",'."\n" + .' "timezone": "Asia/Shanghai",'."\n" + .' "delaySeconds": 0'."\n" + .' },'."\n" + .' "runtimeResource": {'."\n" + .' "resourceGroup": "S_res_group_XXXX_XXXX",'."\n" + .' "id": "623731286945488XXXX",'."\n" + .' "resourceGroupId": "7201XXXX"'."\n" + .' },'."\n" + .' "name": "ODPS_SQL_Test",'."\n" + .' "owner": "110755000425XXXX",'."\n" + .' "metadata": {'."\n" + .' "owner": "110755000425XXXX",'."\n" + .' "ownerName": "XXXXX@test.XXX.com",'."\n" + .' "projectId": "307XXX"'."\n" + .' },'."\n" + .' "inputs": {'."\n" + .' "nodeOutputs": ['."\n" + .' {'."\n" + .' "data": "lwttest_standard_root",'."\n" + .' "artifactType": "NodeOutput"'."\n" + .' }'."\n" + .' ]'."\n" + .' },'."\n" + .' "outputs": {'."\n" + .' "nodeOutputs": ['."\n" + .' {'."\n" + .' "data": "860438872620113XXXX",'."\n" + .' "artifactType": "NodeOutput",'."\n" + .' "refTableName": "ODPS_SQL_Test",'."\n" + .' "isDefault": true'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' }'."\n" + .' ],'."\n" + .' "flow": ['."\n" + .' {'."\n" + .' "nodeId": "860438872620113XXXX",'."\n" + .' "depends": ['."\n" + .' {'."\n" + .' "type": "Normal",'."\n" + .' "output": "lwttest_standard_root"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' ]'."\n" + .' },'."\n" + .' "metadata": {'."\n" + .' "uuid": "860438872620113XXXX"'."\n" + .' }'."\n" + .'}', 'title' => ''], + 'TaskId' => ['description' => 'The ID of the corresponding scheduling task after the node is published.', 'type' => 'integer', 'format' => 'int64', 'example' => '700006680527', 'title' => ''], + 'Id' => ['description' => 'The unique identifier of the Data Studio node.'."\n" + ."\n" + .'> Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.', 'type' => 'string', 'example' => '860438872620113XXXX'."\n", 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"Node\\": {\\n \\"ProjectId\\": 10000,\\n \\"Name\\": \\"Node name\\",\\n \\"Owner\\": \\"196596664824XXXX\\",\\n \\"CreateTime\\": 1700539206000,\\n \\"ModifyTime\\": 1700539206000,\\n \\"Spec\\": \\"{\\\\n \\\\\\"version\\\\\\": \\\\\\"1.1.0\\\\\\",\\\\n \\\\\\"kind\\\\\\": \\\\\\"Node\\\\\\",\\\\n \\\\\\"spec\\\\\\": {\\\\n \\\\\\"nodes\\\\\\": [\\\\n {\\\\n \\\\\\"recurrence\\\\\\": \\\\\\"Normal\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"860438872620113XXXX\\\\\\",\\\\n \\\\\\"timeout\\\\\\": 0,\\\\n \\\\\\"instanceMode\\\\\\": \\\\\\"T+1\\\\\\",\\\\n \\\\\\"rerunMode\\\\\\": \\\\\\"Allowed\\\\\\",\\\\n \\\\\\"rerunTimes\\\\\\": 3,\\\\n \\\\\\"rerunInterval\\\\\\": 180000,\\\\n \\\\\\"datasource\\\\\\": {\\\\n \\\\\\"name\\\\\\": \\\\\\"odps_test\\\\\\",\\\\n \\\\\\"type\\\\\\": \\\\\\"odps\\\\\\"\\\\n },\\\\n \\\\\\"script\\\\\\": {\\\\n \\\\\\"language\\\\\\": \\\\\\"odps-sql\\\\\\",\\\\n \\\\\\"path\\\\\\": \\\\\\"XX/OpenAPI_Test/ODPS_SQL_Test\\\\\\",\\\\n \\\\\\"runtime\\\\\\": {\\\\n \\\\\\"command\\\\\\": \\\\\\"ODPS_SQL\\\\\\",\\\\n \\\\\\"commandTypeId\\\\\\": 10\\\\n },\\\\n \\\\\\"content\\\\\\": \\\\\\"select now();\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"853573334108680XXXX\\\\\\"\\\\n },\\\\n \\\\\\"trigger\\\\\\": {\\\\n \\\\\\"type\\\\\\": \\\\\\"Scheduler\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"543680677872062XXXX\\\\\\",\\\\n \\\\\\"cron\\\\\\": \\\\\\"00 00 00 * * ?\\\\\\",\\\\n \\\\\\"startTime\\\\\\": \\\\\\"1970-01-01 00:00:00\\\\\\",\\\\n \\\\\\"endTime\\\\\\": \\\\\\"9999-01-01 00:00:00\\\\\\",\\\\n \\\\\\"timezone\\\\\\": \\\\\\"Asia/Shanghai\\\\\\",\\\\n \\\\\\"delaySeconds\\\\\\": 0\\\\n },\\\\n \\\\\\"runtimeResource\\\\\\": {\\\\n \\\\\\"resourceGroup\\\\\\": \\\\\\"S_res_group_XXXX_XXXX\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"623731286945488XXXX\\\\\\",\\\\n \\\\\\"resourceGroupId\\\\\\": \\\\\\"7201XXXX\\\\\\"\\\\n },\\\\n \\\\\\"name\\\\\\": \\\\\\"ODPS_SQL_Test\\\\\\",\\\\n \\\\\\"owner\\\\\\": \\\\\\"110755000425XXXX\\\\\\",\\\\n \\\\\\"metadata\\\\\\": {\\\\n \\\\\\"owner\\\\\\": \\\\\\"110755000425XXXX\\\\\\",\\\\n \\\\\\"ownerName\\\\\\": \\\\\\"XXXXX@test.XXX.com\\\\\\",\\\\n \\\\\\"projectId\\\\\\": \\\\\\"307XXX\\\\\\"\\\\n },\\\\n \\\\\\"inputs\\\\\\": {\\\\n \\\\\\"nodeOutputs\\\\\\": [\\\\n {\\\\n \\\\\\"data\\\\\\": \\\\\\"lwttest_standard_root\\\\\\",\\\\n \\\\\\"artifactType\\\\\\": \\\\\\"NodeOutput\\\\\\"\\\\n }\\\\n ]\\\\n },\\\\n \\\\\\"outputs\\\\\\": {\\\\n \\\\\\"nodeOutputs\\\\\\": [\\\\n {\\\\n \\\\\\"data\\\\\\": \\\\\\"860438872620113XXXX\\\\\\",\\\\n \\\\\\"artifactType\\\\\\": \\\\\\"NodeOutput\\\\\\",\\\\n \\\\\\"refTableName\\\\\\": \\\\\\"ODPS_SQL_Test\\\\\\",\\\\n \\\\\\"isDefault\\\\\\": true\\\\n }\\\\n ]\\\\n }\\\\n }\\\\n ],\\\\n \\\\\\"flow\\\\\\": [\\\\n {\\\\n \\\\\\"nodeId\\\\\\": \\\\\\"860438872620113XXXX\\\\\\",\\\\n \\\\\\"depends\\\\\\": [\\\\n {\\\\n \\\\\\"type\\\\\\": \\\\\\"Normal\\\\\\",\\\\n \\\\\\"output\\\\\\": \\\\\\"lwttest_standard_root\\\\\\"\\\\n }\\\\n ]\\\\n }\\\\n ]\\\\n },\\\\n \\\\\\"metadata\\\\\\": {\\\\n \\\\\\"uuid\\\\\\": \\\\\\"860438872620113XXXX\\\\\\"\\\\n }\\\\n}\\",\\n \\"TaskId\\": 700006680527,\\n \\"Id\\": \\"860438872620113XXXX\\\\n\\"\\n }\\n}","type":"json"}]', + 'title' => 'GetNode', + 'changeSet' => [ + ['createdAt' => '2025-02-18T01:56:57.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-01-13T07:36:01.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX\\",\\n \\"Id\\": \\"a7ef0634-20ec-4a7c-a214-54020f91XXXX\\\\n\\"\\n}","type":"json"}]', - 'title' => 'CreatePipelineRun', - 'description' => '> Batch operations are not currently supported. If you specify multiple entities in the parameters, only the first entity takes effect, and the rest are ignored.'."\n" - ."\n" - .'> This operation may not be available in earlier versions of the SDK. In this case, use the CreateDeployment operation. The parameters for CreateDeployment are the same as those described in this topic.'."\n", - ], - 'AbolishPipelineRun' => [ - 'summary' => 'Terminates the specified deployment process. This operation changes the status of the process to Terminated but does not delete the process. You can still query the process.', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'GetParameter' => [ + 'summary' => 'Gets the details of a parameter by its ID.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '267906', - 'abilityTreeNodes' => [ - 'FEATUREdide4AR6E0', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB'], + 'autoTest' => true, ], '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 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, - 'example' => '10000', - ], - ], [ 'name' => 'Id', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the process.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1606087c-9ac4-43f0-83a8-0b5ced21XXXX'."\n", - ], + 'schema' => ['description' => 'The ID of the parameter.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12345', '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' => '55D786C9-DD57-524D-884C-C5239278XXXX'."\n", - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Parameter' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the parameter.', 'type' => 'integer', 'format' => 'int64', 'example' => '12345', 'title' => ''], + 'Name' => ['description' => 'The name of the parameter.', 'type' => 'string', 'example' => 'workspace.para', 'title' => ''], + 'Type' => ['description' => 'The type of the parameter. Valid values:'."\n" + ."\n" + .'- `PlainConstant`: a constant in plaintext.'."\n" + ."\n" + .'- `SecretConstant`: a constant in ciphertext.'."\n" + ."\n" + .'- `Variable`: a variable.', 'type' => 'string', 'example' => 'PlainConstant', 'title' => ''], + 'Scope' => ['description' => 'The scope of the parameter.', 'type' => 'string', 'example' => 'Project', 'title' => ''], + 'ProjectId' => ['description' => 'The ID of the workspace.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''], + 'Version' => ['description' => 'The version of the parameter.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Description' => ['description' => 'The description of the parameter.', 'type' => 'string', 'example' => 'This is a test parameter.', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the parameter was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1640000000000', 'title' => ''], + 'ModifyTime' => ['description' => 'The time when the parameter was last modified.', 'type' => 'integer', 'format' => 'int64', 'example' => '1640000000000', 'title' => ''], + 'Owner' => ['description' => 'The owner of the parameter.', 'type' => 'string', 'example' => '123456789', 'title' => ''], + 'CreateUser' => ['description' => 'The creator of the parameter.', 'type' => 'string', 'example' => '123456789', 'title' => ''], + 'ModifyUser' => ['description' => 'The modifier of the parameter.', 'type' => 'string', 'example' => '123456789', 'title' => ''], + 'Properties' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EnvType' => ['description' => 'The project environment. Valid values:'."\n" + ."\n" + .'- `Prod`: production.'."\n" + ."\n" + .'- `Dev`: development.', 'type' => 'string', 'example' => 'Prod', 'title' => ''], + 'Value' => ['description' => 'The value of the parameter.', 'type' => 'string', 'example' => 'value123', 'title' => ''], + ], + 'title' => '', + 'description' => 'A value configuration of the parameter.', + 'example' => '', + ], + 'title' => '', + 'description' => 'The value configurations of the parameter.', + 'example' => '', + ], + ], + 'title' => '', + 'description' => 'The details of the parameter.', + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', 'title' => ''], ], + 'title' => '', + 'description' => 'The response object.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetParameter', + 'description' => 'This operation is available only in DataWorks Professional Edition or later.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"55D786C9-DD57-524D-884C-C5239278XXXX\\\\n\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'AbolishPipelineRun', - 'description' => '> This operation may not be available in earlier versions of the SDK. In this case, use the AbolishDeployment operation. The parameters for AbolishDeployment are the same as those described in this topic.'."\n", + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Parameter\\": {\\n \\"Id\\": 12345,\\n \\"Name\\": \\"workspace.para\\",\\n \\"Type\\": \\"PlainConstant\\",\\n \\"Scope\\": \\"Project\\",\\n \\"ProjectId\\": 1000,\\n \\"Version\\": 1,\\n \\"Description\\": \\"This is a test parameter.\\",\\n \\"CreateTime\\": 1640000000000,\\n \\"ModifyTime\\": 1640000000000,\\n \\"Owner\\": \\"123456789\\",\\n \\"CreateUser\\": \\"123456789\\",\\n \\"ModifyUser\\": \\"123456789\\",\\n \\"Properties\\": [\\n {\\n \\"EnvType\\": \\"Prod\\",\\n \\"Value\\": \\"value123\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]', + 'translator' => 'manual', ], - 'ExecPipelineRunStage' => [ - 'summary' => 'Executes a stage in a process.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetPartition' => [ + 'summary' => 'Retrieves partition details for a data map table. Currently supports MaxCompute and HMS (EMR cluster) types only.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '267908', - 'abilityTreeNodes' => [ - 'FEATUREdide4AR6E0', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'abilityTreeCode' => '268141', + 'abilityTreeNodes' => ['FEATUREdideE9XYA6'], ], 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'TableId', '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, - 'example' => '10000', - ], - ], - [ - 'name' => 'Id', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the process.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'a7ef0634-20ec-4a7c-a214-54020f91XXXX', - ], + 'schema' => ['description' => 'The table ID. You can refer to the result returned by the ListTables operation and [Concepts related to metadata entities](~~2880092~~).', 'type' => 'string', 'required' => true, 'example' => 'maxcompute-table:::project_name:[schema_name]:table_name', 'title' => ''], ], [ - 'name' => 'Code', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The code of the stage in the process. You can call the GetDeployment operation to query the code.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'DEV_CHECK', - ], + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The partition name.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'ds=20250101'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'AFBB799F-8578-51C5-A766-E922EDB8XXXX'."\n", - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - ."\n" - .'* false'."\n" - ."\n" - .' **'."\n" - ."\n" - .' **Note:** The value of this parameter indicates only whether the stage is triggered but does not indicate whether the execution of the stage is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'Partition' => ['description' => 'Partition details.', '$ref' => '#/components/schemas/Partition', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AFBB799F-8578-51C5-A766-E922EDB8XXXX\\\\n\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'ExecPipelineRunStage', - 'description' => '> The stages in a process are sequential. For more information, see the GetDeployment operation. Skipping or repeating a stage is not allowed.'."\n" + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx\\",\\n \\"Success\\": true,\\n \\"Partition\\": {\\n \\"TableId\\": \\"maxcompute-table:accountId::project::table\\",\\n \\"Name\\": \\"ds=20250101\\",\\n \\"CreateTime\\": 1700192563000,\\n \\"ModifyTime\\": 1700192563000,\\n \\"RecordCount\\": 1000000,\\n \\"DataSize\\": 4096\\n }\\n}","type":"json"}]', + 'title' => 'GetPartition', + 'description' => '1. DataWorks Basic Edition or a higher edition is required.'."\n" ."\n" - .'> The execution of a stage is asynchronous. The response of this operation indicates only whether a stage is triggered but does not indicate whether the execution of the stage is successful. You can call the GetDeployment operation to check whether the execution is successful.'."\n", + .'2. Only MaxCompute and HMS (EMR cluster) table types are supported.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], ], 'GetPipelineRun' => [ - 'summary' => 'Queries the information about a process for deploying or undeploying an entity.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'summary' => 'Gets the details of a Deployment Process.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -17918,282 +21655,192 @@ 'riskType' => 'none', 'chargeType' => 'free', 'abilityTreeCode' => '267907', - 'abilityTreeNodes' => [ - 'FEATUREdide4AR6E0', - ], + 'abilityTreeNodes' => ['FEATUREdide4AR6E0'], ], '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, - 'example' => '10000', - ], + 'schema' => ['description' => 'The ID of the DataWorks workspace. You can find this ID on the Workspace Management page in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n" + ."\n" + .'This parameter specifies the DataWorks workspace for the API call.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000', 'title' => ''], ], [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'title' => '实例 ID。', - 'description' => 'The ID of the process.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'a7ef0634-20ec-4a7c-a214-54020f****'."\n", - ], + 'schema' => ['description' => 'The unique identifier of the Publishing Pipeline.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'a7ef0634-20ec-4a7c-a214-54020f****'."\n"], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '08468352-032C-5262-AEDC-68C9FA05XXXX', - ], + 'RequestId' => ['description' => 'The ID of the request. You can use this ID to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => '08468352-032C-5262-AEDC-68C9FA05XXXX', 'title' => ''], 'Pipeline' => [ - 'description' => 'The information about the process.'."\n", + 'description' => 'The details of the pipeline run.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '发布流程Id', - 'description' => 'The process ID.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'a7ef0634-20ec-4a7c-a214-54020f91XXXX'."\n", - 'pattern' => '', - 'default' => '', - ], - 'ProjectId' => [ - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '56160', - ], - 'CreateTime' => [ - 'title' => '发布包创建时间戳', - 'description' => 'The time when the process was created. This value is a UNIX timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1724984066000', - ], - 'ModifyTime' => [ - 'title' => '修改时间', - 'description' => 'The time when the process was modified. This value is a UNIX timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'deprecated' => false, - 'example' => '1724984066000', - 'pattern' => '', - 'default' => '', - ], - 'Creator' => [ - 'title' => '创建人', - 'description' => 'The creator of the process.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => '137946317766XXXX', - 'pattern' => '', - 'default' => '', - ], + 'Id' => ['description' => 'The ID of the pipeline run.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'a7ef0634-20ec-4a7c-a214-54020f91XXXX'."\n"], + 'ProjectId' => ['description' => 'The ID of the DataWorks workspace.', 'type' => 'integer', 'format' => 'int64', 'example' => '56160', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the pipeline run was created. 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', 'title' => '', 'example' => '1724984066000'], + 'ModifyTime' => ['description' => 'The time when the pipeline run 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.', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '1724984066000'], + 'Creator' => ['description' => 'The ID of the user who created the pipeline run.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '137946317766XXXX'], 'Status' => [ - 'title' => '发布流程状态', - 'description' => 'The status of the process.'."\n" + 'description' => 'The status of the pipeline run.'."\n" ."\n" .'Valid values:'."\n" ."\n" - .'* Init'."\n" - .'* Running'."\n" - .'* Success'."\n" - .'* Fail'."\n" - .'* Termination'."\n" - .'* Cancel'."\n", + .'- `Init`: The pipeline run is being initialized.'."\n" + ."\n" + .'- `Running`: The pipeline run is in progress.'."\n" + ."\n" + .'- `Success`: The pipeline run succeeded.'."\n" + ."\n" + .'- `Fail`: The pipeline run failed.'."\n" + ."\n" + .'- `Terminated`: The pipeline run was terminated.'."\n" + ."\n" + .'- `Canceled`: The pipeline run was canceled.', 'type' => 'string', 'deprecated' => false, - 'example' => 'Running', 'pattern' => '', 'default' => '', - 'enum' => [ - 'Init', - 'Running', - 'Success', - 'Fail', - 'Termination', - 'Cancel', - ], - ], - 'Message' => [ - 'description' => 'The error message returned when the process fails.'."\n", - 'type' => 'string', - 'example' => 'Error message', + 'enum' => ['Init', 'Running', 'Success', 'Fail', 'Termination', 'Cancel'], + 'title' => '', + 'example' => 'Running', ], + 'Message' => ['description' => 'The error message returned if the pipeline run fails.', 'type' => 'string', 'example' => 'Error message', 'title' => ''], 'Stages' => [ - 'title' => '步骤详情', - 'description' => 'The information about stages in the process.'."\n", + 'title' => '', + 'description' => 'The stages in the pipeline run.', 'type' => 'array', 'items' => [ - 'title' => 'stage的元素', - 'description' => 'The information about a stage in the process.'."\n", + 'title' => '', + 'description' => 'The details of a stage.', 'type' => 'object', 'properties' => [ - 'Code' => [ - 'title' => '阶段代号', - 'description' => 'The code of the stage.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'DEV_CHECK', - 'pattern' => '', - 'default' => '', - ], - 'Step' => [ - 'title' => '步骤', - 'description' => 'The step number of the stage.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'deprecated' => false, - 'example' => '1', - 'pattern' => '', - 'default' => '', - ], + 'Code' => ['description' => 'The code that identifies the stage.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'DEV_CHECK'], + 'Step' => ['description' => 'The sequence number of the stage within the pipeline.', 'type' => 'integer', 'format' => 'int32', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '1'], 'Type' => [ - 'title' => '阶段类型', 'description' => 'The type of the stage.'."\n" ."\n" .'Valid values:'."\n" ."\n" - .'* Deploy'."\n" - .'* Check'."\n" - .'* Offline'."\n" - .'* Build'."\n" - .'* Delete'."\n", - 'type' => 'string', - 'deprecated' => false, - 'enumValueTitles' => [ - 'Delete' => 'Delete', - 'Build' => 'Build', - 'Check' => 'Check', - 'Offline' => 'Offline', - 'Deploy' => 'Deploy', - ], - 'example' => 'Check', - 'pattern' => '', - 'default' => '', - ], - 'Name' => [ - 'title' => '阶段名称', - 'description' => 'The name of the stage.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'Publish package build', - 'pattern' => '', - 'default' => '', - ], - 'Description' => [ - 'title' => '阶段描述', - 'description' => 'The description of the stage.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'Phase description', - 'pattern' => '', - 'default' => '', - ], - 'Message' => [ - 'title' => '阶段信息', - 'description' => 'The error message returned for the stage.'."\n", + .'- `Deploy`: A deployment operation.'."\n" + ."\n" + .'- `Check`: A check operation.'."\n" + ."\n" + .'- `Offline`: An offline operation.'."\n" + ."\n" + .'- `Build`: A build operation.'."\n" + ."\n" + .'- `Delete`: A delete operation.', + 'enumValueTitles' => ['Delete' => '', 'Build' => '', 'Check' => '', 'Offline' => '', 'Deploy' => ''], 'type' => 'string', 'deprecated' => false, - 'example' => 'Exception information XXX', 'pattern' => '', 'default' => '', + 'title' => '', + 'example' => 'Check', ], + 'Name' => ['description' => 'The name of the stage.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'Publish package build'], + 'Description' => ['description' => 'The description of the stage.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'Phase description'], + 'Message' => ['description' => 'The exception message returned if the stage fails.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'Exception information XXX'], 'Status' => [ - 'title' => '阶段状态', 'description' => 'The status of the stage.'."\n" ."\n" .'Valid values:'."\n" ."\n" - .'* Init'."\n" - .'* Running'."\n" - .'* Success'."\n" - .'* Fail'."\n" - .'* Termination'."\n" - .'* Cancel'."\n", + .'- `Init`: The stage is being initialized.'."\n" + ."\n" + .'- `Running`: The stage is in progress.'."\n" + ."\n" + .'- `Success`: The stage succeeded.'."\n" + ."\n" + .'- `Fail`: The stage failed.'."\n" + ."\n" + .'- `Terminated`: The stage was terminated.'."\n" + ."\n" + .'- `Canceled`: The stage was canceled.', + 'enumValueTitles' => ['Init' => '', 'Cancel' => '', 'Running' => '', 'Termination' => '', 'Success' => '', 'Fail' => ''], 'type' => 'string', 'deprecated' => false, - 'enumValueTitles' => [ - 'Init' => 'Init', - 'Cancel' => 'Cancel', - 'Running' => 'Running', - 'Termination' => 'Termination', - 'Success' => 'Success', - 'Fail' => 'Fail', - ], - 'example' => 'Running', 'pattern' => '', 'default' => '', + 'title' => '', + 'example' => 'Running', ], 'Detail' => [ - 'description' => 'The details of the stage.'."\n", + 'description' => 'Detailed information about the stage.', 'type' => 'object', 'deprecated' => false, - 'additionalProperties' => [ - 'type' => 'any', - 'description' => 'The additional information about the stage.'."\n", - 'example' => '"checkerList": ['."\n" - .' {'."\n" - .' "code": "BuildPackageChecker",'."\n" - .' "name": "Build_Package_Checker"'."\n" - .' },'."\n" - .' {'."\n" - .' "code": "NodeParentDependency",'."\n" - .' "name": "Downstream_Dependency_Checker"'."\n" - .' },'."\n" - .' {'."\n" - .' "code": "NodeInProcess",'."\n" - .' "name": "Decommissioning_Process_Checker"'."\n" - .' }'."\n" - .']'."\n", - ], + 'additionalProperties' => ['description' => 'Additional key-value pairs that provide more information about the stage.', 'type' => 'any', 'example' => '"checkerList": ['."\n" + .' {'."\n" + .' "code": "BuildPackageChecker",'."\n" + .' "name": "Build_Package_Checker"'."\n" + .' },'."\n" + .' {'."\n" + .' "code": "NodeParentDependency",'."\n" + .' "name": "Downstream_Dependency_Checker"'."\n" + .' },'."\n" + .' {'."\n" + .' "code": "NodeInProcess",'."\n" + .' "name": "Decommissioning_Process_Checker"'."\n" + .' }'."\n" + .']'."\n", 'title' => ''], + 'title' => '', + 'example' => '', ], ], 'deprecated' => false, + 'example' => '', ], 'deprecated' => false, + 'example' => '', ], - 'Description' => [ - 'title' => '发布流程的描述信息', - 'type' => 'string', - 'example' => '发布流程描述信息', - ], + 'Description' => ['description' => 'The description of the pipeline run.', 'type' => 'string', 'example' => '发布流程描述信息', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"08468352-032C-5262-AEDC-68C9FA05XXXX\\",\\n \\"Pipeline\\": {\\n \\"Id\\": \\"a7ef0634-20ec-4a7c-a214-54020f91XXXX\\\\n\\",\\n \\"ProjectId\\": 56160,\\n \\"CreateTime\\": 1724984066000,\\n \\"ModifyTime\\": 1724984066000,\\n \\"Creator\\": \\"137946317766XXXX\\",\\n \\"Status\\": \\"Running\\",\\n \\"Message\\": \\"Error message\\",\\n \\"Stages\\": [\\n {\\n \\"Code\\": \\"DEV_CHECK\\",\\n \\"Step\\": 1,\\n \\"Type\\": \\"Check\\",\\n \\"Name\\": \\"Publish package build\\",\\n \\"Description\\": \\"Phase description\\",\\n \\"Message\\": \\"Exception information XXX\\",\\n \\"Status\\": \\"Running\\",\\n \\"Detail\\": {\\n \\"key\\": \\"\\\\\\"checkerList\\\\\\": [\\\\n {\\\\n \\\\\\"code\\\\\\": \\\\\\"BuildPackageChecker\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"Build_Package_Checker\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"code\\\\\\": \\\\\\"NodeParentDependency\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"Downstream_Dependency_Checker\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"code\\\\\\": \\\\\\"NodeInProcess\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"Decommissioning_Process_Checker\\\\\\"\\\\n }\\\\n]\\\\n\\"\\n }\\n }\\n ],\\n \\"Description\\": \\"发布流程描述信息\\"\\n }\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'GetPipelineRun', - ], - 'ListPipelineRuns' => [ - 'summary' => 'Queries a list of processes that are used to deploy or undeploy entities in DataStudio. You can also specify filter conditions to query specific processes.', - 'methods' => [ - 'get', + 'description' => '>'."\n" + ."\n" + .'For earlier SDK versions that do not include this API, use the GetDeployment API with the same parameters described in this document.'."\n" + ."\n" + .'>', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"08468352-032C-5262-AEDC-68C9FA05XXXX\\",\\n \\"Pipeline\\": {\\n \\"Id\\": \\"a7ef0634-20ec-4a7c-a214-54020f91XXXX\\\\n\\",\\n \\"ProjectId\\": 56160,\\n \\"CreateTime\\": 1724984066000,\\n \\"ModifyTime\\": 1724984066000,\\n \\"Creator\\": \\"137946317766XXXX\\",\\n \\"Status\\": \\"Running\\",\\n \\"Message\\": \\"Error message\\",\\n \\"Stages\\": [\\n {\\n \\"Code\\": \\"DEV_CHECK\\",\\n \\"Step\\": 1,\\n \\"Type\\": \\"Check\\",\\n \\"Name\\": \\"Publish package build\\",\\n \\"Description\\": \\"Phase description\\",\\n \\"Message\\": \\"Exception information XXX\\",\\n \\"Status\\": \\"Running\\",\\n \\"Detail\\": {\\n \\"key\\": \\"\\\\\\"checkerList\\\\\\": [\\\\n {\\\\n \\\\\\"code\\\\\\": \\\\\\"BuildPackageChecker\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"Build_Package_Checker\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"code\\\\\\": \\\\\\"NodeParentDependency\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"Downstream_Dependency_Checker\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"code\\\\\\": \\\\\\"NodeInProcess\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"Decommissioning_Process_Checker\\\\\\"\\\\n }\\\\n]\\\\n\\"\\n }\\n }\\n ],\\n \\"Description\\": \\"发布流程描述信息\\"\\n }\\n}","type":"json"}]', + ], + 'GetProcessDefinition' => [ + 'summary' => 'Retrieves the approval policy for a given process definition ID.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -18202,360 +21849,230 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '267909', - 'abilityTreeNodes' => [ - 'FEATUREdide4AR6E0', - ], + 'abilityTreeCode' => '244495', + 'abilityTreeNodes' => ['FEATUREdideYTM537'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], '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, - 'example' => '10000', - ], - ], - [ - 'name' => 'Creator', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the user who creates the processes. This parameter specifies a filter condition.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '110755000425****'."\n", - ], - ], - [ - 'name' => 'Status', - 'in' => 'query', - 'schema' => [ - 'description' => 'The status of the processes. This parameter specifies a filter condition.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Init'."\n" - .'* Running'."\n" - .'* Success'."\n" - .'* Fail'."\n" - .'* Termination'."\n" - .'* Cancel'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Running', - ], - ], - [ - 'name' => 'ObjectId', - 'in' => 'query', - 'schema' => [ - 'title' => '发布物的ID', - 'type' => 'string', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], - ], - [ - 'name' => 'PageSize', + 'name' => 'Id', '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' => '10', - 'example' => '10', - 'default' => '10', - ], + 'schema' => ['description' => 'The ID of the process definition.', 'type' => 'string', 'required' => true, 'example' => 'f0d6d578-a305-40ac-ba1e-0a09f64cbc69', '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' => '7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX'."\n", - ], - 'PagingInfo' => [ - 'description' => 'The pagination information.'."\n", + 'RequestId' => ['description' => 'API request ID', 'type' => 'string', 'title' => '', 'example' => '0bc5df3a17***903790e8e8a'], + 'ProcessDefinition' => [ 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2524', - ], - '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', + 'Id' => ['description' => 'Process definition ID', 'type' => 'string', 'example' => '210001039767', 'title' => ''], + 'Name' => ['description' => 'Process definition name', 'type' => 'string', 'example' => 'MaxCompute 表审批', 'title' => ''], + 'Description' => ['description' => 'The description of the business process.', 'type' => 'string', 'example' => '订单业务数据审批流程', 'title' => ''], + 'Type' => ['description' => 'Process definition type. Valid values:'."\n" + ."\n" + .'- MaxCompute'."\n" + ."\n" + .'- DataService'."\n" + ."\n" + .'- Extension'."\n" + ."\n" + .'- Hologres'."\n" + ."\n" + .'- DlfV1 (Custom creation not supported).'."\n" + ."\n" + .'- EMR (Custom creation not supported).'."\n" + ."\n" + .'- DataAssetGovernance (Custom creation not supported).'."\n" + ."\n" + .'- Lindorm (Custom creation not supported).'."\n" + ."\n" + .'- StarRocks (Custom creation not supported).'."\n" + ."\n" + .'- DlfNext (Custom creation not supported).'."\n" + ."\n" + .'- DataWorks (Custom creation not supported).', 'type' => 'string', 'example' => 'MaxCompute', 'title' => ''], + 'SubType' => ['description' => 'Subtype:'."\n" + ."\n" + .'- Table'."\n" + ."\n" + .'- Column'."\n" + ."\n" + .'- Database'."\n" + ."\n" + .'- Schema'."\n" + ."\n" + .'- Default', 'type' => 'string', 'example' => 'Table', 'title' => ''], + 'IsSystem' => ['description' => 'System Default Policy', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Enabled' => ['description' => 'Enable', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RuleConditions' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The condition type. This is an enumeration:'."\n" + ."\n" + .'- `odpsProject`,'."\n" + ."\n" + .'- `hologresInstanceId`'."\n" + ."\n" + .'- `sensibleLevel`,'."\n" + ."\n" + .'- `tableGuid`,'."\n" + ."\n" + .'- `projectId`', 'type' => 'string', 'example' => 'odpsProject', 'title' => ''], + 'Expression' => ['description' => 'A conditional expression is in the format `((#type==\'typeValue\'))`, such as `((#odpsProject==\'PX_BEIJING_TEST\'))`.', 'type' => 'string', 'example' => '((#odpsProject==\'PX_BEIJING_TEST\'))', 'title' => ''], + 'Scope' => ['description' => 'rule effective stage:'."\n" + ."\n" + .'- `Deployment` determines whether an application matches this approval policy upon submission.'."\n" + ."\n" + .'- `Running` is used to determine whether an approval process is approval-free. This feature is supported only for the MaxCompute type.', 'type' => 'string', 'example' => 'Deployment', 'title' => ''], + ], + 'description' => 'Rule condition', + 'title' => '', + 'example' => '', + ], + 'description' => 'List of rule conditions', + 'title' => '', + 'example' => '', ], - 'PipelineRuns' => [ - 'description' => 'The processes.'."\n", + 'NotificationServices' => [ 'type' => 'array', 'items' => [ - 'description' => 'The information about the process.'."\n", 'type' => 'object', 'properties' => [ - 'Id' => [ - 'title' => '发布流程Id', - 'description' => 'The process ID.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => '097c73fe-ed6e-4fb1-b109-a5d59e46cd58', - 'pattern' => '', - 'default' => '', - ], - 'ProjectId' => [ - 'title' => '项目Id', - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'deprecated' => false, - 'example' => '70199', - 'pattern' => '', - 'default' => '', - ], - 'CreateTime' => [ - 'title' => '发布包创建时间戳', - 'description' => 'The time when the process was created. This value is a UNIX timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1702736654000', - ], - 'ModifyTime' => [ - 'title' => '修改时间', - 'description' => 'The time when the process was modified. This value is a UNIX timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'deprecated' => false, - 'example' => '1702736654000', - 'pattern' => '', - 'default' => '', - ], - 'Creator' => [ - 'title' => '创建人', - 'description' => 'The creator of the process.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => '110755000425XXXX', - 'pattern' => '', - 'default' => '', - ], - 'Status' => [ - 'title' => '发布流程状态', - 'description' => 'The status of the process.'."\n" + 'Channel' => ['description' => 'Notification channel, an enumeration:'."\n" + ."\n" + .'- Mail'."\n" + ."\n" + .'- Sms'."\n" + ."\n" + .'- DingRobot'."\n" + ."\n" + .'- Weixin', 'type' => 'string', 'example' => 'DingRobot', 'title' => ''], + 'Extension' => ['description' => 'Additional information in JSON format, such as `{"atAll":"true"}` to specify whether to @all members.', 'type' => 'string', 'example' => '{"atAll":"true"}', 'title' => ''], + 'Receiver' => ['description' => 'You must specify WebhookUrl when Channel is DingRobot or Weixin.', 'type' => 'string', 'example' => 'https://dingtalk.com', 'title' => ''], + ], + 'description' => 'Notification service', + 'title' => '', + 'example' => '', + ], + 'description' => 'Notification Service Statement', + 'title' => '', + 'example' => '', + ], + 'ApprovalNodes' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'Node ID', 'type' => 'string', 'example' => '7a809b6a-2a62-4c6c-9c23-c2a145e3877d', 'title' => ''], + 'Name' => ['description' => '**Node Name**', 'type' => 'string', 'example' => 'default-name', 'title' => ''], + 'AccountType' => ['description' => '**Node approver type**:'."\n" + ."\n" + .'- DataWorksProjectRole project role'."\n" + ."\n" + .'- DataWorksProjectMember project member'."\n" + ."\n" + .'- TableAdministrator table administrator'."\n" + ."\n" + .'- TableOrProjectAdministrator Table or project administrator'."\n" + ."\n" + .'- AliyunResourceOwner Alibaba Cloud account'."\n" + ."\n" + .'- MaxComputeRole MC Administrator'."\n" + ."\n" + .'- DLFAdmin and DlfLegacy administrator'."\n" + ."\n" + .'- DLFNext Administrator'."\n" + ."\n" + .'- TenantRole tenant role'."\n" + ."\n" + .'- EmrAdministrator Emr administrator'."\n" + ."\n" + .'- LindormAdministrator Lindorm Administrator'."\n" + ."\n" + .'- AliyunRamUser RAM user', 'type' => 'string', 'example' => 'TableOrProjectAdministrator', 'title' => ''], + 'Assignees' => [ + 'type' => 'array', + 'items' => ['description' => 'Approver', 'type' => 'string', 'example' => '213463068144525171', 'title' => ''], + 'description' => '**`AccountType` has different semantics for different types**:'."\n" ."\n" - .'Valid values:'."\n" + .'- DataWorksProjectMember specifies the project member\'s UserId.'."\n" ."\n" - .'* Init'."\n" - .'* Running'."\n" - .'* Success'."\n" - .'* Fail'."\n" - .'* Termination'."\n" - .'* Cancel'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'Running', - 'pattern' => '', - 'default' => '', - 'enum' => [ - 'Init', - 'Running', - 'Success', - 'Fail', - 'Termination', - 'Cancel', - ], - ], - 'Message' => [ - 'description' => 'The error message returned during the stage.'."\n", - 'type' => 'string', - 'example' => 'Error message', - ], - 'Stages' => [ - 'title' => '步骤详情', - 'description' => 'The stages of the process.'."\n", - 'type' => 'array', - 'items' => [ - 'title' => 'stage的元素', - 'description' => 'The information about the stage.'."\n", - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'title' => '阶段代号', - 'description' => 'The code of the stage.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'DEV_CHECK', - 'pattern' => '', - 'default' => '', - ], - 'Step' => [ - 'title' => '步骤', - 'description' => 'The step number of the stage.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'deprecated' => false, - 'example' => '1', - 'pattern' => '', - 'default' => '', - ], - 'Type' => [ - 'title' => '阶段类型', - 'description' => 'The type of the stage. This parameter indicates the operation type in the stage.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Deploy'."\n" - .'* Check'."\n" - .'* Offline'."\n" - .'* Build'."\n" - .'* Delete'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'Check', - 'pattern' => '', - 'default' => '', - ], - 'Name' => [ - 'title' => '阶段名称', - 'description' => 'The name of the stage.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'Check before going online to development'."\n", - 'pattern' => '', - 'default' => '', - ], - 'Description' => [ - 'title' => '阶段描述', - 'description' => 'The description of the stage.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'Check before going online to development'."\n", - 'pattern' => '', - 'default' => '', - ], - 'Message' => [ - 'title' => '阶段信息', - 'description' => 'The error message returned during the stage.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'Error message'."\n", - 'pattern' => '', - 'default' => '', - ], - 'Status' => [ - 'title' => '阶段状态', - 'description' => 'The status of the stage.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Init'."\n" - .'* Running'."\n" - .'* Success'."\n" - .'* Fail'."\n" - .'* Termination'."\n" - .'* Cancel'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'Running', - 'pattern' => '', - 'default' => '', - ], - 'Detail' => [ - 'title' => '阶段详细信息', - 'description' => 'The additional information about the stage.'."\n", - 'type' => 'object', - 'deprecated' => false, - 'additionalProperties' => [ - 'type' => 'any', - 'description' => 'The additional information.'."\n", - 'example' => '{'."\n" - .' "checkerList": ['."\n" - .' {'."\n" - .' "code": "BuildPackageChecker",'."\n" - .' "name": "package check"'."\n" - .' },'."\n" - .' {'."\n" - .' "code": "NodeParentDependency",'."\n" - .' "name": "downstream dependency check"'."\n" - .' },'."\n" - .' {'."\n" - .' "code": "NodeInProcess",'."\n" - .' "name": "offline process check"'."\n" - .' }'."\n" - .' ]'."\n" - .'}', - ], - ], - ], - 'deprecated' => false, - ], - 'deprecated' => false, + .'- DataWorksProjectRole specifies the code of the project role.'."\n" + ."\n" + .'- MaxComputeRole specifies the MaxCompute role.'."\n" + ."\n" + .'- TenantRole specifies the tenant role code.'."\n" + ."\n" + .'- AliyunRamUser specifies the RAM user ID.', + 'title' => '', + 'example' => '', ], - 'Description' => [ - 'title' => '发布流程的描述信息', - 'type' => 'string', - 'example' => '发布流程描述信息', + 'ExtensionProperties' => [ + 'type' => 'object', + 'additionalProperties' => ['description' => 'Additional Information', 'type' => 'any', 'example' => '{'."\n" + .' "449656": "role_project_admin,role_project_pe"'."\n" + .' }', 'title' => ''], + 'description' => 'When `AccountType `is set to different types, you must provide different additional declarations:'."\n" + ."\n" + .'- DataWorksProjectMember: The key is projectId, and the value is the UserIds of project members, separated by commas.'."\n" + ."\n" + .'- MaxComputeRole: The key is a MaxCompute project and the value is a role name in MaxCompute. Multiple role names are separated by a comma.', + 'title' => '', + 'example' => '', ], ], + 'description' => 'Approval node', + 'title' => '', + 'example' => '', ], + 'description' => 'Approval node list', + 'title' => '', + 'example' => '', ], ], + 'description' => 'Process definition', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => 'Schema of Response', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetProcessDefinition', + 'description' => '## Request'."\n" + ."\n" + .'- This API retrieves the details of a specific approval process definition using the `ID` parameter.'."\n" + ."\n" + .'- The `ID` parameter is required and must be a valid process definition ID.'."\n" + ."\n" + .'- The response includes the basic properties of the approval process definition, rule conditions, notification service configurations, and approval nodes.'."\n" + ."\n" + .'- A successful request returns the complete process definition object. A failed request returns an error code and message for troubleshooting.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX\\\\n\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 2524,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"PipelineRuns\\": [\\n {\\n \\"Id\\": \\"097c73fe-ed6e-4fb1-b109-a5d59e46cd58\\",\\n \\"ProjectId\\": 70199,\\n \\"CreateTime\\": 1702736654000,\\n \\"ModifyTime\\": 1702736654000,\\n \\"Creator\\": \\"110755000425XXXX\\",\\n \\"Status\\": \\"Running\\",\\n \\"Message\\": \\"Error message\\",\\n \\"Stages\\": [\\n {\\n \\"Code\\": \\"DEV_CHECK\\",\\n \\"Step\\": 1,\\n \\"Type\\": \\"Check\\",\\n \\"Name\\": \\"Check before going online to development\\\\n\\",\\n \\"Description\\": \\"Check before going online to development\\\\n\\",\\n \\"Message\\": \\"Error message\\\\n\\",\\n \\"Status\\": \\"Running\\",\\n \\"Detail\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"checkerList\\\\\\": [\\\\n {\\\\n \\\\\\"code\\\\\\": \\\\\\"BuildPackageChecker\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"package check\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"code\\\\\\": \\\\\\"NodeParentDependency\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"downstream dependency check\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"code\\\\\\": \\\\\\"NodeInProcess\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"offline process check\\\\\\"\\\\n }\\\\n ]\\\\n}\\"\\n }\\n }\\n ],\\n \\"Description\\": \\"发布流程描述信息\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListPipelineRuns', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc5df3a17***903790e8e8a\\",\\n \\"ProcessDefinition\\": {\\n \\"Id\\": \\"210001039767\\",\\n \\"Name\\": \\"MaxCompute 表审批\\",\\n \\"Description\\": \\"订单业务数据审批流程\\",\\n \\"Type\\": \\"MaxCompute\\",\\n \\"SubType\\": \\"Table\\",\\n \\"IsSystem\\": false,\\n \\"Enabled\\": true,\\n \\"RuleConditions\\": [\\n {\\n \\"Type\\": \\"odpsProject\\",\\n \\"Expression\\": \\"((#odpsProject==\'PX_BEIJING_TEST\'))\\",\\n \\"Scope\\": \\"Deployment\\"\\n }\\n ],\\n \\"NotificationServices\\": [\\n {\\n \\"Channel\\": \\"DingRobot\\",\\n \\"Extension\\": \\"{\\\\\\"atAll\\\\\\":\\\\\\"true\\\\\\"}\\",\\n \\"Receiver\\": \\"https://dingtalk.com\\"\\n }\\n ],\\n \\"ApprovalNodes\\": [\\n {\\n \\"Id\\": \\"7a809b6a-2a62-4c6c-9c23-c2a145e3877d\\",\\n \\"Name\\": \\"default-name\\",\\n \\"AccountType\\": \\"TableOrProjectAdministrator\\",\\n \\"Assignees\\": [\\n \\"213463068144525171\\"\\n ],\\n \\"ExtensionProperties\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"449656\\\\\\": \\\\\\"role_project_admin,role_project_pe\\\\\\"\\\\n }\\"\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', ], - 'ListPipelineRunItems' => [ - 'summary' => 'Queries the information about deployment objects by deployment process ID.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'GetProcessInstance' => [ + 'summary' => 'Retrieves details for a specified approval process instance, including its approval nodes and task list.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -18564,2276 +22081,2576 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '267918', - 'abilityTreeNodes' => [ - 'FEATUREdide4AR6E0', - ], + 'abilityTreeCode' => '244495', + 'abilityTreeNodes' => ['FEATUREdideYTM537'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the DataWorks workspace. You can obtain the workspace ID from the workspace configuration page in the DataWorks console.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10001', - ], - ], - [ - 'name' => 'PipelineRunId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The workflow task ID. To obtain the ID, see [ListPipelineRuns](~~438042~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => ' '."\n" - .'097c73fe-ed6e-4fb1-b109-a5d59e46cd58'."\n", - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number, for pagination.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], - ], - [ - 'name' => 'PageSize', + 'name' => 'ProcessInstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The requested page number, used for pagination.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '10', - 'example' => '10', - 'default' => '10', - ], + 'schema' => ['description' => 'The ID of the process instance.', 'type' => 'string', 'required' => true, 'example' => '332066440109224007', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The returned result.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID. You can use this ID to troubleshoot issues if errors occur.'."\n", - 'type' => 'string', - 'example' => 'C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490', - ], - 'PagingInfo' => [ - 'description' => 'Pagination information.'."\n", + 'RequestId' => ['description' => 'The request ID. Use this ID to locate logs and troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => '0bc5df3a17****903790e8e8a'], + 'ProcessInstance' => [ 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of entries that match the conditions.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '12', - ], - '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', + 'Id' => ['description' => 'The process instance ID.', 'type' => 'string', 'example' => '332066440109224007', 'title' => ''], + 'Title' => ['description' => 'The name of the process instance.', 'type' => 'string', 'example' => 'MaxCompute表权限申请', 'title' => ''], + 'Status' => [ + 'description' => 'The status of the process instance. Valid values:'."\n" + ."\n" + .'- `Completed`: The request is approved.'."\n" + ."\n" + .'- `Running`: The request is in the approval process.'."\n" + ."\n" + .'- `Aborted`: The request is withdrawn.', + 'enumValueTitles' => ['running' => 'running', 'aborted' => 'aborted', 'completed' => 'completed'], + 'type' => 'string', + 'example' => 'completed', + 'title' => '', ], - 'PipelineRunItems' => [ - 'description' => 'The list of deployments.'."\n", + 'Applicator' => ['description' => 'The user ID of the applicant.', 'type' => 'string', 'example' => '1107558004253538', 'title' => ''], + 'ApplicatorName' => ['description' => 'The username of the applicant\'s Alibaba Cloud account.', 'type' => 'string', 'example' => 'test_account', 'title' => ''], + 'StartTime' => ['description' => 'The time when the approval process started.', 'type' => 'any', 'example' => '2026-05-25 10:20:18 CST', 'title' => ''], + 'Reason' => ['description' => 'The reason for the request.', 'type' => 'string', 'example' => '业务需要', 'title' => ''], + 'AuthErrorMessage' => ['description' => 'The authorization failure message.'."\n" + ."\n" + .'**Note**: This parameter is returned only if the authorization fails.', 'type' => 'string', 'example' => 'S-400007:ODPS acl auth failed. odps table acl auth failed', 'title' => ''], + 'ApprovalTasks' => [ 'type' => 'array', 'items' => [ - 'description' => 'Details of a deployment.'."\n", 'type' => 'object', 'properties' => [ - 'Version' => [ - 'title' => '项目Id', - 'description' => 'The deployment version.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'deprecated' => false, - 'example' => '1', - 'pattern' => '', - 'default' => '', - ], - 'Name' => [ - 'description' => 'The deployment name.'."\n", + 'Id' => ['description' => 'The approval task ID.', 'type' => 'string', 'example' => 'task_001', 'title' => ''], + 'Status' => [ + 'description' => 'The status of the task. Valid values:'."\n" + ."\n" + .'- `Completed`: The task is complete.'."\n" + ."\n" + .'- `Pending`: The task is pending.'."\n" + ."\n" + .'- `Aborted`: The task is aborted.', + 'enumValueTitles' => ['Completed' => 'Completed', 'Pending' => 'Pending', 'Aborted' => 'Aborted'], 'type' => 'string', - 'example' => 'test', - ], - 'CreateTime' => [ - 'title' => '发布包创建时间戳', - 'description' => 'The deployment creation time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1724984066000', - ], - 'ModifyTime' => [ - 'title' => '修改时间', - 'description' => 'The time when the deployment was last modified.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'deprecated' => false, - 'example' => '1724984066000', - 'pattern' => '', - 'default' => '', + 'example' => 'Aborted', + 'title' => '', ], - 'Status' => [ - 'title' => '发布流程状态', - 'description' => 'The deployment status. Valid values:'."\n" + 'ApprovalComment' => ['description' => 'The approval comment.', 'type' => 'string', 'example' => '同意', 'title' => ''], + 'Assignee' => ['description' => 'The user ID of the actual approver.', 'type' => 'string', 'example' => '207947399706614297', 'title' => ''], + 'AssigneeName' => ['description' => 'The name of the actual approver.', 'type' => 'string', 'example' => '李四', 'title' => ''], + 'ApprovalDecision' => [ + 'description' => 'The approval decision. Valid values:'."\n" ."\n" - .'* Init: Initializing'."\n" - .'* Running'."\n" - .'* Success'."\n" - .'* Fail'."\n" - .'* Termination'."\n", + .'- `Agree`'."\n" + ."\n" + .'- `Deny`', + 'enumValueTitles' => ['deny' => 'deny', 'agree' => 'agree'], 'type' => 'string', - 'deprecated' => false, - 'example' => 'Running', - 'pattern' => '', - 'default' => '', - 'enum' => [ - 'Init', - 'Running', - 'Success', - 'Fail', - 'Termination', + 'example' => 'Deny', + 'title' => '', + ], + 'CreateTime' => ['description' => 'The time when the task was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1715587200000', 'title' => ''], + 'CompleteTime' => ['description' => 'The time when the task was completed.', 'type' => 'integer', 'format' => 'int64', 'example' => '1715590800000', 'title' => ''], + 'ApprovalNode' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The node ID.', 'type' => 'string', 'example' => '7a809b6a-2a62-4c6c-9c23-c2a145e3877d', 'title' => ''], + 'Name' => ['description' => 'The node name.', 'type' => 'string', 'example' => 'default-name', 'title' => ''], + 'AccountType' => [ + 'description' => 'The type of the approver for the node. Valid values:'."\n" + ."\n" + .'- `DataWorksProjectRole`: A workspace role'."\n" + ."\n" + .'- `DataWorksProjectMember`: A workspace member'."\n" + ."\n" + .'- `TableAdministrator`: A table administrator'."\n" + ."\n" + .'- `TableOrProjectAdministrator`: A table or workspace administrator'."\n" + ."\n" + .'- `AliyunResourceOwner`: An Alibaba Cloud account'."\n" + ."\n" + .'- `MaxComputeRole`: A MaxCompute role'."\n" + ."\n" + .'- `DLFAdmin`: A DlfLegacy administrator'."\n" + ."\n" + .'- `DLFNextAdmin`: A DLFNext administrator'."\n" + ."\n" + .'- `TenantRole`: A tenant role'."\n" + ."\n" + .'- `EmrAdministrator`: An Emr administrator'."\n" + ."\n" + .'- `LindormAdministrator`: A Lindorm administrator'."\n" + ."\n" + .'- `AliyunRamUser`: A RAM user', + 'enumValueTitles' => [ + 'AliyunResourceOwner' => 'Alibaba Cloud account', 'MaxComputeRole' => 'MaxCompute role', 'DLFNextAdmin' => 'DLFNext administrator', 'TenantRole' => 'Tenant role', 'DataWorksProjectRole' => 'Workspace role', 'AliyunRamUser' => 'RAM user', 'TableOrProjectAdministrator' => 'Table or workspace administrator', 'EmrAdministrator' => 'Emr administrator', 'TableAdministrator' => 'Table administrator', 'DLFAdmin' => 'DlfLegacy administrator', + 'DataWorksProjectMember' => 'Workspace member', 'LindormAdministrator' => 'Lindorm administrator', + ], + 'type' => 'string', + 'example' => 'DataWorksProjectRole', + 'title' => '', + ], + 'Assignees' => [ + 'type' => 'array', + 'items' => ['description' => 'An approver.', 'type' => 'string', 'example' => 'role_project_admin', 'title' => ''], + 'description' => 'The specified approvers.'."\n" + ."\n" + .'The contents of this parameter depend on the `AccountType` value:'."\n" + ."\n" + .'- If `AccountType` is `DataWorksProjectMember`, this parameter contains the user IDs of workspace members.'."\n" + ."\n" + .'- If `AccountType` is `DataWorksProjectRole`, this parameter contains the codes of workspace roles.'."\n" + ."\n" + .'- If `AccountType` is `MaxComputeRole`, this parameter contains the MaxCompute roles.'."\n" + ."\n" + .'- If `AccountType` is `TenantRole`, this parameter contains the codes of tenant roles.'."\n" + ."\n" + .'- If `AccountType` is `AliyunRamUser`, this parameter contains the user IDs of RAM users.', + 'title' => '', + 'example' => '', + ], ], + 'description' => 'The approval node from the corresponding approval policy.', + 'title' => '', + 'example' => '', ], - 'Message' => [ - 'title' => '创建人', - 'description' => 'The error message if the deployment failed.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => 'Error Message', - 'pattern' => '', - 'default' => '', + 'TaskCandidates' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MemberUserId' => ['description' => 'The user ID of the approver.', 'type' => 'string', 'example' => '207947397776614297', 'title' => ''], + 'MemberName' => ['description' => 'The name of the approver.', 'type' => 'string', 'example' => '李四', 'title' => ''], + ], + 'description' => 'A candidate approver.', + 'title' => '', + 'example' => '', + ], + 'description' => 'The candidate approvers for the task.', + 'title' => '', + 'example' => '', ], - 'Type' => [ - 'description' => 'The deployment type. Valid values:'."\n" - ."\n" - .'* Node'."\n" - .'* WorkflowDefinition: Workflow definition.'."\n" - .'* Resource'."\n" - .'* Function: The object is a function.'."\n", - 'type' => 'string', - 'example' => 'Node', + ], + 'description' => 'An approval task.', + 'title' => '', + 'example' => '', + ], + 'description' => 'The approval tasks.', + 'title' => '', + 'example' => '', + ], + 'ApprovalProcessDefinition' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The approval policy ID.', 'type' => 'string', 'example' => '323861511451222099', 'title' => ''], + 'Name' => ['description' => 'The name of the approval policy.', 'type' => 'string', 'example' => 'SYSTEM_GENERATE_DEFAULT', 'title' => ''], + 'Description' => ['description' => 'The description of the approval policy.', 'type' => 'string', 'example' => '流程定义描述', 'title' => ''], + 'Type' => ['description' => 'The type of the approval policy. Valid values:'."\n" + ."\n" + .'- `MaxCompute`'."\n" + ."\n" + .'- `DataService`'."\n" + ."\n" + .'- `DlfV1` (Custom creation is not supported)'."\n" + ."\n" + .'- `Extension`'."\n" + ."\n" + .'- `Hologres`'."\n" + ."\n" + .'- `Emr` (Custom creation is not supported)'."\n" + ."\n" + .'- `DataAssetGovernance` (Custom creation is not supported)'."\n" + ."\n" + .'- `Lindorm` (Custom creation is not supported)'."\n" + ."\n" + .'- `StarRocks` (Custom creation is not supported)'."\n" + ."\n" + .'- `DlfNext` (Custom creation is not supported)'."\n" + ."\n" + .'- `DataWorks` (Custom creation is not supported)', 'type' => 'string', 'example' => 'MaxCompute', 'title' => ''], + 'SubType' => ['description' => 'The subtype of the approval policy. Valid values:'."\n" + ."\n" + .'- `Table`'."\n" + ."\n" + .'- `Column`'."\n" + ."\n" + .'- `Database`'."\n" + ."\n" + .'- `Schema`'."\n" + ."\n" + .'- `Default`', 'type' => 'string', 'example' => 'Table', 'title' => ''], + 'Enabled' => ['description' => 'Indicates whether the policy is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RuleConditions' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The type of the rule condition. Valid values:'."\n" + ."\n" + .'- `odpsProject`: Applies to a specific MaxCompute project.'."\n" + ."\n" + .'- `hologresInstanceId`: Applies to a specific Hologres instance.'."\n" + ."\n" + .'- `sensibleLevel`: Applies to a specific security level.'."\n" + ."\n" + .'- `tableGuid`: Applies to a specific table.'."\n" + ."\n" + .'- `projectId`: Applies to a specific workspace.', + 'enumValueTitles' => ['tableGuid' => 'tableGuid', 'hologresInstanceId' => 'hologresInstanceId', 'sensibleLevel' => 'sensibleLevel', 'odpsProject' => 'odpsProject', 'projectId' => 'projectId'], + 'type' => 'string', + 'example' => 'odpsProject', + 'title' => '', + ], + 'Expression' => ['description' => 'The expression of the rule condition. Format: `((#type==\'typeValue\'))`.', 'type' => 'string', 'example' => '((#odpsProject==\'PX_BEIJING_TEST\'))', 'title' => ''], + 'Scope' => [ + 'description' => 'The rule scope. Valid values:'."\n" + ."\n" + .'- `Deployment`: Determines whether the policy applies when a request is submitted.'."\n" + ."\n" + .'- `Running`: Determines whether to skip approval while the process instance runs. This value is supported only for MaxCompute approval policies.', + 'enumValueTitles' => ['Running' => 'Skip approval while the process instance runs.', 'Deployment' => 'Takes effect when a request is triggered.'], + 'type' => 'string', + 'example' => 'Deployment', + 'title' => '', + ], + ], + 'description' => 'A rule that determines when the approval policy takes effect.', + 'title' => '', + 'example' => '', ], - 'Spec' => [ - 'description' => 'The FlowSpec information describing this deployment. For detailed specifications, see [FlowSpec](https://github.com/aliyun/dataworks-spec/blob/master/README_zh_CN.md).'."\n", - 'type' => 'string', - 'example' => '{ "version": "1.1.0", "kind": "Node", "spec": { "nodes": [ { "recurrence": "Normal", "id": "860438872620113XXXX", "timeout": 0, "instanceMode": "T+1", "rerunMode": "Allowed", "rerunTimes": 3, "rerunInterval": 180000, "datasource": { "name": "odps_test", "type": "odps" }, "script": { "language": "odps-sql", "path": "XX/OpenAPI_Test/ODPS_SQL_Test", "runtime": { "command": "ODPS_SQL", "commandTypeId": 10 }, "content": "select now();", "id": "853573334108680XXXX" }, "trigger": { "type": "Scheduler", "id": "543680677872062XXXX", "cron": "00 00 00 * * ?", "startTime": "1970-01-01 00:00:00", "endTime": "9999-01-01 00:00:00", "timezone": "Asia/Shanghai", "delaySeconds": 0 }, "runtimeResource": { "resourceGroup": "S_res_group_XXXX_XXXX", "id": "623731286945488XXXX", "resourceGroupId": "7201XXXX" }, "name": "ODPS_SQL_Test", "owner": "110755000425XXXX", "metadata": { "owner": "110755000425XXXX", "ownerName": "XXXXX@test.XXX.com", "projectId": "307XXX" }, "inputs": { "nodeOutputs": [ { "data": "lwttest_standard_root", "artifactType": "NodeOutput" } ] }, "outputs": { "nodeOutputs": [ { "data": "860438872620113XXXX", "artifactType": "NodeOutput", "refTableName": "ODPS_SQL_Test", "isDefault": true } ] } } ], "flow": [ { "nodeId": "860438872620113XXXX", "depends": [ { "type": "Normal", "output": "lwttest_standard_root" } ] } ] }, "metadata": { "uuid": "860438872620113XXXX" } }', + 'description' => 'The rules that determine when the approval policy takes effect.', + 'title' => '', + 'example' => '', + ], + 'NotificationServices' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Channel' => [ + 'description' => 'The notification channel. Valid values:'."\n" + ."\n" + .'- `Mail`'."\n" + ."\n" + .'- `Sms`'."\n" + ."\n" + .'- `DingRobot`'."\n" + ."\n" + .'- `Weixin`', + 'enumValueTitles' => ['Mail' => 'Email', 'Weixin' => 'A webhook', 'Sms' => 'SMS', 'DingRobot' => 'DingTalk chatbot'], + 'type' => 'string', + 'example' => 'Mail', + 'title' => '', + ], + 'Extension' => ['description' => 'Additional information in JSON format. For example, `{"atAll":"true"}` indicates whether to @all members.', 'type' => 'string', 'example' => '{"atAll":"true"}', 'title' => ''], + 'Receiver' => ['description' => 'If `Channel` is set to `DingRobot` or `Weixin`, the value of this parameter must be the webhook URL.', 'type' => 'string', 'example' => 'https://dingtalk', 'title' => ''], + ], + 'description' => 'A notification service.', + 'title' => '', + 'example' => '', ], - 'Id' => [ - 'description' => 'The unique identifier of the deployment.'."\n" - ."\n" - .'> Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'example' => '860438872620113XXXX', + 'description' => 'The notification services.', + 'title' => '', + 'example' => '', + ], + 'ApprovalNodes' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The node ID.', 'type' => 'string', 'example' => '7a809b6a-2a62-4c6c-9c23-c2a145e3877d', 'title' => ''], + 'Name' => ['description' => 'The node name.', 'type' => 'string', 'example' => 'default-name', 'title' => ''], + 'AccountType' => ['description' => 'The type of the approver for the node. Valid values:'."\n" + ."\n" + .'- `DataWorksProjectRole`: A workspace role'."\n" + ."\n" + .'- `DataWorksProjectMember`: A workspace member'."\n" + ."\n" + .'- `TableAdministrator`: A table administrator'."\n" + ."\n" + .'- `TableOrProjectAdministrator`: A table or workspace administrator'."\n" + ."\n" + .'- `AliyunResourceOwner`: An Alibaba Cloud account'."\n" + ."\n" + .'- `MaxComputeRole`: A MaxCompute role'."\n" + ."\n" + .'- `DLFAdmin`: A DlfLegacy administrator'."\n" + ."\n" + .'- `DLFNextAdmin`: A DLFNext administrator'."\n" + ."\n" + .'- `TenantRole`: A tenant role'."\n" + ."\n" + .'- `EmrAdministrator`: An Emr administrator'."\n" + ."\n" + .'- `LindormAdministrator`: A Lindorm administrator'."\n" + ."\n" + .'- `AliyunRamUser`: A RAM user', 'type' => 'string', 'example' => 'DataWorksProjectRole', 'title' => ''], + 'Assignees' => [ + 'type' => 'array', + 'items' => ['description' => 'An approver.', 'type' => 'string', 'example' => 'role_project_admin', 'title' => ''], + 'description' => 'The specified approvers.'."\n" + ."\n" + .'The contents of this parameter depend on the `AccountType` value:'."\n" + ."\n" + .'- If `AccountType` is `DataWorksProjectMember`, this parameter contains the user IDs of workspace members.'."\n" + ."\n" + .'- If `AccountType` is `DataWorksProjectRole`, this parameter contains the codes of workspace roles.'."\n" + ."\n" + .'- If `AccountType` is `MaxComputeRole`, this parameter contains the MaxCompute roles.'."\n" + ."\n" + .'- If `AccountType` is `TenantRole`, this parameter contains the codes of tenant roles.'."\n" + ."\n" + .'- If `AccountType` is `AliyunRamUser`, this parameter contains the user IDs of RAM users.', + 'title' => '', + 'example' => '', + ], + 'ExtensionProperties' => ['description' => 'The extended description of the approval node.', 'type' => 'string', 'example' => 'none', 'title' => ''], + ], + 'description' => 'An approval node.', + 'title' => '', + 'example' => '', ], + 'description' => 'The approval nodes.', + 'title' => '', + 'example' => '', ], ], + 'description' => 'The approval policy applied to this process instance.', + 'title' => '', + 'example' => '', ], ], + 'description' => 'Details of the approval process instance.', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => 'The returned data.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetProcessInstance', + 'description' => '## Request'."\n" + ."\n" + .'This API is used to monitor and manage the status of an approval process. By providing the approval process instance ID, you can query for related information, such as the approval process definition, current approval nodes, and the tasks on each node.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 12,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"PipelineRunItems\\": [\\n {\\n \\"Version\\": 1,\\n \\"Name\\": \\"test\\",\\n \\"CreateTime\\": 1724984066000,\\n \\"ModifyTime\\": 1724984066000,\\n \\"Status\\": \\"Running\\",\\n \\"Message\\": \\"Error Message\\",\\n \\"Type\\": \\"Node\\",\\n \\"Spec\\": \\"{ \\\\\\"version\\\\\\": \\\\\\"1.1.0\\\\\\", \\\\\\"kind\\\\\\": \\\\\\"Node\\\\\\", \\\\\\"spec\\\\\\": { \\\\\\"nodes\\\\\\": [ { \\\\\\"recurrence\\\\\\": \\\\\\"Normal\\\\\\", \\\\\\"id\\\\\\": \\\\\\"860438872620113XXXX\\\\\\", \\\\\\"timeout\\\\\\": 0, \\\\\\"instanceMode\\\\\\": \\\\\\"T+1\\\\\\", \\\\\\"rerunMode\\\\\\": \\\\\\"Allowed\\\\\\", \\\\\\"rerunTimes\\\\\\": 3, \\\\\\"rerunInterval\\\\\\": 180000, \\\\\\"datasource\\\\\\": { \\\\\\"name\\\\\\": \\\\\\"odps_test\\\\\\", \\\\\\"type\\\\\\": \\\\\\"odps\\\\\\" }, \\\\\\"script\\\\\\": { \\\\\\"language\\\\\\": \\\\\\"odps-sql\\\\\\", \\\\\\"path\\\\\\": \\\\\\"XX/OpenAPI_Test/ODPS_SQL_Test\\\\\\", \\\\\\"runtime\\\\\\": { \\\\\\"command\\\\\\": \\\\\\"ODPS_SQL\\\\\\", \\\\\\"commandTypeId\\\\\\": 10 }, \\\\\\"content\\\\\\": \\\\\\"select now();\\\\\\", \\\\\\"id\\\\\\": \\\\\\"853573334108680XXXX\\\\\\" }, \\\\\\"trigger\\\\\\": { \\\\\\"type\\\\\\": \\\\\\"Scheduler\\\\\\", \\\\\\"id\\\\\\": \\\\\\"543680677872062XXXX\\\\\\", \\\\\\"cron\\\\\\": \\\\\\"00 00 00 * * ?\\\\\\", \\\\\\"startTime\\\\\\": \\\\\\"1970-01-01 00:00:00\\\\\\", \\\\\\"endTime\\\\\\": \\\\\\"9999-01-01 00:00:00\\\\\\", \\\\\\"timezone\\\\\\": \\\\\\"Asia/Shanghai\\\\\\", \\\\\\"delaySeconds\\\\\\": 0 }, \\\\\\"runtimeResource\\\\\\": { \\\\\\"resourceGroup\\\\\\": \\\\\\"S_res_group_XXXX_XXXX\\\\\\", \\\\\\"id\\\\\\": \\\\\\"623731286945488XXXX\\\\\\", \\\\\\"resourceGroupId\\\\\\": \\\\\\"7201XXXX\\\\\\" }, \\\\\\"name\\\\\\": \\\\\\"ODPS_SQL_Test\\\\\\", \\\\\\"owner\\\\\\": \\\\\\"110755000425XXXX\\\\\\", \\\\\\"metadata\\\\\\": { \\\\\\"owner\\\\\\": \\\\\\"110755000425XXXX\\\\\\", \\\\\\"ownerName\\\\\\": \\\\\\"XXXXX@test.XXX.com\\\\\\", \\\\\\"projectId\\\\\\": \\\\\\"307XXX\\\\\\" }, \\\\\\"inputs\\\\\\": { \\\\\\"nodeOutputs\\\\\\": [ { \\\\\\"data\\\\\\": \\\\\\"lwttest_standard_root\\\\\\", \\\\\\"artifactType\\\\\\": \\\\\\"NodeOutput\\\\\\" } ] }, \\\\\\"outputs\\\\\\": { \\\\\\"nodeOutputs\\\\\\": [ { \\\\\\"data\\\\\\": \\\\\\"860438872620113XXXX\\\\\\", \\\\\\"artifactType\\\\\\": \\\\\\"NodeOutput\\\\\\", \\\\\\"refTableName\\\\\\": \\\\\\"ODPS_SQL_Test\\\\\\", \\\\\\"isDefault\\\\\\": true } ] } } ], \\\\\\"flow\\\\\\": [ { \\\\\\"nodeId\\\\\\": \\\\\\"860438872620113XXXX\\\\\\", \\\\\\"depends\\\\\\": [ { \\\\\\"type\\\\\\": \\\\\\"Normal\\\\\\", \\\\\\"output\\\\\\": \\\\\\"lwttest_standard_root\\\\\\" } ] } ] }, \\\\\\"metadata\\\\\\": { \\\\\\"uuid\\\\\\": \\\\\\"860438872620113XXXX\\\\\\" } }\\",\\n \\"Id\\": \\"860438872620113XXXX\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListPipelineRunItems', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc5df3a17****903790e8e8a\\",\\n \\"ProcessInstance\\": {\\n \\"Id\\": \\"332066440109224007\\",\\n \\"Title\\": \\"MaxCompute表权限申请\\",\\n \\"Status\\": \\"completed\\",\\n \\"Applicator\\": \\"1107558004253538\\",\\n \\"ApplicatorName\\": \\"test_account\\",\\n \\"StartTime\\": \\"2026-05-25 10:20:18 CST\\",\\n \\"Reason\\": \\"业务需要\\",\\n \\"AuthErrorMessage\\": \\"S-400007:ODPS acl auth failed. odps table acl auth failed\\",\\n \\"ApprovalTasks\\": [\\n {\\n \\"Id\\": \\"task_001\\",\\n \\"Status\\": \\"Aborted\\",\\n \\"ApprovalComment\\": \\"同意\\",\\n \\"Assignee\\": \\"207947399706614297\\",\\n \\"AssigneeName\\": \\"李四\\",\\n \\"ApprovalDecision\\": \\"Deny\\",\\n \\"CreateTime\\": 1715587200000,\\n \\"CompleteTime\\": 1715590800000,\\n \\"ApprovalNode\\": {\\n \\"Id\\": \\"7a809b6a-2a62-4c6c-9c23-c2a145e3877d\\",\\n \\"Name\\": \\"default-name\\",\\n \\"AccountType\\": \\"DataWorksProjectRole\\",\\n \\"Assignees\\": [\\n \\"role_project_admin\\"\\n ]\\n },\\n \\"TaskCandidates\\": [\\n {\\n \\"MemberUserId\\": \\"207947397776614297\\",\\n \\"MemberName\\": \\"李四\\"\\n }\\n ]\\n }\\n ],\\n \\"ApprovalProcessDefinition\\": {\\n \\"Id\\": \\"323861511451222099\\",\\n \\"Name\\": \\"SYSTEM_GENERATE_DEFAULT\\",\\n \\"Description\\": \\"流程定义描述\\",\\n \\"Type\\": \\"MaxCompute\\",\\n \\"SubType\\": \\"Table\\",\\n \\"Enabled\\": true,\\n \\"RuleConditions\\": [\\n {\\n \\"Type\\": \\"odpsProject\\",\\n \\"Expression\\": \\"((#odpsProject==\'PX_BEIJING_TEST\'))\\",\\n \\"Scope\\": \\"Deployment\\"\\n }\\n ],\\n \\"NotificationServices\\": [\\n {\\n \\"Channel\\": \\"Mail\\",\\n \\"Extension\\": \\"{\\\\\\"atAll\\\\\\":\\\\\\"true\\\\\\"}\\",\\n \\"Receiver\\": \\"https://dingtalk\\"\\n }\\n ],\\n \\"ApprovalNodes\\": [\\n {\\n \\"Id\\": \\"7a809b6a-2a62-4c6c-9c23-c2a145e3877d\\",\\n \\"Name\\": \\"default-name\\",\\n \\"AccountType\\": \\"DataWorksProjectRole\\",\\n \\"Assignees\\": [\\n \\"role_project_admin\\"\\n ],\\n \\"ExtensionProperties\\": \\"none\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]', ], - 'CreateFile' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetProject' => [ + 'summary' => 'Queries the information about a DataWorks workspace.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '267402', - 'abilityTreeNodes' => [ - 'FEATUREdideHO4TQP', - 'FEATUREdide8FM783', - ], - ], - 'parameters' => [ - [ - 'name' => 'FileFolderPath', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The file path.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'Business_process/First_Business_Process/MaxCompute/Folder_1/Folder_2', - ], - ], - [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The DataWorks workspace ID. To obtain the workspace ID, log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and navigate to the workspace configuration page. 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' => true, - 'example' => '10000', - ], - ], - [ - 'name' => 'FileName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The file name.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'File name', - ], - ], - [ - 'name' => 'FileDescription', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The description of the file.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'test', - ], - ], - [ - 'name' => 'FileType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The code type of the file. Different file types have different code. For more information, see [DataWorks node types](~~600169~~). You can call the [ListFileType](~~212428~~) operation to query the code types of files.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], - ], - [ - 'name' => 'Owner', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The Alibaba Cloud account ID of the file owner. If this parameter is not specified, the Alibaba Cloud account ID of the caller is used by default.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1000000000001', - ], - ], - [ - 'name' => 'Content', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The file code content. Different code types (fileType) have different code formats. In Operation Center, you can find a task of the corresponding type, right-click it, and select View Code to view the specific code format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SHOW TABLES;', - ], - ], - [ - 'name' => 'AutoRerunTimes', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of automatic reruns after an error occurs. Maximum value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '3', - ], - ], - [ - 'name' => 'AutoRerunIntervalMillis', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The interval at which the node is automatically rerun after a failure. Unit: milliseconds. Maximum value: 1800000 milliseconds (30 minutes).'."\n" - ."\n" - .'This parameter corresponds to the Rerun interval parameter in Properties > Schedule > Auto Rerun upon Failure for data development nodes in the [DataWorks console](https://workbench.data.aliyun.com/console). In the console, the unit of the rerun interval is minutes. Convert the time unit when you call this operation.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '120000', - ], - ], - [ - 'name' => 'RerunMode', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The rerun policy. Valid values:'."\n" - ."\n" - .'* ALL_ALLOWED: Reruns are allowed regardless of whether the task succeeds or fails.'."\n" - .'* FAILURE_ALLOWED: Reruns are allowed only when the task fails.'."\n" - .'* ALL_DENIED: Reruns are not allowed regardless of whether the task succeeds or fails.'."\n" - ."\n" - .'This parameter corresponds to the Support for Rerun setting in Scheduling > Scheduling Policies for Data Studio tasks 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', - ], - ], - ], - [ - 'name' => 'Stop', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether to skip execution. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n" - ."\n" - .'This parameter corresponds to the Skip Execution option in Properties > Schedule > Recurrence for data development nodes in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], - ], - [ - 'name' => 'ParaValue', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The scheduling parameters of the node. Separate multiple parameters with spaces.'."\n" - ."\n" - .'This parameter corresponds to the Scheduling Parameter setting in Properties for data development nodes in the [DataWorks console](https://workbench.data.aliyun.com/console). For more information, see [Scheduling parameters](~~137548~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'a=x b=y', - ], - ], - [ - 'name' => 'StartEffectDate', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The timestamp (in milliseconds) when automatic scheduling starts.'."\n" - ."\n" - .'This parameter corresponds to the start time of Effective Period in Scheduling > Scheduling Time for Data Studio tasks in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'minimum' => '0', - 'example' => '1671608450000', - 'default' => '0', - ], - ], - [ - 'name' => 'EndEffectDate', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The timestamp (in milliseconds) when automatic scheduling stops.'."\n" - ."\n" - .'This parameter corresponds to the end time of Effective Period in Scheduling > Scheduling Time for Data Studio tasks in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'minimum' => '0', - 'example' => '1671694850000', - ], - ], - [ - 'name' => 'CronExpress', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The cron expression for scheduled execution. This parameter corresponds to the Cron Expression setting in Scheduling > Scheduling Time for Data Studio tasks in the [DataWorks console](https://workbench.data.aliyun.com/console). After you configure Scheduling Cycle and Scheduled Time, DataWorks automatically generates a cron expression.'."\n" - ."\n" - .'Examples:'."\n" - ."\n" - .'* Scheduled at 05:30 every day: `00 30 05 * * ?`'."\n" - .'* Scheduled at the 15th minute of every hour: `00 15 00-23/1 * * ?`'."\n" - .'* Scheduled every 10 minutes: `00 00/10 * * * ?`'."\n" - .'* Scheduled every 10 minutes between 08:00 and 17:00 every day: `00 00-59/10 8-17 * * * ?`'."\n" - .'* Scheduled at 00:20 on the 1st day of every month: `00 20 00 1 * ?`'."\n" - .'* Scheduled every 3 months starting from 00:10 on January 1: `00 10 00 1 1-12/3 ?`'."\n" - .'* Scheduled at 00:05 on every Tuesday and Friday: `00 05 00 * * 2,5`'."\n" - ."\n" - .'Due to the rules of the DataWorks scheduling system, cron expressions have the following restrictions:'."\n" - ."\n" - .'* The minimum scheduling interval is 5 minutes.'."\n" - .'* The earliest scheduling time each day is 00:05.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '00 05 00 * * ?', - 'default' => 'day', - ], - ], - [ - 'name' => 'CycleType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The type of scheduling cycle. Valid values: NOT_DAY (minute, hour) and DAY (day, week, month).'."\n" - ."\n" - .'This parameter corresponds to the Scheduling Cycle setting in Scheduling > Scheduling Time for Data Studio tasks in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'DAY', - 'default' => 'DAY', - 'enum' => [ - 'DAY', - 'NOT_DAY', - ], - ], - ], - [ - 'name' => 'DependentType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The dependency mode on the previous cycle. Valid values:'."\n" - ."\n" - .'* SELF: Depends on the current node.'."\n" - .'* CHILD: Depends on the child nodes.'."\n" - .'* USER_DEFINE: Depends on other nodes.'."\n" - .'* NONE: No dependencies. Does not depend on the previous cycle.'."\n" - .'* USER_DEFINE_AND_SELF: Depends on both the current node and other nodes in the previous cycle.'."\n" - .'* CHILD_AND_SELF: Depends on both the current node and its child nodes 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', - ], - ], - ], - [ - 'name' => 'DependentNodeIdList', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The IDs of the nodes on which the current node depends. This parameter takes effect only when the DependentType parameter is set to USER_DEFINE. Separate multiple node IDs with commas (,).'."\n" - ."\n" - .'This parameter corresponds to the Other Nodes option in Properties > Dependencies > Cross-cycle Dependency (Original Previous-cycle Dependency) for data development nodes in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], - ], - [ - 'name' => 'InputList', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The output names of the ancestor nodes on which the current node depends. Separate multiple output names with commas (,).'."\n" - ."\n" - .'This parameter corresponds to the Output Name of Ancestor Node setting in Properties > Dependencies for data development nodes 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', - ], - ], - [ - 'name' => 'ProjectIdentifier', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The DataWorks workspace name. To obtain the workspace name, log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and navigate to the workspace configuration page.'."\n" - ."\n" - .'You must specify either this parameter or ProjectId to identify the target DataWorks workspace for this API call.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'dw_project', - ], - ], - [ - 'name' => 'ResourceGroupIdentifier', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The resource group for the task published from the file. To obtain the ID, log on to the [DataWorks console](https://workbench.data.aliyun.com/console), navigate to the workspace configuration page, and click Resource Groups in the left-side navigation pane to view the IDs of resource groups bound to the current workspace.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'S_res_group_559_1613715566828', - ], - ], - [ - 'name' => 'ResourceGroupId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'This parameter is deprecated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '375827434852437', - ], - ], - [ - 'name' => 'ConnectionName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The data source used when the task published from the file 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_source', - ], - ], - [ - 'name' => 'AutoParsing', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether to enable automatic parsing for the file. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n" - ."\n" - .'This parameter corresponds to the Analyze Code setting in Properties > Dependencies for data development nodes in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'boolean', - 'required' => false, - 'docRequired' => false, - 'example' => 'true', - 'default' => 'true', - ], - ], - [ - 'name' => 'SchedulerType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The scheduling type. Valid values:'."\n" - ."\n" - .'* NORMAL: Normal scheduled task.'."\n" - .'* MANUAL: Manually triggered node. Not scheduled for daily execution. Corresponds to nodes in manually triggered workflows.'."\n" - .'* PAUSE: Paused task.'."\n" - .'* SKIP: Dry-run task. Scheduled for daily execution but is directly marked as successful when scheduling starts.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [], - 'example' => 'NORMAL', - 'enum' => [ - 'NORMAL', - 'MANUAL', - 'PAUSE', - 'SKIP', - ], - ], - ], - [ - 'name' => 'AdvancedSettings', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The advanced settings of the node.'."\n" - ."\n" - .'This parameter corresponds to the Advanced Settings section in the right-side navigation pane on the configuration tab of EMR Spark Streaming and EMR Streaming SQL nodes in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n" - ."\n" - .'Only EMR Spark Streaming and EMR Streaming SQL nodes support this parameter. The value must be in the JSON format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"queue":"default","SPARK_CONF":"--conf spark.driver.memory=2g"}', - ], - ], - [ - 'name' => 'StartImmediately', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether to immediately run the node after the node is deployed.'."\n" - ."\n" - .'This parameter corresponds to the Start Method setting in Settings > Schedule in the right-side navigation pane on the configuration tab of EMR Spark Streaming and EMR Streaming SQL nodes in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'boolean', - 'required' => false, - 'docRequired' => false, - 'example' => 'true', - 'default' => 'false', - ], - ], - [ - 'name' => 'InputParameters', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The input context parameters of the node. The value must be in the JSON format. For more information about the parameter structure, see the InputContextParameterList parameter in the response parameters of the [GetFile](~~173954~~) operation.'."\n" - ."\n" - .'This parameter corresponds to the Input Parameters setting in Properties > Input and Output Parameters for data development nodes 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 context parameters of the node. The value must be in the JSON format. For more information about the parameter structure, see the OutputContextParameterList parameter in the response parameters of the [GetFile](~~173954~~) operation.'."\n" - ."\n" - .'This parameter corresponds to the Output Parameters setting in Properties > Input and Output Parameters for data development nodes 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 inherit the dry-run status from the previous cycle. Valid values:'."\n" - ."\n" - .'* true: Inherit the dry-run status from the previous cycle.'."\n" - .'* false: Do not inherit the dry-run status from the previous cycle.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - [ - 'name' => 'CreateFolderIfNotExists', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether to automatically create the directory specified by FileFolderPath if the directory does not exist. Valid values:'."\n" - ."\n" - .'* true: If the directory does not exist, automatically create it.'."\n" - .'* false: If the directory does not exist, the call fails.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - [ - 'name' => 'ApplyScheduleImmediately', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether to apply the scheduling configuration immediately after the file is published.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'Timeout', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The timeout settings for scheduling configuration.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '244495', + 'abilityTreeNodes' => ['FEATUREdideYTM537'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ [ - 'name' => 'ImageId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The custom image ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'm-bp1h4b5a8ogkbll2f3tr', - ], + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://dataworks.console.aliyun.com/workspace/list) 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.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response.'."\n", + 'title' => 'Schema of Response', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The file ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000001', - ], - 'RequestId' => [ - 'description' => 'The request ID. Use this ID to troubleshoot issues.'."\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 call succeeded. Valid values:'."\n" - ."\n" - .'* true: The call succeeded.'."\n" - .'* false: The call failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A1****'], + 'Project' => [ + 'description' => 'The information about the workspace.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '28477242', 'title' => ''], + 'Name' => ['description' => 'The name of the workspace.', 'type' => 'string', 'example' => 'sora_finance', 'title' => ''], + 'DisplayName' => ['description' => 'The display name of the workspace.', 'type' => 'string', 'example' => 'Sora financial analysis', 'title' => ''], + 'Description' => ['description' => 'The description of the workspace.', 'type' => 'string', 'example' => 'Financial analysis group project data development', 'title' => ''], + 'Owner' => ['description' => 'The ID of the Alibaba Cloud account to which the workspace belongs.', 'type' => 'string', 'example' => '207947397706614299', 'title' => ''], + 'AliyunResourceGroupId' => ['description' => 'The ID of the Alibaba Cloud resource group to which the workspace belongs.', 'type' => 'string', 'example' => 'rg-acfmzbn7pti3zfa', 'title' => ''], + 'Status' => [ + 'description' => 'The status of the workspace. Valid values:'."\n" + ."\n" + .'- Available'."\n" + ."\n" + .'- Initializing'."\n" + ."\n" + .'- InitFailed'."\n" + ."\n" + .'- Forbidden'."\n" + ."\n" + .'- Deleting'."\n" + ."\n" + .'- DeleteFailed'."\n" + ."\n" + .'- Frozen'."\n" + ."\n" + .'- Updating'."\n" + ."\n" + .'- UpdateFailed', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'Available', + 'title' => '', + ], + 'PaiTaskEnabled' => ['description' => 'Indicates whether scheduling of PAI tasks is enabled. Valid values:'."\n" + ."\n" + .'- true: Scheduling of PAI tasks is enabled. In this case, you can create a PAI node in a DataWorks workspace and configure scheduling properties for the node to implement periodic scheduling of PAI tasks.'."\n" + ."\n" + .'- false: Scheduling of PAI tasks is disabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'DevEnvironmentEnabled' => ['description' => 'Indicates whether the development environment is enabled. Valid values:'."\n" + ."\n" + .'- true: The development environment is enabled. In this case, the development environment is isolated from the production environment in the workspace.'."\n" + ."\n" + .'- false: The development environment is disabled. In this case, only the production environment is used in the workspace.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'DevRoleDisabled' => ['description' => 'Indicates whether the Develop role is disabled. Valid values:'."\n" + ."\n" + .'- false'."\n" + ."\n" + .'- true', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'AliyunResourceTags' => [ + 'description' => 'The tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tag.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'batch', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'blue', 'title' => ''], + ], + '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.', - ], - ], - 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 \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A1****\\",\\n \\"Project\\": {\\n \\"Id\\": 28477242,\\n \\"Name\\": \\"sora_finance\\",\\n \\"DisplayName\\": \\"Sora financial analysis\\",\\n \\"Description\\": \\"Financial analysis group project data development\\",\\n \\"Owner\\": \\"207947397706614299\\",\\n \\"AliyunResourceGroupId\\": \\"rg-acfmzbn7pti3zfa\\",\\n \\"Status\\": \\"Available\\",\\n \\"PaiTaskEnabled\\": true,\\n \\"DevEnvironmentEnabled\\": true,\\n \\"DevRoleDisabled\\": false,\\n \\"AliyunResourceTags\\": [\\n {\\n \\"Key\\": \\"batch\\",\\n \\"Value\\": \\"blue\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'GetProject', + 'description' => 'This API operation is available for all DataWorks editions.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetProject', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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 Data Integration nodes.', ], - 'CreateResourceFile' => [ - 'summary' => 'Creates a resource file in DataStudio. The following types are supported: JAR, Archive, File, and Python.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetProjectMember' => [ + 'summary' => 'Retrieves the details of a specific member in a Workspace.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '269305', - 'abilityTreeNodes' => [ - 'FEATUREdide8FM783', - 'FEATUREdideJ3TPTK', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '244502', + 'abilityTreeNodes' => ['FEATUREdideYTM537'], + 'tenantRelevance' => 'tenant', ], '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' => 'Filename', - ], - ], - [ - 'name' => 'FileType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The type of the code for the file.'."\n" - ."\n" - .'The code for files varies based on the file type. For more information, see [DataWorks nodes](~~600169~~). 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', - ], - ], - [ - '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 by default.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1000000000001', - ], - ], - [ - '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, open the directed acyclic graph (DAG) of a node of the file type, right-click the node, and then select View Code.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SHOW TABLES;', - ], - ], - [ - 'name' => 'ResourceFile', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The URL of the Object Storage Service (OSS) bucket to which you upload the file. The URL is provided by the POP platform.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http://bucketname1.oss-cn-shanghai.aliyuncs.com/example', - 'isFileTransferUrl' => true, - ], - ], - [ - 'name' => 'OriginResourceName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the original resource file.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'origin_file_name.sql', - ], - ], - [ - 'name' => 'UploadMode', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The upload mode of MaxCompute file resources. This parameter takes effect only for MaxCompute file resources. Valid values:'."\n" - ."\n" - .'* true: indicates the resource upload and download mode.'."\n" - .'* false: indicates the online editing mode.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - [ - 'name' => 'RegisterToCalcEngine', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether to upload the resource file to a desired compute engine.'."\n", - 'type' => 'boolean', - 'required' => true, - 'example' => 'false', - ], + 'schema' => ['description' => 'The ID of the DataWorks Workspace. You can sign in to the [DataWorks Console](https://dataworks.console.aliyun.com/workspace/list) and go to the Workspace Management page to obtain the Workspace ID.'."\n" + ."\n" + .'This parameter is used to identify the DataWorks workspace that you want to access.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '88757', 'title' => ''], ], [ - 'name' => 'StorageURL', + 'name' => 'UserId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The storage path of the resource file in a desired compute engine. This parameter takes effect only for E-MapReduce (EMR) and Cloudera\'s Distribution including Apache Hadoop (CDH) compute engines. In an EMR compute engine, this parameter is configured in the \\[osshdfs]://path/to/object format. In a CDH compute engine, this parameter is set to /user/admin/lib by default.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'oss://oss-cn-shanghai.aliyuncs.com/emr-test', - ], + 'schema' => ['description' => 'The ID of the user. To find the ID, sign in to the [DataWorks Console](https://dataworks.console.aliyun.com/product/ms_menu), go to the Management Center, select the target Workspace, and open the Tenant Members and Roles page.', 'type' => 'string', 'required' => true, 'example' => '123422****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => 'The ID of the file that is created.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000001', - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID. Use this ID to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => '8abcb91f-d266-4073-b907-2ed670378ed1'], + 'ProjectMember' => [ + 'description' => 'The details of the Workspace member.', + 'type' => 'object', + 'properties' => [ + 'ProjectId' => ['description' => 'The ID of the Workspace.', 'type' => 'integer', 'format' => 'int64', 'example' => '88757', 'title' => ''], + 'UserId' => ['description' => 'The ID of the user.', 'type' => 'string', 'example' => '123422344899', 'title' => ''], + 'Status' => ['description' => 'The status of the Workspace member.'."\n" + ."\n" + .'- Normal: The member is active.'."\n" + ."\n" + .'- Disabled: The member is disabled.', 'type' => 'string', 'example' => 'Normal', 'title' => ''], + 'Roles' => [ + 'description' => 'Roles assigned to the Workspace member.', + 'type' => 'array', + 'items' => [ + 'description' => 'Details of an assigned role.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The code of the Workspace role.'."\n" + ."\n" + .'The built-in system roles in a DataWorks Workspace include:'."\n" + ."\n" + .'- role\\_project\\_admin: Workspace Administrator'."\n" + ."\n" + .'- role\\_project\\_dev: Developer'."\n" + ."\n" + .'- role\\_project\\_dg\\_admin: Data Governance Administrator'."\n" + ."\n" + .'- role\\_project\\_guest: Guest'."\n" + ."\n" + .'- role\\_project\\_security: Security Administrator'."\n" + ."\n" + .'- role\\_project\\_deploy: Deployment'."\n" + ."\n" + .'- role\\_project\\_owner: Workspace Owner'."\n" + ."\n" + .'- role\\_project\\_data\\_analyst: Data Analyst'."\n" + ."\n" + .'- role\\_project\\_pe: O\\&M (Operations & Maintenance)'."\n" + ."\n" + .'- role\\_project\\_erd: Model Designer', 'type' => 'string', 'example' => 'role_project_guest', 'title' => ''], + 'Name' => ['description' => 'The name of the Workspace role.', 'type' => 'string', 'example' => 'Visitors', 'title' => ''], + 'Type' => ['description' => 'The type of the Workspace role.'."\n" + ."\n" + .'- UserCustom: A user-defined role.'."\n" + ."\n" + .'- System: A built-in System Role.', 'type' => 'string', 'example' => 'System', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'UserName' => ['description' => 'The name of the user.', 'type' => 'string', '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.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8abcb91f-d266-4073-b907-2ed670378ed1\\",\\n \\"ProjectMember\\": {\\n \\"ProjectId\\": 88757,\\n \\"UserId\\": \\"123422344899\\",\\n \\"Status\\": \\"Normal\\",\\n \\"Roles\\": [\\n {\\n \\"Code\\": \\"role_project_guest\\",\\n \\"Name\\": \\"Visitors\\",\\n \\"Type\\": \\"System\\"\\n }\\n ],\\n \\"UserName\\": \\"\\"\\n }\\n}","type":"json"}]', + 'title' => 'GetProjectMember', + 'description' => 'This operation is available only in DataWorks Basic Edition and later.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetProjectMember', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": 1000001,\\n \\"RequestId\\": \\"0000-ABCD-EFG\\"\\n}","type":"json"}]', - 'title' => 'CreateResourceFile', ], - 'CreateUdfFile' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetProjectRole' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '269313', - 'abilityTreeNodes' => [ - 'FEATUREdide8FM783', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '244504', + 'abilityTreeNodes' => ['FEATUREdideYTM537'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ - [ - 'name' => 'FileFolderPath', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The path to the folder containing the function file.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Business_process/First_Business_Process/function/string_processing', - ], - ], [ 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The DataWorks workspace ID. To find this, click the wrench icon in the upper-right corner and navigate to the workspace management page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '10000', - ], - ], - [ - 'name' => 'FileName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The function name.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'StringConcat', - ], - ], - [ - 'name' => 'FunctionType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The function category, corresponding to the function type field in the Create Function form. Valid values: MATH (mathematical functions), AGGREGATE (aggregate functions), STRING (string processing functions), DATE (date processing functions), ANALYTIC (window functions), and OTHER (other functions).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'STRING', - 'enum' => [ - 'MATH', - 'AGGREGATE', - 'STRING', - 'DATE', - 'ANALYTIC', - 'OTHER', - ], - ], - ], - [ - 'name' => 'ClassName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The class name where the function is defined, corresponding to the class name field in the Create Function form.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'com.alibaba.DataWorks.api.udf.StringConcat', - ], + '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 Management page to obtain the workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10002', 'title' => ''], ], [ - 'name' => 'Resources', - 'in' => 'formData', + 'name' => 'Code', + 'in' => 'query', 'schema' => [ - 'description' => 'A comma-separated list of resource names referenced by the function, corresponding to the resource list field in the Create Function form.'."\n", + 'description' => 'The code of the workspace role. Valid values:'."\n" + ."\n" + .'- role\\_project\\_admin: workspace administrator'."\n" + ."\n" + .'- role\\_project\\_dev: developer'."\n" + ."\n" + .'- role\\_project\\_dg\\_admin: data governance administrator'."\n" + ."\n" + .'- role\\_project\\_guest: guest'."\n" + ."\n" + .'- role\\_project\\_security: security administrator'."\n" + ."\n" + .'- role\\_project\\_deploy: deployer'."\n" + ."\n" + .'- role\\_project\\_owner: workspace owner'."\n" + ."\n" + .'- role\\_project\\_data\\_analyst: data analyst'."\n" + ."\n" + .'- role\\_project\\_pe: O\\&M engineer'."\n" + ."\n" + .'- role\\_project\\_erd: model designer', + 'enumValueTitles' => [], 'type' => 'string', 'required' => true, - 'docRequired' => true, - 'example' => 'string-concat-1.0.0.jar,commons-lang-2.6.jar', - ], - ], - [ - 'name' => 'UdfDescription', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The function purpose description, corresponding to the description field in the Create Function form.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'Concatenate several strings to generate a new string', - ], - ], - [ - 'name' => 'CmdDescription', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The command format for invoking the function, corresponding to the command format field in the Create Function form.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'StringConcat(String... substrs)', - ], - ], - [ - 'name' => 'ParameterDescription', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The function parameter description, corresponding to the parameter description field in the Create Function form.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'List of strings to be connected', - 'default' => '', - ], - ], - [ - 'name' => 'ReturnValue', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The return value description, corresponding to the return value field in the Create Function form.'."\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' => 'An example demonstrating how to call the function, corresponding to the example field in the Create Function form.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'StringConcat(\'a\', \'b\', \'c\')', - ], - ], - [ - 'name' => 'ProjectIdentifier', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The unique identifier of the DataWorks workspace, which is the identifier at the top of the Data Studio page where you switch workspaces.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dw_project', - ], - ], - [ - 'name' => 'CreateFolderIfNotExists', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether to automatically create the directory if the specified path (FileFolderPath) does not exist. Valid values:'."\n" - ."\n" - .'* true: Automatically creates the directory if it does not exist.'."\n" - .'* false: The call fails if the directory does not exist.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', + 'example' => 'role_project_guest', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response.'."\n", + 'title' => 'Schema of Response', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The file ID after successful creation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100000002', - ], - 'RequestId' => [ - 'description' => 'The unique ID for this request. Use this ID for troubleshooting if an error occurs.'."\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 succeeded.'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '82F28E60-CF48-5EDF-AB25-D806847B97D1'], + 'ProjectRole' => [ + 'description' => 'The details of the workspace role.', + 'type' => 'object', + 'properties' => [ + 'ProjectId' => ['description' => 'The ID of the DataWorks workspace.'."\n" + ."\n" + .'Note: A fixed value of -1 is returned for a system role.', 'type' => 'integer', 'format' => 'int64', 'example' => '10002', 'title' => ''], + 'Code' => [ + 'description' => 'The code of the workspace role.', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'role_project_guest', + 'title' => '', + ], + 'Name' => ['description' => 'The name of the workspace role.', 'type' => 'string', 'example' => 'Visitors', 'title' => ''], + 'Type' => [ + 'description' => 'The type of the workspace role. Valid values:'."\n" + ."\n" + .'- UserCustom: a custom role'."\n" + ."\n" + .'- System: a system role', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'System', + 'title' => '', + ], + 'ModulePermissions' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ModuleId' => ['description' => 'The module ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'ModuleName' => ['description' => 'The module name.', 'type' => 'string', 'example' => 'HoloStudio', 'title' => ''], + 'PermissionType' => ['description' => 'The permission type.', 'type' => 'string', 'example' => 'Read', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => 'The permissions for the modules in the workspace.', + '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.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetProjectRole', + 'summary' => 'Queries the details of a workspace role.', + 'description' => 'You can call this operation only if you have purchased DataWorks Basic Edition or a later edition.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetProjectRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - '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"}]', - 'title' => 'CreateUdfFile', - 'summary' => 'Creates a file for a function in DataStudio.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"82F28E60-CF48-5EDF-AB25-D806847B97D1\\",\\n \\"ProjectRole\\": {\\n \\"ProjectId\\": 10002,\\n \\"Code\\": \\"role_project_guest\\",\\n \\"Name\\": \\"Visitors\\",\\n \\"Type\\": \\"System\\",\\n \\"ModulePermissions\\": [\\n {\\n \\"ModuleId\\": 2,\\n \\"ModuleName\\": \\"HoloStudio\\",\\n \\"PermissionType\\": \\"Read\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], - 'DeleteFile' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetRerunWorkflowInstancesResult' => [ + 'summary' => 'Query the result of an asynchronous rerun workflow instance', + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '268111', - 'abilityTreeNodes' => [ - 'FEATUREdide8FM783', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdideVFMENL'], ], '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 ID.'."\n" - ."\n" - .'You must specify either this parameter or the ProjectIdentifier parameter to identify the DataWorks workspace when you call this operation.'."\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](https://workbench.data.aliyun.com/console) and go to the Workspace page to query the name.'."\n" - ."\n" - .'You must specify either this parameter or the ProjectId parameter to identify the DataWorks workspace when you call this operation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dw_project', - ], - ], - [ - 'name' => 'FileId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The file ID. You can call the [ListFiles](~~173942~~) operation to obtain the folder ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '10000201', - ], + 'name' => 'OperationId', + 'in' => 'query', + 'schema' => ['description' => 'The operation ID used to asynchronously query the result of the workflow instance rerun. This value is obtained from the RerunWorkflowInstances operation.', 'type' => 'string', 'required' => true, 'example' => 'e15ad21c-b0e9-4792-8f55-b037xxxxxxxx'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The returned result.'."\n", + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'DeploymentId' => [ - 'description' => 'If the file has already been submitted, the DeleteFile operation also triggers an asynchronous deletion process in the scheduling system. You must use the DeploymentId returned by the DeleteFile operation to call GetDeployment and poll the status of the triggered asynchronous deletion process.'."\n" - ."\n" - .'If this field is empty, the file has been deleted and no further polling is required.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000000001', - ], - 'RequestId' => [ - 'description' => 'The request ID. Used for troubleshooting when an error occurs.'."\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 call was successful. Valid values:'."\n" - ."\n" - .'* true: success.'."\n" - .'* false: failure.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID, used for log tracing and troubleshooting.', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n"], + 'Result' => [ + 'description' => 'The result of the workflow instance rerun.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status. NotRun Success Failure', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'FailureMessage' => ['description' => 'The failure message. Returned if the rerun fails.', 'type' => 'string', 'example' => 'Invalid Param xxx'."\n", 'title' => ''], + ], + '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.', - ], + 400 => [ + ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Obtain the result of a rerun workflow instance ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', - '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.', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\\\n\\",\\n \\"Result\\": {\\n \\"Status\\": \\"Success\\",\\n \\"FailureMessage\\": \\"Invalid Param xxx\\\\n\\"\\n }\\n}","type":"json"}]', ], - 'UpdateFile' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetResource' => [ + 'summary' => 'Queries the information about a file resource.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '268116', - 'abilityTreeNodes' => [ - 'FEATUREdide8FM783', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235473', + 'abilityTreeNodes' => ['FEATUREdideJ3TPTK'], ], 'parameters' => [ - [ - 'name' => 'FileFolderPath', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The path to the folder where the file is located.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'Business_process/First_Business_Process/data_integration/Folder_1/Folder_2', - ], - ], [ 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The DataWorks workspace ID. To obtain the ID, log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and navigate to the workspace management page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '100001', - ], + '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.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000', 'title' => ''], ], [ - 'name' => 'FileName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The file name. You can modify the file name by setting a new value for FileName. For example, you can call the [ListFiles](~~173942~~) operation to query the file ID in the target directory, and then call the [UpdateFile](~~173951~~) operation with the file ID specified in the FileId parameter and a new value specified in the FileName parameter to modify the file name.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'ods_user_info_d', - ], + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The unique identifier of the file resource.'."\n" + ."\n" + .'> This field is of type Long in SDK versions prior to 8.0.0, and of type String in SDK version 8.0.0 and later. This change does not affect the normal use of the SDK; parameters are still returned according to the type defined in the SDK. Compilation failures due to the type change may occur only when upgrading the SDK across version 8.0.0, in which case users need to manually correct the data type.', 'type' => 'string', 'required' => true, 'example' => '86043887262011****', 'title' => ''], ], - [ - 'name' => 'FileDescription', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The file description.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'Here is the file description', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'E871F6C0-2EFF-5790-A00D-C57543EEXXXX'], + 'Resource' => [ + 'description' => 'File resource details.', + 'type' => 'object', + 'properties' => [ + 'ProjectId' => ['description' => 'The ID of the workspace to which the file resource belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'title' => ''], + 'Name' => ['description' => 'The name of the file resource.', 'type' => 'string', 'example' => 'OpenAPI_Test_Resource. py', 'title' => ''], + 'Owner' => ['description' => 'The owner of the file resource.', 'type' => 'string', 'example' => '110755000425XXXX', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the file resource was created. This value is a UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1700539206000', 'title' => ''], + 'ModifyTime' => ['description' => 'The time when the file resource was last modified. This value is a UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1700539206000', 'title' => ''], + 'Spec' => ['description' => 'The FlowSpec field information about the file resource. For more information, see [FlowSpec](https://github.com/aliyun/alibabacloud-dataworks-tool-dflow).', 'type' => 'string', 'example' => '{'."\n" + .' "version": "1.1.0",'."\n" + .' "kind": "Resource",'."\n" + .' "spec": {'."\n" + .' "fileResources": ['."\n" + .' {'."\n" + .' "name": "OpenAPI_Test_Resource.py",'."\n" + .' "id": "631478864897630XXXX",'."\n" + .' "script": {'."\n" + .' "content": "",'."\n" + .' "path": "XX/OpenAPI_Test/Resource_Test/OpenAPI_Test_Resource.py",'."\n" + .' "runtime": {'."\n" + .' "command": "ODPS_PYTHON"'."\n" + .' }'."\n" + .' },'."\n" + .' "type": "python",'."\n" + .' "file": {'."\n" + .' "storage": {}'."\n" + .' },'."\n" + .' "datasource": {'."\n" + .' "name": "odps_first",'."\n" + .' "type": "odps"'."\n" + .' },'."\n" + .' "metadata": {'."\n" + .' "owner": "110755000425XXXX"'."\n" + .' }'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .'}', 'title' => ''], + 'Id' => ['description' => 'The unique identifier of the file resource.'."\n" + ."\n" + .'> Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.', 'type' => 'string', 'example' => '860438872620113XXXX', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E871F6C0-2EFF-5790-A00D-C57543EEXXXX\\",\\n \\"Resource\\": {\\n \\"ProjectId\\": 10000,\\n \\"Name\\": \\"OpenAPI_Test_Resource. py\\",\\n \\"Owner\\": \\"110755000425XXXX\\",\\n \\"CreateTime\\": 1700539206000,\\n \\"ModifyTime\\": 1700539206000,\\n \\"Spec\\": \\"{\\\\n \\\\\\"version\\\\\\": \\\\\\"1.1.0\\\\\\",\\\\n \\\\\\"kind\\\\\\": \\\\\\"Resource\\\\\\",\\\\n \\\\\\"spec\\\\\\": {\\\\n \\\\\\"fileResources\\\\\\": [\\\\n {\\\\n \\\\\\"name\\\\\\": \\\\\\"OpenAPI_Test_Resource.py\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"631478864897630XXXX\\\\\\",\\\\n \\\\\\"script\\\\\\": {\\\\n \\\\\\"content\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"path\\\\\\": \\\\\\"XX/OpenAPI_Test/Resource_Test/OpenAPI_Test_Resource.py\\\\\\",\\\\n \\\\\\"runtime\\\\\\": {\\\\n \\\\\\"command\\\\\\": \\\\\\"ODPS_PYTHON\\\\\\"\\\\n }\\\\n },\\\\n \\\\\\"type\\\\\\": \\\\\\"python\\\\\\",\\\\n \\\\\\"file\\\\\\": {\\\\n \\\\\\"storage\\\\\\": {}\\\\n },\\\\n \\\\\\"datasource\\\\\\": {\\\\n \\\\\\"name\\\\\\": \\\\\\"odps_first\\\\\\",\\\\n \\\\\\"type\\\\\\": \\\\\\"odps\\\\\\"\\\\n },\\\\n \\\\\\"metadata\\\\\\": {\\\\n \\\\\\"owner\\\\\\": \\\\\\"110755000425XXXX\\\\\\"\\\\n }\\\\n }\\\\n ]\\\\n }\\\\n}\\",\\n \\"Id\\": \\"860438872620113XXXX\\"\\n }\\n}","type":"json"}]', + 'title' => 'GetResource', + 'changeSet' => [ + ['createdAt' => '2025-01-13T07:36:02.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'Content', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The file code content. Different code types (fileType) have different code formats. In Operation Center, you can right-click a task of the corresponding type and select View Code to view the specific code format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SELECT "1";', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'GetResourceGroup' => [ + 'summary' => 'Queries the information about a resource group based on its ID.', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'AutoRerunTimes', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of automatic reruns after the file execution fails.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'example' => '3', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '245094', + 'abilityTreeNodes' => ['FEATUREdide2SV6DS'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ [ - 'name' => 'AutoRerunIntervalMillis', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The interval at which the node is automatically rerun after a failure. Unit: milliseconds. Maximum value: 1800000 milliseconds (30 minutes).'."\n" - ."\n" - .'This parameter corresponds to the Rerun interval parameter in Properties > Schedule > Auto Rerun upon Failure for data development nodes in the [DataWorks console](https://workbench.data.aliyun.com/console). In the console, the unit of the rerun interval is minutes. Convert the time unit when you call this operation.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '120000', - ], + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => true, 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX', 'title' => ''], ], - [ - 'name' => 'RerunMode', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The rerun policy. Valid values:'."\n" - ."\n" - .'* ALL_ALLOWED: Reruns are allowed regardless of whether the task succeeds or fails.'."\n" - .'* FAILURE_ALLOWED: Reruns are allowed only when the task fails.'."\n" - .'* ALL_DENIED: Reruns are not allowed regardless of whether the task succeeds or fails.'."\n" - ."\n" - .'This parameter corresponds to the Support for Rerun setting in Scheduling > Scheduling Policies for Data Studio tasks 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', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'example' => 'true'], + 'ResourceGroup' => [ + 'title' => '', + 'description' => 'The details about the resource group.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX', 'title' => ''], + 'Name' => ['description' => 'The name of the resource group.', 'type' => 'string', 'example' => 'common_resource_group', 'title' => ''], + 'Remark' => ['description' => 'The description of the resource group.', 'type' => 'string', 'example' => 'Create a common resource group for common tasks', 'title' => ''], + 'PaymentType' => [ + 'description' => 'The billing method of the resource group. Valid values: PrePaid and PostPaid. The value PrePaid indicates the subscription billing method, and the value PostPaid indicates the pay-as-you-go billing method.', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'PrePaid', + 'enum' => ['PrePaid', 'PostPaid'], + 'title' => '', + ], + 'Status' => [ + 'description' => 'The status of the resource group. Valid values:'."\n" + ."\n" + .'- Normal: The resource group is running or in use.'."\n" + ."\n" + .'- Stop: The resource group is expired.'."\n" + ."\n" + .'- Deleted: The resource group is released or destroyed.'."\n" + ."\n" + .'- Creating: The resource group is being created.'."\n" + ."\n" + .'- CreateFailed: The resource group fails to be created.'."\n" + ."\n" + .'- Updating: The resource group is being scaled in or out, or the configurations of the resource group are being changed.'."\n" + ."\n" + .'- UpdateFailed: The resource group fails to be scaled out or upgraded.'."\n" + ."\n" + .'- Deleting: The resource group is being released or destroyed.'."\n" + ."\n" + .'- DeleteFailed: The resource group fails to be released or destroyed.'."\n" + ."\n" + .'- Timeout: The operations that are performed on the resource group time out.'."\n" + ."\n" + .'- Freezed: The resource group is frozen.'."\n" + ."\n" + .'- Starting: The resource group is being started.', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'Normal', + 'enum' => ['Normal', 'Stop', 'Deleted', 'Creating', 'CreateFailed', 'Updating', 'UpdateFailed', 'Deleting', 'DeleteFailed', 'Timeout'], + 'title' => '', + ], + 'Spec' => [ + 'title' => '', + 'description' => 'The specifications of the resource group.', + 'type' => 'object', + 'properties' => [ + 'Standard' => ['description' => 'The number of compute units (CUs) in the resource group.', 'type' => 'string', 'example' => '2CU', 'title' => ''], + 'Amount' => ['description' => 'The number of resources in the resource group.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + ], + 'example' => '', + ], + 'ResourceGroupType' => [ + 'description' => 'The type of the resource group. Valid values:'."\n" + ."\n" + .'- CommonV2: Serverless resource group.'."\n" + ."\n" + .'- ExclusiveDataIntegration: Exclusive resource group for Data Integration.'."\n" + ."\n" + .'- ExclusiveScheduler: Exclusive resource group for scheduling.'."\n" + ."\n" + .'- ExclusiveDataService: Exclusive resource group for DataService Studio.', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'CommonV2', + 'enum' => ['CommonV2', 'ExclusiveDataIntegration', 'ExclusiveScheduler', 'ExclusiveDataService'], + 'title' => '', + ], + 'OrderInstanceId' => ['description' => 'The instance ID of the order that is used to create the resource group.', 'type' => 'string', 'example' => 'c442b330-3b10-4584-959e-736e4edXXXXX', 'title' => ''], + 'CreateUser' => ['description' => 'The ID of the account that is used to create the resource group.', 'type' => 'string', 'example' => '11075500042XXXXX', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the resource group was created. The value is a 64-bit timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1727055811000', 'title' => ''], + 'DefaultVpcId' => ['description' => 'The ID of the virtual private cloud (VPC) with which the resource group is associated by default.', 'type' => 'string', 'example' => 'vpc-m2et4f3oc8msfbccXXXXX', 'title' => ''], + 'DefaultVswitchId' => ['description' => 'The ID of the vSwitch with which the resource group is associated by default.', 'type' => 'string', 'example' => 'vsw-uf8usrhs7hjd9amsXXXXX', 'title' => ''], + 'AliyunResourceGroupId' => ['description' => 'The ID of the Alibaba Cloud resource group.', 'type' => 'string', 'example' => 'rg-aek2kqofrgXXXXX', 'title' => ''], + 'AliyunResourceTags' => [ + 'title' => '', + 'description' => 'The tags.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The tag.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'key', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'value', 'title' => ''], + ], + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', 'title' => ''], ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ResourceGroup\\": {\\n \\"Id\\": \\"Serverless_res_group_524257424564736_6831777003XXXXX\\",\\n \\"Name\\": \\"common_resource_group\\",\\n \\"Remark\\": \\"Create a common resource group for common tasks\\",\\n \\"PaymentType\\": \\"PrePaid\\",\\n \\"Status\\": \\"Normal\\",\\n \\"Spec\\": {\\n \\"Standard\\": \\"2CU\\",\\n \\"Amount\\": 1\\n },\\n \\"ResourceGroupType\\": \\"CommonV2\\",\\n \\"OrderInstanceId\\": \\"c442b330-3b10-4584-959e-736e4edXXXXX\\",\\n \\"CreateUser\\": \\"11075500042XXXXX\\",\\n \\"CreateTime\\": 1727055811000,\\n \\"DefaultVpcId\\": \\"vpc-m2et4f3oc8msfbccXXXXX\\",\\n \\"DefaultVswitchId\\": \\"vsw-uf8usrhs7hjd9amsXXXXX\\",\\n \\"AliyunResourceGroupId\\": \\"rg-aek2kqofrgXXXXX\\",\\n \\"AliyunResourceTags\\": [\\n {\\n \\"Key\\": \\"key\\",\\n \\"Value\\": \\"value\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]', + 'title' => 'GetResourceGroup', + 'description' => 'DataWorks Basic Edition or a more advanced edition is required to use this feature.', + 'changeSet' => [ + ['createdAt' => '2025-01-02T07:14:14.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'Stop', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether to skip execution. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n" - ."\n" - .'This parameter corresponds to the Skip Execution option in Properties > Schedule > Recurrence for data development nodes in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'DwResourceGroup', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:dwresourcegroup/{#DwResourceGroupId}'], + ], ], ], + ], + ], + 'GetRoute' => [ + 'summary' => 'Queries the information about a route based on its ID.', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'ParaValue', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The scheduling parameters of the node.'."\n" - ."\n" - .'This parameter corresponds to the Scheduling Parameter setting in Properties for data development nodes in the [DataWorks console](https://workbench.data.aliyun.com/console). For more information, see [Scheduling parameters](~~137548~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'x=a y=b z=c', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '245172', + 'abilityTreeNodes' => ['FEATUREdide2SV6DS'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ [ - 'name' => 'StartEffectDate', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The timestamp (in milliseconds) when automatic scheduling starts.'."\n" - ."\n" - .'This parameter corresponds to the start time of Effective Period in Scheduling > Scheduling Time for Data Studio tasks in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'minimum' => '0', - 'example' => '936923400000', - ], + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The route ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1000', 'title' => ''], ], - [ - 'name' => 'EndEffectDate', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The timestamp (in milliseconds) when automatic scheduling stops.'."\n" - ."\n" - .'This parameter corresponds to the end time of Effective Period in Scheduling > Scheduling Time for Data Studio tasks in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'minimum' => '0', - 'example' => '4155787800000', + 'title' => 'Schema of Response', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'example' => 'true'], + 'Route' => [ + 'title' => '', + 'description' => 'The information about the route.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The route ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''], + 'ResourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'Serverless_res_group_524257424564736_6831777****', 'title' => ''], + 'ResourceId' => ['description' => 'The network resource ID.', 'type' => 'string', 'example' => 'ns-679XXXXX', 'title' => ''], + 'DestinationCidr' => ['description' => 'The CIDR block of the destination-based route.', 'type' => 'string', 'example' => '192.168.0.0/16', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the route was created. The value is a 64-bit timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1727055811000', 'title' => ''], + 'NetworkId' => ['description' => 'The network ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''], + ], + 'example' => '', + ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Route\\": {\\n \\"Id\\": 1000,\\n \\"ResourceGroupId\\": \\"Serverless_res_group_524257424564736_6831777****\\",\\n \\"ResourceId\\": \\"ns-679XXXXX\\",\\n \\"DestinationCidr\\": \\"192.168.0.0/16\\",\\n \\"CreateTime\\": 1727055811000,\\n \\"NetworkId\\": 1000\\n },\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]', + 'title' => 'GetRoute', + 'description' => 'This API operation is available for all DataWorks editions.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'CronExpress', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The cron expression for scheduled execution. This parameter corresponds to the Cron Expression setting in Scheduling > Scheduling Time for Data Studio tasks in the [DataWorks console](https://workbench.data.aliyun.com/console). After you configure Scheduling Cycle and Scheduled Time, DataWorks automatically generates a cron expression.'."\n" - ."\n" - .'Examples:'."\n" - ."\n" - .'* Scheduled at 05:30 every day: `00 30 05 * * ?`'."\n" - .'* Scheduled at the 15th minute of every hour: `00 15 * * * ?`'."\n" - .'* Scheduled every 10 minutes: `00 00/10 * * * ?`'."\n" - .'* Scheduled every 10 minutes between 08:00 and 23:00 every day: `00 00-59/10 8-23 * * * ?`'."\n" - .'* Scheduled at 00:20 on the 1st day of every month: `00 20 00 1 * ?`'."\n" - .'* Scheduled every 3 months starting from 00:10 on January 1: `00 10 00 1 1-12/3 ?`'."\n" - .'* Scheduled at 00:05 on every Tuesday and Friday: `00 05 00 * * 2,5`'."\n" - ."\n" - .'Due to the rules of the DataWorks scheduling system, cron expressions have the following restrictions:'."\n" - ."\n" - .'* The minimum scheduling interval is 5 minutes.'."\n" - .'* The earliest scheduling time each day is 00:05.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '00 00-59/5 1-23 * * ?', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetRoute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'GetSchema' => [ + 'summary' => 'Retrieves the schema details of a specified table in Data Map. Only MaxCompute and Hologres schemas are supported.', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'CycleType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The type of scheduling cycle. Valid values: NOT_DAY (minute, hour) and DAY (day, week, month).'."\n" - ."\n" - .'This parameter corresponds to the Scheduling Cycle setting in Scheduling > Scheduling Time for Data Studio tasks in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'NOT_DAY', - 'default' => 'DAY', - 'enum' => [ - 'DAY', - 'NOT_DAY', - ], - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'abilityTreeCode' => '267988', + 'abilityTreeNodes' => ['FEATUREdideE9XYA6'], + ], + 'parameters' => [ [ - 'name' => 'DependentType', - 'in' => 'formData', + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['title' => 'ID', 'description' => 'The ID. You can refer to the ListSchemas operation and [Concepts related to metadata entities](~~2880092~~).'."\n" + ."\n" + .'The format is `${EntityType}:${Instance ID or escaped URL}:${Catalog ID}:${Database name}:${Schema name}`. Use empty strings as placeholders for missing levels.'."\n" + ."\n" + .'> For the MaxCompute type, use an empty string as the placeholder for the instance ID level. The database name is the MaxCompute project name, and the project must have the three-level model enabled.'."\n" + ."\n" + .'Examples:'."\n" + ."\n" + .'`maxcompute-schema:::project_name:schema_name` (The three-level model is enabled for the MaxCompute project.)'."\n" + ."\n" + .'`holo-schema:instance_id::database_name:schema_name`'."\n" + ."\n" + .'>
`instance_id`: The Hologres instance ID
'."\n" + .'> . `database_name`: The database name
'."\n" + .'> . `database_name`: The MaxCompute project name
'."\n" + .'> . `schema_name`: The schema name.', 'type' => 'string', 'required' => true, 'example' => 'maxcompute-schema:::project_name:schema_name'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The dependency mode on the previous cycle. Valid values:'."\n" - ."\n" - .'* SELF: Depends on the current node.'."\n" - .'* CHILD: Depends on the child nodes.'."\n" - .'* USER_DEFINE: Depends on other nodes.'."\n" - .'* NONE: No dependencies. Does not depend on the previous cycle.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'USER_DEFINE', - 'enum' => [ - 'NONE', - 'USER_DEFINE', - 'CHILD', - 'SELF', - 'USER_DEFINE_AND_SELF', - 'CHILD_AND_SELF', + 'title' => 'Schema of Response', + 'description' => 'The response.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'A89B5D9D-74EA-XXXXXX'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'Schema' => ['description' => 'The schema information.', '$ref' => '#/components/schemas/Schema', 'title' => '', 'example' => ''], ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A89B5D9D-74EA-XXXXXX\\",\\n \\"Success\\": true,\\n \\"Schema\\": {\\n \\"Id\\": \\"maxcompute-schema:123456XXX::test_project:default\\\\nholo-schema:h-abc123xxx::test_db:test_schema\\",\\n \\"Name\\": \\"test_db\\",\\n \\"Comment\\": \\"test comment\\",\\n \\"Type\\": \\"MANAGED\\",\\n \\"ParentMetaEntityId\\": \\"maxcompute-project:123456XXX::test_project\\\\nholo-database:h-abc123xxx::test_db\\",\\n \\"CreateTime\\": 1736852168000,\\n \\"ModifyTime\\": 1736852168000\\n }\\n}","type":"json"}]', + 'title' => 'GetSchema', + 'description' => '1. DataWorks Basic Edition or a higher edition is required.'."\n" + ."\n" + .'2. Only MaxCompute and Hologres types are supported.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'GetSecurityStrategy' => [ + 'summary' => 'Retrieves the details of a security policy by its ID. This operation requires both DataWorks tenant administrator and security administrator permissions.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'DependentNodeIdList', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The IDs of the nodes on which the current node depends. This parameter takes effect only when the DependentType parameter is set to USER_DEFINE. Separate multiple node IDs with commas (,).'."\n" - ."\n" - .'This parameter corresponds to the Other Nodes option in Properties > Dependencies > Cross-cycle Dependency (Original Previous-cycle Dependency) for data development nodes in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5,10,15,20', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => 'TBD', + 'abilityTreeNodes' => ['FEATUREdideYTM537'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ [ - 'name' => 'InputList', - 'in' => 'formData', + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => '**The ID of the security strategy.**', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '13', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The output names of the ancestor nodes on which the current node depends. Separate multiple output names with commas (,).'."\n" - ."\n" - .'This parameter corresponds to the Output Name of Ancestor Node setting in Properties > Dependencies for data development nodes in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n" - ."\n" - .'> This parameter is required when you call the CreateDISyncTask or UpdateFile operation to create a batch synchronization node.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'project_root,project.file1,project.001_out', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '0bc5df3a17****903790e8e8a'], + 'SecurityStrategy' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The policy ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '13', 'title' => ''], + 'Name' => ['description' => 'The policy name.', 'type' => 'string', 'example' => '默认数据分析策略', 'title' => ''], + 'Description' => ['description' => 'The policy description.', 'type' => 'string', 'example' => '控制数据分析模块的查询结果安全行为', 'title' => ''], + 'SchemaName' => [ + 'description' => 'The name of the schema template.', + 'type' => 'string', + 'enum' => ['DataQuerySecurityStrategySchema', 'DataStudioSecurityStrategySchema', 'DataStudioMyCatalogSecurityStrategySchema'], + 'example' => 'DataQuerySecurityStrategySchema', + 'title' => '', + ], + 'ControlModule' => [ + 'description' => 'The control module.', + 'type' => 'string', + 'enum' => ['DataQuery', 'DataStudio'], + 'example' => 'DataQuery', + 'title' => '', + ], + 'ControlSubModule' => [ + 'description' => 'The control submodule.', + 'type' => 'string', + 'enum' => ['MyCatalog'], + 'example' => 'MyCatalog', + 'title' => '', + ], + 'ControlDwScope' => [ + 'description' => 'The scope where the policy is effective. Valid values: `Workspace` or `Tenant`.', + 'type' => 'string', + 'enum' => ['Tenant', 'Workspace'], + 'example' => 'Tenant', + 'title' => '', + ], + 'Workspaces' => [ + 'type' => 'array', + 'items' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '4843434', 'title' => ''], + 'description' => 'The list of associated workspace IDs.', + 'title' => '', + 'example' => '', + ], + 'Enabled' => ['description' => 'Whether the security policy is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'OriginPolicyId' => ['description' => 'The source ID of the default system policy.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''], + 'Creator' => ['description' => 'The ID of the creator.', 'type' => 'string', 'example' => '203322746501002787', 'title' => ''], + 'Updater' => ['description' => 'The ID of the last updater.', 'type' => 'string', 'example' => '203322746501002787', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the security policy was created.', 'type' => 'string', 'example' => '2026-05-25T20:46:19', 'title' => ''], + 'UpdateTime' => ['description' => 'The time when the security policy was last updated.', 'type' => 'string', 'example' => '2026-05-25T20:46:19', 'title' => ''], + 'Content' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The `name` field from the associated `SecurityStrategySchema`.', + 'type' => 'string', + 'enum' => ['DataQuerySecurityStrategySchema', 'DataStudioSecurityStrategySchema', 'DataStudioMyCatalogSecurityStrategySchema'], + 'example' => 'DataQuerySecurityStrategySchema', + 'title' => '', + ], + 'DisplayName' => ['description' => 'The `displayName` field from the associated `SecurityStrategySchema`.', 'type' => 'string', 'example' => '数据分析', 'title' => ''], + 'DisplayNameEn' => ['description' => 'The `displayNameEn` field from the associated `SecurityStrategySchema`.', 'type' => 'string', 'example' => 'Data Query', 'title' => ''], + 'ControlModule' => [ + 'description' => 'The control module. This value corresponds to `controlModule` in the associated `SecurityStrategySchema`.', + 'type' => 'string', + 'enum' => ['DataQuery', 'DataStudio'], + 'example' => 'DataQuery', + 'title' => '', + ], + 'ControlSubModule' => [ + 'description' => 'The control submodule. This value corresponds to `controlSubModule` in the associated `SecurityStrategySchema`.', + 'type' => 'string', + 'enum' => ['MyCatalog'], + 'example' => 'MyCatalog', + 'title' => '', + ], + 'ControlDwScope' => [ + 'description' => 'The scope where the policy is effective. Valid values:', + 'enumValueTitles' => ['Tenant' => 'Applies at the tenant level.', 'Workspace' => 'Applies at the workspace level.'], + 'type' => 'string', + 'enum' => ['Tenant', 'Workspace'], + 'example' => 'Tenant', + 'title' => '', + ], + 'SystemPolicyName' => ['description' => 'The name of the system policy. If specified, a default policy is automatically created.', 'type' => 'string', 'example' => 'SYSTEM_GENERATE_DEFAULT_DATA_QUERY', 'title' => ''], + 'SystemPolicyDisplayName' => ['description' => 'The display name of the system policy.', 'type' => 'string', 'example' => 'Default system generate data query policy', 'title' => ''], + 'Controllers' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Controller' => ['description' => 'The identifier for the controller. For valid values, see the documentation for the relevant schema.', 'type' => 'string', 'example' => 'viewCount', 'title' => ''], + 'DisplayName' => ['description' => 'The display name.', 'type' => 'string', 'example' => '查询结果-单次展示记录值上限', 'title' => ''], + 'DisplayNameEn' => ['description' => 'The display name in English.', 'type' => 'string', 'example' => 'Query Results - Single Display Record Limit', 'title' => ''], + 'Enable' => ['description' => 'Whether the controller is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ControllerValueType' => ['description' => 'The value type of the controller. Valid values are `Boolean`, `Integer`, `Long`, and `String`.', 'type' => 'string', 'example' => 'Integer', 'title' => ''], + 'UserConfigValue' => ['description' => 'The value configured by the user. The data type of this value is specified by the `ControllerValueType` parameter.', 'type' => 'any', 'example' => '10', 'title' => ''], + 'BasicEditionDefaultValue' => ['description' => 'The default value for Basic Edition.', 'type' => 'any', 'example' => '10000', 'title' => ''], + 'StandardEditionDefaultValue' => ['description' => 'The default value for Standard Edition.', 'type' => 'any', 'example' => '10000', 'title' => ''], + 'ProfessionalEditionDefaultValue' => ['description' => 'The default value for Professional Edition.', 'type' => 'any', 'example' => '10000', 'title' => ''], + 'EnterpriseEditionDefaultValue' => ['description' => 'The default value for Enterprise Edition.', 'type' => 'any', 'example' => '10000', 'title' => ''], + 'BasicEditionIntervalValue' => [ + 'type' => 'array', + 'items' => ['description' => 'The start or end value of the range.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'description' => 'The valid value range for Basic Edition, specified as an array `[min, max]`.', + 'title' => '', + 'example' => '', + ], + 'StandardEditionIntervalValue' => [ + 'type' => 'array', + 'items' => ['description' => 'The start or end value of the range.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'description' => 'The valid value range for Standard Edition, specified as an array `[min, max]`.', + 'title' => '', + 'example' => '', + ], + 'ProfessionalEditionIntervalValue' => [ + 'type' => 'array', + 'items' => ['description' => 'The start or end value of the range.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'description' => 'The valid value range for Professional Edition, specified as an array `[min, max]`.', + 'title' => '', + 'example' => '', + ], + 'EnterpriseEditionIntervalValue' => [ + 'type' => 'array', + 'items' => ['description' => 'The start or end value of the range.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'description' => 'The valid value range for Enterprise Edition, specified as an array `[min, max]`.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'A controller.', + 'title' => '', + 'example' => '', + ], + 'description' => 'A list of controllers.'."\n" + ."\n" + .'**Note:** The available controllers depend on the selected schema. See the documentation for your schema for a list of valid controllers.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The content of the security policy. Its structure is defined by the `SecurityStrategySchema`.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The security policy.', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'description' => 'The response schema.', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetSecurityStrategy', + 'description' => '## Request'."\n" + ."\n" + .'- This API retrieves the complete configuration information for a security policy by its ID.'."\n" + ."\n" + .'- The API returns an error message if the provided `Id` is invalid or does not exist.'."\n" + ."\n" + .'- The response includes basic policy information, such as its name and description, and policy details, such as control items and their settings.'."\n" + ."\n" + .'- Note: Some fields in a system default policy cannot be modified or deleted.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc5df3a17****903790e8e8a\\",\\n \\"SecurityStrategy\\": {\\n \\"Id\\": 13,\\n \\"Name\\": \\"默认数据分析策略\\",\\n \\"Description\\": \\"控制数据分析模块的查询结果安全行为\\",\\n \\"SchemaName\\": \\"DataQuerySecurityStrategySchema\\",\\n \\"ControlModule\\": \\"DataQuery\\",\\n \\"ControlSubModule\\": \\"MyCatalog\\",\\n \\"ControlDwScope\\": \\"Tenant\\",\\n \\"Workspaces\\": [\\n 4843434\\n ],\\n \\"Enabled\\": true,\\n \\"OriginPolicyId\\": 12,\\n \\"Creator\\": \\"203322746501002787\\",\\n \\"Updater\\": \\"203322746501002787\\",\\n \\"CreateTime\\": \\"2026-05-25T20:46:19\\",\\n \\"UpdateTime\\": \\"2026-05-25T20:46:19\\",\\n \\"Content\\": {\\n \\"Name\\": \\"DataQuerySecurityStrategySchema\\",\\n \\"DisplayName\\": \\"数据分析\\",\\n \\"DisplayNameEn\\": \\"Data Query\\",\\n \\"ControlModule\\": \\"DataQuery\\",\\n \\"ControlSubModule\\": \\"MyCatalog\\",\\n \\"ControlDwScope\\": \\"Tenant\\",\\n \\"SystemPolicyName\\": \\"SYSTEM_GENERATE_DEFAULT_DATA_QUERY\\",\\n \\"SystemPolicyDisplayName\\": \\"Default system generate data query policy\\",\\n \\"Controllers\\": [\\n {\\n \\"Controller\\": \\"viewCount\\",\\n \\"DisplayName\\": \\"查询结果-单次展示记录值上限\\",\\n \\"DisplayNameEn\\": \\"Query Results - Single Display Record Limit\\",\\n \\"Enable\\": true,\\n \\"ControllerValueType\\": \\"Integer\\",\\n \\"UserConfigValue\\": \\"10\\",\\n \\"BasicEditionDefaultValue\\": \\"10000\\",\\n \\"StandardEditionDefaultValue\\": \\"10000\\",\\n \\"ProfessionalEditionDefaultValue\\": \\"10000\\",\\n \\"EnterpriseEditionDefaultValue\\": \\"10000\\",\\n \\"BasicEditionIntervalValue\\": [\\n 0\\n ],\\n \\"StandardEditionIntervalValue\\": [\\n 0\\n ],\\n \\"ProfessionalEditionIntervalValue\\": [\\n 0\\n ],\\n \\"EnterpriseEditionIntervalValue\\": [\\n 0\\n ]\\n }\\n ]\\n }\\n }\\n}","type":"json"}]', + ], + 'GetSkill' => [ + 'summary' => 'Retrieves the details of a specified Skill by name, including the body of the SKILL.md file and the bundle\'s download link.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'ProjectIdentifier', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The DataWorks workspace name. To obtain the workspace name, log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and navigate to the workspace configuration page.'."\n" - ."\n" - .'You must specify either this parameter or ProjectId to identify the target DataWorks workspace for this API call.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dw_project', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => 'TBD', + 'abilityTreeNodes' => ['FEATUREdideYTM537'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ [ - 'name' => 'FileId', + 'name' => 'Name', 'in' => 'formData', + 'schema' => ['description' => 'The unique name of the Skill.', 'type' => 'string', 'required' => true, 'example' => 'my-skill', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The file ID. You can call the [ListFiles](~~173942~~) operation to obtain the file ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '100000001', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The unique ID for the request.', 'type' => 'string', 'title' => '', 'example' => '824F80BA-1778-5D8A-BAFF-668A4D9C4CC7'], + 'Skill' => [ + 'type' => 'object', + 'properties' => [ + 'CreatorId' => ['description' => 'The ID of the user who created the Skill.', 'type' => 'string', 'example' => '123456', 'title' => ''], + 'ModifierId' => ['description' => 'The ID of the user who last modified the Skill.', 'type' => 'string', 'example' => '123456', 'title' => ''], + 'Name' => ['description' => '**The name of the Skill.**', 'type' => 'string', 'example' => 'my-skill', 'title' => ''], + 'Description' => ['description' => '**The Skill description.**', 'type' => 'string', 'example' => '数据分析技能', 'title' => ''], + 'Visibility' => ['description' => '**The visibility level.**', 'type' => 'string', 'example' => 'TENANT', 'title' => ''], + 'Body' => ['description' => '**The content of the SKILL.md file.**', 'type' => 'string', 'example' => '把大象装冰箱需要3步，把冰箱门打开，把大象放进去，把冰箱门关上。', 'title' => ''], + 'VisibilityScope' => [ + 'type' => 'object', + 'properties' => [ + 'ProjectIds' => [ + 'type' => 'array', + 'items' => ['description' => 'A project ID.', 'type' => 'string', 'example' => '123456', 'title' => ''], + 'description' => '**A list of project IDs that can access the Skill.**', + 'title' => '', + 'example' => '', + ], + 'UserIds' => [ + 'type' => 'array', + 'items' => ['description' => 'A user ID.', 'type' => 'string', 'example' => '123456', 'title' => ''], + 'description' => 'A list of user IDs that can access the Skill.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '**The visibility scope.**', + 'title' => '', + 'example' => '', + ], + 'GmtCreateTime' => ['description' => 'The time the Skill was created, provided as a UNIX timestamp in milliseconds.', 'type' => 'string', 'format' => 'iso8601', 'example' => '1780555634000', 'title' => ''], + 'GmtModifiedTime' => ['description' => 'The time the Skill was last modified, provided as a UNIX timestamp in milliseconds.', 'type' => 'string', 'format' => 'iso8601', 'example' => '1780555634000', 'title' => ''], + 'BundleUrl' => ['description' => 'A temporary download link for `bundle.zip`, which does not require authentication and will expire.', 'type' => 'string', 'example' => 'https://your-bucket.oss-cn-hangzhou.aliyuncs.com/xxx.zip?Expires=...&Signature=...', 'title' => ''], + ], + 'description' => 'The returned Skill object.', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'description' => 'The response data.', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetSkill', + 'description' => '## Overview'."\n" + ."\n" + .'- **request parameters**: The name of the target Skill.'."\n" + ."\n" + .'- **response parameters**: The details of the Skill, including its name, description, creator ID, modifier ID, visibility level, visibility scope, the body of the SKILL.md file, a temporary download link for bundle.zip (which requires no authentication and will expire), the creation time, and the last modified time.'."\n" + ."\n" + .'- **Note**: The `BundleUrl` is a temporary download link. Once the link expires, you must call this operation again to get a new one.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"824F80BA-1778-5D8A-BAFF-668A4D9C4CC7\\",\\n \\"Skill\\": {\\n \\"CreatorId\\": \\"123456\\",\\n \\"ModifierId\\": \\"123456\\",\\n \\"Name\\": \\"my-skill\\",\\n \\"Description\\": \\"数据分析技能\\",\\n \\"Visibility\\": \\"TENANT\\",\\n \\"Body\\": \\"把大象装冰箱需要3步，把冰箱门打开，把大象放进去，把冰箱门关上。\\",\\n \\"VisibilityScope\\": {\\n \\"ProjectIds\\": [\\n \\"123456\\"\\n ],\\n \\"UserIds\\": [\\n \\"123456\\"\\n ]\\n },\\n \\"GmtCreateTime\\": \\"1780555634000\\",\\n \\"GmtModifiedTime\\": \\"1780555634000\\",\\n \\"BundleUrl\\": \\"https://your-bucket.oss-cn-hangzhou.aliyuncs.com/xxx.zip?Expires=...&Signature=...\\"\\n }\\n}","type":"json"}]', + ], + 'GetTable' => [ + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'OutputList', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The outputs of the node.'."\n" - ."\n" - .'This parameter corresponds to the Output Name setting in Properties > Dependencies for data development nodes in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dw_project.ods_user_info_d', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '267394', + 'abilityTreeNodes' => ['FEATUREdideE9XYA6'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ [ - 'name' => 'ResourceGroupIdentifier', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The resource group for the task published from the file. 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' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The ID. You can obtain this value from the response of the ListTables operation. For more information, see [Metadata entity concepts](~~2880092~~).'."\n" + ."\n\n" + .'The format is `${EntityType}:${InstanceID or encoded URL}:${DataCatalogIdentifier}:${DatabaseName}:${SchemaName}:${TableName}`. Use an empty string as a placeholder for levels that do not exist.'."\n" + ."\n" + .'> For MaxCompute and DLF types, use an empty string as a placeholder for the instance ID.'."\n" + ."\n" + .'> For StarRocks, the data catalog identifier is the catalog name. For DLF, the data catalog identifier is the catalog ID. Other types do not support the catalog level. Use an empty string as a placeholder.'."\n" + ."\n" + .'> For MaxCompute, the database name is the MaxCompute project name. Projects with the three-layer model enabled require a schema name. For projects without the three-layer model enabled, use an empty string as a placeholder for the schema name.'."\n" + ."\n" + .'The following examples show the ID formats for common types:'."\n" + ."\n" + .'`maxcompute-table:::project_name:[schema_name]:table_name`'."\n" + ."\n" + .'`dlf-table::catalog_id:database_name::table_name`'."\n" + ."\n" + .'`hms-table:instance_id::database_name::table_name`'."\n" + ."\n" + .'`holo-table:instance_id::database_name:schema_name:table_name`'."\n" + ."\n" + .'`mysql-table:(instance_id|encoded_jdbc_url)::database_name::table_name`'."\n" + ."\n" + .'> Where '."\n" + .'`instance_id`: The instance ID. This is required when the data source is registered in instance mode. '."\n" + .'`encoded_jdbc_url`: The URL-encoded JDBC connection string. This is required when the data source is registered using a connection string. '."\n" + .'`catalog_id`: The DLF catalog ID. '."\n" + .'`project_name`: The MaxCompute project name. '."\n" + .'`database_name`: The database name. '."\n" + .'`schema_name`: The schema name. For MaxCompute, this is required only when the three-layer model is enabled for the project. Use an empty string as a placeholder if the three-layer model is not enabled. '."\n" + .'`table_name`: The table name.', 'type' => 'string', 'required' => true, 'example' => 'maxcompute-table:::project_name:[schema_name]:table_name', 'title' => ''], ], [ - 'name' => 'ConnectionName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the data source that is used to run the node. You can call the [ListDataSources](~~211431~~) operation to query the available data sources.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'odps_source', - ], + 'name' => 'IncludeBusinessMetadata', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to include business metadata. Default value: false.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'Owner', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The file owner ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '18023848927592', - ], + 'name' => 'IncludeExtendedProperties', + 'in' => 'query', + 'schema' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], - [ - 'name' => 'AutoParsing', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Specifies whether to enable automatic parsing for the file. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n" - ."\n" - .'This parameter corresponds to the Analyze Code setting in Properties > Dependencies for data development nodes in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + 'description' => 'The response.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '7B3435F4-2D91-XXX', 'title' => ''], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'Table' => ['description' => 'The details of the data table.', '$ref' => '#/components/schemas/Table', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Get data table details in data map', + 'summary' => 'Retrieves the details of a specified data table in DataWorks Data Map. You can specify whether to return business metadata.', + 'description' => '1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'SchedulerType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The scheduling type. Valid values:'."\n" - ."\n" - .'* NORMAL: Normal scheduled task.'."\n" - .'* MANUAL: Manually triggered node. Not scheduled for daily execution. Corresponds to nodes in manually triggered workflows.'."\n" - .'* PAUSE: Paused task.'."\n" - .'* SKIP: Dry-run task. Scheduled for daily execution but is directly marked as successful when scheduling starts.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'NORMAL', - 'enum' => [ - 'NORMAL', - 'SKIP', - 'PAUSE', - 'MANUAL', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetTable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B3435F4-2D91-XXX\\",\\n \\"Success\\": true,\\n \\"Table\\": {\\n \\"Id\\": \\"dlf-table::catalog_id:database_name::table_name\\",\\n \\"Name\\": \\"table_name\\",\\n \\"Comment\\": \\"测试表\\",\\n \\"TableType\\": \\"TABLE\\",\\n \\"PartitionKeys\\": [\\n \\"ds\\"\\n ],\\n \\"ParentMetaEntityId\\": \\"dlf-database::catalog_id:database_name\\",\\n \\"CreateTime\\": 1736852168000,\\n \\"ModifyTime\\": 1736852168000,\\n \\"TechnicalMetadata\\": {\\n \\"Owner\\": \\"test_user\\",\\n \\"Location\\": \\"oss://test-bucket/test_tbl\\",\\n \\"Compressed\\": false,\\n \\"InputFormat\\": \\"org.apache.hadoop.hive.ql.io.parquet.MapredParquetInputFormat\\",\\n \\"OutputFormat\\": \\"org.apache.hadoop.hive.ql.io.parquet.MapredParquetOutputFormat\\",\\n \\"SerializationLibrary\\": \\"org.apache.hadoop.hive.ql.io.parquet.serde.ParquetHiveSerDe\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"value\\"\\n }\\n },\\n \\"BusinessMetadata\\": {\\n \\"Readme\\": \\"## 使用说明\\",\\n \\"CustomAttributes\\": {\\n \\"key\\": [\\n \\"张三\\"\\n ]\\n },\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"tag_key\\",\\n \\"Value\\": \\"tag_value\\"\\n }\\n ],\\n \\"Categories\\": [\\n [\\n {\\n \\"Id\\": \\"CATEGORY.456\\",\\n \\"Name\\": \\"测试类目\\",\\n \\"ParentId\\": \\"CATEGORY.123\\"\\n }\\n ]\\n ],\\n \\"UpstreamTasks\\": [\\n {\\n \\"Id\\": 123456,\\n \\"Name\\": \\"test_task\\"\\n }\\n ],\\n \\"Extension\\": {\\n \\"ProjectId\\": 234,\\n \\"EnvType\\": \\"Dev\\",\\n \\"ViewCount\\": 0,\\n \\"ReadCount\\": 0,\\n \\"FavorCount\\": 0\\n }\\n },\\n \\"StatisticsInfos\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n}","type":"json"}]', + ], + 'GetTask' => [ + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'AdvancedSettings', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The advanced settings for the task.'."\n" - ."\n" - .'This parameter corresponds to the Advanced Settings in the right-side navigation pane on the editing page for EMR Spark Streaming and EMR Streaming SQL tasks in Data Studio in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n" - ."\n" - .'Currently, only EMR Spark Streaming and EMR Streaming SQL tasks support this parameter, and the parameter must be in JSON format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"queue":"default","SPARK_CONF":"--conf spark.driver.memory=2g"}', - ], + 'AK' => [], ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '221964', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB', 'FEATUREdideD0YY7B', 'FEATUREdideVFMENL'], + ], + 'parameters' => [ [ - 'name' => 'StartImmediately', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether to start the task immediately after it is published. Valid values:'."\n" - ."\n" - .'* true: Start the task immediately after it is published.'."\n" - .'* false: Do not start the task immediately after it is published.'."\n" - ."\n" - .'This parameter corresponds to the Start Method setting in Configuration > Scheduling Policies in the right-side navigation pane on the editing page for EMR Spark Streaming and EMR Streaming SQL tasks in Data Studio in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234', 'title' => ''], ], [ - 'name' => 'InputParameters', - 'in' => 'formData', + 'name' => 'ProjectEnv', + 'in' => 'query', 'schema' => [ - 'description' => 'The input context parameters of the node. The value must be in the JSON format. For more information about the parameter structure, see the InputContextParameterList parameter in the response parameters of the [GetFile](~~173954~~) operation.'."\n" + 'description' => 'The environment of the workspace. Valid values:'."\n" ."\n" - .'This parameter corresponds to the Input Parameters setting in Properties > Input and Output Parameters for data development nodes 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 context parameters of the node. The value must be in the JSON format. For more information about the parameter structure, see the OutputContextParameterList parameter in the response parameters of the [GetFile](~~173954~~) operation.'."\n" + .'- Prod: production environment'."\n" ."\n" - .'This parameter corresponds to the Output Parameters setting in Properties > Input and Output Parameters for data development nodes in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", + .'- Dev: development environment', + 'enumValueTitles' => [], 'type' => 'string', + 'default' => 'Prod', + 'enum' => ['Prod', 'Dev'], 'required' => false, - 'example' => '[{"Type": 1,"Value": "${bizdate}","ParameterName": "bizdate_param"}]', + 'example' => 'Prod', + 'title' => '', ], ], - [ - 'name' => 'IgnoreParentSkipRunningProperty', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'This parameter corresponds to the Skip The Dry-Run Property Of The Ancestor Node option in Properties > Dependencies > Cross-cycle Dependency (Original Previous-cycle Dependency) when Instances of Current Node or Level-1 Child Node is selected for data development nodes in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX', 'title' => ''], + 'Task' => [ + 'description' => 'The details of the task.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the task.', 'type' => 'string', 'example' => 'SQL node', 'title' => ''], + 'Description' => ['description' => 'The description of the task.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'WorkflowId' => ['description' => 'The workflow ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'InstanceMode' => ['description' => 'The instance generation mode. Valid values:'."\n" + ."\n" + .'- T+1'."\n" + ."\n" + .'- Immediately', 'type' => 'string', 'example' => 'T+1', 'title' => ''], + 'Type' => ['description' => 'The type of the task.', 'type' => 'string', 'title' => '', 'example' => 'ODPS_SQL'], + 'BaselineId' => ['description' => 'The baseline ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1234'], + 'Priority' => ['description' => 'The priority of the task. Valid values: 1 to 8. A larger value indicates a higher priority. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'Timeout' => ['description' => 'The timeout period of task running. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '3600'], + 'RerunMode' => [ + 'description' => 'The rerun mode. Valid values:'."\n" + ."\n" + .'- AllDenied: The task cannot be rerun regardless of whether the task is successfully run or fails to be run.'."\n" + ."\n" + .'- FailureAllowed: The task can be rerun only after it fails to be run.'."\n" + ."\n" + .'- AllAllowed: The task can be rerun regardless of whether the task is successfully run or fails to be run.', + 'enumValueTitles' => [], + 'type' => 'string', + 'title' => '', + 'example' => 'AllAllowed', + ], + 'RerunTimes' => ['description' => 'The number of times that the task is rerun. This parameter takes effect only if the RerunMode parameter is set to AllAllowed or FailureAllowed.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '3'], + 'RerunInterval' => ['description' => 'The rerun interval. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '60'], + 'Script' => [ + 'title' => '', + 'description' => 'The script information.', + 'type' => 'object', + 'properties' => [ + 'Content' => ['description' => 'The script content.', 'type' => 'string', 'example' => 'echo "helloWorld"', 'title' => ''], + 'Parameters' => ['description' => 'The script parameters.', 'type' => 'string', 'example' => 'para1=$bizdate', 'title' => ''], + ], + 'example' => '', + ], + 'Trigger' => [ + 'title' => '', + 'description' => 'The method to trigger task scheduling.', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The trigger type. Valid values:'."\n" + ."\n" + .'- Scheduler: periodic scheduling'."\n" + ."\n" + .'- Manual: manual scheduling', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'Scheduler', + 'title' => '', + ], + 'Recurrence' => [ + 'description' => 'The running mode of the task after it is triggered. This parameter takes effect only if the Type parameter is set to Scheduler. Valid values:'."\n" + ."\n" + .'- Pause'."\n" + ."\n" + .'- Skip'."\n" + ."\n" + .'- Normal', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'Normal', + 'title' => '', + ], + 'Cron' => ['description' => 'The CRON expression of the task. This parameter takes effect only if the Type parameter is set to Scheduler.', 'type' => 'string', 'example' => '00 00 00 * * ?', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the time range during which the task is periodically scheduled. This parameter takes effect only if the Type parameter is set to Scheduler.', 'type' => 'string', 'example' => '1970-01-01 00:00:00', 'title' => ''], + 'EndTime' => ['description' => 'The end time of the time range during which the task is periodically scheduled. This parameter takes effect only if the Type parameter is set to Scheduler.', 'type' => 'string', 'example' => '9999-01-01 00:00:00', 'title' => ''], + ], + 'example' => '', + ], + 'RuntimeResource' => [ + 'title' => '', + 'description' => 'The configurations of the runtime environment, such as the resource group information.', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupId' => ['description' => 'The ID of the resource group for scheduling configured for task running.', 'type' => 'string', 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', 'title' => ''], + 'Image' => ['description' => 'The ID of the image configured for task running.', 'type' => 'string', 'example' => 'i-xxxxxx'."\n", 'title' => ''], + 'Cu' => ['description' => 'The default number of compute units (CUs) configured for task running.', 'type' => 'string', 'example' => '0.25', 'title' => ''], + ], + 'example' => '', + ], + 'DataSource' => [ + 'title' => '', + 'description' => 'The information about the associated data source.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the data source.', 'type' => 'string', 'example' => 'mysql_test', 'title' => ''], + ], + 'example' => '', + ], + 'Inputs' => [ + 'title' => '', + 'description' => 'The input information.', + 'type' => 'object', + 'properties' => [ + 'Variables' => [ + 'description' => 'The variables.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the variable.', 'type' => 'string', 'example' => 'key1', 'title' => ''], + 'Type' => [ + 'description' => 'The type. Valid values:'."\n" + ."\n" + .'- Constant: constant'."\n" + ."\n" + .'- PassThrough: node output'."\n" + ."\n" + .'- System: variable'."\n" + ."\n" + .'- NodeOutput: script output', + 'enumValueTitles' => [], + 'type' => 'string', + 'title' => '', + 'example' => 'Constant'."\n", + ], + 'Value' => ['description' => 'The value of the variable.', 'type' => 'string', 'example' => 'Value1'."\n", 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'example' => '', + ], + 'Outputs' => [ + 'title' => '', + 'description' => 'The output information.', + 'type' => 'object', + 'properties' => [ + 'TaskOutputs' => [ + 'description' => 'The task outputs.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Output' => ['description' => 'The identifier of the output.', 'type' => 'string', 'title' => '', 'example' => 'pre.odps_sql_demo_0'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Variables' => [ + 'description' => 'The variables.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the variable.', 'type' => 'string', 'example' => 'key1', 'title' => ''], + 'Type' => [ + 'description' => 'The type. Valid values:'."\n" + ."\n" + .'- Constant: constant'."\n" + ."\n" + .'- PassThrough: node output'."\n" + ."\n" + .'- System: variable'."\n" + ."\n" + .'- NodeOutput: script output', + 'enumValueTitles' => [], + 'type' => 'string', + 'title' => '', + 'example' => 'Constant'."\n", + ], + 'Value' => ['description' => 'The value of the variable.', 'type' => 'string', 'example' => 'value1', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'example' => '', + ], + 'Dependencies' => [ + 'title' => '', + 'description' => 'The dependency information.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The dependency type. Valid values:'."\n" + ."\n" + .'- CrossCycleDependsOnChildren: cross-cycle dependency on level-1 descendant nodes'."\n" + ."\n" + .'- CrossCycleDependsOnSelf: cross-cycle dependency on the current node'."\n" + ."\n" + .'- CrossCycleDependsOnOtherNode: cross-cycle dependency on other nodes'."\n" + ."\n" + .'- Normal: same-cycle scheduling dependency', + 'enumValueTitles' => [], + 'type' => 'string', + 'title' => '', + 'example' => 'Normal', + ], + 'UpstreamOutput' => ['description' => 'The identifier of the output of the ancestor task. This parameter is returned only if `same-cycle scheduling dependencies` and the node input are configured.', 'type' => 'string', 'title' => '', 'example' => 'pre.odps_sql_demo_0'], + 'UpstreamTaskId' => ['description' => 'The ancestor task ID. This parameter is returned only if `cross-cycle scheduling dependencies` or `same-cycle scheduling dependencies` and the node input are not configured.', 'type' => 'string', 'example' => '1234', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'SubTasks' => [ + 'title' => '', + 'description' => 'The configurations of the subtasks, such as a do-while node.', + 'type' => 'object', + 'properties' => [ + 'SubTasks' => [ + 'description' => 'The subtasks.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the task.', 'type' => 'string', 'example' => 'SQL node'."\n", 'title' => ''], + 'Description' => ['description' => 'The description of the task.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'WorkflowId' => ['description' => 'The ID of the workflow to which the task belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'Type' => ['description' => 'The type of the task.', 'type' => 'string', 'title' => '', 'example' => 'ODPS_SQL'."\n"], + 'BaselineId' => ['description' => 'The baseline ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => 'The baseline ID.'."\n" + ."\n"], + 'Priority' => ['description' => 'The priority of the task. Valid values: 1 to 8. A larger value indicates a higher priority. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'Timeout' => ['description' => 'The timeout period of task running. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '3600'], + 'RerunMode' => [ + 'description' => 'The rerun mode. Valid values:'."\n" + ."\n" + .'- AllDenied: The task cannot be rerun regardless of whether the task is successfully run or fails to be run.'."\n" + ."\n" + .'- FailureAllowed: The task can be rerun only after it fails to be run.'."\n" + ."\n" + .'- AllAllowed: The task can be rerun regardless of whether the task is successfully run or fails to be run.', + 'enumValueTitles' => [], + 'type' => 'string', + 'title' => '', + 'example' => 'AllAllowed', + ], + 'RerunTimes' => ['description' => 'The number of times that the task is rerun. This parameter takes effect only if the RerunMode parameter is set to AllAllowed or FailureAllowed.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '3'], + 'RerunInterval' => ['description' => 'The rerun interval. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '180'], + 'Trigger' => [ + 'title' => '', + 'description' => 'The method to trigger task scheduling.', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The trigger type. Valid values:'."\n" + ."\n" + .'- Scheduler: periodic scheduling'."\n" + ."\n" + .'- Manual: manual scheduling', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'Scheduler', + 'title' => '', + ], + 'Recurrence' => [ + 'description' => 'The running mode of the task after it is triggered. This parameter takes effect only if the Type parameter is set to Scheduler. Valid values:'."\n" + ."\n" + .'- Pause'."\n" + ."\n" + .'- Skip'."\n" + ."\n" + .'- Normal', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'Normal'."\n", + 'title' => '', + ], + 'Cron' => ['description' => 'The CRON expression of the task. This parameter takes effect only if the Type parameter is set to Scheduler.', 'type' => 'string', 'example' => '00 00 00 * * ?'."\n", 'title' => ''], + 'StartTime' => ['description' => 'The start time of the time range during which the task is periodically scheduled. This parameter takes effect only if the Type parameter is set to Scheduler.', 'type' => 'string', 'example' => '1970-01-01 00:00:00'."\n", 'title' => ''], + 'EndTime' => ['description' => 'The end time of the time range during which the task is periodically scheduled. This parameter takes effect only if the Type parameter is set to Scheduler.', 'type' => 'string', 'example' => '9999-01-01 00:00:00'."\n", 'title' => ''], + ], + 'example' => '', + ], + 'RuntimeResource' => [ + 'title' => '', + 'description' => 'The runtime environment configuration of the task, such as the resource group.', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupId' => ['description' => 'The ID of the resource group for scheduling configured for task running.', 'type' => 'string', 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', 'title' => ''], + 'Image' => ['description' => 'The ID of the image configured for task running.', 'type' => 'string', 'example' => 'i-xxxxxx', 'title' => ''], + 'Cu' => ['description' => 'The default number of CUs configured for task running.', 'type' => 'string', 'example' => '0.25', 'title' => ''], + ], + 'example' => '', + ], + 'DataSource' => [ + 'title' => '', + 'description' => 'The information about the associated data source.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the data source.', 'type' => 'string', 'example' => 'mysql_test'."\n", 'title' => ''], + ], + 'example' => '', + ], + 'Id' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'ProjectId' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'ProjectEnv' => [ + 'description' => 'The environment of the workspace. This parameter is deprecated and replaced by the EnvType parameter. Valid values:'."\n" + ."\n" + .'- Prod: production environment'."\n" + ."\n" + .'- Dev: development environment', + 'enumValueTitles' => [], + 'type' => 'string', + 'deprecated' => true, + 'example' => 'Prod', + 'title' => '', + ], + 'EnvType' => ['description' => 'The environment of the workspace. Valid values:'."\n" + ."\n" + .'- Prod: production environment'."\n" + ."\n" + .'- Dev: development environment', 'type' => 'string', 'example' => 'Prod', 'title' => ''], + 'Owner' => ['description' => 'The account ID of the task owner.', 'type' => 'string', 'example' => '1000'."\n", 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'."\n", 'title' => ''], + 'ModifyTime' => ['description' => 'The modification time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'."\n", 'title' => ''], + 'CreateUser' => ['description' => 'The account ID of the creator.', 'type' => 'string', 'example' => '1000'."\n", 'title' => ''], + 'ModifyUser' => ['description' => 'The account ID of the modifier.', 'type' => 'string', 'example' => '1000'."\n", 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Type' => [ + 'description' => 'The type of the subtask. Valid values:'."\n" + ."\n" + .'- DoWhile: do-while node'."\n" + ."\n" + .'- Combined: node group'."\n" + ."\n" + .'- ForEach: for-each node', + 'enumValueTitles' => [], + 'type' => 'string', + 'title' => '', + 'example' => 'Combined', + ], + ], + 'example' => '', + ], + 'Tags' => [ + 'title' => '', + 'description' => 'The tags.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'key1', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'value1', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'Id' => ['description' => 'The instance ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'ProjectId' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'ProjectEnv' => [ + 'description' => 'The environment of the workspace. This parameter is deprecated and replaced by the EnvType parameter. Valid values:'."\n" + ."\n" + .'- Prod: production environment'."\n" + ."\n" + .'- Dev: development environment', + 'enumValueTitles' => [], + 'type' => 'string', + 'deprecated' => true, + 'example' => 'Prod', + 'title' => '', + ], + 'EnvType' => ['description' => 'The environment of the workspace. Valid values:'."\n" + ."\n" + .'- Prod: production environment'."\n" + ."\n" + .'- Dev: development environment', 'type' => 'string', 'example' => 'Prod', 'title' => ''], + 'Owner' => ['description' => 'The account ID of the task owner.', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'."\n", 'title' => ''], + 'ModifyTime' => ['description' => 'The modification time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'."\n", 'title' => ''], + 'CreateUser' => ['description' => 'The account ID of the creator.', 'type' => 'string', 'example' => '1000'."\n", 'title' => ''], + 'ModifyUser' => ['description' => 'The account ID of the modifier.', 'type' => 'string', 'example' => '1000', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"Task\\": {\\n \\"Name\\": \\"SQL node\\",\\n \\"Description\\": \\"test\\",\\n \\"WorkflowId\\": 1234,\\n \\"InstanceMode\\": \\"T+1\\",\\n \\"Type\\": \\"ODPS_SQL\\",\\n \\"BaselineId\\": 1234,\\n \\"Priority\\": 1,\\n \\"Timeout\\": 3600,\\n \\"RerunMode\\": \\"AllAllowed\\",\\n \\"RerunTimes\\": 3,\\n \\"RerunInterval\\": 60,\\n \\"Script\\": {\\n \\"Content\\": \\"echo \\\\\\"helloWorld\\\\\\"\\",\\n \\"Parameters\\": \\"para1=$bizdate\\"\\n },\\n \\"Trigger\\": {\\n \\"Type\\": \\"Scheduler\\",\\n \\"Recurrence\\": \\"Normal\\",\\n \\"Cron\\": \\"00 00 00 * * ?\\",\\n \\"StartTime\\": \\"1970-01-01 00:00:00\\",\\n \\"EndTime\\": \\"9999-01-01 00:00:00\\"\\n },\\n \\"RuntimeResource\\": {\\n \\"ResourceGroupId\\": \\"S_res_group_524258031846018_1684XXXXXXXXX\\",\\n \\"Image\\": \\"i-xxxxxx\\\\n\\",\\n \\"Cu\\": \\"0.25\\"\\n },\\n \\"DataSource\\": {\\n \\"Name\\": \\"mysql_test\\"\\n },\\n \\"Inputs\\": {\\n \\"Variables\\": [\\n {\\n \\"Name\\": \\"key1\\",\\n \\"Type\\": \\"Constant\\\\n\\",\\n \\"Value\\": \\"Value1\\\\n\\"\\n }\\n ]\\n },\\n \\"Outputs\\": {\\n \\"TaskOutputs\\": [\\n {\\n \\"Output\\": \\"pre.odps_sql_demo_0\\"\\n }\\n ],\\n \\"Variables\\": [\\n {\\n \\"Name\\": \\"key1\\",\\n \\"Type\\": \\"Constant\\\\n\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ]\\n },\\n \\"Dependencies\\": [\\n {\\n \\"Type\\": \\"Normal\\",\\n \\"UpstreamOutput\\": \\"pre.odps_sql_demo_0\\",\\n \\"UpstreamTaskId\\": \\"1234\\"\\n }\\n ],\\n \\"SubTasks\\": {\\n \\"SubTasks\\": [\\n {\\n \\"Name\\": \\"SQL node\\\\n\\",\\n \\"Description\\": \\"test\\",\\n \\"WorkflowId\\": 1234,\\n \\"Type\\": \\"ODPS_SQL\\\\n\\",\\n \\"BaselineId\\": 0,\\n \\"Priority\\": 1,\\n \\"Timeout\\": 3600,\\n \\"RerunMode\\": \\"AllAllowed\\",\\n \\"RerunTimes\\": 3,\\n \\"RerunInterval\\": 180,\\n \\"Trigger\\": {\\n \\"Type\\": \\"Scheduler\\",\\n \\"Recurrence\\": \\"Normal\\\\n\\",\\n \\"Cron\\": \\"00 00 00 * * ?\\\\n\\",\\n \\"StartTime\\": \\"1970-01-01 00:00:00\\\\n\\",\\n \\"EndTime\\": \\"9999-01-01 00:00:00\\\\n\\"\\n },\\n \\"RuntimeResource\\": {\\n \\"ResourceGroupId\\": \\"S_res_group_524258031846018_1684XXXXXXXXX\\",\\n \\"Image\\": \\"i-xxxxxx\\",\\n \\"Cu\\": \\"0.25\\"\\n },\\n \\"DataSource\\": {\\n \\"Name\\": \\"mysql_test\\\\n\\"\\n },\\n \\"Id\\": 1234,\\n \\"ProjectId\\": 100,\\n \\"ProjectEnv\\": \\"Prod\\",\\n \\"EnvType\\": \\"Prod\\",\\n \\"Owner\\": \\"1000\\\\n\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"1000\\\\n\\",\\n \\"ModifyUser\\": \\"1000\\\\n\\"\\n }\\n ],\\n \\"Type\\": \\"Combined\\"\\n },\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"Id\\": 1234,\\n \\"ProjectId\\": 100,\\n \\"ProjectEnv\\": \\"Prod\\",\\n \\"EnvType\\": \\"Prod\\",\\n \\"Owner\\": \\"1000\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"1000\\\\n\\",\\n \\"ModifyUser\\": \\"1000\\"\\n }\\n}","type":"json"}]', + 'title' => 'GetTask', + 'summary' => 'Queries the information about a task.', + 'description' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-01-21T03:12:29.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-01-07T07:52:32.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-11-20T07:55:32.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'ApplyScheduleImmediately', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether to apply the scheduling configuration immediately after the file is published.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'GetTaskInstance' => [ + 'summary' => 'Queries the information about an instance.', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'Timeout', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The timeout settings for scheduling configuration.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '240659', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB', 'FEATUREdideD0YY7B', 'FEATUREdideVFMENL'], + ], + 'parameters' => [ [ - 'name' => 'ImageId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The custom image ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'm-uf6d7npxk1hhek8ng0cb', - ], + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response.'."\n", + 'description' => 'The returned data.', '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. Use this ID to troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFGH-IJKLMNOPQ', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Success' => [ - 'description' => 'Indicates whether the call succeeded. Valid values:'."\n" - ."\n" - .'* true: The call succeeded.'."\n" - .'* false: The call failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77****', 'title' => ''], + 'TaskInstance' => [ + 'description' => 'The details of the task instance.', + 'type' => 'object', + 'properties' => [ + 'TaskId' => ['description' => 'The ID of the task for which the instance is generated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'TaskType' => ['description' => 'The type of the task for which the instance is generated.', 'type' => 'string', 'title' => '', 'example' => 'ODPS_SQL'], + 'TaskName' => ['description' => 'The name of the task for which the instance is generated.', 'type' => 'string', 'example' => 'SQL node'."\n", 'title' => ''], + 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'WorkflowId' => ['description' => 'The ID of the workflow to which the instance belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'WorkflowName' => ['description' => 'The name of the workflow to which the instance belongs.', 'type' => 'string', 'example' => 'Test workflow', 'title' => ''], + 'TriggerType' => [ + 'description' => 'The method to trigger instance scheduling. The value of the Trigger.Type parameter in the response of the GetTask operation is used. Valid values:'."\n" + ."\n" + .'- Scheduler'."\n" + ."\n" + .'- Manual', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'Scheduler', + 'title' => '', + ], + 'TriggerRecurrence' => [ + 'description' => 'The running mode of the instance after it is triggered. This parameter takes effect only if the TriggerType parameter is set to Scheduler. Valid values:'."\n" + ."\n" + .'- Pause'."\n" + ."\n" + .'- Skip'."\n" + ."\n" + .'- Normal', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'Normal', + 'title' => '', + ], + 'WorkflowInstanceId' => ['description' => 'The workflow instance ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'WorkflowInstanceType' => [ + 'description' => 'The type of the workflow instance. Valid values:'."\n" + ."\n" + .'- SmokeTest'."\n" + ."\n" + .'- SupplementData'."\n" + ."\n" + .'- Manual'."\n" + ."\n" + .'- ManualWorkflow'."\n" + ."\n" + .'- Normal'."\n" + ."\n" + .'- ManualFlow', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'Normal', + 'title' => '', + ], + 'UnifiedWorkflowInstanceId' => ['description' => 'Unified workflow instance ID. All task instances triggered under the same data timestamp share the same value for this field.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'Timeout' => ['description' => 'The timeout period of task running. Unit: seconds.'."\n" + ."\n" + .'Note: The value of this parameter is rounded up by hour.', 'type' => 'integer', 'format' => 'int32', 'example' => '3600', 'title' => ''], + 'RerunMode' => [ + 'description' => 'The rerun mode. Valid values:'."\n" + ."\n" + .'- AllDenied: The task cannot be rerun regardless of whether the task is successfully run or fails to run.'."\n" + ."\n" + .'- AllAllowed: The task can be rerun regardless of whether the task is successfully run or fails to run.'."\n" + ."\n" + .'- FailureAllowed: The task can be rerun only after it fails to run.', + 'enumValueTitles' => [], + 'type' => 'string', + 'title' => '', + 'example' => 'AllAllowed', + ], + 'RunNumber' => ['description' => 'The number of times the instance is run. By default, the value starts from 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PeriodNumber' => ['description' => 'The sequence number of the cycle. This parameter indicates the cycle of the task instance on the current day.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'BaselineId' => ['description' => 'The baseline ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'Priority' => ['description' => 'The task priority. Valid values: 1 to 8. A larger value indicates a higher priority. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Script' => [ + 'description' => 'The script information.', + 'type' => 'object', + 'properties' => [ + 'Content' => ['description' => 'The script content.', 'type' => 'string', 'example' => 'echo "helloWorld"', 'title' => ''], + 'Parameters' => ['description' => 'The script parameters.', 'type' => 'string', 'example' => 'para1=$bizdate', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'RuntimeResource' => [ + 'description' => 'The information about the resource group with which the instance is associated.', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupId' => ['description' => 'The ID of the resource group for scheduling configured for task running.', 'type' => 'string', 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', 'title' => ''], + 'Image' => ['description' => 'The ID of the image configured for task running.', 'type' => 'string', 'example' => 'i-xxxxxx', 'title' => ''], + 'Cu' => ['description' => 'The default number of CUs configured for task running.', 'type' => 'string', 'example' => '0.25', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Runtime' => [ + 'description' => 'The runtime information about the instance.', + 'type' => 'object', + 'properties' => [ + 'ProcessId' => ['description' => 'The instance run ID.', 'type' => 'string', 'example' => 'T3_123', 'title' => ''], + 'Gateway' => ['description' => 'The host for running.', 'type' => 'string', 'example' => 'cn-shanghai.1.2', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'DataSource' => [ + 'description' => 'The information about the associated data source.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the data source.', 'type' => 'string', 'example' => 'mysql_test', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Inputs' => [ + 'description' => 'The input information.', + 'type' => 'object', + 'properties' => [ + 'Variables' => [ + 'description' => 'The variables.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the variable.', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'Key1', + 'title' => '', + ], + 'Type' => [ + 'description' => 'The type. Valid values:'."\n" + ."\n" + .'- Constant: constant'."\n" + ."\n" + .'- PassThrough: node output'."\n" + ."\n" + .'- System: variable'."\n" + ."\n" + .'- NodeOutput: script output', + 'enumValueTitles' => [], + 'type' => 'string', + 'title' => '', + 'example' => 'Constant', + ], + 'Value' => ['description' => 'The value of the variable.', 'type' => 'string', 'example' => 'Value1', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'Outputs' => [ + 'description' => 'The output information.', + 'type' => 'object', + 'properties' => [ + 'TaskOutputs' => [ + 'description' => 'The task outputs.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Output' => ['description' => 'The output identifier.', 'type' => 'string', 'title' => '', 'example' => 'pre.odps_sql_demo_0'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Variables' => [ + 'description' => 'The variables.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the variable.', 'type' => 'string', 'example' => 'key1', 'title' => ''], + 'Type' => [ + 'description' => 'The type. Valid values:'."\n" + ."\n" + .'- Constant: constant'."\n" + ."\n" + .'- PassThrough: node output'."\n" + ."\n" + .'- System: variable'."\n" + ."\n" + .'- NodeOutput: script output', + 'enumValueTitles' => [], + 'type' => 'string', + 'title' => '', + 'example' => 'Constant', + ], + 'Value' => ['description' => 'The value of the variable.', 'type' => 'string', 'example' => 'value1', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'Tags' => [ + 'title' => '', + 'description' => 'The tags of the task.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'key1', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'value1', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'Status' => [ + 'description' => 'The status of the instance. Valid values:'."\n" + ."\n" + .'- NotRun: The instance is not run.'."\n" + ."\n" + .'- Running: The instance is running.'."\n" + ."\n" + .'- WaitTime: The instance is waiting for the scheduling time to arrive.'."\n" + ."\n" + .'- CheckingCondition: Branch conditions are being checked for the instance.'."\n" + ."\n" + .'- WaitResource: The instance is waiting for resources.'."\n" + ."\n" + .'- Failure: The instance fails to be run.'."\n" + ."\n" + .'- Success: The instance is successfully run.'."\n" + ."\n" + .'- Checking: Data quality is being checked for the instance.', + 'enumValueTitles' => [], + 'type' => 'string', + 'title' => '', + 'example' => 'Success', + ], + 'TriggerTime' => ['description' => 'The scheduling time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + 'Bizdate' => ['description' => 'The data timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + 'StartedTime' => ['description' => 'The time when the instance started to run.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + 'FinishedTime' => ['description' => 'The time when the instance finished running.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + 'Id' => ['description' => 'The instance ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'ProjectId' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'ProjectEnv' => [ + 'description' => 'The environment of the workspace. Valid values:'."\n" + ."\n" + .'- Prod: production environment'."\n" + ."\n" + .'- Dev: development environment', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'Prod', + 'title' => '', + ], + 'Owner' => ['description' => 'The account ID of the task owner.', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + 'ModifyTime' => ['description' => 'The modification time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + 'CreateUser' => ['description' => 'The account ID of the creator.', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'ModifyUser' => ['description' => 'The account ID of the modifier.', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'WaitingResourceTime' => ['description' => 'The timestamp for when it started waiting for resources.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + 'WaitingTriggerTime' => ['description' => 'The timestamp for when it started waiting for the scheduled time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + ], + '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.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77****\\",\\n \\"TaskInstance\\": {\\n \\"TaskId\\": 1234,\\n \\"TaskType\\": \\"ODPS_SQL\\",\\n \\"TaskName\\": \\"SQL node\\\\n\\",\\n \\"Description\\": \\"test\\",\\n \\"WorkflowId\\": 1234,\\n \\"WorkflowName\\": \\"Test workflow\\",\\n \\"TriggerType\\": \\"Scheduler\\",\\n \\"TriggerRecurrence\\": \\"Normal\\",\\n \\"WorkflowInstanceId\\": 1234,\\n \\"WorkflowInstanceType\\": \\"Normal\\",\\n \\"UnifiedWorkflowInstanceId\\": 1234,\\n \\"Timeout\\": 3600,\\n \\"RerunMode\\": \\"AllAllowed\\",\\n \\"RunNumber\\": 1,\\n \\"PeriodNumber\\": 1,\\n \\"BaselineId\\": 1234,\\n \\"Priority\\": 1,\\n \\"Script\\": {\\n \\"Content\\": \\"echo \\\\\\"helloWorld\\\\\\"\\",\\n \\"Parameters\\": \\"para1=$bizdate\\"\\n },\\n \\"RuntimeResource\\": {\\n \\"ResourceGroupId\\": \\"S_res_group_524258031846018_1684XXXXXXXXX\\",\\n \\"Image\\": \\"i-xxxxxx\\",\\n \\"Cu\\": \\"0.25\\"\\n },\\n \\"Runtime\\": {\\n \\"ProcessId\\": \\"T3_123\\",\\n \\"Gateway\\": \\"cn-shanghai.1.2\\"\\n },\\n \\"DataSource\\": {\\n \\"Name\\": \\"mysql_test\\"\\n },\\n \\"Inputs\\": {\\n \\"Variables\\": [\\n {\\n \\"Name\\": \\"Key1\\",\\n \\"Type\\": \\"Constant\\",\\n \\"Value\\": \\"Value1\\"\\n }\\n ]\\n },\\n \\"Outputs\\": {\\n \\"TaskOutputs\\": [\\n {\\n \\"Output\\": \\"pre.odps_sql_demo_0\\"\\n }\\n ],\\n \\"Variables\\": [\\n {\\n \\"Name\\": \\"key1\\",\\n \\"Type\\": \\"Constant\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ]\\n },\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"Status\\": \\"Success\\",\\n \\"TriggerTime\\": 1710239005403,\\n \\"Bizdate\\": 1710239005403,\\n \\"StartedTime\\": 1710239005403,\\n \\"FinishedTime\\": 1710239005403,\\n \\"Id\\": 1234,\\n \\"ProjectId\\": 100,\\n \\"ProjectEnv\\": \\"Prod\\",\\n \\"Owner\\": \\"1000\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"1000\\",\\n \\"ModifyUser\\": \\"1000\\",\\n \\"WaitingResourceTime\\": 1710239005403,\\n \\"WaitingTriggerTime\\": 1710239005403\\n }\\n}","type":"json"}]', + 'title' => 'GetTaskInstance', + 'description' => 'You must purchase DataWorks Basic Edition or a higher edition to use this feature.', + 'changeSet' => [ + ['createdAt' => '2025-01-21T03:12:29.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-11-20T07:55:32.000Z', 'description' => 'Response parameters changed'], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', - 'title' => 'UpdateFile', - 'summary' => 'Updates a file.', + 'ramActions' => [], ], - 'UpdateUdfFile' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetTaskInstanceLog' => [ + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '269316', - 'abilityTreeNodes' => [ - 'FEATUREdide8FM783', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '240663', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB'], ], 'parameters' => [ [ - 'name' => 'FileFolderPath', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The path to the folder containing the function file.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'Business_process/First_Business_Process/function/string_processing_function', - ], - ], - [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The DataWorks workspace ID. To find this, click the wrench icon in the upper-right corner and navigate to the workspace management page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '10000', - ], - ], - [ - 'name' => 'FunctionType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The function category, corresponding to the function type field in the Create Function form. Valid values: MATH (mathematical functions), AGGREGATE (aggregate functions), STRING (string processing functions), DATE (date processing functions), ANALYTIC (window functions), and OTHER (other functions).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'STRING', - 'enum' => [ - 'MATH', - 'AGGREGATE', - 'STRING', - 'DATE', - 'ANALYTIC', - 'OTHER', - ], - ], - ], - [ - 'name' => 'ClassName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The class name where the function is defined, corresponding to the class name field in the Create Function form.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'com.alibaba.DataWorks.api.udf.StringConcat', - ], - ], - [ - 'name' => 'Resources', - 'in' => 'formData', - 'schema' => [ - 'description' => 'A comma-separated list of resource names referenced by the function, corresponding to the resource list field in the Create Function form.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'string-concat-1.0.0.jar,commons-lang-2.6.jar', - ], - ], - [ - 'name' => 'UdfDescription', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The function purpose description, corresponding to the description field in the Create Function form.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'Concatenate several strings to generate a new string', - ], - ], - [ - 'name' => 'CmdDescription', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The command format for invoking the function, corresponding to the command format field in the Create Function form.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'StringConcat(String... substrs)', - ], - ], - [ - 'name' => 'ParameterDescription', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The function parameter description, corresponding to the parameter description field in the Create Function form.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* ALL_ALLOWD'."\n" - .'* FAILURE_ALLOWED'."\n" - .'* ALL_DENIED'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'List of strings to be connected', - 'default' => 'ALL_ALLOWED', - 'enum' => [ - 'ALL_ALLOWD', - 'FAILURE_ALLOWED', - 'ALL_DENIED', - ], - ], - ], - [ - 'name' => 'ReturnValue', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The return value description, corresponding to the return value field in the Create Function form.'."\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' => 'An example demonstrating how to call the function, corresponding to the example field in the Create Function form.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'StringConcat(\'a\', \'b\', \'c\')', - ], - ], - [ - 'name' => 'ProjectIdentifier', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The unique identifier of the DataWorks workspace, which is the identifier at the top of the Data Studio page where you switch workspaces.'."\n" - ."\n" - .'Either this parameter or ProjectId must be specified to identify the target DataWorks workspace for this API call.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dw_project', - ], + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234', 'title' => ''], ], [ - 'name' => 'FileId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The file ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '10000001', - ], + 'name' => 'RunNumber', + 'in' => 'query', + 'schema' => ['description' => 'The sequence number of an instance run. Minimum value: 1. By default, the latest run is used.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', '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 unique ID for this request. Use this ID for troubleshooting if an error occurs.'."\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 succeeded. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n", 'title' => ''], + 'TaskInstanceLog' => ['description' => 'The run log of the instance.', 'type' => 'string', 'example' => 'This is running log', 'title' => ''], ], + 'description' => '', + '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.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\\\n\\",\\n \\"TaskInstanceLog\\": \\"This is running log\\"\\n}","type":"json"}]', + 'title' => 'GetTaskInstanceLog', + 'summary' => 'Queries the run log generated during a specific run of an instance.', + 'description' => 'This API operation is available for all DataWorks editions.', + 'changeSet' => [], + '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 \\"ErrorMessage\\": \\"The connection does not exist.\\",\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"ErrorCode\\": \\"Invalid.Tenant.ConnectionNotExists\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'UpdateUdfFile', - 'summary' => 'Updates the file information about a function.', ], - 'GetFile' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetWorkflow' => [ + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '267409', - 'abilityTreeNodes' => [ - 'FEATUREdide8FM783', - ], + 'abilityTreeCode' => '250954', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB', 'FEATUREdideD0YY7B', 'FEATUREdideVFMENL'], ], '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 query the 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, - 'docRequired' => false, - 'example' => '10000', - ], + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The workflow ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234', 'title' => ''], ], [ - 'name' => 'ProjectIdentifier', - 'in' => 'formData', + 'name' => 'EnvType', + 'in' => 'query', '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 query the name.'."\n" + 'description' => 'The environment of the workspace. Valid values:'."\n" ."\n" - .'You must configure either this parameter or the ProjectId parameter to determine the DataWorks workspace to which the operation is applied.'."\n", + .'- Prod: production environment'."\n" + ."\n" + .'- Dev: development environment', + 'enumValueTitles' => [], 'type' => 'string', + 'default' => 'Prod', + 'enum' => ['Prod', 'Dev'], 'required' => false, - 'example' => 'dw_project', - ], - ], - [ - 'name' => 'FileId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The file ID. You can call the [ListFiles](~~173942~~) operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '100000001', - ], - ], - [ - 'name' => 'NodeId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the node that is scheduled. You can call the [ListFiles](~~173942~~) operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '200000001', + 'example' => 'Prod', + 'title' => '', ], ], ], @@ -20842,506 +24659,209 @@ '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' => '0000-ABCD-EFG****', - ], - '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 details of the file.'."\n", + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX', 'title' => ''], + 'Workflow' => [ + 'description' => 'The information about the workflow.', 'type' => 'object', 'properties' => [ - 'File' => [ - 'description' => 'The basic information about the file.'."\n", + 'Id' => ['description' => 'The workflow ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'ProjectId' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'EnvType' => ['description' => 'The environment of the workspace. Valid values:'."\n" + ."\n" + .'- Prod: production environment'."\n" + ."\n" + .'- Dev: development environment', 'type' => 'string', 'example' => 'Prod', 'title' => ''], + 'Owner' => ['description' => 'The account ID of the workflow owner.', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'Name' => ['description' => 'The name of the workflow.', 'type' => 'string', 'example' => 'Workflow', 'title' => ''], + 'Description' => ['description' => 'The description of the workflow.', 'type' => 'string', 'example' => 'Test workflow', 'title' => ''], + 'Trigger' => [ + 'description' => 'The trigger method.', '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'."\n" - .'* false'."\n" - ."\n" - .'This parameter corresponds to the Automatic Parsing From Code Before Node Committing parameter that is displayed after you select Same Cycle 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', - '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' => '424732****'."\n", - ], - 'FileName' => [ - 'description' => 'The name of the file.'."\n", - 'type' => 'string', - 'example' => 'ods_user_info_d', - ], - 'ConnectionName' => [ - 'description' => 'The name of the data source that is used to run the node that corresponds to the file.'."\n", - 'type' => 'string', - 'example' => 'odps_source', - ], - '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 node in DataStudio.'."\n" - .'* ADHOCQUERY: The file is used for an ad hoc query.'."\n" - .'* COMPONENT: The file is used for a script template.'."\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****'."\n", - ], - 'IsMaxCompute' => [ - 'description' => 'Indicates whether the resource file needs to be uploaded to MaxCompute. 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' => '{\\"priority\\":\\"1\\",\\"ENABLE_SPARKSQL_JDBC\\":false,\\"FLOW_SKIP_SQL_ANALYZE\\":false,\\"queue\\":\\"default\\"}', - ], - 'FileId' => [ - 'description' => 'The file ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100000001', - ], + 'Type' => ['description' => 'The trigger type. Valid values:'."\n" + ."\n" + .'- Scheduler: scheduling cycle-based trigger'."\n" + ."\n" + .'- Manual: manual trigger', 'type' => 'string', 'title' => '', 'example' => 'Scheduler'], + 'Recurrence' => ['description' => 'The running mode of the workflow after it is triggered. This parameter takes effect only if the Type parameter is set to Scheduler. Valid values:'."\n" + ."\n" + .'- Pause'."\n" + ."\n" + .'- Skip'."\n" + ."\n" + .'- Normal', 'type' => 'string', 'example' => 'Normal', 'title' => ''], + 'Cron' => ['description' => 'The CRON expression. This parameter takes effect only if the Type parameter is set to Scheduler.', 'type' => 'string', 'example' => '00 00 00 * * ?', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the time range during which the workflow is periodically scheduled. This parameter takes effect only if the Type parameter is set to Scheduler.', 'type' => 'string', 'example' => '1970-01-01 00:00:00', 'title' => ''], + 'EndTime' => ['description' => 'The end time of the time range during which the workflow is periodically scheduled. This parameter takes effect only if the Type parameter is set to Scheduler.', 'type' => 'string', 'example' => '1970-01-01 00:00:00', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - '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 on the DataStudio page 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" + 'Dependencies' => [ + 'description' => 'The dependency information.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The scheduling dependency type. Valid values:'."\n" ."\n" - .'* true'."\n" - .'* false'."\n" + .'- CrossCycleDependsOnChildren: cross-cycle dependency on the level-1 descendant nodes of a node'."\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', - 'example' => 'false', - ], - 'ParaValue' => [ - 'description' => 'The scheduling parameters of the node.'."\n" + .'- CrossCycleDependsOnSelf: cross-cycle dependency on the current node'."\n" ."\n" - .'This parameter corresponds to the Scheduling Parameter section of the Properties tab on the DataStudio page in the [DataWorks console](https://workbench.data.aliyun.com/console). For more information about the configurations of scheduling parameters, see [Configure scheduling parameters](~~137548~~).'."\n", - 'type' => 'string', - 'example' => 'a=x b=y', - ], - 'StartEffectDate' => [ - 'description' => 'The beginning of the time range for 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" + .'- CrossCycleDependsOnOtherNode: cross-cycle dependency on other nodes'."\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', - 'example' => '936923400000', + .'- Normal: same-cycle scheduling dependency', 'type' => 'string', 'title' => '', 'example' => 'Normal'], + 'UpstreamOutput' => ['description' => 'The identifier of the output of the ancestor task. This parameter is returned only if `same-cycle scheduling dependencies` and the node input are configured.', 'type' => 'string', 'title' => '', 'example' => 'pre.odps_sql_demo_0'], + 'UpstreamTaskId' => ['description' => 'The ancestor task ID. This parameter is returned only if `cross-cycle scheduling dependencies` or `same-cycle scheduling dependencies` and the node input are not configured.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1234'], ], - 'EndEffectDate' => [ - 'description' => 'The end of the time range for 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" + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Parameters' => ['description' => 'The parameters.', 'type' => 'string', 'example' => 'para1=$bizdate para2=$[yyyymmdd] ', 'title' => ''], + 'Tasks' => [ + 'description' => 'The tasks.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'ProjectId' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'EnvType' => ['description' => 'The environment of the workspace. Valid values:'."\n" ."\n" - .'Configuring this parameter is equivalent to specifying an end 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', - '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" + .'- Prod'."\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', - '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" + .'- Dev', 'type' => 'string', 'example' => 'Prod', 'title' => ''], + 'Owner' => ['description' => 'The account ID of the task owner.', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'Name' => ['description' => 'The name of the task.', 'type' => 'string', 'example' => 'SQL node', 'title' => ''], + 'Description' => ['description' => 'The description of the task.', 'type' => 'string', 'example' => 'Test', 'title' => ''], + 'WorkflowId' => ['description' => 'The ID of the workflow to which the task belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'Type' => ['description' => 'The type of the task.', 'type' => 'string', 'title' => '', 'example' => 'ODPS_SQL'], + 'BaselineId' => ['description' => 'The baseline ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1234'], + 'Priority' => ['description' => 'The priority of the task. Valid values: 1 to 8. A larger value indicates a higher priority. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'Timeout' => ['description' => 'The timeout period of task running. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '3600'], + 'RerunMode' => ['description' => 'The rerun mode. Valid values:'."\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 on the DataStudio page 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', - ], - 'DependentType' => [ - 'description' => 'The type of the cross-cycle scheduling dependency of the node. Valid values:'."\n" + .'- AllDenied: The task cannot be rerun regardless of whether the task is successfully run or fails to run.'."\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" + .'- FailureAllowed: The task can be rerun only after it fails to run.'."\n" ."\n" - .'This parameter corresponds to the Rerun interval parameter that is displayed after the Auto Rerun upon Failure check box is selected in the Schedule section of the Properties tab on the DataStudio page in the [DataWorks console](https://workbench.data.aliyun.com/console). 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 information about the parent files on which the current file depends.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The output information about the parent file on which the current file depends.'."\n", + .'- AllAllowed: The task can be rerun regardless of whether the task is successfully run or fails to run.', 'type' => 'string', 'title' => '', 'example' => 'AllAllowed'], + 'RerunTimes' => ['description' => 'The number of times that the task is rerun. This parameter takes effect only if the RerunMode parameter is set to AllAllowed or FailureAllowed.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '3'], + 'RerunInterval' => ['description' => 'The rerun interval. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '60'], + 'RuntimeResource' => [ + 'title' => '', + 'description' => 'The configurations of the runtime environment, such as the resource group information.', '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 on the DataStudio page 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', - ], + 'ResourceGroupId' => ['description' => 'The ID of the resource group for scheduling configured for task running.', 'type' => 'string', 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', 'title' => ''], + 'Image' => ['description' => 'The ID of the image configured for task running.', 'type' => 'string', 'example' => 'i-xxxxxx', 'title' => ''], + 'Cu' => ['description' => 'The default number of compute units (CUs) configured for task running.', 'type' => 'string', 'example' => '0.25', 'title' => ''], ], + 'example' => '', ], - ], - 'OutputList' => [ - 'description' => 'The output information about the current file.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The output information about the current file.'."\n", + 'DataSource' => [ + 'title' => '', + 'description' => 'The information about the associated data source.', '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 on the DataStudio page 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 on the DataStudio page in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'string', - 'example' => 'dw_project.002_out', - ], + 'Name' => ['description' => 'The name of the data source.', 'type' => 'string', 'example' => 'mysql_test', 'title' => ''], ], + 'example' => '', ], - ], - 'StartImmediately' => [ - 'description' => 'Indicates whether a node is immediately run after the node is deployed to the production environment.'."\n" + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + 'ModifyTime' => ['description' => 'The modification time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + 'CreateUser' => ['description' => 'The account ID of the creator.', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'ModifyUser' => ['description' => 'The account ID of the modifier.', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'TriggerRecurrence' => ['description' => 'The running mode of the task after it is triggered. Valid values:'."\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 on the DataStudio page in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'InputParameters' => [ - 'description' => 'The input parameters of the node.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The input parameter of the node.'."\n", - '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 on the DataStudio page 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 on the DataStudio page in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'string', - 'example' => 'project_001.parent_node:outputs', - ], - ], - ], + .'- Pause'."\n" + ."\n" + .'- Skip'."\n" + ."\n" + .'- Normal', 'type' => 'string', 'example' => 'Normal', 'title' => ''], + 'ClientUniqueCode' => ['description' => 'The unique code of the client. This parameter is used to create a task asynchronously and implement the idempotence of the task. If you do not specify this parameter when you create the task, the system automatically generates a unique code. The unique code is uniquely associated with the task ID. If you specify this parameter when you update or delete the task, the value of this parameter must be the unique code that is used to create the task.', 'type' => 'string', 'example' => 'Task_0bc5213917368545132902xxxxxxxx', 'title' => ''], ], - 'OutputParameters' => [ - 'description' => 'The output parameters of the node.'."\n", + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Outputs' => [ + 'title' => '', + 'description' => 'The output information.', + 'type' => 'object', + 'properties' => [ + 'TaskOutputs' => [ + 'description' => 'The task outputs.', 'type' => 'array', 'items' => [ - 'description' => 'The output parameter of the node.'."\n", '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 on the DataStudio page 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 on the DataStudio page 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 on the DataStudio page 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.', - ], + 'Output' => ['description' => 'The identifier of the output.', 'type' => 'string', 'title' => '', 'example' => 'pre.odps_sql_demo_0'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - ], - 'ApplyScheduleImmediately' => [ - 'description' => 'Indicates whether scheduling configurations immediately take effect after the deployment.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'IgnoreParentSkipRunningProperty' => [ - 'description' => 'Indicates whether the dry-run property of the ancestor nodes of the node is skipped. 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 on the DataStudio page in the DataWorks console.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Timeout' => [ - 'description' => 'The timeout period.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ImageId' => [ - 'description' => 'The custom image ID.'."\n", - 'type' => 'string', - 'example' => 'm-bp1h4b5a8ogkbll2f3tr', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], - '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', + 'Tags' => [ + 'title' => '', + 'description' => 'The tags.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'key1', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'value1', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + 'ModifyTime' => ['description' => 'The modification time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + 'CreateUser' => ['description' => 'The account ID of the creator.', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'ModifyUser' => ['description' => 'The account ID of the modifier.', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'ClientUniqueCode' => ['description' => 'The unique code of the client. This parameter is used to create a workflow asynchronously and implement the idempotence of the workflow. If you do not specify this parameter when you create the workflow, the system automatically generates a unique code. The unique code is uniquely associated with the workflow ID. If you specify this parameter when you update or delete the workflow, the value of this parameter must be the unique code that is used to create the workflow.', 'type' => 'string', 'example' => 'Workflow_0bc5213917368545132902xxxxxxxx', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + '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.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"Workflow\\": {\\n \\"Id\\": 1234,\\n \\"ProjectId\\": 100,\\n \\"EnvType\\": \\"Prod\\",\\n \\"Owner\\": \\"1000\\",\\n \\"Name\\": \\"Workflow\\",\\n \\"Description\\": \\"Test workflow\\",\\n \\"Trigger\\": {\\n \\"Type\\": \\"Scheduler\\",\\n \\"Recurrence\\": \\"Normal\\",\\n \\"Cron\\": \\"00 00 00 * * ?\\",\\n \\"StartTime\\": \\"1970-01-01 00:00:00\\",\\n \\"EndTime\\": \\"1970-01-01 00:00:00\\"\\n },\\n \\"Dependencies\\": [\\n {\\n \\"Type\\": \\"Normal\\",\\n \\"UpstreamOutput\\": \\"pre.odps_sql_demo_0\\",\\n \\"UpstreamTaskId\\": 1234\\n }\\n ],\\n \\"Parameters\\": \\"para1=$bizdate para2=$[yyyymmdd] \\",\\n \\"Tasks\\": [\\n {\\n \\"Id\\": 1234,\\n \\"ProjectId\\": 100,\\n \\"EnvType\\": \\"Prod\\",\\n \\"Owner\\": \\"1000\\",\\n \\"Name\\": \\"SQL node\\",\\n \\"Description\\": \\"Test\\",\\n \\"WorkflowId\\": 1234,\\n \\"Type\\": \\"ODPS_SQL\\",\\n \\"BaselineId\\": 1234,\\n \\"Priority\\": 1,\\n \\"Timeout\\": 3600,\\n \\"RerunMode\\": \\"AllAllowed\\",\\n \\"RerunTimes\\": 3,\\n \\"RerunInterval\\": 60,\\n \\"RuntimeResource\\": {\\n \\"ResourceGroupId\\": \\"S_res_group_524258031846018_1684XXXXXXXXX\\",\\n \\"Image\\": \\"i-xxxxxx\\",\\n \\"Cu\\": \\"0.25\\"\\n },\\n \\"DataSource\\": {\\n \\"Name\\": \\"mysql_test\\"\\n },\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"1000\\",\\n \\"ModifyUser\\": \\"1000\\",\\n \\"TriggerRecurrence\\": \\"Normal\\",\\n \\"ClientUniqueCode\\": \\"Task_0bc5213917368545132902xxxxxxxx\\"\\n }\\n ],\\n \\"Outputs\\": {\\n \\"TaskOutputs\\": [\\n {\\n \\"Output\\": \\"pre.odps_sql_demo_0\\"\\n }\\n ]\\n },\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"1000\\",\\n \\"ModifyUser\\": \\"1000\\",\\n \\"ClientUniqueCode\\": \\"Workflow_0bc5213917368545132902xxxxxxxx\\"\\n }\\n}","type":"json"}]', + 'title' => 'GetWorkflow', + 'summary' => 'Queries the information about a workflow.', + 'description' => 'This API operation is available for all DataWorks editions.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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\\": \\"424732****\\\\n\\",\\n \\"FileName\\": \\"ods_user_info_d\\",\\n \\"ConnectionName\\": \\"odps_source\\",\\n \\"UseType\\": \\"NORMAL\\",\\n \\"FileFolderId\\": \\"2735c2****\\",\\n \\"ParentId\\": -1,\\n \\"CreateUser\\": \\"424732****\\\\n\\",\\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' => ' ', + 'ramActions' => [], ], - 'ListFiles' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GetWorkflowDefinition' => [ + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -21351,450 +24871,286 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '267410', - 'abilityTreeNodes' => [ - 'FEATUREdide8FM783', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '234973', + 'abilityTreeNodes' => ['FEATUREdideHO4TQP', 'FEATUREdide8FM783', 'FEATUREdideQUQUVB', 'FEATUREdideIQU97M'], ], 'parameters' => [ - [ - 'name' => 'FileFolderPath', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The path to the folder where the file is located.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'Business_process/my_first_business_process/MaxCompute/ods_layer', - ], - ], [ '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 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, - 'docRequired' => false, - 'example' => '10000', - ], - ], - [ - 'name' => 'Keyword', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The keyword for the file name. Fuzzy match is supported. You can enter a keyword to query all files that contain the keyword.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'ods', - ], - ], - [ - 'name' => 'ProjectIdentifier', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The DataWorks workspace name. To obtain the workspace name, log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and navigate to the workspace configuration page.'."\n" - ."\n" - .'You must specify either this parameter or ProjectId to identify the target DataWorks workspace for this API call.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dw_project', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The page number for pagination.'."\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 functional module to which the file belongs. Valid values:'."\n" - ."\n" - .'* NORMAL: Data Studio'."\n" - .'* MANUAL: Manually triggered node'."\n" - .'* MANUAL_BIZ: Manually triggered workflow'."\n" - .'* SKIP: Dry-run scheduling in Data Studio'."\n" - .'* ADHOCQUERY: Ad hoc query'."\n" - .'* COMPONENT: Component management'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'NORMAL', - ], - ], - [ - 'name' => 'FileTypes', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The code type of the file.'."\n" - ."\n" - .'The code type of the file. Common code types and their corresponding file types include: 6 (Shell), 10 (ODPS SQL), 11 (ODPS MR), 23 (Data Integration), 24 (ODPS Script), 97 (PAI), 98 (Combined node), 99 (Virtual node), 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 sync), 1002 (PAI internal node), 1089 (Cross-tenant node), 1091 (Hologres development), 1093 (Hologres SQL), 1100 (Assignment node), 1106 (ForEach node), 1221 (PyODPS 3).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '10,23', - ], - ], - [ - 'name' => 'Owner', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the file owner.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '3726346****', - ], - ], - [ - 'name' => 'NodeId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the scheduling node. You can call the [ListNodes](~~173979~~) operation to obtain the node ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123541234', - ], + '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.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000', 'title' => ''], ], [ - 'name' => 'NeedContent', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether the query result includes the file content. For files with large content, network transmission delays may occur.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the workflow.', 'type' => 'string', 'required' => true, 'format' => 'int64', 'example' => '860438872620****', 'title' => ''], ], [ - 'name' => 'NeedAbsoluteFolderPath', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether the query result includes the path to the folder where the file is located.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'name' => 'IncludeScriptContent', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether the query result includes the script content of internal nodes in the workflow definition. For nodes with large content, this may cause high network transmission latency.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], - [ - 'name' => 'ExactFileName', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The exact file name. The file name in the query result must exactly match this parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ods_create.sql', + 'title' => 'Schema of Response', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F2BDD628-8A21-5BD1-B930-1A2D5989XXXX'], + 'WorkflowDefinition' => [ + 'description' => 'The information about the workflow.', + 'type' => 'object', + 'properties' => [ + 'ProjectId' => ['description' => 'The ID of the workspace to which the workflow belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '307XXX', 'title' => ''], + 'Name' => ['description' => 'The name of the workflow.', 'type' => 'string', 'example' => 'OpenAPI test workflow Demo', 'title' => ''], + 'Owner' => ['description' => 'The owner of the workflow.', 'type' => 'string', 'example' => '110755000425XXXX', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the workflow was created. This value is a UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1708481905000', 'title' => ''], + 'ModifyTime' => ['description' => 'The time when the workflow was last modified. This value is a UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1708481905000'."\n", 'title' => ''], + 'Spec' => ['description' => 'The FlowSpec field information about the workflow. For more information, see [FlowSpec](https://github.com/aliyun/alibabacloud-dataworks-tool-dflow/).', 'type' => 'string', 'example' => '{'."\n" + .' "metadata": {'."\n" + .' "tenantId": "52425742456XXXX",'."\n" + .' "projectId": "307XXXX",'."\n" + .' "uuid": "463497880880954XXXX"'."\n" + .' },'."\n" + .' "kind": "CycleWorkflow",'."\n" + .' "version": "1.1.0",'."\n" + .' "spec": {'."\n" + .' "name": "OpenAPI_Test_Workflow_Demo",'."\n" + .' "id": "463497880880954XXXX",'."\n" + .' "type": "CycleWorkflow",'."\n" + .' "owner": "110755000425XXXX",'."\n" + .' "workflows": ['."\n" + .' {'."\n" + .' "script": {'."\n" + .' "path": "XX/OpenAPI_Test/Workflow_Test/OpenAPI_Test_Workflow_Demo",'."\n" + .' "runtime": {'."\n" + .' "command": "WORKFLOW"'."\n" + .' },'."\n" + .' "id": "698002781368644XXXX"'."\n" + .' },'."\n" + .' "id": "463497880880954XXXX",'."\n" + .' "trigger": {'."\n" + .' "type": "Scheduler",'."\n" + .' "id": "652567824470354XXXX",'."\n" + .' "cron": "00 02 00 * * ?",'."\n" + .' "startTime": "1970-01-01 00:00:00",'."\n" + .' "endTime": "9999-01-01 00:00:00",'."\n" + .' "timezone": "Asia/Shanghai",'."\n" + .' "delaySeconds": 0'."\n" + .' },'."\n" + .' "strategy": {'."\n" + .' "timeout": 0,'."\n" + .' "instanceMode": "T+1",'."\n" + .' "rerunMode": "Allowed",'."\n" + .' "rerunTimes": 3,'."\n" + .' "rerunInterval": 180000,'."\n" + .' "failureStrategy": "Break"'."\n" + .' },'."\n" + .' "name": "OpenAPI_Test_Workflow_Demo",'."\n" + .' "owner": "110755000425XXXX",'."\n" + .' "metadata": {'."\n" + .' "owner": "110755000425XXXX",'."\n" + .' "ownerName": "XXXX@test.XXXX.com",'."\n" + .' "tenantId": "52425742456XXXX",'."\n" + .' "project": {'."\n" + .' "mode": "STANDARD",'."\n" + .' "projectId": "307303",'."\n" + .' "projectIdentifier": "lwttest_standard",'."\n" + .' "projectName": "XXXX",'."\n" + .' "projectOwnerId": "110755000425XXXX",'."\n" + .' "simple": false,'."\n" + .' "tenantId": "52425742456XXXX"'."\n" + .' },'."\n" + .' "projectId": "307XXXX"'."\n" + .' },'."\n" + .' "inputs": {},'."\n" + .' "outputs": {'."\n" + .' "nodeOutputs": ['."\n" + .' {'."\n" + .' "data": "463497880880954XXXX",'."\n" + .' "artifactType": "NodeOutput",'."\n" + .' "refTableName": "OpenAPI_Test_Workflow_Demo",'."\n" + .' "isDefault": true'."\n" + .' }'."\n" + .' ]'."\n" + .' },'."\n" + .' "nodes": [],'."\n" + .' "dependencies": []'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .'}', 'title' => ''], + 'WorkflowId' => ['description' => 'The ID of the workflow on the scheduling side after publishing.', 'type' => 'integer', 'format' => 'int64', 'example' => '700006657495', 'title' => ''], + 'Id' => ['description' => 'The ID of the workflow.', 'type' => 'string', 'format' => 'int64', 'example' => '463497880880954XXXX', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], ], + ], + 'title' => 'GetWorkflowDefinition', + 'summary' => 'Queries the information about a workflow.', + 'changeSet' => [ + ['createdAt' => '2025-02-18T02:45:10.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-02-18T01:56:59.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2025-01-13T07:35:59.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'FileIdIn', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The list of file IDs. The file IDs in the query result must be a subset of this list. You can specify up to 50 file IDs at a time.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '78237,816123', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F2BDD628-8A21-5BD1-B930-1A2D5989XXXX\\",\\n \\"WorkflowDefinition\\": {\\n \\"ProjectId\\": 0,\\n \\"Name\\": \\"OpenAPI test workflow Demo\\",\\n \\"Owner\\": \\"110755000425XXXX\\",\\n \\"CreateTime\\": 1708481905000,\\n \\"ModifyTime\\": 1708481905000,\\n \\"Spec\\": \\"{\\\\n \\\\\\"metadata\\\\\\": {\\\\n \\\\\\"tenantId\\\\\\": \\\\\\"52425742456XXXX\\\\\\",\\\\n \\\\\\"projectId\\\\\\": \\\\\\"307XXXX\\\\\\",\\\\n \\\\\\"uuid\\\\\\": \\\\\\"463497880880954XXXX\\\\\\"\\\\n },\\\\n \\\\\\"kind\\\\\\": \\\\\\"CycleWorkflow\\\\\\",\\\\n \\\\\\"version\\\\\\": \\\\\\"1.1.0\\\\\\",\\\\n \\\\\\"spec\\\\\\": {\\\\n \\\\\\"name\\\\\\": \\\\\\"OpenAPI_Test_Workflow_Demo\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"463497880880954XXXX\\\\\\",\\\\n \\\\\\"type\\\\\\": \\\\\\"CycleWorkflow\\\\\\",\\\\n \\\\\\"owner\\\\\\": \\\\\\"110755000425XXXX\\\\\\",\\\\n \\\\\\"workflows\\\\\\": [\\\\n {\\\\n \\\\\\"script\\\\\\": {\\\\n \\\\\\"path\\\\\\": \\\\\\"XX/OpenAPI_Test/Workflow_Test/OpenAPI_Test_Workflow_Demo\\\\\\",\\\\n \\\\\\"runtime\\\\\\": {\\\\n \\\\\\"command\\\\\\": \\\\\\"WORKFLOW\\\\\\"\\\\n },\\\\n \\\\\\"id\\\\\\": \\\\\\"698002781368644XXXX\\\\\\"\\\\n },\\\\n \\\\\\"id\\\\\\": \\\\\\"463497880880954XXXX\\\\\\",\\\\n \\\\\\"trigger\\\\\\": {\\\\n \\\\\\"type\\\\\\": \\\\\\"Scheduler\\\\\\",\\\\n \\\\\\"id\\\\\\": \\\\\\"652567824470354XXXX\\\\\\",\\\\n \\\\\\"cron\\\\\\": \\\\\\"00 02 00 * * ?\\\\\\",\\\\n \\\\\\"startTime\\\\\\": \\\\\\"1970-01-01 00:00:00\\\\\\",\\\\n \\\\\\"endTime\\\\\\": \\\\\\"9999-01-01 00:00:00\\\\\\",\\\\n \\\\\\"timezone\\\\\\": \\\\\\"Asia/Shanghai\\\\\\",\\\\n \\\\\\"delaySeconds\\\\\\": 0\\\\n },\\\\n \\\\\\"strategy\\\\\\": {\\\\n \\\\\\"timeout\\\\\\": 0,\\\\n \\\\\\"instanceMode\\\\\\": \\\\\\"T+1\\\\\\",\\\\n \\\\\\"rerunMode\\\\\\": \\\\\\"Allowed\\\\\\",\\\\n \\\\\\"rerunTimes\\\\\\": 3,\\\\n \\\\\\"rerunInterval\\\\\\": 180000,\\\\n \\\\\\"failureStrategy\\\\\\": \\\\\\"Break\\\\\\"\\\\n },\\\\n \\\\\\"name\\\\\\": \\\\\\"OpenAPI_Test_Workflow_Demo\\\\\\",\\\\n \\\\\\"owner\\\\\\": \\\\\\"110755000425XXXX\\\\\\",\\\\n \\\\\\"metadata\\\\\\": {\\\\n \\\\\\"owner\\\\\\": \\\\\\"110755000425XXXX\\\\\\",\\\\n \\\\\\"ownerName\\\\\\": \\\\\\"XXXX@test.XXXX.com\\\\\\",\\\\n \\\\\\"tenantId\\\\\\": \\\\\\"52425742456XXXX\\\\\\",\\\\n \\\\\\"project\\\\\\": {\\\\n \\\\\\"mode\\\\\\": \\\\\\"STANDARD\\\\\\",\\\\n \\\\\\"projectId\\\\\\": \\\\\\"307303\\\\\\",\\\\n \\\\\\"projectIdentifier\\\\\\": \\\\\\"lwttest_standard\\\\\\",\\\\n \\\\\\"projectName\\\\\\": \\\\\\"XXXX\\\\\\",\\\\n \\\\\\"projectOwnerId\\\\\\": \\\\\\"110755000425XXXX\\\\\\",\\\\n \\\\\\"simple\\\\\\": false,\\\\n \\\\\\"tenantId\\\\\\": \\\\\\"52425742456XXXX\\\\\\"\\\\n },\\\\n \\\\\\"projectId\\\\\\": \\\\\\"307XXXX\\\\\\"\\\\n },\\\\n \\\\\\"inputs\\\\\\": {},\\\\n \\\\\\"outputs\\\\\\": {\\\\n \\\\\\"nodeOutputs\\\\\\": [\\\\n {\\\\n \\\\\\"data\\\\\\": \\\\\\"463497880880954XXXX\\\\\\",\\\\n \\\\\\"artifactType\\\\\\": \\\\\\"NodeOutput\\\\\\",\\\\n \\\\\\"refTableName\\\\\\": \\\\\\"OpenAPI_Test_Workflow_Demo\\\\\\",\\\\n \\\\\\"isDefault\\\\\\": true\\\\n }\\\\n ]\\\\n },\\\\n \\\\\\"nodes\\\\\\": [],\\\\n \\\\\\"dependencies\\\\\\": []\\\\n }\\\\n ]\\\\n }\\\\n}\\",\\n \\"WorkflowId\\": 700006657495,\\n \\"Id\\": \\"463497880880954XXXX\\"\\n }\\n}","type":"json"}]', + ], + 'GetWorkflowInstance' => [ + 'summary' => 'Queries the information about a workflow instance.', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'LastEditUser', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The Alibaba Cloud account ID of the user who last updated the file.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '11233***', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '260634', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB', 'FEATUREdideD0YY7B', 'FEATUREdideVFMENL'], + ], + 'parameters' => [ [ - 'name' => 'CommitStatus', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The current commit status of the file. Valid values: 0 (the latest code is not committed) and 1 (the latest code is committed).'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the workflow instance.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234', '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. Use this ID to troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-****', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Success' => [ - 'description' => 'Indicates whether the call succeeded. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The response details.'."\n", + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX', 'title' => ''], + 'WorkflowInstance' => [ + 'description' => 'The information about the workflow instance.', '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' => '13', - ], - 'Files' => [ - 'description' => 'The file details.'."\n", + 'Id' => ['description' => 'The ID of the workflow instance.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'WorkflowId' => ['description' => 'The ID of the workflow to which the instance belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'WorkflowTaskInstanceId' => ['description' => 'The task instance ID corresponding to the workflow instance.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'UnifiedWorkflowInstanceId' => ['description' => 'The unified pipeline instance ID. For all pipeline instances triggered under the same data timestamp in a single trigger, this field value is identical.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'Name' => ['description' => 'The name of the workflow instance.', 'type' => 'string', 'example' => 'WorkInstance1', 'title' => ''], + 'Type' => ['description' => 'The type of the workflow instance. Valid values:'."\n" + ."\n" + .'- Normal: Scheduled execution'."\n" + ."\n" + .'- Manual: Manually triggered node'."\n" + ."\n" + .'- SmokeTest: Testing'."\n" + ."\n" + .'- SupplementData: Data backfill'."\n" + ."\n" + .'- ManualWorkflow: Manually triggered workflow'."\n" + ."\n" + .'- TriggerWorkflow: Triggered Workflow', 'type' => 'string', 'title' => '', 'example' => 'Normal'], + 'Status' => ['description' => 'The status of the workflow instance. Valid values:'."\n" + ."\n" + .'- NotRun: The instance is not run.'."\n" + ."\n" + .'- Running: The instance is running.'."\n" + ."\n" + .'- WaitTime: The instance is waiting for the scheduling time to arrive.'."\n" + ."\n" + .'- CheckingCondition: Branch conditions are being checked for the instance.'."\n" + ."\n" + .'- WaitResource: The instance is waiting for resources.'."\n" + ."\n" + .'- Failure: The instance fails to be run.'."\n" + ."\n" + .'- Success: The instance is successfully run.'."\n" + ."\n" + .'- Checking: Data quality is being checked for the instance.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'BizDate' => ['description' => 'The data timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + 'StartedTime' => ['description' => 'The time when the instance started to run.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + 'FinishedTime' => ['description' => 'The time when the instance finished running.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + 'ProjectId' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'EnvType' => ['description' => 'The environment of the workspace. Valid values:'."\n" + ."\n" + .'- Prod'."\n" + ."\n" + .'- Dev', 'type' => 'string', 'example' => 'Prod', 'title' => ''], + 'Owner' => ['description' => 'The account ID of the workflow owner.', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + 'ModifyTime' => ['description' => 'The modification time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + 'CreateUser' => ['description' => 'The account ID of the creator.', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'ModifyUser' => ['description' => 'The account ID of the modifier.', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'WorkflowParameters' => ['description' => 'The workflow parameters.', 'type' => 'string', 'example' => '周期工作流：'."\n" + .'key1=value1 key2=value2'."\n" + .'手动业务流程：'."\n" + .'{"key1":"value1", "key2": "value2"}', 'title' => ''], + 'Tags' => [ + 'title' => '', + 'description' => 'The task tag.', 'type' => 'array', 'items' => [ - 'description' => 'The file information.'."\n", 'type' => 'object', 'properties' => [ - 'CommitStatus' => [ - 'description' => 'The current commit status of the file. Valid values: 0 (the latest code is not committed) and 1 (the latest code is committed).'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'AutoParsing' => [ - 'description' => 'Specifies whether automatic parsing is enabled for the file. Valid values:'."\n" - ."\n" - .'* true: The file automatically parses code.'."\n" - .'* false: The file does not automatically parse code.'."\n" - ."\n" - .'This parameter corresponds to Analyze Code when you set Dependencies to Same Cycle in the scheduling configuration of a Data Studio task in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Owner' => [ - 'description' => 'The Alibaba Cloud account ID of the file owner.'."\n", - 'type' => 'string', - 'example' => '3872572****', - ], - 'CreateTime' => [ - 'description' => 'The timestamp (in milliseconds) when the file was created.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1593950832000', - ], - 'FileType' => [ - 'description' => 'The file type. Different file types have different code. For more information, see [DataWorks node types](~~600169~~).'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'CurrentVersion' => [ - 'description' => 'The latest version 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. Use the BusinessId parameter instead.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '300000', - ], - 'LastEditUser' => [ - 'description' => 'The Alibaba Cloud account ID of the user who last updated the file.'."\n", - 'type' => 'string', - 'example' => '382762****', - ], - 'FileName' => [ - 'description' => 'The file name.'."\n", - 'type' => 'string', - 'example' => 'ods_user_info_d', - ], - 'ConnectionName' => [ - 'description' => 'The data source name used by the task.'."\n", - 'type' => 'string', - 'example' => 'odps_source', - ], - 'UseType' => [ - 'description' => 'The functional module to which the file belongs. Valid values:'."\n" - ."\n" - .'* NORMAL: Data Studio'."\n" - .'* MANUAL: Manually triggered node'."\n" - .'* MANUAL_BIZ: Manually triggered workflow'."\n" - .'* SKIP: Dry-run scheduling in Data Studio'."\n" - .'* ADHOCQUERY: Ad hoc query'."\n" - .'* COMPONENT: Component management'."\n", - 'type' => 'string', - 'example' => 'NORMAL', - ], - 'FileFolderId' => [ - 'description' => 'The ID of the folder where the file is located.'."\n", - 'type' => 'string', - 'example' => '2735c2****', - ], - 'FileId' => [ - 'description' => 'The file ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000001', - ], - 'ParentId' => [ - 'description' => 'If the current file is an internal file of a combined node, this parameter specifies the ID of the corresponding combined node file.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '-1', - ], - 'CreateUser' => [ - 'description' => 'The Alibaba Cloud account ID of the file creator.'."\n", - 'type' => 'string', - 'example' => '382762****', - ], - 'IsMaxCompute' => [ - 'description' => 'If the current file is a MaxCompute resource file, this parameter specifies whether the resource file needs to be uploaded to MaxCompute.'."\n" - ."\n" - .'You only need to configure this parameter when 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 timestamp (in milliseconds) when the file was last modified.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1593950832000', - ], - 'Content' => [ - 'description' => 'This parameter is deprecated. You can call the [GetFile](~~173954~~) operation to query this information.'."\n", - 'type' => 'string', - 'example' => 'SHOW TABLES;', - ], - 'NodeId' => [ - 'description' => 'The ID of the scheduling task generated in the scheduling system after the file is committed.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '300001', - ], - 'AbsoluteFolderPath' => [ - 'description' => 'The path to the folder where the file is located.'."\n", - 'type' => 'string', - 'example' => 'Business_process/my_first_business_process/MaxCompute/ods_layer', - ], + 'Key' => ['description' => 'The key of a tag.', 'type' => 'string', 'example' => 'key1', 'title' => ''], + 'Value' => ['description' => 'The value of a tag.', 'type' => 'string', 'example' => 'value1', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + '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.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"WorkflowInstance\\": {\\n \\"Id\\": 1234,\\n \\"WorkflowId\\": 1234,\\n \\"WorkflowTaskInstanceId\\": 1234,\\n \\"UnifiedWorkflowInstanceId\\": 1234,\\n \\"Name\\": \\"WorkInstance1\\",\\n \\"Type\\": \\"Normal\\",\\n \\"Status\\": \\"Success\\",\\n \\"BizDate\\": 1710239005403,\\n \\"StartedTime\\": 1710239005403,\\n \\"FinishedTime\\": 1710239005403,\\n \\"ProjectId\\": 100,\\n \\"EnvType\\": \\"Prod\\",\\n \\"Owner\\": \\"1000\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"1000\\",\\n \\"ModifyUser\\": \\"1000\\",\\n \\"WorkflowParameters\\": \\"周期工作流：\\\\nkey1=value1 key2=value2\\\\n手动业务流程：\\\\n{\\\\\\"key1\\\\\\":\\\\\\"value1\\\\\\", \\\\\\"key2\\\\\\": \\\\\\"value2\\\\\\"}\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'GetWorkflowInstance', + 'description' => 'You must purchase DataWorks Basic Edition or a higher edition to use this feature.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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 \\"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\\": \\"382762****\\",\\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}","type":"json"}]', - 'title' => 'ListFiles', - 'summary' => 'Queries a list of files.', + 'ramActions' => [], ], - 'SubmitFile' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'GrantMemberProjectRoles' => [ + 'summary' => 'Assigns roles to members in a workspace.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -21804,162 +25160,77 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'abilityTreeCode' => '268112', - 'abilityTreeNodes' => [ - 'FEATUREdide8FM783', - ], + 'abilityTreeCode' => '244500', + 'abilityTreeNodes' => ['FEATUREdideYTM537'], + 'tenantRelevance' => 'tenant', ], '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 specify either this parameter or the ProjectIdentifier parameter to identify the DataWorks workspace when you call this operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '100001', - ], - ], - [ - '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 query the workspace name. You must specify either this parameter or the ProjectId parameter to identify the DataWorks workspace when you call this operation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dw_project', - ], - ], - [ - 'name' => 'FileId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The file ID. You can call the [ListFiles](~~173942~~) operation to obtain the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1000000', - ], + '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, 'example' => '105149', 'title' => ''], ], [ - 'name' => 'Comment', + 'name' => 'UserId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The description of the submission.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Submit a task for the first time', - ], + 'schema' => ['description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://dataworks.console.aliyun.com/product/ms_menu), choose More > Management Center in the left-side navigation pane, select the desired workspace on the Management Center page, and then click Go to Management Center. In the left-side navigation pane of the SettingCenter page, click Tenant Members and Roles. On the Tenant Members and Roles page, view the IDs of the accounts used by the members in the workspace.', 'type' => 'string', 'required' => true, 'example' => '123422344899', 'title' => ''], ], [ - 'name' => 'SkipAllDeployFileExtensions', + 'name' => 'RoleCodes', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'Whether to skip the pre-deployment check after the file is submitted:'."\n" + 'description' => 'The codes of the roles in the workspace. You can call the [ListProjectRoles](~~2853930~~) operation to query the codes of all roles in the workspace.'."\n" ."\n" - .'* false: Do not skip. After the file is submitted, the system automatically triggers the pre-deployment check. The file becomes available for deployment only after the check is passed.'."\n" - .'* true: Skip. After the file is submitted, the system does not trigger the pre-deployment check. The file can proceed directly to deployment.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', + .'You must configure this parameter to specify the roles that you want to assign to members in the workspace.', + 'type' => 'array', + 'items' => ['description' => 'The code of a role in the workspace.', 'type' => 'string', 'required' => false, 'example' => 'role_project_guest', 'title' => ''], + 'required' => true, + 'maxItems' => 10, + 'minItems' => 1, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response.'."\n", + 'title' => 'Schema of Response', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The deployment package ID. You must specify this ID as a parameter when you call the [GetDeployment](~~173950~~) operation to query the details of the deployment.'."\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 call was successful.'."\n" - ."\n" - .'* true: success.'."\n" - .'* false: failure.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.', 'type' => 'string', 'example' => '2d9ced66-38ef-4923-baf6-391dd3a7e656'], ], + '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.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2d9ced66-38ef-4923-baf6-391dd3a7e656\\"\\n}","type":"json"}]', + 'title' => 'GrantMemberProjectRoles', + 'description' => 'This API operation is available for all DataWorks editions.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:GrantMemberProjectRoles', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - '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' => 'Commits a file to the development environment of the scheduling system to generate a task.', ], - 'DeployFile' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ImportCertificate' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -21968,564 +25239,730 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '268115', - 'abilityTreeNodes' => [ - 'FEATUREdide8FM783', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '250619', + 'abilityTreeNodes' => ['FEATUREdideRWC5F7'], ], '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 specify either this parameter or the ProjectIdentifier parameter to identify the DataWorks workspace when you call this operation.'."\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 page to query the workspace name. You must specify either this parameter or the ProjectId parameter to identify the DataWorks workspace when you call this operation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dw_project', - ], + 'in' => 'query', + 'schema' => ['description' => 'The ID of the project to which the certificate file belongs.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '106560', 'title' => ''], ], [ - 'name' => 'FileId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The file ID. You can call the [ListFiles](~~173942~~) operation to obtain the ID. You need to configure either this parameter or the NodeId parameter.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'example' => '10000001', - ], + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the certificate file. The name must be unique within a project.', 'type' => 'string', 'required' => true, 'example' => 'ca1.crt', 'title' => ''], ], [ - 'name' => 'Comment', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The description of the deployment.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'First release task', - ], + 'name' => 'CertificateFile', + 'in' => 'query', + 'schema' => ['description' => 'The certificate file to upload. Construct an InputStream to upload the file.', 'type' => 'string', 'required' => true, 'isFileTransferUrl' => true, 'example' => '-', 'title' => ''], ], [ - 'name' => 'NodeId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The task ID of the file to be deployed in the scheduling system. You need to configure either this parameter or the FileId parameter.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '2000001', - ], + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The description of the file.', 'type' => 'string', 'required' => false, 'example' => 'This is a file', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response.'."\n", + 'title' => 'Schema of Response', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The deployment package ID. You must specify this ID as a parameter when you call the [GetDeployment](~~173950~~) operation to query the details of the deployment.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30000001', - ], - '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 call was successful. Valid values:'."\n" - ."\n" - .'* true: success.'."\n" - .'* false: failure.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', + 'Id' => ['description' => 'The unique ID of the certificate file.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '676303114031776'], + 'RequestId' => ['description' => 'The ID of the request. This ID is used to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => '7C352CB7-CD88-50CF-9D0D-E81BDF020E7F', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ImportCertificate', + 'summary' => 'Imports a certificate file.', + 'description' => '1. This feature requires DataWorks Basic Edition or a later version.'."\n" + ."\n" + .'2. You must be assigned one of the following roles in the DataWorks project: Tenant Owner, Space Administrator, Project Owner, or O\\&M.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Id\\": 676303114031776,\\n \\"RequestId\\": \\"7C352CB7-CD88-50CF-9D0D-E81BDF020E7F\\"\\n}","type":"json"}]', + ], + 'ImportWorkflowDefinition' => [ + 'summary' => 'Imports a workflow node defined by FlowSpec and its child nodes into DataStudio.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '246297', + 'abilityTreeNodes' => ['FEATUREdideHO4TQP', 'FEATUREdide8FM783', 'FEATUREdideQUQUVB', 'FEATUREdideIQU97M'], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the DataWorks workspace. You can logon to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the workspace management page to obtain the ID.'."\n" + ."\n" + .'This parameter specifies the DataWorks workspace for this API invoke.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456', 'title' => ''], + ], + [ + 'name' => 'Spec', + 'in' => 'formData', + 'schema' => ['description' => 'The FlowSpec information that describes the workflow. For the specification details, see [FlowSpec](https://github.com/aliyun/alibabacloud-dataworks-tool-dflow/).'."\n" + ."\n" + .'> How do I quickly obtain a FlowSpec template?'."\n" + .'> - Open a workflow in DataStudio, and then click **Show Spec** in the upper-right corner to obtain the FlowSpec description of the current workflow. You can use this FlowSpec description to quickly build a template that meets your requirements.'."\n" + ."\n" + .'>This operation supports creating a workflow and its internal nodes at the same time. Pay attention to the IDs specified in the FlowSpec. If an ID already exists, the operation becomes an update. The operation becomes a create only when no ID is specified or the ID does not exist.>', 'type' => 'string', 'required' => true, 'example' => '{'."\n" + .' "version": "1.1.0",'."\n" + .' "kind": "CycleWorkflow",'."\n" + .' "spec": {'."\n" + .' "name": "Asynchronous_Workflow_Creation_Test",'."\n" + .' "id": "632647691239009XXXX",'."\n" + .' "type": "CycleWorkflow",'."\n" + .' "workflows": ['."\n" + .' {'."\n" + .' "script": {'."\n" + .' "path": "XX/OpenAPI_Test/Workflow_Test/Asynchronous_Workflow_Creation_Test",'."\n" + .' "runtime": {'."\n" + .' "command": "WORKFLOW"'."\n" + .' }'."\n" + .' },'."\n" + .' "id": "632647691239009XXXX",'."\n" + .' "trigger": {'."\n" + .' "type": "Scheduler",'."\n" + .' "cron": "00 03 00 * * ?",'."\n" + .' "startTime": "1970-01-01 00:00:00",'."\n" + .' "endTime": "9999-01-01 00:00:00",'."\n" + .' "timezone": "Asia/Shanghai",'."\n" + .' "delaySeconds": 0'."\n" + .' },'."\n" + .' "strategy": {'."\n" + .' "timeout": 0,'."\n" + .' "instanceMode": "T+1",'."\n" + .' "rerunMode": "Allowed",'."\n" + .' "rerunTimes": 3,'."\n" + .' "rerunInterval": 180000,'."\n" + .' "failureStrategy": "Break"'."\n" + .' },'."\n" + .' "name": "Asynchronous_Workflow_Creation_Test",'."\n" + .' "inputs": {},'."\n" + .' "outputs": {'."\n" + .' "nodeOutputs": ['."\n" + .' {'."\n" + .' "data": "632647691239009XXXX",'."\n" + .' "artifactType": "NodeOutput",'."\n" + .' "refTableName": "Asynchronous_Workflow_Creation_Test"'."\n" + .' }'."\n" + .' ]'."\n" + .' },'."\n" + .' "nodes": ['."\n" + .' {'."\n" + .' "recurrence": "Normal",'."\n" + .' "id": "742981001612325XXXX",'."\n" + .' "timeout": 0,'."\n" + .' "instanceMode": "T+1",'."\n" + .' "rerunMode": "Allowed",'."\n" + .' "rerunTimes": 3,'."\n" + .' "rerunInterval": 180000,'."\n" + .' "script": {'."\n" + .' "path": "XX/OpenAPI_Test/Workflow_Test/Asynchronous_Workflow_Creation_Test/111",'."\n" + .' "runtime": {'."\n" + .' "command": "ODPS_SQL"'."\n" + .' },'."\n" + .' "content": "select now();\\n"'."\n" + .' },'."\n" + .' "trigger": {'."\n" + .' "type": "Scheduler",'."\n" + .' "cron": "00 24 00 * * ?",'."\n" + .' "startTime": "1970-01-01 00:00:00",'."\n" + .' "endTime": "9999-01-01 00:00:00",'."\n" + .' "timezone": "Asia/Shanghai",'."\n" + .' "delaySeconds": 0'."\n" + .' },'."\n" + .' "name": "111",'."\n" + .' "inputs": {},'."\n" + .' "outputs": {'."\n" + .' "nodeOutputs": ['."\n" + .' {'."\n" + .' "data": "742981001612325XXXX",'."\n" + .' "artifactType": "NodeOutput",'."\n" + .' "refTableName": "111"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' },'."\n" + .' {'."\n" + .' "recurrence": "Normal",'."\n" + .' "id": "595182137303408XXXX",'."\n" + .' "timeout": 0,'."\n" + .' "instanceMode": "T+1",'."\n" + .' "rerunMode": "Allowed",'."\n" + .' "rerunTimes": 3,'."\n" + .' "rerunInterval": 180000,'."\n" + .' "script": {'."\n" + .' "path": "XX/OpenAPI_Test/Workflow_Test/Asynchronous_Workflow_Creation_Test/222",'."\n" + .' "runtime": {'."\n" + .' "command": "ODPS_SQL"'."\n" + .' },'."\n" + .' "content": "select now();\\n select 1;"'."\n" + .' },'."\n" + .' "trigger": {'."\n" + .' "type": "Scheduler",'."\n" + .' "cron": "00 00 00 * * ?",'."\n" + .' "startTime": "1970-01-01 00:00:00",'."\n" + .' "endTime": "9999-01-01 00:00:00",'."\n" + .' "timezone": "Asia/Shanghai",'."\n" + .' "delaySeconds": 0'."\n" + .' },'."\n" + .' "name": "222",'."\n" + .' "inputs": {},'."\n" + .' "outputs": {'."\n" + .' "nodeOutputs": ['."\n" + .' {'."\n" + .' "data": "595182137303408XXXX",'."\n" + .' "artifactType": "NodeOutput",'."\n" + .' "refTableName": "222" '."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' }'."\n" + .' ],'."\n" + .' "dependencies": ['."\n" + .' {'."\n" + .' "nodeId": "595182137303408XXXX",'."\n" + .' "depends": ['."\n" + .' {'."\n" + .' "type": "Normal",'."\n" + .' "output": "742981001612325XXXX",'."\n" + .' "refTableName": "111"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .'}', 'title' => ''], + ], + [ + 'name' => 'DryRun', + 'in' => 'formData', + 'schema' => ['type' => 'boolean', 'description' => '', 'required' => false, 'example' => 'false', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '7C352CB7-CD88-50CF-9D0D-E81BDF020E7F'], + 'AsyncJob' => [ + 'description' => 'The asynchronous task status information.', + 'type' => 'object', + 'properties' => [ + 'Completed' => ['description' => 'Indicates whether the asynchronous task is complete.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'CreateTime' => ['description' => 'The timestamp when the asynchronous task was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1706581425000', 'title' => ''], + 'Error' => ['description' => 'The error message returned when the asynchronous task fails.', 'type' => 'string', 'example' => 'target folder already exists: XXXX', 'title' => ''], + 'Id' => ['description' => 'The ID of the asynchronous task.', 'type' => 'string', 'example' => '1234567691239009XXXX', 'title' => ''], + 'Progress' => ['description' => 'The progress of the asynchronous task. Valid values: 0 to 100.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Response' => ['description' => 'The content that the asynchronous task is expected to return.'."\n" + ."\n" + .'> This field currently contains the ID of the workflow created by the asynchronous task.', 'type' => 'string', 'example' => '632647691239009XXXX', 'title' => ''], + 'Status' => [ + 'description' => 'The status of the asynchronous task.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- Running: The task is running.'."\n" + .'- Success: The task succeeded.'."\n" + .'- Fail: The task failed.'."\n" + .'- Cancel: The task was canceled.', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'Running', + 'title' => '', + ], + 'Type' => [ + 'description' => 'The operation type of the asynchronous task.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- Create: creates a resource. '."\n" + .'- Cancel: cancels a creation job.', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'Create', + 'title' => '', + ], + ], + '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.', - ], - ], + 'staticInfo' => ['returnType' => 'asynchronous', 'callback' => 'dataworks-public::2024-05-18::GetJobStatus', 'callbackInterval' => 1000, 'maxCallbackTimes' => 10], + 'gatewayOptions' => [ + 'gatewayProtocols' => [], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'Import a dataStudio workflow', + 'description' => '>'."\n" + ."\n" + .'- This operation does not support importing multiple workflows. If more than one workflow is defined in the FlowSpec, all workflows except the first one are ignored.'."\n" + ."\n" + .'- This is an asynchronous operation. The response returns an asynchronous task object. Call GetJobStatus to query the execution status of the task.>', + 'changeSet' => [ + ['createdAt' => '2025-01-13T07:35:59.000Z', 'description' => 'Request parameters changed'], ], - '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', - ], - 'CreateFolder' => [ - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7C352CB7-CD88-50CF-9D0D-E81BDF020E7F\\",\\n \\"AsyncJob\\": {\\n \\"Completed\\": false,\\n \\"CreateTime\\": 1706581425000,\\n \\"Error\\": \\"target folder already exists: XXXX\\",\\n \\"Id\\": \\"1234567691239009XXXX\\",\\n \\"Progress\\": 0,\\n \\"Response\\": \\"632647691239009XXXX\\",\\n \\"Status\\": \\"Running\\",\\n \\"Type\\": \\"Create\\"\\n }\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'ListAgentSessionArtifacts' => [ + 'summary' => 'Retrieves a list of artifacts from a specified session.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '268606', - 'abilityTreeNodes' => [ - 'FEATUREdide8FM783', - ], + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdideEWGMTH'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'Jsonrpc', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the DataWorks workspace. You can obtain the workspace ID from the workspace configuration page in the DataWorks console. Either this parameter or **ProjectIdentifier** must be specified to determine which DataWorks workspace this API call operates on.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '10000', - ], + 'schema' => ['description' => 'The JSON-RPC version. Fixed value: 2.0.', 'type' => 'string', 'required' => false, 'example' => '2.0', 'title' => ''], ], [ - 'name' => 'ProjectIdentifier', + 'name' => 'Id', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the DataWorks workspace. You can obtain the workspace name from the workspace configuration page in the DataWorks console. Either this parameter or **ProjectId** must be specified to determine which DataWorks workspace this API call operates on.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dw_project', - ], + 'schema' => ['description' => 'The ID passed by the caller. The value is returned as-is in the response.', 'type' => 'string', 'required' => false, 'example' => '10001', 'title' => ''], ], [ - 'name' => 'FolderPath', + 'name' => 'Params', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The path of the folder.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Business_process/System_Data/MaxCompute/import_layer', + 'type' => 'object', + 'properties' => [ + 'SessionId' => ['description' => 'The session ID. If this parameter is not specified, an error `sessionCode` is required is returned.', 'type' => 'string', 'required' => false, 'example' => 'sess_0f12abc34', 'title' => ''], + 'RequestId' => ['description' => 'The request code used to filter artifacts. If specified, only artifacts generated by the specified request are returned.', 'type' => 'string', 'required' => false, 'example' => 'req_20260421_001', 'title' => ''], + 'MaxResults' => ['description' => 'The maximum number of entries per page. Default value: 50.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], + 'NextToken' => ['description' => 'The continuation token for retrieving the next page of results. Do not specify this parameter for the first request.', 'type' => 'string', 'required' => false, 'example' => 'CAESExFsbyH...', 'title' => ''], + ], + 'description' => 'The business parameters.', + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response.'."\n", 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The unique identifier of the newly created folder.'."\n", - 'type' => 'string', - 'example' => 'bdfd68****', - ], - 'RequestId' => [ - 'description' => 'The request ID. Used for troubleshooting when errors occur.'."\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 call succeeded. Valid values:'."\n" - ."\n" - .'true'."\n" - ."\n" - .'false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '0000-ABCD-E****'], + 'JsonRpcResponse' => [ + 'type' => 'object', + 'properties' => [ + 'Jsonrpc' => ['description' => 'The JSON-RPC version. Fixed value: 2.0.', 'type' => 'string', 'example' => '2.0', 'title' => ''], + 'Id' => ['description' => 'The ID passed by the caller. The value is returned as-is in the response.', 'type' => 'string', 'example' => '28477817', 'title' => ''], + 'Result' => [ + 'type' => 'object', + 'properties' => [ + 'NextToken' => ['description' => 'The token for the next page. The value is null if there are no more pages.', 'type' => 'string', 'example' => 'CAESExFsbyH...', 'title' => ''], + 'MaxResults' => ['description' => 'The actual number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '29', 'title' => ''], + 'Artifacts' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ArtifactName' => ['description' => 'The name of the artifact.', 'type' => 'string', 'example' => 'mock_report.md', 'title' => ''], + 'ArtifactType' => ['description' => 'The type of the artifact, which is typically the file extension.', 'type' => 'string', 'example' => 'md', 'title' => ''], + 'ArtifactPath' => ['description' => 'The path of the artifact.', 'type' => 'string', 'example' => 'mock/mock_report.md', 'title' => ''], + ], + 'description' => 'The artifact information.', + 'title' => '', + 'example' => '', + ], + 'description' => 'The list of artifacts.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The paginated information of artifacts.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The JSON-RPC response.', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => 'Schema of Response', + '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.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListAgentSessionArtifacts', + 'description' => '## Request'."\n" + ."\n" + .'- This operation retrieves all artifacts from a specific session. You can use the `Params.RequestId` parameter to filter for artifacts from a specific request.'."\n" + ."\n" + .'- The `NextToken` parameter is a continuation token used to retrieve the next page of results. Do not specify this parameter for the first request.'."\n" + ."\n" + .'- By default, this operation returns up to 50 artifacts per page. You can use the `MaxResults` parameter to specify a different limit.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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"}]', - 'title' => 'CreateFolder', - 'summary' => 'Creates a folder.', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0000-ABCD-E****\\",\\n \\"JsonRpcResponse\\": {\\n \\"Jsonrpc\\": \\"2.0\\",\\n \\"Id\\": \\"28477817\\",\\n \\"Result\\": {\\n \\"NextToken\\": \\"CAESExFsbyH...\\",\\n \\"MaxResults\\": 29,\\n \\"Artifacts\\": [\\n {\\n \\"ArtifactName\\": \\"mock_report.md\\",\\n \\"ArtifactType\\": \\"md\\",\\n \\"ArtifactPath\\": \\"mock/mock_report.md\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]', ], - 'DeleteFolder' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListAgentSessions' => [ + 'summary' => 'Retrieves the conversation history for the agent session.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '268607', - 'abilityTreeNodes' => [ - 'FEATUREdide8FM783', - ], + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdideEWGMTH'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'Jsonrpc', '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 specify either this parameter or the ProjectIdentifier parameter to identify the DataWorks workspace when you call this operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '10000', - ], + 'schema' => ['description' => 'The JSON-RPC version. The value must be `2.0`.', 'type' => 'string', 'required' => false, 'example' => '2.0', 'title' => ''], ], [ - 'name' => 'ProjectIdentifier', + 'name' => 'Id', '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 query the workspace name. You must specify either this parameter or the ProjectId parameter to identify the DataWorks workspace when you call this operation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dw_project', - ], + 'schema' => ['description' => 'The ID provided by the caller. The value is returned as-is.', 'type' => 'string', 'required' => false, 'example' => '676303114031776', 'title' => ''], ], [ - 'name' => 'FolderId', + 'name' => 'Params', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The folder ID. You can call the [ListFolders](~~173955~~) operation to obtain the folder ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2eb6f9****', + 'type' => 'object', + 'properties' => [ + 'AgentName' => ['description' => 'Filters sessions by the **agent name**. You must specify at least one of this parameter and `SessionSourceList`.', 'type' => 'string', 'required' => false, 'example' => 'chat_cli_chatbi', 'title' => ''], + 'SessionSourceList' => [ + 'type' => 'array', + 'items' => ['description' => 'The session source.', 'type' => 'string', 'required' => false, 'example' => 'pop-sdk', 'title' => ''], + 'description' => 'Filters sessions by the **list of session sources**. You must specify at least one of this parameter and `AgentName`.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'TagList' => [ + 'type' => 'array', + 'items' => ['description' => 'The tag code.', 'type' => 'string', 'required' => false, 'example' => 'user_123456', 'title' => ''], + 'description' => 'Filters sessions by a list of session tag codes.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'SessionId' => ['description' => 'Filters sessions by session ID.', 'type' => 'string', 'required' => false, 'example' => 'sess_0f12abc34', 'title' => ''], + 'SessionTitle' => ['description' => 'Filters sessions by session title using a fuzzy match.', 'type' => 'string', 'example' => 'Sales in the last 30 days', 'required' => false, 'title' => ''], + 'MaxResults' => ['description' => 'The maximum number of results to return per page. Default value: 50.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '50', 'title' => ''], + 'NextToken' => ['description' => 'The token for the next page of results. Set this parameter to `1` to retrieve the first page of results.', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], + ], + 'description' => 'Business parameters.', + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Responses.'."\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. Used for troubleshooting when an error occurs.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Success' => [ - 'description' => 'Indicates whether the call was successful. Valid values:'."\n" - ."\n" - .'* true: success.'."\n" - .'* false: failure.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '50C5A9F7-B5BD-58B2-9EB8-ADFFA9E6A56F'], + 'JsonRpcResponse' => [ + 'type' => 'object', + 'properties' => [ + 'Jsonrpc' => ['description' => 'The JSON-RPC version. The value is always `2.0`.', 'type' => 'string', 'example' => '2.0', 'title' => ''], + 'Id' => ['description' => 'The ID provided in the request. This value is returned unmodified.', 'type' => 'string', 'example' => '29d9a29c-a284-48c1-9eaa-4a42c7c616d5', 'title' => ''], + 'Result' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['description' => 'The total number of sessions that match the query.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'MaxResults' => ['description' => 'The number of entries returned on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'NextToken' => ['description' => 'The token to retrieve the next page of results. To retrieve the first page, use the value `1`.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'AgentSessions' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SessionId' => ['description' => 'The unique session ID.', 'type' => 'string', 'example' => 'sess_0f12abc34', 'title' => ''], + 'SessionTitle' => ['description' => 'The session title.', 'type' => 'string', 'example' => 'Sales analysis for the last 30 days', 'title' => ''], + 'SessionDescription' => ['description' => 'The session description.', 'type' => 'string', 'example' => 'Sales trend analysis', 'title' => ''], + 'SessionCreatedAt' => ['description' => 'The time the session was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456789', 'title' => ''], + 'SessionUpdatedAt' => ['description' => 'The time the session was last modified.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456789', 'title' => ''], + 'Meta' => [ + 'type' => 'object', + 'properties' => [ + 'SessionStatus' => ['description' => 'The session status.', 'type' => 'string', 'example' => '* NORMAL: 无状态的session'."\n" + .'* INIT: 初始化状态'."\n" + .'* RUNNING: 运行中'."\n" + .'* RELEASED: 释放状态', 'title' => ''], + 'SessionSource' => ['description' => 'The source of the session.', 'type' => 'string', 'example' => 'openapi_sdk', 'title' => ''], + 'SessionTagList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SessionTagCode' => ['description' => 'A tag for the session, which can be used for filtering. For example, if your application has its own user accounts but calls the API through a single service account, you can pass your application\'s user ID as a tag. This allows you to filter sessions by your internal users.', 'type' => 'string', 'example' => 'user_123456', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => 'A list of session tags.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'DataWorks-specific session metadata. This field is not part of the standard ACP protocol.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => 'A list of sessions.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The paginated results of the session query.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The JSON-RPC response.', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => 'The schema of the response.', + '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.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListAgentSessions', + 'description' => '## Request'."\n" + ."\n" + .'- Specify at least one of `agentName` or `sessionSourceList`.'."\n" + ."\n" + .'- You can use the `tagList`, `sessionId`, and `sessionTitle` parameters for combined filtering.'."\n" + ."\n" + .'- The response follows the Alibaba Cloud OpenAPI pagination specification and includes the `totalCount`, `maxResults`, `nextToken`, and `sessionList` fields.'."\n" + ."\n" + .'- If you provide an invalid string for `nextToken`, its value defaults to `1`.'."\n" + ."\n" + .'- By default, this operation returns 50 records per page. You can use the `maxResults` parameter to adjust this number.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - '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', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"50C5A9F7-B5BD-58B2-9EB8-ADFFA9E6A56F\\",\\n \\"JsonRpcResponse\\": {\\n \\"Jsonrpc\\": \\"2.0\\",\\n \\"Id\\": \\"29d9a29c-a284-48c1-9eaa-4a42c7c616d5\\",\\n \\"Result\\": {\\n \\"TotalCount\\": 200,\\n \\"MaxResults\\": 100,\\n \\"NextToken\\": \\"1\\",\\n \\"AgentSessions\\": [\\n {\\n \\"SessionId\\": \\"sess_0f12abc34\\",\\n \\"SessionTitle\\": \\"Sales analysis for the last 30 days\\",\\n \\"SessionDescription\\": \\"Sales trend analysis\\",\\n \\"SessionCreatedAt\\": 123456789,\\n \\"SessionUpdatedAt\\": 123456789,\\n \\"Meta\\": {\\n \\"SessionStatus\\": \\"* NORMAL: 无状态的session\\\\n* INIT: 初始化状态\\\\n* RUNNING: 运行中\\\\n* RELEASED: 释放状态\\",\\n \\"SessionSource\\": \\"openapi_sdk\\",\\n \\"SessionTagList\\": [\\n {\\n \\"SessionTagCode\\": \\"user_123456\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n }\\n}","type":"json"}]', + 'translator' => 'machine', ], - 'UpdateFolder' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListAgents' => [ + 'summary' => 'Lists agents for the current tenant and supports filtering by name and pagination.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '268610', - 'abilityTreeNodes' => [ - 'FEATUREdide8FM783', - ], + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdideEWGMTH'], + 'tenantRelevance' => 'publicInformation', ], '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 specify either this parameter or the ProjectIdentifier parameter to identify the DataWorks workspace when you call this operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '10000', - ], - ], - [ - 'name' => 'ProjectIdentifier', + 'name' => 'Jsonrpc', '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 query the workspace name. You must specify either this parameter or the ProjectId parameter to identify the DataWorks workspace when you call this operation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dw_project', - ], + 'schema' => ['description' => 'The JSON-RPC version. Fixed value: 2.0.', 'type' => 'string', 'required' => false, 'example' => '2.0', 'title' => ''], ], [ - 'name' => 'FolderId', + 'name' => 'Id', 'in' => 'formData', - 'schema' => [ - 'description' => 'The folder ID. You can call the [ListFolders](~~173955~~) operation to obtain the folder ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '2735c2c19d58', - ], + 'schema' => ['description' => 'The request ID passed in by the caller. The value is returned as-is in the response.', 'type' => 'string', 'required' => false, 'example' => '4as3dasf654a', 'title' => ''], ], [ - 'name' => 'FolderName', + 'name' => 'Params', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The folder name.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'MySecondFolder', + 'type' => 'object', + 'properties' => [ + 'AgentName' => ['description' => 'The exact agent name to filter by. If not specified, all agents are returned.', 'type' => 'string', 'required' => false, 'example' => 'chat_cli_chatbi', 'title' => ''], + 'MaxResults' => ['description' => 'The number of entries per page. Default value: 50.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '100', 'title' => ''], + 'NextToken' => ['description' => 'The token for the next page, following the Alibaba Cloud OpenAPI convention. Do not specify this parameter for the first page. For subsequent pages, pass in the nextToken value returned in the previous response.', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], + ], + 'description' => 'The parameters for this request.', + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], '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' => '0000-ABCD-EFG****', - ], - 'ErrorCode' => [ - 'description' => 'The error code'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Success' => [ - 'description' => 'Indicates whether the call was successful'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['description' => 'Id of the request', 'type' => 'string', 'title' => '', 'example' => '4003B739-C33C-5297-B810-0490EEE5A767'], + 'JsonRpcResponse' => [ + 'type' => 'object', + 'properties' => [ + 'Jsonrpc' => ['description' => 'The JSON-RPC version. Fixed value: 2.0.', 'type' => 'string', 'example' => '2.0', 'title' => ''], + 'Id' => ['description' => 'The request ID passed in by the caller. The value is returned as-is in the response.', 'type' => 'string', 'example' => '70623e38-a889-4192-930a-752ffdd75f48', 'title' => ''], + 'Result' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['description' => 'The total number of agents that match the filter criteria.', 'type' => 'integer', 'format' => 'int32', 'example' => '27', 'title' => ''], + 'MaxResults' => ['description' => 'The actual number of entries per page that takes effect.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'NextToken' => ['description' => 'The token for the next page. The value is null when the current page is the last page or no data is available.', 'type' => 'string', 'example' => '2', 'title' => ''], + 'Agents' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AgentName' => ['description' => 'The agent name.', 'type' => 'string', 'example' => 'chat_cli_chatbi', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => 'The list of agents.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The paginated query result for agents.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The response object that conforms to the JSON-RPC specification.', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => 'Schema of Response', + '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.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListAgents', + 'description' => '## Request description'."\n" + ."\n" + .'- This operation lists all available agents for the current tenant.'."\n" + ."\n" + .'- You can filter the results by specifying an exact match for the `agentName` parameter.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:ListAgents', + '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}","type":"json"}]', - 'title' => 'UpdateFolder', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4003B739-C33C-5297-B810-0490EEE5A767\\",\\n \\"JsonRpcResponse\\": {\\n \\"Jsonrpc\\": \\"2.0\\",\\n \\"Id\\": \\"70623e38-a889-4192-930a-752ffdd75f48\\",\\n \\"Result\\": {\\n \\"TotalCount\\": 27,\\n \\"MaxResults\\": 100,\\n \\"NextToken\\": \\"2\\",\\n \\"Agents\\": [\\n {\\n \\"AgentName\\": \\"chat_cli_chatbi\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]', ], - 'GetFolder' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListAlertRules' => [ + 'summary' => 'Queries a list of custom monitoring alert rules.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -22535,156 +25972,310 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '268603', - 'abilityTreeNodes' => [ - 'FEATUREdide8FM783', - ], + 'abilityTreeCode' => '249251', + 'abilityTreeNodes' => ['FEATUREdideRJGWWC'], ], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the DataWorks workspace. You can obtain the workspace ID from the workspace configuration page in the DataWorks console. Either this parameter or ProjectIdentifier must be specified to determine which DataWorks workspace this API call operates on.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '1000011', - ], + 'name' => 'Owner', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the Alibaba Cloud account used by the owner of the rule.', 'type' => 'string', 'required' => false, 'example' => '1933790683****', 'title' => ''], ], [ - 'name' => 'ProjectIdentifier', - 'in' => 'formData', + 'name' => 'TaskIds', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The name of the DataWorks workspace. You can obtain the workspace name from the workspace configuration page in the DataWorks console. Either this parameter or ProjectId must be specified to determine which DataWorks workspace this API call operates on.'."\n", - 'type' => 'string', + 'description' => 'The IDs of the scheduling tasks.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the scheduling task.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234', 'title' => ''], 'required' => false, - 'example' => 'dw_project', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'FolderId', - 'in' => 'formData', + 'name' => 'Types', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The folder ID. Either this parameter or FolderPath must be specified. You can call the [ListFolders](~~173955~~) operation to obtain the folder ID.'."\n", - 'type' => 'string', + 'description' => 'The alert triggering condition.', + 'type' => 'array', + 'items' => ['description' => 'The alert type. Valid values:'."\n" + ."\n" + .'- Finished: An instance is successfully run.'."\n" + ."\n" + .'- UnFinished: An instance does not finish running before a specified point in time.'."\n" + ."\n" + .'- Error: An error occurs on an instance.'."\n" + ."\n" + .'- CycleUnfinished: An instance does not finish running as expected within a specific cycle.'."\n" + ."\n" + .'- Timeout: An instance times out.'."\n" + ."\n" + .'- InstanceTransferComplete: An instance is generated by the auto triggered node.'."\n" + ."\n" + .'- InstanceTransferFluctuate: The number of generated instances fluctuates.'."\n" + ."\n" + .'- ExhaustedError: An error persists after an instance is automatically rerun.'."\n" + ."\n" + .'- InstanceKeyword: An instance with errors contains specified keywords.'."\n" + ."\n" + .'- InstanceErrorCount: The number of instances on which an error occurs reaches a specified threshold.'."\n" + ."\n" + .'- InstanceErrorPercentage: The proportion of instances on which an error occurs in the workspace to the total number of instances reaches a specified threshold.'."\n" + ."\n" + .'- ResourceGroupPercentage: The usage rate of the resource group reaches a specified threshold.'."\n" + ."\n" + .'- ResourceGroupWaitCount: The number of instances that are waiting for resources in the resource group reaches a specified threshold.', 'type' => 'string', 'required' => false, 'example' => 'Error', 'title' => ''], 'required' => false, - 'docRequired' => false, - 'example' => '273****', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'FolderPath', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The folder path. Either this parameter or FolderId must be specified. You can call the [ListFolders](~~173955~~) operation to obtain the folder path.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'Business_process/my_first_business_process/MaxCompute/ods_layer', - 'minLength' => 1, - ], + 'name' => 'Receiver', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the Alibaba Cloud account used by the alert recipient.', 'type' => 'string', 'required' => false, 'example' => '1933790683****', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the rule.', 'type' => 'string', 'required' => false, 'example' => 'error_rule', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Pages start from page 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'minimum' => '1', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Maximum value: 100.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'maximum' => '100', 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response.'."\n", + 'title' => 'Schema of Response', + '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' => 'The connection does not exist.', - ], - 'RequestId' => [ - 'description' => 'The request ID. Used for troubleshooting when errors occur.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Success' => [ - 'description' => 'Indicates whether the call was successful.'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'Details about the folder.'."\n", + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'A6C6B486-E3A2-5D52-9E76-D938048****'], + 'PagingInfo' => [ + 'description' => 'The pagination information.', 'type' => 'object', 'properties' => [ - 'FolderPath' => [ - 'description' => 'The path of the folder.'."\n", - 'type' => 'string', - 'example' => 'Business_process/my_first_business_process/MaxCompute/ods_layer', - ], - 'FolderId' => [ - 'description' => 'The ID of the folder.'."\n", - 'type' => 'string', - 'example' => '2735****', + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '5', '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' => ''], + 'AlertRules' => [ + 'description' => 'The rules.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '22125', 'title' => ''], + 'Name' => ['description' => 'The name of the rule.', 'type' => 'string', 'example' => 'error_test', 'title' => ''], + 'Owner' => ['description' => 'The ID of the Alibaba Cloud account used by the owner of the rule.', 'type' => 'string', 'example' => '1933790683****', 'title' => ''], + 'Enabled' => ['description' => 'Indicates whether the rule is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'TriggerCondition' => [ + 'description' => 'The alert triggering condition.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The alert type. Valid values:'."\n" + ."\n" + .'- Finished: An instance is successfully run.'."\n" + ."\n" + .'- UnFinished: An instance does not finish running before a specified point in time.'."\n" + ."\n" + .'- Error: An error occurs on an instance.'."\n" + ."\n" + .'- CycleUnfinished: An instance does not finish running as expected within a specific cycle.'."\n" + ."\n" + .'- Timeout: An instance times out.'."\n" + ."\n" + .'- InstanceTransferComplete: An instance is generated by the auto triggered node.'."\n" + ."\n" + .'- InstanceTransferFluctuate: The number of generated instances fluctuates.'."\n" + ."\n" + .'- ExhaustedError: An error persists after an instance is automatically rerun.'."\n" + ."\n" + .'- InstanceKeyword: An instance with errors contains specified keywords.'."\n" + ."\n" + .'- InstanceErrorCount: The number of instances on which an error occurs reaches a specified threshold.'."\n" + ."\n" + .'- InstanceErrorPercentage: The proportion of instances on which an error occurs in the workspace to the total number of instances reaches a specified threshold.'."\n" + ."\n" + .'- ResourceGroupPercentage: The usage rate of the resource group reaches a specified threshold.'."\n" + ."\n" + .'- ResourceGroupWaitCount: The number of instances that are waiting for resources in the resource group reaches a specified threshold.', 'type' => 'string', 'example' => 'Error', 'title' => ''], + 'Extension' => [ + 'description' => 'The extended information about the rule. This parameter is required for specific types of alerts.', + 'type' => 'object', + 'properties' => [ + 'Error' => [ + 'description' => 'The configuration for an alert of the Error type.', + 'type' => 'object', + 'properties' => [ + 'StreamTaskIds' => [ + 'description' => 'The IDs of the real-time computing tasks. This parameter is required when you monitor real-time computing tasks.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the real-time computing task.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'AutoRerunAlertEnabled' => ['description' => 'Indicates whether an alert is triggered if a batch synchronization task is automatically rerun upon a failure.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Timeout' => [ + 'description' => 'The configuration for an alert of the Timeout type.', + 'type' => 'object', + 'properties' => [ + 'TimeoutInMinutes' => ['description' => 'The timeout period. Unit: minutes.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'UnFinished' => [ + 'description' => 'The configuration for an alert of the UnFinished type.', + 'type' => 'object', + 'properties' => [ + 'UnFinishedTime' => ['description' => 'The latest completion time of the instance. The period is in the hh:mm format. Valid values of hh: \\[0,47]. Valid values of mm: \\[0,59].', 'type' => 'string', 'example' => '12:00', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'CycleUnfinished' => [ + 'description' => 'The configuration for an alert of the CycleUnfinished type.', + 'type' => 'object', + 'properties' => [ + 'CycleAndTime' => [ + 'description' => 'The configurations of the scheduling cycle and timeout period of the instance.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CycleId' => ['description' => 'The ID of the scheduling cycle of the instance. Valid values: \\[1,288].', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Time' => ['description' => 'The latest completion time of the instance within the scheduling cycle. The time is in the hh:mm format. Valid values of hh: \\[0,47]. Valid values of mm: \\[0,59].', 'type' => 'string', 'example' => '01:00', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'InstanceErrorCount' => [ + 'description' => 'The configuration for an alert of the InstanceErrorCount type.', + 'type' => 'object', + 'properties' => [ + 'Count' => ['description' => 'The maximum number of instances on which an error occurs. Valid values: \\[1,10000].', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'InstanceErrorPercentage' => [ + 'description' => 'The configuration for an alert of the InstanceErrorPercentage type.', + 'type' => 'object', + 'properties' => [ + 'Percentage' => ['description' => 'The maximum percentage of instances on which an error occurs in the workspace to the total number of instances. Valid values: \\[1-100].', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'InstanceTransferFluctuate' => [ + 'description' => 'The configuration for an alert of the InstanceTransferFluctuate type.', + 'type' => 'object', + 'properties' => [ + 'Trend' => ['description' => 'The way in which the number of auto triggered node instances that are generated in your workspace fluctuates. Valid values:'."\n" + ."\n" + .'- abs: the absolute value. The number of instances increases or decreases.'."\n" + ."\n" + .'- increase: The number of instances increases.'."\n" + ."\n" + .'- decrease: The number of instances decreases.', 'type' => 'string', 'example' => 'abs', 'title' => ''], + 'Percentage' => ['description' => 'The maximum percentage of fluctuation in the number of auto triggered node instances that are generated in your workspace. Valid values: \\[1-100].', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'Target' => [ + 'description' => 'The monitored objects.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The type of the monitored objects. Valid values:'."\n" + ."\n" + .'- Task: node'."\n" + ."\n" + .'- Baseline: baseline'."\n" + ."\n" + .'- Project: workspace'."\n" + ."\n" + .'- BizProcess: workflow', 'type' => 'string', 'example' => 'Task', 'title' => ''], + 'Ids' => [ + 'description' => 'The IDs of monitored objects.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the monitored object.', 'type' => 'integer', 'format' => 'int64', 'example' => '32567', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'AllowTasks' => [ + 'description' => 'The nodes that are not to be monitored.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the node that is not to be monitored.', 'type' => 'integer', 'format' => 'int64', 'example' => '123123', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + '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.', - ], - ], - 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 \\"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' => 'Queries the information about a folder.', - ], - 'ListFolders' => [ - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A6C6B486-E3A2-5D52-9E76-D938048****\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 5,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"AlertRules\\": [\\n {\\n \\"Id\\": 22125,\\n \\"Name\\": \\"error_test\\",\\n \\"Owner\\": \\"1933790683****\\",\\n \\"Enabled\\": true,\\n \\"TriggerCondition\\": {\\n \\"Type\\": \\"Error\\",\\n \\"Extension\\": {\\n \\"Error\\": {\\n \\"StreamTaskIds\\": [\\n 123\\n ],\\n \\"AutoRerunAlertEnabled\\": false\\n },\\n \\"Timeout\\": {\\n \\"TimeoutInMinutes\\": 10\\n },\\n \\"UnFinished\\": {\\n \\"UnFinishedTime\\": \\"12:00\\"\\n },\\n \\"CycleUnfinished\\": {\\n \\"CycleAndTime\\": [\\n {\\n \\"CycleId\\": 1,\\n \\"Time\\": \\"01:00\\"\\n }\\n ]\\n },\\n \\"InstanceErrorCount\\": {\\n \\"Count\\": 10\\n },\\n \\"InstanceErrorPercentage\\": {\\n \\"Percentage\\": 10\\n },\\n \\"InstanceTransferFluctuate\\": {\\n \\"Trend\\": \\"abs\\",\\n \\"Percentage\\": 10\\n }\\n },\\n \\"Target\\": {\\n \\"Type\\": \\"Task\\",\\n \\"Ids\\": [\\n 32567\\n ],\\n \\"AllowTasks\\": [\\n 123123\\n ]\\n }\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListAlertRules', + 'changeSet' => [ + ['createdAt' => '2024-12-27T03:06:33.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'ListBusiness' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -22694,1063 +26285,704 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '268609', - 'abilityTreeNodes' => [ - 'FEATUREdide8FM783', - ], + 'abilityTreeCode' => '268605', + 'abilityTreeNodes' => ['FEATUREdide8FM783'], ], '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 specify either this parameter or the ProjectIdentifier parameter to identify the DataWorks workspace when you call this operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '10000', - ], + '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 specify either this parameter or the ProjectIdentifier parameter to identify the DataWorks workspace when you call this operation.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10000', 'title' => ''], ], [ '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 query the workspace name. You must specify either this parameter or the ProjectId parameter to identify the DataWorks workspace when you call this operation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dw_project', - ], + 'schema' => ['description' => 'The name of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace page to query the workspace name. You must specify either this parameter or the ProjectId parameter to identify the DataWorks workspace when you call this operation.', 'type' => 'string', 'required' => false, 'example' => 'dw_project', 'title' => ''], ], [ - 'name' => 'ParentFolderPath', + 'name' => 'PageNumber', 'in' => 'formData', - 'schema' => [ - 'description' => 'The path of the parent folder.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Business_process/my_first_business_process/MaxCompute', - ], + 'schema' => ['description' => 'The requested page number, used for pagination.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'description' => 'The page number of the request. Used for pagination.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'minimum' => '1', - 'example' => '1', - ], + 'schema' => ['description' => 'The number of records per page. Default: 10. Maximum: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '0', 'example' => '10', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'Keyword', 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of records per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '100', - 'minimum' => '0', - 'example' => '10', - ], + 'schema' => ['description' => 'The keyword, used for fuzzy match of workflow names.', 'type' => 'string', 'required' => false, 'example' => 'my', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Responses'."\n", + 'description' => 'Responses.', '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. Used to troubleshoot errors.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-****', - ], - '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: success.'."\n" - .'* false: failure.'."\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. Used for troubleshooting when 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 request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'The list of folders that meet the conditions.'."\n", + 'description' => 'Details of workflows.', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The current page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of records on the current page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of records that meet the query conditions.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '13', - ], - 'Folders' => [ - 'description' => 'The list of folders.'."\n", + 'PageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of records on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of records that meet the query conditions.', 'type' => 'integer', 'format' => 'int32', 'example' => '13', 'title' => ''], + 'Business' => [ + 'description' => 'Information about the workflow list.', 'type' => 'array', 'items' => [ - 'description' => 'The folder details.'."\n", + 'description' => 'Information about the workflow list.', 'type' => 'object', 'properties' => [ - 'FolderPath' => [ - 'description' => 'The folder path.'."\n", - 'type' => 'string', - 'example' => 'Business_process/my_first_business_process/MaxCompute/ods_layer', - ], - 'FolderId' => [ - 'description' => 'The folder ID.'."\n", - 'type' => 'string', - 'example' => '2735c2****', - ], + 'Owner' => ['description' => 'The owner of the workflow.', 'type' => 'string', 'example' => '34824327****', 'title' => ''], + 'Description' => ['description' => 'The description of the workflow.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'ProjectId' => ['description' => 'The ID of the workspace to which the workflow belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'title' => ''], + 'BusinessId' => ['description' => 'The workflow ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '3000001', 'title' => ''], + 'BusinessName' => ['description' => 'The name of the workflow.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'UseType' => ['description' => 'The module to which the workflow belongs. Valid values: NORMAL (Data Studio) and MANUAL\\_BIZ (Manually Triggered Workflow).', 'type' => 'string', 'example' => 'NORMAL', '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.', - ], + ['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 \\"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' => 'Queries a list of folders.', - ], - 'CreateBusiness' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + '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\\": \\"test\\",\\n \\"ProjectId\\": 10000,\\n \\"BusinessId\\": 3000001,\\n \\"BusinessName\\": \\"test\\",\\n \\"UseType\\": \\"NORMAL\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListBusiness', + 'summary' => 'Queries a list of workflows.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'ListCatalogs' => [ + 'summary' => 'Queries a list of catalogs in Data Map. Only catalogs of the Data Lake Formation (DLF) and StarRocks metadata crawler types are supported. For the DLF metadata crawler type, all supported data catalogs are returned. For the StarRocks metadata crawler type, data catalogs in a specific instance are returned.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '268146', - 'abilityTreeNodes' => [ - 'FEATUREdide8FM783', - ], + 'operationType' => 'list', + 'riskType' => 'none', + 'abilityTreeCode' => '267928', + 'abilityTreeNodes' => ['FEATUREdideE9XYA6'], ], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '10000', - ], + 'name' => 'ParentMetaEntityId', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The parent entity ID. For more information, see [Concepts related to metadata entities](~~2880092~~).'."\n" + ."\n" + .'Currently, only the DLF and StarRocks types are supported.'."\n" + ."\n" + .'- For the DLF type, you can query all catalog lists. The format of `ParentMetaEntityId` is `DLF`.'."\n" + ."\n" + .'- For the StarRocks type, you can query the catalogs of a specific instance. The format of `ParentMetaEntityId` `is StarRocks:(instance_id|encoded_jdbc_url)`.'."\n" + ."\n" + .'>
`instance_id`: The instance ID. Required if the data source is registered in instance mode.
'."\n" + .'> `encoded_jdbc_url`: The JDBC connection string encoded with URL encoding. Required if the data source is registered in connection-string mode.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'dlf'], ], [ - 'name' => 'ProjectIdentifier', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'dw_project', - ], + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name. Supports fuzzy matching.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'abc'], ], [ - 'name' => 'BusinessName', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'My business process', - ], + 'name' => 'Comment', + 'in' => 'query', + 'schema' => ['description' => 'The comment. Supports token-based matching.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'this is a comment'], ], [ - 'name' => 'Description', - 'in' => 'formData', + 'name' => 'Types', + 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'title' => '', + 'description' => 'The type. Supports exact match. If left empty, all types are queried.', + 'type' => 'array', + 'items' => ['description' => 'The catalog type.', 'type' => 'string', 'required' => false, 'example' => 'HIVE', 'title' => ''], 'required' => false, - 'example' => 'test', + 'example' => '', ], ], [ - 'name' => 'Owner', - 'in' => 'formData', + 'name' => 'SortBy', + 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The sort field. Default value: CreateTime. Valid values:'."\n" + ."\n" + .'- CreateTime'."\n" + ."\n" + .'- ModifyTime'."\n" + ."\n" + .'- Name'."\n" + ."\n" + .'- Type', 'type' => 'string', + 'example' => 'CreateTime', + 'pattern' => '^[\\w.,;/@-]+$', + 'default' => 'CreateTime', + 'enum' => ['CreateTime', 'ModifyTime', 'Name', 'Type'], + 'title' => '', 'required' => false, - 'example' => '1000000000001', ], ], [ - 'name' => 'UseType', - 'in' => 'formData', + 'name' => 'Order', + 'in' => 'query', 'schema' => [ - 'description' => '', + 'description' => 'The order in which the tables are sorted. Default value: Asc. Valid values:'."\n" + ."\n" + .'- Asc: ascending order.'."\n" + ."\n" + .'- Desc: descending order.', 'type' => 'string', 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [], - 'example' => 'NORMAL', - 'default' => 'NORMAL', - 'enum' => [ - 'NORMAL', - 'MANUAL_BIZ', - ], + 'example' => 'Asc', + 'default' => 'Asc', + 'enum' => ['Asc', 'Desc'], + 'title' => '', ], ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '1', 'default' => '1', 'title' => '', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of records per page. Default value: 10. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10', 'title' => '', 'required' => false], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => '', + 'title' => 'Schema of Response', + 'description' => 'Responses.', 'type' => 'object', 'properties' => [ - 'HttpStatusCode' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'ErrorMessage' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'The connection does not exist.', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'ErrorCode' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'BusinessId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100001', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '317CD7D0-AB36-XXXXXX'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'PagingInfo' => [ + 'title' => '', + 'description' => 'The pagination result.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'Catalogs' => [ + 'description' => 'The catalog.', + 'type' => 'array', + 'items' => ['description' => 'The catalog details.', '$ref' => '#/components/schemas/Catalog', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', + ], + ], + '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.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"317CD7D0-AB36-XXXXXX\\",\\n \\"Success\\": true,\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Catalogs\\": [\\n {\\n \\"Id\\": \\"dlf-catalog:123456XXX:test_catalog\\\\nstarrocks-catalog:c-abc123xxx:default_catalog\\",\\n \\"Name\\": \\"default_catalog\\",\\n \\"Comment\\": \\"this is a comment\\\\n\\",\\n \\"Type\\": \\"Internal\\",\\n \\"CreateTime\\": 1722073854000,\\n \\"ModifyTime\\": 1722073854000,\\n \\"ParentMetaEntityId\\": \\"dlf\\\\nstarrocks:c-abc123xxx\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListCatalogs', + 'description' => '1. DataWorks Basic Edition or a higher edition is required.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:ListCatalogs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - '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"}]', - 'title' => 'CreateBusiness', - 'summary' => 'Creates a workflow in DataStudio.', ], - 'DeleteBusiness' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListCertificates' => [ + 'summary' => 'Retrieves a list of certificate files.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '268604', - 'abilityTreeNodes' => [ - 'FEATUREdide8FM783', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '250939', + 'abilityTreeNodes' => ['FEATUREdideRWC5F7'], ], '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 specify either this parameter or the ProjectIdentifier parameter to identify the DataWorks workspace when you call this operation.'."\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 page to query the workspace name. You must specify either this parameter or the ProjectId parameter to identify the DataWorks workspace when you call this operation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dw_project', - ], + 'in' => 'query', + 'schema' => ['description' => 'The ID of the workspace to which the certificate file belongs.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '10000'], ], [ - 'name' => 'BusinessId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The workflow ID. You can call the [ListBusiness](~~173945~~) operation to query the ID of a workflow by name.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1000001', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'Responses'."\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. Used to troubleshoot issues when an error occurs.'."\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. Valid values:'."\n" - ."\n" - .'* true: success.'."\n" - .'* false: failure.'."\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.', - ], + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '10'], ], - ], - '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' => 'DeleteBusiness', - 'summary' => 'Deletes a workflow.', - ], - 'UpdateBusiness' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '268602', - 'abilityTreeNodes' => [ - 'FEATUREdide8FM783', + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'required' => false, 'example' => '1'], ], - ], - 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://dataworks.console.aliyun.com/workspace/list) and go to the Workspace 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' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the certificate file. Fuzzy match by file name is supported.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'xm_create_test'], ], [ - 'name' => 'ProjectIdentifier', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the DataWorks workspace. You can log on to the [DataWorks console](https://dataworks.console.aliyun.com/workspace/list) and go to the Workspace page to obtain the 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' => 'CreateUser', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the user who created the certificate files.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '1107550004253538'], ], [ - 'name' => 'BusinessName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the workflow.'."\n" - ."\n" - .'You can call the [ListBusiness](~~173945~~) operation to query the name.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'MyBusiness', - ], + 'name' => 'StartCreateTime', + 'in' => 'query', + 'schema' => ['description' => 'The time when the certificate file was created. You can call this operation to query the files that are created after the time. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '1730217600000'], ], [ - 'name' => 'Description', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The description of the workflow.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'modified from my first business', - ], + 'name' => 'EndCreateTime', + 'in' => 'query', + 'schema' => ['description' => 'The time when the certificate file was created. You can call this operation to query the files that are created before the time. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '1593877765000'], ], [ - 'name' => 'Owner', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The owner of the workflow.'."\n" - ."\n" - .'You can call the [ListBusiness](~~173945~~) operation to query the owner.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '348428****', - ], + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => ['description' => 'The field used to sort the certificate files. Valid values: CreateTime Id Name Default value: Id', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'Id'], ], [ - 'name' => 'BusinessId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The workflow ID.'."\n" - ."\n" - .'You can call the [ListBusiness](~~173945~~) operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '300000', - ], + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => 'The order in which you want to sort the certificate files. Valid values: Desc: descending order ASC: ascending order Default value: Asc', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'Asc'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + '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' => '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. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'ecb967ec-c137-48****', 'title' => ''], + 'PagingInfo' => [ + 'description' => 'The pagination information.', + 'type' => 'object', + 'properties' => [ + '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' => '100', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Certificates' => [ + 'title' => '', + 'description' => 'The certificate files.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the certificate file.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the certificate file.', 'type' => 'integer', 'format' => 'int64', 'example' => '676303114031776', 'title' => ''], + 'Name' => ['description' => 'The name of the certificate file.', 'type' => 'string', 'example' => 'ca1.crt', 'title' => ''], + 'CreateUser' => ['description' => 'The ID of the user who created the certificate file.', 'type' => 'string', 'example' => '1107550004253538', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the certificate file was created. This value is a UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1730217600000', 'title' => ''], + 'FileSizeInBytes' => ['description' => 'The size of the certificate file, in bytes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1024', 'title' => ''], + 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'This is a file', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + '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.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ecb967ec-c137-48****\\",\\n \\"PagingInfo\\": {\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"Certificates\\": [\\n {\\n \\"Id\\": 676303114031776,\\n \\"Name\\": \\"ca1.crt\\",\\n \\"CreateUser\\": \\"1107550004253538\\",\\n \\"CreateTime\\": 1730217600000,\\n \\"FileSizeInBytes\\": 1024,\\n \\"Description\\": \\"This is a file\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListCertificates', + 'description' => '1. This API operation is available for all DataWorks editions.'."\n" + ."\n" + .'2. You can call this operation only if you are assigned one of the following roles in DataWorks: Tenant Owner, Workspace Administrator, Deploy, Develop, Visitor, Workspace Owner, O\\&M, Model Designer, Security Administrator, Data Analyst, OpenPlatform Administrator, and Data Governance Administrator.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:ListCertificates', + '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}","type":"json"}]', - 'title' => 'UpdateBusiness', - 'summary' => 'Updates a workflow.', ], - 'GetBusiness' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListColumns' => [ + 'summary' => 'Queries the column list of a specified data table in DataWorks Data Map.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '268608', - 'abilityTreeNodes' => [ - 'FEATUREdide8FM783', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '267999', + 'abilityTreeNodes' => ['FEATUREdideE9XYA6'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'TableId', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['title' => '', 'description' => 'The ID of the data table. You can obtain the ID from the response of the ListTables operation. For more information, see [Metadata entity concepts](~~2880092~~).', 'type' => 'string', 'required' => true, 'example' => 'maxcompute-table:::project_name:[schema_name]:table_name'], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The name. Fuzzy match is supported.', 'type' => 'string', 'required' => false, 'example' => 'test_table'], + ], + [ + 'name' => 'Comment', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The comment. Fuzzy match is supported.', 'type' => 'string', 'required' => false, 'example' => 'test comment'], ], - ], - 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'formData', + 'name' => 'SortBy', + 'in' => 'query', '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 specify either this parameter or the ProjectIdentifier parameter to identify the DataWorks workspace when you call this operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'title' => '', + 'description' => 'The sort field. Default value: Position. Valid values:'."\n" + .'- Name: name'."\n" + .'- Position: position', + 'type' => 'string', + 'example' => 'Position', + 'default' => 'Position', + 'enum' => ['Name', 'Position'], 'required' => false, - 'docRequired' => false, - 'example' => '10000', ], ], [ - 'name' => 'ProjectIdentifier', - 'in' => 'formData', + 'name' => 'Order', + 'in' => 'query', 'schema' => [ - 'description' => 'The name of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace page to query the workspace name. You must specify either this parameter or the ProjectId parameter to identify the DataWorks workspace when you call this operation.'."\n", + 'title' => '', + 'description' => 'The sort order. Default value: Asc. Valid values:'."\n" + .'- Asc: ascending order'."\n" + .'- Desc: descending order', 'type' => 'string', 'required' => false, - 'example' => 'dw_project', + 'example' => 'Asc', + 'default' => 'Asc', + 'enum' => ['Asc', 'Desc'], ], ], [ - 'name' => 'BusinessId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The workflow ID. You can call the [ListBusiness](~~173945~~) operation to obtain the folder ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1000000111', - ], + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '1', 'default' => '1', 'required' => false, 'example' => '1'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10', 'required' => false], + ], + [ + 'name' => 'IncludeExtendedProperties', + 'in' => 'query', + 'schema' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Responses.'."\n", + 'title' => '', + 'description' => 'The response.', '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. Used for troubleshooting when an error occurs.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Success' => [ - 'description' => 'Indicates whether the call was successful. Valid values:'."\n" - ."\n" - .'* true: success.'."\n" - .'* false: failure.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'Details of the workflow.'."\n", + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'PagingInfo' => [ + 'title' => '', + 'description' => 'The paging result.', '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 where the workflow resides.'."\n", - 'type' => 'string', - 'example' => '10000', - ], - 'BusinessId' => [ - 'description' => 'The workflow ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000001', - ], - 'BusinessName' => [ - 'description' => 'The name of the workflow. Workflow names must be unique within the same workspace.'."\n", - 'type' => 'string', - 'example' => 'The first business process', - ], - 'UseType' => [ - 'description' => 'The functional module to which the workflow belongs. Valid values: NORMAL (Data Studio) and MANUAL_BIZ (Manually Triggered Workflow)'."\n", - 'type' => 'string', - 'example' => 'NORMAL', + 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', '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' => ''], + 'Columns' => [ + 'description' => 'The list of columns.', + 'type' => 'array', + 'items' => ['description' => 'The column information.', '$ref' => '#/components/schemas/Column', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], ], + '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.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query columns of a data table in data map', + 'description' => '1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:ListColumns', + '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 \\"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"}]', - 'title' => 'GetBusiness', - 'summary' => 'Queries the information about a workflow.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx\\",\\n \\"Success\\": true,\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Columns\\": [\\n {\\n \\"Id\\": \\"maxcompute-column:::project_name:[schema_name]:table_name:column_name\\",\\n \\"Name\\": \\"column_name\\",\\n \\"Comment\\": \\"字段1\\",\\n \\"TableId\\": \\"maxcompute-table:::project_name:[schema_name]:table_name\\",\\n \\"Position\\": 1,\\n \\"Type\\": \\"bigint\\",\\n \\"PrimaryKey\\": false,\\n \\"PartitionKey\\": false,\\n \\"ForeignKey\\": false,\\n \\"BusinessMetadata\\": {\\n \\"Description\\": \\"字段1的业务描述\\",\\n \\"CustomAttributes\\": {\\n \\"key\\": [\\n \\"张三\\"\\n ]\\n }\\n },\\n \\"StatisticsInfos\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', ], - 'ListBusiness' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListComponents' => [ + 'summary' => 'Retrieves a list of components.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'consumes' => ['application/json'], + 'produces' => ['application/json'], 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '268605', - 'abilityTreeNodes' => [ - 'FEATUREdide8FM783', - ], + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236015', + 'abilityTreeNodes' => ['FEATUREdideITYNXL'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], '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 specify either this parameter or the ProjectIdentifier parameter to identify the DataWorks workspace when you call this operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '10000', - ], + 'in' => 'query', + 'schema' => ['description' => 'The ID of the workspace associated with the data source. You can call the [ListProjects](~~178393~~) operation to obtain the workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100001', 'title' => ''], ], [ - '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 query the workspace name. You must specify either this parameter or the ProjectId parameter to identify the DataWorks workspace when you call this operation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dw_project', - ], + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the data source.', 'type' => 'string', 'required' => false, 'example' => 'xm_create_test', 'title' => ''], ], [ 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The requested page number, used for pagination.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'minimum' => '1', - 'example' => '1', - ], + 'in' => 'query', + 'schema' => ['description' => 'The page number for pagination.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '2147483647', 'minimum' => '1', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of records per page. Default: 10. Maximum: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '100', - 'minimum' => '0', - 'example' => '10', - ], - ], - [ - 'name' => 'Keyword', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The keyword, used for fuzzy match of workflow names.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'my', - ], + 'in' => 'query', + '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' => '1000', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Responses.'."\n", + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', '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. Used for troubleshooting when an error occurs.'."\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', - ], - 'Data' => [ - 'description' => 'Details of workflows.'."\n", + 'RequestId' => ['description' => 'The request ID. Use this ID for troubleshooting.', 'type' => 'string', 'example' => '952795279527ab****', 'title' => ''], + 'PagingInfo' => [ + 'description' => 'The pagination information.', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The current page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of records on the current page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of records that meet the query conditions.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '13', - ], - 'Business' => [ - 'description' => 'Information about the workflow list.'."\n", + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', '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' => ''], + 'Components' => [ + 'description' => 'The UID of the user who created the dataset acceleration component. In Alibaba Cloud, this is the RAM user ID (or the Alibaba Cloud account ID if created by the account itself).', 'type' => 'array', 'items' => [ - 'description' => 'Information about the workflow list.'."\n", + 'description' => 'The UID of the user who created the dataset acceleration component. In Alibaba Cloud, this is the RAM user ID (or the Alibaba Cloud account ID if created by the account itself).', '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' => 'test', - ], - 'ProjectId' => [ - 'description' => 'The ID of the workspace to which the workflow belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000', - ], - 'BusinessId' => [ - 'description' => 'The workflow ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3000001', + 'ModifyTime' => ['description' => 'The timestamp when the publishing process was modified.', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '2023-11-30T13:30:58Z', 'title' => ''], + 'Script' => [ + 'title' => '', + 'description' => 'The script information.', + 'type' => 'object', + 'properties' => [ + 'Path' => ['description' => 'The script path.', 'type' => 'string', 'pattern' => '', 'default' => '', 'title' => '', 'example' => '/'], + 'Runtime' => [ + 'title' => '', + 'description' => 'The runtime.', + 'type' => 'object', + 'properties' => [ + 'Command' => ['description' => 'The command.', 'type' => 'string', 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'SQL_COMPONENT'], + ], + 'example' => '', + ], + 'Id' => ['description' => 'ID', 'type' => 'string', 'example' => '348100', 'title' => ''], + ], + 'example' => '', ], - 'BusinessName' => [ - 'description' => 'The name of the workflow.'."\n", - 'type' => 'string', - 'example' => 'test', + 'Owner' => ['description' => 'The owner.', 'type' => 'string', 'pattern' => '', 'default' => '', 'title' => '', 'example' => '252675537980665607'], + 'Description' => ['description' => 'The description.', 'type' => 'string', 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'vpc peering management_staging'], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'format' => 'iso8601_normal', 'example' => '2023-03-13 16:35:59', 'title' => ''], + 'Outputs' => [ + 'title' => '', + 'description' => 'The output parameters.', + 'type' => 'array', + 'items' => [ + 'description' => 'The node output.', + 'type' => 'object', + 'properties' => [ + 'DefaultValue' => ['description' => 'The default value.', 'type' => 'string', 'pattern' => '', 'default' => '', 'title' => '', 'example' => '32000'], + 'Type' => ['description' => 'The parameter type.', 'type' => 'string', 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'string'], + 'Description' => ['description' => 'The parameter description.', 'type' => 'string', 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'zdy'], + 'Name' => ['description' => 'The parameter name.', 'type' => 'string', 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'auto_updateAlertRule_test_bULIRo'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', ], - 'UseType' => [ - 'description' => 'The module to which the workflow belongs. Valid values: NORMAL (Data Studio) and MANUAL_BIZ (Manually Triggered Workflow).'."\n", - 'type' => 'string', - 'example' => 'NORMAL', + 'ProjectId' => ['description' => 'The DataWorks workspace ID. To obtain the workspace ID, log on to the DataWorks console and navigate to the workspace configuration page. You must specify either this parameter or ProjectIdentifier to identify the target DataWorks workspace for this API call.', 'type' => 'integer', 'format' => 'int64', 'example' => '199925', 'title' => ''], + 'ComponentId' => ['description' => 'The component ID. This parameter can be used in requests to query, modify, or delete director components.', 'type' => 'string', 'example' => '12312313123', 'title' => ''], + 'Inputs' => [ + 'title' => '', + 'description' => 'The input parameters.', + 'type' => 'array', + 'items' => [ + 'description' => 'The variable element.', + 'type' => 'object', + 'properties' => [ + 'DefaultValue' => ['description' => 'The default value of the variable.', 'type' => 'string', 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'mdb.shard.2x.2xlarge.d'], + 'Type' => ['description' => 'The parameter type.', 'type' => 'string', 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'string'], + 'Description' => ['description' => 'The parameter description.', 'type' => 'string', 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'None'], + 'Name' => ['description' => 'The parameter name.', 'type' => 'string', 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'auto_updateAlertRule_test_bULIRo'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', ], + 'Name' => ['description' => 'The resource name.', 'type' => 'string', 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'auto_updateAlertRule_test_lJd81f'], ], + '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.', - ], - ], - 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'], + 'title' => 'ListComponents', + 'description' => 'You must purchase DataWorks Basic Edition or a higher edition to use this feature.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:ListComponents', + '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 \\"Business\\": [\\n {\\n \\"Owner\\": \\"34824327****\\",\\n \\"Description\\": \\"test\\",\\n \\"ProjectId\\": 10000,\\n \\"BusinessId\\": 3000001,\\n \\"BusinessName\\": \\"test\\",\\n \\"UseType\\": \\"NORMAL\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListBusiness', - 'summary' => 'Queries a list of workflows.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"952795279527ab****\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Components\\": [\\n {\\n \\"ModifyTime\\": \\"2023-11-30T13:30:58Z\\",\\n \\"Script\\": {\\n \\"Path\\": \\"/\\",\\n \\"Runtime\\": {\\n \\"Command\\": \\"SQL_COMPONENT\\"\\n },\\n \\"Id\\": \\"348100\\"\\n },\\n \\"Owner\\": \\"252675537980665607\\",\\n \\"Description\\": \\"vpc peering management_staging\\",\\n \\"CreateTime\\": \\"2023-03-13 16:35:59\\",\\n \\"Outputs\\": [\\n {\\n \\"DefaultValue\\": \\"32000\\",\\n \\"Type\\": \\"string\\",\\n \\"Description\\": \\"zdy\\",\\n \\"Name\\": \\"auto_updateAlertRule_test_bULIRo\\"\\n }\\n ],\\n \\"ProjectId\\": 199925,\\n \\"ComponentId\\": \\"12312313123\\",\\n \\"Inputs\\": [\\n {\\n \\"DefaultValue\\": \\"mdb.shard.2x.2xlarge.d\\",\\n \\"Type\\": \\"string\\",\\n \\"Description\\": \\"None\\",\\n \\"Name\\": \\"auto_updateAlertRule_test_bULIRo\\"\\n }\\n ],\\n \\"Name\\": \\"auto_updateAlertRule_test_lJd81f\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], - 'GetDeploymentPackage' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListComputeResources' => [ + 'summary' => 'Queries the list of computing resources that meet the specified business information.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -23760,504 +26992,360 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '269309', - 'abilityTreeNodes' => [ - 'FEATUREdide8FM783', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '232439', + 'abilityTreeNodes' => ['FEATUREdideRWC5F7'], ], '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 ID. This parameter identifies the DataWorks workspace for this API call.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '10000', - ], + 'in' => 'query', + 'schema' => ['description' => 'The ID of the DataWorks workspace.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '21229', 'title' => ''], ], [ - 'name' => 'ProjectIdentifier', - 'in' => 'formData', + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the computing resource.', 'type' => 'string', 'required' => false, 'example' => 'category name ', 'title' => ''], + ], + [ + 'name' => 'Types', + 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => 'The unique identifier of the DataWorks workspace. This is the identifier shown in the workspace switcher at the top of the Data Studio page.'."\n" - ."\n" - .'Either this parameter or ProjectId must be specified to determine which DataWorks workspace this API call operates on.'."\n", - 'type' => 'string', + 'description' => 'The filter for computing resource types. You can configure multiple types for filtering.', + 'type' => 'array', + 'items' => ['description' => 'The type of the computing resource.', 'type' => 'string', 'required' => false, 'example' => 'hologres', 'title' => ''], 'required' => false, - 'example' => 'dw_project', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'DeploymentId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The deployment package ID. This ID is generated when you call [SubmitFile](~~173944~~) or [DeployFile](~~173956~~).'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1000000001', - ], + 'name' => 'EnvType', + 'in' => 'query', + 'schema' => ['description' => 'The environment type of the computing resource. Valid values:'."\n" + ."\n" + .'- Dev'."\n" + ."\n" + .'- Prod', 'type' => 'string', 'required' => false, 'example' => 'Dev', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number to query. The default value is 1, which indicates the first page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. The default value is 10, and the maximum value is 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => ['description' => 'The field to sort the computing resource list by. Supported fields include name, creation time, and computing resource ID.'."\n" + ."\n" + .'- CreateTime: Sorts by creation time'."\n" + ."\n" + .'- Id: Sorts by computing resource ID'."\n" + ."\n" + .'- Name: Sorts by computing resource name.'."\n" + ."\n" + .'- CreateTimeWithDefaultFirst: Sorts based on whether it is the default resource and by creation time, with the default computing resource listed first.'."\n" + ."\n" + .'Default value: CreateTime', 'type' => 'string', 'required' => false, 'example' => 'CreateTimeWithDefaultFirst', 'title' => ''], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => 'The sort direction of the computing resource list. Valid values:'."\n" + ."\n" + .'- Desc: descending order.'."\n" + ."\n" + .'- Asc: ascending order.'."\n" + ."\n" + .'Default value: Desc', 'type' => 'string', 'required' => false, 'example' => 'Asc', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response.'."\n", + 'title' => 'Schema of Response', + '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' => 'You have no permission.', - ], - 'RequestId' => [ - 'description' => 'The request ID. Use this ID to locate logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '0bc1ec92159376****', - ], - 'ErrorCode' => [ - 'description' => 'The error code.'."\n", - 'type' => 'string', - 'example' => 'Invalid.Tenant.ConnectionNotExists', - ], - 'Success' => [ - 'description' => 'Indicates whether the call succeeded. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The deployment package details.'."\n", + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID. Used to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => '7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX'], + 'PagingInfo' => [ + 'description' => 'Pagination information.', 'type' => 'object', 'properties' => [ - 'Deployment' => [ - 'description' => 'The deployment package details.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The current status of the deployment package. Valid values: 0 (ready), 1 (succeeded), and 2 (failed).'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ErrorMessage' => [ - 'description' => 'The detailed error message when the deployment package fails (status is 2).'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'FromEnvironment' => [ - 'description' => 'The environment where the deployment is executed. Valid values: 0 (local) and 1 (development).'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ToEnvironment' => [ - 'description' => 'The target environment for the deployment. Valid values: 1 (development) and 2 (production).'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'CheckingStatus' => [ - 'description' => 'The validation status of nodes in the deployment package. For packages deployed to the development environment (toEnviroment=1), you can only proceed to deploy to production if the package Status is 1 (succeeded) and CheckingStatus is empty (validation complete).'."\n" - ."\n" - .'* 7: Validation failed'."\n" - .'* 8: Validation in progress'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7', - ], - 'CreateTime' => [ - 'description' => 'The timestamp (in milliseconds) when the deployment package was created.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1593877765000', - ], - 'HandlerId' => [ - 'description' => 'The Alibaba Cloud account ID of the user who executed the deployment.'."\n", - 'type' => 'string', - 'example' => '2003****', - ], - 'CreatorId' => [ - 'description' => 'The Alibaba Cloud account ID of the user who created the deployment package.'."\n", - 'type' => 'string', - 'example' => '20030****', - ], - 'ExecuteTime' => [ - 'description' => 'The timestamp (in milliseconds) when the deployment started.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1593877765000', - ], - 'Name' => [ - 'description' => 'The deployment package name, displayed on the Deploy Center > Deployment Packages page.'."\n", - 'type' => 'string', - 'example' => 'ods_user_info_d-2020-07-04_20030****', - ], - ], - ], - 'DeployedItems' => [ - 'description' => 'The deployment item details.'."\n", + 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'PageSize' => ['description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'PageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'ComputeResources' => [ + 'description' => 'The list of computing resources. Each element is a computing resource group that contains information about the development environment (if any) and the production environment.', 'type' => 'array', 'items' => [ - 'description' => 'The deployment item details.'."\n", + 'description' => 'Information about the computing resource group, which includes computing resources for the development environment (if any) and the production environment. The computing resources for the development and production environments have the same name and type but different IDs.', 'type' => 'object', 'properties' => [ - 'FileId' => [ - 'description' => 'The file ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5076****', - ], - 'FileVersion' => [ - 'description' => 'The file version.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '7', - ], - 'Status' => [ - 'description' => '* UNPUBLISHED(0)'."\n" - .'* SUCCESS(1)'."\n" - .'* ERROR(2)'."\n" - .'* CLONED(3)'."\n" - .'* DEPLOY_ERROR(4)'."\n" - .'* CLONING(5)'."\n" - .'* REJECT(6)'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + 'Name' => ['description' => 'The name of the computing resource.', 'type' => 'string', 'example' => 'cal_all_vemg_workflow_parallel', 'title' => ''], + 'Type' => ['description' => 'The type of the computing resource.', 'type' => 'string', 'example' => 'hologres', 'title' => ''], + 'ComputeResource' => [ + 'description' => 'Details of a single computing resource.', + 'type' => 'array', + 'items' => [ + 'description' => 'Details of a single computing resource.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The computing resource ID, which is the unique identifier for the resource.', 'type' => 'integer', 'format' => 'int64', 'example' => '8649832502405358603', 'title' => ''], + 'ConnectionProperties' => ['description' => 'The category of the added compute resource. Different types have different subtypes with corresponding parameter constraints. Examples: InstanceMode: The instance mode. UrlMode: The connection string mode.', 'type' => 'any', 'example' => '{\\n \\"clusterIdentifier\\": \\"c-da123456\\",\\n \\"database\\": \\"testdb\\",\\n \\"loginMode\\":\\"Anonymous\\",\\n \\"defaultFS\\":\\"127.0.0.1\\",\\n \\"envType\\": \\"Prod\\"\\n}', 'title' => ''], + 'ConnectionPropertiesMode' => ['description' => 'The specific connection configuration details for the computing resource, including the connection address, access identity, and environment information. envType, which specifies the computing resource environment, is a property of this object. Valid values:'."\n" + ."\n" + .'- Dev'."\n" + ."\n" + .'- Prod Different types of computing resources have different attribute specifications under different configuration modes (ConnectionPropertiesMode).', 'type' => 'string', 'example' => 'UrlMode', 'title' => ''], + 'Description' => ['description' => 'The unique identifier of the computing resource.', 'type' => 'string', 'example' => 'home_feed', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time (timestamp).', 'type' => 'integer', 'format' => 'int64', 'example' => '1624387842781448', 'title' => ''], + 'CreateUser' => ['description' => 'The creator ID.', 'type' => 'string', 'example' => '1648711113000', 'title' => ''], + 'ModifyTime' => ['description' => 'The last modified time of the computing resource (timestamp).', 'type' => 'integer', 'format' => 'int64', 'example' => '1624387842781448', 'title' => ''], + 'ModifyUser' => ['description' => 'The modifier ID.', 'type' => 'string', 'example' => '1648711113000', 'title' => ''], + 'WhetherDefault' => ['description' => 'Specifies whether it is the default compute resource.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + '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.', - ], - ], - 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'], + 'title' => 'ListComputeResources', + 'description' => '1. DataWorks Basic Edition or a more advanced edition is required.'."\n" + ."\n" + .'2. You must have at least one of the following roles in the DataWorks workspace:'."\n" + ."\n" + .'3. Tenant Owner, Workspace Administrator, Deploy, Developer, Visitor, Project Owner, O\\&M, Model Designer, Security Administrator, Data Analyst, Development Platform Administrator, Data Governance Administrator', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:ListComputeResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"You have no permission.\\",\\n \\"RequestId\\": \\"0bc1ec92159376****\\",\\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"}]', - 'title' => 'GetDeploymentPackage', - 'summary' => 'Queries the information about a deployment package.', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 100,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"ComputeResources\\": [\\n {\\n \\"Name\\": \\"cal_all_vemg_workflow_parallel\\",\\n \\"Type\\": \\"hologres\\",\\n \\"ComputeResource\\": [\\n {\\n \\"Id\\": 8649832502405359000,\\n \\"ConnectionProperties\\": \\"{\\\\\\\\n \\\\\\\\\\\\\\"clusterIdentifier\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"c-da123456\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"database\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"testdb\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"loginMode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"Anonymous\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"defaultFS\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"127.0.0.1\\\\\\\\\\\\\\",\\\\\\\\n \\\\\\\\\\\\\\"envType\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"Prod\\\\\\\\\\\\\\"\\\\\\\\n}\\",\\n \\"ConnectionPropertiesMode\\": \\"UrlMode\\",\\n \\"Description\\": \\"home_feed\\",\\n \\"CreateTime\\": 1624387842781448,\\n \\"CreateUser\\": \\"1648711113000\\",\\n \\"ModifyTime\\": 1624387842781448,\\n \\"ModifyUser\\": \\"1648711113000\\",\\n \\"WhetherDefault\\": true\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', ], - 'ListDeploymentPackages' => [ - 'summary' => 'Queries a list of deployment packages.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListCrawlerTypes' => [ + 'summary' => 'Queries a list of metadata crawler types supported in Data Map. The subtypes of the types and the hierarchical relationship between the subtypes are also returned.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', - 'abilityTreeCode' => '269317', - 'abilityTreeNodes' => [ - 'FEATUREdide8FM783', - ], - 'tenantRelevance' => 'tenant', + 'riskType' => 'none', + 'abilityTreeCode' => '268429', + 'abilityTreeNodes' => ['FEATUREdideE9XYA6'], + 'tenantRelevance' => 'publicInformation', ], - 'parameters' => [ - [ - 'name' => 'ProjectIdentifier', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The unique identifier of the DataWorks workspace, which is the identifier at the top of the Data Studio page where you switch workspaces. Either this parameter or ProjectId must be specified to determine which DataWorks workspace this API call operates on.'."\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 and go to the workspace configuration 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, - 'example' => '10003', - ], - ], - [ - 'name' => 'Creator', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The Alibaba Cloud account ID of the deployment package creator.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '110755000425****', - ], - ], - [ - 'name' => 'EndCreateTime', - 'in' => 'formData', + 'parameters' => [], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The maximum millisecond timestamp for when the deployment package was created.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1593877765000', + 'title' => 'Schema of Response', + 'description' => 'The response.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0000-ABCD-EFG****'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'CrawlerTypes' => [ + 'title' => '', + 'description' => 'The list of metadata crawler types.', + 'type' => 'array', + 'items' => ['description' => 'Information about supported metadata crawler types.', '$ref' => '#/components/schemas/CrawlerType', 'title' => '', 'example' => ''], + 'example' => '', + ], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"Success\\": true,\\n \\"CrawlerTypes\\": [\\n {\\n \\"Type\\": \\"dlf\\",\\n \\"DisplayName\\": \\"Data Lake Formation\\",\\n \\"SupportedEntityTypes\\": [\\n {\\n \\"Type\\": \\"dlf-table\\",\\n \\"SubType\\": \\"table\\",\\n \\"Optional\\": true,\\n \\"ParentSubType\\": \\"database\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListCrawlerTypes', + 'description' => '1. DataWorks Basic Edition or a higher edition is required.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'Executor', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The Alibaba Cloud account ID of the deployment package executor.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2003****', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:ListCrawlerTypes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'ListCustomAgents' => [ + 'summary' => 'Retrieves a paginated list of custom agents.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'EndExecuteTime', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The maximum millisecond timestamp for when the deployment package started executing.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1593877765000', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => 'TBD', + 'abilityTreeNodes' => ['FEATUREdideYTM537'], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ [ - 'name' => 'Status', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The status of the deployment package. Valid values:'."\n" - ."\n" - .'* 0: It is ready.'."\n" - .'* 1: It was successfully deployed.'."\n" - .'* 2: It failed to be deployed.'."\n" - .'* 6: It was rejected.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of entries to return on a single page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], [ - 'name' => 'Keyword', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The keyword in the deployment package name. DataWorks supports fuzzy matching, meaning you can enter a keyword to query for deployment packages that contain it.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'The pagination token. Omit this parameter for the first request. For subsequent requests, use the `NextToken` value from the previous response to retrieve the next page.', 'type' => 'string', 'required' => false, 'example' => '12345', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'Q', 'in' => 'formData', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The search keyword for a fuzzy match by agent name.', 'type' => 'string', 'required' => false, 'example' => 'analysis', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'Visibility', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The number of records per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'type' => 'array', + 'items' => [ + 'description' => 'The visibility level.', + 'type' => 'string', + 'enum' => ['TENANT', 'PROJECT', 'USER'], + 'required' => false, + 'example' => 'TENANT', + 'title' => '', + ], + 'description' => 'Filters the results by visibility level. You can specify multiple levels.', 'required' => false, - 'maximum' => '100', - 'example' => '10', + 'example' => '-', + 'title' => '', ], ], ], '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' => '952795279527ab****', - ], - 'Data' => [ - 'description' => 'The list of deployment packages that meet the query conditions.'."\n", + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '824F80BA-1778-5D8A-BAFF-668A4D9C4CC7'], + 'PagingInfo' => [ 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of records per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of records that meet the conditions.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'Deployments' => [ - 'description' => 'The returned list of deployment packages.'."\n", + 'TotalCount' => ['description' => 'The total number of entries that meet the filter criteria.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'MaxResults' => ['description' => 'The maximum number of entries returned in this response.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'NextToken' => ['description' => 'The token to retrieve the next page of results. This parameter is empty when there are no more results to return.', 'type' => 'string', 'example' => '5', 'title' => ''], + 'Agents' => [ 'type' => 'array', 'items' => [ - 'description' => 'The detailed information of the deployment package.'."\n", 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The status of the deployment package. Valid values:'."\n" - ."\n" - .'* 0: It is ready.'."\n" - .'* 1: It was successfully deployed.'."\n" - .'* 2: It failed to be deployed.'."\n" - .'* 6: It was rejected.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ErrorMessage' => [ - 'description' => 'When the deployment package fails to execute, this parameter is used to record the error message.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'CreateTime' => [ - 'description' => 'The timestamp when the deployment package was created.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1593877765000', - ], - 'Executor' => [ - 'description' => 'The Alibaba Cloud account ID of the deployment package executor.'."\n", - 'type' => 'string', - 'example' => '2003****', - ], - 'Creator' => [ - 'description' => 'The Alibaba Cloud account ID of the deployment package creator.'."\n", - 'type' => 'string', - 'example' => '2003****', - ], - 'ExecuteTime' => [ - 'description' => 'The timestamp when the deployment package was executed.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1593877765000', - ], - 'Name' => [ - 'description' => 'The name of the deployment package.'."\n", - 'type' => 'string', - 'example' => 'auto_created', - ], - 'Id' => [ - 'description' => 'The ID of the deployment package. You can use this ID to call the [GetDeployment](~~173950~~) operation to get the deployment package details.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '11111', - ], - ], + 'Name' => ['description' => 'The name of the custom agent.', 'type' => 'string', 'example' => 'my-agent', 'title' => ''], + 'DisplayName' => ['description' => 'The display name of the custom agent.', 'type' => 'string', 'example' => '我的助手', 'title' => ''], + 'Description' => ['description' => 'A description of the custom agent.', 'type' => 'string', 'example' => '数据分析助手', 'title' => ''], + 'CreatorId' => ['description' => 'The ID of the user who created the agent.', 'type' => 'string', 'example' => '123456', 'title' => ''], + 'ModifierId' => ['description' => 'The ID of the user who last modified the agent.', 'type' => 'string', 'example' => '123456', 'title' => ''], + 'Visibility' => ['description' => 'The visibility level of the custom agent.', 'type' => 'string', 'example' => 'TENANT', 'title' => ''], + 'GmtCreateTime' => ['description' => 'The time when the agent was created, provided in milliseconds since the Unix epoch.', 'type' => 'string', 'format' => 'iso8601', 'example' => '1780555634000', 'title' => ''], + 'GmtModifiedTime' => ['description' => 'The time when the agent was last modified, provided in milliseconds since the Unix epoch.', 'type' => 'string', 'format' => 'iso8601', 'example' => '1780555634000', 'title' => ''], + ], + 'description' => 'A custom agent.', + 'title' => '', + 'example' => '', ], + 'description' => 'The list of custom agents.', + 'title' => '', + 'example' => '', ], ], + 'description' => 'The paging information.', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => 'The response parameters.', + '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' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"952795279527ab****\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 20,\\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}","type":"json"}]', - 'title' => 'ListDeploymentPackages', - ], - 'ListDeploymentPackageFiles' => [ - 'summary' => 'Queries a list of versions of files to be deployed.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListCustomAgents', + 'description' => '## Request'."\n" + ."\n" + .'- **Search keyword**: Use the `Q` parameter to perform a fuzzy search by agent name.'."\n" + ."\n" + .'- **Visibility level filtering**: Use the `Visibility` parameter to filter results by visibility level, such as `TENANT`, `PROJECT`, or `USER`.'."\n" + ."\n" + .'- **Paging information**: Use the `MaxResults` and `NextToken` parameters to implement paginated queries. `NextToken` retrieves the next page of results.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"824F80BA-1778-5D8A-BAFF-668A4D9C4CC7\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 100,\\n \\"MaxResults\\": 20,\\n \\"NextToken\\": \\"5\\",\\n \\"Agents\\": [\\n {\\n \\"Name\\": \\"my-agent\\",\\n \\"DisplayName\\": \\"我的助手\\",\\n \\"Description\\": \\"数据分析助手\\",\\n \\"CreatorId\\": \\"123456\\",\\n \\"ModifierId\\": \\"123456\\",\\n \\"Visibility\\": \\"TENANT\\",\\n \\"GmtCreateTime\\": \\"1780555634000\\",\\n \\"GmtModifiedTime\\": \\"1780555634000\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListCustomAttributes' => [ + 'summary' => 'Retrieves a list of custom attribute definitions.', + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -24269,392 +27357,347 @@ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '270534', - 'abilityTreeNodes' => [ - 'FEATUREdide4AR6E0', - ], + 'abilityTreeNodes' => ['FEATUREdideX3KVYR'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'PageNumber', '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, - 'example' => '12345', - ], + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '1', 'example' => '1', 'default' => '1', 'title' => '', 'required' => false], ], [ - 'name' => 'BusinessId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The workflow ID. You can call the [ListBusiness](~~173945~~) operation to query the workflow ID by name.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '100001', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10', 'title' => '', 'required' => false], ], [ - 'name' => 'SolutionId', + 'name' => 'DisplayName', 'in' => 'query', - 'schema' => [ - 'description' => 'The solution ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '8065', - ], + 'schema' => ['description' => 'The display name of the custom attribute. The service performs a partial match based on this parameter\'s value.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'Owner'], ], [ - 'name' => 'CommitFrom', + 'name' => 'EntityTypes', 'in' => 'query', - 'schema' => [ - 'description' => 'The start date for committing. Specify the date in the yyyy-MM-dd format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2025-01-01', - ], + 'schema' => ['description' => 'The entity types to which the custom attribute applies. To specify multiple entity types, separate them with commas (,), for example, `*-table,*-column`. This parameter supports specific entity types, such as `hms-table` and `emr-table`, and wildcard types, such as `*-table` and `*-column`.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'maxcompute-table'], ], [ - 'name' => 'CommitTo', + 'name' => 'Comment', 'in' => 'query', - 'schema' => [ - 'description' => 'The end date (included) for committing. Specify the date in the yyyy-MM-dd format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2025-01-31', - ], + 'schema' => ['description' => 'The comment on the custom attribute. The service performs a fuzzy search based on this parameter\'s value.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'owner'], ], [ - 'name' => 'CommitUserId', + 'name' => 'SortBy', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the user who commits the file.'."\n", + 'description' => 'The field to sort by. Valid values: CreateTime and ModifyTime.', + 'enumValueTitles' => ['ModifyTime' => '', 'CreateTime' => ''], 'type' => 'string', + 'default' => 'CreateTime', + 'enum' => ['Name', 'Type', 'CreateTime', 'ModifyTime'], + 'title' => '', 'required' => false, - 'example' => '2003****'."\n", + 'example' => 'CreateTime', ], ], [ - 'name' => 'FileType', + 'name' => 'Order', 'in' => 'query', 'schema' => [ - 'description' => 'The type of the code for the file.'."\n" - ."\n" - .'The code for files varies based on the file type. For more information, see [DataWorks nodes](~~600169~~). You can call the [ListFileType](~~212428~~) operation to query the type of the code for the file.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The sort order. Valid values: Asc and Desc.', + 'type' => 'string', + 'default' => 'Asc', + 'enum' => ['Asc', 'Desc'], + 'title' => '', 'required' => false, - 'example' => '10', + 'example' => 'Asc', ], ], - [ - 'name' => 'ChangeType', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The change type. Valid values:'."\n" - ."\n" - .'* 0: addition'."\n" - .'* 1: update'."\n" - .'* 2: deletion'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => '54594ACA-7976-5273-958B-02E15E9B867C'], + 'Success' => ['description' => 'Indicates whether the request succeeded.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'PagingInfo' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'PageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], + 'CustomAttributes' => [ + 'type' => 'array', + 'items' => ['description' => 'A custom attribute object.', '$ref' => '#/components/schemas/CustomAttribute', 'title' => '', 'example' => ''], + 'title' => '', + 'description' => 'A list of custom attribute objects.', + 'example' => '', + ], + ], + 'title' => '', + 'description' => 'The paging information.', + 'example' => '', + ], + ], + 'title' => '', + 'description' => 'The data returned.', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListCustomAttributes', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"54594ACA-7976-5273-958B-02E15E9B867C\\",\\n \\"Success\\": true,\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 10,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"CustomAttributes\\": [\\n {\\n \\"Id\\": \\"custom-attribute:biz_owner\\",\\n \\"DisplayName\\": \\"业务负责人\\",\\n \\"Type\\": \\"TEXT\\",\\n \\"EntityTypes\\": [\\n \\"maxcompute-table\\"\\n ],\\n \\"ValueEnums\\": [\\n \\"VALUE_1\\"\\n ],\\n \\"SearchFilterEnabled\\": false,\\n \\"DisplayEnabled\\": true,\\n \\"Comment\\": \\"this is a comment\\",\\n \\"CreateTime\\": 1750817692000,\\n \\"ModifyTime\\": 1763380628000\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListDIAlarmRules' => [ + 'summary' => 'Views alert rules configured for a synchronization task.', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'FileIds', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The IDs of the files to be queried.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the file to be queried.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '11223**', - ], - 'required' => false, - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '234129', + 'abilityTreeNodes' => ['FEATUREdideBP0OJZ'], + ], + 'parameters' => [ [ - 'name' => 'FileName', + 'name' => 'JobId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the file.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Filename', - ], + 'schema' => ['description' => 'The ID of the task for which alert rules are configured.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000001', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'The page number.', '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, - 'maximum' => '100', - 'minimum' => '10', - 'example' => '20', - 'default' => '10', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'DIAlarmRuleId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the alert rule. If you leave this parameter empty, all alert rules of the task are queried.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '34988', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.', 'type' => 'string', 'example' => '74C2FECD-5B3A-554A-BCF5-351A36DE9815'], 'PagingInfo' => [ - 'description' => 'The pagination details.'."\n", + 'description' => 'The pagination information.', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'PageNumber' => [ - 'description' => 'The page number. Pages start from page 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'DeploymentPackageFiles' => [ - 'description' => 'The list of files pending deployment.'."\n", + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '90', 'title' => ''], + 'PageNumber' => ['description' => 'The page number. Pages start from page 1.', '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 version of the file to be deployed.'."\n", + 'description' => 'The details of an alert rule.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => 'The unique ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '650433503', - ], - 'FileId' => [ - 'description' => 'The file ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '520246913', - ], - 'FileVersion' => [ - 'description' => 'The file version.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '34', - ], - 'CommitTime' => [ - 'description' => 'The time for committing.'."\n", - 'type' => 'string', - 'example' => '2025-04-10 15:55:47', - ], - 'CommitUser' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the user who committed the file.'."\n", - 'type' => 'string', - 'example' => '446***', - ], - 'CommitUserName' => [ - 'description' => 'The name of the Alibaba Cloud account used by the user who committed the file.'."\n", - 'type' => 'string', - 'example' => 'user***', - ], - 'ProjectId' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '27595', - ], - 'TenantId' => [ - 'description' => 'The DataWorks tenant ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '639415964191360', - ], - 'FileType' => [ - 'description' => 'The file type. The code for files varies based on the file type. For more information, see [DataWorks nodes](~~600169~~).'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '13', - ], - 'FileName' => [ - 'description' => 'The name of the file of the current version.'."\n", - 'type' => 'string', - 'example' => 'bak_part_basc_person_relation_all_da', - ], - 'Status' => [ - 'description' => 'The status of the code file of the current version. Valid values:'."\n" - ."\n" - .'* 2: Commit check in progress.'."\n" - .'* 3: Commit check passed.'."\n" - .'* 4: Commit check failed.'."\n" - .'* 10: Committing.'."\n" - .'* 11: Committed.'."\n" - .'* 20: Approved.'."\n" - .'* 21: Rejected.'."\n" - .'* 22: Warning detected during checking.'."\n" - .'* 23: Under code review.'."\n" - .'* 24: Code review rejected.'."\n" - .'* 80: Deployment package created.'."\n" - .'* 100: Deploying.'."\n" - .'* 101: Deployed to the production environment.'."\n" - .'* 200: Cancelled.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'ChangeType' => [ - 'description' => 'The change type, which is an integer. Valid values:'."\n" - ."\n" - .'* 0: addition'."\n" - .'* 1: update'."\n" - .'* 2: deletion'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'IsSameAsProductionVersion' => [ - 'description' => 'Indicates whether the version is a version in the production environment of the scheduling system.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'NodeId' => [ - 'description' => 'The ID of the auto triggered node that corresponds to the file.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '700005008419', - ], - 'Comment' => [ - 'description' => 'The comment for committing.'."\n", - 'type' => 'string', + 'Id' => ['description' => 'The ID of the alert rule.', 'type' => 'integer', 'format' => 'int64', 'example' => '72402', 'title' => ''], + 'DIJobId' => ['description' => 'The ID of the synchronization task.', 'type' => 'integer', 'format' => 'int64', 'example' => '32594', 'title' => ''], + 'Description' => ['description' => 'The description of the alert rule.', 'type' => 'string', 'example' => 'rule descrition', 'title' => ''], + 'MetricType' => ['description' => 'The metric type in the alert rule. Valid values:'."\n" + ."\n" + .'- Heartbeat'."\n" + ."\n" + .'- FailoverCount'."\n" + ."\n" + .'- Delay'."\n" + ."\n" + .'- DdlReport'."\n" + ."\n" + .'- ResourceUtilization', 'type' => 'string', 'example' => 'Heartbeat', 'title' => ''], + 'Name' => ['description' => 'The name of the alert rule.', 'type' => 'string', 'example' => 'rule_name', 'title' => ''], + 'Enabled' => ['description' => 'Indicates whether the alert rule is enabled. Valid values: True and False.', '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', 'type' => 'string', 'example' => 'Critical', 'title' => ''], + 'Duration' => ['description' => 'The time interval for alert calculation. Unit: minutes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', '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' => ''], + 'DdlTypes' => [ + 'description' => 'The types of DDL operations for which the alert rule takes effect. This parameter is returned only if the MetricType parameter is set to DdlReport.', + 'type' => 'array', + 'items' => ['description' => 'The type of the DDL operation for which the alert rule takes effect. This parameter is returned only if the MetricType parameter is set to DdlReport. Valid values:'."\n" + ."\n" + .'- AlterAddColumn'."\n" + ."\n" + .'- AlterDropColumn'."\n" + ."\n" + .'- AlterRenameColumn'."\n" + ."\n" + .'- AlterRenameTable'."\n" + ."\n" + .'- AlterTableModify'."\n" + ."\n" + .'- DropTable'."\n" + ."\n" + .'- TruncateTable', 'type' => 'string', 'example' => 'AlterAddColumn', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'DdlReportTags' => [ + 'description' => 'This parameter is deprecated and replaced by the DdlTypes parameter.', + 'type' => 'array', + 'items' => ['description' => 'This parameter is deprecated and replaced by the DdlTypes parameter.', 'type' => 'string', 'deprecated' => true, 'example' => 'ALTERADDCOLUMN', 'title' => ''], + 'deprecated' => true, + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', 'example' => '', ], - 'NodeConfiguration' => [ - 'description' => 'The scheduling property configurations of the node that corresponds to the file, which is a JSON string.'."\n", - 'type' => 'string', - 'example' => '{'."\n" - .' "tagList": [],'."\n" - .' "fileId": -1,'."\n" - .' "taskRerunTime": 0,'."\n" - .' "taskRerunInterval": 0,'."\n" - .' "reRunAble": 1,'."\n" - .' "nodeId": 125803000,'."\n" - .' "nodeName": "new",'."\n" - .' "nodeType": 0,'."\n" - .' "isStop": 0,'."\n" - .' "paraValue": "",'."\n" - .' "startEffectDate": "1970-01-01 00:00:00",'."\n" - .' "endEffectDate": "9999-01-01 00:00:00",'."\n" - .' "cronExpress": "00 26 00 * * ?",'."\n" - .' "owner": "1107550004250000",'."\n" - .' "resgroupId": 6300000,'."\n" - .' "cu": "0.25",'."\n" - .' "appId": 170000,'."\n" - .' "tenantId": 524257424560000,'."\n" - .' "createTime": "2025-04-10 15:55:01",'."\n" - .' "createUser": "1107550004250000",'."\n" - .' "lastModifyTime": "2025-04-10 15:55:41",'."\n" - .' "cycleType": 0,'."\n" - .' "dependentType": 0,'."\n" - .' "dependentTypeList": [0],'."\n" - .' "lastModifyUser": "1107550004250000",'."\n" - .' "dependentDataNode": "",'."\n" - .' "input": "[{\\"regionId\\":\\"cn-hangzhou\\",\\"str\\":\\"root_input\\",\\"parseType\\":1}]",'."\n" - .' "output": "[{\\"str\\":\\"project_root.526586287_out\\",\\"parseType\\":2},{\\"str\\":\\"project_root.new\\",\\"parseType\\":1}]",'."\n" - .' "inputList": [{'."\n" - .' "regionId": "cn-hangzhou",'."\n" - .' "str": "root_input",'."\n" - .' "parseType": 1'."\n" - .' }],'."\n" - .' "outputList": [{'."\n" - .' "str": "project_root.526586287_out",'."\n" - .' "parseType": 2'."\n" - .' }, {'."\n" - .' "str": "project_root.new",'."\n" - .' "parseType": 1'."\n" - .' }],'."\n" - .' "isAutoParse": 1,'."\n" - .' "startRightNow": false,'."\n" - .' "extConfig": "{\\"openCustomCron\\":false,\\"formCron\\":\\"\\"}",'."\n" - .' "inputContextList": [],'."\n" - .' "outputContextList": []'."\n" - .'}', - ], - '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 node in DataStudio.'."\n" - .'* ADHOCQUERY: The file is used for an ad hoc query.'."\n" - .'* COMPONENT: The file is used for a script template.'."\n", - 'type' => 'string', - 'example' => 'NORMAL', - ], - 'SmokeTestStatus' => [ - 'description' => 'The test status in the development environment.'."\n", - 'type' => 'string', + 'NotificationSettings' => [ + 'description' => 'The alert notification method and recipient 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', 'type' => 'string', 'example' => 'Critical', 'title' => ''], + 'Channels' => [ + 'description' => 'The alert notification methods.', + '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' => '', + ], + 'NotificationReceivers' => [ + 'description' => 'The settings of alert notification recipients.', + 'type' => 'array', + 'items' => [ + 'description' => 'The settings of alert notification recipients.', + 'type' => 'object', + 'properties' => [ + 'ReceiverType' => ['description' => 'The recipient type. Valid values: AliyunUid, DingToken, FeishuToken, and WebHookUrl.', 'type' => 'string', 'example' => 'DingToken', 'title' => ''], + 'ReceiverValues' => [ + 'description' => 'The recipient.'."\n" + ."\n" + .'- If the value of the ReceiverType parameter is AliyunUid, the value of this parameter is the Alibaba Cloud account ID of a user.'."\n" + ."\n" + .'- If the value of the ReceiverType parameter is DingToken, the value of this parameter is the token of a DingTalk chatbot.', + 'type' => 'array', + 'items' => ['description' => 'The recipient.'."\n" + ."\n" + .'- If the value of the ReceiverType parameter is AliyunUid, the value of this parameter is the Alibaba Cloud account ID of a user.'."\n" + ."\n" + .'- If the value of the ReceiverType parameter is DingToken, the value of this parameter is the token of a DingTalk chatbot.', 'type' => 'string', 'example' => 'token1', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'MuteInterval' => ['description' => 'The duration of the alert suppression interval. Unit: minutes.', 'type' => 'integer', 'format' => 'int64', 'example' => '5', 'title' => ''], + 'InhibitionInterval' => ['description' => 'This parameter is deprecated and replaced by the MuteInterval parameter.', 'type' => 'integer', 'format' => 'int64', 'deprecated' => true, 'example' => '5', 'title' => ''], + ], + 'title' => '', 'example' => '', ], + 'DIAlarmRuleId' => ['description' => 'This parameter is deprecated. Use the Id parameter instead.', 'type' => 'integer', 'format' => 'int64', 'deprecated' => true, 'example' => '72402', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"DeploymentPackageFiles\\": [\\n {\\n \\"Id\\": 650433503,\\n \\"FileId\\": 520246913,\\n \\"FileVersion\\": 34,\\n \\"CommitTime\\": \\"2025-04-10 15:55:47\\",\\n \\"CommitUser\\": \\"446***\\",\\n \\"CommitUserName\\": \\"user***\\",\\n \\"ProjectId\\": 27595,\\n \\"TenantId\\": 639415964191360,\\n \\"FileType\\": 13,\\n \\"FileName\\": \\"bak_part_basc_person_relation_all_da\\",\\n \\"Status\\": 100,\\n \\"ChangeType\\": 0,\\n \\"IsSameAsProductionVersion\\": true,\\n \\"NodeId\\": 700005008419,\\n \\"Comment\\": \\"测试提交\\",\\n \\"NodeConfiguration\\": \\"{\\\\n\\\\t\\\\\\"tagList\\\\\\": [],\\\\n\\\\t\\\\\\"fileId\\\\\\": -1,\\\\n\\\\t\\\\\\"taskRerunTime\\\\\\": 0,\\\\n\\\\t\\\\\\"taskRerunInterval\\\\\\": 0,\\\\n\\\\t\\\\\\"reRunAble\\\\\\": 1,\\\\n\\\\t\\\\\\"nodeId\\\\\\": 125803000,\\\\n\\\\t\\\\\\"nodeName\\\\\\": \\\\\\"new\\\\\\",\\\\n\\\\t\\\\\\"nodeType\\\\\\": 0,\\\\n\\\\t\\\\\\"isStop\\\\\\": 0,\\\\n\\\\t\\\\\\"paraValue\\\\\\": \\\\\\"\\\\\\",\\\\n\\\\t\\\\\\"startEffectDate\\\\\\": \\\\\\"1970-01-01 00:00:00\\\\\\",\\\\n\\\\t\\\\\\"endEffectDate\\\\\\": \\\\\\"9999-01-01 00:00:00\\\\\\",\\\\n\\\\t\\\\\\"cronExpress\\\\\\": \\\\\\"00 26 00 * * ?\\\\\\",\\\\n\\\\t\\\\\\"owner\\\\\\": \\\\\\"1107550004250000\\\\\\",\\\\n\\\\t\\\\\\"resgroupId\\\\\\": 6300000,\\\\n\\\\t\\\\\\"cu\\\\\\": \\\\\\"0.25\\\\\\",\\\\n\\\\t\\\\\\"appId\\\\\\": 170000,\\\\n\\\\t\\\\\\"tenantId\\\\\\": 524257424560000,\\\\n\\\\t\\\\\\"createTime\\\\\\": \\\\\\"2025-04-10 15:55:01\\\\\\",\\\\n\\\\t\\\\\\"createUser\\\\\\": \\\\\\"1107550004250000\\\\\\",\\\\n\\\\t\\\\\\"lastModifyTime\\\\\\": \\\\\\"2025-04-10 15:55:41\\\\\\",\\\\n\\\\t\\\\\\"cycleType\\\\\\": 0,\\\\n\\\\t\\\\\\"dependentType\\\\\\": 0,\\\\n\\\\t\\\\\\"dependentTypeList\\\\\\": [0],\\\\n\\\\t\\\\\\"lastModifyUser\\\\\\": \\\\\\"1107550004250000\\\\\\",\\\\n\\\\t\\\\\\"dependentDataNode\\\\\\": \\\\\\"\\\\\\",\\\\n\\\\t\\\\\\"input\\\\\\": \\\\\\"[{\\\\\\\\\\\\\\"regionId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cn-hangzhou\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"str\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"root_input\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"parseType\\\\\\\\\\\\\\":1}]\\\\\\",\\\\n\\\\t\\\\\\"output\\\\\\": \\\\\\"[{\\\\\\\\\\\\\\"str\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"project_root.526586287_out\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"parseType\\\\\\\\\\\\\\":2},{\\\\\\\\\\\\\\"str\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"project_root.new\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"parseType\\\\\\\\\\\\\\":1}]\\\\\\",\\\\n\\\\t\\\\\\"inputList\\\\\\": [{\\\\n\\\\t\\\\t\\\\\\"regionId\\\\\\": \\\\\\"cn-hangzhou\\\\\\",\\\\n\\\\t\\\\t\\\\\\"str\\\\\\": \\\\\\"root_input\\\\\\",\\\\n\\\\t\\\\t\\\\\\"parseType\\\\\\": 1\\\\n\\\\t}],\\\\n\\\\t\\\\\\"outputList\\\\\\": [{\\\\n\\\\t\\\\t\\\\\\"str\\\\\\": \\\\\\"project_root.526586287_out\\\\\\",\\\\n\\\\t\\\\t\\\\\\"parseType\\\\\\": 2\\\\n\\\\t}, {\\\\n\\\\t\\\\t\\\\\\"str\\\\\\": \\\\\\"project_root.new\\\\\\",\\\\n\\\\t\\\\t\\\\\\"parseType\\\\\\": 1\\\\n\\\\t}],\\\\n\\\\t\\\\\\"isAutoParse\\\\\\": 1,\\\\n\\\\t\\\\\\"startRightNow\\\\\\": false,\\\\n\\\\t\\\\\\"extConfig\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"openCustomCron\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"formCron\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\"}\\\\\\",\\\\n\\\\t\\\\\\"inputContextList\\\\\\": [],\\\\n\\\\t\\\\\\"outputContextList\\\\\\": []\\\\n}\\",\\n \\"UseType\\": \\"NORMAL\\",\\n \\"SmokeTestStatus\\": \\"未测试\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListDeploymentPackageFiles', - ], - 'GetFileVersion' => [ - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"74C2FECD-5B3A-554A-BCF5-351A36DE9815\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 90,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"DIJobAlarmRules\\": [\\n {\\n \\"Id\\": 72402,\\n \\"DIJobId\\": 32594,\\n \\"Description\\": \\"rule descrition\\",\\n \\"MetricType\\": \\"Heartbeat\\",\\n \\"Name\\": \\"rule_name\\",\\n \\"Enabled\\": true,\\n \\"TriggerConditions\\": [\\n {\\n \\"Severity\\": \\"Critical\\",\\n \\"Duration\\": 1,\\n \\"Threshold\\": 5,\\n \\"DdlTypes\\": [\\n \\"AlterAddColumn\\"\\n ],\\n \\"DdlReportTags\\": [\\n \\"ALTERADDCOLUMN\\"\\n ]\\n }\\n ],\\n \\"NotificationSettings\\": {\\n \\"NotificationChannels\\": [\\n {\\n \\"Severity\\": \\"Critical\\",\\n \\"Channels\\": [\\n \\"Ding\\"\\n ]\\n }\\n ],\\n \\"NotificationReceivers\\": [\\n {\\n \\"ReceiverType\\": \\"DingToken\\",\\n \\"ReceiverValues\\": [\\n \\"token1\\"\\n ]\\n }\\n ],\\n \\"MuteInterval\\": 5,\\n \\"InhibitionInterval\\": 5\\n },\\n \\"DIAlarmRuleId\\": 72402\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListDIAlarmRules', + 'description' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-01-09T07:20:21.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-01-06T05:34:15.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'ListDIJobEvents' => [ + 'summary' => 'Queries events for a synchronization task.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -24664,235 +27707,120 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '269314', - 'abilityTreeNodes' => [ - 'FEATUREdide8FM783', - ], + 'abilityTreeCode' => '235253', + 'abilityTreeNodes' => ['FEATUREdideBP0OJZ'], ], 'parameters' => [ [ - 'name' => 'FileId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The file ID. You can call the [ListFiles](~~173942~~) operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1000001', - ], + 'name' => 'DIJobId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the synchronization task.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '11588', 'title' => ''], ], [ - '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 workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '1000011', - ], + 'name' => 'EventType', + 'in' => 'query', + 'schema' => ['description' => 'The type of event that you want to query. Valid values: Failover, Alarm, and DDL.', 'type' => 'string', 'required' => true, 'example' => 'Alarm', 'title' => ''], ], [ - '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.'."\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' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The beginning of the time range to query.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1716971005', 'title' => ''], ], [ - 'name' => 'FileVersion', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The file version whose information you want to query.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '2', - ], + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end of the time range to query.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1717971005', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', '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' => '0000-ABCD-EFG****', - ], - '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 details of the file version.'."\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' => '645F6D68-9C29-5961-80B1-BDD4****'], + 'PagingInfo' => [ + 'description' => 'The pagination information.', 'type' => 'object', 'properties' => [ - 'FileContent' => [ - 'description' => 'The code in the file of the current version.'."\n", - 'type' => 'string', - 'example' => 'SHOW TABLES;', - ], - 'IsCurrentProd' => [ - 'description' => 'Indicates whether the version is the latest version in the production environment. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Status' => [ - 'description' => 'The status of the file version. Valid values:'."\n" - ."\n" - .'* COMMITTING'."\n" - .'* COMMITTED or CHECK_OK'."\n" - .'* PACKAGED'."\n" - .'* DEPLOYING'."\n" - .'* DEPLOYED'."\n" - .'* CANCELLED'."\n", - 'type' => 'string', - 'example' => 'COMMITTED', - ], - 'NodeContent' => [ - 'description' => 'The scheduling configurations of the node that corresponds to the file of the current version.'."\n", - 'type' => 'string', - 'example' => '{"cycleType":0,"cronExpress":"00 05 00 * * ?"}', - ], - 'CommitUser' => [ - 'description' => 'The ID of the Alibaba Cloud account that is used to generate the file of the current version.'."\n", - 'type' => 'string', - 'example' => ' '."\n" - .'7384234****'."\n", - ], - '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 module to which the file belongs. Valid values:'."\n" - ."\n" - .'* 0: NORMAL, which indicates that the file is used for DataStudio.'."\n" - .'* 1: MANUAL, which indicates that the file is used for a manually triggered node.'."\n" - .'* 2: MANUAL_BIZ, which indicates that the file is used for a manually triggered workflow.'."\n" - .'* 3: SKIP, which indicates that the file is used for a dry-run node in DataStudio.'."\n" - .'* 10: ADHOCQUERY, which indicates that the file is used for an ad hoc query.'."\n" - .'* 30: COMPONENT, which indicates that the file is used for a script template.'."\n", - 'type' => 'string', - 'example' => '0', - ], - '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 file version.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'CommitTime' => [ - 'description' => 'The time when the file 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', + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '2524', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'DIJobEvent' => [ + 'description' => 'The events returned. The value of this parameter is an array.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details about a single event.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The event ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the event was created.', 'type' => 'string', 'example' => '1663573162', 'title' => ''], + 'FailoverMessage' => ['description' => 'The error logs for failovers.', 'type' => 'string', 'example' => '2024-05-29 15:11:31,377 [main] INFO com.*.**.di.core.metrics.:21 [] {****} '."\n" + .'2024-05-29 15:11:31,384 [main] INFO *.aliyun.*.di.*.*.metrics.*:27 [] - Open MarioDiReporter '."\n" + .'2024-05-29 15:11:33,248 [flink-akka.*.*-dispatcher-17] INFO ', 'title' => ''], + 'Severity' => ['description' => 'The severity level of the alert. Valid values: Warning and Critical.', 'type' => 'string', 'example' => 'Warning', 'title' => ''], + 'Channels' => ['description' => 'The alert notification method. Valid values: Phone, Mail, Sms, Ding, and Webhook.', 'type' => 'string', 'example' => 'Phone', 'title' => ''], + 'Status' => ['description' => 'The sending status of an alert notification. Valid values: Success, Fail, and Silence.', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Detail' => ['description' => 'The alert details.', 'type' => 'string', 'example' => 'Data integration sync task exception: Level: WARNING, DataWorks project name:** [Region: cn-shanghai], Task name:**, Alert rule: Business delay, aggregator:avg [**] for 5 minutes, service maybe abnormal.', 'title' => ''], + 'Type' => ['description' => 'The type of the alert event.'."\n" + ."\n" + .'- Heartbeat'."\n" + ."\n" + .'- Delay'."\n" + ."\n" + .'- FailoverCount'."\n" + ."\n" + .'- DdlReport'."\n" + ."\n" + .'- ResourceUtilization', 'type' => 'string', 'example' => 'Delay', 'title' => ''], + 'Action' => ['description' => 'The processing result of the DDL event. Valid values: Critical, Ignore, Normal, and Warning.', 'type' => 'string', 'example' => 'Ignore', 'title' => ''], + 'SrcTable' => ['description' => 'The name of the source table.', 'type' => 'string', 'example' => 'table1', 'title' => ''], + 'DstTable' => ['description' => 'The name of the destination table.', 'type' => 'string', 'example' => 'table2', 'title' => ''], + 'SrcSql' => ['description' => 'The DDL statement of the source table.', 'type' => 'string', 'example' => 'alter table table1 ***', 'title' => ''], + 'DstSql' => ['description' => 'The DDL statement of the destination table.', 'type' => 'string', 'example' => 'alter table table2 ***', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], - '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.', + 'example' => '', ], ], ], - '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\\": \\"\\\\t\\\\n7384234****\\\\n\\",\\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"}]', - 'title' => 'GetFileVersion', - 'summary' => 'Queries the information about a file version.', - ], - 'ListFileVersions' => [ - 'methods' => [ - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"645F6D68-9C29-5961-80B1-BDD4****\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 2524,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"DIJobEvent\\": [\\n {\\n \\"Id\\": \\"1\\",\\n \\"CreateTime\\": \\"1663573162\\",\\n \\"FailoverMessage\\": \\"2024-05-29 15:11:31,377 [main] INFO com.*.**.di.core.metrics.:21 [] {****} \\\\n2024-05-29 15:11:31,384 [main] INFO *.aliyun.*.di.*.*.metrics.*:27 [] - Open MarioDiReporter \\\\n2024-05-29 15:11:33,248 [flink-akka.*.*-dispatcher-17] INFO \\",\\n \\"Severity\\": \\"Warning\\",\\n \\"Channels\\": \\"Phone\\",\\n \\"Status\\": \\"Success\\",\\n \\"Detail\\": \\"Data integration sync task exception: Level: WARNING, DataWorks project name:** [Region: cn-shanghai], Task name:**, Alert rule: Business delay, aggregator:avg [**] for 5 minutes, service maybe abnormal.\\",\\n \\"Type\\": \\"Delay\\",\\n \\"Action\\": \\"Ignore\\",\\n \\"SrcTable\\": \\"table1\\",\\n \\"DstTable\\": \\"table2\\",\\n \\"SrcSql\\": \\"alter table table1 ***\\",\\n \\"DstSql\\": \\"alter table table2 ***\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListDIJobEvents', + 'description' => 'This API operation is available for all DataWorks editions.', + 'changeSet' => [ + ['createdAt' => '2024-10-15T07:52:06.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'translator' => 'manual', + ], + 'ListDIJobMetrics' => [ + 'summary' => 'Queries metrics for a synchronization task.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -24902,388 +27830,245 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '269312', - 'abilityTreeNodes' => [ - 'FEATUREdide8FM783', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235252', + 'abilityTreeNodes' => ['FEATUREdideBP0OJZ'], + 'autoTest' => false, ], 'parameters' => [ [ - 'name' => 'FileId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The file ID. You can call [ListFiles](~~173942~~) to query the file ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '100000001', - ], - ], - [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The DataWorks workspace ID. To find this, click the wrench icon in the upper-right corner and navigate to the workspace management page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '100001', - ], + 'name' => 'DIJobId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the synchronization task.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '11265', 'title' => ''], ], [ - 'name' => 'ProjectIdentifier', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The unique identifier of the DataWorks workspace, which is the identifier at the top of the Data Studio page where you switch workspaces.'."\n" - ."\n" - .'Either this parameter or ProjectId must be specified to identify the target DataWorks workspace for this API call.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dw_project', - ], + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The beginning of the time range to query.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1586509407', 'title' => ''], ], [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The page number for pagination.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end of the time range to query.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1712205941', 'title' => ''], ], [ - 'name' => 'PageSize', - 'in' => 'formData', + 'name' => 'MetricName', + 'in' => 'query', + 'style' => 'json', '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', + 'description' => 'The metrics that you want to query.', + 'type' => 'array', + 'items' => ['description' => 'The name of the metric. The following six metrics are supported:'."\n" + ."\n" + .'- resourceUtilization: specifies the resource usage of a resource group. This metric is supported only for serverless resource groups.'."\n" + ."\n" + .'- delayTime: specifies the latency on the synchronization task.'."\n" + ."\n" + .'- totalRecordsRead: specifies the number of data records that are read from the source.'."\n" + ."\n" + .'- speedRecordsRead: specifies the rate at which the synchronization task reads data from the source.'."\n" + ."\n" + .'- totalRecordsWrite: specifies the number of data records that are written to the destination.'."\n" + ."\n" + .'- speedRecordsWrite: specifies the rate at which the synchronization task writes data to the destination.', 'type' => 'string', 'required' => false, 'example' => 'delayTime', 'title' => ''], + 'required' => true, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response.'."\n", + 'title' => 'Schema of Response', + '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' => '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 call succeeded. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The list of file versions.'."\n", + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.', 'type' => 'string', 'example' => '691CA452-D37A-4ED0-9441'], + 'PagingInfo' => [ + 'description' => 'The pagination information.', 'type' => 'object', 'properties' => [ - 'PageNumber' => [ - 'description' => 'The current page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries on the current 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 list of file version details.'."\n", + 'JobMetrics' => [ + 'description' => 'The metrics returned.', 'type' => 'array', 'items' => [ - 'description' => 'The file version details.'."\n", + 'description' => 'The information about a single metric.', 'type' => 'object', 'properties' => [ - 'FileContent' => [ - 'description' => 'The file code for this version.'."\n", - 'type' => 'string', - 'example' => 'SHOW TABLES;', - ], - 'Status' => [ - 'description' => 'The current status of the file version. Valid values: COMMITTING (committing), COMMITTED or CHECK_OK (committed), PACKAGED (ready for deployment), DEPLOYING (deploying), DEPLOYED (deployed), and CANCELLED (deployment canceled).'."\n", - 'type' => 'string', - 'example' => 'COMMITTED', - ], - 'IsCurrentProd' => [ - 'description' => 'Indicates whether this file version is the latest version in the production environment.'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'CommitUser' => [ - 'description' => 'The Alibaba Cloud account ID of the user who created this file version.'."\n", - 'type' => 'string', - 'example' => '73842342****'."\n", - ], - 'NodeContent' => [ - 'description' => 'The scheduling configuration for this file version.'."\n", - 'type' => 'string', - 'example' => '{"cycleType":0,"cronExpress":"00 05 00 * * ?"}', - ], - 'Comment' => [ - 'description' => 'The description of this file version.'."\n", - 'type' => 'string', - 'example' => 'Second version submission', - ], - 'FilePropertyContent' => [ - 'description' => 'The text information for this file version.'."\n", - 'type' => 'string', - 'example' => '{"fileName":"ods_user_info_d","fileType":10}', - ], - 'FileName' => [ - 'description' => 'The file name for this file version.'."\n", - 'type' => 'string', - 'example' => 'ods_user_info_d', - ], - 'UseType' => [ - 'description' => 'The functional module to which the file belongs. Valid values: NORMAL (Data Studio), MANUAL (manual task), MANUAL_BIZ (manual workflow), SKIP (dry-run scheduling in Data Studio), ADHOCQUERY (ad hoc query), and COMPONENT (component management).'."\n", - 'type' => 'string', - 'example' => 'NORMAL', - ], - 'ChangeType' => [ - 'description' => 'The change type for this 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 timestamp (in milliseconds) when the file version was created.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1593881265000', - ], - 'NodeId' => [ - 'description' => 'The scheduling task ID associated with this file version.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', + 'Name' => ['description' => 'The name of the metric.', 'type' => 'string', 'example' => 'JobDelay', 'title' => ''], + 'SeriesList' => [ + 'description' => 'The metric data.', + 'type' => 'array', + 'items' => [ + 'description' => 'The metric data.', + 'type' => 'object', + 'properties' => [ + 'Time' => ['description' => 'The point in time at which data is sampled based on the metric.', 'type' => 'integer', 'format' => 'int64', 'example' => '1716881141', 'title' => ''], + 'Value' => ['description' => 'The sample value.', 'type' => 'number', 'format' => 'double', 'example' => '10', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + '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.', - ], - ], - 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 \\"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\\",\\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"}]', - 'title' => 'ListFileVersions', - 'summary' => 'Queries a list of file versions.', - ], - 'UpdateIDEEventResult' => [ - 'summary' => 'Recalls the check result of the message of an extension point event.', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-4ED0-9441\\",\\n \\"PagingInfo\\": {\\n \\"JobMetrics\\": [\\n {\\n \\"Name\\": \\"JobDelay\\",\\n \\"SeriesList\\": [\\n {\\n \\"Time\\": 1716881141,\\n \\"Value\\": 10\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListDIJobMetrics', + 'description' => 'This API operation is available for all DataWorks editions.', + 'changeSet' => [ + ['createdAt' => '2024-10-15T07:52:06.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'ListDIJobRunDetails' => [ + 'summary' => 'Queries the running information about a synchronization task.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '269315', - 'abilityTreeNodes' => [ - 'FEATUREdide6ZPSGN', - ], + 'abilityTreeCode' => '235254', + 'abilityTreeNodes' => ['FEATUREdideBP0OJZ'], ], 'parameters' => [ [ - 'name' => 'MessageId', - 'in' => 'formData', - 'schema' => [ - 'title' => '消息UUID', - 'description' => 'The OpenEvent message ID from DataWorks. When an extension point event is triggered, you can obtain the message ID from the event message.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '8abcb91f-d266-4073-b907-2ed670378ed1', - ], + 'name' => 'DIJobId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the synchronization task.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '11265', 'title' => ''], ], [ - 'name' => 'ExtensionCode', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The unique identifier of the extension. You can obtain the identifier from the Extensions tab on Open Platform in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '8abcb91f-d266-4073-b907-2ed670378ed1', - ], + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234', 'title' => ''], ], [ - 'name' => 'CheckResult', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The check status of the extension for this extension point event. Valid values:'."\n" - ."\n" - .'* OK: The extension passed the check for this event.'."\n" - .'* FAIL: The extension failed the check for this event. You need to review and resolve the error promptly to avoid affecting subsequent program execution.'."\n" - .'* WARN: The extension passed the check for this event, but with warnings.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'OK', - ], + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'CheckResultTip', - 'in' => 'formData', - 'schema' => [ - 'description' => 'A summary of the check result for this extension point event. This message is displayed on your current development page. When the check fails or has warnings, you can use this summary to quickly identify the cause.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Succeeded', - ], + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'SourceDataSourceName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the source.', 'type' => 'string', 'required' => false, 'example' => 'ds_name', 'title' => ''], + ], + [ + 'name' => 'SourceDatabaseName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the database in the source.', 'type' => 'string', 'required' => false, 'example' => 'db_name', 'title' => ''], + ], + [ + 'name' => 'SourceSchemaName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the schema of the source.', 'type' => 'string', 'required' => false, 'example' => 'schema_name', 'title' => ''], + ], + [ + 'name' => 'SourceTableName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the table in the source.', 'type' => 'string', 'required' => false, 'example' => 'table_name', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response.'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID. Used for troubleshooting errors.'."\n", - 'type' => 'string', - 'example' => '8abcb91f-d266-4073-b907-2ed670378ed1', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.', 'type' => 'string', 'example' => '691CA452-D37A-4ED0-9441'], + 'PagingInfo' => [ + 'description' => 'The pagination information.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'string', 'example' => '131', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'JobRunInfos' => [ + 'description' => 'The running information about the synchronization task.', + 'type' => 'array', + 'items' => [ + 'description' => 'The running information about the synchronization task for a single table.', + 'type' => 'object', + 'properties' => [ + 'SourceDatasourceName' => ['description' => 'The name of the source.', 'type' => 'string', 'example' => 'ds_name', 'title' => ''], + 'SourceDatabaseName' => ['description' => 'The name of the database in the source.', 'type' => 'string', 'example' => 'db_name', 'title' => ''], + 'SourceSchemaName' => ['description' => 'The name of the schema of the source.', 'type' => 'string', 'example' => 'schema_name', 'title' => ''], + 'SourceTableName' => ['description' => 'The name of the table in the source.', 'type' => 'string', 'example' => 'table_name', 'title' => ''], + 'DestinationDatasourceName' => ['description' => 'The name of the destination.', 'type' => 'string', 'example' => 'dst_name', 'title' => ''], + 'DestinationDatabaseName' => ['description' => 'The name of the database in the destination.', 'type' => 'string', 'example' => 'dst_db', 'title' => ''], + 'DestinationSchemaName' => ['description' => 'The name of the schema of the destination.', 'type' => 'string', 'example' => 'dst_schema', 'title' => ''], + 'DestinationTableName' => ['description' => 'The name of the table in the destination.', 'type' => 'string', 'example' => 'dst_name', 'title' => ''], + 'StructureMigrationStatus' => ['description' => 'The synchronization status of the schema.', 'type' => 'string', 'example' => 'Finished', 'title' => ''], + 'StructureMigrationErrorMessage' => ['description' => 'The error message that is returned if an error occurs during schema synchronization. If no error occurs, no value is returned for this parameter.', 'type' => 'string', 'example' => 'create table t1 fail.', 'title' => ''], + 'FullMigrationStatus' => ['description' => 'The status of full batch synchronization.', 'type' => 'string', 'example' => 'Finished', 'title' => ''], + 'FullMigrationErrorMessage' => ['description' => 'The error message that is returned if an error occurs during full batch synchronization. If no error occurs, no value is returned for this parameter.', 'type' => 'string', 'example' => 'sync table t1 fail.', 'title' => ''], + 'OfflineErrorRecords' => ['description' => 'The total number of errors that occur during full synchronization.', 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'OfflineTotalBytes' => ['description' => 'The total number of bytes that are synchronized during full synchronization.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'OfflineTotalRecords' => ['description' => 'The total number of data records that are synchronized during full synchronization.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'RealtimeMigrationStatus' => ['description' => 'The status of real-time synchronization.', 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'RealtimeMigrationErrorMessage' => ['description' => 'The error message that is returned if an error occurs during real-time synchronization. If no error occurs, no value is returned for this parameter.', 'type' => 'string', 'example' => 'sync table t1 fail.'."\n", 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + '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.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-4ED0-9441\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": \\"131\\",\\n \\"PageSize\\": \\"10\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"JobRunInfos\\": [\\n {\\n \\"SourceDatasourceName\\": \\"ds_name\\",\\n \\"SourceDatabaseName\\": \\"db_name\\",\\n \\"SourceSchemaName\\": \\"schema_name\\",\\n \\"SourceTableName\\": \\"table_name\\",\\n \\"DestinationDatasourceName\\": \\"dst_name\\",\\n \\"DestinationDatabaseName\\": \\"dst_db\\",\\n \\"DestinationSchemaName\\": \\"dst_schema\\",\\n \\"DestinationTableName\\": \\"dst_name\\",\\n \\"StructureMigrationStatus\\": \\"Finished\\",\\n \\"StructureMigrationErrorMessage\\": \\"create table t1 fail.\\",\\n \\"FullMigrationStatus\\": \\"Finished\\",\\n \\"FullMigrationErrorMessage\\": \\"sync table t1 fail.\\",\\n \\"OfflineErrorRecords\\": 0,\\n \\"OfflineTotalBytes\\": 100,\\n \\"OfflineTotalRecords\\": 10,\\n \\"RealtimeMigrationStatus\\": \\"Running\\",\\n \\"RealtimeMigrationErrorMessage\\": \\"sync table t1 fail.\\\\n\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListDIJobRunDetails', + 'description' => 'This API operation is available for all DataWorks editions.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8abcb91f-d266-4073-b907-2ed670378ed1\\"\\n}","type":"json"}]', - 'title' => 'UpdateIDEEventResult', + 'ramActions' => [], ], - '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' => [ - 'https', - ], + 'ListDIJobs' => [ + 'summary' => 'Lists Data Integration jobs.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -25292,2003 +28077,2184 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '269311', - 'abilityTreeNodes' => [ - 'FEATUREdide8FM783', - ], + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '234100', + 'abilityTreeNodes' => ['FEATUREdideBP0OJZ'], ], '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-2ed67****1', - ], + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Pages are numbered starting from 1. Default value: 1.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default: 10. Maximum: 100.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the Data Integration job.'."\n" + ."\n" + .'The name must be unique within the DataWorks workspace.', 'type' => 'string', 'required' => false, 'example' => 'test_export_01', 'title' => ''], + ], + [ + 'name' => 'SourceDataSourceType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the source data source. If you do not specify this parameter, jobs are not filtered by this criterion. Valid values: `PolarDB`, `MySQL`, `Kafka`, `LogHub`, `Hologres`, `Oracle`, `OceanBase`, `MongoDB`, `RedShift`, `Hive`, `SQLServer`, `Doris`, and `ClickHouse`.', 'type' => 'string', 'required' => false, 'example' => 'MySQL', 'title' => ''], + ], + [ + 'name' => 'DestinationDataSourceType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the destination data source. If you do not specify this parameter, jobs are not filtered by this criterion. Valid values: `Hologres`, `OSS-HDFS`, `OSS`, `MaxCompute`, `LogHub`, `StarRocks`, `DataHub`, `AnalyticDB_For_MySQL`, `Kafka`, and `Hive`.', 'type' => 'string', 'required' => false, 'example' => 'Hologres', 'title' => ''], + ], + [ + 'name' => 'MigrationType', + 'in' => 'query', + 'schema' => ['description' => 'The synchronization type. Valid values:'."\n" + ."\n" + .'- `FullAndRealtimeIncremental`: full and real-time incremental synchronization'."\n" + ."\n" + .'- `RealtimeIncremental`: real-time incremental synchronization'."\n" + ."\n" + .'- `Full`: full synchronization'."\n" + ."\n" + .'- `OfflineIncremental`: offline incremental synchronization'."\n" + ."\n" + .'- `FullAndOfflineIncremental`: full and offline incremental synchronization', 'type' => 'string', 'required' => false, 'example' => 'FullAndRealtimeIncremental', 'title' => ''], ], [ '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', - ], + 'in' => 'query', + 'schema' => ['description' => 'The ID of the DataWorks workspace.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1967', 'title' => ''], + ], + [ + 'name' => 'SpecType', + 'in' => 'query', + 'schema' => ['description' => 'The configuration type of the job. Valid values: `FILESPEC`, `CLASSIC`, and `ALL`. `FILESPEC` indicates a new job type configured based on a structured file specification. `CLASSIC` indicates a job configured in the traditional mode. If you set this parameter to `ALL`, jobs of both types are returned.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response object.', '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", + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '7263E4AC-9D2E-5B29-B8AF-7C5012E92A41'], + 'PagingInfo' => [ + 'description' => 'The paging information.', '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", - '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_source', - ], - 'Content' => [ - 'description' => 'The code in the file of the current version.'."\n", - 'type' => 'string', - 'example' => 'SHOW TABLES;', - ], - 'FileType' => [ - 'description' => 'The file type. The code for files varies based on the file type. For more information, see [DataWorks nodes](~~600169~~).'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - ], - ], - '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 file type. The code for 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_source', - ], - '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 node in DataStudio.'."\n" - .'* ADHOCQUERY: The file is used for an ad hoc query.'."\n" - .'* COMPONENT: The file is used for a script template.'."\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', - ], - ], - ], - '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 file type. The code for 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 node in DataStudio.'."\n" - .'* ADHOCQUERY: The file is used for an ad hoc query.'."\n" - .'* COMPONENT: The file is used for a script template.'."\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_source', - ], - '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 on the DataStudio page 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 on the DataStudio page in the [DataWorks console](https://workbench.data.aliyun.com/console). For more information about the configurations of 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 on the DataStudio page 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 on the DataStudio page 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 information about the parent files on which the current file depends.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The output information about the parent file 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 on the DataStudio page 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', - ], - ], - ], - ], - 'OutputList' => [ - 'description' => 'The output information about the current file.'."\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 on the DataStudio page 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 on the DataStudio page in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", - 'type' => 'string', - 'example' => 'dw_project.002_out', - ], - ], - ], - ], - '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', - ], - ], - ], - ], - ], - '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" + 'TotalCount' => ['description' => 'The total number of entries that meet the filter criteria.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'PageNumber' => ['description' => 'The returned page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'DIJobs' => [ + 'description' => 'A list of Data Integration jobs.', + 'type' => 'array', + 'items' => [ + 'description' => 'Details of a Data Integration job.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the Data Integration job.', 'type' => 'integer', 'format' => 'int64', 'example' => '32599', 'title' => ''], + 'ProjectId' => ['description' => 'The ID of the DataWorks workspace that contains the job.', 'type' => 'integer', 'format' => 'int64', 'example' => '26442', 'title' => ''], + 'JobName' => ['description' => 'The name of the job.', 'type' => 'string', 'example' => 'mysql_to_holo_sync_35197', 'title' => ''], + 'MigrationType' => ['description' => 'The synchronization type. Valid values:'."\n" ."\n" - .'* DEV'."\n" - .'* PROD'."\n", - 'type' => 'string', - 'example' => 'DEV', - ], - 'LifeCycle' => [ - 'description' => 'The lifecycle of the table. 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_source', - ], - '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', - ], - 'ColumnType' => [ - 'description' => 'The data type of the column.'."\n", - 'type' => 'string', - 'example' => 'BIGINT', - ], - 'IsPartitionColumn' => [ - 'description' => 'Indicates whether the column is a partition key column. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'Comment' => [ - 'description' => 'The remarks of the column.'."\n", - 'type' => 'string', - 'example' => 'ID', - ], - ], - ], - ], - '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', + .'- `FullAndRealtimeIncremental`: full and real-time incremental synchronization'."\n" + ."\n" + .'- `RealtimeIncremental`: real-time incremental synchronization'."\n" + ."\n" + .'- `Full`: full synchronization'."\n" + ."\n" + .'- `OfflineIncremental`: offline incremental synchronization'."\n" + ."\n" + .'- `FullAndOfflineIncremental`: full and offline incremental synchronization', 'type' => 'string', 'example' => 'FullAndRealtimeIncremental', 'title' => ''], + 'SourceDataSourceType' => ['description' => 'The type of the source data source. Valid values: `PolarDB`, `MySQL`, `Kafka`, `LogHub`, `Hologres`, `Oracle`, `OceanBase`, `MongoDB`, `RedShift`, `Hive`, `SQLServer`, `Doris`, and `ClickHouse`.', 'type' => 'string', 'example' => 'Mysql', 'title' => ''], + 'DestinationDataSourceType' => ['description' => 'The type of the destination data source. Valid values: `Hologres`, `OSS-HDFS`, `OSS`, `MaxCompute`, `LogHub`, `StarRocks`, `DataHub`, `AnalyticDB_For_MySQL`, `Kafka`, and `Hive`.', 'type' => 'string', 'example' => 'Hologres', 'title' => ''], + 'JobStatus' => ['description' => 'The job status. Valid values:'."\n" + ."\n" + .'- `Finished`: The job completed successfully.'."\n" + ."\n" + .'- `Initialized`: The job is initialized.'."\n" + ."\n" + .'- `Stopped`: The job is stopped.'."\n" + ."\n" + .'- `Failed`: The job failed.'."\n" + ."\n" + .'- `Running`: The job is running.'."\n" + ."\n" + .'- `Stopping`: The job is being stopped.', 'type' => 'string', 'example' => 'Running', 'title' => ''], + 'DIJobId' => ['description' => 'This parameter is deprecated. Use the `Id` parameter instead.', 'type' => 'integer', 'format' => 'int64', 'deprecated' => true, 'example' => '32599', 'title' => ''], + 'Owner' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + '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.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError.System', - 'errorMessage' => 'An internal system error occurred. Try again later.', - ], - ], - ], - '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"}]', - 'title' => 'GetIDEEventDetail', - ], - 'EstablishRelationTableToBusiness' => [ - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListDIJobs', + 'description' => 'This operation requires DataWorks Basic Edition or a later edition.', + 'changeSet' => [ + ['createdAt' => '2025-01-06T05:34:14.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7263E4AC-9D2E-5B29-B8AF-7C5012E92A41\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 12,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"DIJobs\\": [\\n {\\n \\"Id\\": 32599,\\n \\"ProjectId\\": 26442,\\n \\"JobName\\": \\"mysql_to_holo_sync_35197\\",\\n \\"MigrationType\\": \\"FullAndRealtimeIncremental\\",\\n \\"SourceDataSourceType\\": \\"Mysql\\",\\n \\"DestinationDataSourceType\\": \\"Hologres\\",\\n \\"JobStatus\\": \\"Running\\",\\n \\"DIJobId\\": 32599,\\n \\"Owner\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListDataAssetTags' => [ + 'summary' => 'Queries a list of tags.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '269310', - 'abilityTreeNodes' => [ - 'FEATUREdideEPPSOE', - ], + 'operationType' => 'list', + 'riskType' => 'none', + 'abilityTreeCode' => '250731', + 'abilityTreeNodes' => ['FEATUREdideKQ371B'], ], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the DataWorks workspace. You can click the wrench icon in the top-right corner to access the workspace management page and view the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '10000', - ], + 'name' => 'Key', + 'in' => 'query', + 'schema' => ['description' => 'The tag key.', 'type' => 'string', 'maxLength' => 128, 'minLength' => 1, 'required' => false, 'example' => 'key1', 'title' => ''], ], [ - 'name' => 'ProjectIdentifier', - 'in' => 'formData', + 'name' => 'Category', + 'in' => 'query', 'schema' => [ - 'description' => 'The unique identifier of the DataWorks workspace. This is the identifier shown in the workspace switcher at the top of the Data Studio page.'."\n" + 'description' => 'The type of the tag. Valid values:'."\n" + ."\n" + .'- Normal'."\n" ."\n" - .'Either this parameter or ProjectId must be specified to determine which DataWorks workspace this API call operates on.'."\n", + .'- System', + 'enumValueTitles' => [], 'type' => 'string', + 'enum' => ['Normal', 'System'], 'required' => false, - 'example' => 'dw', - ], - ], - [ - 'name' => 'BusinessId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The workflow ID. You can call the [ListBusiness](~~173945~~) operation to obtain the workflow ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1000001', + 'example' => 'Normal', + 'title' => '', ], ], [ - 'name' => 'TableGuid', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The UUID of the table. You can call the [SearchMetaTables](~~173919~~) operation to obtain the table UUID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'odps.dw_project.tb1', - ], + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '200', 'minimum' => '1', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'FolderId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the folder. You can call the [GetFolder](~~173952~~) or [ListFolders](~~173955~~) operation to obtain the folder ID.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '2eb6f9****', - ], + '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', 'default' => '10', 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response.'."\n", + 'title' => 'Schema of Response', + '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' => 'The connection does not exist.', - ], - 'RequestId' => [ - 'description' => 'The unique ID of this request. You can use this ID to troubleshoot issues if errors occur.'."\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 succeeded. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0bc1ec92159376****'], + 'PagingInfo' => [ + 'description' => 'The pagination information.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '2524', 'title' => ''], + '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' => ''], + 'DataAssetTags' => [ + 'description' => 'The tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tag.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'key1', 'title' => ''], + 'Category' => [ + 'description' => 'The type of the tag.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- Normal'."\n" + ."\n" + .'- System', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'Normal', + 'title' => '', + ], + 'Description' => ['description' => 'The description of the tag.', 'type' => 'string', 'example' => 'This is a description', 'title' => ''], + 'ValueType' => ['description' => 'The type of the tag value.', 'type' => 'string', 'example' => 'String', 'title' => ''], + 'Values' => [ + 'description' => 'The tag values.', + 'type' => 'array', + 'items' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'v1', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Managers' => [ + 'description' => 'The tag administrators.', + 'type' => 'array', + 'items' => ['description' => 'The employee ID of the tag administrator.', 'type' => 'string', 'example' => '12345', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'ModifyTime' => ['description' => 'The time when the tag was last modified.', 'type' => 'integer', 'format' => 'int64', 'example' => '1735890003000', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the tag was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1735890003000', 'title' => ''], + 'CreateUser' => ['description' => 'The creator of the tag.', 'type' => 'string', 'example' => '12345', 'title' => ''], + 'ModifyUser' => ['description' => 'The user who last modified the tag.', 'type' => 'string', 'example' => '1234', 'title' => ''], + ], + '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.', - ], - ], - 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 \\"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' => '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.', - ], - 'CreateDIJob' => [ - 'summary' => 'Creates a new-version synchronization task.', - 'methods' => [ - 'get', - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc1ec92159376****\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 2524,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"DataAssetTags\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Category\\": \\"Normal\\",\\n \\"Description\\": \\"This is a description\\",\\n \\"ValueType\\": \\"String\\",\\n \\"Values\\": [\\n \\"v1\\"\\n ],\\n \\"Managers\\": [\\n \\"12345\\"\\n ],\\n \\"ModifyTime\\": 1735890003000,\\n \\"CreateTime\\": 1735890003000,\\n \\"CreateUser\\": \\"12345\\",\\n \\"ModifyUser\\": \\"1234\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListDataAssetTags', + 'description' => 'This API operation is available only for DataWorks Enterprise Edition or a more advanced edition.', + 'changeSet' => [ + ['createdAt' => '2025-05-19T03:26:56.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'ListDataAssets' => [ + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'list', 'riskType' => 'none', - 'chargeType' => 'paid', - 'abilityTreeCode' => '234097', - 'abilityTreeNodes' => [ - 'FEATUREdideBP0OJZ', - ], + 'chargeType' => 'free', + 'abilityTreeCode' => '253908', + 'abilityTreeNodes' => ['FEATUREdideKQ371B'], ], 'parameters' => [ [ - 'name' => 'DestinationDataSourceType', + 'name' => 'Tags', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The destination type. Valid values: Hologres, OSS-HDFS, OSS, MaxCompute, LogHub, StarRocks, DataHub, AnalyticDB for MySQL, Kafka, and Hive.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Hologres', - ], - ], - [ - 'name' => 'Description', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The task description.'."\n", - 'type' => 'string', + 'description' => 'The list of tags associated with data assets. Tags are used as query filters:'."\n" + .'- Multiple values have an OR relationship. For example, `["key1:v1", "key2:v1", "key3:v1"]` queries data assets that contain any of the specified tags.'."\n" + .'- If this parameter is not specified or is left empty, no tag-based filtering is applied.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tag key-value pair definition.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The custom tag key.'."\n" + ."\n" + .'The tag key can be up to 64 characters in length, cannot start with `dw:`, and supports only letters, digits, and the following special characters: `-@#*<>|[]()+=&%$!~`.', 'type' => 'string', 'required' => false, 'pattern' => '^[\\u4E00-\\u9FA5A-Za-z0-9_\\-@#*<>|\\[\\]()+=&%$!~]+$', 'example' => 'key', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'pattern' => '^[\\u4E00-\\u9FA5A-Za-z0-9_\\-@#*<>|\\[\\]()+=&%$!~]+$', 'required' => false, 'example' => 'value', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'The description of the synchronization task.'."\n" - ."\n", + 'maxItems' => 20, + 'minItems' => 1, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'SourceDataSourceType', + 'name' => 'DataAssetIds', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The source type. Valid values: PolarDB, MySQL, Kafka, LogHub, Hologres, Oracle, OceanBase, MongoDB, Redshift, Hive, SQL Server, Doris, and ClickHouse.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'MySQL', + 'description' => 'The list of unique data asset IDs.', + 'type' => 'array', + 'items' => ['description' => 'The unique ID of the data asset.', 'type' => 'string', 'required' => false, 'example' => '7000069357000', 'title' => ''], + 'required' => false, + 'maxItems' => 100, + 'minItems' => 0, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ProjectId', + 'name' => 'DataAssetType', '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" + 'description' => 'The Asset Type of the data asset. Valid values:'."\n" + ."\n" + .'- ACS::DataWorks::Table: table.'."\n" ."\n" - .'You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.'."\n", - 'type' => 'integer', - 'format' => 'int64', + .'- ACS::DataWorks::Task: scheduling node.', + 'enumValueTitles' => [], + 'type' => 'string', 'required' => false, - 'example' => '10000', + 'enum' => ['ACS::DataWorks::Table', 'ACS::DataWorks::Task'], + 'example' => 'ACS::DataWorks::Task', + 'title' => '', ], ], [ - 'name' => 'Name', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the synchronization task.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mysql_to_holo_sync_8772', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000', 'title' => ''], ], [ - 'name' => 'MigrationType', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The synchronization type. Valid values:'."\n" - ."\n" - .'* FullAndRealtimeIncremental'."\n" - .'* RealtimeIncremental'."\n" - .'* Full'."\n" - .'* OfflineIncremental'."\n" - .'* FullAndOfflineIncremental'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'FullAndRealtimeIncremental', - ], + 'schema' => ['description' => 'The page number. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '200', 'minimum' => '1', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'JobType', + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'EnvType', 'in' => 'query', 'schema' => [ - 'description' => 'The type of the synchronization task. Valid values:'."\n" - ."\n" - .'* DatabaseRealtimeMigration: A real-time synchronization task used to synchronize only full data, only incremental data, or full and incremental data in multiple tables of multiple databases in the source.'."\n" - .'* DatabaseOfflineMigration: A batch synchronization task used to synchronize only full data, only incremental data, or full and incremental data in multiple tables of multiple databases in the source.'."\n" - .'* SingleTableRealtimeMigration: A real-time synchronization task used to synchronize data only in a single table in the source.'."\n", + 'description' => 'The workspace environment to which the data asset belongs. Valid values:'."\n" + .'- Dev: development environment.'."\n" + .'- Prod: production environment.', + 'enumValueTitles' => [], 'type' => 'string', + 'enum' => ['Prod', 'Dev'], 'required' => false, - 'example' => 'DatabaseRealtimeMigration', + 'example' => 'Prod', + 'title' => '', ], ], [ - 'name' => 'SourceDataSourceSettings', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The list of source data source settings.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'A single source data source setting.'."\n", - 'type' => 'object', - 'properties' => [ - 'DataSourceName' => [ - 'description' => 'The data source name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mysql_datasource_1', - ], - 'DataSourceProperties' => [ - 'description' => 'The data source properties.'."\n", - 'type' => 'object', - 'properties' => [ - 'Encoding' => [ - 'description' => 'The database encoding.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'UTF-8', - ], - 'Timezone' => [ - 'description' => 'The time zone.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GMT+8', - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => true, - ], + 'name' => 'AssetDomainId', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'example' => '1001', 'description' => '', 'title' => ''], ], [ - 'name' => 'DestinationDataSourceSettings', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The list of destination data source settings.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'A single destination data source setting.'."\n", - 'type' => 'object', - 'properties' => [ - 'DataSourceName' => [ - 'description' => 'The data source name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'holo_datasource_1', - ], - ], - 'required' => false, - ], - 'required' => true, - ], + 'name' => 'CategoryUuid', + 'in' => 'query', + 'schema' => ['type' => 'string', 'example' => 'cate-xxxxxxxx', 'description' => '', 'title' => ''], ], [ - 'name' => 'ResourceSettings', - 'in' => 'formData', - 'style' => 'json', + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['type' => 'string', 'example' => '资产域名称', 'description' => '', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The resource settings.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'OfflineResourceSettings' => [ - 'description' => 'The batch synchronization resources.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestedCu' => [ - 'description' => 'The CU of the Data Integration resource group used for batch synchronization.'."\n", - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '2.0', - ], - 'ResourceGroupIdentifier' => [ - 'description' => 'The name of the Data Integration resource group used for batch synchronization.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'S_res_group_111_222', - ], - ], - 'required' => false, - ], - 'RealtimeResourceSettings' => [ - 'description' => 'The real-time synchronization resources.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestedCu' => [ - 'description' => 'The CU of the Data Integration resource group used for real-time synchronization.'."\n", - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '2.0', - ], - 'ResourceGroupIdentifier' => [ - 'description' => 'The name of the Data Integration resource group used for real-time synchronization.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'S_res_group_111_222', - ], - ], - 'required' => false, - ], - 'ScheduleResourceSettings' => [ - 'description' => 'The scheduling resources.'."\n", + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0bc1ec92159376'], + 'PagingInfo' => [ + 'description' => 'The pagination information.', 'type' => 'object', 'properties' => [ - 'RequestedCu' => [ - 'description' => 'The CU of the scheduling resource group for batch synchronization tasks.'."\n", - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '2.0', - ], - 'ResourceGroupIdentifier' => [ - 'description' => 'The name of the scheduling resource group for batch synchronization tasks.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'S_res_group_235454102432001_1579085295030', + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', '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' => ''], + 'DataAssets' => [ + 'description' => 'The list of data assets.', + 'type' => 'array', + 'items' => [ + 'description' => 'The data asset schema definition.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The data asset ID.', 'type' => 'string', 'example' => '7259557313', 'title' => ''], + 'Name' => ['description' => 'The name of the data asset.', 'type' => 'string', 'example' => 'ali_cn_es_gfn', 'title' => ''], + 'Type' => [ + 'description' => 'The Asset Type of the data asset. Valid values:'."\n" + ."\n" + .'- ACS::DataWorks::Table: table.'."\n" + ."\n" + .'- ACS::DataWorks::Task: scheduling node.', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'ACS::DataWorks::Task', + 'title' => '', + ], + 'EnvType' => [ + 'description' => 'The workspace environment to which the data asset belongs. Valid values:'."\n" + .'- Dev: development environment.'."\n" + .'- Prod: production environment.', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'Prod', + 'title' => '', + ], + 'ProjectId' => ['description' => 'The DataWorks workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '54275', 'title' => ''], + 'DataAssetTagMappings' => [ + 'description' => 'The list of tags associated with the data asset.', + 'type' => 'array', + 'items' => [ + 'description' => 'The schema definition of the mapping between a data asset and a tag.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'key', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'value', 'title' => ''], + 'TagSource' => [ + 'description' => 'The source of the mapping between the data asset and the tag. Valid values:'."\n" + ."\n" + .'- System: The mapping is created by the data asset governance system.'."\n" + .'- UserDefined: The mapping is manually created by a user.', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'UserDefined', + 'title' => '', + ], + 'Creator' => ['description' => 'The creator of the mapping between the data asset and the tag.', 'type' => 'string', 'example' => '12345', 'title' => ''], + 'AutoTraceEnabled' => ['description' => 'Indicates whether automatic lineage tracing is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'DataAssetId' => ['description' => 'The data asset ID.', 'type' => 'string', 'example' => '7259557313', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'AssetCategories' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['type' => 'string', 'example' => 'cate-xxxxxx', 'description' => '', 'title' => ''], + 'Name' => ['type' => 'string', 'example' => '资产域名称', 'description' => '', 'title' => ''], + 'AssetDomainId' => ['type' => 'string', 'example' => '1001', 'description' => '', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], - 'required' => false, + 'title' => '', + 'example' => '', ], ], - 'required' => true, + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query data assets associated with tags', + 'summary' => 'Queries DataWorks data assets that are associated with tags by paging.', + 'description' => 'You must purchase DataWorks Enterprise Edition or a higher edition to use this feature.', + 'changeSet' => [ + ['createdAt' => '2025-05-19T03:26:56.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"DataAssets\\": [\\n {\\n \\"Id\\": \\"7259557313\\",\\n \\"Name\\": \\"ali_cn_es_gfn\\",\\n \\"Type\\": \\"ACS::DataWorks::Task\\",\\n \\"EnvType\\": \\"Prod\\",\\n \\"ProjectId\\": 54275,\\n \\"DataAssetTagMappings\\": [\\n {\\n \\"Key\\": \\"key\\",\\n \\"Value\\": \\"value\\",\\n \\"TagSource\\": \\"UserDefined\\",\\n \\"Creator\\": \\"12345\\",\\n \\"AutoTraceEnabled\\": false,\\n \\"DataAssetId\\": \\"7259557313\\"\\n }\\n ],\\n \\"AssetCategories\\": [\\n {\\n \\"Id\\": \\"cate-xxxxxx\\",\\n \\"Name\\": \\"资产域名称\\",\\n \\"AssetDomainId\\": \\"1001\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListDataQualityAlertRules' => [ + 'summary' => 'Queries the list of data quality alert rules in a project.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'TransformationRules', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The list of synchronization object transformation rule definitions.'."\n" - ."\n" - .'> \\[ { "RuleName":"my_database_rename_rule", "RuleActionType":"Rename", "RuleTargetType":"Schema", "RuleExpression":"{"expression":"${srcDatasoureName}\\_${srcDatabaseName}"}" } ]'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'A single synchronization object transformation rule definition.'."\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" - .'* DefinePartitionKey'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Rename', - ], - 'RuleExpression' => [ - 'description' => 'The rule expression in JSON string format.'."\n" - ."\n" - .'1. Rename rule'."\n" - ."\n" - .'* Example: {"expression":"${srcDatasourceName}\\_${srcDatabaseName}\\_0922" }'."\n" - .'* expression: The rename transformation expression. Supported variables include: ${srcDatasourceName} (source data source name), ${srcDatabaseName} (source database name), and ${srcTableName} (source table name).'."\n" - ."\n" - .'2. AddColumn rule'."\n" - ."\n" - .'* Example: {"columns":\\[{"columnName":"my_add_column","columnValueType":"Constant","columnValue":"123"}]}'."\n" - .'* If not specified, the default behavior is to not add columns.'."\n" - .'* columnName: The name of the column to add.'."\n" - .'* columnValueType: The value type of the column to add. Valid values: Constant and Variable.'."\n" - .'* columnValue: The value of the column to add. When columnValueType is set to Constant, the value is a custom constant of the string type. When columnValueType is set to Variable, the value is a built-in variable. Built-in variables include: EXECUTE_TIME (execution time, long type), DB_NAME_SRC (source database name, string type), DATASOURCE_NAME_SRC (source data source name, string type), TABLE_NAME_SRC (source table name, string type), DB_NAME_DEST (destination database name, string type), DATASOURCE_NAME_DEST (destination data source name, string type), TABLE_NAME_DEST (destination table name, string type), and DB_NAME_SRC_TRANSED (transformed source database name, string type).'."\n" - ."\n" - .'3. DefinePrimaryKey'."\n" - ."\n" - .'* Example: {"columns":\\["ukcolumn1","ukcolumn2"]}'."\n" - .'* If not specified, the source primary key columns are used by default.'."\n" - .'* When the destination table already exists: Data Integration does not modify the destination table structure. If the specified primary key columns are not in the destination table, the task fails to start.'."\n" - .'* When the destination table is auto-created: Data Integration automatically creates the destination table structure with the defined primary key columns. If the specified primary key columns are not in the destination table, the task fails to start.'."\n" - ."\n" - .'4. HandleDml rule'."\n" - ."\n" - .'* Example of a rule used to process DML messages: {"dmlPolicies":\\[{"dmlType":"Delete","dmlAction":"Filter","filterCondition":"id > 1"}]}.'."\n" - .'* If not specified, the default rule is Normal for Insert, Update, and Delete.'."\n" - .'* dmlType: The DML operation type. Valid values: Insert, Update, and Delete.'."\n" - .'* dmlAction: The DML handling policy. Valid values: Normal, Ignore, Filter (conditional processing, used when dmlType is Update or Delete), and LogicalDelete.'."\n" - .'* filterCondition: The DML filter condition. This parameter is used when dmlAction is set to Filter.'."\n" - ."\n" - .'5. DefineIncrementalCondition'."\n" - ."\n" - .'* Example: {"where":"id > 0"}'."\n" - .'* Specifies the incremental filter condition.'."\n" - ."\n" - .'6. DefineCycleScheduleSettings'."\n" - ."\n" - .'* Example: {"cronExpress":" \\* \\* \\* \\* \\* \\*", "cycleType":"1"}'."\n" - .'* Specifies the scheduled task parameters.'."\n" - ."\n" - .'7. DefinePartitionKey'."\n" - ."\n" - .'* Example: {"columns":\\["id"]}'."\n" - .'* Specifies the partition key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"expression":"${srcDatasoureName}_${srcDatabaseName}"}', - ], - 'RuleName' => [ - 'description' => 'The rule name. When the action type and target type are the same, the rule name must be unique. The name cannot exceed 50 characters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rename_rule_1', - ], - 'RuleTargetType' => [ - 'description' => 'The target type for the action. Valid values:'."\n" - ."\n" - .'* Table'."\n" - .'* Schema'."\n" - .'* Database'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Table', - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdide3WJOKE'], + ], + 'parameters' => [ [ - 'name' => 'TableMappings', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The list of synchronization object transformation mappings. Each element describes a set of source object selection rules and the transformation rules applied to those objects.'."\n" - ."\n" - .'> \\[ { "SourceObjectSelectionRules":\\[ { "ObjectType":"Database", "Action":"Include", "ExpressionType":"Exact", "Expression":"biz_db" }, { "ObjectType":"Schema", "Action":"Include", "ExpressionType":"Exact", "Expression":"s1" }, { "ObjectType":"Table", "Action":"Include", "ExpressionType":"Exact", "Expression":"table1" } ], "TransformationRuleNames":\\[ { "RuleName":"my_database_rename_rule", "RuleActionType":"Rename", "RuleTargetType":"Schema" } ] } ]'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Each rule represents the selection of a table to synchronize.'."\n", - 'type' => 'object', - 'properties' => [ - 'SourceObjectSelectionRules' => [ - 'description' => 'Each rule can select a set of source objects to synchronize. Multiple rules together select a table.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Each rule can select different object types from the source, such as source databases and source tables.'."\n", - 'type' => 'object', - 'properties' => [ - 'Action' => [ - 'description' => 'The selection action. Valid values: Include and Exclude.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Include', - ], - 'Expression' => [ - 'description' => 'The expression.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mysql_table_1', - ], - 'ExpressionType' => [ - 'description' => 'The expression type. Valid values: Exact and Regex.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Exact', - ], - 'ObjectType' => [ - 'description' => 'The object type. Valid values:'."\n" - ."\n" - .'* Table'."\n" - .'* Schema'."\n" - .'* Database'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Table', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'TransformationRules' => [ - 'description' => 'The list of synchronization object transformation rule definitions. Each element represents a single transformation rule definition.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The transformation rules applied to source objects.'."\n", - 'type' => 'object', - 'properties' => [ - 'RuleName' => [ - 'description' => 'The rule name. The rule name must be unique for a given combination of action type and target type. The name cannot exceed 50 characters.'."\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" - .'* DefinePartitionKey'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Rename', - ], - 'RuleTargetType' => [ - 'description' => 'The target type for the action. Valid values:'."\n" - ."\n" - .'* Table'."\n" - .'* Schema'."\n" - .'* Database'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Table', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => true, - ], + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10001', 'title' => ''], ], [ - 'name' => 'JobSettings', - 'in' => 'formData', - 'style' => 'json', + 'name' => 'DataQualityScanId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the data quality monitor that the alert rule targets.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10001', 'title' => ''], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => ['description' => 'The list of sorting fields. Supports fields such as last modified time and creation time. Format: "SortField+SortOrder (Desc/Asc)", where Asc is the default. Valid values:'."\n" + ."\n" + .'- CreateTime (Desc/Asc)'."\n" + ."\n" + .'- Id (Desc/Asc)', 'type' => 'string', 'required' => false, 'example' => 'CreateTime Desc', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number of the results.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'minimum' => '1', 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of records to return on each page.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '200', 'minimum' => '1', 'example' => '10', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The task-level settings, including DDL handling policies, column data type mapping between source and destination, and runtime parameters.'."\n", + 'title' => 'Schema of Response', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'ChannelSettings' => [ - 'description' => 'The channel-specific settings. You can configure special settings for specific channels. Currently supported: Holo2Holo (Hologres to Hologres) and Holo2Kafka (Hologres to Kafka).'."\n" - ."\n" - .'1. Holo2Kafka'."\n" - ."\n" - .'* Example: {"destinationChannelSettings":{"kafkaClientProperties":\\[{"key":"linger.ms","value":"100"}],"keyColumns":\\["col3"],"writeMode":"canal"}} kafkaClientProperties: Kafka producer parameters used when writing to Kafka.'."\n" - .'* keyColumns: The columns to write to Kafka.'."\n" - .'* writeMode: The Kafka write format. Valid values: json and canal.'."\n" - ."\n" - .'2. Holo2Holo'."\n" - ."\n" - .'* Example: {"destinationChannelSettings":{"conflictMode":"replace","dynamicColumnAction":"replay","writeMode":"replay"}}'."\n" - .'* conflictMode: The conflict handling policy when writing to Hologres. Valid values: replace (overwrite) and ignore.'."\n" - .'* writeMode: The write mode for Hologres. Valid values: replay and insert.'."\n" - .'* dynamicColumnAction: The dynamic column handling mode when writing to Hologres. Valid values: replay, insert, and ignore.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"structInfo":"MANAGED","storageType":"TEXTFILE","writeMode":"APPEND","partitionColumns":[{"columnName":"pt","columnType":"STRING","comment":""}],"fieldDelimiter":""}'."\n", - ], - 'ColumnDataTypeSettings' => [ - 'description' => 'The array of column type mappings.'."\n" - ."\n" - .'> \\["ColumnDataTypeSettings":\\[ { "SourceDataType":"Bigint", "DestinationDataType":"Text" } ]'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'A single column type mapping.'."\n", - 'type' => 'object', - 'properties' => [ - 'DestinationDataType' => [ - 'description' => 'The destination type, such as bigint, boolean, string, text, datetime, timestamp, decimal, or binary. Different data sources may have different types.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'text', - ], - 'SourceDataType' => [ - 'description' => 'The source type, such as bigint, boolean, string, text, datetime, timestamp, decimal, or binary. Different data sources may have different types.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'bigint', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'CycleScheduleSettings' => [ - 'description' => 'The scheduled task settings.'."\n", + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0bc14115***159376359'], + 'PageInfo' => [ + 'description' => 'Alert rule configurations.', 'type' => 'object', 'properties' => [ - 'CycleMigrationType' => [ - 'description' => 'The synchronization type that requires 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, - ], - 'DdlHandlingSettings' => [ - 'description' => 'The array of DDL handling settings.'."\n" - ."\n" - .'> \\["DDLHandlingSettings":\\[ { "Type":"Insert", "Action":"Normal" } ]'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'A single DDL handling setting.'."\n", - 'type' => 'object', - 'properties' => [ - 'Action' => [ - 'description' => 'Valid values:'."\n" - ."\n" - .'* Ignore'."\n" - .'* Critical: Fail the task'."\n" - .'* Normal'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Critical', - ], - 'Type' => [ - 'description' => 'The DDL type. Valid values:'."\n" - ."\n" - .'* RenameColumn'."\n" - .'* ModifyColumn'."\n" - .'* CreateTable'."\n" - .'* TruncateTable'."\n" - .'* DropTable'."\n" - .'* DropColumn'."\n" - .'* AddColumn'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'AddColumn', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'RuntimeSettings' => [ - 'description' => 'The runtime settings.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The setting name. Valid values:'."\n" - ."\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" - .'* dst.offline.truncate: Specifies whether to clear the destination table before data writing.'."\n" - .'* runtime.offline.speed.limit.enable: Specifies whether throttling is enabled for a batch synchronization task.'."\n" - .'* runtime.offline.concurrent: Specifies the maximum number of parallel threads that are allowed for a batch synchronization task.'."\n" - .'* runtime.enable.auto.create.schema: Specifies whether schemas are automatically created in the destination of a synchronization task.'."\n" - .'* runtime.realtime.concurrent: Specifies the maximum number of parallel threads that are allowed for a real-time synchronization task.'."\n" - .'* runtime.realtime.failover.minute.dataxcdc: Specifies the maximum waiting duration before a synchronization task retries the next restart if the previous restart fails after failover occurs. Unit: minutes.'."\n" - .'* runtime.realtime.failover.times.dataxcdc: Specifies the maximum number of failures that are allowed for restarting a synchronization task after failovers occur.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'runtime.offline.concurrent', - ], - 'Value' => [ - 'description' => 'The setting value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '335', 'title' => ''], + 'PageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'DataQualityAlertRules' => [ + 'description' => 'The list of alert rule configurations.', + 'type' => 'array', + 'items' => [ + 'description' => 'Alert rule configurations.', + 'type' => 'object', + 'properties' => [ + 'Condition' => ['description' => 'The alert conditions.', 'type' => 'string', 'example' => 'results.any { r -> r.status == \'fail\' && r.rule.severity == \'High\' }', 'title' => ''], + 'Target' => [ + 'description' => 'Monitored targets of the data quality alert rule.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The type of the monitored target. Only DataQualityScan is supported.', 'type' => 'string', 'example' => 'DataQualityScan', 'title' => ''], + 'Ids' => [ + 'description' => 'The list of monitored target IDs', + 'type' => 'array', + 'items' => ['description' => 'The ID of the monitored target.', 'type' => 'integer', 'format' => 'int64', 'example' => '7638999336', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'ProjectId' => ['description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '59094', 'title' => ''], + 'Id' => ['description' => 'The ID of the data quality monitor alert rule.', 'type' => 'integer', 'format' => 'int64', 'example' => '26433', 'title' => ''], + 'Notification' => [ + 'description' => 'Alert notification configurations.', + 'type' => 'object', + 'properties' => [ + 'Receivers' => [ + 'description' => 'The alert recipients.', + 'type' => 'array', + 'items' => [ + 'description' => 'The alert recipients.', + 'type' => 'object', + 'properties' => [ + 'Extension' => ['description' => 'Additional configurations required for the alert recipients. When ReceiverType is DingdingUrl, you can set `{"atAll":true}` to mention all members.', 'type' => 'string', 'example' => '{"atAll":true}', 'title' => ''], + 'ReceiverType' => [ + 'description' => 'The type of alert recipients.'."\n" + ."\n" + .'- ShiftSchedule'."\n" + ."\n" + .'- WebhookUrl'."\n" + ."\n" + .'- FeishuUrl'."\n" + ."\n" + .'- TaskOwner'."\n" + ."\n" + .'- WeixinUrl'."\n" + ."\n" + .'- DingdingUrl'."\n" + ."\n" + .'- DataQualityScanOwner'."\n" + ."\n" + .'- AliUid', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'AliUid', + 'title' => '', + ], + 'ReceiverValues' => [ + 'description' => 'The value of alert recipients.', + 'type' => 'array', + 'items' => ['description' => 'The value of alert recipients.'."\n" + ."\n" + .'- If ReceiverType is AliUid, enter the Alibaba Cloud account ID.'."\n" + ."\n" + .'- If ReceiverType is ShiftSchedule, enter the shift schedule ID.'."\n" + ."\n" + .'- If ReceiverType is WebhookUrl, DingdingUrl, FeishuUrl, or WeixinUrl, enter the corresponding URL.', 'type' => 'string', 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=a30bae7******', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Channels' => [ + 'description' => 'In Channels, you can set both Email and Sms at the same time. In other cases, only one channel can be set.', + 'type' => 'array', + 'items' => [ + 'description' => 'Alert channels.'."\n" + ."\n" + .'- Mail'."\n" + ."\n" + .'- Weixin'."\n" + ."\n" + .'- Feishu'."\n" + ."\n" + .'- Phone'."\n" + ."\n" + .'- Sms'."\n" + ."\n" + .'- Webhook', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'Sms', + 'title' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'required' => false, - 'description' => '', ], - 'required' => false, + 'title' => '', + 'example' => '', ], ], - 'required' => false, + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListDataQualityAlertRules', + 'description' => 'DataWorks Basic Edition or a higher edition is required.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:ListDataQualityAlertRules', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115***159376359\\",\\n \\"PageInfo\\": {\\n \\"TotalCount\\": 335,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"DataQualityAlertRules\\": [\\n {\\n \\"Condition\\": \\"results.any { r -> r.status == \'fail\' && r.rule.severity == \'High\' }\\",\\n \\"Target\\": {\\n \\"Type\\": \\"DataQualityScan\\",\\n \\"Ids\\": [\\n 7638999336\\n ]\\n },\\n \\"ProjectId\\": 59094,\\n \\"Id\\": 26433,\\n \\"Notification\\": {\\n \\"Receivers\\": [\\n {\\n \\"Extension\\": \\"{\\\\\\"atAll\\\\\\":true}\\",\\n \\"ReceiverType\\": \\"AliUid\\",\\n \\"ReceiverValues\\": [\\n \\"https://oapi.dingtalk.com/robot/send?access_token=a30bae7******\\"\\n ]\\n }\\n ],\\n \\"Channels\\": [\\n \\"Sms\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListDataQualityEvaluationTaskInstances' => [ + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '240385', + 'abilityTreeNodes' => ['FEATUREdideGK4B66'], + 'autoTest' => true, + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the DataWorks workspace.', 'type' => 'integer', 'format' => 'int64', 'docRequired' => true, 'required' => true, 'example' => '100', 'title' => ''], + ], + [ + 'name' => 'DataQualityEvaluationTaskId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the data quality evaluation task.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000', 'title' => ''], + ], + [ + 'name' => 'TableGuid', + 'in' => 'query', + 'schema' => ['description' => 'The unique ID of the table in Data Map.', 'type' => 'string', 'required' => false, 'example' => 'odps.unit_test.tb_unit_test', 'title' => ''], + ], [ - 'name' => 'JobName', + 'name' => 'CreateTimeFrom', 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter is deprecated and is replaced by the Name parameter.'."\n", - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - 'example' => 'mysql_to_holo_sync_8772', - ], + 'schema' => ['description' => 'The earliest start time of the data quality evaluation task instance.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1710239005403', 'title' => ''], + ], + [ + 'name' => 'CreateTimeTo', + 'in' => 'query', + 'schema' => ['description' => 'The latest start time of the data quality evaluation task instance.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1710239005403', 'title' => ''], + ], + [ + 'name' => 'BizdateFrom', + 'in' => 'query', + 'schema' => ['description' => 'The business start date of the quality evaluation task.', 'type' => 'string', 'required' => false, 'example' => '2024-04-01', 'title' => ''], + ], + [ + 'name' => 'BizdateTo', + 'in' => 'query', + 'schema' => ['description' => 'The business end date of the quality evaluation task.', 'type' => 'string', 'required' => false, 'example' => '2024-05-01', 'title' => ''], + ], + [ + 'name' => 'TriggerClientId', + 'in' => 'query', + 'schema' => ['description' => 'The TriggerClientId in TriggerContext.', 'type' => 'string', 'required' => false, 'example' => '1001', 'title' => ''], + ], + [ + 'name' => 'TriggerClient', + 'in' => 'query', + 'schema' => ['description' => 'The TriggerClient in TriggerContext.', 'type' => 'string', 'required' => false, 'example' => 'CWF2', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The page size for the list pagination query. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'docRequired' => true, 'maximum' => '200', 'minimum' => '1', 'default' => '10', 'required' => true, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number for the list pagination query. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'docRequired' => true, 'default' => '1', 'required' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The return value.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the synchronization task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '11792', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '4F6AB6B3-41FB-5EBB-AFB2-0C98D49DA2BB', - ], - 'DIJobId' => [ - 'description' => 'This parameter is deprecated and is replaced by the Id parameter.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'deprecated' => true, - 'example' => '11792', + 'RequestId' => ['title' => '', 'description' => 'The API request ID.', 'type' => 'string', 'example' => '691CA452-D37A-4ED****'], + 'PagingInfo' => [ + 'description' => 'The pagination query result of quality evaluation task instances.', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '294', 'title' => ''], + 'DataQualityEvaluationTaskInstances' => [ + 'description' => 'The successfully triggered TaskInstance.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the quality check task instance.', 'type' => 'integer', 'format' => 'int64', 'example' => '10001', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time of the task instance.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + 'FinishTime' => ['description' => 'The end time of the task instance.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + 'Status' => ['description' => 'The current running status.'."\n" + .'- Running'."\n" + .'- Error'."\n" + .'- Passed'."\n" + .'- Warned'."\n" + .'- Critical', 'type' => 'string', 'example' => 'Critical', 'title' => ''], + 'Parameters' => ['description' => 'The parameter settings used during the actual runtime.', 'type' => 'string', 'example' => '{'."\n" + .' "bizdate": "20240517",'."\n" + .' "triggerTime": "1710239005403"'."\n" + .'}', 'title' => ''], + 'TriggerContext' => ['description' => 'The context information when the instance is triggered.', 'type' => 'string', 'example' => '{'."\n" + .' "TriggerClientId": 10001,'."\n" + .' "TriggerClient": "CWF2"'."\n" + .'}', 'title' => ''], + 'ProjectId' => ['description' => 'The ID of the DataWorks project workspace.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'Task' => [ + 'description' => 'The snapshot of the data quality evaluation task when the evaluation starts.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The ID of the data quality evaluation task.', 'type' => 'integer', 'format' => 'int64', 'example' => '10001'], + 'Description' => ['title' => '', 'description' => 'The description of the quality monitoring task.', 'type' => 'string', 'example' => 'This is a daily run data quality evaluation plan.'], + 'ProjectId' => ['title' => '', 'description' => 'The ID of the project workspace.', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'example' => '100'], + 'Target' => [ + 'title' => '', + 'description' => 'The monitoring object of the data quality evaluation task.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '', 'description' => 'The type of the monitoring object.'."\n" + .'- Table', 'type' => 'string', 'example' => 'Table'], + 'DatabaseType' => ['title' => '', 'description' => 'For a dataset of table type, the database type to which the table belongs.'."\n" + .'- maxcompute'."\n" + .'- emr'."\n" + .'- cdh'."\n" + .'- hologres'."\n" + .'- analyticdb_for_postgresql'."\n" + .'- analyticdb_for_mysql'."\n" + .'- starrocks', 'type' => 'string', 'example' => 'maxcompute'], + 'TableGuid' => ['title' => '', 'description' => 'The unique ID of the table in Data Map.', 'type' => 'string', 'example' => 'odps.unit_test.tb_unit_test'], + 'PartitionSpec' => ['title' => '', 'description' => 'The partition settings of the partitioned table.', 'type' => 'string', 'example' => 'ds=$[yyyymmdd-1]'], + ], + 'example' => '', + ], + 'Trigger' => [ + 'title' => '', + 'description' => 'The trigger configuration of the data quality evaluation task.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '', 'description' => 'The type of event that can trigger the execution of the quality evaluation task.'."\n" + .'- ByScheduledTaskInstance: A scheduled instance runs successfully.', 'type' => 'string', 'example' => 'ByScheduledTaskInstance'], + 'TaskIds' => [ + 'title' => '', + 'description' => 'The IDs of scheduled task nodes.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the scheduled task node.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'title' => ''], + 'example' => '', + ], + ], + 'example' => '', + ], + 'RuntimeConf' => ['title' => '', 'description' => 'Settings used when accessing data sources. Currently, only specifying the YARN queue of EMR and specifying the SQL engine as SPARK_SQL|KYUUBI|PRESTO_SQL|HIVE_SQL when collecting EMR tables are supported.', 'type' => 'string', 'example' => '{ "queue": "default", "sqlEngine": "SPARK_SQL" }'], + 'Hooks' => [ + 'title' => '', + 'description' => 'The callback settings in the lifecycle of the data quality evaluation task instance. Currently, only one Hook for blocking scheduled tasks is supported.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => ['title' => '', 'description' => 'The type of the subsequent processing action.'."\n" + .'- BlockTaskInstance: Blocks the execution of the DataWorks task instance.', 'type' => 'string', 'example' => 'BlockTaskInstance'], + 'Condition' => ['title' => '', 'description' => 'The trigger condition of the Hook.', 'type' => 'string', 'example' => '${severity} == "High" AND ${status} == "Critical"'], + ], + 'description' => 'Hook.', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'Notifications' => [ + 'title' => '', + 'description' => 'The notification subscription configuration.', + 'type' => 'object', + 'properties' => [ + 'Condition' => ['title' => '', 'description' => 'The trigger condition of the notification.', 'type' => 'string', 'example' => '${severity} == "High"'], + 'Notifications' => [ + 'title' => '', + 'description' => 'The notification settings.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NofiticationReceivers' => [ + 'title' => '', + 'description' => 'The alert recipient settings.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ReceiverType' => ['title' => '', 'description' => 'The type of the alert recipient.'."\n" + .'- AliUid - The UID of the Alibaba Cloud account'."\n" + .'- WebhookUrl - A custom webhook URL'."\n" + .'- DingdingUrl - The URL of a DingTalk bot'."\n" + .'- FeishuUrl - The URL of a Lark bot'."\n" + .'- WeixinUrl - The URL of a WeCom bot', 'type' => 'string', 'example' => 'AliUid'], + 'Extension' => ['title' => '', 'description' => 'The extension information, in JSON format. For example, a DingTalk bot supports at-all.', 'type' => 'string', 'example' => '{"atAll":"true"}'], + 'ReceiverValues' => [ + 'title' => '', + 'description' => 'The alert recipient.', + 'type' => 'array', + 'items' => ['description' => 'The specific value of the alert recipient.', 'type' => 'string', 'example' => '10000001', 'title' => ''], + 'example' => '', + ], + ], + 'description' => 'The alert recipient settings.', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'NotificationChannels' => [ + 'title' => '', + 'description' => 'The alert method.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Channels' => [ + 'title' => '', + 'description' => 'The alert method.', + 'type' => 'array', + 'items' => ['description' => '- Mail - Email'."\n" + .'- Sms - SMS'."\n" + .'- Phone - Phone call'."\n" + .'- Feishu - Lark'."\n" + .'- Weixin - WeChat'."\n" + .'- Dingding - DingTalk'."\n" + .'- Webhook - Custom Webhook', 'type' => 'string', 'example' => 'Mail', 'title' => ''], + 'example' => '', + ], + ], + 'description' => 'The notification method.', + 'title' => '', + 'example' => '', + ], + 'deprecated' => false, + 'example' => '', + ], + ], + 'description' => 'The notification settings.', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'Name' => ['title' => '', 'description' => 'The name of the quality monitoring task.', 'type' => 'string', 'deprecated' => false, 'required' => true, 'example' => 'Quality verification task'], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Id\\": 11792,\\n \\"RequestId\\": \\"4F6AB6B3-41FB-5EBB-AFB2-0C98D49DA2BB\\",\\n \\"DIJobId\\": 11792\\n}","type":"json"}]', - 'title' => 'CreateDIJob', - 'description' => '* This API operation is available for all DataWorks editions.'."\n" - .'* You can call this API operation to create a synchronization task. When you call this API operation, you must configure parameters such as SourceDataSourceSettings, DestinationDataSourceSettings, MigrationType, TransformationRules, TableMappings, and JobSettings. The SourceDataSourceSettings parameter defines the settings related to the source. The DestinationDataSourceSettings parameter defines the settings related to the destination. The MigrationType parameter defines the synchronization task type. The TransformationRules parameter defines the transformation rules for objects involved in the synchronization task. The TableMappings parameter defines the mappings between rules used to select synchronization objects in the source and transformation rules applied to the selected synchronization objects. The JobSettings parameter defines the settings for the dimension of the synchronization task, including policies for data type mappings between source fields and destination fields and settings for periodic scheduling.'."\n", - ], - 'UpdateDIJob' => [ - 'summary' => 'Updates a synchronization task.', - 'methods' => [ - 'get', - 'post', + 'staticInfo' => [ + 'substitutions' => ['dataworks-public::2024-05-18::ListDataQualityScanRuns'], ], - 'schemes' => [ - 'https', + 'title' => 'Queries the list of quality monitoring task instances', + 'summary' => 'Performs a paginated query of the quality monitoring task instance list.', + 'description' => 'You must purchase DataWorks Basic Edition or above to use this feature.', + 'changeSet' => [ + ['createdAt' => '2025-03-31T05:58:07.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-01-15T08:15:09.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-12-23T06:29:09.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-12-19T09:25:09.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-11-06T02:56:45.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\\": \\"691CA452-D37A-4ED****\\",\\n \\"PagingInfo\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 294,\\n \\"DataQualityEvaluationTaskInstances\\": [\\n {\\n \\"Id\\": 10001,\\n \\"CreateTime\\": 1710239005403,\\n \\"FinishTime\\": 1710239005403,\\n \\"Status\\": \\"Critical\\",\\n \\"Parameters\\": \\"{\\\\n \\\\\\"bizdate\\\\\\": \\\\\\"20240517\\\\\\",\\\\n \\\\\\"triggerTime\\\\\\": \\\\\\"1710239005403\\\\\\"\\\\n}\\",\\n \\"TriggerContext\\": \\"{\\\\n \\\\\\"TriggerClientId\\\\\\": 10001,\\\\n \\\\\\"TriggerClient\\\\\\": \\\\\\"CWF2\\\\\\"\\\\n}\\",\\n \\"ProjectId\\": 100,\\n \\"Task\\": {\\n \\"Id\\": 10001,\\n \\"Description\\": \\"This is a daily run data quality evaluation plan.\\",\\n \\"ProjectId\\": 100,\\n \\"Target\\": {\\n \\"Type\\": \\"Table\\",\\n \\"DatabaseType\\": \\"maxcompute\\",\\n \\"TableGuid\\": \\"odps.unit_test.tb_unit_test\\",\\n \\"PartitionSpec\\": \\"ds=$[yyyymmdd-1]\\"\\n },\\n \\"Trigger\\": {\\n \\"Type\\": \\"ByScheduledTaskInstance\\",\\n \\"TaskIds\\": [\\n 10000\\n ]\\n },\\n \\"RuntimeConf\\": \\"{ \\\\\\"queue\\\\\\": \\\\\\"default\\\\\\", \\\\\\"sqlEngine\\\\\\": \\\\\\"SPARK_SQL\\\\\\" }\\",\\n \\"Hooks\\": [\\n {\\n \\"Type\\": \\"BlockTaskInstance\\",\\n \\"Condition\\": \\"${severity} == \\\\\\"High\\\\\\" AND ${status} == \\\\\\"Critical\\\\\\"\\"\\n }\\n ],\\n \\"Notifications\\": {\\n \\"Condition\\": \\"${severity} == \\\\\\"High\\\\\\"\\",\\n \\"Notifications\\": [\\n {\\n \\"NofiticationReceivers\\": [\\n {\\n \\"ReceiverType\\": \\"AliUid\\",\\n \\"Extension\\": \\"{\\\\\\"atAll\\\\\\":\\\\\\"true\\\\\\"}\\",\\n \\"ReceiverValues\\": [\\n \\"10000001\\"\\n ]\\n }\\n ],\\n \\"NotificationChannels\\": [\\n {\\n \\"Channels\\": [\\n \\"Mail\\"\\n ]\\n }\\n ]\\n }\\n ]\\n },\\n \\"Name\\": \\"Quality verification task\\"\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListDataQualityEvaluationTasks' => [ + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, + 'operationType' => 'read', + 'deprecated' => true, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '234099', - 'abilityTreeNodes' => [ - 'FEATUREdideBP0OJZ', - ], + 'abilityTreeCode' => '240369', + 'abilityTreeNodes' => ['FEATUREdideGK4B66'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the synchronization task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '11588', - ], + 'schema' => ['description' => 'The DataWorks workspace ID.', 'type' => 'integer', 'format' => 'int64', 'docRequired' => true, 'required' => true, 'example' => '100', 'title' => ''], ], [ - 'name' => 'Description', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The task description.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'The description of the synchronization task.'."\n" - ."\n", - ], + 'name' => 'TableGuid', + 'in' => 'query', + 'schema' => ['description' => 'The unique ID of the table in Data Map.', 'type' => 'string', 'required' => false, 'example' => 'odps.unit_test.tb_unit_test', 'title' => ''], ], [ - 'name' => 'TableMappings', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The list of synchronization object transformation mappings. Each element describes a set of source object selection rules and the transformation rules applied to those objects.'."\n" - ."\n" - .'> \\[ { "SourceObjectSelectionRules":\\[ { "ObjectType":"Database", "Action":"Include", "ExpressionType":"Exact", "Expression":"biz_db" }, { "ObjectType":"Schema", "Action":"Include", "ExpressionType":"Exact", "Expression":"s1" }, { "ObjectType":"Table", "Action":"Include", "ExpressionType":"Exact", "Expression":"table1" } ], "TransformationRuleNames":\\[ { "RuleName":"my_database_rename_rule", "RuleActionType":"Rename", "RuleTargetType":"Schema" } ] } ]'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The list of synchronization object transformation mappings. Each element describes a set of source object selection rules and the transformation rules applied to those objects.'."\n", - 'type' => 'object', - 'properties' => [ - 'SourceObjectSelectionRules' => [ - 'description' => 'Each rule can select different object types from the source, such as source databases and source tables.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Each rule can select different object types from the source, such as source databases and source tables.'."\n", - 'type' => 'object', - 'properties' => [ - 'Action' => [ - 'description' => 'Valid values: Include and Exclude.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Include', - ], - 'Expression' => [ - 'description' => 'The expression.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mysql_table_1', - ], - 'ExpressionType' => [ - 'description' => 'The expression type. Valid values: Exact and Regex.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Exact', - ], - 'ObjectType' => [ - 'description' => 'The object type. Valid values:'."\n" - ."\n" - .'* Table'."\n" - .'* Schema'."\n" - .'* Database'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Table', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'TransformationRules' => [ - 'description' => 'The transformation rules applied to source objects.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The transformation rules applied to source objects.'."\n", - 'type' => 'object', - 'properties' => [ - 'RuleName' => [ - 'description' => 'The rule name. The rule name must be unique for a given combination of action type and target type. The name cannot exceed 50 characters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rename_rule_1', - ], - 'RuleActionType' => [ - 'description' => 'Valid values:'."\n" - ."\n" - .'* DefinePrimaryKey'."\n" - .'* Rename'."\n" - .'* AddColumn'."\n" - .'* HandleDml'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Rename', - ], - 'RuleTargetType' => [ - 'description' => 'Valid values:'."\n" - ."\n" - .'* Table'."\n" - .'* Schema'."\n" - .'* Database'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Table', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name used to fuzzy match data quality check task names.', 'type' => 'string', 'required' => false, 'example' => 'Test', 'title' => ''], ], [ - 'name' => 'JobSettings', - 'in' => 'formData', - 'style' => 'json', + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The page size for the paging query. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'docRequired' => true, 'maximum' => '200', 'minimum' => '1', 'default' => '10', 'required' => true, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number for the paging query. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'docRequired' => true, 'default' => '1', 'required' => true, 'example' => '1', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The task-level settings, including DDL handling policies, column data type mapping between source and destination, and runtime parameters.'."\n", + 'title' => '', + 'description' => '返回值', 'type' => 'object', 'properties' => [ - 'ChannelSettings' => [ - 'description' => 'The channel-specific settings. You can configure special settings for specific channels. Currently supported: Holo2Holo (Hologres to Hologres) and Holo2Kafka (Hologres to Kafka).'."\n" - ."\n" - .'1. Holo2Kafka'."\n" - ."\n" - .'* Example: {"destinationChannelSettings":{"kafkaClientProperties":\\[{"key":"linger.ms","value":"100"}],"keyColumns":\\["col3"],"writeMode":"canal"}} kafkaClientProperties: Kafka producer parameters used when writing to Kafka.'."\n" - .'* keyColumns: The columns to write to Kafka.'."\n" - .'* writeMode: The Kafka write format. Valid values: json and canal.'."\n" - ."\n" - .'2. Holo2Holo'."\n" - ."\n" - .'* Example: {"destinationChannelSettings":{"conflictMode":"replace","dynamicColumnAction":"replay","writeMode":"replay"}}'."\n" - .'* conflictMode: The conflict handling policy when writing to Hologres. Valid values: replace (overwrite) and ignore.'."\n" - .'* writeMode: The write mode for Hologres. Valid values: replay and insert.'."\n" - .'* dynamicColumnAction: The dynamic column handling mode when writing to Hologres. Valid values: replay, insert, and ignore.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"structInfo":"MANAGED","storageType":"TEXTFILE","writeMode":"APPEND","partitionColumns":[{"columnName":"pt","columnType":"STRING","comment":""}],"fieldDelimiter":""}'."\n", - ], - 'ColumnDataTypeSettings' => [ - 'description' => 'The array of column type mappings.'."\n" - ."\n" - .'> \\["ColumnDataTypeSettings":\\[ { "SourceDataType":"Bigint", "DestinationDataType":"Text" } ]'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'A single column type mapping.'."\n", - 'type' => 'object', - 'properties' => [ - 'DestinationDataType' => [ - 'description' => 'The destination type, such as bigint, boolean, string, text, datetime, timestamp, decimal, or binary. Different data sources may have different types.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'text', - ], - 'SourceDataType' => [ - 'description' => 'The source type, such as bigint, boolean, string, text, datetime, timestamp, decimal, or binary. Different data sources may have different types.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'bigint', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'CycleScheduleSettings' => [ - 'description' => 'The scheduled task settings.'."\n", + 'RequestId' => ['title' => '', 'description' => 'API请求ID', 'type' => 'string', 'example' => '691CA452-D37A-4ED0-****'], + 'PagingInfo' => [ + 'description' => '质量校验任务分页查询结果', 'type' => 'object', 'properties' => [ - 'ScheduleParameters' => [ - 'description' => 'The scheduling parameters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'bizdate=$bizdate'."\n", - ], - ], - 'required' => false, - ], - 'DdlHandlingSettings' => [ - 'description' => 'The array of DDL handling settings.'."\n" - ."\n" - .'> \\["DDLHandlingSettings":\\[ { "Type":"Insert", "Action":"Normal" } ]'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'A single DDL handling setting.'."\n", - 'type' => 'object', - 'properties' => [ - 'Action' => [ - 'description' => 'Valid values:'."\n" - ."\n" - .'* Ignore'."\n" - .'* Critical: Fail the task'."\n" - .'* Normal'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Critical', - ], - 'Type' => [ - 'description' => 'The DDL type. Valid values:'."\n" - ."\n" - .'* RenameColumn'."\n" - .'* ModifyColumn'."\n" - .'* CreateTable'."\n" - .'* TruncateTable'."\n" - .'* DropTable'."\n" - .'* DropColumn'."\n" - .'* AddColumn'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'AddColumn', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'RuntimeSettings' => [ - 'description' => 'The runtime settings.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The runtime settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The setting name. Valid values:'."\n" - ."\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" - .'* dst.offline.truncate: Specifies whether to clear the destination table before data writing.'."\n" - .'* runtime.offline.speed.limit.enable: Specifies whether throttling is enabled for a batch synchronization task.'."\n" - .'* runtime.offline.concurrent: Specifies the maximum number of parallel threads that are allowed for a batch synchronization task.'."\n" - .'* runtime.enable.auto.create.schema: Specifies whether schemas are automatically created in the destination of a synchronization task.'."\n" - .'* runtime.realtime.concurrent: Specifies the maximum number of parallel threads that are allowed for a real-time synchronization task.'."\n" - .'* runtime.realtime.failover.minute.dataxcdc: Specifies the maximum waiting duration before a synchronization task retries the next restart if the previous restart fails after failover occurs. Unit: minutes.'."\n" - .'* runtime.realtime.failover.times.dataxcdc: Specifies the maximum number of failures that are allowed for restarting a synchronization task after failovers occur.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'runtime.offline.concurrent', - ], - 'Value' => [ - 'description' => 'The setting value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', + 'TotalCount' => ['description' => '总条数', 'type' => 'string', 'example' => '131', 'title' => ''], + 'PageSize' => ['description' => '页大小', 'type' => 'string', 'default' => '10', 'example' => '10', 'title' => ''], + 'PageNumber' => ['description' => '页码', 'type' => 'string', 'default' => '1', 'example' => '1', 'title' => ''], + 'DataQualityEvaluationTasks' => [ + 'description' => '质量校验任务', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => '数据质量校验任务ID', 'type' => 'integer', 'format' => 'int64', 'example' => '10001', 'title' => ''], + 'Name' => ['description' => '数据质量校验任务名称，数字、英文字母、汉字、半角全角标点符号组合，最长255个字符。', 'type' => 'string', 'example' => 'Data quality verification task', 'title' => ''], + 'Description' => ['description' => '数据质量校验任务描述，最长65535个字符', 'type' => 'string', 'example' => 'This is a daily run data quality evaluation plan', 'title' => ''], + 'ProjectId' => ['description' => 'DataWorks工作空间ID', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'Target' => [ + 'description' => '数据质量校验任务的监控对象', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => '监控对象类型'."\n" + ."\n" + .'- Table', 'type' => 'string', 'example' => 'Table', 'title' => ''], + 'DatabaseType' => ['description' => '表类型的数据集，表所属的数据库类型'."\n" + .'- maxcompute'."\n" + .'- emr'."\n" + .'- cdh'."\n" + .'- hologres'."\n" + .'- analyticdb_for_postgresql'."\n" + .'- analyticdb_for_mysql'."\n" + .'- starrocks', 'type' => 'string', 'example' => 'maxcompute', 'title' => ''], + 'TableGuid' => ['description' => '表在数据地图中的唯一ID', 'type' => 'string', 'example' => 'odps.unit_test.tb_unit_test', 'title' => ''], + 'PartitionSpec' => ['description' => '分区表的分区设置', 'type' => 'string', 'example' => 'ds=$[yyyymmdd-1]', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Trigger' => [ + 'description' => '数据质量校验任务的触发配置', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => '何种事件可以触发质量校验任务执行'."\n" + ."\n" + .'- ByScheduledTaskInstance：调度实例运行成功', 'type' => 'string', 'example' => 'ByScheduledTaskInstance', 'title' => ''], + 'TaskIds' => [ + 'description' => 'type=ByScheduledTaskInstance时生效'."\n" + .',具体指明哪些调度节点的实例执行成功后可以触发', + 'type' => 'array', + 'items' => ['description' => '调度任务节点ID', 'type' => 'integer', 'format' => 'int64', 'example' => '10001', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'RuntimeConf' => ['description' => '使用数据源时的一些设置，目前只支持指定EMR的yarn队列、采集EMR表时SQL引擎指定为SPARK_SQL|KYUUBI|PRESTO_SQL|HIVE_SQL', 'type' => 'string', 'example' => '{ "queue": "default", "sqlEngine": "SPARK_SQL" }', 'title' => ''], + 'Hooks' => [ + 'description' => '数据质量校验任务实例生命周期中的回调设置，目前只支持一个阻塞调度任务的Hook', + 'type' => 'array', + 'items' => [ + 'description' => '回调设置', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => '后续处理动作类型'."\n" + .'- BlockTaskInstance：阻塞DataWorks任务实例执行', 'type' => 'string', 'example' => 'BlockTaskInstance', 'title' => ''], + 'Condition' => ['description' => 'Hook触发条件', 'type' => 'string', 'example' => '${severity} == "High" AND ${status} == "Critical"', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Notifications' => [ + 'description' => '告警配置', + 'type' => 'object', + 'properties' => [ + 'Condition' => ['description' => 'Notification触发条件', 'type' => 'string', 'example' => '${severity} == "High"', 'title' => ''], + 'Notifications' => [ + 'description' => '具体的告警设置', + 'type' => 'array', + 'items' => [ + 'description' => '告警设置', + 'type' => 'object', + 'properties' => [ + 'NotificationChannels' => [ + 'description' => '告警方式配置', + 'type' => 'array', + 'items' => [ + 'description' => '告警方式', + 'type' => 'object', + 'properties' => [ + 'Channels' => [ + 'description' => '告警方式', + 'type' => 'array', + 'items' => ['description' => '告警方式'."\n" + .'- Mail - 邮件'."\n" + .'- Sms - 短信'."\n" + .'- Phone - 电话'."\n" + .'- Feishu - 飞书'."\n" + .'- Weixin - 微信'."\n" + .'- Dingding - 钉钉'."\n" + .'- Webhook - 自定义Webhook', 'type' => 'string', 'example' => 'Mail', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'NotificationReceivers' => [ + 'description' => '告警接收人配置', + 'type' => 'array', + 'items' => [ + 'description' => '告警接收人', + 'type' => 'object', + 'properties' => [ + 'ReceiverType' => ['description' => '告警接收人类型'."\n" + .'- AliUid - 阿里云账号Uid'."\n" + .'- WebhookUrl - 自定义 webhook URL'."\n" + .'- DingdingUrl - 钉钉机器人Url'."\n" + .'- FeishuUrl - 飞书机器人Url'."\n" + .'- WeixinUrl - 企微机器人Url', 'type' => 'string', 'example' => 'AliUid', 'title' => ''], + 'ReceiverValues' => [ + 'description' => '告警接收人具体值', + 'type' => 'array', + 'items' => ['description' => '告警接收人具体值', 'type' => 'string', 'example' => 'user1', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Extension' => ['description' => '扩展信息，格式为 json，例如钉钉机器人支持 at 所有人', 'type' => 'string', 'example' => '{"atAll":"true"}', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'DataSourceId' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'required' => false, ], - 'required' => false, + 'title' => '', + 'example' => '', ], ], - 'required' => false, + 'example' => '', ], ], + ], + 'staticInfo' => [ + 'substitutions' => ['dataworks-public::2024-05-18::ListDataQualityScans'], + ], + 'title' => 'List quality watchtasks', + 'summary' => 'Lists quality monitoring nodes by paging query.', + 'description' => '需要购买DataWorks基础版及以上版本才能使用', + 'changeSet' => [ + ['createdAt' => '2025-03-31T05:58:07.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2024-12-23T06:29:09.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-12-19T09:25:09.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-11-06T02:56:45.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'ResourceSettings', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The resource settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'OfflineResourceSettings' => [ - 'description' => 'The batch synchronization resources.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestedCu' => [ - 'description' => 'The CUs of the resource group for Data Integration used for batch synchronization.'."\n", - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '2.0', - ], - 'ResourceGroupIdentifier' => [ - 'description' => 'The name of the resource group for Data Integration that are used for batch synchronization.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'S_res_group_111_222', - ], - ], - 'required' => false, - ], - 'RealtimeResourceSettings' => [ - 'description' => 'The real-time synchronization resources.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestedCu' => [ - 'description' => 'The CUs of the resource group for Data Integration that are used for real-time synchronization.'."\n", - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '2.0', - ], - 'ResourceGroupIdentifier' => [ - 'description' => 'The name of the resource group for Data Integration that are used for real-time synchronization.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'S_res_group_111_222', - ], - ], - 'required' => false, - ], - 'ScheduleResourceSettings' => [ - 'description' => 'The resource used for scheduling.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestedCu' => [ - 'description' => 'The CUs of the scheduling resource group for batch synchronization tasks.'."\n", - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '2.0', - ], - 'ResourceGroupIdentifier' => [ - 'description' => 'The name of the scheduling resource group used for batch synchronization tasks.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'S_res_group_235454102432001_1721021993437', - ], - ], - 'required' => false, - ], + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'required' => false, ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-4ED0-****\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": \\"131\\",\\n \\"PageSize\\": \\"10\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"DataQualityEvaluationTasks\\": [\\n {\\n \\"Id\\": 10001,\\n \\"Name\\": \\"Data quality verification task\\",\\n \\"Description\\": \\"This is a daily run data quality evaluation plan\\",\\n \\"ProjectId\\": 100,\\n \\"Target\\": {\\n \\"Type\\": \\"Table\\",\\n \\"DatabaseType\\": \\"maxcompute\\",\\n \\"TableGuid\\": \\"odps.unit_test.tb_unit_test\\",\\n \\"PartitionSpec\\": \\"ds=$[yyyymmdd-1]\\"\\n },\\n \\"Trigger\\": {\\n \\"Type\\": \\"ByScheduledTaskInstance\\",\\n \\"TaskIds\\": [\\n 10001\\n ]\\n },\\n \\"RuntimeConf\\": \\"{ \\\\\\"queue\\\\\\": \\\\\\"default\\\\\\", \\\\\\"sqlEngine\\\\\\": \\\\\\"SPARK_SQL\\\\\\" }\\",\\n \\"Hooks\\": [\\n {\\n \\"Type\\": \\"BlockTaskInstance\\",\\n \\"Condition\\": \\"${severity} == \\\\\\"High\\\\\\" AND ${status} == \\\\\\"Critical\\\\\\"\\"\\n }\\n ],\\n \\"Notifications\\": {\\n \\"Condition\\": \\"${severity} == \\\\\\"High\\\\\\"\\",\\n \\"Notifications\\": [\\n {\\n \\"NotificationChannels\\": [\\n {\\n \\"Channels\\": [\\n \\"Mail\\"\\n ]\\n }\\n ],\\n \\"NotificationReceivers\\": [\\n {\\n \\"ReceiverType\\": \\"AliUid\\",\\n \\"ReceiverValues\\": [\\n \\"user1\\"\\n ],\\n \\"Extension\\": \\"{\\\\\\"atAll\\\\\\":\\\\\\"true\\\\\\"}\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"DataSourceId\\": 0\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListDataQualityResults' => [ + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'TransformationRules', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The list of synchronization object transformation rule definitions.'."\n" - ."\n" - .'> \\[ { "RuleName":"my_database_rename_rule", "RuleActionType":"Rename", "RuleTargetType":"Schema", "RuleExpression":"{"expression":"${srcDatasoureName}\\_${srcDatabaseName}"}" } ]'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'A single synchronization object transformation rule definition.'."\n", - 'type' => 'object', - 'properties' => [ - 'RuleActionType' => [ - 'description' => 'Valid values:'."\n" - ."\n" - .'* DefinePrimaryKey'."\n" - .'* Rename'."\n" - .'* AddColumn'."\n" - .'* HandleDml'."\n" - .'* DefineIncrementalCondition'."\n" - .'* DefineCycleScheduleSettings'."\n" - .'* DefinePartitionKey'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Rename', - ], - 'RuleExpression' => [ - 'description' => 'The rule expression in JSON string format.'."\n" - ."\n" - .'1. Rename rule'."\n" - ."\n" - .'* Example: {"expression":"${srcDatasourceName}\\_${srcDatabaseName}\\_0922" }'."\n" - .'* expression: The rename transformation expression. Supported variables include: ${srcDatasourceName} (source data source name), ${srcDatabaseName} (source database name), and ${srcTableName} (source table name).'."\n" - ."\n" - .'2. AddColumn rule'."\n" - ."\n" - .'* Example: {"columns":\\[{"columnName":"my_add_column","columnValueType":"Constant","columnValue":"123"}]}'."\n" - .'* If not specified, the default behavior is to not add columns.'."\n" - .'* columnName: The name of the column to add.'."\n" - .'* columnValueType: The value type of the column to add. Valid values: Constant and Variable.'."\n" - .'* columnValue: The value of the column to add. When columnValueType is set to Constant, the value is a custom constant of the string type. When columnValueType is set to Variable, the value is a built-in variable. Built-in variables include: EXECUTE_TIME (execution time, long type), DB_NAME_SRC (source database name, string type), DATASOURCE_NAME_SRC (source data source name, string type), TABLE_NAME_SRC (source table name, string type), DB_NAME_DEST (destination database name, string type), DATASOURCE_NAME_DEST (destination data source name, string type), TABLE_NAME_DEST (destination table name, string type), and DB_NAME_SRC_TRANSED (transformed source database name, string type).'."\n" - ."\n" - .'3. DefinePrimaryKey'."\n" - ."\n" - .'* Example: {"columns":\\["ukcolumn1","ukcolumn2"]}'."\n" - .'* If not specified, the source primary key columns are used by default.'."\n" - .'* When the destination table already exists: Data Integration does not modify the destination table structure. If the specified primary key columns are not in the destination table, the task fails to start.'."\n" - .'* When the destination table is auto-created: Data Integration automatically creates the destination table structure with the defined primary key columns. If the specified primary key columns are not in the destination table, the task fails to start.'."\n" - ."\n" - .'4. HandleDml rule'."\n" - ."\n" - .'* Example of a rule used to process DML messages: {"dmlPolicies":\\[{"dmlType":"Delete","dmlAction":"Filter","filterCondition":"id > 1"}]}.'."\n" - .'* If not specified, the default rule is Normal for Insert, Update, and Delete.'."\n" - .'* dmlType: The DML operation type. Valid values: Insert, Update, Delete.'."\n" - .'* dmlAction: The DML handling policy. Valid values: Normal, Ignore, Filter (conditional processing, used when dmlType is Update or Delete), and LogicalDelete.'."\n" - .'* filterCondition: The DML filter condition. This parameter is used when dmlAction is set to Filter.'."\n" - ."\n" - .'5. DefineIncrementalCondition'."\n" - ."\n" - .'* Example: {"where":"id > 0"}'."\n" - .'* Specifies the incremental filter condition.'."\n" - ."\n" - .'6. DefineCycleScheduleSettings'."\n" - ."\n" - .'* Example: {"cronExpress":" \\* \\* \\* \\* \\* \\*", "cycleType":"1"}'."\n" - .'* Specifies the scheduled task parameters.'."\n" - ."\n" - .'7. DefinePartitionKey'."\n" - ."\n" - .'* Example: {"columns":\\["id"]}'."\n" - .'* Specifies the partition key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"expression":"${srcDatasoureName}_${srcDatabaseName}"}', - ], - 'RuleName' => [ - 'description' => 'The rule name. When the action type and target type are the same, the rule name must be unique. The name cannot exceed 50 characters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rename_rule_1', - ], - 'RuleTargetType' => [ - 'description' => 'The target type for the action. Valid values:'."\n" - ."\n" - .'* Table'."\n" - .'* Schema'."\n" - .'* Database'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Table', - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '240397', + 'abilityTreeNodes' => ['FEATUREdideGK4B66'], + 'autoTest' => true, + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The DataWorks workspace ID.', 'type' => 'integer', 'format' => 'int64', 'docRequired' => true, 'required' => true, 'example' => '100', 'title' => ''], + ], + [ + 'name' => 'DataQualityRuleId', + 'in' => 'query', + 'schema' => ['description' => 'The data quality rule ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100001', 'title' => ''], + ], + [ + 'name' => 'DataQualityEvaluationTaskId', + 'in' => 'query', + 'schema' => ['description' => 'The data quality evaluation task ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '200001', 'title' => ''], + ], + [ + 'name' => 'DataQualityEvaluationTaskInstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The data quality evaluation task instance ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10001', 'title' => ''], ], [ - 'name' => 'ProjectId', + 'name' => 'CreateTimeFrom', 'in' => 'query', - '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', - ], + 'schema' => ['description' => 'The earliest time when the data quality evaluation result was generated.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1710239005403', 'title' => ''], ], [ - 'name' => 'DIJobId', + 'name' => 'CreateTimeTo', 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter is deprecated. Use the Id parameter instead.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'deprecated' => true, - 'required' => false, - 'example' => '11588', - ], + 'schema' => ['description' => 'The latest time when the data quality evaluation result was generated.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1710239005403', 'title' => ''], + ], + [ + 'name' => 'BizdateFrom', + 'in' => 'query', + 'schema' => ['description' => 'The start business date of the rule instance.', 'type' => 'string', 'required' => false, 'example' => '2024-05-01', 'title' => ''], + ], + [ + 'name' => 'BizdateTo', + 'in' => 'query', + 'schema' => ['description' => 'The end business date of the rule instance.', 'type' => 'string', 'required' => false, 'example' => '2024-05-04', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The page size for the paging query. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'docRequired' => true, 'maximum' => '200', 'minimum' => '1', 'default' => '10', 'required' => true, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number for the paging query. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'docRequired' => true, 'default' => '1', 'required' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => '返回值。', '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' => 'AAC30B35-820D-5F3E-A42C-E96BB6379325', + 'RequestId' => ['title' => '', 'description' => 'API请求ID。', 'type' => 'string', 'example' => '691CA452-D37A-****'], + 'PagingInfo' => [ + 'description' => '数据质量校验结果分页查询结果。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => '页码。', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => '页大小。', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => '总条数。', 'type' => 'integer', 'format' => 'int32', 'example' => '219', 'title' => ''], + 'DataQualityResults' => [ + 'description' => '质量校验结果列表。', + 'type' => 'array', + 'items' => [ + 'description' => '质量校验结果。', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => '校验结果ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '16033', 'title' => ''], + 'Status' => ['description' => '校验结果状态：'."\n" + .'- Running'."\n" + .'- Error'."\n" + .'- Passed'."\n" + .'- Warned'."\n" + .'- Critical', 'type' => 'string', 'example' => 'Passed', 'title' => ''], + 'CreateTime' => ['description' => '校验结果生成时间。', 'type' => 'integer', 'format' => 'int64', 'example' => '1708284916414', 'title' => ''], + 'TaskInstanceId' => ['description' => '校验任务实例ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '200001', 'title' => ''], + 'Sample' => ['description' => '本次校验所使用的样本值。', 'type' => 'string', 'example' => '['."\n" + .' {'."\n" + .' "gender": "male",'."\n" + .' "_count": 100'."\n" + .' }, {'."\n" + .' "gender": "female",'."\n" + .' "_count": 100'."\n" + .' }'."\n" + .']', 'title' => ''], + 'Details' => [ + 'description' => '本次校验的详情。', + 'type' => 'array', + 'items' => [ + 'description' => '校验详情。', + 'type' => 'object', + 'properties' => [ + 'ReferencedValue' => ['description' => '使用引用的样本，用来参与CheckedValue计算的基准值。', 'type' => 'string', 'example' => '0.0', 'title' => ''], + 'CheckedValue' => ['description' => '最终用来与阈值比较的值。', 'type' => 'string', 'example' => '100.0', 'title' => ''], + 'Status' => ['description' => '最终的比较结果状态：'."\n" + .'- Error'."\n" + .'- Passed'."\n" + .'- Warned'."\n" + .'- Critical', 'type' => 'string', 'example' => 'Passed', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Rule' => [ + 'description' => '校验开始时，规则配置快照。', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => '规则ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '100001', 'title' => ''], + 'Name' => ['description' => '规则名称，数字、英文字母、汉字、半角全角标点符号组合，最长255个字符。', 'type' => 'string', 'example' => 'The table cannot be empty.', 'title' => ''], + 'ProjectId' => ['description' => 'DataWorks项目空间ID。', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'Enabled' => ['description' => '规则是否启用。', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Severity' => ['description' => '规则对于业务的等级（对应页面上的强弱规则）：'."\n" + .'- High'."\n" + .'- Normal', 'type' => 'string', 'example' => 'Normal', 'title' => ''], + 'Description' => ['description' => '规则描述信息，最长500个字符。', 'type' => 'string', 'example' => 'this is a odps _sql task', 'title' => ''], + 'TemplateCode' => ['description' => '创建规则时所引用的规则模板Code。', 'type' => 'string', 'example' => 'SYSTEM:user_defined_sql', 'title' => ''], + 'Target' => [ + 'description' => '规则所监控的对象。', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => '监控对象类型：'."\n" + .'- Table', 'type' => 'string', 'example' => 'Table', 'title' => ''], + 'DatabaseType' => ['description' => '表类型的数据集，表所属的数据库类型：'."\n" + .'- maxcompute'."\n" + .'- emr'."\n" + .'- cdh'."\n" + .'- hologres'."\n" + .'- analyticdb_for_postgresql'."\n" + .'- analyticdb_for_mysql'."\n" + .'- starrocks', 'type' => 'string', 'example' => 'maxcompute', 'title' => ''], + 'TableGuid' => ['description' => '表在数据地图中的唯一ID。', 'type' => 'string', 'example' => 'odps.unit_test.tb_unit_test', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'SamplingConfig' => [ + 'description' => '样本采集所需的设置。', + 'type' => 'object', + 'properties' => [ + 'Metric' => ['description' => '采样的指标名称：'."\n" + .'- Count：表行数'."\n" + .'- Min：字段最小值'."\n" + .'- Max：字段最大值'."\n" + .'- Avg：字段均值'."\n" + .'- DistinctCount：字段唯一值个数'."\n" + .'- DistinctPercent：字段唯一值个数与数据行数占比'."\n" + .'- DuplicatedCount：字段重复值个数'."\n" + .'- DuplicatedPercent：字段重复值个数与数据行数占比'."\n" + .'- TableSize：表大小'."\n" + .'- NullValueCount：字段为空的行数'."\n" + .'- NullValuePercent：字段为空的比例'."\n" + .'- GroupCount：按字段值聚合后每个值与对应的数据行数'."\n" + .'- CountNotIn：枚举值不匹配行数'."\n" + .'- CountDistinctNotIn：枚举值不匹配唯一值个数'."\n" + .'- UserDefinedSql：通过自定义SQL做样本采集', 'type' => 'string', 'example' => 'Count', 'title' => ''], + 'MetricParameters' => ['description' => '样本采集时，所需的参数。', 'type' => 'string', 'example' => '{ "columns": [ "id", "name" ] }', 'title' => ''], + 'SettingConfig' => ['description' => '具体执行采样语句前，插入执行的一些运行时参数设置语句，最长1000个字符。目前只支持MaxCompute。', 'type' => 'string', 'example' => 'SET odps.sql.udf.timeout=600s; ', 'title' => ''], + 'SamplingFilter' => ['description' => '采样时，对不关注的数据进行二次过滤的条件，最多16777215个字符。', 'type' => 'string', 'example' => 'id IS NULL', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'CheckingConfig' => [ + 'description' => '样本校验设置。', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => '阈值计算方式：'."\n" + .'- Fixed'."\n" + .'- Fluctation'."\n" + .'- FluctationDiscreate'."\n" + .'- Auto'."\n" + .'- Average'."\n" + .'- Variance', 'type' => 'string', 'example' => 'Fixed', 'title' => ''], + 'ReferencedSamplesFilter' => ['description' => '有些类型的阈值需要查询出一些参考样本，然后对参考样本的值进行汇总得出进行比较的阈值，这里使用一个表达式来表示参考样本的查询方式。', 'type' => 'string', 'example' => '{ "bizdate": [ "-1", "-7", "-1m" ] }', 'title' => ''], + 'Thresholds' => [ + 'description' => '阈值设置。', + 'type' => 'object', + 'properties' => [ + 'Expected' => [ + 'description' => '期望的阈值设置。', + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => '阈值数值。', 'type' => 'string', 'example' => '100.0', 'title' => ''], + 'Operator' => ['description' => '比较符：'."\n" + .'- \\>'."\n" + .'- \\>='."\n" + .'- \\<'."\n" + .'- \\<='."\n" + .'- !='."\n" + .'- =', 'type' => 'string', 'example' => '>', 'title' => ''], + 'Expression' => ['description' => '阈值表达式。'."\n" + ."\n" + .'波动率类型规则必须使用表达式方式表示波动阈值。如：'."\n" + ."\n" + .'- 波动上升大于0.01： $checkValue > 0.01 '."\n" + .'- 波动下降大于0.01：$checkValue < -0.01 '."\n" + .'- 波动率绝对值：abs($checkValue) > 0.01'."\n" + ."\n" + .'固定值类型规则也可以使用表达式方式配置阈值，如果同时配置，表达式优先级高于Operator和Value。', 'type' => 'string', 'example' => '$checkValue > 0.01', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Warned' => [ + 'description' => '普通警告的阈值设置。', + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => '阈值数值。', 'type' => 'string', 'example' => '100.0', 'title' => ''], + 'Operator' => ['description' => '比较符：'."\n" + .'- \\>'."\n" + .'- \\>='."\n" + .'- \\<'."\n" + .'- \\<='."\n" + .'- !='."\n" + .'- =', 'type' => 'string', 'example' => '>', 'title' => ''], + 'Expression' => ['description' => '阈值表达式。'."\n" + ."\n" + .'波动率类型规则必须使用表达式方式表示波动阈值。如：'."\n" + ."\n" + .'- 波动上升大于0.01： $checkValue > 0.01 '."\n" + .'- 波动下降大于0.01：$checkValue < -0.01 '."\n" + .'- 波动率绝对值：abs($checkValue) > 0.01'."\n" + ."\n" + .'固定值类型规则也可以使用表达式方式配置阈值，如果同时配置，表达式优先级高于Operator和Value。', 'type' => 'string', 'example' => ' $checkValue > 0.01', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Critical' => [ + 'description' => '严重警告的阈值设置。', + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => '阈值数值。', 'type' => 'string', 'example' => '100.0', 'title' => ''], + 'Operator' => ['description' => '比较符：'."\n" + .'- \\>'."\n" + .'- \\>='."\n" + .'- \\<'."\n" + .'- \\<='."\n" + .'- !='."\n" + .'- =', 'type' => 'string', 'example' => '>', 'title' => ''], + 'Expression' => ['description' => '阈值表达式。'."\n" + ."\n" + .'波动率类型规则必须使用表达式方式表示波动阈值。如：'."\n" + ."\n" + .'- 波动上升大于0.01： $checkValue > 0.01 '."\n" + .'- 波动下降大于0.01：$checkValue < -0.01 '."\n" + .'- 波动率绝对值：abs($checkValue) > 0.01'."\n" + ."\n" + .'固定值类型规则也可以使用表达式方式配置阈值，如果同时配置，表达式优先级高于Operator和Value。', 'type' => 'string', 'example' => ' $checkValue > 0.01', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'ErrorHandlers' => [ + 'description' => '质量规则校验问题处理器。', + 'type' => 'array', + 'items' => [ + 'description' => '质量规则校验问题处理器。', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => '处理器类型。'."\n" + .'- SaveErrorData', 'type' => 'string', 'example' => 'SaveErrorData'."\n", 'title' => ''], + 'ErrorDataFilter' => ['description' => '如果是自定义SQL规则，需要用户指定SQL来过滤问题数据。', 'type' => 'string', 'example' => 'SELECT * FROM tb_api_log WHERE id IS NULL', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'staticInfo' => [ - 'returnType' => 'synchronous', + 'substitutions' => ['dataworks-public::2024-05-18::ListDataQualityScanRuns'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"AAC30B35-820D-5F3E-A42C-E96BB****\\"\\n}","type":"json"}]', - 'title' => 'UpdateDIJob', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", - ], - 'DeleteDIJob' => [ - 'summary' => 'Deletes a new-version synchronization task.', - 'methods' => [ - 'get', + 'title' => 'Query data quality results', + 'summary' => 'Queries a list of data quality results by using paging.', + 'description' => '需要购买DataWorks基础版及以上版本才能使用', + 'changeSet' => [ + ['createdAt' => '2025-03-31T05:58:07.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-01-15T08:15:09.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-12-23T06:29:09.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-12-19T09:25:09.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-11-06T02:56:45.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'https', + '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\\": \\"691CA452-D37A-****\\",\\n \\"PagingInfo\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 219,\\n \\"DataQualityResults\\": [\\n {\\n \\"Id\\": 16033,\\n \\"Status\\": \\"Passed\\",\\n \\"CreateTime\\": 1708284916414,\\n \\"TaskInstanceId\\": 200001,\\n \\"Sample\\": \\"[\\\\n {\\\\n \\\\\\"gender\\\\\\": \\\\\\"male\\\\\\",\\\\n \\\\\\"_count\\\\\\": 100\\\\n }, {\\\\n \\\\\\"gender\\\\\\": \\\\\\"female\\\\\\",\\\\n \\\\\\"_count\\\\\\": 100\\\\n }\\\\n]\\",\\n \\"Details\\": [\\n {\\n \\"ReferencedValue\\": \\"0.0\\",\\n \\"CheckedValue\\": \\"100.0\\",\\n \\"Status\\": \\"Passed\\"\\n }\\n ],\\n \\"Rule\\": {\\n \\"Id\\": 100001,\\n \\"Name\\": \\"The table cannot be empty.\\",\\n \\"ProjectId\\": 100,\\n \\"Enabled\\": true,\\n \\"Severity\\": \\"Normal\\",\\n \\"Description\\": \\"this is a odps _sql task\\",\\n \\"TemplateCode\\": \\"SYSTEM:user_defined_sql\\",\\n \\"Target\\": {\\n \\"Type\\": \\"Table\\",\\n \\"DatabaseType\\": \\"maxcompute\\",\\n \\"TableGuid\\": \\"odps.unit_test.tb_unit_test\\"\\n },\\n \\"SamplingConfig\\": {\\n \\"Metric\\": \\"Count\\",\\n \\"MetricParameters\\": \\"{ \\\\\\"columns\\\\\\": [ \\\\\\"id\\\\\\", \\\\\\"name\\\\\\" ] }\\",\\n \\"SettingConfig\\": \\"SET odps.sql.udf.timeout=600s; \\",\\n \\"SamplingFilter\\": \\"id IS NULL\\"\\n },\\n \\"CheckingConfig\\": {\\n \\"Type\\": \\"Fixed\\",\\n \\"ReferencedSamplesFilter\\": \\"{ \\\\\\"bizdate\\\\\\": [ \\\\\\"-1\\\\\\", \\\\\\"-7\\\\\\", \\\\\\"-1m\\\\\\" ] }\\",\\n \\"Thresholds\\": {\\n \\"Expected\\": {\\n \\"Value\\": \\"100.0\\",\\n \\"Operator\\": \\">\\",\\n \\"Expression\\": \\"$checkValue > 0.01\\"\\n },\\n \\"Warned\\": {\\n \\"Value\\": \\"100.0\\",\\n \\"Operator\\": \\">\\",\\n \\"Expression\\": \\" $checkValue > 0.01\\"\\n },\\n \\"Critical\\": {\\n \\"Value\\": \\"100.0\\",\\n \\"Operator\\": \\">\\",\\n \\"Expression\\": \\" $checkValue > 0.01\\"\\n }\\n }\\n },\\n \\"ErrorHandlers\\": [\\n {\\n \\"Type\\": \\"SaveErrorData\\\\n\\",\\n \\"ErrorDataFilter\\": \\"SELECT * FROM tb_api_log WHERE id IS NULL\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListDataQualityRuleTemplates' => [ + 'summary' => 'Queries a list of data quality rule templates.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, + 'operationType' => 'read', + 'deprecated' => true, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '234098', - 'abilityTreeNodes' => [ - 'FEATUREdideBP0OJZ', - ], + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '259074', + 'abilityTreeNodes' => ['FEATUREdideRGVRPF'], ], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the synchronization task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '11126', - ], + 'schema' => ['description' => 'The DataWorks workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10000', 'title' => ''], ], [ - 'name' => 'ProjectId', + 'name' => 'CreationSource', 'in' => 'query', - 'schema' => [ - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '108864', - ], + 'schema' => ['description' => 'The creation source of the rule template. This parameter is required.'."\n" + .'- System: system template'."\n" + .'- UserDefined: user-defined template', 'type' => 'string', 'docRequired' => true, 'required' => true, 'example' => 'System'."\n", 'title' => ''], ], [ - 'name' => 'DIJobId', + 'name' => 'DirectoryPath', 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter is deprecated. Use the Id parameter instead.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'deprecated' => true, - 'required' => false, - 'example' => '11126', - ], + 'schema' => ['description' => 'The category directory in which the custom template is stored. Levels are separated by forward slashes (/). Each level name can be up to 1,024 characters in length and cannot contain whitespace characters or backslashes.', 'type' => 'string', 'required' => false, 'example' => '/ods/order_data', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The fuzzy match of the template rule name. For a system template, the internationalized name of the system template is fuzzy matched based on the language.', 'type' => 'string', 'required' => false, 'example' => 'Table rows', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page in a paginated query. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'docRequired' => true, 'minimum' => '1', 'default' => '1', 'required' => true, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The page number of a paginated query. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'docRequired' => true, 'maximum' => '200', 'minimum' => '1', 'default' => '10', 'required' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'true', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => 'D33D4A51-5845-579A-B4BA-FAADD0F83D53', + 'RequestId' => ['title' => '', 'description' => 'The API request ID.', 'type' => 'string', 'example' => '691CA452-D37A-****'], + 'PagingInfo' => [ + 'description' => 'The paginated query result of data quality rule templates.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '42', 'title' => ''], + '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' => ''], + 'DataQualityRuleTemplates' => [ + 'description' => 'The list of rule templates.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the rule template.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The code of the rule template.', 'type' => 'string', 'example' => 'USER_DEFINED:123', 'title' => ''], + 'Name' => ['description' => 'The name of the rule template. It can be a combination of digits, letters, Chinese characters, and half-width or full-width punctuation marks, and can be up to 512 characters in length.', 'type' => 'string', 'example' => 'Table row Count Verification'."\n", 'title' => ''], + 'ProjectId' => ['description' => 'The DataWorks workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '2043', 'title' => ''], + 'SamplingConfig' => [ + 'description' => 'The settings required for sample collection.', + 'type' => 'object', + 'properties' => [ + 'Metric' => ['description' => 'The name of the sampling metric.'."\n" + .'- Count: the number of table rows'."\n" + .'- Min: the minimum value of the field'."\n" + .'- Max: the maximum value of the field'."\n" + .'- Avg: the average value of the field'."\n" + .'- DistinctCount: the number of unique values of the field'."\n" + .'- DistinctPercent: the ratio of the number of unique values of the field to the number of data rows'."\n" + .'- DuplicatedCount: the number of duplicate values of the field'."\n" + .'- DuplicatedPercent: the ratio of the number of duplicate values of the field to the number of data rows'."\n" + .'- TableSize: the size of the table'."\n" + .'- NullValueCount: the number of rows in which the field is null'."\n" + .'- NullValuePercent: the ratio of rows in which the field is null'."\n" + .'- GroupCount: each value and the corresponding number of data rows after aggregation by field value'."\n" + .'- CountNotIn: the number of rows in which the enumeration value does not match'."\n" + .'- CountDistinctNotIn: the number of unique values in which the enumeration value does not match'."\n" + .'- UserDefinedSql: collect samples by using custom SQL', 'type' => 'string', 'example' => 'Max', 'title' => ''], + 'MetricParameters' => ['description' => 'The parameters required for sample collection.', 'type' => 'string', 'example' => '{"Sql": "select count(1) from table;"}'."\n", 'title' => ''], + 'SettingConfig' => ['description' => 'The runtime parameter setting statements that are inserted and executed before the sampling statement is executed. This parameter can be up to 1,000 characters in length. Currently, only MaxCompute is supported.', 'type' => 'string', 'example' => 'SET odps.sql.udf.timeout=600s; '."\n" + .'SET odps.sql.python.version=cp27;'."\n", 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'CheckingConfig' => [ + 'description' => 'The sample verification settings.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The threshold calculation method.'."\n" + .'- Fixed'."\n" + .'- Fluctation'."\n" + .'- FluctationDiscreate'."\n" + .'- Auto'."\n" + .'- Average'."\n" + .'- Variance', 'type' => 'string', 'example' => 'Fixed', 'title' => ''], + 'ReferencedSamplesFilter' => ['description' => 'Some types of thresholds require reference samples to be queried, and then the values of the reference samples are aggregated to obtain the threshold for comparison. An expression is used here to indicate the query method of the reference samples.', 'type' => 'string', 'example' => '{ "bizdate": [ "-1", "-7", "-1m" ] }'."\n", 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'VisibleScope' => ['description' => 'The available scope of the template:'."\n" + .'- Tenant: available to all tenants'."\n" + .'- Project: available only in the current project', 'type' => 'string', 'example' => 'Project', 'title' => ''], + 'DirectoryPath' => ['description' => 'The category directory in which the custom template is stored. Levels are separated by forward slashes (/). Each level name can be up to 1,024 characters in length and cannot contain whitespace characters or slashes.', 'type' => 'string', 'example' => '/ods/order_data', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'staticInfo' => [ + 'substitutions' => ['dataworks-public::2024-05-18::ListDataQualityTemplates'], 'returnType' => 'synchronous', ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"D33D4A51-5845-579A-B4BA-FAADD0F****\\"\\n}","type":"json"}]', - 'title' => 'DeleteDIJob', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", - ], - 'StopDIJob' => [ - 'summary' => 'Stops a synchronization task.', - 'methods' => [ - 'get', + 'title' => 'Queries a list of data quality rule templates', + 'description' => 'You must purchase DataWorks Basic Edition or higher to use this feature.', + 'changeSet' => [ + ['createdAt' => '2025-03-31T05:58:07.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-****\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 42,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"DataQualityRuleTemplates\\": [\\n {\\n \\"Code\\": \\"USER_DEFINED:123\\",\\n \\"Name\\": \\"Table row Count Verification\\\\n\\",\\n \\"ProjectId\\": 2043,\\n \\"SamplingConfig\\": {\\n \\"Metric\\": \\"Max\\",\\n \\"MetricParameters\\": \\"{\\\\\\"Sql\\\\\\": \\\\\\"select count(1) from table;\\\\\\"}\\\\n\\",\\n \\"SettingConfig\\": \\"SET odps.sql.udf.timeout=600s; \\\\nSET odps.sql.python.version=cp27;\\\\n\\"\\n },\\n \\"CheckingConfig\\": {\\n \\"Type\\": \\"Fixed\\",\\n \\"ReferencedSamplesFilter\\": \\"{ \\\\\\"bizdate\\\\\\": [ \\\\\\"-1\\\\\\", \\\\\\"-7\\\\\\", \\\\\\"-1m\\\\\\" ] }\\\\n\\"\\n },\\n \\"VisibleScope\\": \\"Project\\",\\n \\"DirectoryPath\\": \\"/ods/order_data\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListDataQualityRules' => [ + 'summary' => 'Paginated query of data quality monitoring rules.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, + 'operationType' => 'read', + 'deprecated' => true, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '235119', - 'abilityTreeNodes' => [ - 'FEATUREdideBP0OJZ', - ], + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '237677', + 'abilityTreeNodes' => ['FEATUREdide3WJOKE'], ], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the synchronization task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '11668', - ], + 'schema' => ['title' => '', 'description' => 'DataWorks workspace ID.', 'type' => 'integer', 'format' => 'int64', 'docRequired' => true, 'required' => true, 'example' => '10002'], ], [ - 'name' => 'InstanceId', + 'name' => 'DataQualityEvaluationTaskId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1234', - ], + 'schema' => ['title' => '', 'description' => 'ID of the associated data quality evaluation task.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000'], ], [ - 'name' => 'DIJobId', + 'name' => 'TableGuid', 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter is deprecated and is replaced by the Id parameter.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'deprecated' => true, - 'required' => false, - 'example' => '11668', - 'title' => '', - ], + 'schema' => ['title' => '', 'description' => 'The unique identifier of the table to which the rule applies in Data Map.', 'type' => 'string', 'required' => false, 'example' => 'odps.unit_test.tb_unit_test'], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Rule name for fuzzy matching.', 'type' => 'string', 'required' => false, 'example' => 'unit_test'], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'Number of entries per page. Default value: 10. Maximum value: 200.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '200', 'minimum' => '1', 'default' => '10', 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'Page number for paginated query. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'docRequired' => true, 'default' => '1', 'required' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Return value.', 'type' => 'object', 'properties' => [ - '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. You can use the ID to query logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '92F778C7-8F00-53B1-AE1A-B3B17101247D', + 'RequestId' => ['title' => '', 'description' => 'Request ID.', 'type' => 'string', 'example' => '691CA452-D37A-4ED0-9441'], + 'PagingInfo' => [ + 'description' => 'Paginated query result of the rule list.', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => 'Page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'Page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'Total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '294', 'title' => ''], + 'DataQualityRules' => [ + 'description' => 'Specific rule list.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'Rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '22130', 'title' => ''], + 'Name' => ['description' => 'Rule name.', 'type' => 'string', 'example' => 'The table cannot be empty.', 'title' => ''], + 'ProjectId' => ['description' => 'DataWorks workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '100001', 'title' => ''], + 'Enabled' => ['description' => 'Whether the data quality rule is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Severity' => ['description' => 'Severity level of the rule for the business (corresponding to strong/weak rules on the page). Valid enumerated values:'."\n" + .'- Normal'."\n" + .'- High', 'type' => 'string', 'example' => 'High', 'title' => ''], + 'Description' => ['description' => 'Rule description. Maximum length: 500 characters.', 'type' => 'string', 'example' => 'this is a odps _sql task', 'title' => ''], + 'Target' => [ + 'description' => 'Object monitored by the rule.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'Type of the monitored object.'."\n" + ."\n" + .'- Table', 'type' => 'string', 'example' => 'Table', 'title' => ''], + 'DatabaseType' => ['description' => 'For table-type datasets, the database type to which the table belongs.'."\n" + .'- maxcompute'."\n" + .'- emr'."\n" + .'- cdh'."\n" + .'- hologres'."\n" + .'- analyticdb_for_postgresql'."\n" + .'- analyticdb_for_mysql'."\n" + .'- starrocks', 'type' => 'string', 'example' => 'maxcompute', 'title' => ''], + 'TableGuid' => ['description' => 'Unique ID of the table to which the rule applies in Data Map.', 'type' => 'string', 'example' => 'odps.unit_test.tb_unit_test', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'TemplateCode' => ['description' => 'Unique identifier of the rule template referenced by the rule.', 'type' => 'string', 'example' => 'SYSTEM:user_defined_sql', 'title' => ''], + 'SamplingConfig' => [ + 'description' => 'Settings required for sample collection.', + 'type' => 'object', + 'properties' => [ + 'Metric' => ['description' => 'Sampling metric name.'."\n" + .'- Count: number of table rows.'."\n" + .'- Min: minimum value of the field.'."\n" + .'- Max: maximum value of the field.'."\n" + .'- Avg: average value of the field.'."\n" + .'- DistinctCount: number of distinct values of the field.'."\n" + .'- DistinctPercent: ratio of the number of distinct values of the field to the number of data rows.'."\n" + .'- DuplicatedCount: number of duplicate values of the field.'."\n" + .'- DuplicatedPercent: ratio of the number of duplicate values of the field to the number of data rows.'."\n" + .'- TableSize: table size.'."\n" + .'- NullValueCount: number of rows where the field value is null.'."\n" + .'- NullValuePercent: percentage of rows where the field value is null.'."\n" + .'- GroupCount: each value and its corresponding number of data rows after aggregation by field value.'."\n" + .'- CountNotIn: number of rows whose enumerated values do not match.'."\n" + .'- CountDistinctNotIn: number of distinct values whose enumerated values do not match.'."\n" + .'- UserDefinedSql: sample collection via custom SQL.', 'type' => 'string', 'example' => 'Max', 'title' => ''], + 'MetricParameters' => ['description' => 'Parameters required during sample collection.', 'type' => 'string', 'example' => '{ "Columns": [ "id", "name" ] , "SQL": "select count(1) from table;"}', 'title' => ''], + 'SettingConfig' => ['description' => 'Runtime parameter setting statements inserted and executed before the sampling statement is actually executed. Maximum length: 1,000 characters. Currently only MaxCompute is supported.', 'type' => 'string', 'example' => 'SET odps.sql.udf.timeout=600s; '."\n" + .'SET odps.sql.python.version=cp27;', 'title' => ''], + 'SamplingFilter' => ['description' => 'Condition for the secondary filtering of data that is not of concern during sampling. Maximum length: 16,777,215 characters.', 'type' => 'string', 'example' => 'id IS NULL', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'CheckingConfig' => [ + 'description' => 'Sample validation settings.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'Threshold calculation method.'."\n" + .'- Fixed'."\n" + .'- Fluctation'."\n" + .'- FluctationDiscreate'."\n" + .'- Auto'."\n" + .'- Average'."\n" + .'- Variance', 'type' => 'string', 'example' => 'Fixed', 'title' => ''], + 'ReferencedSamplesFilter' => ['description' => 'Some types of thresholds require querying some reference samples, then aggregating the values of the reference samples to obtain the threshold for comparison. An expression is used here to represent the query method for the reference samples.', 'type' => 'string', 'example' => '{ "bizdate": [ "-1", "-7", "-1m" ] }', 'title' => ''], + 'Thresholds' => [ + 'description' => 'Threshold settings.', + 'type' => 'object', + 'properties' => [ + 'Expected' => [ + 'description' => 'Expected threshold settings.', + 'type' => 'object', + 'properties' => [ + 'Operator' => ['description' => 'Comparison operator.'."\n" + .'- \\>'."\n" + .'- \\>='."\n" + .'- <'."\n" + .'- <='."\n" + .'- !='."\n" + .'- =', 'type' => 'string', 'example' => '>', 'title' => ''], + 'Value' => ['description' => 'Threshold value.', 'type' => 'string', 'example' => '100.0', 'title' => ''], + 'Expression' => ['description' => 'Threshold expression.'."\n" + ."\n" + .'Fluctuation rate type rules must use the expression method to indicate the fluctuation threshold. Examples:'."\n" + ."\n" + .'- Fluctuation increase greater than 0.01: $checkValue > 0.01 '."\n" + .'- Fluctuation decrease greater than 0.01: $checkValue < -0.01 '."\n" + .'- Absolute value of the fluctuation rate: abs($checkValue) > 0.01'."\n" + ."\n" + .'Fixed value type rules can also configure thresholds using expressions. If both are configured, the expression takes precedence over Operator and Value.', 'type' => 'string', 'example' => '$checkValue > 0.01', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Warned' => [ + 'description' => 'Threshold settings for normal warnings.', + 'type' => 'object', + 'properties' => [ + 'Operator' => ['description' => 'Comparison operator.'."\n" + .'- \\>'."\n" + .'- \\>='."\n" + .'- <'."\n" + .'- <='."\n" + .'- !='."\n" + .'- =', 'type' => 'string', 'example' => '>', 'title' => ''], + 'Value' => ['description' => 'Threshold value.', 'type' => 'string', 'example' => '100.0', 'title' => ''], + 'Expression' => ['description' => 'Threshold expression.'."\n" + ."\n" + .'Fluctuation rate type rules must use the expression method to indicate the fluctuation threshold. Examples:'."\n" + ."\n" + .'- Fluctuation increase greater than 0.01: $checkValue > 0.01 '."\n" + .'- Fluctuation decrease greater than 0.01: $checkValue < -0.01 '."\n" + .'- Absolute value of the fluctuation rate: abs($checkValue) > 0.01'."\n" + ."\n" + .'Fixed value type rules can also configure thresholds using expressions. If both are configured, the expression takes precedence over Operator and Value.', 'type' => 'string', 'example' => '$checkValue > 0.01', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Critical' => [ + 'description' => 'Threshold settings for critical warnings.', + 'type' => 'object', + 'properties' => [ + 'Operator' => ['description' => 'Comparison operator.'."\n" + .'- \\>'."\n" + .'- \\>='."\n" + .'- <'."\n" + .'- <='."\n" + .'- !='."\n" + .'- =', 'type' => 'string', 'example' => '>', 'title' => ''], + 'Value' => ['description' => 'Threshold value.', 'type' => 'string', 'example' => '100.0', 'title' => ''], + 'Expression' => ['description' => 'Threshold expression.'."\n" + ."\n" + .'Fluctuation rate type rules must use the expression method to indicate the fluctuation threshold. Examples:'."\n" + ."\n" + .'- Fluctuation increase greater than 0.01: $checkValue > 0.01 '."\n" + .'- Fluctuation decrease greater than 0.01: $checkValue < -0.01 '."\n" + .'- Absolute value of the fluctuation rate: abs($checkValue) > 0.01'."\n" + ."\n" + .'Fixed value type rules can also configure thresholds using expressions. If both are configured, the expression takes precedence over Operator and Value.', 'type' => 'string', 'example' => '$checkValue > 0.01', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'ErrorHandlers' => [ + 'description' => 'List of issue handlers for data quality rule validation.', + 'type' => 'array', + 'items' => [ + 'description' => 'Issue handler for data quality rule validation.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'Handler type:'."\n" + .'- SaveErrorData', 'type' => 'string', 'example' => 'SaveErrorData'."\n", 'title' => ''], + 'ErrorDataFilter' => ['description' => 'For custom SQL rules, the user needs to specify SQL to filter problem data.', 'type' => 'string', 'example' => 'SELECT * FROM tb_api_log WHERE id IS NULL', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], 'staticInfo' => [ - 'returnType' => 'synchronous', + 'substitutions' => ['dataworks-public::2024-05-18::ListDataQualityScans'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"92F778C7-8F00-53B1-AE1A-B3B17101247D\\"\\n}","type":"json"}]', - 'title' => 'StopDIJob', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", - ], - 'StartDIJob' => [ - 'summary' => 'Starts a new-version synchronization task.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-4ED0-9441\\",\\n \\"PagingInfo\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 294,\\n \\"DataQualityRules\\": [\\n {\\n \\"Id\\": 22130,\\n \\"Name\\": \\"The table cannot be empty.\\",\\n \\"ProjectId\\": 100001,\\n \\"Enabled\\": true,\\n \\"Severity\\": \\"High\\",\\n \\"Description\\": \\"this is a odps _sql task\\",\\n \\"Target\\": {\\n \\"Type\\": \\"Table\\",\\n \\"DatabaseType\\": \\"maxcompute\\",\\n \\"TableGuid\\": \\"odps.unit_test.tb_unit_test\\"\\n },\\n \\"TemplateCode\\": \\"SYSTEM:user_defined_sql\\",\\n \\"SamplingConfig\\": {\\n \\"Metric\\": \\"Max\\",\\n \\"MetricParameters\\": \\"{ \\\\\\"Columns\\\\\\": [ \\\\\\"id\\\\\\", \\\\\\"name\\\\\\" ] , \\\\\\"SQL\\\\\\": \\\\\\"select count(1) from table;\\\\\\"}\\",\\n \\"SettingConfig\\": \\"SET odps.sql.udf.timeout=600s; \\\\nSET odps.sql.python.version=cp27;\\",\\n \\"SamplingFilter\\": \\"id IS NULL\\"\\n },\\n \\"CheckingConfig\\": {\\n \\"Type\\": \\"Fixed\\",\\n \\"ReferencedSamplesFilter\\": \\"{ \\\\\\"bizdate\\\\\\": [ \\\\\\"-1\\\\\\", \\\\\\"-7\\\\\\", \\\\\\"-1m\\\\\\" ] }\\",\\n \\"Thresholds\\": {\\n \\"Expected\\": {\\n \\"Operator\\": \\">\\",\\n \\"Value\\": \\"100.0\\",\\n \\"Expression\\": \\"$checkValue > 0.01\\"\\n },\\n \\"Warned\\": {\\n \\"Operator\\": \\">\\",\\n \\"Value\\": \\"100.0\\",\\n \\"Expression\\": \\"$checkValue > 0.01\\"\\n },\\n \\"Critical\\": {\\n \\"Operator\\": \\">\\",\\n \\"Value\\": \\"100.0\\",\\n \\"Expression\\": \\"$checkValue > 0.01\\"\\n }\\n }\\n },\\n \\"ErrorHandlers\\": [\\n {\\n \\"Type\\": \\"SaveErrorData\\\\n\\",\\n \\"ErrorDataFilter\\": \\"SELECT * FROM tb_api_log WHERE id IS NULL\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Queries the list of data quality rules.', + 'description' => 'Requires DataWorks Basic Edition or above.', + 'extraInfo' => 'Rule template Code list:'."\n" + .'- Custom SQL: SYSTEM:user_defined_sql'."\n" + ."\n" + .'- Table row count greater than 0: SYSTEM:table:table_count:fixed:0'."\n" + .'- Table row count, fixed value: SYSTEM:table:table_count:fixed'."\n" + .'- Table row count, 1-day delta: SYSTEM:table:table_count_delta:fixed:1_bizdate'."\n" + .'- Table row count, previous cycle delta: SYSTEM:table:table_count_delta:fixed:latest_bizdate'."\n" + .'- Table row count, previous cycle fluctuation rate: SYSTEM:table:table_count:cycle:latest_bizdate'."\n" + .'- Table row count, 7-day average fluctuation rate: SYSTEM:table:table_count:avg:7_bizdate'."\n" + .'- Table row count, 30-day average fluctuation rate: SYSTEM:table:table_count:avg:1m_bizdate'."\n" + .'- Table row count, 1-day fluctuation rate: SYSTEM:table:table_count:flux:1_bizdate'."\n" + .'- Table row count, 7-day fluctuation rate: SYSTEM:table:table_count:flux:7_bizdate'."\n" + .'- Table row count, 30-day fluctuation rate: SYSTEM:table:table_count:flux:1m_bizdate'."\n" + .'- Table row count, 1, 7, 30-day fluctuation rate: SYSTEM:table:table_count:flux:1_7_1m_bizdate'."\n" + .'- Table row count, 1, 7, 30-day, 1st of this month, fluctuation rate: SYSTEM:table:table_count:flux:1_7_1m_1st_bizdate'."\n" + .'- Table row count, custom range: SYSTEM:table:count'."\n" + .'- Condition match ratio, custom range: SYSTEM:table:count_percent'."\n" + ."\n" + .'- Average value, 1-day fluctuation rate: SYSTEM:field:avg:cycle:1_bizdate'."\n" + .'- Average value, 1, 7, 30-day fluctuation rate: SYSTEM:field:avg:flux:1_7_1m_bizdate'."\n" + .'- Average value, custom range: SYSTEM:field:avg'."\n" + ."\n" + .'- Sum value, 1-day fluctuation rate: SYSTEM:field:sum:cycle:1_bizdate'."\n" + .'- Sum value, previous cycle fluctuation rate: SYSTEM:field:sum:cycle:latest_bizdate'."\n" + .'- Sum value, 1, 7, 30-day fluctuation rate: SYSTEM:field:sum:flux:1_7_1m_bizdate'."\n" + .'- Sum value, custom range: SYSTEM:field:sum'."\n" + ."\n" + .'- Minimum value, 1-day fluctuation rate: SYSTEM:field:min:cycle:1_bizdate'."\n" + .'- Minimum value, previous cycle fluctuation rate: SYSTEM:field:min:cycle:latest_bizdate'."\n" + .'- Minimum value, 1, 7, 30-day fluctuation rate: SYSTEM:field:min:flux:1_7_1m_bizdate'."\n" + .'- Minimum value, custom range: SYSTEM:field:min'."\n" + ."\n" + .'- Maximum value, 1-day fluctuation rate: SYSTEM:field:max:cycle:1_bizdate'."\n" + .'- Maximum value, previous cycle fluctuation rate: SYSTEM:field:max:cycle:latest_bizdate'."\n" + .'- Maximum value, 1, 7, 30-day fluctuation rate: SYSTEM:field:max:flux:1_7_1m_bizdate'."\n" + .'- Maximum value, custom range: SYSTEM:field:max'."\n" + ."\n" + .'- Number of null value records is 0: SYSTEM:field:null_value:fixed:0'."\n" + .'- Null value count, fixed value: SYSTEM:field:null_value:fixed'."\n" + .'- Null value count / total row count, fixed value: SYSTEM:field:null_value_percent:fixed'."\n" + ."\n" + .'- Field duplicate value count is 0: SYSTEM:field:duplicated_count:fixed:0'."\n" + .'- Duplicate value count / total row count, fixed value: SYSTEM:field:duplicated_percent:fixed'."\n" + .'- Duplicate value count, fixed value: YSTEM:field:duplicated_count:fixed'."\n" + .'- Multi-field duplicate value count is 0: SYSTEM:fields:duplicated_count:fixed:0'."\n" + ."\n" + .'- Discrete value (status value), fixed value: SYSTEM:field:all_discrete_count:fixed'."\n" + .'- Discrete value (group count and status value), 1, 7, 30-day fluctuation rate: SYSTEM:field:all_discrete_metrics:fluxdiscrete:1_7_1m_bizdate'."\n" + .'- Discrete value (group count), fixed value: SYSTEM:field:discrete_group_count:fixed'."\n" + .'- Discrete value (group count), 1-day fluctuation rate: SYSTEM:field:discrete_group_count:cycle:latest_bizdate'."\n" + ."\n" + .'- Table size, fixed value: SYSTEM:table:table_size:fixed'."\n" + .'- Table size, previous cycle delta: SYSTEM:table:table_size_delta:fixed:latest_bizdate'."\n" + .'- Table size, delta compared to 1 day ago (bytes): SYSTEM:table:table_size_delta:fixed:1_bizdate'."\n" + .'- Table size, 1-day fluctuation rate: SYSTEM:table:table_size:flux:1_bizdate'."\n" + .'- Table size, 7-day fluctuation rate: SYSTEM:table:table_size:flux:7_bizdate'."\n" + .'- Table size, 30-day fluctuation rate: SYSTEM:table:table_size:flux:1m_bizdate'."\n" + ."\n" + .'- Distinct value count, fixed value: SYSTEM:field:count_distinct:fixed'."\n" + .'- Distinct value count, 1, 7, 30-day fluctuation rate: SYSTEM:field:count_distinct:flux:1_7_1m_bizdate'."\n" + .'- Distinct value count / total row count, fixed value: SYSTEM:field:count_distinct_percent:fixed'."\n" + ."\n" + .'- Table row count, dynamic threshold: SYSTEM:table:table_count:dynamic_threshold'."\n" + .'- Sum value, dynamic threshold: SYSTEM:field:sum:dynamic_threshold'."\n" + .'- Average value, dynamic threshold: SYSTEM:field:avg:dynamic_threshold'."\n" + .'- Maximum value, dynamic threshold: SYSTEM:field:max:dynamic_threshold'."\n" + .'- Minimum value, dynamic threshold: SYSTEM:field:min:dynamic_threshold'."\n" + .'- Distinct value rate, dynamic threshold: SYSTEM:table:table_size:dynamic_threshold'."\n" + .'- Distinct value count, dynamic threshold: SYSTEM:table:distinct_count:dynamic_threshold'."\n" + .'- Discrete value (group count), dynamic threshold: SYSTEM:field:avg:dynamic_threshold'."\n" + .'- Discrete value (status value), dynamic threshold: SYSTEM:field:sum:dynamic_threshold'."\n" + .'- Discrete value (group count), dynamic threshold: SYSTEM:field:discrete_group_count:dynamic_threshold'."\n" + .'- Discrete value (status value), dynamic threshold: SYSTEM:field:discrete_value_count:dynamic_threshold', + 'changeSet' => [ + ['createdAt' => '2025-03-31T05:58:07.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-01-15T08:15:09.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-12-23T06:29:09.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-12-19T09:25:09.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-12-04T03:12:44.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-11-06T02:56:45.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' => '*'], + ], + ], + ], ], + ], + 'ListDataQualityScanRuns' => [ + 'summary' => 'Queries the run history of data quality scans in a specified project.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -27297,138 +30263,189 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '235100', - 'abilityTreeNodes' => [ - 'FEATUREdideBP0OJZ', - ], + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdide3WJOKE'], ], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'DataQualityScanId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the synchronization task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10000', - ], + 'schema' => ['description' => 'The ID of the data quality scan.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10001', 'title' => ''], ], [ - 'name' => 'ForceToRerun', + 'name' => 'CreateTimeFrom', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to forcefully rerun all synchronization steps. If you do not configure this parameter, the system does not perform the forcible rerun operation.'."\n" - ."\n" - .'* If the system does not perform the forcible rerun operation, only the steps that are not run start to run.'."\n" - .'* If the system performs the forcible rerun operation, all steps start to rerun.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The earliest start time of a data quality scan run to include in the results. Specify the time as a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1710239005403', 'title' => ''], ], [ - 'name' => 'RealtimeStartSettings', + 'name' => 'CreateTimeTo', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The settings for starting real-time synchronization.'."\n" - ."\n" - .' {'."\n" - .' "StartTime":1663765058'."\n" - .' }'."\n", - 'type' => 'object', - 'properties' => [ - 'StartTime' => [ - 'description' => 'The start time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1671516776', - ], - 'FailoverSettings' => [ - 'description' => 'This parameter is deprecated. Use advanced parameters for failover settings when you create a task.'."\n", - 'type' => 'object', - 'properties' => [ - 'Interval' => [ - 'description' => 'This parameter is deprecated. Use advanced parameters for failover settings when you create a task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'deprecated' => true, - 'required' => false, - 'example' => '10', - ], - 'UpperLimit' => [ - 'description' => 'This parameter is deprecated. Use advanced parameters for failover settings when you create a task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'deprecated' => true, - 'required' => false, - 'example' => '30', - ], - ], - 'deprecated' => true, - 'required' => false, - ], - ], - 'required' => false, - ], + 'schema' => ['description' => 'The latest start time of a data quality scan run to include in the results. Specify the time as a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1710239005403', 'title' => ''], ], [ - 'name' => 'DIJobId', + 'name' => 'Status', 'in' => 'query', 'schema' => [ - 'description' => 'This parameter is deprecated. Use the Id parameter instead.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'deprecated' => true, + 'description' => 'The status of the data quality scan run. Valid values:'."\n" + ."\n" + .'- Pass'."\n" + ."\n" + .'- Running'."\n" + ."\n" + .'- Error'."\n" + ."\n" + .'- Fail'."\n" + ."\n" + .'- Warn', + 'enumValueTitles' => [], + 'type' => 'string', + 'enum' => ['Error', 'Fail', 'Kill', 'Pass', 'Running', 'Warn'], 'required' => false, - 'example' => '10000', + 'example' => 'Fail', 'title' => '', ], ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => ['description' => 'The sort field and order for the results. The format is `FieldName Order`. The default order is ascending (Asc). Supported fields:'."\n" + ."\n" + .'- CreateTime (Desc/Asc)'."\n" + ."\n" + .'- Id (Desc/Asc)', 'type' => 'string', 'required' => false, 'example' => 'CreateTime Desc', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number to return. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12345', 'title' => ''], + ], + [ + 'name' => 'Filter', + 'in' => 'query', + 'style' => 'json', + 'schema' => ['description' => 'An object with advanced filter conditions. The following parameters are supported:'."\n" + ."\n" + .'- `TaskInstanceId`: The ID of the task instance.'."\n" + ."\n" + .'- `RunNumber`: The run number of the instance.', 'type' => 'object', 'required' => false, 'example' => '{'."\n" + .' "TaskInstanceId": "111",'."\n" + .' "RunNumber": "1"'."\n" + .'}', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - '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' => '999431B2-6013-577F-B684-36F7433C753B', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0bc14115***159376359'], + 'PageInfo' => [ + 'description' => 'The pagination information.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '324', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page. The default value is 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'PageNumber' => ['description' => 'The page number. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'DataQualityScanRuns' => [ + 'description' => 'The list of data quality scan runs.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of a data quality scan run.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the data quality scan run.', 'type' => 'integer', 'format' => 'int64', 'example' => '3155', 'title' => ''], + 'CreateTime' => ['description' => 'The start time of the data quality scan run.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + 'FinishTime' => ['description' => 'The end time of the data quality scan run.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + 'Status' => [ + 'description' => 'The status of the data quality scan run. Valid values:'."\n" + ."\n" + .'- Pass'."\n" + ."\n" + .'- Running'."\n" + ."\n" + .'- Error'."\n" + ."\n" + .'- Warn'."\n" + ."\n" + .'- Fail', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'Fail', + 'title' => '', + ], + 'Parameters' => [ + 'description' => 'The parameters used for the run.', + 'type' => 'array', + 'items' => [ + 'description' => 'The parameter details.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The parameter name.', 'type' => 'string', 'example' => 'dt', 'title' => ''], + 'Value' => ['description' => 'The parameter value. You can use a scheduling time expression.', 'type' => 'string', 'example' => '$[yyyy-mm-dd-1]', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"999431B2-6013-577F-B684-36F7433C753B\\"\\n}","type":"json"}]', - 'title' => 'StartDIJob', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", - ], - 'GetDIJob' => [ - 'summary' => 'Queries the information about a synchronization task.', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListDataQualityScanRuns', + 'description' => 'This feature requires DataWorks basic edition or higher.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:ListDataQualityScanRuns', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115***159376359\\",\\n \\"PageInfo\\": {\\n \\"TotalCount\\": 324,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"DataQualityScanRuns\\": [\\n {\\n \\"Id\\": 3155,\\n \\"CreateTime\\": 1710239005403,\\n \\"FinishTime\\": 1710239005403,\\n \\"Status\\": \\"Fail\\",\\n \\"Parameters\\": [\\n {\\n \\"Name\\": \\"dt\\",\\n \\"Value\\": \\"$[yyyy-mm-dd-1]\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListDataQualityScans' => [ + 'summary' => 'Queries the list of data quality scan tasks in a project.', + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -27437,574 +30454,252 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '234096', - 'abilityTreeNodes' => [ - 'FEATUREdideBP0OJZ', - ], + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdide3WJOKE'], ], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the synchronization task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '11588', - ], + 'schema' => ['description' => 'The data quality scan task name for fuzzy match.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'WithDetails', + 'name' => 'SortBy', 'in' => 'query', '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', + 'description' => 'The list of sorting fields. Supports fields such as last modified time and creation time. Format: "SortField+SortOrder (Desc/Asc)", where Asc is the default. Valid values:'."\n" + ."\n" + .'- ModifyTime (Desc/Asc)'."\n" + ."\n" + .'- CreateTime (Desc/Asc)'."\n" + ."\n" + .'- Id (Desc/Asc)', + 'enumValueTitles' => [], + 'type' => 'string', 'required' => false, - 'example' => 'true', + 'example' => 'ModifyTime Desc', + 'title' => '', ], ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'maximum' => '200', 'minimum' => '1', 'example' => '1', 'title' => ''], + ], [ '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' => false, - 'example' => '10000', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000', 'title' => ''], ], [ - 'name' => 'DIJobId', + 'name' => 'Table', 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter is deprecated. Use the Id parameter instead.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'deprecated' => true, - 'required' => false, - 'example' => '11588', - 'title' => '', - ], + 'schema' => ['description' => 'Fuzzy match for the monitored table name.', 'type' => 'string', 'required' => false, 'example' => 'video_album', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '创建时间', - 'description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => 'C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490', - ], - 'PagingInfo' => [ - 'description' => 'The pagination information.'."\n", + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The API request ID, which is generated as a UUID.', 'type' => 'string', 'example' => '0bc14115***159376359'], + 'PageInfo' => [ + 'description' => 'The page information.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the synchronization task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '32601', - ], - 'Description' => [ - 'description' => 'The description of the synchronization task.'."\n", - 'type' => 'string', - 'example' => 'description', - ], - 'DestinationDataSourceSettings' => [ - 'description' => 'The properties of the destination.'."\n", + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of records per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of records returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'DataQualityScans' => [ + 'description' => 'The list of data quality monitors.', 'type' => 'array', 'items' => [ - 'description' => 'The properties of the destination.'."\n", + 'description' => 'Information about the data quality monitor.', 'type' => 'object', 'properties' => [ - 'DataSourceName' => [ - 'description' => 'The name of the data source.'."\n", - 'type' => 'string', - 'example' => 'dw_mysql', - ], - ], - ], - ], - 'DestinationDataSourceType' => [ - 'description' => 'The destination type. Valid values: Hologres, OSS-HDFS, OSS, MaxCompute, LogHub, StarRocks, DataHub, AnalyticDB_For_MySQL, Kafka, Hive.'."\n", - 'type' => 'string', - 'example' => 'Hologres', - ], - 'JobName' => [ - 'description' => 'The name of the synchronization task.'."\n", - 'type' => 'string', - 'example' => 'imp_ods_dms_det_dealer_info_df', - ], - 'JobSettings' => [ - 'description' => 'The runtime settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'ChannelSettings' => [ - 'description' => 'The channel control settings for the synchronization task. You can configure special channel control settings for the following synchronization links: data synchronization between Hologres data sources and data synchronization from Hologres to Kafka.'."\n" - ."\n" - .'1. Holo2Kafka'."\n" - ."\n" - .'* Example: {"destinationChannelSettings":{"kafkaClientProperties":\\[{"key":"linger.ms","value":"100"}],"keyColumns":\\["col3"],"writeMode":"canal"}}'."\n" - .'* kafkaClientProperties: the parameters related to a Kafka producer, which are used when you write data to a Kafka data source.'."\n" - .'* keyColumns: the names of Kafka columns to which data is written.'."\n" - .'* writeMode: the writing format. Valid values: json and canal.'."\n" - ."\n" - .'2. Holo2Holo'."\n" - ."\n" - .'* Example: {"destinationChannelSettings":{"conflictMode":"replace","dynamicColumnAction":"replay","writeMode":"replay"}}'."\n" - .'* conflictMode: the policy used to handle a conflict that occurs during data writing to Hologres. Valid values: replace and ignore.'."\n" - .'* writeMode: the mode in which data is written to Hologres. Valid values: replay and insert.'."\n" - .'* dynamicColumnAction: the mode in which data is written to dynamic columns in a Hologres table. Valid values: replay, insert, and ignore.'."\n", - 'type' => 'string', - 'example' => '{"structInfo":"MANAGED","storageType":"TEXTFILE","writeMode":"APPEND","partitionColumns":[{"columnName":"pt","columnType":"STRING","comment":""}],"fieldDelimiter":""}', - ], - 'ColumnDataTypeSettings' => [ - 'description' => 'The data type mappings between source fields and destination fields.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data type mapping between a source field and a destination field.'."\n", - 'type' => 'object', - 'properties' => [ - 'DestinationDataType' => [ - 'description' => 'The data type of the destination field. Valid values: bigint, boolean, string, text, datetime, timestamp, decimal, and binary. Different types of data sources support different data types.'."\n", - 'type' => 'string', - 'example' => 'text', - ], - 'SourceDataType' => [ - 'description' => 'The data type of the source field. Valid values: bigint, boolean, string, text, datetime, timestamp, decimal, and binary. Different types of data sources support different data types.'."\n", - 'type' => 'string', - 'example' => 'bigint', + 'ModifyTime' => ['description' => 'Last update time of the data quality monitor.', 'type' => 'integer', 'format' => 'int64', 'example' => '17236236472', 'title' => ''], + 'Owner' => ['description' => 'The user ID of the owner responsible for the data quality monitor.', 'type' => 'string', 'example' => '23782382795249', 'title' => ''], + 'Description' => ['description' => 'The description of the data quality scan task. Maximum length: 65,535 characters.', 'type' => 'string', 'example' => 'This is a hourly run data quality evaluation plan.', 'title' => ''], + 'ModifyUser' => ['description' => 'The user ID of the last person who updated the data quality monitor.', 'type' => 'string', 'example' => '23782382795249', 'title' => ''], + 'Parameters' => [ + 'description' => 'Execution parameter definitions for the data quality monitor.', + 'type' => 'array', + 'items' => [ + 'description' => 'Execution parameter definitions for the data quality monitor.', + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => 'The parameter value.', 'type' => 'string', 'example' => '$[yyyy-mm-dd-1]', 'title' => ''], + 'Name' => ['description' => 'The parameter name.', 'type' => 'string', 'example' => 'dt', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + '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', - 'example' => 'Full', - ], - 'ScheduleParameters' => [ - 'description' => 'The scheduling parameters.'."\n", - 'type' => 'string', - 'example' => 'bizdate=$bizdate'."\n", - ], - ], - ], - 'DdlHandlingSettings' => [ - 'description' => 'The DDL operation types. Valid values:'."\n" - ."\n" - .'* RenameColumn'."\n" - .'* ModifyColumn'."\n" - .'* CreateTable'."\n" - .'* TruncateTable'."\n" - .'* DropTable'."\n" - .'* DropColumn'."\n" - .'* AddColumn'."\n", - 'type' => 'array', - 'items' => [ - '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", + 'CreateTime' => ['description' => 'The creation time of the data quality monitor.', 'type' => 'integer', 'format' => 'int64', 'example' => '1694512304000', 'title' => ''], + 'ProjectId' => ['description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '59094', 'title' => ''], + 'CreateUser' => ['description' => 'The creator of the data quality monitor.', 'type' => 'string', 'example' => '7892346529452', 'title' => ''], + 'ComputeResource' => [ + 'description' => 'The compute engine used during execution. If it is not specified, the data source connection defined in the Spec will be used.', 'type' => 'object', 'properties' => [ - 'Action' => [ - 'description' => 'The processing policy for a specific type of DDL message. 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', - 'example' => 'Ignore', + 'Runtime' => [ + 'description' => 'Additional runtime settings for the data quality monitor.', + 'type' => 'object', + 'properties' => [ + 'HiveConf' => ['description' => 'Additional parameters for the Hive engine. Currently, only mapreduce.job.queuename is supported to set the queue.', 'type' => 'string', 'example' => 'mapreduce.job.queuename=dq_queue', 'title' => ''], + 'SparkConf' => ['description' => 'Additional parameters for the Spark engine. Currently, only spark.yarn.queue is supported to set the queue.', 'type' => 'string', 'example' => 'spark.yarn.queue=dq_queue', 'title' => ''], + 'Engine' => [ + 'description' => 'The engine type. These settings are only supported for the EMR compute engine. Valid values:'."\n" + ."\n" + .'- Hive: Hive SQL'."\n" + ."\n" + .'- Spark: Spark SQL'."\n" + ."\n" + .'- Kyuubi', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'Hive', + 'title' => '', + ], + ], + 'title' => '', + 'example' => '', ], - 'Type' => [ - 'description' => 'The DDL operation type. Valid values:'."\n" + 'EnvType' => [ + 'description' => 'Workspace environment of the compute engine. Valid values:'."\n" ."\n" - .'* RenameColumn'."\n" - .'* ModifyColumn'."\n" - .'* CreateTable'."\n" - .'* TruncateTable'."\n" - .'* DropTable'."\n", + .'- Prod'."\n" + ."\n" + .'- Dev', + 'enumValueTitles' => [], 'type' => 'string', - 'example' => 'CreateTable', + 'example' => 'Prod', + 'title' => '', ], + 'Name' => ['description' => 'The name of the computing engine. Uniquely identifies the engine.', 'type' => 'string', 'example' => 'emr_cluster_001', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - ], - 'RuntimeSettings' => [ - 'description' => 'The runtime settings.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The runtime setting.'."\n", + 'Name' => ['description' => 'The name of the data quality scan task. Can include digits, letters, Chinese characters, and both half-width and full-width punctuation marks. Maximum length: 255 characters.', 'type' => 'string', 'example' => 'Hourly partition quality monitoring', 'title' => ''], + 'RuntimeResource' => [ + 'description' => 'The resource group used during the execution of the data quality monitor.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'The name of the configuration item. Valid values:'."\n" - ."\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" - .'* dst.offline.truncate: indicates whether to clear the destination table before data writing.'."\n" - .'* runtime.offline.speed.limit.enable: indicates whether throttling is enabled for a batch synchronization task.'."\n" - .'* runtime.offline.concurrent: indicates the maximum number of parallel threads that are allowed for a batch synchronization task.'."\n" - .'* runtime.enable.auto.create.schema: indicates whether schemas are automatically created in the destination of a synchronization task.'."\n" - .'* runtime.realtime.concurrent: indicates the maximum number of parallel threads that are allowed for a real-time synchronization task.'."\n" - .'* runtime.realtime.failover.minute.dataxcdc: indicates the maximum waiting duration before a synchronization task retries the next restart if the previous restart fails after failover occurs. Unit: minutes.'."\n" - .'* runtime.realtime.failover.times.dataxcdc: indicates the maximum number of failures that are allowed for restarting a synchronization task after failovers occur.'."\n", - 'type' => 'string', - 'example' => 'runtime.offline.concurrent'."\n", - ], - 'Value' => [ - 'description' => 'The value of the configuration item.'."\n", - 'type' => 'string', - 'example' => '1', - ], - ], - ], - ], - ], - ], - 'MigrationType' => [ - 'description' => 'The synchronization type. Valid values:'."\n" - ."\n" - .'* FullAndRealtimeIncremental: full synchronization and real-time incremental synchronization of data in an entire database'."\n" - .'* RealtimeIncremental: real-time incremental synchronization of data in a single table'."\n" - .'* Full: full batch synchronization of data in an entire database'."\n" - .'* OfflineIncremental: batch incremental synchronization of data in an entire database'."\n" - .'* FullAndOfflineIncremental: full synchronization and batch incremental synchronization of data in an entire database'."\n", - 'type' => 'string', - 'example' => 'FullAndRealtimeIncremental', - ], - 'JobType' => [ - 'description' => '任务类型'."\n" - ."\n" - .'- DatabaseRealtimeMigration(整库实时):将源端多个库的多个表进行流同步，支持仅全量，仅增量，或全量+增量。'."\n" - ."\n" - .'- DatabaseOfflineMigration(整库离线):将源端多个库的多个表进行批同步，支持仅全量，仅增量，或全量+增量。'."\n" - ."\n" - .'- SingleTableRealtimeMigration(单表实时):将源端单个表进行流同步。', - 'type' => 'string', - 'example' => 'DatabaseRealtimeMigration', - ], - 'ProjectId' => [ - '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" - .'This parameter indicates the DataWorks workspace to which the API operation is applied.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '98330', - ], - 'ResourceSettings' => [ - 'description' => 'The resource settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'OfflineResourceSettings' => [ - 'description' => 'The resource used for batch synchronization.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestedCu' => [ - 'description' => 'The number of compute units (CUs) in the resource group for scheduling that are used for batch synchronization.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '2.0', - ], - 'ResourceGroupIdentifier' => [ - 'description' => 'The identifier of the resource group for Data Integration used for batch synchronization.'."\n", - 'type' => 'string', - 'example' => 'S_res_group_7708_1667792816832', - ], - ], - ], - 'RealtimeResourceSettings' => [ - 'description' => 'The resource used for real-time synchronization.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestedCu' => [ - 'description' => 'The number of CUs in the resource group for Data Integration that are used for real-time synchronization.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '2.0', - ], - 'ResourceGroupIdentifier' => [ - 'description' => 'The identifier of the resource group for Data Integration used for real-time synchronization.'."\n", - 'type' => 'string', - 'example' => 'S_res_group_235454102432001_1579085295030', + 'Cu' => ['description' => 'CU consumption for task running.', 'type' => 'number', 'format' => 'float', 'example' => '0.25', 'title' => ''], + 'Id' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'example' => 'Serverless_resource_group_xxxxx', 'title' => ''], + 'Image' => ['description' => 'The ID of the image configured for task running.', 'type' => 'string', 'example' => 'i-xxxxx', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - ], - 'ScheduleResourceSettings' => [ - 'description' => 'The resource used for scheduling.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestedCu' => [ - 'description' => 'The number of CUs in the resource group for Data Integration that are used for scheduling.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '2.0', - ], - 'ResourceGroupIdentifier' => [ - 'description' => 'The identifier of the resource group for scheduling used by the synchronization task.'."\n", - 'type' => 'string', - 'example' => 'S_res_group_235454102432001_1718359176885', - ], - ], - ], - ], - ], - 'SourceDataSourceSettings' => [ - 'description' => 'The settings of the source. Only a single source is supported.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The settings of the source. Only a single source is supported.'."\n", - 'type' => 'object', - 'properties' => [ - 'DataSourceName' => [ - 'description' => 'The name of the data source.'."\n", - 'type' => 'string', - 'example' => 'dw_mysql', - ], - 'DataSourceProperties' => [ - 'description' => 'The properties of the data source.'."\n", + 'Trigger' => [ + 'description' => 'Trigger settings for the data quality monitor.', 'type' => 'object', 'properties' => [ - 'Encoding' => [ - 'description' => 'The encoding format of the database.'."\n", - 'type' => 'string', - 'example' => 'UTF-8'."\n", - ], - 'Timezone' => [ - 'description' => 'The time zone.'."\n", + 'Type' => [ + 'description' => 'The trigger mode of the data quality monitor. Valid values:'."\n" + ."\n" + .'- ByManual: Manually triggered. Default setting.'."\n" + ."\n" + .'- BySchedule: Triggered by a scheduled task instance.', + 'enumValueTitles' => [], 'type' => 'string', - 'example' => 'GMT+8'."\n", + 'example' => 'BySchedule', + 'title' => '', ], - ], - ], - ], - ], - ], - 'SourceDataSourceType' => [ - 'description' => 'The source type. Valid values: PolarDB, MySQL, Kafka, LogHub, Hologres, Oracle, OceanBase, MongoDB, RedShift, Hive, SQLServer, Doris, ClickHouse.'."\n", - 'type' => 'string', - 'example' => 'Mysql', - ], - '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" - ."\n" - .'> \\[ { "SourceObjectSelectionRules":\\[ { "ObjectType":"Database", "Action":"Include", "ExpressionType":"Exact", "Expression":"biz_db" }, { "ObjectType":"Schema", "Action":"Include", "ExpressionType":"Exact", "Expression":"s1" }, { "ObjectType":"Table", "Action":"Include", "ExpressionType":"Exact", "Expression":"table1" } ], "TransformationRuleNames":\\[ { "RuleName":"my_database_rename_rule", "RuleActionType":"Rename", "RuleTargetType":"Schema" } ] } ]'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Each rule defines a table that needs to be synchronized.'."\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' => [ - 'Action' => [ - 'description' => 'The operation that is performed to select objects. Valid values: Include and Exclude.'."\n", - 'type' => 'string', - 'example' => 'Include', - ], - 'Expression' => [ - 'description' => 'The expression.'."\n", - 'type' => 'string', - 'example' => 'mysql_table_1', - ], - 'ExpressionType' => [ - 'description' => 'The expression type. Valid values: Exact and Regex.'."\n", - 'type' => 'string', - 'example' => 'Exact', - ], - 'ObjectType' => [ - 'description' => 'The object type. Valid values:'."\n" - ."\n" - .'* Table'."\n" - .'* Schema'."\n" - .'* Database'."\n", - 'type' => 'string', - 'example' => 'Table', - ], + 'TaskIds' => [ + 'description' => 'If the trigger mode is BySchedule, the ID of the scheduling task that triggers the monitor must be configured.', + 'type' => 'array', + 'items' => ['description' => 'The scheduling task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1023777390', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], - '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", + 'Hooks' => [ + 'description' => 'The hook configuration after the data quality monitor stops.', 'type' => 'array', 'items' => [ - 'description' => 'The transformation rule that is applied to the synchronization objects selected from the source.'."\n", + 'description' => 'The hook configuration after the data quality monitor stops.', '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', - 'example' => 'rename_rule_1', - ], - 'RuleActionType' => [ - 'description' => 'The action type. Valid values:'."\n" - ."\n" - .'* DefinePrimaryKey'."\n" - .'* Rename'."\n" - .'* AddColumn'."\n" - .'* HandleDml'."\n", - 'type' => 'string', - 'example' => 'AddColumn', - ], - 'RuleTargetType' => [ - 'description' => 'The type of the object on which the action is performed. Valid values:'."\n" + 'Condition' => ['description' => 'The hook trigger condition. When this condition is met, the hook is triggered. Valid expression format:'."\n" + ."\n" + .'Specifies multiple combinations of rule severity levels and rule validation statuses, such as `results.any { r -> r.status == \'Fail\' && r.rule.severity == \'Normal\' || r.status == \'Error\' && r.rule.severity == \'High\' || r.status == \'Warn\' && r.rule.severity == \'High\' }`. This means the hook is triggered if any executed rule has Fail with Normal severity, Error with High severity, or Warn with High severity. The severity values must match those defined in the Spec. The status values must match those in DataQualityResult.', 'type' => 'string', 'example' => 'results.any { r -> r.status == \'Fail\' && r.rule.severity == \'Normal\' || r.status == \'Error\' && r.rule.severity == \'High\' || r.status == \'Warn\' && r.rule.severity == \'High\' }', 'title' => ''], + 'Type' => [ + 'description' => 'The type of the hook. Valid values:'."\n" ."\n" - .'* Table'."\n" - .'* Schema'."\n" - .'* Database'."\n", + .'- BlockTaskInstance: Blocks the scheduling of the task instance.', + 'enumValueTitles' => [], 'type' => 'string', - 'example' => 'Table', + 'example' => 'BlockTaskInstance', + 'title' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'Id' => ['description' => 'The ID of the data quality monitor.', 'type' => 'integer', 'format' => 'int64', 'example' => '26433', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - ], - 'TransformationRules' => [ - 'description' => 'The list of transformation rules that are applied to the synchronization objects selected from the source.'."\n" - ."\n" - .'> \\[ { "RuleName":"my_database_rename_rule", "RuleActionType":"Rename", "RuleTargetType":"Schema", "RuleExpression":"{"expression":"${srcDatasoureName}\\_${srcDatabaseName}"}" } ]'."\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" - .'* DefinePartitionKey'."\n", - 'type' => 'string', - 'example' => 'Rename', - ], - 'RuleExpression' => [ - 'description' => 'The expression of the rule. The expression is a JSON string.'."\n" - ."\n" - .'1. Example of a renaming rule'."\n" - ."\n" - .'* Example: {"expression":"${srcDatasourceName}\\_${srcDatabaseName}\\_0922" }'."\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" - ."\n" - .'2. Example of a column addition rule'."\n" - ."\n" - .'* Example: {"columns":\\[{"columnName":"my_add_column","columnValueType":"Constant","columnValue":"123"}]}'."\n" - .'* If no rule of this type is configured, 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 value type of the field. Valid values: Constant and Variable.'."\n" - .'* columnValue: the value of the field. If the columnValueType parameter is set to Constant, the value of the columnValue parameter is a constant of the STRING data type. If the columnValueType parameter is set to 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" - .'3. Example of a rule used to specify primary key fields for a destination table'."\n" - ."\n" - .'* Example: {"columns":\\["ukcolumn1","ukcolumn2"]}'."\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" - .'* 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" - .'4. Example of a rule used to process DML messages'."\n" - ."\n" - .'* Example: {"dmlPolicies":\\[{"dmlType":"Delete","dmlAction":"Filter","filterCondition":"id > 1"}]}'."\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" - .'* 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" - ."\n" - .'5. Example of a rule used to perform incremental synchronization'."\n" - ."\n" - .'* Example: {"where":"id > 0"}'."\n" - .'* The rule used to perform incremental synchronization is returned.'."\n" - ."\n" - .'6. Example of a rule used to configure scheduling parameters for an auto triggered task'."\n" - ."\n" - .'* Example: {"cronExpress":" \\* \\* \\* \\* \\* \\*", "cycleType":"1"}'."\n" - .'* The rule used to configure scheduling parameters for an auto triggered task is returned.'."\n" - ."\n" - .'7. Example of a rule used to specify a partition key'."\n" - ."\n" - .'* Example: {"columns":\\["id"]}'."\n" - .'* The rule used to specify a partition key is returned.'."\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" - .'* Database'."\n", - 'type' => 'string', - 'example' => 'Table', - ], - ], - ], - ], - 'JobStatus' => [ - 'description' => 'The status of the job.', - 'type' => 'string', - 'example' => 'Running', - ], - 'DIJobId' => [ - 'description' => 'This parameter is deprecated. Use the Id parameter instead.'."\n", - 'type' => 'string', - 'deprecated' => true, - 'example' => '32601', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490\\",\\n \\"PagingInfo\\": {\\n \\"Id\\": 32601,\\n \\"Description\\": \\"description\\",\\n \\"DestinationDataSourceSettings\\": [\\n {\\n \\"DataSourceName\\": \\"dw_mysql\\"\\n }\\n ],\\n \\"DestinationDataSourceType\\": \\"Hologres\\",\\n \\"JobName\\": \\"imp_ods_dms_det_dealer_info_df\\",\\n \\"JobSettings\\": {\\n \\"ChannelSettings\\": \\"{\\\\\\"structInfo\\\\\\":\\\\\\"MANAGED\\\\\\",\\\\\\"storageType\\\\\\":\\\\\\"TEXTFILE\\\\\\",\\\\\\"writeMode\\\\\\":\\\\\\"APPEND\\\\\\",\\\\\\"partitionColumns\\\\\\":[{\\\\\\"columnName\\\\\\":\\\\\\"pt\\\\\\",\\\\\\"columnType\\\\\\":\\\\\\"STRING\\\\\\",\\\\\\"comment\\\\\\":\\\\\\"\\\\\\"}],\\\\\\"fieldDelimiter\\\\\\":\\\\\\"\\\\\\"}\\",\\n \\"ColumnDataTypeSettings\\": [\\n {\\n \\"DestinationDataType\\": \\"text\\",\\n \\"SourceDataType\\": \\"bigint\\"\\n }\\n ],\\n \\"CycleScheduleSettings\\": {\\n \\"CycleMigrationType\\": \\"Full\\",\\n \\"ScheduleParameters\\": \\"bizdate=$bizdate\\\\n\\"\\n },\\n \\"DdlHandlingSettings\\": [\\n {\\n \\"Action\\": \\"Ignore\\",\\n \\"Type\\": \\"CreateTable\\"\\n }\\n ],\\n \\"RuntimeSettings\\": [\\n {\\n \\"Name\\": \\"runtime.offline.concurrent\\\\n\\",\\n \\"Value\\": \\"1\\"\\n }\\n ]\\n },\\n \\"MigrationType\\": \\"FullAndRealtimeIncremental\\",\\n \\"JobType\\": \\"DatabaseRealtimeMigration\\",\\n \\"ProjectId\\": 98330,\\n \\"ResourceSettings\\": {\\n \\"OfflineResourceSettings\\": {\\n \\"RequestedCu\\": 2,\\n \\"ResourceGroupIdentifier\\": \\"di_resourcegroup_v1\\"\\n },\\n \\"RealtimeResourceSettings\\": {\\n \\"RequestedCu\\": 2,\\n \\"ResourceGroupIdentifier\\": \\"di_resourcegroup_v1\\"\\n },\\n \\"ScheduleResourceSettings\\": {\\n \\"RequestedCu\\": 2,\\n \\"ResourceGroupIdentifier\\": \\"schedual_resourcegroup_v1\\"\\n }\\n },\\n \\"SourceDataSourceSettings\\": [\\n {\\n \\"DataSourceName\\": \\"dw_mysql\\",\\n \\"DataSourceProperties\\": {\\n \\"Encoding\\": \\"UTF-8\\\\n\\",\\n \\"Timezone\\": \\"GMT+8\\\\n\\"\\n }\\n }\\n ],\\n \\"SourceDataSourceType\\": \\"Mysql\\",\\n \\"TableMappings\\": [\\n {\\n \\"SourceObjectSelectionRules\\": [\\n {\\n \\"Action\\": \\"Include\\",\\n \\"Expression\\": \\"mysql_table_1\\",\\n \\"ExpressionType\\": \\"Exact\\",\\n \\"ObjectType\\": \\"Table\\"\\n }\\n ],\\n \\"TransformationRules\\": [\\n {\\n \\"RuleName\\": \\"rename_rule_1\\",\\n \\"RuleActionType\\": \\"AddColumn\\",\\n \\"RuleTargetType\\": \\"Table\\"\\n }\\n ]\\n }\\n ],\\n \\"TransformationRules\\": [\\n {\\n \\"RuleActionType\\": \\"Rename\\",\\n \\"RuleExpression\\": \\"{\\\\\\"expression\\\\\\":\\\\\\"${srcDatasoureName}_${srcDatabaseName}\\\\\\"}\\",\\n \\"RuleName\\": \\"rename_rule_1\\",\\n \\"RuleTargetType\\": \\"Table\\"\\n }\\n ],\\n \\"JobStatus\\": \\"Running\\",\\n \\"DIJobId\\": \\"32601\\"\\n }\\n}","type":"json"}]', - 'title' => 'GetDIJob', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", - ], - 'GetDIJobLog' => [ - 'summary' => 'Obtains logs generated for a synchronization task.', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListDataQualityScans', + 'description' => 'DataWorks Basic Edition or a higher edition is required.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:ListDataQualityScans', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115***159376359\\",\\n \\"PageInfo\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"DataQualityScans\\": [\\n {\\n \\"ModifyTime\\": 17236236472,\\n \\"Owner\\": \\"23782382795249\\",\\n \\"Description\\": \\"This is a hourly run data quality evaluation plan.\\",\\n \\"ModifyUser\\": \\"23782382795249\\",\\n \\"Parameters\\": [\\n {\\n \\"Value\\": \\"$[yyyy-mm-dd-1]\\",\\n \\"Name\\": \\"dt\\"\\n }\\n ],\\n \\"CreateTime\\": 1694512304000,\\n \\"ProjectId\\": 59094,\\n \\"CreateUser\\": \\"7892346529452\\",\\n \\"ComputeResource\\": {\\n \\"Runtime\\": {\\n \\"HiveConf\\": \\"mapreduce.job.queuename=dq_queue\\",\\n \\"SparkConf\\": \\"spark.yarn.queue=dq_queue\\",\\n \\"Engine\\": \\"Hive\\"\\n },\\n \\"EnvType\\": \\"Prod\\",\\n \\"Name\\": \\"emr_cluster_001\\"\\n },\\n \\"Name\\": \\"Hourly partition quality monitoring\\",\\n \\"RuntimeResource\\": {\\n \\"Cu\\": 0.25,\\n \\"Id\\": \\"Serverless_resource_group_xxxxx\\",\\n \\"Image\\": \\"i-xxxxx\\"\\n },\\n \\"Trigger\\": {\\n \\"Type\\": \\"BySchedule\\",\\n \\"TaskIds\\": [\\n 1023777390\\n ]\\n },\\n \\"Hooks\\": [\\n {\\n \\"Condition\\": \\"results.any { r -> r.status == \'Fail\' && r.rule.severity == \'Normal\' || r.status == \'Error\' && r.rule.severity == \'High\' || r.status == \'Warn\' && r.rule.severity == \'High\' }\\",\\n \\"Type\\": \\"BlockTaskInstance\\"\\n }\\n ],\\n \\"Id\\": 26433\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListDataQualityTemplates' => [ + 'summary' => 'Queries the list of data quality rule templates in a project.', + 'path' => '', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -28013,355 +30708,209 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '235251', - 'abilityTreeNodes' => [ - 'FEATUREdideBP0OJZ', - ], - 'autoTest' => false, + 'abilityTreeNodes' => ['FEATUREdide3WJOKE'], ], 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the synchronization task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10000', - ], - ], - [ - 'name' => 'InstanceId', + 'name' => 'Catalog', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '6153616438', - ], + 'schema' => ['description' => 'The directory path to which the data quality template belongs.', 'type' => 'string', 'required' => false, 'example' => '/timeliness/ods_layer', 'title' => ''], ], [ - 'name' => 'FailoverId', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => 'The failover ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000', 'title' => ''], ], [ - 'name' => 'DIJobId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter is deprecated. Use the Id parameter instead.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'deprecated' => true, - 'required' => false, - 'example' => '10000', - ], + 'schema' => ['description' => 'Fuzzy match for the template rule name.', 'type' => 'string', 'required' => false, 'example' => 'table_rows', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => 'The page number of the pagination query. The value is a positive integer greater than or equal to 1.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The number of records per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'NodeType', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the node. This parameter is applicable only to the tasks that are run on serverless resource groups. Valid values:'."\n" - ."\n" - .'* **MASTER**: the master node, which is used to query the logs of JobManagers.'."\n" - .'* **WORKER**: the worker node, which is used to query the logs of TaskManagers.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'MASTER', - ], + 'schema' => ['description' => 'The page number of the results. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The logs that are returned.'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Log' => [ - 'title' => '资源一级ID', - 'description' => 'The log.'."\n", - 'type' => 'string', - 'example' => '>>>>>>>> stdout:n++++++++++++++++++executing sql: create database if not exists jindo_test location \'oss://pangbei-hdfs/tmp/hive\' n++n', - ], - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '1AFAE64E-D1BE-432B-A9****', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The API request ID, which is generated as a UUID.', 'type' => 'string', 'example' => '0bc14115***159376359'], + 'PageInfo' => [ + 'description' => 'Paged query results of data quality rule templates.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'PageSize' => ['description' => 'The number of pages.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'DataQualityTemplates' => [ + 'description' => 'The list of rule templates.', + 'type' => 'array', + 'items' => [ + 'description' => 'The rule template.', + 'type' => 'object', + 'properties' => [ + 'ModifyTime' => ['description' => 'The time when the data quality rule template was updated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1729816478147', 'title' => ''], + 'Owner' => ['description' => 'The owner of the data quality rule template.', 'type' => 'string', 'example' => '205250754596036836', 'title' => ''], + 'ModifyUser' => ['description' => 'The last updater of the data quality rule template.', 'type' => 'string', 'example' => '205250754596036836', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the data quality rule template was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1729816478147', 'title' => ''], + 'ProjectId' => ['description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '7635', 'title' => ''], + 'CreateUser' => ['description' => 'The creator of the data quality rule template.', 'type' => 'string', 'example' => '7892346529452', 'title' => ''], + 'Id' => ['description' => 'The ID of the data quality rule template.', 'type' => 'string', 'example' => '819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a', 'title' => ''], + 'Spec' => ['description' => 'Specific configurations of the data quality rule template. For more information, see [Data quality Spec configuration description](~2963394~).', 'type' => 'string', 'example' => '{'."\n" + .' "assertion": "anomaly detection fro id_not_null_cnt",'."\n" + .' "id_not_null_cnt": {'."\n" + .' "query": "SELECT COUNT(*) AS cnt FROM ${tableName} WHERE dt = \'$[yyyymmdd-1]\';"'."\n" + .' },'."\n" + .' "identity": "819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a"'."\n" + .'}', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Log\\": \\">>>>>>>> stdout:n++++++++++++++++++executing sql: create database if not exists jindo_test location \'oss://pangbei-hdfs/tmp/hive\' n++n\\",\\n \\"RequestId\\": \\"1AFAE64E-D1BE-432B-A9****\\"\\n}","type":"json"}]', - 'title' => 'GetDIJobLog', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", - ], - 'ListDIJobs' => [ - 'summary' => 'Queries a list of new-version synchronization tasks in Data Integration. A new-version synchronization task can be a real-time synchronization task used to synchronize full or incremental data in a database, a batch synchronization task used to synchronize full or incremental data in a database, or a real-time synchronization task used to synchronize incremental data in a single table.', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListDataQualityTemplates', + 'description' => 'DataWorks Basic Edition or a higher edition is required.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:ListDataQualityTemplates', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115***159376359\\",\\n \\"PageInfo\\": {\\n \\"TotalCount\\": 10,\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"DataQualityTemplates\\": [\\n {\\n \\"ModifyTime\\": 1729816478147,\\n \\"Owner\\": \\"205250754596036836\\",\\n \\"ModifyUser\\": \\"205250754596036836\\",\\n \\"CreateTime\\": 1729816478147,\\n \\"ProjectId\\": 7635,\\n \\"CreateUser\\": \\"7892346529452\\",\\n \\"Id\\": \\"819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a\\",\\n \\"Spec\\": \\"{\\\\n \\\\\\"assertion\\\\\\": \\\\\\"anomaly detection fro id_not_null_cnt\\\\\\",\\\\n \\\\\\"id_not_null_cnt\\\\\\": {\\\\n \\\\\\"query\\\\\\": \\\\\\"SELECT COUNT(*) AS cnt FROM ${tableName} WHERE dt = \'$[yyyymmdd-1]\';\\\\\\"\\\\n },\\\\n \\\\\\"identity\\\\\\": \\\\\\"819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a\\\\\\"\\\\n}\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListDataSourceSharedRules' => [ + 'summary' => 'Retrieves a list of sharing rules for a data source.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '234100', - 'abilityTreeNodes' => [ - 'FEATUREdideBP0OJZ', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '235551', + 'abilityTreeNodes' => ['FEATUREdideRWC5F7'], ], 'parameters' => [ [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int64', - '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' => 'int64', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the export task.'."\n" - ."\n" - .'The name of each export task must be unique. You must make sure that the names of the export tasks in the current workspace are unique.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_export_01', - ], - ], - [ - 'name' => 'SourceDataSourceType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The source type. Valid values: PolarDB, MySQL, Kafka, Loghub, Hologres, Oracle, OceanBase, MongoDB, RedShift, Hive, SqlServer, Doris, and ClickHouse. If you do not configure this parameter, the API operation queries synchronization tasks that use all types of sources.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'MySQL', - ], - ], - [ - 'name' => 'DestinationDataSourceType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The destination type. Valid values: Hologres, OSS-HDFS, OSS, MaxCompute, Loghub, STARROCKS, Datahub, ANALYTICDB_FOR_MYSQL, Kafka, and Hive. If you do not configure this parameter, the API operation queries synchronization tasks that use all type of destinations.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Hologres', - ], - ], - [ - 'name' => 'MigrationType', - 'in' => 'query', - '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, - 'example' => 'FullAndRealtimeIncremental', - ], - ], - [ - 'name' => 'ProjectId', + 'name' => 'DataSourceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1967', - ], + 'schema' => ['description' => 'The data source ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '135123'], ], [ - 'name' => 'SpecType', + 'name' => 'TargetProjectId', 'in' => 'query', - 'schema' => [ - 'title' => '任务配置规范类型。可选FILESPEC、CLASSIC、ALL。FILESPEC：基于结构化 filespec 的新版任务；CLASSIC：传统配置模式的任务；', - 'description' => 'The task configuration specification type. Valid values: FILESPEC, CLASSIC, ALL. FILESPEC: New-style task based on structured filespec; CLASSIC: Task using traditional configuration mode.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'FILESPEC', - ], + 'schema' => ['description' => 'The ID of the workspace to which the data source is shared. You cannot share the data source to the workspace with which the data source is associated.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'title' => '', 'example' => '106565'], ], ], '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' => '7263E4AC-9D2E-5B29-B8AF-7C5012E92A41', - ], - 'PagingInfo' => [ - 'description' => 'The pagination information.'."\n", - 'type' => 'object', - 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'DIJobs' => [ - 'description' => 'The synchronization tasks returned.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The synchronization task.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the synchronization task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '32599', - ], - 'ProjectId' => [ - 'description' => 'The ID of the DataWorks workspace to which the synchronization task belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '26442', - ], - 'JobName' => [ - 'description' => 'The name of the synchronization task.'."\n", - 'type' => 'string', - 'example' => 'mysql_to_holo_sync_35197', - ], - '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', - 'example' => 'FullAndRealtimeIncremental', - ], - 'SourceDataSourceType' => [ - 'description' => 'The source type. Valid values: PolarDB, MySQL, Kafka, Loghub, Hologres, Oracle, OceanBase, MongoDB, RedShift, Hive, SqlServer, Doris, and ClickHouse. If you do not configure this parameter, the API operation returns synchronization tasks that use all types of sources.'."\n", - 'type' => 'string', - 'example' => 'Mysql', - ], - 'DestinationDataSourceType' => [ - 'description' => 'The destination type. Valid values: Hologres, OSS-HDFS, OSS, MaxCompute, Loghub, STARROCKS, DataHub, ANALYTICDB_FOR_MYSQL, Kafka, and Hive.'."\n", - 'type' => 'string', - 'example' => 'Hologres', - ], - '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', - 'example' => 'Running', - ], - 'DIJobId' => [ - 'description' => 'This parameter is deprecated. Use the Id parameter instead.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'deprecated' => true, - 'example' => '32599', - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0000-ABCD-EFG****'], + 'DataSourceSharedRules' => [ + 'description' => 'The sharing rules of the data source.', + 'type' => 'array', + 'items' => [ + 'description' => 'The sharing rule of the data source.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '101412', 'title' => ''], + 'DataSourceId' => ['description' => 'The data source ID. You can call the [ListDataSources](~~211431~~) operation to query the ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '265133', 'title' => ''], + 'SharedDataSourceName' => ['description' => 'The name of the data source in the destination workspace.', 'type' => 'string', 'example' => 'targetProject.datasource', 'title' => ''], + 'SourceProjectId' => ['description' => 'The ID of the workspace with which the data source is associated.', 'type' => 'integer', 'format' => 'int64', 'example' => '106560', 'title' => ''], + 'TargetProjectId' => ['description' => 'The ID of the workspace to which the data source is shared.', 'type' => 'integer', 'format' => 'int64', 'example' => '106561', 'title' => ''], + 'SharedUser' => ['description' => 'The user in the workspace to which the data source is shared. If the data source is shared to the entire workspace, this parameter is left empty.', 'type' => 'string', 'example' => '1107550004253538', 'title' => ''], + 'EnvType' => ['description' => 'The environment to which the target data source belongs. The values are as follows:'."\n" + ."\n" + .'- Dev: the development environment.'."\n" + ."\n" + .'- Prod: the production environment.', 'type' => 'string', 'example' => 'Dev', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the rule was created. This value is a UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1724379762000', 'title' => ''], + 'CreateUser' => ['description' => 'The ID of the user who creates the rule.', 'type' => 'string', 'example' => '1107550****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7263E4AC-9D2E-5B29-B8AF-7C5012E92A41\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 12,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"DIJobs\\": [\\n {\\n \\"Id\\": 32599,\\n \\"ProjectId\\": 26442,\\n \\"JobName\\": \\"mysql_to_holo_sync_35197\\",\\n \\"MigrationType\\": \\"FullAndRealtimeIncremental\\",\\n \\"SourceDataSourceType\\": \\"Mysql\\",\\n \\"DestinationDataSourceType\\": \\"Hologres\\",\\n \\"JobStatus\\": \\"Running\\",\\n \\"DIJobId\\": 32599\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListDIJobs', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", - ], - 'ListDIJobRunDetails' => [ - 'summary' => 'Queries the running information about a synchronization task.', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"DataSourceSharedRules\\": [\\n {\\n \\"Id\\": 101412,\\n \\"DataSourceId\\": 265133,\\n \\"SharedDataSourceName\\": \\"targetProject.datasource\\",\\n \\"SourceProjectId\\": 106560,\\n \\"TargetProjectId\\": 106561,\\n \\"SharedUser\\": \\"1107550004253538\\",\\n \\"EnvType\\": \\"Dev\\",\\n \\"CreateTime\\": 1724379762000,\\n \\"CreateUser\\": \\"1107550****\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListDataSourceSharedRules', + 'description' => '1. This operation is available for all DataWorks editions.'."\n" + ."\n" + .'2. To query the sharing rules of a data source associated with a workspace, you must have the data source sharing permissions in that workspace. You must have one of the following roles in DataWorks:'."\n" + ."\n" + .'- Tenant Owner, Tenant Administrator, Workspace Administrator, and Workspace Owner', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:ListDataSourceSharedRules', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListDataSources' => [ + 'summary' => 'Retrieves a list of data sources that match the specified filter conditions.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -28371,248 +30920,199 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '235254', - 'abilityTreeNodes' => [ - 'FEATUREdideBP0OJZ', - ], + 'abilityTreeCode' => '232439', + 'abilityTreeNodes' => ['FEATUREdideRWC5F7'], ], 'parameters' => [ [ - 'name' => 'DIJobId', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the synchronization task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '11265', - ], + '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.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '17820', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1234', - ], + 'schema' => ['description' => 'The name of the data source. Fuzzy match by data source name is supported.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'Types', 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The data source types. This parameter specifies a filter condition. You can specify multiple data source types.', + 'type' => 'array', + 'items' => ['description' => 'The data source type.', 'type' => 'string', 'required' => false, 'example' => 'mysql', 'title' => ''], 'required' => false, - 'example' => '1', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'PageSize', + 'name' => 'EnvType', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The environment in which the data sources are used. Valid values:'."\n" + ."\n" + .'- Dev: development environment'."\n" + ."\n" + .'- Prod: production environment', 'type' => 'string', 'required' => false, 'example' => 'Prod', 'title' => ''], ], [ - 'name' => 'SourceDataSourceName', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the source.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ds_name', - ], + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'SourceDatabaseName', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database in the source.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'db_name', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'SourceSchemaName', + 'name' => 'SortBy', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the schema of the source.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'schema_name', - ], + 'schema' => ['description' => 'The field that you want to use to sort the data sources. Valid values:'."\n" + ."\n" + .'- CreateTime'."\n" + ."\n" + .'- Id'."\n" + ."\n" + .'- Name'."\n" + ."\n" + .'Default value: CreateTime', 'type' => 'string', 'required' => false, 'example' => 'CreateTime', 'title' => ''], ], [ - 'name' => 'SourceTableName', + 'name' => 'Order', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the table in the source.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'table_name', - ], + 'schema' => ['description' => 'The order in which you want to sort the data sources. Valid values:'."\n" + ."\n" + .'- Desc: descending order'."\n" + ."\n" + .'- Asc: ascending order'."\n" + ."\n" + .'Default value: Desc', 'type' => 'string', 'required' => false, 'example' => 'Desc', 'title' => ''], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'schema' => ['description' => 'The tag of the data source. This parameter specifies a filter condition.'."\n" + ."\n" + .'- You can specify multiple tags, which are in the logical AND relation. For example, you can query the data sources that contain the following tags: `["tag1", "tag2", "tag3"]`.'."\n" + ."\n" + .'- If you do not configure this parameter, tag-based filtering is not performed. You can specify up to 10 tags.', 'type' => 'string', 'required' => false, 'example' => '["tag1", "tag2", "tag3"] ', '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. You can use the ID to query logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '691CA452-D37A-4ED0-9441', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '7BE1433F-6D55-5D86-9344-CA6F7DD19B13'], 'PagingInfo' => [ - 'description' => 'The pagination information.'."\n", + 'description' => 'The pagination information.', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'string', - 'example' => '131', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'JobRunInfos' => [ - 'description' => 'The running information about the synchronization task.'."\n", + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '131', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'DataSources' => [ + 'description' => 'The data source groups. Each element in the array indicates a data source group. Each data source group contains data sources in the development environment (if any) and the production environment.', 'type' => 'array', 'items' => [ - 'description' => 'The running information about the synchronization task for a single table.'."\n", + 'description' => 'The information about the data source group, including data sources in the development environment (if any) and the production environment. Data sources in the development environment and the production environment have the same data source name and data source type, but different data source IDs.', 'type' => 'object', 'properties' => [ - 'SourceDatasourceName' => [ - 'description' => 'The name of the source.'."\n", - 'type' => 'string', - 'example' => 'ds_name', - ], - 'SourceDatabaseName' => [ - 'description' => 'The name of the database in the source.'."\n", - 'type' => 'string', - 'example' => 'db_name', - ], - 'SourceSchemaName' => [ - 'description' => 'The name of the schema of the source.'."\n", - 'type' => 'string', - 'example' => 'schema_name', - ], - 'SourceTableName' => [ - 'description' => 'The name of the table in the source.'."\n", - 'type' => 'string', - 'example' => 'table_name', - ], - 'DestinationDatasourceName' => [ - 'description' => 'The name of the destination.'."\n", - 'type' => 'string', - 'example' => 'dst_name', - ], - 'DestinationDatabaseName' => [ - 'description' => 'The name of the database in the destination.'."\n", - 'type' => 'string', - 'example' => 'dst_db', - ], - 'DestinationSchemaName' => [ - 'description' => 'The name of the schema of the destination.'."\n", - 'type' => 'string', - 'example' => 'dst_schema', - ], - 'DestinationTableName' => [ - 'description' => 'The name of the table in the destination.'."\n", - 'type' => 'string', - 'example' => 'dst_name', - ], - 'StructureMigrationStatus' => [ - 'description' => 'The synchronization status of the schema.'."\n", - 'type' => 'string', - 'example' => 'Finished', - ], - 'StructureMigrationErrorMessage' => [ - 'description' => 'The error message that is returned if an error occurs during schema synchronization. If no error occurs, no value is returned for this parameter.'."\n", - 'type' => 'string', - 'example' => 'create table t1 fail.', - ], - 'FullMigrationStatus' => [ - 'description' => 'The status of full batch synchronization.'."\n", - 'type' => 'string', - 'example' => 'Finished', - ], - 'FullMigrationErrorMessage' => [ - 'description' => 'The error message that is returned if an error occurs during full batch synchronization. If no error occurs, no value is returned for this parameter.'."\n", - 'type' => 'string', - 'example' => 'sync table t1 fail.', - ], - 'OfflineErrorRecords' => [ - 'description' => 'The total number of errors that occur during full synchronization.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'OfflineTotalBytes' => [ - 'description' => 'The total number of bytes that are synchronized during full synchronization.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'OfflineTotalRecords' => [ - 'description' => 'The total number of data records that are synchronized during full synchronization.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'RealtimeMigrationStatus' => [ - 'description' => 'The status of real-time synchronization.'."\n", - 'type' => 'string', - 'example' => 'Running', - ], - 'RealtimeMigrationErrorMessage' => [ - 'description' => 'The error message that is returned if an error occurs during real-time synchronization. If no error occurs, no value is returned for this parameter.'."\n", - 'type' => 'string', - 'example' => 'sync table t1 fail.'."\n", + 'Name' => ['description' => 'The name of the data source.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'Type' => ['description' => 'The type of the data source.', 'type' => 'string', 'example' => 'mysql', 'title' => ''], + 'DataSource' => [ + 'description' => 'The data sources. Each element is the information of a single data source with a unique data source ID.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the data source.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the data source.', 'type' => 'integer', 'format' => 'int64', 'example' => '16035', 'title' => ''], + 'ConnectionProperties' => ['description' => 'The connection configurations of the data source, including the connection address, access identity, and environment information. The envType parameter specifies the environment in which the data source is used. Valid values of the envType parameter:'."\n" + ."\n" + .'- Dev: development environment'."\n" + ."\n" + .'- Prod: production environment'."\n" + ."\n" + .'The parameters that you need to configure for the data source vary based on the mode in which the data source is added. For more information, see [Data source connection information (ConnectionProperties)](~~2852465~~).', 'type' => 'any', 'example' => '{'."\n" + .' "envType": "Prod",'."\n" + .' "regionId": "cn-beijing",'."\n" + .' "instanceId": "hgprecn-cn-x0r3oun4k001",'."\n" + .' "database": "testdb",'."\n" + .' "securityProtocol": "authTypeNone",'."\n" + .' "authType": "Executor",'."\n" + .' "authIdentity": "1107550004253538"'."\n" + .'}', 'title' => ''], + 'ConnectionPropertiesMode' => ['description' => 'The mode in which the data source is added. The mode varies based on the data source type. Valid values:'."\n" + ."\n" + .'- InstanceMode: instance mode'."\n" + ."\n" + .'- UrlMode: connection string mode', 'type' => 'string', 'example' => 'UrlMode', 'title' => ''], + 'Description' => ['description' => 'The description of the data source.', 'type' => 'string', 'example' => 'test ', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the data source was added. This value is a UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1648711113000', 'title' => ''], + 'CreateUser' => ['description' => 'The ID of the user who adds the data source.', 'type' => 'string', 'example' => '1624387842781448', 'title' => ''], + 'ModifyTime' => ['description' => 'The time when the data source was last modified. This value is a UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1648711113000', 'title' => ''], + 'ModifyUser' => ['description' => 'The ID of the user who modifies the data source.', 'type' => 'string', 'example' => '1624387842781448', 'title' => ''], + 'QualifiedName' => ['description' => 'The unique business key of the data source. For example, the unique business key of a Hologres data source is in the `${tenantOwnerId}:${regionId}:${type}:${instanceId}:${database}` format.', 'type' => 'string', 'example' => '1648711121000:cn-beijing:odps:yongxunQA_beijing_standard', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-4ED0-9441\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": \\"131\\",\\n \\"PageSize\\": \\"10\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"JobRunInfos\\": [\\n {\\n \\"SourceDatasourceName\\": \\"ds_name\\",\\n \\"SourceDatabaseName\\": \\"db_name\\",\\n \\"SourceSchemaName\\": \\"schema_name\\",\\n \\"SourceTableName\\": \\"table_name\\",\\n \\"DestinationDatasourceName\\": \\"dst_name\\",\\n \\"DestinationDatabaseName\\": \\"dst_db\\",\\n \\"DestinationSchemaName\\": \\"dst_schema\\",\\n \\"DestinationTableName\\": \\"dst_name\\",\\n \\"StructureMigrationStatus\\": \\"Finished\\",\\n \\"StructureMigrationErrorMessage\\": \\"create table t1 fail.\\",\\n \\"FullMigrationStatus\\": \\"Finished\\",\\n \\"FullMigrationErrorMessage\\": \\"sync table t1 fail.\\",\\n \\"OfflineErrorRecords\\": 0,\\n \\"OfflineTotalBytes\\": 100,\\n \\"OfflineTotalRecords\\": 10,\\n \\"RealtimeMigrationStatus\\": \\"Running\\",\\n \\"RealtimeMigrationErrorMessage\\": \\"sync table t1 fail.\\\\n\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListDIJobRunDetails', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", - ], - 'ListDIJobMetrics' => [ - 'summary' => 'Queries metrics for a synchronization task.', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7BE1433F-6D55-5D86-9344-CA6F7DD19B13\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 131,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"DataSources\\": [\\n {\\n \\"Name\\": \\"test\\",\\n \\"Type\\": \\"mysql\\",\\n \\"DataSource\\": [\\n {\\n \\"Id\\": 16035,\\n \\"ConnectionProperties\\": \\"{\\\\n\\\\t\\\\\\"envType\\\\\\": \\\\\\"Prod\\\\\\",\\\\n\\\\t\\\\\\"regionId\\\\\\": \\\\\\"cn-beijing\\\\\\",\\\\n \\\\\\"instanceId\\\\\\": \\\\\\"hgprecn-cn-x0r3oun4k001\\\\\\",\\\\n \\\\\\"database\\\\\\": \\\\\\"testdb\\\\\\",\\\\n \\\\\\"securityProtocol\\\\\\": \\\\\\"authTypeNone\\\\\\",\\\\n \\\\\\"authType\\\\\\": \\\\\\"Executor\\\\\\",\\\\n \\\\\\"authIdentity\\\\\\": \\\\\\"1107550004253538\\\\\\"\\\\n}\\",\\n \\"ConnectionPropertiesMode\\": \\"UrlMode\\",\\n \\"Description\\": \\"test \\",\\n \\"CreateTime\\": 1648711113000,\\n \\"CreateUser\\": \\"1624387842781448\\",\\n \\"ModifyTime\\": 1648711113000,\\n \\"ModifyUser\\": \\"1624387842781448\\",\\n \\"QualifiedName\\": \\"1648711121000:cn-beijing:odps:yongxunQA_beijing_standard\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListDataSources', + 'description' => '1. This operation is available for all DataWorks editions.'."\n" + ."\n" + .'2. To call this operation, you must have one of the following roles in DataWorks:'."\n" + ."\n" + .'- Tenant Owner, Workspace Administrator, Deploy, Develop, Visitor, Workspace Owner, O\\&M, Model Designer, Security Administrator, Data Analyst, OpenPlatform Administrator, and Data Governance Administrator', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:ListDataSources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListDatabases' => [ + 'summary' => 'Queries a list of databases in an instance, cluster, or data catalog in Data Map. For DLF or StarRocks data sources, you can call this API operation to query databases in a data catalog. For StarRocks data sources, you can call this API operation to query databases in internal catalogs. For other types of data sources, you can call this API operation to query databases in an instance or cluster.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -28621,149 +31121,161 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '235252', - 'abilityTreeNodes' => [ - 'FEATUREdideBP0OJZ', - ], - 'autoTest' => false, + 'abilityTreeCode' => '267985', + 'abilityTreeNodes' => ['FEATUREdideE9XYA6'], ], 'parameters' => [ [ - 'name' => 'DIJobId', + 'name' => 'ParentMetaEntityId', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The parent entity ID. For more information, see [Concepts related to metadata entities](~~2880092~~).'."\n" + ."\n" + .'You can refer to the ListCrawlerTypes operation for the parent entity type.'."\n" + ."\n" + .'- If the parent entity is a catalog, the format of `ParentMetaEntityId` follows the response of the ListCatalogs API.'."\n" + ."\n" + .'- If the parent entity is a metadata crawler, the format of `ParentMetaEntityId` is `${CrawlerType}:${Instance ID or encoded URL}`.'."\n" + ."\n" + .'ParentMetaEntityId format examples'."\n" + ."\n" + .'- `dlf-catalog::catalog_id`'."\n" + ."\n" + .'- `holo:instance_id`'."\n" + ."\n" + .'- `mysql:(instance_id|encoded_jdbc_url)`'."\n" + ."\n" + .'>'."\n" + ."\n" + .'- `catalog_id`: The ID of the DLF catalog.'."\n" + ."\n" + .'- `instance_id`: The instance ID. Required when the data source is registered in instance mode.'."\n" + ."\n" + .'- `encoded_jdbc_url`: The URL-encoded JDBC connection string. Required when the data source is registered by connection string.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'holo:instance_id'], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name. Supports fuzzy match.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'test_tbl'], + ], + [ + 'name' => 'Comment', + 'in' => 'query', + 'schema' => ['description' => 'The comment. Supports fuzzy match.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'test comment'], + ], + [ + 'name' => 'SortBy', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the synchronization task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '11265', + 'description' => 'The sort field. Default value: CreateTime. Valid values:'."\n" + ."\n" + .'- CreateTime'."\n" + ."\n" + .'- ModifyTime'."\n" + ."\n" + .'- Name', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'CreateTime', + 'pattern' => '^[\\w.,;/@-]+$', + 'default' => 'CreateTime', + 'enum' => ['CreateTime', 'ModifyTime', 'Name'], 'title' => '', + 'required' => false, ], ], [ - 'name' => 'StartTime', + 'name' => 'Order', 'in' => 'query', 'schema' => [ - 'description' => 'The beginning of the time range to query.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1586509407', + 'description' => 'The sort order. Default value: Asc. Valid values:'."\n" + ."\n" + .'- Asc: ascending.'."\n" + ."\n" + .'- Desc: descending.', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'example' => 'Asc', + 'default' => 'Asc', + 'enum' => ['Asc', 'Desc'], + 'title' => '', ], ], [ - 'name' => 'EndTime', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1712205941', - ], + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '1', 'default' => '1', 'title' => '', 'required' => false, 'example' => '1'], ], [ - 'name' => 'MetricName', + 'name' => 'PageSize', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The metrics that you want to query.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The name of the metric. The following six metrics are supported:'."\n" - ."\n" - .'* resourceUtilization: specifies the resource usage of a resource group. This metric is supported only for serverless resource groups.'."\n" - .'* delayTime: specifies the latency on the synchronization task.'."\n" - .'* totalRecordsRead: specifies the number of data records that are read from the source.'."\n" - .'* speedRecordsRead: specifies the rate at which the synchronization task reads data from the source.'."\n" - .'* totalRecordsWrite: specifies the number of data records that are written to the destination.'."\n" - .'* speedRecordsWrite: specifies the rate at which the synchronization task writes data to the destination.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'delayTime', - ], - 'required' => true, - ], + 'schema' => ['description' => 'The number of records per page. Default: 10. Maximum: 100.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '691CA452-D37A-4ED0-9441', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '9DD08926-38B9-XXXXXXX'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'PagingInfo' => [ - 'description' => 'The pagination information.'."\n", + 'title' => '', + 'description' => 'The pagination result.', 'type' => 'object', 'properties' => [ - 'JobMetrics' => [ - 'description' => 'The metrics returned.'."\n", + 'TotalCount' => ['description' => 'The total number of records returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'Databases' => [ + 'description' => 'The database list.', 'type' => 'array', - 'items' => [ - 'description' => 'The information about a single metric.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the metric.'."\n", - 'type' => 'string', - 'example' => 'JobDelay', - ], - 'SeriesList' => [ - 'description' => 'The metric data.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The metric data.'."\n", - 'type' => 'object', - 'properties' => [ - 'Time' => [ - 'description' => 'The point in time at which data is sampled based on the metric.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1716881141', - ], - 'Value' => [ - 'description' => 'The sample value.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => '10', - ], - ], - ], - ], - ], - ], + 'items' => ['description' => 'The database information.', '$ref' => '#/components/schemas/Database', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-4ED0-9441\\",\\n \\"PagingInfo\\": {\\n \\"JobMetrics\\": [\\n {\\n \\"Name\\": \\"JobDelay\\",\\n \\"SeriesList\\": [\\n {\\n \\"Time\\": 1716881141,\\n \\"Value\\": 10\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListDIJobMetrics', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", - ], - 'ListDIJobEvents' => [ - 'summary' => 'Queries events for a synchronization task.', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9DD08926-38B9-XXXXXXX\\",\\n \\"Success\\": true,\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Databases\\": [\\n {\\n \\"Id\\": \\"holo-database:h-xxxx::test_db\\",\\n \\"Name\\": \\"test_db\\",\\n \\"Comment\\": \\"test comment\\",\\n \\"LocationUri\\": \\"oss://test-bucket/test_db\\",\\n \\"ParentMetaEntityId\\": \\"holo:h-xxxx\\",\\n \\"CreateTime\\": 1736852168000,\\n \\"ModifyTime\\": 1736852168000\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListDatabases', + 'description' => '1. DataWorks Basic Edition or a higher edition is required.'."\n" + ."\n" + .'2. For the StarRocks type, only the Internal catalog is supported.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:ListDatabases', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListDatasetVersions' => [ + 'summary' => 'Retrieves the version list for a given dataset.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -28772,1624 +31284,1501 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '235253', - 'abilityTreeNodes' => [ - 'FEATUREdideBP0OJZ', - ], + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdideXGTG91'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'DIJobId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the synchronization task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '11588', - 'title' => '', - ], + 'name' => 'DatasetId', + 'in' => 'formData', + 'schema' => ['description' => 'The dataset ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'dataworks-dataset:3pXXXb8o0ngr07njhps1'], ], [ - 'name' => 'EventType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of event that you want to query. Valid values: Failover, Alarm, and DDL.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Alarm', - ], + 'name' => 'CreatorId', + 'in' => 'formData', + 'schema' => ['description' => 'The creator ID.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '12103XXX46492139'], ], [ - 'name' => 'StartTime', - 'in' => 'query', + 'name' => 'SortBy', + 'in' => 'formData', 'schema' => [ - 'description' => 'The beginning of the time range to query.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1716971005', + 'description' => 'The sort field. Default: VersionNumber.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- ModifyTime: Modification time.'."\n" + ."\n" + .'- CreateTime: Creation time.'."\n" + ."\n" + .'- VersionNumber: Version number.', + 'enumValueTitles' => ['ModifyTime' => '', 'CreateTime' => '', 'VersionNumber' => ''], + 'type' => 'string', + 'default' => 'VersionNumber', + 'enum' => ['CreateTime', 'ModifyTime', 'VersionNumber'], + 'title' => '', + 'required' => false, + 'example' => 'CreateTime', ], ], [ - 'name' => 'EndTime', - 'in' => 'query', + 'name' => 'Order', + 'in' => 'formData', 'schema' => [ - 'description' => 'The end of the time range to query.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1717971005', + 'description' => 'The sort order. Default: Desc.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- Asc: Ascending.'."\n" + ."\n" + .'- Desc: Descending.', + 'enumValueTitles' => ['Asc' => '', 'Desc' => ''], + 'type' => 'string', + 'default' => 'Desc', + 'enum' => ['Asc', 'Desc'], + 'title' => '', + 'required' => false, + 'example' => 'Desc', ], ], [ 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The page number. Default: 1.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '1', 'example' => '1', 'default' => '1', 'title' => '', 'required' => false], ], [ 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The number of entries per page. Default: 10. Maximum: 100.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'Schema of Response', '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' => '645F6D68-9C29-5961-80B1-BDD4B794C22D', - ], + 'RequestId' => ['title' => 'RequestId', 'description' => 'RequestId', 'type' => 'string', 'example' => 'E25887B7-579C-54A5-9C4F-83A0DE367XXX'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'PagingInfo' => [ - 'description' => 'The pagination information.'."\n", + 'title' => '', + 'description' => 'The pagination information.', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2524', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'DIJobEvent' => [ - 'description' => 'The events returned. The value of this parameter is an array.'."\n", + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], + 'DatasetVersions' => [ + 'title' => '', + 'description' => 'The dataset version list.', 'type' => 'array', - 'items' => [ - 'description' => 'The details about a single event.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The event ID.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'CreateTime' => [ - 'description' => 'The time when the event was created.'."\n", - 'type' => 'string', - 'example' => '1663573162', - ], - 'FailoverMessage' => [ - 'description' => 'The error logs for failovers.'."\n", - 'type' => 'string', - 'example' => '2024-05-29 15:11:31,377 [main] INFO com.*.**.di.core.metrics.:21 [] {****} '."\n" - .'2024-05-29 15:11:31,384 [main] INFO *.aliyun.*.di.*.*.metrics.*:27 [] - Open MarioDiReporter '."\n" - .'2024-05-29 15:11:33,248 [flink-akka.*.*-dispatcher-17] INFO ', - ], - 'Severity' => [ - 'description' => 'The severity level of the alert. Valid values: Warning and Critical.'."\n", - 'type' => 'string', - 'example' => 'Warning', - ], - 'Channels' => [ - 'description' => 'The alert notification method. Valid values: Phone, Mail, Sms, Ding, and Webhook.'."\n", - 'type' => 'string', - 'example' => 'Phone', - ], - 'Status' => [ - 'description' => 'The sending status of an alert notification. Valid values: Success, Fail, and Silence.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Detail' => [ - 'description' => 'The alert details.'."\n", - 'type' => 'string', - 'example' => 'aggregator:avg [**] for 5 minutes, service maybe abnormal'."\n", - ], - 'Type' => [ - 'description' => 'The type of the alert event.'."\n" - ."\n" - .'* Heartbeat'."\n" - .'* Delay'."\n" - .'* FailoverCount'."\n" - .'* DdlReport'."\n" - .'* ResourceUtilization'."\n", - 'type' => 'string', - 'example' => 'Delay', - ], - 'Action' => [ - 'description' => 'The processing result of the DDL event. Valid values: Critical, Ignore, Normal, and Warning.'."\n", - 'type' => 'string', - 'example' => 'Ignore', - ], - 'SrcTable' => [ - 'description' => 'The name of the source table.'."\n", - 'type' => 'string', - 'example' => 'table1', - ], - 'DstTable' => [ - 'description' => 'The name of the destination table.'."\n", - 'type' => 'string', - 'example' => 'table2', - ], - 'SrcSql' => [ - 'description' => 'The DDL statement of the source table.'."\n", - 'type' => 'string', - 'example' => 'alter table table1 ***', - ], - 'DstSql' => [ - 'description' => 'The DDL statement of the destination table.'."\n", - 'type' => 'string', - 'example' => 'alter table table2 ***', - ], - ], - ], + 'items' => ['description' => 'The dataset version.', '$ref' => '#/components/schemas/DatasetVersion', 'title' => '', 'example' => ''], + 'example' => '', ], ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"645F6D68-9C29-5961-80B1-BDD4****\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 2524,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"DIJobEvent\\": [\\n {\\n \\"Id\\": \\"1\\",\\n \\"CreateTime\\": \\"1663573162\\",\\n \\"FailoverMessage\\": \\"2024-05-29 15:11:31,377 [main] INFO com.*.**.di.core.metrics.:21 [] {****} \\\\n2024-05-29 15:11:31,384 [main] INFO *.aliyun.*.di.*.*.metrics.*:27 [] - Open MarioDiReporter \\\\n2024-05-29 15:11:33,248 [flink-akka.*.*-dispatcher-17] INFO \\",\\n \\"Severity\\": \\"Warning\\",\\n \\"Channels\\": \\"Phone\\",\\n \\"Status\\": \\"Success\\",\\n \\"Detail\\": \\"数据集成同步任务异常: Level: WARNING, DataWorks项目名:** [Region: cn-shanghai], 任务名:**, 报警规则:业务延迟, aggregator:avg [**] for 5 minutes, service maybe abnormal\\",\\n \\"Type\\": \\"Delay\\",\\n \\"Action\\": \\"Ignore\\",\\n \\"SrcTable\\": \\"table1\\",\\n \\"DstTable\\": \\"table2\\",\\n \\"SrcSql\\": \\"alter table table1 ***\\",\\n \\"DstSql\\": \\"alter table table2 ***\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListDIJobEvents', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", - ], - 'CreateDIAlarmRule' => [ - 'summary' => 'Creates an alert rule for a synchronization task.', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListDatasetVersions', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:ListDatasetVersions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E25887B7-579C-54A5-9C4F-83A0DE367XXX\\",\\n \\"Success\\": true,\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"DatasetVersions\\": [\\n {\\n \\"Id\\": \\"dataworks-datasetVersion:0gfxxxjx155usz3hrv:1\\",\\n \\"DatasetId\\": \\"dataworks-datasetVersion:0gfxxxjx155usz3hrv\\",\\n \\"Comment\\": \\"初始版本\\",\\n \\"CreatorId\\": \\"17815XXX61016173\\",\\n \\"VersionNumber\\": 1,\\n \\"StorageType\\": \\"OSS\\",\\n \\"Url\\": \\"oss://test-oss-bucket/test_dir/\\",\\n \\"MountPath\\": \\"/mnt/data\\",\\n \\"CreateTime\\": 1736756055000,\\n \\"ModifyTime\\": 1736756055000,\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"ImportInfo\\": {\\n \\"key\\": \\"None\\"\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListDatasets' => [ + 'summary' => 'Queries a list of datasets. Currently, DataWorks datasets and PAI datasets are supported.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '234126', - 'abilityTreeNodes' => [ - 'FEATUREdideBP0OJZ', - ], + 'abilityTreeNodes' => ['FEATUREdideXGTG91'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'title' => '描述。', - 'description' => 'The description of the alert rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'The description of the alert rule.'."\n" - ."\n", - ], - ], - [ - 'name' => 'MetricType', - 'in' => 'query', - 'schema' => [ - 'title' => '告警指标类型，可选的枚举值：'."\n" - .'- Heartbeat（任务状态报警）'."\n" - .'- FailoverCount（failover次数报警）'."\n" - .'- Delay（任务延迟报警）', - 'description' => 'The metric type in the alert rule. Valid values:'."\n" - ."\n" - .'* Heartbeat'."\n" - .'* FailoverCount'."\n" - .'* Delay'."\n" - .'* DdlReport'."\n" - .'* ResourceUtilization'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Heartbeat', - 'enum' => [], - ], + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The DataWorks workspace ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '251363'], ], [ - 'name' => 'Enabled', - 'in' => 'query', - 'schema' => [ - 'title' => '告警规则是否启用，默认不开启。', - 'description' => 'Specifies whether to enable the alert rule. By default, the alert rule is disabled.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'false', - ], + 'name' => 'Origin', + 'in' => 'formData', + 'schema' => ['description' => 'The dataset source. Valid values:'."\n" + ."\n" + .'- DataWorks'."\n" + ."\n" + .'- PAI', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'DataWorks'], ], [ - 'name' => 'DIJobId', - 'in' => 'query', - 'schema' => [ - 'title' => '任务ID，是告警规则关联的任务ID。', - 'description' => 'The ID of the synchronization task with which the alert rule is associated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['description' => 'The dataset name. Supports fuzzy search.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'test_dataset'], ], [ - 'name' => 'ClientToken', - 'in' => 'query', - 'allowEmptyValue' => false, + 'name' => 'DataTypeList', + 'in' => 'formData', + 'style' => 'simple', 'schema' => [ - 'title' => '幂等参数', - 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n", - 'type' => 'string', + 'title' => '', + 'description' => 'The data type. Multiple selections are allowed. Valid values:'."\n" + ."\n" + .'- COMMON'."\n" + ."\n" + .'- PIC'."\n" + ."\n" + .'- TEXT'."\n" + ."\n" + .'- TABLE'."\n" + ."\n" + .'- VIDEO'."\n" + ."\n" + .'- AUDIO'."\n" + ."\n" + .'- INDEX', + 'type' => 'array', + 'items' => [ + 'description' => 'Data types'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- TABLE: Table.'."\n" + ."\n" + .'- VIDEO: Video.'."\n" + ."\n" + .'- COMMON: Common.'."\n" + ."\n" + .'- TEXT: Text.'."\n" + ."\n" + .'- PIC: Image.'."\n" + ."\n" + .'- INDEX: Index.'."\n" + ."\n" + .'- AUDIO: Audio.', + 'enumValueTitles' => ['TABLE' => '', 'VIDEO' => '', 'COMMON' => '', 'TEXT' => '', 'PIC' => '', 'INDEX' => '', 'AUDIO' => ''], + 'type' => 'string', + 'required' => false, + 'example' => 'COMMON', + 'title' => '', + ], 'required' => false, - 'example' => 'ABFUOEUOTRTRJKE', - ], - ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the alert rule.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'alartRule', + 'maxItems' => 10, + 'minItems' => 0, + 'example' => '', ], ], [ - 'name' => 'TriggerConditions', - 'in' => 'query', - 'style' => 'json', + 'name' => 'StorageTypeList', + 'in' => 'formData', + 'style' => 'simple', 'schema' => [ - 'description' => 'The conditions that can trigger the alert rule.'."\n", + 'title' => '', + 'description' => 'The storage type. Multiple selections are allowed. Supported values:'."\n" + ."\n" + .'- OSS'."\n" + ."\n" + .'- NAS: General-purpose NAS file systems'."\n" + ."\n" + .'- EXTREMENAS: Extreme NAS file systems'."\n" + ."\n" + .'- DLF\\_LANCE: Data Lake Formation'."\n" + ."\n" + .'- CPFS: Cloud Parallel File Storage'."\n" + ."\n" + .'- BMCPFS: CPFS for Lingjun'."\n" + ."\n" + .'- MAXCOMPUTE: MaxCompute table', 'type' => 'array', - 'items' => [ - 'description' => 'The condition that can 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, - 'example' => 'Warning', - ], - 'Duration' => [ - 'description' => 'The time interval for alert calculation. Unit: minutes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], - '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' => '10', - ], - 'DdlTypes' => [ - 'description' => 'The types of DDL operations for which the alert rule takes effect.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The type of the DDL operation for which the alert rule takes effect. This parameter is required only if the MetricType parameter is set to DdlReport. Valid values:'."\n" - ."\n" - .'* AlterAddColumn'."\n" - .'* AlterDropColumn'."\n" - .'* AlterRenameColumn'."\n" - .'* AlterRenameTable'."\n" - .'* AlterTableModify'."\n" - .'* DropTable'."\n" - .'* TruncateTable'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'AlterAddColumn', - ], - 'required' => false, - ], - 'DdlReportTags' => [ - 'description' => 'This parameter is deprecated and replaced by the DdlTypes parameter.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'This parameter is deprecated and replaced by the DdlTypes parameter.'."\n", - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - 'example' => 'ALTERADDCOLUMN', - ], - 'deprecated' => true, - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => true, + 'items' => ['description' => 'The storage type.', 'type' => 'string', 'required' => false, 'example' => 'NAS', 'title' => ''], + 'required' => false, + 'enumValueTitles' => ['NAS' => '', 'MAXCOMPUTE' => '', 'CPFS' => '', 'BMCPFS' => '', 'EXTREMENAS' => '', 'OSS' => '', 'DLF_LANCE' => ''], + 'maxItems' => 10, + 'minItems' => 0, + 'example' => '', ], ], [ - 'name' => 'NotificationSettings', - 'in' => 'query', - 'style' => 'json', + 'name' => 'CreatorId', + 'in' => 'formData', + 'schema' => ['description' => 'The creator ID.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '12103XXX46492139'], + ], + [ + 'name' => 'SortBy', + 'in' => 'formData', '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, - 'example' => 'Warning', - ], - 'Channels' => [ - 'description' => 'The alert notification method. Valid values:'."\n" - ."\n" - .'* Mail'."\n" - .'* Phone'."\n" - .'* Sms'."\n" - .'* Ding'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The alert notification method. Valid values:'."\n" - ."\n" - .'* Mail'."\n" - .'* Phone'."\n" - .'* Sms'."\n" - .'* Ding'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Ding', - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'NotificationReceivers' => [ - 'description' => 'The settings of alert notification recipients.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The settings of alert notification recipients.'."\n", - 'type' => 'object', - 'properties' => [ - 'ReceiverType' => [ - 'description' => 'The recipient type. Valid values: AliyunUid, DingToken, FeishuToken, and WebHookUrl.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'DingToken', - ], - 'ReceiverValues' => [ - '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' => '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' => false, - ], - 'MuteInterval' => [ - 'description' => 'The duration of the alert suppression interval. Default value: 5. Unit: minutes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '5', - ], - 'InhibitionInterval' => [ - 'description' => 'This parameter is deprecated and replaced by the MuteInterval parameter.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'deprecated' => true, - 'required' => false, - 'example' => '5', - ], - ], - 'required' => true, + 'description' => 'The sort field. Default: CreateTime.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- ModifyTime: Modification time.'."\n" + ."\n" + .'- CreateTime: Creation time.'."\n" + ."\n" + .'- Name', + 'enumValueTitles' => ['ModifyTime' => '', 'CreateTime' => '', 'Name' => ''], + 'type' => 'string', + 'default' => 'CreateTime', + 'enum' => ['Name', 'CreateTime', 'ModifyTime'], + 'title' => '', + 'required' => false, + 'example' => 'CreateTime', + ], + ], + [ + 'name' => 'Order', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The sort order. Default: Desc.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- Asc: Ascending.'."\n" + ."\n" + .'- Desc: Descending.', + 'enumValueTitles' => ['Asc' => '', 'Desc' => ''], + 'type' => 'string', + 'default' => 'Desc', + 'enum' => ['Asc', 'Desc'], + 'title' => '', + 'required' => false, + 'example' => 'Asc', ], ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => ['description' => 'The page number. Default: 1.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '1', 'example' => '1', 'default' => '1', 'title' => '', 'required' => false], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['description' => 'The number of entries per page. Default: 10. Maximum: 100.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10', 'title' => '', 'required' => false], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the alert rule.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => 'C636A747-7E4E-594D-94CD-2B4F8A9A9A63', - ], - 'DIAlarmRuleId' => [ - 'title' => '资源一级ID', - 'description' => 'This parameter is deprecated and is replaced by the Id parameter.'."\n", - 'type' => 'string', - 'deprecated' => true, - 'example' => '1', + 'RequestId' => ['title' => 'RequestId', 'description' => 'RequestId', 'type' => 'string', 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX'."\n"], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'PagingInfo' => [ + 'title' => '', + 'description' => 'The pagination information.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '100'], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'PageSize' => ['description' => 'The number of entries on this page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], + 'Datasets' => [ + 'title' => '', + 'description' => 'The dataset list.', + 'type' => 'array', + 'items' => ['description' => 'The dataset object.', '$ref' => '#/components/schemas/Dataset', 'title' => '', 'example' => ''], + 'example' => '', + ], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Id\\": 1,\\n \\"RequestId\\": \\"C636A747-7E4E-594D-94CD-2B****\\",\\n \\"DIAlarmRuleId\\": \\"1\\"\\n}","type":"json"}]', - 'title' => 'CreateDIAlarmRule', - ], - 'UpdateDIAlarmRule' => [ - 'summary' => 'Updates an alert rule configured for a synchronization task.', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListDatasets', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:ListDatasets', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\\\n\\",\\n \\"Success\\": true,\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Datasets\\": [\\n {\\n \\"Id\\": \\"dataworks-dataset:1gxxxqjx155usz3hrv\\",\\n \\"Name\\": \\"test_dataset\\",\\n \\"Comment\\": \\"测试数据集\\",\\n \\"ProjectId\\": 123456,\\n \\"Origin\\": \\"DataWorks\\",\\n \\"DataType\\": \\"COMMON\\",\\n \\"StorageType\\": \\"OSS\\",\\n \\"CreatorId\\": \\"210484359\\",\\n \\"Readme\\": \\"## introduction\\",\\n \\"LatestVersion\\": {\\n \\"Id\\": \\"dataworks-datasetVersion:0gfxxxjx155usz3hrv:1\\",\\n \\"DatasetId\\": \\"dataworks-datasetVersion:0gfxxxjx155usz3hrv\\",\\n \\"Comment\\": \\"初始版本\\",\\n \\"CreatorId\\": \\"17815XXX61016173\\",\\n \\"VersionNumber\\": 1,\\n \\"StorageType\\": \\"OSS\\",\\n \\"Url\\": \\"oss://test-oss-bucket/test_dir/\\",\\n \\"MountPath\\": \\"/mnt/data\\",\\n \\"CreateTime\\": 1736756055000,\\n \\"ModifyTime\\": 1736756055000,\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"ImportInfo\\": {\\n \\"key\\": \\"None\\"\\n }\\n },\\n \\"CreateTime\\": 1736756055000,\\n \\"ModifyTime\\": 1736756055000,\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListDeploymentPackageFiles' => [ + 'summary' => 'Queries a list of versions of files to be deployed.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '234128', - 'abilityTreeNodes' => [ - 'FEATUREdideBP0OJZ', - ], + 'abilityTreeCode' => '270534', + 'abilityTreeNodes' => ['FEATUREdide4AR6E0'], ], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => 'The alert rule Id', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '34982', - ], + '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, 'example' => '12345', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'BusinessId', 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the alert rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'The description of the alert rule.'."\n" - ."\n", - ], + 'schema' => ['description' => 'The workflow ID. You can call the [ListBusiness](~~173945~~) operation to query the workflow ID by name.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100001', 'title' => ''], ], [ - 'name' => 'MetricType', + 'name' => 'SolutionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The metric type in the alert rule. Valid values:'."\n" - ."\n" - .'* Heartbeat'."\n" - .'* FailoverCount'."\n" - .'* Delay'."\n" - .'* DdlReport'."\n" - .'* ResourceUtilization'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Heartbeat', - ], + 'schema' => ['description' => 'The solution ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '8065', 'title' => ''], ], [ - 'name' => 'Enabled', + 'name' => 'CommitFrom', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the alert rule. By default, the alert rule is disabled.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The start date for committing. Specify the date in the yyyy-MM-dd format.', 'type' => 'string', 'required' => false, 'example' => '2025-01-01', 'title' => ''], ], [ - 'name' => 'DIJobId', + 'name' => 'CommitTo', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the synchronization task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'deprecated' => false, - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The end date (included) for committing. Specify the date in the yyyy-MM-dd format.', 'type' => 'string', 'required' => false, 'example' => '2025-01-31', 'title' => ''], ], [ - 'name' => 'TriggerConditions', + 'name' => 'CommitUserId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the user who commits the file.', 'type' => 'string', 'required' => false, 'example' => '2003****'."\n", 'title' => ''], + ], + [ + 'name' => 'FileType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the code for the file.'."\n" + ."\n" + .'The code for files varies based on the file type. For more information, see [DataWorks nodes](~~600169~~). You can call the [ListFileType](~~212428~~) operation to query the type of the code for the file.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'ChangeType', + 'in' => 'query', + 'schema' => ['description' => 'The change type. Valid values:'."\n" + ."\n" + .'- 0: addition'."\n" + ."\n" + .'- 1: update'."\n" + ."\n" + .'- 2: deletion', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'FileIds', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'The conditions that can trigger the alert rule.'."\n", + 'description' => 'The IDs of the files to be queried.', 'type' => 'array', - 'items' => [ - 'description' => 'The condition that can 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, - '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', - ], - 'DdlTypes' => [ - 'description' => 'The types of DDL operations for which the alert rule takes effect.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The type of the DDL operation for which the alert rule takes effect. This parameter is required only if the MetricType parameter is set to DdlReport. Valid values:'."\n" - ."\n" - .'* AlterAddColumn'."\n" - .'* AlterDropColumn'."\n" - .'* AlterRenameColumn'."\n" - .'* AlterRenameTable'."\n" - .'* AlterTableModify'."\n" - .'* DropTable'."\n" - .'* TruncateTable'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'AlterAddColumn', - ], - 'required' => false, - ], - 'DdlReportTags' => [ - 'description' => 'This parameter is deprecated and replaced by the DdlTypes parameter.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'This parameter is deprecated and replaced by the DdlTypes parameter.'."\n", - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - 'example' => 'ALTERADDCOLUMN', - ], - 'deprecated' => true, - 'required' => false, - ], - ], - 'required' => false, - ], + 'items' => ['description' => 'The ID of the file to be queried.', 'type' => 'string', 'required' => false, 'example' => '11223**', 'title' => ''], 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'NotificationSettings', + 'name' => 'FileName', 'in' => 'query', - '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, - 'example' => 'Warning', - ], - 'Channels' => [ - 'description' => 'The alert notification method. Valid values:'."\n" - ."\n" - .'* Mail'."\n" - .'* Phone'."\n" - .'* Sms'."\n" - .'* Ding'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The alert notification method. Valid values:'."\n" - ."\n" - .'* Mail'."\n" - .'* Phone'."\n" - .'* Sms'."\n" - .'* Ding'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Ding', - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'NotificationReceivers' => [ - 'description' => 'The settings of alert notification recipients.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The settings of alert notification recipients.'."\n", - 'type' => 'object', - 'properties' => [ - 'ReceiverType' => [ - 'description' => 'The recipient type. Valid values: AliyunUid, DingToken, FeishuToken, and WebHookUrl.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'DingToken', - ], - 'ReceiverValues' => [ - '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' => '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' => false, - ], - 'MuteInterval' => [ - 'description' => 'The duration of the alert suppression interval. Default value: 5. Unit: minutes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '5', - ], - 'InhibitionInterval' => [ - 'description' => 'This parameter is deprecated and replaced by the MuteInterval parameter.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'deprecated' => true, - 'required' => false, - 'example' => '5', - ], - ], - 'required' => false, - ], + 'schema' => ['description' => 'The name of the file.', 'type' => 'string', 'required' => false, 'example' => 'Filename', 'title' => ''], ], [ - 'name' => 'Name', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the alert rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'alarm_rule_name', - ], + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '2147483647', 'minimum' => '1', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'DIAlarmRuleId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter is deprecated. Use the Id parameter instead.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'deprecated' => true, - 'required' => false, - 'example' => '34982', - ], + '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' => '20', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '资源ID，如ECS实例的创建接口CreateInstance应返回InstanceId。', - 'description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => 'A6C6B486-E3A2-5D52-9E76-D9380485D946', - ], - '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.', 'type' => 'string', 'example' => '0000-ABCD-EFG****', 'title' => ''], + 'PagingInfo' => [ + 'description' => 'The pagination details.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'PageNumber' => ['description' => 'The page number. Pages start from page 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'DeploymentPackageFiles' => [ + 'description' => 'The list of files pending deployment.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the version of the file to be deployed.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The unique ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '650433503', 'title' => ''], + 'FileId' => ['description' => 'The file ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '520246913', 'title' => ''], + 'FileVersion' => ['description' => 'The file version.', 'type' => 'integer', 'format' => 'int64', 'example' => '34', 'title' => ''], + 'CommitTime' => ['description' => 'The time for committing.', 'type' => 'string', 'example' => '2025-04-10 15:55:47', 'title' => ''], + 'CommitUser' => ['description' => 'The ID of the Alibaba Cloud account used by the user who committed the file.', 'type' => 'string', 'example' => '446***', 'title' => ''], + 'CommitUserName' => ['description' => 'The name of the Alibaba Cloud account used by the user who committed the file.', 'type' => 'string', 'example' => 'user***', 'title' => ''], + 'ProjectId' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '27595', 'title' => ''], + 'TenantId' => ['description' => 'The DataWorks tenant ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '639415964191360', 'title' => ''], + 'FileType' => ['description' => 'The file type. The code for files varies based on the file type. For more information, see [DataWorks nodes](~~600169~~).', 'type' => 'integer', 'format' => 'int32', 'example' => '13', 'title' => ''], + 'FileName' => ['description' => 'The name of the file of the current version.', 'type' => 'string', 'example' => 'bak_part_basc_person_relation_all_da', 'title' => ''], + 'Status' => ['description' => 'The status of the code file of the current version. Valid values:'."\n" + ."\n" + .'- 2: Commit check in progress.'."\n" + ."\n" + .'- 3: Commit check passed.'."\n" + ."\n" + .'- 4: Commit check failed.'."\n" + ."\n" + .'- 10: Committing.'."\n" + ."\n" + .'- 11: Committed.'."\n" + ."\n" + .'- 20: Approved.'."\n" + ."\n" + .'- 21: Rejected.'."\n" + ."\n" + .'- 22: Warning detected during checking.'."\n" + ."\n" + .'- 23: Under code review.'."\n" + ."\n" + .'- 24: Code review rejected.'."\n" + ."\n" + .'- 80: Deployment package created.'."\n" + ."\n" + .'- 100: Deploying.'."\n" + ."\n" + .'- 101: Deployed to the production environment.'."\n" + ."\n" + .'- 200: Cancelled.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'ChangeType' => ['description' => 'The change type, which is an integer. Valid values:'."\n" + ."\n" + .'- 0: addition'."\n" + ."\n" + .'- 1: update'."\n" + ."\n" + .'- 2: deletion', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'IsSameAsProductionVersion' => ['description' => 'Indicates whether the version is a version in the production environment of the scheduling system.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'NodeId' => ['description' => 'The ID of the auto triggered node that corresponds to the file.', 'type' => 'integer', 'format' => 'int64', 'example' => '700005008419', 'title' => ''], + 'Comment' => ['description' => 'The comment for committing.', 'type' => 'string', 'example' => 'Test submission', 'title' => ''], + 'NodeConfiguration' => ['description' => 'The scheduling property configurations of the node that corresponds to the file, which is a JSON string.', 'type' => 'string', 'example' => '{'."\n" + .' "tagList": [],'."\n" + .' "fileId": -1,'."\n" + .' "taskRerunTime": 0,'."\n" + .' "taskRerunInterval": 0,'."\n" + .' "reRunAble": 1,'."\n" + .' "nodeId": 125803000,'."\n" + .' "nodeName": "new",'."\n" + .' "nodeType": 0,'."\n" + .' "isStop": 0,'."\n" + .' "paraValue": "",'."\n" + .' "startEffectDate": "1970-01-01 00:00:00",'."\n" + .' "endEffectDate": "9999-01-01 00:00:00",'."\n" + .' "cronExpress": "00 26 00 * * ?",'."\n" + .' "owner": "1107550004250000",'."\n" + .' "resgroupId": 6300000,'."\n" + .' "cu": "0.25",'."\n" + .' "appId": 170000,'."\n" + .' "tenantId": 524257424560000,'."\n" + .' "createTime": "2025-04-10 15:55:01",'."\n" + .' "createUser": "1107550004250000",'."\n" + .' "lastModifyTime": "2025-04-10 15:55:41",'."\n" + .' "cycleType": 0,'."\n" + .' "dependentType": 0,'."\n" + .' "dependentTypeList": [0],'."\n" + .' "lastModifyUser": "1107550004250000",'."\n" + .' "dependentDataNode": "",'."\n" + .' "input": "[{\\"regionId\\":\\"cn-hangzhou\\",\\"str\\":\\"root_input\\",\\"parseType\\":1}]",'."\n" + .' "output": "[{\\"str\\":\\"project_root.526586287_out\\",\\"parseType\\":2},{\\"str\\":\\"project_root.new\\",\\"parseType\\":1}]",'."\n" + .' "inputList": [{'."\n" + .' "regionId": "cn-hangzhou",'."\n" + .' "str": "root_input",'."\n" + .' "parseType": 1'."\n" + .' }],'."\n" + .' "outputList": [{'."\n" + .' "str": "project_root.526586287_out",'."\n" + .' "parseType": 2'."\n" + .' }, {'."\n" + .' "str": "project_root.new",'."\n" + .' "parseType": 1'."\n" + .' }],'."\n" + .' "isAutoParse": 1,'."\n" + .' "startRightNow": false,'."\n" + .' "extConfig": "{\\"openCustomCron\\":false,\\"formCron\\":\\"\\"}",'."\n" + .' "inputContextList": [],'."\n" + .' "outputContextList": []'."\n" + .'}', 'title' => ''], + 'UseType' => ['description' => 'The module to which the file belongs. Valid values:'."\n" + ."\n" + .'- NORMAL: The file is used for DataStudio.'."\n" + ."\n" + .'- MANUAL: The file is used for a manually triggered node.'."\n" + ."\n" + .'- MANUAL\\_BIZ: The file is used for a manually triggered workflow.'."\n" + ."\n" + .'- SKIP: The file is used for a dry-run node in DataStudio.'."\n" + ."\n" + .'- ADHOCQUERY: The file is used for an ad hoc query.'."\n" + ."\n" + .'- COMPONENT: The file is used for a script template.', 'type' => 'string', 'example' => 'NORMAL', 'title' => ''], + 'SmokeTestStatus' => ['description' => 'The test status in the development environment.', 'type' => 'string', 'example' => 'Not tested', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A6C6B486-E3A2-5D52-9E76-D9380485D946\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'UpdateDIAlarmRule', - ], - 'DeleteDIAlarmRule' => [ - 'summary' => 'Deletes an alert rule configured for a synchronization task.', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"DeploymentPackageFiles\\": [\\n {\\n \\"Id\\": 650433503,\\n \\"FileId\\": 520246913,\\n \\"FileVersion\\": 34,\\n \\"CommitTime\\": \\"2025-04-10 15:55:47\\",\\n \\"CommitUser\\": \\"446***\\",\\n \\"CommitUserName\\": \\"user***\\",\\n \\"ProjectId\\": 27595,\\n \\"TenantId\\": 639415964191360,\\n \\"FileType\\": 13,\\n \\"FileName\\": \\"bak_part_basc_person_relation_all_da\\",\\n \\"Status\\": 100,\\n \\"ChangeType\\": 0,\\n \\"IsSameAsProductionVersion\\": true,\\n \\"NodeId\\": 700005008419,\\n \\"Comment\\": \\"Test submission\\",\\n \\"NodeConfiguration\\": \\"{\\\\n\\\\t\\\\\\"tagList\\\\\\": [],\\\\n\\\\t\\\\\\"fileId\\\\\\": -1,\\\\n\\\\t\\\\\\"taskRerunTime\\\\\\": 0,\\\\n\\\\t\\\\\\"taskRerunInterval\\\\\\": 0,\\\\n\\\\t\\\\\\"reRunAble\\\\\\": 1,\\\\n\\\\t\\\\\\"nodeId\\\\\\": 125803000,\\\\n\\\\t\\\\\\"nodeName\\\\\\": \\\\\\"new\\\\\\",\\\\n\\\\t\\\\\\"nodeType\\\\\\": 0,\\\\n\\\\t\\\\\\"isStop\\\\\\": 0,\\\\n\\\\t\\\\\\"paraValue\\\\\\": \\\\\\"\\\\\\",\\\\n\\\\t\\\\\\"startEffectDate\\\\\\": \\\\\\"1970-01-01 00:00:00\\\\\\",\\\\n\\\\t\\\\\\"endEffectDate\\\\\\": \\\\\\"9999-01-01 00:00:00\\\\\\",\\\\n\\\\t\\\\\\"cronExpress\\\\\\": \\\\\\"00 26 00 * * ?\\\\\\",\\\\n\\\\t\\\\\\"owner\\\\\\": \\\\\\"1107550004250000\\\\\\",\\\\n\\\\t\\\\\\"resgroupId\\\\\\": 6300000,\\\\n\\\\t\\\\\\"cu\\\\\\": \\\\\\"0.25\\\\\\",\\\\n\\\\t\\\\\\"appId\\\\\\": 170000,\\\\n\\\\t\\\\\\"tenantId\\\\\\": 524257424560000,\\\\n\\\\t\\\\\\"createTime\\\\\\": \\\\\\"2025-04-10 15:55:01\\\\\\",\\\\n\\\\t\\\\\\"createUser\\\\\\": \\\\\\"1107550004250000\\\\\\",\\\\n\\\\t\\\\\\"lastModifyTime\\\\\\": \\\\\\"2025-04-10 15:55:41\\\\\\",\\\\n\\\\t\\\\\\"cycleType\\\\\\": 0,\\\\n\\\\t\\\\\\"dependentType\\\\\\": 0,\\\\n\\\\t\\\\\\"dependentTypeList\\\\\\": [0],\\\\n\\\\t\\\\\\"lastModifyUser\\\\\\": \\\\\\"1107550004250000\\\\\\",\\\\n\\\\t\\\\\\"dependentDataNode\\\\\\": \\\\\\"\\\\\\",\\\\n\\\\t\\\\\\"input\\\\\\": \\\\\\"[{\\\\\\\\\\\\\\"regionId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"cn-hangzhou\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"str\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"root_input\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"parseType\\\\\\\\\\\\\\":1}]\\\\\\",\\\\n\\\\t\\\\\\"output\\\\\\": \\\\\\"[{\\\\\\\\\\\\\\"str\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"project_root.526586287_out\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"parseType\\\\\\\\\\\\\\":2},{\\\\\\\\\\\\\\"str\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"project_root.new\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"parseType\\\\\\\\\\\\\\":1}]\\\\\\",\\\\n\\\\t\\\\\\"inputList\\\\\\": [{\\\\n\\\\t\\\\t\\\\\\"regionId\\\\\\": \\\\\\"cn-hangzhou\\\\\\",\\\\n\\\\t\\\\t\\\\\\"str\\\\\\": \\\\\\"root_input\\\\\\",\\\\n\\\\t\\\\t\\\\\\"parseType\\\\\\": 1\\\\n\\\\t}],\\\\n\\\\t\\\\\\"outputList\\\\\\": [{\\\\n\\\\t\\\\t\\\\\\"str\\\\\\": \\\\\\"project_root.526586287_out\\\\\\",\\\\n\\\\t\\\\t\\\\\\"parseType\\\\\\": 2\\\\n\\\\t}, {\\\\n\\\\t\\\\t\\\\\\"str\\\\\\": \\\\\\"project_root.new\\\\\\",\\\\n\\\\t\\\\t\\\\\\"parseType\\\\\\": 1\\\\n\\\\t}],\\\\n\\\\t\\\\\\"isAutoParse\\\\\\": 1,\\\\n\\\\t\\\\\\"startRightNow\\\\\\": false,\\\\n\\\\t\\\\\\"extConfig\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"openCustomCron\\\\\\\\\\\\\\":false,\\\\\\\\\\\\\\"formCron\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\"}\\\\\\",\\\\n\\\\t\\\\\\"inputContextList\\\\\\": [],\\\\n\\\\t\\\\\\"outputContextList\\\\\\": []\\\\n}\\",\\n \\"UseType\\": \\"NORMAL\\",\\n \\"SmokeTestStatus\\": \\"Not tested\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListDeploymentPackageFiles', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'manual', + ], + 'ListDeploymentPackages' => [ + 'summary' => 'Queries a list of deployment packages.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '234127', - 'abilityTreeNodes' => [ - 'FEATUREdideBP0OJZ', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '269317', + 'abilityTreeNodes' => ['FEATUREdide8FM783'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the synchronization task.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '2', - ], + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => ['description' => 'The unique identifier of the DataWorks workspace, which is the identifier at the top of the Data Studio page where you switch workspaces. Either this parameter or ProjectId must be specified to determine which DataWorks workspace this API call operates on.', 'type' => 'string', 'required' => false, 'example' => 'dw_project', 'title' => ''], ], [ - 'name' => 'DIJobId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the synchronization task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'deprecated' => false, - 'required' => false, - 'example' => '1', - ], + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The DataWorks workspace ID. You can log on to the DataWorks console and go to the workspace configuration 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.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10003', 'title' => ''], ], [ - 'name' => 'DIAlarmRuleId', - 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter is deprecated. Use the Id parameter instead.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'deprecated' => true, - 'required' => false, - 'example' => '2', - ], + 'name' => 'Creator', + 'in' => 'formData', + 'schema' => ['description' => 'The Alibaba Cloud account ID of the deployment package creator.', 'type' => 'string', 'required' => false, 'example' => '110755000425****', 'title' => ''], + ], + [ + 'name' => 'EndCreateTime', + 'in' => 'formData', + 'schema' => ['description' => 'The maximum millisecond timestamp for when the deployment package was created.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1593877765000', 'title' => ''], + ], + [ + 'name' => 'Executor', + 'in' => 'formData', + 'schema' => ['description' => 'The Alibaba Cloud account ID of the deployment package executor.', 'type' => 'string', 'required' => false, 'example' => '2003****', 'title' => ''], + ], + [ + 'name' => 'EndExecuteTime', + 'in' => 'formData', + 'schema' => ['description' => 'The maximum millisecond timestamp for when the deployment package started executing.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1593877765000', 'title' => ''], + ], + [ + 'name' => 'Status', + 'in' => 'formData', + 'schema' => ['description' => 'The status of the deployment package. Valid values:'."\n" + ."\n" + .'- 0: It is ready.'."\n" + ."\n" + .'- 1: It was successfully deployed.'."\n" + ."\n" + .'- 2: It failed to be deployed.'."\n" + ."\n" + .'- 6: It was rejected.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Keyword', + 'in' => 'formData', + 'schema' => ['description' => 'The keyword in the deployment package name. DataWorks supports fuzzy matching, meaning you can enter a keyword to query for deployment packages that contain it.', 'type' => 'string', 'required' => false, 'example' => 'abc', 'title' => ''], + ], + [ + '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 records per page. Default value: 10. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '资源一级ID', - 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => 'C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490', - ], - '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.', 'type' => 'string', 'example' => '952795279527ab****'], + 'Data' => [ + 'description' => 'The list of deployment packages that meet the query conditions.', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of records that meet the conditions.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'Deployments' => [ + 'description' => 'The returned list of deployment packages.', + 'type' => 'array', + 'items' => [ + 'description' => 'The detailed information of the deployment package.', + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status of the deployment package. Valid values:'."\n" + ."\n" + .'- 0: It is ready.'."\n" + ."\n" + .'- 1: It was successfully deployed.'."\n" + ."\n" + .'- 2: It failed to be deployed.'."\n" + ."\n" + .'- 6: It was rejected.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ErrorMessage' => ['description' => 'When the deployment package fails to execute, this parameter is used to record the error message.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'CreateTime' => ['description' => 'The timestamp when the deployment package was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1593877765000', 'title' => ''], + 'Executor' => ['description' => 'The Alibaba Cloud account ID of the deployment package executor.', 'type' => 'string', 'example' => '2003****', 'title' => ''], + 'Creator' => ['description' => 'The Alibaba Cloud account ID of the deployment package creator.', 'type' => 'string', 'example' => '2003****', 'title' => ''], + 'ExecuteTime' => ['description' => 'The timestamp when the deployment package was executed.', 'type' => 'integer', 'format' => 'int64', 'example' => '1593877765000', 'title' => ''], + 'Name' => ['description' => 'The name of the deployment package.', 'type' => 'string', 'example' => 'auto_created', 'title' => ''], + 'Id' => ['description' => 'The ID of the deployment package. You can use this ID to call the [GetDeployment](~~173950~~) operation to get the deployment package details.', 'type' => 'integer', 'format' => 'int64', 'example' => '11111', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C99E2BE6-9DEA-5C2E-8F51-1DDCFE****\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'DeleteDIAlarmRule', - ], - 'ListDIAlarmRules' => [ - 'summary' => 'Views alert rules configured for a synchronization task.', - '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.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' => ''], + ], ], - 'schemes' => [ - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"952795279527ab****\\",\\n \\"Data\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 20,\\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}","type":"json"}]', + 'title' => 'ListDeploymentPackages', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'ListDownstreamTaskInstances' => [ + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '234129', - 'abilityTreeNodes' => [ - 'FEATUREdideBP0OJZ', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '240662', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB', 'FEATUREdideD0YY7B', 'FEATUREdideVFMENL'], ], 'parameters' => [ [ - 'name' => 'JobId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the task for which alert rules are configured.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1000001', - ], - ], - [ - 'name' => 'PageNumber', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234', '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', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'DIAlarmRuleId', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert rule. If you leave this parameter empty, all alert rules of the task are queried.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '34988', - ], + 'schema' => ['description' => 'The page number. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', '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. You can use the ID to query logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '74C2FECD-5B3A-554A-BCF5-351A36DE9815', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX', 'title' => ''], 'PagingInfo' => [ - 'description' => 'The pagination information.'."\n", + 'description' => 'The pagination information.', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '90', - ], - 'PageNumber' => [ - 'description' => 'The page number. Pages start from page 1.'."\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", + 'TaskInstances' => [ + 'description' => 'The instances. This parameter is deprecated and replaced by the DownstreamTaskInstances parameter.', 'type' => 'array', 'items' => [ - 'description' => 'The details of an alert rule.'."\n", 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the alert rule.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '72402', - ], - 'DIJobId' => [ - 'description' => 'The ID of the synchronization task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '32594', + 'StepType' => ['description' => 'The scheduling dependency type. Valid values:'."\n" + ."\n" + .'- Normal: same-cycle scheduling dependency'."\n" + ."\n" + .'- CrossCycle: cross-cycle scheduling dependency', 'type' => 'string', 'title' => '', 'example' => 'Normal'], + 'TaskId' => ['description' => 'The ID of the task for which the instance is generated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'TaskType' => ['description' => 'The type of the task for which the instance is generated.', 'type' => 'string', 'title' => '', 'example' => 'ODPS_SQL'], + 'TaskName' => ['description' => 'The name of the task for which the instance is generated.', 'type' => 'string', 'example' => 'SQL node'."\n", 'title' => ''], + 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'WorkflowId' => ['description' => 'The ID of the workflow to which the instance belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'WorkflowName' => ['description' => 'The name of the workflow to which the instance belongs.', 'type' => 'string', 'example' => 'Test workflow', 'title' => ''], + 'TriggerType' => [ + 'description' => 'The method to trigger instance scheduling.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- Scheduler: scheduling cycle-based trigger'."\n" + ."\n" + .'- Manual: manual trigger', + 'enumValueTitles' => ['Scheduler' => '', 'Manual' => ''], + 'type' => 'string', + 'example' => 'Scheduler', + 'title' => '', ], - 'Description' => [ - 'description' => 'The description of the alert rule.'."\n", + 'TriggerRecurrence' => [ + 'description' => 'The running mode of the instance after it is triggered. This parameter takes effect only if the TriggerType parameter is set to Scheduler.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- Pause'."\n" + ."\n" + .'- Skip'."\n" + ."\n" + .'- Normal', + 'enumValueTitles' => ['Pause' => '', 'Skip' => '', 'Normal' => ''], 'type' => 'string', - 'example' => 'rule descrition', + 'example' => 'Normal', + 'title' => '', ], - 'MetricType' => [ - 'description' => 'The metric type in the alert rule. Valid values:'."\n" - ."\n" - .'* Heartbeat'."\n" - .'* FailoverCount'."\n" - .'* Delay'."\n" - .'* DdlReport'."\n" - .'* ResourceUtilization'."\n", + 'WorkflowInstanceId' => ['description' => 'The workflow instance ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'WorkflowInstanceType' => [ + 'description' => 'The type of the workflow instance.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- SmokeTest'."\n" + ."\n" + .'- SupplementData'."\n" + ."\n" + .'- Manual'."\n" + ."\n" + .'- ManualWorkflow'."\n" + ."\n" + .'- Normal'."\n" + ."\n" + .'- ManualFlow', + 'enumValueTitles' => ['SmokeTest' => '', 'SupplementData' => '', 'Manual' => '', 'ManualWorkflow' => '', 'Normal' => '', 'ManualFlow' => ''], 'type' => 'string', - 'example' => 'Heartbeat', + 'example' => 'Normal', + 'title' => '', ], - 'Name' => [ - 'description' => 'The name of the alert rule.'."\n", + 'Timeout' => ['description' => 'The timeout period of task running. Unit: seconds.'."\n" + ."\n" + .'Note: The value of this parameter is rounded up by hour.', 'type' => 'integer', 'format' => 'int32', 'example' => '3600', 'title' => ''], + 'RerunMode' => [ + 'description' => 'The rerun mode.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- AllDenied: The task cannot be rerun regardless of whether it is successfully run or fails to run.'."\n" + ."\n" + .'- FailureAllowed: The task can be rerun only after it fails to run.'."\n" + ."\n" + .'- AllAllowed: The task can be rerun regardless of whether it is successfully run or fails to run.', + 'enumValueTitles' => ['AllDenied' => '', 'FailureAllowed' => '', 'AllAllowed' => ''], 'type' => 'string', - 'example' => 'rule_name', + 'title' => '', + 'example' => 'AllAllowed', ], - 'Enabled' => [ - 'description' => 'Indicates whether the alert rule is enabled. Valid values: True and False.'."\n", - 'type' => 'boolean', - 'example' => 'True', + 'RunNumber' => ['description' => 'The number of times the instance is run. By default, the value starts from 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PeriodNumber' => ['description' => 'The sequence number of the cycle. This parameter indicates the cycle of the task instance on the current day.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'BaselineId' => ['description' => 'The baseline ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'Priority' => ['description' => 'The priority of the task. Valid values: 1 to 8. A larger value indicates a higher priority. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RuntimeResource' => [ + 'description' => 'The information about the resource group with which the instance is associated.', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupId' => ['description' => 'The ID of the resource group for scheduling configured for task running.', 'type' => 'string', 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', 'title' => ''], + 'Image' => ['description' => 'The ID of the image configured for task running.', 'type' => 'string', 'example' => 'i-xxxxxx', 'title' => ''], + 'Cu' => ['description' => 'The default number of compute units (CUs) configured for task running.', 'type' => 'string', 'example' => '0.25', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - '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', - 'example' => 'Critical', - ], - 'Duration' => [ - 'description' => 'The time interval for alert calculation. Unit: minutes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - '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', - ], - 'DdlTypes' => [ - 'description' => 'The types of DDL operations for which the alert rule takes effect. This parameter is returned only if the MetricType parameter is set to DdlReport.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The type of the DDL operation for which the alert rule takes effect. This parameter is returned only if the MetricType parameter is set to DdlReport. Valid values:'."\n" - ."\n" - .'* AlterAddColumn'."\n" - .'* AlterDropColumn'."\n" - .'* AlterRenameColumn'."\n" - .'* AlterRenameTable'."\n" - .'* AlterTableModify'."\n" - .'* DropTable'."\n" - .'* TruncateTable'."\n", - 'type' => 'string', - 'example' => 'ALTERADDCOLUMN', - ], - ], - 'DdlReportTags' => [ - 'description' => 'This parameter is deprecated and replaced by the DdlTypes parameter.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'This parameter is deprecated and replaced by the DdlTypes parameter.'."\n", - 'type' => 'string', - 'deprecated' => true, - 'example' => 'ALTERADDCOLUMN', - ], - 'deprecated' => true, - ], - ], + 'Runtime' => [ + 'description' => 'The runtime information about the instance.', + 'type' => 'object', + 'properties' => [ + 'ProcessId' => ['description' => 'The instance run ID.', 'type' => 'string', 'example' => 'T3_123'."\n", 'title' => ''], + 'Gateway' => ['description' => 'The host for running.', 'type' => 'string', 'example' => 'cn-shanghai.1.2', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'NotificationSettings' => [ - 'description' => 'The alert notification method and recipient settings.'."\n", + 'DataSource' => [ + 'description' => 'The information about the associated data source.', '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', - 'example' => 'Critical', - ], - 'Channels' => [ - 'description' => 'The alert notification methods.'."\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', - ], - ], - ], + 'Name' => ['description' => 'The name of the data source.', 'type' => 'string', 'example' => 'mysql_test'."\n", 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Status' => [ + 'description' => 'The status of the instance. Valid values:'."\n" + ."\n" + .'- NotRun: The instance is not run.'."\n" + ."\n" + .'- Running: The instance is running.'."\n" + ."\n" + .'- WaitTime: The instance is waiting for the scheduling time to arrive.'."\n" + ."\n" + .'- CheckingCondition: Branch conditions are being checked for the instance.'."\n" + ."\n" + .'- WaitResource: The instance is waiting for resources.'."\n" + ."\n" + .'- Failure: The instance fails to be run.'."\n" + ."\n" + .'- Success: The instance is successfully run.'."\n" + ."\n" + .'- Checking: Data quality is being checked for the instance.'."\n" + ."\n" + .'- WaitTrigger: The instance is waiting to be triggered by external scheduling systems.', + 'enumValueTitles' => [], + 'type' => 'string', + 'title' => '', + 'example' => 'Success', + ], + 'TriggerTime' => ['description' => 'The scheduling time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'."\n", 'title' => ''], + 'Bizdate' => ['description' => 'The data timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'."\n", 'title' => ''], + 'StartedTime' => ['description' => 'The time when the instance started to run.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'."\n", 'title' => ''], + 'FinishedTime' => ['description' => 'The time when the instance finished running.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'."\n", 'title' => ''], + 'Id' => ['description' => 'The instance ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'ProjectId' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'ProjectEnv' => [ + 'description' => 'The environment of the workspace. This parameter is deprecated and replaced by the EnvType parameter. Valid values:', + 'enumValueTitles' => [], + 'type' => 'string', + 'deprecated' => true, + 'example' => 'Prod', + 'title' => '', + ], + 'EnvType' => ['description' => 'The environment in which the data source is used. Valid values:'."\n" + ."\n" + .'- Dev'."\n" + ."\n" + .'- Prod', 'type' => 'string', 'example' => 'Prod', 'title' => ''], + 'Owner' => ['description' => 'The account ID of the task owner.', 'type' => 'string', 'example' => '100', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'."\n", 'title' => ''], + 'ModifyTime' => ['description' => 'The modification time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'."\n", 'title' => ''], + 'CreateUser' => ['description' => 'The account ID of the creator.', 'type' => 'string', 'example' => '1000'."\n", 'title' => ''], + 'ModifyUser' => ['description' => 'The account ID of the modifier.', 'type' => 'string', 'example' => '1000'."\n", 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'DownstreamTaskInstances' => [ + 'description' => 'The descendant instances.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DependencyType' => ['description' => 'The scheduling dependency type. Valid values:'."\n" + ."\n" + .'- Normal'."\n" + ."\n" + .'- CrossCycle', 'type' => 'string', 'title' => '', 'example' => 'Normal'], + 'TaskInstance' => [ + 'title' => '', + 'description' => 'The information about a task instance.', + 'type' => 'object', + 'properties' => [ + 'TaskId' => ['description' => 'The ID of the task for which the instance is generated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'TaskType' => ['description' => 'The type of the task for which the instance is generated.', 'type' => 'string', 'title' => '', 'example' => 'ODPS_SQL'], + 'TaskName' => ['description' => 'The name of the task for which the instance is generated.', 'type' => 'string', 'example' => 'SQL node', 'title' => ''], + 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'WorkflowId' => ['description' => 'The ID of the workflow to which the instance belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'WorkflowName' => ['description' => 'The name of the workflow to which the instance belongs.', 'type' => 'string', 'example' => 'Test workflow', 'title' => ''], + 'TriggerType' => ['description' => 'The trigger type. Valid values:'."\n" + ."\n" + .'- Scheduler: scheduling cycle-based trigger'."\n" + ."\n" + .'- Manual: manual trigger', 'type' => 'string', 'example' => 'Scheduler', 'title' => ''], + 'TriggerRecurrence' => ['description' => 'The running mode of the instance after it is triggered. This parameter takes effect only if the TriggerType parameter is set to Scheduler. Valid values:'."\n" + ."\n" + .'- Pause'."\n" + ."\n" + .'- Skip'."\n" + ."\n" + .'- Normal', 'type' => 'string', 'example' => 'Normal', 'title' => ''], + 'WorkflowInstanceId' => ['description' => 'The workflow instance ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'WorkflowInstanceType' => ['description' => 'The type of the workflow instance. Valid values:'."\n" + ."\n" + .'- Normal'."\n" + ."\n" + .'- Manual'."\n" + ."\n" + .'- SmokeTest'."\n" + ."\n" + .'- SupplementData'."\n" + ."\n" + .'- ManualWorkflow', 'type' => 'string', 'example' => 'Normal', 'title' => ''], + 'Timeout' => ['description' => 'The timeout period of task running. Unit: seconds.'."\n" + ."\n" + .'Note: The value of this parameter is rounded up by hour.', 'type' => 'integer', 'format' => 'int32', 'example' => '3600', 'title' => ''], + 'RerunMode' => ['description' => 'The rerun mode.', 'type' => 'string', 'title' => '', 'example' => 'AllAllowed'], + 'RunNumber' => ['description' => 'The number of times the instance is run. By default, the value starts from 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PeriodNumber' => ['description' => 'The sequence number of the cycle. This parameter indicates the cycle of the task instance on the current day.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'BaselineId' => ['description' => 'The baseline ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'Priority' => ['description' => 'The priority of the task. Minimum value: 1. Maximum value: 8. A larger value indicates a higher priority. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RuntimeResource' => [ + 'description' => 'The configurations of the runtime environment, such as the resource group information.', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupId' => ['description' => 'The ID of the resource group for scheduling configured for task running.', 'type' => 'string', 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', 'title' => ''], + 'Image' => ['description' => 'The ID of the image configured for task running.', 'type' => 'string', 'example' => 'i-xxxxxx', 'title' => ''], + 'Cu' => ['description' => 'The default number of compute units (CUs) configured for task running.', 'type' => 'string', 'example' => '0.25', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'NotificationReceivers' => [ - 'description' => 'The settings of alert notification recipients.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The settings of alert notification recipients.'."\n", - 'type' => 'object', - 'properties' => [ - 'ReceiverType' => [ - 'description' => 'The recipient type. Valid values: AliyunUid, DingToken, FeishuToken, and WebHookUrl.'."\n", - 'type' => 'string', - 'example' => 'DingToken', - ], - 'ReceiverValues' => [ - 'description' => 'The recipient.'."\n" - ."\n" - .'* If the value of the ReceiverType parameter is AliyunUid, the value of this parameter is the Alibaba Cloud account ID of a user.'."\n" - .'* If the value of the ReceiverType parameter is DingToken, the value of this parameter is the token of a DingTalk chatbot.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The recipient.'."\n" - ."\n" - .'* If the value of the ReceiverType parameter is AliyunUid, the value of this parameter is the Alibaba Cloud account ID of a user.'."\n" - .'* If the value of the ReceiverType parameter is DingToken, the value of this parameter is the token of a DingTalk chatbot.'."\n", - 'type' => 'string', - 'example' => 'token1', - ], - ], - ], + 'Runtime' => [ + 'description' => 'The runtime information about the instance.', + 'type' => 'object', + 'properties' => [ + 'ProcessId' => ['description' => 'The instance run ID.', 'type' => 'string', 'example' => 'T3_123', 'title' => ''], + 'Gateway' => ['description' => 'The host for running.', 'type' => 'string', 'example' => 'cn-shanghai.1.2', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'MuteInterval' => [ - 'description' => 'The duration of the alert suppression interval. Unit: minutes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - 'InhibitionInterval' => [ - 'description' => 'This parameter is deprecated and replaced by the MuteInterval parameter.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'deprecated' => true, - 'example' => '5', + 'DataSource' => [ + 'description' => 'The information about the associated data source.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the data source.', 'type' => 'string', 'example' => 'mysql_test', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'Status' => ['description' => 'The status of the instance. Valid values:'."\n" + ."\n" + .'- NotRun: The instance is not run.'."\n" + ."\n" + .'- Running: The instance is running.'."\n" + ."\n" + .'- WaitTime: The instance is waiting for the scheduling time to arrive.'."\n" + ."\n" + .'- CheckingCondition: Branch conditions are being checked for the instance.'."\n" + ."\n" + .'- WaitResource: The instance is waiting for resources.'."\n" + ."\n" + .'- Failure: The instance fails to be run.'."\n" + ."\n" + .'- Success: The instance is successfully run.'."\n" + ."\n" + .'- Checking: Data quality is being checked for the instance.'."\n" + ."\n" + .'- WaitTrigger: The instance is waiting to be triggered by external scheduling systems.', 'type' => 'string', 'title' => '', 'example' => 'Success'], + 'TriggerTime' => ['description' => 'The scheduling time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + 'Bizdate' => ['description' => 'The data timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + 'StartedTime' => ['description' => 'The time when the instance started to run.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + 'FinishedTime' => ['description' => 'The time when the instance finished running.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + 'Id' => ['description' => 'The instance ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'ProjectId' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'EnvType' => ['description' => 'The environment in which the data source is used. Valid values:'."\n" + ."\n" + .'- Dev'."\n" + ."\n" + .'- Prod', 'type' => 'string', 'example' => 'Prod', 'title' => ''], + 'Owner' => ['description' => 'The account ID of the task owner.', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + 'ModifyTime' => ['description' => 'The modification time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + 'CreateUser' => ['description' => 'The account ID of the creator.', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'ModifyUser' => ['description' => 'The account ID of the modifier.', 'type' => 'string', 'example' => '1000', 'title' => ''], ], - ], - 'DIAlarmRuleId' => [ - 'description' => 'This parameter is deprecated. Use the Id parameter instead.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'deprecated' => true, - 'example' => '72402', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + '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' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"74C2FECD-5B3A-554A-BCF5-351A36DE9815\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 90,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"DIJobAlarmRules\\": [\\n {\\n \\"Id\\": 72402,\\n \\"DIJobId\\": 32594,\\n \\"Description\\": \\"rule descrition\\",\\n \\"MetricType\\": \\"Heartbeat\\",\\n \\"Name\\": \\"rule_name\\",\\n \\"Enabled\\": true,\\n \\"TriggerConditions\\": [\\n {\\n \\"Severity\\": \\"Critical\\",\\n \\"Duration\\": 1,\\n \\"Threshold\\": 5,\\n \\"DdlTypes\\": [\\n \\"AlterAddColumn\\"\\n ],\\n \\"DdlReportTags\\": [\\n \\"ALTERADDCOLUMN\\"\\n ]\\n }\\n ],\\n \\"NotificationSettings\\": {\\n \\"NotificationChannels\\": [\\n {\\n \\"Severity\\": \\"Critical\\",\\n \\"Channels\\": [\\n \\"Ding\\"\\n ]\\n }\\n ],\\n \\"NotificationReceivers\\": [\\n {\\n \\"ReceiverType\\": \\"DingToken\\",\\n \\"ReceiverValues\\": [\\n \\"token1\\"\\n ]\\n }\\n ],\\n \\"MuteInterval\\": 5,\\n \\"InhibitionInterval\\": 5\\n },\\n \\"DIAlarmRuleId\\": 72402\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListDIAlarmRules', - ], - 'ListCrawlerTypes' => [ - 'summary' => 'Queries a list of metadata crawler types supported in Data Map. The subtypes of the types and the hierarchical relationship between the subtypes are also returned.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'abilityTreeCode' => '268429', - 'abilityTreeNodes' => [ - 'FEATUREdideE9XYA6', - ], - 'tenantRelevance' => 'publicInformation', - ], - 'parameters' => [], - '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' => '0000-ABCD-EFG****', - ], - 'Success' => [ - 'title' => '是否请求成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'CrawlerTypes' => [ - 'title' => '元数据采集器类型列表', - 'description' => 'The list of metadata crawler types.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Information about supported metadata crawler types.'."\n", - '$ref' => '#/components/schemas/CrawlerType', - ], - ], - ], - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"PagingInfo\\": {\\n \\"TaskInstances\\": [\\n {\\n \\"StepType\\": \\"Normal\\",\\n \\"TaskId\\": 1234,\\n \\"TaskType\\": \\"ODPS_SQL\\",\\n \\"TaskName\\": \\"SQL node\\\\n\\",\\n \\"Description\\": \\"test\\",\\n \\"WorkflowId\\": 1234,\\n \\"WorkflowName\\": \\"Test workflow\\",\\n \\"TriggerType\\": \\"Scheduler\\",\\n \\"TriggerRecurrence\\": \\"Normal\\",\\n \\"WorkflowInstanceId\\": 1234,\\n \\"WorkflowInstanceType\\": \\"Normal\\",\\n \\"Timeout\\": 3600,\\n \\"RerunMode\\": \\"AllAllowed\\",\\n \\"RunNumber\\": 1,\\n \\"PeriodNumber\\": 1,\\n \\"BaselineId\\": 1234,\\n \\"Priority\\": 1,\\n \\"RuntimeResource\\": {\\n \\"ResourceGroupId\\": \\"S_res_group_524258031846018_1684XXXXXXXXX\\",\\n \\"Image\\": \\"i-xxxxxx\\",\\n \\"Cu\\": \\"0.25\\"\\n },\\n \\"Runtime\\": {\\n \\"ProcessId\\": \\"T3_123\\\\n\\",\\n \\"Gateway\\": \\"cn-shanghai.1.2\\"\\n },\\n \\"DataSource\\": {\\n \\"Name\\": \\"mysql_test\\\\n\\"\\n },\\n \\"Status\\": \\"Success\\",\\n \\"TriggerTime\\": 1710239005403,\\n \\"Bizdate\\": 1710239005403,\\n \\"StartedTime\\": 1710239005403,\\n \\"FinishedTime\\": 1710239005403,\\n \\"Id\\": 1234,\\n \\"ProjectId\\": 100,\\n \\"ProjectEnv\\": \\"Prod\\",\\n \\"EnvType\\": \\"Prod\\",\\n \\"Owner\\": \\"100\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"1000\\\\n\\",\\n \\"ModifyUser\\": \\"1000\\\\n\\"\\n }\\n ],\\n \\"DownstreamTaskInstances\\": [\\n {\\n \\"DependencyType\\": \\"Normal\\",\\n \\"TaskInstance\\": {\\n \\"TaskId\\": 1234,\\n \\"TaskType\\": \\"ODPS_SQL\\",\\n \\"TaskName\\": \\"SQL node\\",\\n \\"Description\\": \\"test\\",\\n \\"WorkflowId\\": 1234,\\n \\"WorkflowName\\": \\"Test workflow\\",\\n \\"TriggerType\\": \\"Scheduler\\",\\n \\"TriggerRecurrence\\": \\"Normal\\",\\n \\"WorkflowInstanceId\\": 1234,\\n \\"WorkflowInstanceType\\": \\"Normal\\",\\n \\"Timeout\\": 3600,\\n \\"RerunMode\\": \\"AllAllowed\\",\\n \\"RunNumber\\": 1,\\n \\"PeriodNumber\\": 1,\\n \\"BaselineId\\": 1234,\\n \\"Priority\\": 1,\\n \\"RuntimeResource\\": {\\n \\"ResourceGroupId\\": \\"S_res_group_524258031846018_1684XXXXXXXXX\\",\\n \\"Image\\": \\"i-xxxxxx\\",\\n \\"Cu\\": \\"0.25\\"\\n },\\n \\"Runtime\\": {\\n \\"ProcessId\\": \\"T3_123\\",\\n \\"Gateway\\": \\"cn-shanghai.1.2\\"\\n },\\n \\"DataSource\\": {\\n \\"Name\\": \\"mysql_test\\"\\n },\\n \\"Status\\": \\"Success\\",\\n \\"TriggerTime\\": 1710239005403,\\n \\"Bizdate\\": 1710239005403,\\n \\"StartedTime\\": 1710239005403,\\n \\"FinishedTime\\": 1710239005403,\\n \\"Id\\": 1234,\\n \\"ProjectId\\": 100,\\n \\"EnvType\\": \\"Prod\\",\\n \\"Owner\\": \\"1000\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"1000\\",\\n \\"ModifyUser\\": \\"1000\\"\\n }\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1\\n }\\n}","type":"json"}]', + 'title' => 'ListDownstreamTaskInstances', + 'summary' => 'Queries a list of descendant instances of an instance by page.', + 'description' => 'This API operation is available for all DataWorks editions.', + 'changeSet' => [ + ['createdAt' => '2025-01-21T03:12:29.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-01-06T09:33:04.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-11-20T07:55:32.000Z', 'description' => 'Response parameters changed'], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"Success\\": true,\\n \\"CrawlerTypes\\": [\\n {\\n \\"Type\\": \\"dlf\\",\\n \\"DisplayName\\": \\"Data Lake Formation\\",\\n \\"SupportedEntityTypes\\": [\\n {\\n \\"Type\\": \\"dlf-table\\",\\n \\"SubType\\": \\"table\\",\\n \\"Optional\\": true,\\n \\"ParentSubType\\": \\"database\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListCrawlerTypes', + 'ramActions' => [], ], - 'ListCatalogs' => [ - 'summary' => 'Queries a list of catalogs in Data Map. Only catalogs of the Data Lake Formation (DLF) and StarRocks metadata crawler types are supported. For the DLF metadata crawler type, all supported data catalogs are returned. For the StarRocks metadata crawler type, data catalogs in a specific instance are returned.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListDownstreamTasks' => [ + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'abilityTreeCode' => '267928', - 'abilityTreeNodes' => [ - 'FEATUREdideE9XYA6', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '240489', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB', 'FEATUREdideD0YY7B', 'FEATUREdideVFMENL'], ], 'parameters' => [ [ - 'name' => 'ParentMetaEntityId', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '父层级实体ID', - 'description' => 'The parent entity ID. For more information, see [Concepts related to metadata entities](~~2880092~~).'."\n" - ."\n" - .'Currently, only the DLF and StarRocks types are supported.'."\n" - ."\n" - .'* For the DLF type, you can query all catalog lists. The format of `ParentMetaEntityId` is `DLF`.'."\n" - .'* For the StarRocks type, you can query the catalogs of a specific instance. The format of `ParentMetaEntityId` `is StarRocks:(instance_id|encoded_jdbc_url)`.'."\n" - ."\n" - .'> \\'."\n" - .'`instance_id`: The instance ID. Required if the data source is registered in instance mode.\\'."\n" - .'`encoded_jdbc_url`: The JDBC connection string encoded with URL encoding. Required if the data source is registered in connection-string mode.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'dlf'."\n" - .'starrocks:c-abc123xxx', - ], - ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'title' => '名称，模糊匹配', - 'description' => 'The name. Supports fuzzy matching.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], - ], - [ - 'name' => 'Comment', - 'in' => 'query', - 'schema' => [ - 'title' => '注释，模糊匹配', - 'description' => 'The comment. Supports token-based matching.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'this is a comment', - ], - ], - [ - 'name' => 'Types', + 'name' => 'Id', 'in' => 'query', - 'style' => 'simple', - 'schema' => [ - 'title' => '类型，精确匹配，支持多项，按照逻辑或的关系查询', - 'description' => 'The type. Supports exact match. If left empty, all types are queried.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The catalog type.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'HIVE', - ], - 'required' => false, - ], + 'schema' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234', 'title' => ''], ], [ - 'name' => 'SortBy', + 'name' => 'ProjectEnv', 'in' => 'query', 'schema' => [ - 'title' => '排序字段，默认为CreateTime', - 'description' => 'The sort field. Default value: CreateTime. Valid values:'."\n" + 'description' => 'The environment of the workspace.'."\n" ."\n" - .'* CreateTime'."\n" - .'* ModifyTime'."\n" - .'* Name'."\n" - .'* Type'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'CreateTime', - 'pattern' => '^[\\w.,;/@-]+$', - 'default' => 'CreateTime', - 'enum' => [ - 'CreateTime', - 'ModifyTime', - 'Name', - 'Type', - ], - ], - ], - [ - 'name' => 'Order', - 'in' => 'query', - 'schema' => [ - 'title' => '排序方向，默认为Asc', - 'description' => 'The order in which the tables are sorted. Default value: Asc. Valid values:'."\n" + .'Valid values:'."\n" + ."\n" + .'- Prod: production environment'."\n" ."\n" - .'* Asc: ascending order.'."\n" - .'* Desc: descending order.'."\n", + .'- Dev: development environment', + 'enumValueTitles' => ['Prod' => '', 'Dev' => ''], 'type' => 'string', + 'default' => 'Prod', + 'enum' => ['Prod', 'Dev'], 'required' => false, - 'example' => 'Asc', - 'default' => 'Asc', - 'enum' => [ - 'Asc', - 'Desc', - ], + 'example' => 'Prod', + 'title' => '', ], ], [ - 'name' => 'PageNumber', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '分页页码，默认为1', - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '分页大小，默认为10，最大为100', - 'description' => 'The number of records per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], + 'schema' => ['description' => 'The page number. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Responses.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '317CD7D0-AB36-XXXXXX', - ], - 'Success' => [ - 'title' => '请求是否成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX', 'title' => ''], 'PagingInfo' => [ - 'title' => '分页结果', - 'description' => 'The pagination result.'."\n", + 'description' => 'The pagination information.', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of records.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of records per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', + 'Tasks' => [ + 'description' => 'The tasks. This parameter is deprecated and replaced by the DownstreamTasks parameter.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the task.', 'type' => 'string', 'example' => 'SQL node'."\n", 'title' => ''], + 'Description' => ['description' => 'The description of the task.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'WorkflowId' => ['description' => 'The ID of the workflow to which the task belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'InstanceMode' => ['description' => 'The instance generation mode. Valid values:'."\n" + ."\n" + .'- T+1'."\n" + ."\n" + .'- Immediately', 'type' => 'string', 'example' => 'T+1', 'title' => ''], + 'Type' => ['description' => 'The type of the task.', 'type' => 'string', 'title' => '', 'example' => 'ODPS_SQL'], + 'BaselineId' => ['description' => 'The baseline ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1234'], + 'Priority' => ['description' => 'The priority of the task. Valid values: 1 to 8. A larger value indicates a higher priority. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'Timeout' => ['description' => 'The timeout period of task running. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '3600'], + 'RerunMode' => [ + 'description' => 'The rerun mode.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- AllDenied: The task cannot be rerun regardless of whether it is successfully run or fails to run.'."\n" + ."\n" + .'- FailureAllowed: The task can be rerun only after it fails to run.'."\n" + ."\n" + .'- AllAllowed: The task can be rerun regardless of whether it is successfully run or fails to run.', + 'enumValueTitles' => ['AllDenied' => '', 'FailureAllowed' => '', 'AllAllowed' => ''], + 'type' => 'string', + 'title' => '', + 'example' => 'AllAllowed', + ], + 'RerunTimes' => ['description' => 'The number of times that the task is rerun. This parameter takes effect only if the RerunMode parameter is set to AllAllowed or FailureAllowed.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '3'], + 'RerunInterval' => ['description' => 'The rerun interval. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '60'], + 'Trigger' => [ + 'title' => '', + 'description' => 'The method to trigger task scheduling.', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The trigger type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- Scheduler: scheduling cycle-based trigger'."\n" + ."\n" + .'- Manual: manual trigger', + 'enumValueTitles' => ['Scheduler' => '', 'Manual' => ''], + 'type' => 'string', + 'example' => 'Scheduler', + 'title' => '', + ], + 'Recurrence' => [ + 'description' => 'The running mode of the task after it is triggered. This parameter takes effect only if the Type parameter is set to Scheduler.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- Pause'."\n" + ."\n" + .'- Skip'."\n" + ."\n" + .'- Normal', + 'enumValueTitles' => ['Pause' => '', 'Skip' => '', 'Normal' => ''], + 'type' => 'string', + 'example' => 'Normal'."\n", + 'title' => '', + ], + 'Cron' => ['description' => 'The CRON expression of the task. This parameter takes effect only if the Type parameter is set to Scheduler.', 'type' => 'string', 'example' => '00 00 00 * * ?', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the time range during which the task is periodically scheduled. This parameter takes effect only if the Type parameter is set to Scheduler.', 'type' => 'string', 'example' => '1970-01-01 00:00:00', 'title' => ''], + 'EndTime' => ['description' => 'The end time of the time range during which the task is periodically scheduled. This parameter takes effect only if the Type parameter is set to Scheduler.', 'type' => 'string', 'example' => '9999-01-01 00:00:00', 'title' => ''], + 'Timezone' => ['description' => 'The time zone.', 'type' => 'string', 'example' => 'Asia/Shanghai', 'title' => ''], + ], + 'example' => '', + ], + 'RuntimeResource' => [ + 'title' => '', + 'description' => 'The configurations of the runtime environment, such as the resource group information.', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupId' => ['description' => 'The ID of the resource group for scheduling configured for task running.', 'type' => 'string', 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX'."\n", 'title' => ''], + 'Image' => ['description' => 'The ID of the image configured for task running.', 'type' => 'string', 'example' => 'i-xxxxxx', 'title' => ''], + 'Cu' => ['description' => 'The default number of compute units (CUs) configured for task running.', 'type' => 'string', 'example' => '0.25', 'title' => ''], + ], + 'example' => '', + ], + 'DataSource' => [ + 'title' => '', + 'description' => 'The information about the associated data source.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the data source.', 'type' => 'string', 'example' => 'mysql_test'."\n", 'title' => ''], + ], + 'example' => '', + ], + 'Id' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'ProjectId' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'ProjectEnv' => [ + 'description' => 'The environment of the workspace. This parameter is deprecated and replaced by the EnvType parameter.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- Prod'."\n" + ."\n" + .'- Dev', + 'enumValueTitles' => ['Prod' => '', 'Dev' => ''], + 'type' => 'string', + 'deprecated' => true, + 'example' => 'Prod', + 'title' => '', + ], + 'EnvType' => ['description' => 'The environment of the workspace. Valid values:'."\n" + ."\n" + .'- Prod'."\n" + ."\n" + .'- Dev', 'type' => 'string', 'example' => 'Prod', 'title' => ''], + 'Owner' => ['description' => 'The account ID of the task owner.', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'StepType' => ['description' => 'The scheduling dependency type. Valid values:'."\n" + ."\n" + .'- Normal: same-cycle scheduling dependency'."\n" + ."\n" + .'- CrossCycle: cross-cycle scheduling dependency', 'type' => 'string', 'example' => 'Normal', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + 'ModifyTime' => ['description' => 'The modification time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + 'CreateUser' => ['description' => 'The account ID of the creator.', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'ModifyUser' => ['description' => 'The account ID of the modifier.', 'type' => 'string', 'example' => '1000', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'Catalogs' => [ - 'description' => 'The catalog.'."\n", + 'DownstreamTasks' => [ + 'description' => 'The descendant tasks.', 'type' => 'array', 'items' => [ - 'description' => 'The catalog details.'."\n", - '$ref' => '#/components/schemas/Catalog', + 'type' => 'object', + 'properties' => [ + 'DependencyType' => ['description' => 'The scheduling dependency type. Valid values:'."\n" + ."\n" + .'- Normal: same-cycle scheduling dependency'."\n" + ."\n" + .'- CrossCycle: cross-cycle scheduling dependency', 'type' => 'string', 'title' => '', 'example' => 'Normal'], + 'Task' => [ + 'description' => 'The information about the task.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the task.', 'type' => 'string', 'example' => 'SQL node', 'title' => ''], + 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'WorkflowId' => ['description' => 'The ID of the workflow to which the task belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'InstanceMode' => ['description' => 'The instance generation mode. Valid values:'."\n" + ."\n" + .'- T+1'."\n" + ."\n" + .'- Immediately', 'type' => 'string', 'example' => 'T+1', 'title' => ''], + 'Type' => ['description' => 'The type of the task.', 'type' => 'string', 'title' => '', 'example' => 'ODPS_SQL'], + 'BaselineId' => ['description' => 'The baseline ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1234'], + 'Priority' => ['description' => 'The priority of the task. Valid values: 1 to 8.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'Timeout' => ['description' => 'The timeout period of task running. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '3600'], + 'RerunMode' => ['description' => 'The rerun mode. Valid values:'."\n" + ."\n" + .'- AllDenied: The task cannot be rerun regardless of whether the task is successfully run or fails to run.'."\n" + ."\n" + .'- FailureAllowed: The task can be rerun only after it fails to run.'."\n" + ."\n" + .'- AllAllowed: The task can be rerun regardless of whether it is successfully run or fails to run.', 'type' => 'string', 'title' => '', 'example' => 'AllAllowed'], + 'RerunTimes' => ['description' => 'The number of times that the task is rerun. This parameter takes effect only if the RerunMode parameter is set to AllAllowed or FailureAllowed.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '3'], + 'RerunInterval' => ['description' => 'The rerun interval. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '60'], + 'Trigger' => [ + 'title' => '', + 'description' => 'The trigger method.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The trigger type. Valid values:'."\n" + ."\n" + .'- Scheduler: scheduling cycle-based trigger'."\n" + ."\n" + .'- Manual: manual trigger', 'type' => 'string', 'example' => 'Scheduler', 'title' => ''], + 'Recurrence' => ['description' => 'The running mode of the task after it is triggered. This parameter takes effect only if the Type parameter is set to Scheduler. Valid values:'."\n" + ."\n" + .'- Pause'."\n" + ."\n" + .'- Skip'."\n" + ."\n" + .'- Normal', 'type' => 'string', 'example' => 'Normal', 'title' => ''], + 'Cron' => ['description' => 'The CRON expression. This parameter takes effect only if the Type parameter is set to Scheduler.', 'type' => 'string', 'example' => '00 00 00 * * ?', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the time range during which the task is periodically scheduled. This parameter takes effect only if the Type parameter is set to Scheduler.', 'type' => 'string', 'example' => '1970-01-01 00:00:00', 'title' => ''], + 'EndTime' => ['description' => 'The end time of the time range during which the task is periodically scheduled. This parameter takes effect only if the Type parameter is set to Scheduler.', 'type' => 'string', 'example' => '9999-01-01 00:00:00', 'title' => ''], + 'Timezone' => ['description' => 'The time zone.', 'type' => 'string', 'example' => 'Asia/Shanghai', 'title' => ''], + ], + 'example' => '', + ], + 'RuntimeResource' => [ + 'title' => '', + 'description' => 'The configurations of the runtime environment, such as the resource group information.', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupId' => ['description' => 'The ID of the resource group for scheduling configured for task running.', 'type' => 'string', 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', 'title' => ''], + 'Image' => ['description' => 'The ID of the image configured for task running.', 'type' => 'string', 'example' => 'i-xxxxxx', 'title' => ''], + 'Cu' => ['description' => 'The default number of compute units (CUs) configured for task running.', 'type' => 'string', 'example' => '0.25', 'title' => ''], + ], + 'example' => '', + ], + 'DataSource' => [ + 'title' => '', + 'description' => 'The information about the associated data source.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the data source.', 'type' => 'string', 'example' => 'mysql_test', 'title' => ''], + ], + 'example' => '', + ], + 'Id' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'ProjectId' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'EnvType' => ['description' => 'The environment of the workspace. Valid values:'."\n" + ."\n" + .'- Prod'."\n" + ."\n" + .'- Dev', 'type' => 'string', 'example' => 'Prod', 'title' => ''], + 'Owner' => ['description' => 'The account ID of the task owner.', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + 'ModifyTime' => ['description' => 'The modification time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + 'CreateUser' => ['description' => 'The account ID of the creator.', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'ModifyUser' => ['description' => 'The account ID of the modifier.', 'type' => 'string', 'example' => '1000', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - ], - ], - ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"317CD7D0-AB36-XXXXXX\\",\\n \\"Success\\": true,\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Catalogs\\": [\\n {\\n \\"Id\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Comment\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"CreateTime\\": 0,\\n \\"ModifyTime\\": 0,\\n \\"ParentMetaEntityId\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListCatalogs', - ], - 'GetCatalog' => [ - 'summary' => 'Queries the information about a catalog in Data Map. Only catalogs of the Data Lake Formation (DLF) and StarRocks metadata crawlers are supported.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + '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' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'abilityTreeCode' => '267969', - 'abilityTreeNodes' => [ - 'FEATUREdideE9XYA6', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"PagingInfo\\": {\\n \\"Tasks\\": [\\n {\\n \\"Name\\": \\"SQL node\\\\n\\",\\n \\"Description\\": \\"test\\",\\n \\"WorkflowId\\": 1234,\\n \\"InstanceMode\\": \\"T+1\\",\\n \\"Type\\": \\"ODPS_SQL\\",\\n \\"BaselineId\\": 1234,\\n \\"Priority\\": 1,\\n \\"Timeout\\": 3600,\\n \\"RerunMode\\": \\"AllAllowed\\",\\n \\"RerunTimes\\": 3,\\n \\"RerunInterval\\": 60,\\n \\"Trigger\\": {\\n \\"Type\\": \\"Scheduler\\",\\n \\"Recurrence\\": \\"Normal\\\\n\\",\\n \\"Cron\\": \\"00 00 00 * * ?\\",\\n \\"StartTime\\": \\"1970-01-01 00:00:00\\",\\n \\"EndTime\\": \\"9999-01-01 00:00:00\\",\\n \\"Timezone\\": \\"Asia/Shanghai\\"\\n },\\n \\"RuntimeResource\\": {\\n \\"ResourceGroupId\\": \\"S_res_group_524258031846018_1684XXXXXXXXX\\\\n\\",\\n \\"Image\\": \\"i-xxxxxx\\",\\n \\"Cu\\": \\"0.25\\"\\n },\\n \\"DataSource\\": {\\n \\"Name\\": \\"mysql_test\\\\n\\"\\n },\\n \\"Id\\": 1234,\\n \\"ProjectId\\": 100,\\n \\"ProjectEnv\\": \\"Prod\\",\\n \\"EnvType\\": \\"Prod\\",\\n \\"Owner\\": \\"1000\\",\\n \\"StepType\\": \\"Normal\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"1000\\",\\n \\"ModifyUser\\": \\"1000\\"\\n }\\n ],\\n \\"DownstreamTasks\\": [\\n {\\n \\"DependencyType\\": \\"Normal\\",\\n \\"Task\\": {\\n \\"Name\\": \\"SQL node\\",\\n \\"Description\\": \\"test\\",\\n \\"WorkflowId\\": 1234,\\n \\"InstanceMode\\": \\"T+1\\",\\n \\"Type\\": \\"ODPS_SQL\\",\\n \\"BaselineId\\": 1234,\\n \\"Priority\\": 1,\\n \\"Timeout\\": 3600,\\n \\"RerunMode\\": \\"AllAllowed\\",\\n \\"RerunTimes\\": 3,\\n \\"RerunInterval\\": 60,\\n \\"Trigger\\": {\\n \\"Type\\": \\"Scheduler\\",\\n \\"Recurrence\\": \\"Normal\\",\\n \\"Cron\\": \\"00 00 00 * * ?\\",\\n \\"StartTime\\": \\"1970-01-01 00:00:00\\",\\n \\"EndTime\\": \\"9999-01-01 00:00:00\\",\\n \\"Timezone\\": \\"Asia/Shanghai\\"\\n },\\n \\"RuntimeResource\\": {\\n \\"ResourceGroupId\\": \\"S_res_group_524258031846018_1684XXXXXXXXX\\",\\n \\"Image\\": \\"i-xxxxxx\\",\\n \\"Cu\\": \\"0.25\\"\\n },\\n \\"DataSource\\": {\\n \\"Name\\": \\"mysql_test\\"\\n },\\n \\"Id\\": 1234,\\n \\"ProjectId\\": 100,\\n \\"EnvType\\": \\"Prod\\",\\n \\"Owner\\": \\"1000\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"1000\\",\\n \\"ModifyUser\\": \\"1000\\"\\n }\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1\\n }\\n}","type":"json"}]', + 'title' => 'ListDownstreamTasks', + 'summary' => 'Queries a list of descendant tasks of a task by page.', + 'description' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-01-21T03:12:29.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-01-13T08:44:56.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-01-06T09:33:04.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-11-20T07:55:32.000Z', 'description' => 'Response parameters changed'], ], - 'parameters' => [ - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'title' => 'ID', - 'description' => 'The catalog entity ID. Currently supports dlf and starrocks types. You can refer to the results returned by the ListCatalogs operation and the [Concepts related to metadata entities](~~2880092~~).'."\n" - ."\n" - .'* For the DLF type, the format is `dlf-catalog::catalog_id`.'."\n" - .'* For the StarRocks type, the format is `starrocks-catalog:(instance_id|encoded_jdbc_url):catalog_name`.'."\n" - ."\n" - .'> \\'."\n" - .'`catalog_id`: The ID of the DLF catalog.\\'."\n" - .'`instance_id`: The instance ID, required if the data source is registered in instance mode.\\'."\n" - .'`encoded_jdbc_url`: The URL-encoded JDBC connection string. Required if the data source is registered in connection string mode.\\'."\n" - .'`catalog_name`: The name of the StarRocks catalog.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'dlf-catalog:123456XXX:test_catalog'."\n" - .'starrocks-catalog:c-abc123xxx:default_catalog', - ], - ], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Responses.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AFAE64E-D1BE-432B-A9****', - ], - 'Success' => [ - 'title' => '请求是否成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Catalog' => [ - 'description' => 'Catalog information.'."\n", - '$ref' => '#/components/schemas/Catalog', - ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AFAE64E-D1BE-432B-A9****\\",\\n \\"Success\\": true,\\n \\"Catalog\\": {\\n \\"Id\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Comment\\": \\"\\",\\n \\"Type\\": \\"\\",\\n \\"CreateTime\\": 0,\\n \\"ModifyTime\\": 0,\\n \\"ParentMetaEntityId\\": \\"\\"\\n }\\n}","type":"json"}]', - 'title' => 'GetCatalog', ], - 'ListDatabases' => [ - 'summary' => 'Queries a list of databases in an instance, cluster, or data catalog in Data Map. For DLF or StarRocks data sources, you can call this API operation to query databases in a data catalog. For StarRocks data sources, you can call this API operation to query databases in internal catalogs. For other types of data sources, you can call this API operation to query databases in an instance or cluster.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListEntitiesInMetaCollection' => [ + 'summary' => 'Queries a list of entities in a collection in Data Map. Collections include categories and data albums. Entities can only be tables.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -30400,207 +32789,117 @@ 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', - 'abilityTreeCode' => '267985', - 'abilityTreeNodes' => [ - 'FEATUREdideE9XYA6', - ], + 'abilityTreeCode' => '267198', + 'abilityTreeNodes' => ['FEATUREdideE9XYA6'], ], 'parameters' => [ [ - 'name' => 'ParentMetaEntityId', + 'name' => 'Id', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '父层级实体ID', - 'description' => 'The parent entity ID. For more information, see [Concepts related to metadata entities](~~2880092~~).'."\n" - ."\n" - .'You can refer to the ListCrawlerTypes operation for the parent entity type.'."\n" - ."\n" - .'* If the parent entity is a catalog, the format of `ParentMetaEntityId` follows the response of the ListCatalogs API.'."\n" - .'* If the parent entity is a metadata crawler, the format of `ParentMetaEntityId` is `${CrawlerType}:${Instance ID or encoded URL}`.'."\n" - ."\n" - .'ParentMetaEntityId format examples'."\n" - ."\n" - .'* `dlf-catalog::catalog_id`'."\n" - .'* `holo:instance_id`'."\n" - .'* `mysql:(instance_id|encoded_jdbc_url)`'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* `catalog_id`: The ID of the DLF catalog.'."\n" - .'* `instance_id`: The instance ID. Required when the data source is registered in instance mode.'."\n" - .'* `encoded_jdbc_url`: The URL-encoded JDBC connection string. Required when the data source is registered by connection string.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'mysql:rm-abc123xxx'."\n" - .'dlf-catalog:123456XXX:test_catalog', - ], + 'schema' => ['description' => 'The collection ID.', 'type' => 'string', 'required' => true, 'example' => 'as78d756asd', 'title' => ''], ], [ - 'name' => 'Name', + 'name' => 'EntityType', 'in' => 'query', - 'schema' => [ - 'title' => '名称，模糊匹配', - 'description' => 'The name. Supports fuzzy match.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_tbl', - ], + 'schema' => ['description' => 'The entity type.', 'type' => 'string', 'required' => false, 'example' => 'dlf-table', 'title' => ''], ], [ - 'name' => 'Comment', + 'name' => 'EntityName', 'in' => 'query', - 'schema' => [ - 'title' => '注释，模糊匹配', - 'description' => 'The comment. Supports fuzzy match.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test comment', - ], + 'schema' => ['description' => 'The entity name. Supports fuzzy matching.', 'type' => 'string', 'required' => false, 'example' => 'test1', 'title' => ''], + ], + [ + 'name' => 'EntityDescription', + 'in' => 'query', + 'schema' => ['description' => 'The description specified when the entity was added to the collection. Supports fuzzy matching. Valid only for the album type.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ 'name' => 'SortBy', 'in' => 'query', - 'schema' => [ - 'title' => '排序字段，默认为CreateTime', - 'description' => 'The sort field. Default value: CreateTime. Valid values:'."\n" - ."\n" - .'* CreateTime'."\n" - .'* ModifyTime'."\n" - .'* Name'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'CreateTime', - 'pattern' => '^[\\w.,;/@-]+$', - 'default' => 'CreateTime', - 'enum' => [ - 'CreateTime', - 'ModifyTime', - 'Name', - ], - ], + 'schema' => ['description' => 'The sort field. Valid values:'."\n" + ."\n" + .'- Name (default)'."\n" + ."\n" + .'- CreateTime', 'type' => 'string', 'required' => false, 'example' => 'Name', 'title' => ''], ], [ 'name' => 'Order', 'in' => 'query', - 'schema' => [ - 'title' => '排序方向，默认为Asc', - 'description' => 'The sort order. Default value: Asc. Valid values:'."\n" - ."\n" - .'* Asc: ascending.'."\n" - .'* Desc: descending.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Asc', - 'default' => 'Asc', - 'enum' => [ - 'Asc', - 'Desc', - ], - ], + 'schema' => ['description' => 'The sort order. Valid values:'."\n" + ."\n" + .'- Asc (default): ascending order.'."\n" + ."\n" + .'- Desc', 'type' => 'string', 'required' => false, 'example' => 'Asc', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '分页页码，默认为1', - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '分页大小，默认为10，最大为100', - 'description' => 'The number of records per page. Default: 10. Maximum: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], + 'schema' => ['description' => 'The number of records 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 response.'."\n", + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '9DD08926-38B9-XXXXXXX', - ], - 'Success' => [ - 'title' => '请求是否成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F05080B0-CCE6-5D22-B284-34A51C5D4E28'], 'PagingInfo' => [ - 'title' => '分页结果', - 'description' => 'The pagination result.'."\n", + 'description' => 'The pagination result.', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of records returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of records per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Databases' => [ - 'description' => 'The database list.'."\n", + 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'PageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of records per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Entities' => [ + 'description' => 'The list of entities in the collection.', 'type' => 'array', 'items' => [ - 'description' => 'The database information.'."\n", - '$ref' => '#/components/schemas/Database', + 'description' => 'The entity in the collection.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the entity. Currently, only the Table type is supported. If the entity is deleted, this field is empty.', 'type' => 'string', 'example' => 'maxcompute-table:::project_name:[schema_name]:table_name', 'title' => ''], + 'Type' => ['description' => 'The entity type.', 'type' => 'string', 'example' => 'maxcompute-table', 'title' => ''], + 'Name' => ['description' => 'The entity name.', 'type' => 'string', 'example' => 'test_table', 'title' => ''], + 'Comment' => ['description' => 'The entity comment.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1737078994080', 'title' => ''], + 'ModifyTime' => ['description' => 'The last modified time in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1737078994080', 'title' => ''], + 'Description' => ['description' => 'The description specified when the entity was added to the collection. Valid only for albums.', 'type' => 'string', 'example' => 'test', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F05080B0-CCE6-5D22-B284-34A51C5D4E28\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 1,\\n \\"Entities\\": [\\n {\\n \\"Id\\": \\"maxcompute-table:::project_name:[schema_name]:table_name\\",\\n \\"Type\\": \\"maxcompute-table\\",\\n \\"Name\\": \\"test_table\\",\\n \\"Comment\\": \\"test\\",\\n \\"CreateTime\\": 1737078994080,\\n \\"ModifyTime\\": 1737078994080,\\n \\"Description\\": \\"test\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListEntitiesInMetaCollection', + 'description' => '1. DataWorks Professional Edition or a higher edition is required.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9DD08926-38B9-XXXXXXX\\",\\n \\"Success\\": true,\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Databases\\": [\\n {\\n \\"Id\\": \\"holo-database:h-xxxx::test_db\\",\\n \\"Name\\": \\"test_db\\",\\n \\"Comment\\": \\"test comment\\",\\n \\"LocationUri\\": \\"oss://test-bucket/test_db\\",\\n \\"ParentMetaEntityId\\": \\"holo:h-xxxx\\",\\n \\"CreateTime\\": 1736852168000,\\n \\"ModifyTime\\": 1736852168000\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListDatabases', + 'ramActions' => [], ], - 'GetDatabase' => [ - 'summary' => 'Queries the information about a specific database in Data Map.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListFileVersions' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -30610,302 +32909,127 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'riskType' => 'none', - 'abilityTreeCode' => '267986', - 'abilityTreeNodes' => [ - 'FEATUREdideE9XYA6', - ], - ], - 'parameters' => [ - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'title' => 'ID', - 'description' => 'Database entity ID. You can refer to the response of the ListDatabases operation and [Concepts related to metadata entities](~~2880092~~).'."\n" - ."\n" - .'The format: `${EntityType}:${Instance ID or escaped URL}:${Catalog identifier}:${Database name}`. Use empty strings as placeholders for levels that do not exist.'."\n" - ."\n" - .'> For StarRocks, the catalog identifier is the catalog name. For DLF, the catalog identifier is the catalog ID. For other types, the catalog-level hierarchy is not supported, and an empty string can be used as a placeholder.'."\n" - ."\n" - .'Examples of common ID formats'."\n" - ."\n" - .'* `dlf-database::catalog_id:database_name`'."\n" - .'* `holo-database:instance_id::database_name`'."\n" - .'* `mysql-database:(instance_id|encoded_jdbc_url)::database_name`'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* `catalog_id`: The ID of the DLF catalog.'."\n" - ."\n" - .'* `instance_id`: The instance ID, which is required when the data source is registered in instance mode.'."\n" - ."\n" - .'* `encoded_jdbc_url`: The encoded JDBC connection string, which is required when the data source is registered in connection-string mode.'."\n" - ."\n" - .'* `database_name`: The database name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'mysql-database:rm-abc123xxx::test_db', - ], - ], - ], - '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' => '1AFAE64E-D1BE-432B-A9****', - ], - 'Success' => [ - 'title' => '请求是否成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Database' => [ - 'description' => 'The database details.'."\n", - '$ref' => '#/components/schemas/Database', - ], - ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AFAE64E-D1BE-432B-A9****\\",\\n \\"Success\\": true,\\n \\"Database\\": {\\n \\"Id\\": \\"holo-database:h-xxxx::test_db\\",\\n \\"Name\\": \\"test_db\\",\\n \\"Comment\\": \\"test comment\\",\\n \\"LocationUri\\": \\"oss://test-bucket/test_db\\",\\n \\"ParentMetaEntityId\\": \\"holo:h-xxxx\\",\\n \\"CreateTime\\": 1736852168000,\\n \\"ModifyTime\\": 1736852168000\\n }\\n}","type":"json"}]', - 'title' => 'GetDatabase', - ], - 'ListSchemas' => [ - 'summary' => 'Queries a list of schemas in a database or a MaxCompute project in Data Map. Only schemas of the MaxCompute and Hologres metadata crawler types are supported.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'abilityTreeCode' => '267987', - 'abilityTreeNodes' => [ - 'FEATUREdideE9XYA6', - ], + 'abilityTreeCode' => '269312', + 'abilityTreeNodes' => ['FEATUREdide8FM783'], ], 'parameters' => [ [ - 'name' => 'ParentMetaEntityId', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '父层级实体ID', - 'description' => 'The parent entity ID. For more information, see [Concepts related to metadata entities](~~2880092~~). For the Hologres metadata crawler type, you can call the ListDatabases operation to query the settings of the `ParentMetaEntityId` parameter.'."\n" - ."\n" - .'Configure the `ParentMetaEntityId` parameter in the `${EntityType}:${Instance ID or escaped URL}:${Catalog identifier}:${Database name}` format. If a level does not exist, leave the level empty.'."\n" - ."\n" - .'> If you want to query the information about a MaxCompute schema, specify an empty string at the Instance ID level as a placeholder and a MaxCompute project name at the Database name level. Make sure that the schema feature is enabled for the MaxCompute project.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'maxcompute-project:123456XXX::test_project'."\n" - .'holo-database:h-abc123xxx::test_db', - ], - ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'title' => '名称，模糊匹配', - 'description' => 'The name. Fuzzy match is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], - ], - [ - 'name' => 'Comment', - 'in' => 'query', - 'schema' => [ - 'title' => '注释，模糊匹配', - 'description' => 'The comment. Fuzzy match is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test comment', - ], - ], - [ - 'name' => 'Types', - 'in' => 'query', - 'style' => 'simple', - 'schema' => [ - 'title' => '类型，精确匹配，支持多项，按照逻辑或的关系查询', - 'description' => 'The types. Exact match is supported. If this parameter is left empty, all types are queried.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The schema type.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'MANAGED', - ], - 'required' => false, - ], + 'name' => 'FileId', + 'in' => 'formData', + 'schema' => ['description' => 'The file ID. You can call [ListFiles](~~173942~~) to query the file ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '100000001', 'title' => ''], ], [ - 'name' => 'SortBy', - 'in' => 'query', - 'schema' => [ - 'title' => '排序字段，默认为CreateTime', - 'description' => 'The field used for sorting. Default value: CreateTime. Valid values:'."\n" - ."\n" - .'* CreateTime'."\n" - .'* ModifyTime'."\n" - .'* Name'."\n" - .'* Type'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'CreateTime', - 'pattern' => '^[\\w.,;/@-]+$', - 'default' => 'CreateTime', - 'enum' => [ - 'CreateTime', - 'ModifyTime', - 'Name', - 'Type', - ], - ], + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The DataWorks workspace ID. To find this, click the wrench icon in the upper-right corner and navigate to the workspace management page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '100001', 'title' => ''], ], [ - 'name' => 'Order', - 'in' => 'query', - 'schema' => [ - 'title' => '排序方向，默认为Asc', - 'description' => 'The order in which schemas are sorted. Default value: Asc. Valid values:'."\n" - ."\n" - .'* Asc: ascending order'."\n" - .'* Desc: descending order'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Asc', - 'default' => 'Asc', - 'enum' => [ - 'Asc', - 'Desc', - ], - ], + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => ['description' => 'The unique identifier of the DataWorks workspace, which is the identifier at the top of the Data Studio page where you switch workspaces.'."\n" + ."\n" + .'Either this parameter or ProjectId must be specified to identify the target DataWorks workspace for this API call.', 'type' => 'string', 'required' => false, 'example' => 'dw_project', 'title' => ''], ], [ 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'title' => '分页页码，默认为1', - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The page number for pagination.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '分页大小，默认为10，最大为100', - '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', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'maximum' => '100', 'minimum' => '0', 'default' => '10', 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '235BBA5E-3428-XXXXXX', - ], - 'Success' => [ - 'title' => '请求是否成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'PagingInfo' => [ - '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 connection does not exist.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', '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 succeeded. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The list of file versions.', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageNumber' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Schemas' => [ - 'description' => 'The schemas.'."\n", + 'PageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '13', 'title' => ''], + 'FileVersions' => [ + 'description' => 'The list of file version details.', 'type' => 'array', 'items' => [ - 'description' => 'The schema.'."\n", - '$ref' => '#/components/schemas/Schema', + 'description' => 'The file version details.', + 'type' => 'object', + 'properties' => [ + 'FileContent' => ['description' => 'The file code for this version.', 'type' => 'string', 'example' => 'SHOW TABLES;', 'title' => ''], + 'Status' => ['description' => 'The current status of the file version. Valid values: COMMITTING (committing), COMMITTED or CHECK\\_OK (committed), PACKAGED (ready for deployment), DEPLOYING (deploying), DEPLOYED (deployed), and CANCELLED (deployment canceled).', 'type' => 'string', 'example' => 'COMMITTED', 'title' => ''], + 'IsCurrentProd' => ['description' => 'Indicates whether this file version is the latest version in the production environment.'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'CommitUser' => ['description' => 'The Alibaba Cloud account ID of the user who created this file version.', 'type' => 'string', 'example' => '73842342****'."\n", 'title' => ''], + 'NodeContent' => ['description' => 'The scheduling configuration for this file version.', 'type' => 'string', 'example' => '{"cycleType":0,"cronExpress":"00 05 00 * * ?"}', 'title' => ''], + 'Comment' => ['description' => 'The description of this file version.', 'type' => 'string', 'example' => 'Second version submission', 'title' => ''], + 'FilePropertyContent' => ['description' => 'The text information for this file version.', 'type' => 'string', 'example' => '{"fileName":"ods_user_info_d","fileType":10}', 'title' => ''], + 'FileName' => ['description' => 'The file name for this file version.', 'type' => 'string', 'example' => 'ods_user_info_d', 'title' => ''], + 'UseType' => ['description' => 'The functional module to which the file belongs. Valid values: NORMAL (Data Studio), MANUAL (manual task), MANUAL\\_BIZ (manual workflow), SKIP (dry-run scheduling in Data Studio), ADHOCQUERY (ad hoc query), and COMPONENT (component management).', 'type' => 'string', 'example' => 'NORMAL', 'title' => ''], + 'ChangeType' => ['description' => 'The change type for this file version. Valid values: CREATE, UPDATE, and DELETE.', 'type' => 'string', 'example' => 'UPDATE', 'title' => ''], + 'FileVersion' => ['description' => 'The file version.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'CommitTime' => ['description' => 'The timestamp (in milliseconds) when the file version was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1593881265000', 'title' => ''], + 'NodeId' => ['description' => 'The scheduling task ID associated with this file version.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"235BBA5E-3428-XXXXXX\\",\\n \\"Success\\": true,\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Schemas\\": [\\n {\\n \\"Id\\": \\"maxcompute-schema:123456::test_project:default\\",\\n \\"Name\\": \\"test_db\\",\\n \\"Comment\\": \\"test comment\\",\\n \\"Type\\": \\"MANAGED\\",\\n \\"ParentMetaEntityId\\": \\"maxcompute-project:123456::test_project\\",\\n \\"CreateTime\\": 1736852168000,\\n \\"ModifyTime\\": 1736852168000\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListSchemas', - ], - 'GetSchema' => [ - 'summary' => 'Queries the information about a schema in Data Map. You can call this API operation to query the information only about MaxCompute and Hologres schemas.', - '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.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', + '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\\",\\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"}]', + 'title' => 'ListFileVersions', + 'summary' => 'Queries a list of file versions.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'ListFiles' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -30915,331 +33039,223 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'riskType' => 'none', - 'abilityTreeCode' => '267988', - 'abilityTreeNodes' => [ - 'FEATUREdideE9XYA6', - ], + 'abilityTreeCode' => '267410', + 'abilityTreeNodes' => ['FEATUREdide8FM783'], ], 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'title' => 'ID', - 'description' => 'The ID. You can refer to the ListSchemas operation and [Concepts related to metadata entities](~~2880092~~).'."\n" - ."\n" - .'The format is `${EntityType}:${Instance ID or escaped URL}:${Catalog ID}:${Database name}:${Schema name}`. Use empty strings as placeholders for missing levels.'."\n" - ."\n" - .'> For the MaxCompute type, use an empty string as the placeholder for the instance ID level. The database name is the MaxCompute project name, and the project must have the three-level model enabled.'."\n" - ."\n" - .'Examples:'."\n" - ."\n" - .'`maxcompute-schema:::project_name:schema_name` (The three-level model is enabled for the MaxCompute project.)'."\n" - ."\n" - .'`holo-schema:instance_id::database_name:schema_name`'."\n" - ."\n" - .'> \\'."\n" - .'`instance_id`: The Hologres instance ID\\'."\n" - .'. `database_name`: The database name\\'."\n" - .'. `database_name`: The MaxCompute project name\\'."\n" - .'. `schema_name`: The schema name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'maxcompute-schema:123456XXX::test_project:default'."\n" - .'holo-schema:h-abc123xxx::test_db:test_schema', - ], + 'name' => 'FileFolderPath', + 'in' => 'formData', + 'schema' => ['description' => 'The path to the folder where the file is located.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Business_process/my_first_business_process/MaxCompute/ods_layer', 'title' => ''], ], - ], - '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' => 'A89B5D9D-74EA-XXXXXX', - ], - 'Success' => [ - 'title' => '请求是否成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Schema' => [ - 'description' => 'The schema information.'."\n", - '$ref' => '#/components/schemas/Schema', - ], - ], - ], + [ + '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 ID.'."\n" + ."\n" + .'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' => ''], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A89B5D9D-74EA-XXXXXX\\",\\n \\"Success\\": true,\\n \\"Schema\\": {\\n \\"Id\\": \\"maxcompute-schema:123456::test_project:default\\",\\n \\"Name\\": \\"test_db\\",\\n \\"Comment\\": \\"test comment\\",\\n \\"Type\\": \\"MANAGED\\",\\n \\"ParentMetaEntityId\\": \\"maxcompute-project:123456::test_project\\",\\n \\"CreateTime\\": 1736852168000,\\n \\"ModifyTime\\": 1736852168000\\n }\\n}","type":"json"}]', - 'title' => 'GetSchema', - 'description' => '1. This API operation is available for all DataWorks editions.'."\n" - .'2. You can call this API operation to query the information only about MaxCompute and Hologres schemas.'."\n", - ], - 'ListTables' => [ - 'summary' => 'Queries a list of tables in Data Map. For data source types that do not support schemas, you can call this API operation to query a list of tables in a specific database. For data source types that support schemas, you can call this API operation to query a list of tables in a specific database, MaxCompute project, or schema. Only the basic information about tables is returned. The information about technical metadata and business metadata is not returned.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'Keyword', + 'in' => 'formData', + 'schema' => ['description' => 'The keyword for the file name. Fuzzy match is supported. You can enter a keyword to query all files that contain the keyword.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'ods', 'title' => ''], ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '266735', - 'abilityTreeNodes' => [ - 'FEATUREdideE9OA4H', + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => ['description' => 'The DataWorks workspace name. To obtain the workspace name, log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and navigate to the workspace configuration page.'."\n" + ."\n" + .'You must specify either this parameter or ProjectId to identify the target DataWorks workspace for this API call.', 'type' => 'string', 'required' => false, 'example' => 'dw_project', 'title' => ''], ], - ], - 'parameters' => [ [ - 'name' => 'ParentMetaEntityId', - 'in' => 'query', - 'schema' => [ - 'title' => '父层级实体ID', - 'description' => 'The parent metadata entity ID. You can refer to the responses of the ListDatabases or ListSchemas operation and [Description of concepts related to metadata entities.](~~2880092~~)'."\n" - ."\n" - .'* The parent metadata entity is a database: The format of `ParentMetaEntityId` is `${EntityType}:${Instance ID or encoded URL}:${Catalog Identifier}:${Database Name}`. Use an empty string (\\`""\\`) as a placeholder for any non-existent level.'."\n" - .'* The parent metadata entity is a database schema: The format of `ParentMetaEntityId` is `${EntityType}:${Instance ID or encoded URL}:${Catalog Identifier}:${Database Name}:${Schema Name}`. Use an empty string (\\`""\\`) as a placeholder for any non-existent level.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* The schema level in `ParentMetaEntityId` is supported only for database services, such as `MaxCompute (with schema enabled), Hologres, PostgreSQL, SQL Server, HybridDB for PostgreSQL, and Oracle`.'."\n" - ."\n" - .'* For the MaxCompute and DLF types, use an empty string as the placeholder for the instance ID. For MaxCompute, the database name is the same as the project name.'."\n" - ."\n" - .'* For StarRocks, the catalog identifier is the catalog name. For DLF, it is the catalog ID. Other types do not support the catalog level and you can use an empty string as a placeholder.'."\n" - ."\n" - .'Examples of common ParentMetaEntityId formats'."\n" - ."\n" - .'* `maxcompute-project:::project_name`'."\n" - .'* `maxcompute-schema:::project_name:schema_name` (for MaxCompute projects with schema enabled)'."\n" - .'* `dlf-database::catalog_id:database_name`'."\n" - .'* `hms-database:instance_id::database_name`'."\n" - .'* `holo-schema:instance_id::database_name:schema_name`'."\n" - .'* `mysql-database:(instance_id|encoded_jdbc_url)::database_name`'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* `instance_id`: The instance ID, which is required when the data source is registered in instance mode.'."\n" - ."\n" - .'* `encoded_jdbc_url`: The URLEncoded JDBC connection string, which is requiredwhen the data source is registered using a connection string.'."\n" - ."\n" - .'* `catalog_id`: The DLF catalog ID.'."\n" - ."\n" - .'* `project_name`: The MaxCompute project name.'."\n" - ."\n" - .'* `database_name`: The database name.'."\n" - ."\n" - .'* `schema_name`: The schema name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'maxcompute-schema:123456XXX::test_project_with_schema:default'."\n" - .'maxcompute-project:123456XXX::test_project_without_schema'."\n" - .'dlf-database:123456XXX:test_catalog:test_db'."\n" - .'hms-database:c-abc123xxx::test_db'."\n" - .'holo-schema:h-abc123xxx::test_db:test_schema'."\n" - .'mysql-database:jdbc%3Amysql%3A%2F%2F127.0.0.1%3A3306%2Ftest_db::test_db', - ], + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => ['description' => 'The page number for pagination.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''], ], [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'title' => '名称', - 'description' => 'The name. Supports fuzzy matching.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abc', - ], + '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' => false, 'maximum' => '100', 'minimum' => '0', 'default' => '10', 'example' => '10', 'title' => ''], ], [ - 'name' => 'Comment', - 'in' => 'query', - 'schema' => [ - 'title' => '注释', - 'description' => 'The comment. Supports fuzzy matching.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'this is a comment'."\n", - ], + 'name' => 'UseType', + 'in' => 'formData', + 'schema' => ['description' => 'The functional module to which the file belongs. Valid values:'."\n" + ."\n" + .'- NORMAL: Data Studio'."\n" + ."\n" + .'- MANUAL: Manually triggered node'."\n" + ."\n" + .'- MANUAL\\_BIZ: Manually triggered workflow'."\n" + ."\n" + .'- SKIP: Dry-run scheduling in Data Studio'."\n" + ."\n" + .'- ADHOCQUERY: Ad hoc query'."\n" + ."\n" + .'- COMPONENT: Component management', 'type' => 'string', 'required' => false, 'example' => 'NORMAL', 'title' => ''], ], [ - 'name' => 'TableTypes', - 'in' => 'query', - 'style' => 'simple', - 'schema' => [ - 'title' => '表类型', - 'description' => 'The list of table types to query. If it\'s left empty, all types will be queried.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The table type. The value is related to the database type.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TABLE', - ], - 'required' => false, - ], + 'name' => 'FileTypes', + 'in' => 'formData', + 'schema' => ['description' => 'The code type of the file.'."\n" + ."\n" + .'The code type of the file. Common code types and their corresponding file types include: 6 (Shell), 10 (ODPS SQL), 11 (ODPS MR), 23 (Data Integration), 24 (ODPS Script), 97 (PAI), 98 (Combined node), 99 (Virtual node), 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 sync), 1002 (PAI internal node), 1089 (Cross-tenant node), 1091 (Hologres development), 1093 (Hologres SQL), 1100 (Assignment node), 1106 (ForEach node), 1221 (PyODPS 3).', 'type' => 'string', 'required' => false, 'example' => '10,23', 'title' => ''], ], [ - 'name' => 'SortBy', - 'in' => 'query', - 'schema' => [ - 'title' => '排序字段，默认为CreateTime', - 'description' => 'The sort field. Default value: CreateTime. Valid values:'."\n" - ."\n" - .'* CreateTime'."\n" - .'* ModifyTime'."\n" - .'* Name'."\n" - .'* TableType'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'CreateTime', - 'default' => 'CreateTime', - 'enum' => [ - 'CreateTime', - 'ModifyTime', - 'Name', - 'TableType', - ], - ], + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the file owner.', 'type' => 'string', 'required' => false, 'example' => '3726346****', 'title' => ''], ], [ - 'name' => 'Order', - 'in' => 'query', - 'schema' => [ - 'title' => '排序方向，默认为Asc', - 'description' => 'The order in which the tables are sorted. Default value: Asc. Valid values:'."\n" - ."\n" - .'* Asc'."\n" - .'* Desc'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Asc', - 'default' => 'Asc', - 'enum' => [ - 'Asc', - 'Desc', - ], - ], + 'name' => 'NodeId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the scheduling node. You can call the [ListNodes](~~173979~~) operation to obtain the node ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123541234', 'title' => ''], ], [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'title' => '分页页码，默认为1', - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'name' => 'NeedContent', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether the query result includes the file content. For files with large content, network transmission delays may occur.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '分页大小，默认为10，最大为100', - 'description' => 'The number of records per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], + 'name' => 'NeedAbsoluteFolderPath', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether the query result includes the path to the folder where the file is located.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'ExactFileName', + 'in' => 'formData', + 'schema' => ['description' => 'The exact file name. The file name in the query result must exactly match this parameter.', 'type' => 'string', 'required' => false, 'example' => 'ods_create.sql', 'title' => ''], + ], + [ + 'name' => 'FileIdIn', + 'in' => 'formData', + 'schema' => ['description' => 'The list of file IDs. The file IDs in the query result must be a subset of this list. You can specify up to 50 file IDs at a time.', 'type' => 'string', 'required' => false, 'example' => '78237,816123', 'title' => ''], + ], + [ + 'name' => 'LastEditUser', + 'in' => 'formData', + 'schema' => ['description' => 'The Alibaba Cloud account ID of the user who last updated the file.', 'type' => 'string', 'required' => false, 'example' => '11233***', 'title' => ''], + ], + [ + 'name' => 'CommitStatus', + 'in' => 'formData', + 'schema' => ['description' => 'The current commit status of the file. Valid values: 0 (the latest code is not committed) and 1 (the latest code is committed).', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response.'."\n", + 'description' => 'The response.', 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'E25887B7-579C-54A5-9C4F-83A****', - ], - 'Success' => [ - 'title' => '请求是否成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'PagingInfo' => [ - 'title' => '分页结果', - 'description' => 'The pagination result.'."\n", + 'properties' => [ + '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. 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 call succeeded. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The response details.', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of records returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of records per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Tables' => [ - 'title' => '数据表列表', - 'description' => 'The list of data tables.'."\n", + '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' => '13', 'title' => ''], + 'Files' => [ + 'description' => 'The file details.', 'type' => 'array', 'items' => [ - 'title' => '数据表详情', - 'description' => 'Data table details.'."\n", - '$ref' => '#/components/schemas/Table', + 'description' => 'The file information.', + 'type' => 'object', + 'properties' => [ + 'CommitStatus' => ['description' => 'The current commit status of the file. Valid values: 0 (the latest code is not committed) and 1 (the latest code is committed).', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'AutoParsing' => ['description' => 'Specifies whether automatic parsing is enabled for the file. Valid values:'."\n" + ."\n" + .'- true: The file automatically parses code.'."\n" + ."\n" + .'- false: The file does not automatically parse code.'."\n" + ."\n" + .'This parameter corresponds to Analyze Code when you set Dependencies to Same Cycle in the scheduling configuration of a Data Studio task in the [DataWorks console](https://workbench.data.aliyun.com/console).', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Owner' => ['description' => 'The Alibaba Cloud account ID of the file owner.', 'type' => 'string', 'example' => '3872572****', 'title' => ''], + 'CreateTime' => ['description' => 'The timestamp (in milliseconds) when the file was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1593950832000', 'title' => ''], + 'FileType' => ['description' => 'The file type. Different file types have different code. For more information, see [DataWorks node types](~~600169~~).', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'CurrentVersion' => ['description' => 'The latest version of the file.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'BizId' => ['description' => 'The ID of the workflow to which the file belongs. This parameter is deprecated. Use the BusinessId parameter instead.', 'type' => 'integer', 'format' => 'int64', 'example' => '300000', 'title' => ''], + 'LastEditUser' => ['description' => 'The Alibaba Cloud account ID of the user who last updated the file.', 'type' => 'string', 'example' => '382762****', 'title' => ''], + 'FileName' => ['description' => 'The file name.', 'type' => 'string', 'example' => 'ods_user_info_d', 'title' => ''], + 'ConnectionName' => ['description' => 'The data source name used by the task.', 'type' => 'string', 'example' => 'odps_source', 'title' => ''], + 'UseType' => ['description' => 'The functional module to which the file belongs. Valid values:'."\n" + ."\n" + .'- NORMAL: Data Studio'."\n" + ."\n" + .'- MANUAL: Manually triggered node'."\n" + ."\n" + .'- MANUAL\\_BIZ: Manually triggered workflow'."\n" + ."\n" + .'- SKIP: Dry-run scheduling in Data Studio'."\n" + ."\n" + .'- ADHOCQUERY: Ad hoc query'."\n" + ."\n" + .'- COMPONENT: Component management', 'type' => 'string', 'example' => 'NORMAL', 'title' => ''], + 'FileFolderId' => ['description' => 'The ID of the folder where the file is located.', 'type' => 'string', 'example' => '2735c2****', 'title' => ''], + 'FileId' => ['description' => 'The file ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '10000001', 'title' => ''], + 'ParentId' => ['description' => 'If the current file is an internal file of a combined node, this parameter specifies the ID of the corresponding combined node file.', 'type' => 'integer', 'format' => 'int64', 'example' => '-1', 'title' => ''], + 'CreateUser' => ['description' => 'The Alibaba Cloud account ID of the file creator.', 'type' => 'string', 'example' => '382762****', 'title' => ''], + 'IsMaxCompute' => ['description' => 'If the current file is a MaxCompute resource file, this parameter specifies whether the resource file needs to be uploaded to MaxCompute.'."\n" + ."\n" + .'You only need to configure this parameter when the file is a MaxCompute resource file.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'BusinessId' => ['description' => 'The ID of the workflow to which the file belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '300000', 'title' => ''], + 'FileDescription' => ['description' => 'The description of the file.', 'type' => 'string', 'example' => 'my test datastudio file', 'title' => ''], + 'LastEditTime' => ['description' => 'The timestamp (in milliseconds) when the file was last modified.', 'type' => 'integer', 'format' => 'int64', 'example' => '1593950832000', 'title' => ''], + 'Content' => ['description' => 'This parameter is deprecated. You can call the [GetFile](~~173954~~) operation to query this information.', 'type' => 'string', 'example' => 'SHOW TABLES;', 'title' => ''], + 'NodeId' => ['description' => 'The ID of the scheduling task generated in the scheduling system after the file is committed.', 'type' => 'integer', 'format' => 'int64', 'example' => '300001', 'title' => ''], + 'AbsoluteFolderPath' => ['description' => 'The path to the folder where the file is located.', 'type' => 'string', 'example' => 'Business_process/my_first_business_process/MaxCompute/ods_layer', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E25887B7-579C-54A5-9C4F-83A****\\",\\n \\"Success\\": true,\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Tables\\": [\\n {\\n \\"Id\\": \\"maxcompute-table:123456::test_project::test_tbl\\",\\n \\"Name\\": \\"test_tbl\\",\\n \\"Comment\\": \\"测试表\\",\\n \\"TableType\\": \\"TABLE\\",\\n \\"PartitionKeys\\": [\\n \\"ds\\"\\n ],\\n \\"ParentMetaEntityId\\": \\"maxcompute-project:123456::test_project\\",\\n \\"CreateTime\\": 1736852168000,\\n \\"ModifyTime\\": 1736852168000,\\n \\"TechnicalMetadata\\": {\\n \\"Owner\\": \\"123456789\\",\\n \\"Location\\": \\"oss://test-bucket/test_tbl\\",\\n \\"Compressed\\": false,\\n \\"InputFormat\\": \\"org.apache.hadoop.hive.ql.io.parquet.MapredParquetInputFormat\\",\\n \\"OutputFormat\\": \\"org.apache.hadoop.hive.ql.io.parquet.MapredParquetOutputFormat\\",\\n \\"SerializationLibrary\\": \\"org.apache.hadoop.hive.ql.io.parquet.serde.ParquetHiveSerDe\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n }\\n },\\n \\"BusinessMetadata\\": {\\n \\"Readme\\": \\"## 使用说明\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"tag_key\\",\\n \\"Value\\": \\"tag_value\\"\\n }\\n ],\\n \\"Categories\\": [\\n [\\n {\\n \\"Id\\": \\"CATEGORY.456\\",\\n \\"Name\\": \\"测试类目\\",\\n \\"ParentId\\": \\"CATEGORY.123\\"\\n }\\n ]\\n ],\\n \\"UpstreamTasks\\": [\\n {\\n \\"Id\\": 123456,\\n \\"Name\\": \\"test_task\\"\\n }\\n ],\\n \\"Extension\\": {\\n \\"ProjectId\\": 234,\\n \\"EnvType\\": \\"Dev\\",\\n \\"ViewCount\\": 0,\\n \\"ReadCount\\": 0,\\n \\"FavorCount\\": 0\\n }\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListTables', - ], - 'GetTable' => [ - 'summary' => 'Queries the information about a specific table in Data Map.', - '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.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', + '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 \\"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\\": \\"382762****\\",\\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}","type":"json"}]', + 'title' => 'ListFiles', + 'summary' => 'Queries a list of files.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'ListFolders' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -31249,181 +33265,111 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'riskType' => 'none', - 'abilityTreeCode' => '267394', - 'abilityTreeNodes' => [ - 'FEATUREdideE9XYA6', - ], + 'abilityTreeCode' => '268609', + 'abilityTreeNodes' => ['FEATUREdide8FM783'], ], 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID. You can refer to the response of the ListTables operation and the [concepts related to metadata entities.](~~2880092~~)'."\n" - ."\n" - .'The format: `${EntityType}:${Instance ID or escaped URL}:${Catalog identifier}:${Database name}:${Table name}`. Use empty strings as placeholders for levels that do not exist.'."\n" - ."\n" - .'> For the MaxCompute and DLF types, use an empty string as the placeholder for the instance ID.'."\n" - ."\n" - .'> The catalog identifier of the StarRocks is the catalog name, and the catalog identifier of the DLF type is the catalog ID. Other types do not support the catalog level. Use an empty string as a placeholder.'."\n" - ."\n" - .'> For MaxCompute, the database name refers to the MaxCompute project name. If the project has schema enabled, you must specify the schema name. Otherwise, use an empty string as the placeholder for the schema name.'."\n" - ."\n" - .'Examples of common ID formats'."\n" - ."\n" - .'`maxcompute-table:::project_name:[schema_name]:table_name`'."\n" - ."\n" - .'`dlf-table::catalog_id:database_name::table_name`'."\n" - ."\n" - .'`hms-table:instance_id::database_name::table_name`'."\n" - ."\n" - .'`holo-table:instance_id::database_name:schema_name:table_name`'."\n" - ."\n" - .'`mysql-table:(instance_id|encoded_jdbc_url)::database_name::table_name`'."\n" - ."\n" - .'> \\'."\n" - .'`instance_id`: The instance ID, required when the data source is registered in instance mode.\\'."\n" - .'`encoded_jdbc_url`: The URL-encoded JDBC connection string, which is required when the data source is registered via a connection string.\\'."\n" - .'`catalog_id`: The DLF catalog ID.\\'."\n" - .'`project_name`: The MaxCompute project name.\\'."\n" - .'`database_name`: The database name.\\'."\n" - .'`schema_name`: The schema name. For the MaxCompute type, this is required only if the project has enabled schema. Otherwise, use an empty string as a placeholder.\\'."\n" - .'`table_name`: The table name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'maxcompute-table:123456XXX::test_project::test_tbl'."\n" - .'dlf-table:123456XXX:test_catalog:test_db::test_tbl'."\n" - .'hms-table:c-abc123xxx::test_db::test_tbl'."\n" - .'holo-table:h-abc123xxx::test_db:test_schema:test_tbl', - ], + '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 specify either this parameter or the ProjectIdentifier parameter to identify the DataWorks workspace when you call this operation.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10000', 'title' => ''], ], [ - 'name' => 'IncludeBusinessMetadata', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to include metadata. Default: false.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '7B3435F4-2D91-XXX', - ], - 'Success' => [ - 'title' => '请求是否成功', - 'description' => 'Indicates whether the request succeeded.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Table' => [ - 'description' => 'Detailed information about the table.'."\n", - '$ref' => '#/components/schemas/Table', - ], - ], - ], + '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 query the workspace name. You must specify either this parameter or the ProjectId parameter to identify the DataWorks workspace when you call this operation.', 'type' => 'string', 'required' => false, 'example' => 'dw_project', 'title' => ''], ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7B3435F4-2D91-XXX\\",\\n \\"Success\\": true,\\n \\"Table\\": {\\n \\"Id\\": \\"maxcompute-table:123456::test_project::test_tbl\\",\\n \\"Name\\": \\"test_tbl\\",\\n \\"Comment\\": \\"测试表\\",\\n \\"TableType\\": \\"TABLE\\",\\n \\"PartitionKeys\\": [\\n \\"ds\\"\\n ],\\n \\"ParentMetaEntityId\\": \\"maxcompute-project:123456::test_project\\",\\n \\"CreateTime\\": 1736852168000,\\n \\"ModifyTime\\": 1736852168000,\\n \\"TechnicalMetadata\\": {\\n \\"Owner\\": \\"123456789\\",\\n \\"Location\\": \\"oss://test-bucket/test_tbl\\",\\n \\"Compressed\\": false,\\n \\"InputFormat\\": \\"org.apache.hadoop.hive.ql.io.parquet.MapredParquetInputFormat\\",\\n \\"OutputFormat\\": \\"org.apache.hadoop.hive.ql.io.parquet.MapredParquetOutputFormat\\",\\n \\"SerializationLibrary\\": \\"org.apache.hadoop.hive.ql.io.parquet.serde.ParquetHiveSerDe\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"\\"\\n }\\n },\\n \\"BusinessMetadata\\": {\\n \\"Readme\\": \\"## 使用说明\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"tag_key\\",\\n \\"Value\\": \\"tag_value\\"\\n }\\n ],\\n \\"Categories\\": [\\n [\\n {\\n \\"Id\\": \\"CATEGORY.456\\",\\n \\"Name\\": \\"测试类目\\",\\n \\"ParentId\\": \\"CATEGORY.123\\"\\n }\\n ]\\n ],\\n \\"UpstreamTasks\\": [\\n {\\n \\"Id\\": 123456,\\n \\"Name\\": \\"test_task\\"\\n }\\n ],\\n \\"Extension\\": {\\n \\"ProjectId\\": 234,\\n \\"EnvType\\": \\"Dev\\",\\n \\"ViewCount\\": 0,\\n \\"ReadCount\\": 0,\\n \\"FavorCount\\": 0\\n }\\n }\\n }\\n}","type":"json"}]', - 'title' => 'GetTable', - ], - 'UpdateTableBusinessMetadata' => [ - 'summary' => 'Updates the business metadata of a table in Data Map. Currently, only the usage notes of a table can be updated.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'abilityTreeCode' => '267996', - 'abilityTreeNodes' => [ - 'FEATUREdideE9XYA6', + 'name' => 'ParentFolderPath', + 'in' => 'formData', + 'schema' => ['description' => 'The path of the parent folder.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Business_process/my_first_business_process/MaxCompute', 'title' => ''], ], - ], - 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'PageNumber', 'in' => 'formData', - 'schema' => [ - 'title' => '数据表ID', - 'description' => 'The table ID. You can refer to the format of the table ID returned by the ListTables operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'maxcompute-table:123456XXX::test_project::test_tbl'."\n" - .'dlf-table:123456XXX:test_catalog:test_db::test_tbl'."\n" - .'hms-table:c-abc123xxx::test_db::test_tbl'."\n" - .'holo-table:h-abc123xxx::test_db:test_schema:test_tbl', - ], + 'schema' => ['description' => 'The page number of the request. Used for pagination.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'minimum' => '1', 'example' => '1', 'title' => ''], ], [ - 'name' => 'Readme', + 'name' => 'PageSize', 'in' => 'formData', - 'schema' => [ - 'title' => '使用说明', - 'description' => 'The usage notes. The rich text format is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '## introduction', - ], + 'schema' => ['description' => 'The number of records per page. Default value: 10. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'maximum' => '100', 'minimum' => '0', 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response.'."\n", + 'description' => 'Responses', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Request ID.'."\n", - 'type' => 'string', - 'example' => '7C352CB7-CD88-XXXXXXX', - ], - '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. Used to troubleshoot errors.', 'type' => 'string', 'example' => '0000-ABCD-****', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true: success.'."\n" + ."\n" + .'- false: failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The list of folders that meet the conditions.', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of records on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of records that meet the query conditions.', 'type' => 'integer', 'format' => 'int32', 'example' => '13', 'title' => ''], + 'Folders' => [ + 'description' => 'The list of folders.', + 'type' => 'array', + 'items' => [ + 'description' => 'The folder details.', + 'type' => 'object', + 'properties' => [ + 'FolderPath' => ['description' => 'The folder path.', 'type' => 'string', 'example' => 'Business_process/my_first_business_process/MaxCompute/ods_layer', 'title' => ''], + 'FolderId' => ['description' => 'The folder ID.', 'type' => 'string', 'example' => '2735c2****', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7C352CB7-CD88-XXXXXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'UpdateTableBusinessMetadata', - ], - 'ListColumns' => [ - 'summary' => 'Queries a list of fields in a data table in Data Map.', - '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.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', + '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' => 'Queries a list of folders.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'ListFunctions' => [ + 'summary' => 'Queries a list of user-defined functions (UDFs) in DataStudio. You can also specify filter conditions to query specific UDFs.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -31434,184 +33380,257 @@ 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', - 'abilityTreeCode' => '267999', - 'abilityTreeNodes' => [ - 'FEATUREdideE9XYA6', - ], + 'chargeType' => 'free', + 'abilityTreeCode' => '236015', + 'abilityTreeNodes' => ['FEATUREdideZOYJZL'], ], 'parameters' => [ [ - 'name' => 'TableId', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '数据表ID', - 'description' => 'The table ID. You can refer to the return result of the ListTables operation. and the [Concepts related to metadata entities](~~2880092~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'maxcompute-column:11075xxxx::test_project:test_schema:test_table', - ], - ], - [ - 'name' => 'Name', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'title' => '名称，模糊匹配', - 'description' => 'The name. Fuzzy match is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_table', - ], + '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.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12345', 'title' => ''], ], [ - 'name' => 'Comment', + 'name' => 'Owner', 'in' => 'query', - 'schema' => [ - 'title' => '注释，模糊匹配', - 'description' => 'The comment. Fuzzy match is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test comment', - ], + 'schema' => ['description' => 'The ID of the owner of the UDF. This parameter specifies a filter condition.', 'type' => 'string', 'required' => false, 'example' => '110755000425XXXX', 'title' => ''], ], [ - 'name' => 'SortBy', + 'name' => 'Type', 'in' => 'query', 'schema' => [ - 'title' => '排序字段，默认为CreateTime', - 'description' => 'The sort field. Default value: Position. Valid values:'."\n" + 'description' => 'The user-defined function (UDF) type. This parameter specifies a filter condition.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- Math: mathematical operation function'."\n" + ."\n" + .'- Aggregate: aggregate function'."\n" ."\n" - .'* Name'."\n" - .'* Position'."\n", + .'- String: string processing function'."\n" + ."\n" + .'- Date: date function'."\n" + ."\n" + .'- Analytic: window function'."\n" + ."\n" + .'- Other: other functions', + 'enumValueTitles' => [], 'type' => 'string', 'required' => false, - 'example' => 'Position', - 'default' => 'Position', - 'enum' => [ - 'Name', - 'Position', - ], + 'example' => 'Math', + 'title' => '', ], ], [ - 'name' => 'Order', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'title' => '排序方向，默认为Asc', - 'description' => 'The sort order. Default value: Asc. Valid values:'."\n" - ."\n" - .'* Asc'."\n" - .'* Desc'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Asc', - 'default' => 'Asc', - 'enum' => [ - 'Asc', - 'Desc', - ], - ], + 'schema' => ['description' => 'Filter criteria: UDF name. Supports fuzzy search.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '分页页码，默认为1', - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'The page number. Default value: 1. Minimum value: 1.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '2147483647', 'minimum' => '1', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '分页大小，默认为10，最大为100', - 'description' => 'The number of records per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], + 'schema' => ['description' => 'The page number. Default value: 1. Minimum value: 1.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '10', 'default' => '10', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response.'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx', - ], - 'Success' => [ - 'title' => '请求是否成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '89FB2BF0-EB00-5D03-9C34-05931001XXXX', 'title' => ''], 'PagingInfo' => [ - 'title' => '分页结果', - 'description' => 'The pagination result.'."\n", + 'description' => 'The pagination information.', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of records returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of records per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Columns' => [ - 'description' => 'The columns in the table.'."\n", + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '294', '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' => ''], + 'Functions' => [ + 'description' => 'The function list.', 'type' => 'array', 'items' => [ - 'description' => 'The column in the table.'."\n", - '$ref' => '#/components/schemas/Column', + 'description' => 'Information about the elements in the function list.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The UDF name.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'Function name'], + 'CreateTime' => ['description' => 'The timestamp when the UDF was created.', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '1655953028000'], + 'ProjectId' => ['description' => 'The ID of the project to which the UDF belongs.', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '307XXX'], + 'Owner' => ['description' => 'The owner of the UDF.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '110755000425XXXX'], + 'Type' => [ + 'description' => 'The UDF type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- Math: Mathematical operation functions'."\n" + ."\n" + .'- Aggregate: Aggregation functions'."\n" + ."\n" + .'- String: String processing functions'."\n" + ."\n" + .'- Date: Date functions'."\n" + ."\n" + .'- Analytic: Window functions'."\n" + ."\n" + .'- Other: Other functions', + 'enumValueTitles' => [], + 'type' => 'string', + 'deprecated' => false, + 'pattern' => '', + 'default' => '', + 'title' => '', + 'example' => 'Math', + ], + 'ModifyTime' => ['description' => 'The modification time.', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '1655953028000'."\n"], + 'ClassName' => ['description' => 'The fully qualified class name of the UDF.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'com.demo.Main'], + 'ArmResource' => ['description' => 'The list of resource files for the ARM cluster.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'xxx.jar,yyy.jar'], + 'FileResource' => ['description' => 'The implementation code of the function and the list of resource files.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'xxx.jar,yyy.jar'], + 'Description' => ['description' => 'The general description of the function.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'Description'], + 'CommandDescription' => ['description' => 'The command description.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'testUdf(xx,yy)'], + 'ParameterDescription' => ['description' => 'The parameter description.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'xx: parameter information XXX'."\n" + .'yy: parameter information YYY'], + 'ReturnValueDescription' => ['description' => 'The return value description.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'The return value is a string.'], + 'ExampleDescription' => ['description' => 'The example description.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'Example description >>> select tsetUdf(xx,yy);'."\n" + .'abc'], + 'EmbeddedCodeType' => [ + 'description' => 'The nested code type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- Python2'."\n" + ."\n" + .'- Python3'."\n" + ."\n" + .'- Java8'."\n" + ."\n" + .'- Java11'."\n" + ."\n" + .'- Java17', + 'enumValueTitles' => [], + 'type' => 'string', + 'deprecated' => false, + 'pattern' => '', + 'default' => '', + 'title' => '', + 'example' => 'Python2', + ], + 'EmbeddedResourceType' => [ + 'description' => 'The nested resource type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- File: General resource file.'."\n" + ."\n" + .'- Embedded: Embedded resource.', + 'enumValueTitles' => [], + 'type' => 'string', + 'deprecated' => false, + 'pattern' => '', + 'default' => '', + 'title' => '', + 'example' => 'File', + ], + 'EmbeddedCode' => ['description' => 'Content of the nested function code', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'print(\'hello,world!\')'], + 'DatabaseName' => ['description' => 'The database name. This parameter is used only when the function type is EMR Function.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'EMR_lake'], + 'DataSource' => [ + 'title' => '', + 'description' => 'Data source information of the UDF.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the data source.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'odps_first'], + 'Type' => ['description' => 'The type of the data source.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'odps'], + ], + 'deprecated' => false, + 'example' => '', + ], + 'Script' => [ + 'title' => '', + 'description' => 'Script information of the UDF.', + 'type' => 'object', + 'properties' => [ + 'Path' => ['description' => 'The script path.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'XXX/OpenAPI/function/function_name'], + 'Runtime' => [ + 'title' => '', + 'description' => 'Runtime', + 'type' => 'object', + 'properties' => [ + 'Command' => ['description' => 'Command', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'ODPS_FUNCTION'], + ], + 'deprecated' => false, + 'example' => '', + ], + 'Id' => ['description' => 'The ID of the script.'."\n" + ."\n" + .'> This field is of type Long in SDK versions prior to 8.0.0, and of type String in SDK version 8.0.0 and later. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. However, compilation failures may occur due to the type change only when upgrading the SDK across version 8.0.0. In this case, you must manually update the data type.', 'type' => 'string', 'deprecated' => false, 'example' => '652567824470354XXXX', 'title' => ''], + ], + 'deprecated' => false, + 'required' => false, + 'example' => '', + ], + 'RuntimeResource' => [ + 'title' => '', + 'description' => 'The runtime resource group information.', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupId' => ['description' => 'The runtime resource group ID.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'S_resgrop_xxx'], + ], + 'deprecated' => false, + 'example' => '', + ], + 'Id' => ['description' => 'The unique identifier of the UDF.'."\n" + ."\n" + .'> Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.', 'type' => 'string', 'example' => '580667964888595XXXX', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"89FB2BF0-EB00-5D03-9C34-05931001XXXX\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 294,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Functions\\": [\\n {\\n \\"Name\\": \\"Function name\\",\\n \\"CreateTime\\": 1655953028000,\\n \\"ProjectId\\": 0,\\n \\"Owner\\": \\"110755000425XXXX\\",\\n \\"Type\\": \\"Math\\",\\n \\"ModifyTime\\": 1655953028000,\\n \\"ClassName\\": \\"com.demo.Main\\",\\n \\"ArmResource\\": \\"xxx.jar,yyy.jar\\",\\n \\"FileResource\\": \\"xxx.jar,yyy.jar\\",\\n \\"Description\\": \\"Description\\",\\n \\"CommandDescription\\": \\"testUdf(xx,yy)\\",\\n \\"ParameterDescription\\": \\"xx: parameter information XXX\\\\nyy: parameter information YYY\\",\\n \\"ReturnValueDescription\\": \\"The return value is a string.\\",\\n \\"ExampleDescription\\": \\"Example description >>> select tsetUdf(xx,yy);\\\\nabc\\",\\n \\"EmbeddedCodeType\\": \\"Python2\\",\\n \\"EmbeddedResourceType\\": \\"File\\",\\n \\"EmbeddedCode\\": \\"print(\'hello,world!\')\\",\\n \\"DatabaseName\\": \\"EMR_lake\\",\\n \\"DataSource\\": {\\n \\"Name\\": \\"odps_first\\",\\n \\"Type\\": \\"odps\\"\\n },\\n \\"Script\\": {\\n \\"Path\\": \\"XXX/OpenAPI/function/function_name\\",\\n \\"Runtime\\": {\\n \\"Command\\": \\"ODPS_FUNCTION\\"\\n },\\n \\"Id\\": \\"652567824470354XXXX\\"\\n },\\n \\"RuntimeResource\\": {\\n \\"ResourceGroupId\\": \\"S_resgrop_xxx\\"\\n },\\n \\"Id\\": \\"580667964888595XXXX\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListFunctions', + 'changeSet' => [ + ['createdAt' => '2025-01-13T07:36:00.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx\\",\\n \\"Success\\": true,\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Columns\\": [\\n {\\n \\"Id\\": \\"maxcompute-column:123456::test_project:default:test_tbl:col1\\",\\n \\"Name\\": \\"col1\\",\\n \\"Comment\\": \\"字段1\\",\\n \\"TableId\\": \\"maxcompute-table:123456::test_project:default:test_tbl\\",\\n \\"Position\\": 1,\\n \\"Type\\": \\"bigint\\",\\n \\"PrimaryKey\\": false,\\n \\"PartitionKey\\": false,\\n \\"ForeignKey\\": false,\\n \\"BusinessMetadata\\": {\\n \\"Description\\": \\"字段1的业务描述\\"\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListColumns', - ], - 'GetColumn' => [ - 'summary' => 'Queries the information about a specific field of a table in Data Map.', - 'methods' => [ - 'get', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListImageAssociatedProjects' => [ + 'summary' => 'Lists the workspaces associated with an image.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -31620,172 +33639,265 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', - 'abilityTreeCode' => '268005', - 'abilityTreeNodes' => [ - 'FEATUREdideE9XYA6', - ], + 'chargeType' => 'free', + 'abilityTreeCode' => '245182', + 'abilityTreeNodes' => ['FEATUREdide2SV6DS'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'title' => 'ID', - 'description' => 'The ID. You can refer to the response of the ListColumns operation and the [description of concepts related to metadata entities.](~~2880092~~)'."\n" - ."\n" - .'The format: `${EntityType}:${Instance ID or escaped URL}:${Catalog identifier}:${Database name}:${Schema name}:${Table name}:${Column name}`. Use empty strings as placeholders for levels that do not exist.'."\n" - ."\n" - .'> For the MaxCompute and DLF types, use an empty string as the placeholder for the instance ID. For MaxCompute, the database name refers to the MaxCompute project name. If the project has schema enabled, you must specify the schema name. Otherwise, use an empty string as the placeholder for the schema name.'."\n" - ."\n" - .'> The catalog identifier of the StarRocks is the catalog name, and the catalog identifier of the DLF type is the catalog ID. Other types do not support catalog levels. Use empty strings as placeholders.'."\n" - ."\n" - .'Examples of common ID formats'."\n" - ."\n" - .'`maxcompute-column:::project_name:[schema_name]:table_name:column_name`'."\n" - ."\n" - .'`dlf-column::catalog_id:database_name::table_name:column_name`'."\n" - ."\n" - .'`hms-column:instance_id::database_name::table_name:column_name`'."\n" - ."\n" - .'`holo-column:instance_id::database_name:schema_name:table_name:column_name`'."\n" - ."\n" - .'`mysql-column:(instance_id|encoded_jdbc_url)::database_name::table_name:column_name`'."\n" - ."\n" - .'> \\'."\n" - .'`instance_id`: the ID of the instance, which is required when the data source is registered in instance mode.\\'."\n" - .'`encoded_jdbc_url`: The URL-encoded JDBC connection string, which is required when the data source is registered via a connection string.\\'."\n" - .'`catalog_id`: The DLF catalog ID.\\'."\n" - .'`project_name`: The MaxCompute project name.\\'."\n" - .'`database_name`: The database name.\\'."\n" - .'`schema_name`: The schema name. For the MaxCompute type, this is required only if the project has enabled schema; otherwise, use an empty string as a placeholder.\\'."\n" - .'`table_name`: The table name.\\'."\n" - .'`column_name`: The field name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'maxcompute-column:11075xxxx::test_project:test_schema:test_table:test_column', - ], + 'schema' => ['description' => 'The ID of the image.', 'type' => 'string', 'required' => true, 'example' => 'Custom_image_xxxx_xxxx', 'title' => ''], ], ], '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' => 'D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx', - ], - 'Success' => [ - 'title' => '请求是否成功', - 'description' => 'Indicates whether the request succeeded.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Column' => [ - 'description' => 'The columns in the table.'."\n", - '$ref' => '#/components/schemas/Column', + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'example' => 'true'], + 'Data' => [ + 'type' => 'array', + 'items' => ['description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '100000001', 'title' => ''], + 'title' => '', + 'description' => 'An array of project IDs for the associated workspaces.', + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', 'title' => ''], ], + 'title' => '', + 'description' => 'The response data.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListImageAssociatedProjects', + 'description' => '1. You must purchase DataWorks Basic Edition or higher to call this operation.'."\n" + ."\n" + .'2. **Before you call this operation, ensure that the AliyunServiceRoleForDataWorks service-linked role is created.**', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx\\",\\n \\"Success\\": true,\\n \\"Column\\": {\\n \\"Id\\": \\"maxcompute-column:123456::test_project:default:test_tbl:col1\\",\\n \\"Name\\": \\"col1\\",\\n \\"Comment\\": \\"字段1\\",\\n \\"TableId\\": \\"maxcompute-table:123456::test_project:default:test_tbl\\",\\n \\"Position\\": 1,\\n \\"Type\\": \\"bigint\\",\\n \\"PrimaryKey\\": false,\\n \\"PartitionKey\\": false,\\n \\"ForeignKey\\": false,\\n \\"BusinessMetadata\\": {\\n \\"Description\\": \\"字段1的业务描述\\"\\n }\\n }\\n}","type":"json"}]', - 'title' => 'GetColumn', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"Data\\": [\\n 100000001\\n ],\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]', ], - 'UpdateColumnBusinessMetadata' => [ - 'summary' => 'Updates the business metadata of a column in a table in Data Map. Only the business description of a column can be updated.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListImageVersions' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'list', 'riskType' => 'none', - 'abilityTreeCode' => '268008', - 'abilityTreeNodes' => [ - 'FEATUREdideE9XYA6', - ], + 'chargeType' => 'free', + 'abilityTreeCode' => '245169', + 'abilityTreeNodes' => ['FEATUREdide2SV6DS'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'Id', - 'in' => 'formData', - 'schema' => [ - 'title' => 'ID', - 'description' => 'The field ID. You can refer to the response from the ListColumns operation. You can also refer to the [Concepts related to metadata entities](~~2880092~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'maxcompute-column:11075xxxx::test_project:test_schema:test_table:test_column', - ], + 'in' => 'query', + 'schema' => ['description' => 'The image ID.', 'type' => 'string', 'required' => true, 'example' => 'Custom_image_xxxx_xxxx', 'title' => ''], ], [ - 'name' => 'Description', - 'in' => 'formData', - 'schema' => [ - 'title' => '字段业务描述', - 'description' => 'The field business description.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test description', - ], + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1', 'title' => '', 'required' => false], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '10', 'title' => '', 'required' => false], ], ], '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' => 'D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx', - ], - 'Success' => [ - 'title' => '请求是否成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Success' => ['description' => 'Indicates whether the request succeeded.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'PagingInfo' => [ + 'type' => 'object', + 'properties' => [ + 'ImageVersions' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The image ID.', 'type' => 'string', 'example' => 'Custom_image_xxxx_xxxx', 'title' => ''], + 'Name' => ['description' => 'The image name.', 'type' => 'string', 'example' => 'dataworks_image', 'title' => ''], + 'Version' => ['description' => 'The image version.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Description' => ['description' => 'The image description.', 'type' => 'string', 'example' => 'Test image created by xxx', 'title' => ''], + 'Creator' => ['description' => 'The ID of the user who created the image.', 'type' => 'string', 'example' => '123', 'title' => ''], + 'Modifier' => ['description' => 'The ID of the user who last modified the image.', 'type' => 'string', 'example' => '123', 'title' => ''], + 'CreatedTime' => ['description' => 'The time when the image was created, as a 64-bit timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1727055811000', 'title' => ''], + 'LastModifiedTime' => ['description' => 'The time when the image was last modified, as a 64-bit timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1727055811000', 'title' => ''], + 'Official' => ['description' => 'Indicates whether the image is an official image.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Accessibility' => ['description' => 'The accessibility of the image. Valid values:'."\n" + ."\n" + .'- `Public`: The image is visible to all users.'."\n" + ."\n" + .'- `Private`: The image is visible only to the creator.', 'type' => 'string', 'title' => '', 'example' => 'Public'], + 'Status' => ['description' => 'The status of the image. Valid values:'."\n" + ."\n" + .'- `Disabled`: The image is disabled.'."\n" + ."\n" + .'- `Expired`: The image is expired.'."\n" + ."\n" + .'- `Available`: The image is available.'."\n" + ."\n" + .'- `ReadOnly`: The image is read-only.', 'type' => 'string', 'example' => 'Available', 'title' => ''], + 'PublishStage' => ['description' => 'The publishing stage of the image. Valid values:'."\n" + ."\n" + .'- `Untest`: Not tested.'."\n" + ."\n" + .'- `Testing`: Being tested.'."\n" + ."\n" + .'- `TestFailed`: Test failed.'."\n" + ."\n" + .'- `Unpublished`: Not published.'."\n" + ."\n" + .'- `Publishing`: Being published.'."\n" + ."\n" + .'- `Published`: Published.'."\n" + ."\n" + .'- `PublishFailed`: Publishing failed.'."\n" + ."\n" + .'- `Building`: Being built.'."\n" + ."\n" + .'- `BuildSuccess`: Build succeeded.'."\n" + ."\n" + .'- `BuildFailed`: Build failed.'."\n" + ."\n" + .'- `Accelerating`: Being accelerated.'."\n" + ."\n" + .'- `AccelerateSuccess`: Acceleration succeeded.'."\n" + ."\n" + .'- `AccelerateFailed`: Acceleration failed.', 'type' => 'string', 'example' => 'Published', 'title' => ''], + 'Supported' => [ + 'type' => 'object', + 'properties' => [ + 'Module' => ['description' => 'The supported module. Valid value:'."\n" + ."\n" + .'- `Scheduler`: The scheduler module.', 'type' => 'string', 'example' => 'Scheduler', 'title' => ''], + 'TaskTypes' => [ + 'type' => 'array', + 'items' => ['description' => 'The supported task type. Valid values:'."\n" + ."\n" + .'- Shell'."\n" + ."\n" + .'- Python'."\n" + ."\n" + .'- ServerIDE'."\n" + ."\n" + .'- Notebook'."\n" + ."\n" + .'- PyODPS 2'."\n" + ."\n" + .'- PyODPS 3', 'type' => 'string', 'title' => '', 'example' => 'Shell'], + 'title' => '', + 'description' => 'The supported task types.', + 'example' => '', + ], + ], + 'title' => '', + 'description' => 'The supported modules and task types.', + 'example' => '', + ], + 'IsDefault' => ['description' => 'Indicates whether the image is the default image.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'EnableSyncMaxCompute' => ['description' => 'Indicates whether MaxCompute synchronization is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'ProviderType' => ['description' => 'The type of the image provider. Valid values:'."\n" + ."\n" + .'- `ACR`: The image is from an ACR repository.'."\n" + ."\n" + .'- `DataWorks`: The image is an official image provided by DataWorks.', 'type' => 'string', 'example' => 'ACR', 'title' => ''], + 'ProviderImageId' => ['description' => 'The ID of the image from the provider.', 'type' => 'string', 'example' => 'acr_image_id', 'title' => ''], + 'ImageUri' => ['description' => 'The image URI.', 'type' => 'string', 'example' => 'registry.cn-hangzhou.aliyuncs.com/xxx/xxx:tag', 'title' => ''], + 'Namespace' => ['description' => 'The namespace.', 'type' => 'string', 'example' => 'namespace', 'title' => ''], + 'Size' => ['description' => 'The image size.', 'type' => 'string', 'example' => '1GB', 'title' => ''], + 'AcrInstanceId' => ['description' => 'The ACR instance ID.', 'type' => 'string', 'example' => 'cri-xxx', 'title' => ''], + 'ImageTag' => ['description' => 'The image tag.', 'type' => 'string', 'example' => 'v1.0.0', 'title' => ''], + 'RepositoryName' => ['description' => 'The repository name.', 'type' => 'string', 'example' => 'repo_name', 'title' => ''], + 'ImageVpcUri' => ['description' => 'The VPC URI of the image.', 'type' => 'string', 'example' => 'registry-vpc.cn-hangzhou.aliyuncs.com/xxx/xxx:tag', 'title' => ''], + 'AcrEndpoint' => ['description' => 'The ACR endpoint.', 'type' => 'string', 'example' => 'registry.cn-hangzhou.aliyuncs.com', 'title' => ''], + 'AcrAssociatedVpcId' => ['description' => 'The ID of the VPC associated with the ACR instance.', 'type' => 'string', 'example' => 'vpc-xxx', 'title' => ''], + 'BuildConfig' => [ + 'type' => 'object', + 'properties' => [ + 'BuildType' => ['description' => 'The build type.', 'type' => 'string', 'example' => 'PackageInstallation', 'title' => ''], + 'PackageInstallationScripts' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The script type.', 'type' => 'string', 'example' => 'Python3', 'title' => ''], + 'Content' => ['description' => 'The script content. Separate multiple package names with a comma (,).', 'type' => 'string', 'example' => 'requests', 'title' => ''], + ], + 'description' => 'A pre-installation script.', + 'title' => '', + 'example' => '', + ], + 'description' => 'The pre-installation scripts.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The image build configuration.', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'description' => 'The details of the image version.', + 'example' => '', + ], + 'title' => '', + 'description' => 'A list of image version details.', + 'example' => '', + ], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + ], + 'title' => '', + 'description' => 'The pagination details.', + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID, used to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', 'title' => ''], ], + 'title' => '', + 'description' => 'The response schema.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListImageVersions', + 'summary' => 'Gets the details of a specified image version.', + 'description' => '1. To use this API, you must purchase DataWorks Basic Edition or a later edition.'."\n" + ."\n" + .'2. **Ensure you create the service-linked role AliyunServiceRoleForDataWorks before you call this API.**', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'UpdateColumnBusinessMetadata', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"PagingInfo\\": {\\n \\"ImageVersions\\": [\\n {\\n \\"Id\\": \\"Custom_image_xxxx_xxxx\\",\\n \\"Name\\": \\"dataworks_image\\",\\n \\"Version\\": \\"1\\",\\n \\"Description\\": \\"Test image created by xxx\\",\\n \\"Creator\\": \\"123\\",\\n \\"Modifier\\": \\"123\\",\\n \\"CreatedTime\\": 1727055811000,\\n \\"LastModifiedTime\\": 1727055811000,\\n \\"Official\\": true,\\n \\"Accessibility\\": \\"Public\\",\\n \\"Status\\": \\"Available\\",\\n \\"PublishStage\\": \\"Published\\",\\n \\"Supported\\": {\\n \\"Module\\": \\"Scheduler\\",\\n \\"TaskTypes\\": [\\n \\"Shell\\"\\n ]\\n },\\n \\"IsDefault\\": false,\\n \\"EnableSyncMaxCompute\\": false,\\n \\"ProviderType\\": \\"ACR\\",\\n \\"ProviderImageId\\": \\"acr_image_id\\",\\n \\"ImageUri\\": \\"registry.cn-hangzhou.aliyuncs.com/xxx/xxx:tag\\",\\n \\"Namespace\\": \\"namespace\\",\\n \\"Size\\": \\"1GB\\",\\n \\"AcrInstanceId\\": \\"cri-xxx\\",\\n \\"ImageTag\\": \\"v1.0.0\\",\\n \\"RepositoryName\\": \\"repo_name\\",\\n \\"ImageVpcUri\\": \\"registry-vpc.cn-hangzhou.aliyuncs.com/xxx/xxx:tag\\",\\n \\"AcrEndpoint\\": \\"registry.cn-hangzhou.aliyuncs.com\\",\\n \\"AcrAssociatedVpcId\\": \\"vpc-xxx\\",\\n \\"BuildConfig\\": {\\n \\"BuildType\\": \\"PackageInstallation\\",\\n \\"PackageInstallationScripts\\": [\\n {\\n \\"Type\\": \\"Python3\\",\\n \\"Content\\": \\"requests\\"\\n }\\n ]\\n }\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10\\n },\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]', ], - 'ListDatasets' => [ - 'summary' => 'Queries a list of datasets. Currently, DataWorks datasets and PAI datasets are supported.', - 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListImages' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -31797,319 +33909,416 @@ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdideXGTG91', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], - 'parameters' => [ - [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'DataWorks工作空间ID', - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '251363', - ], - ], - [ - 'name' => 'Origin', - 'in' => 'formData', - 'schema' => [ - 'title' => '数据集来源，取值有'."\n" - .'- DataWorks'."\n" - .'- PAI', - 'description' => 'The dataset source. Valid values:'."\n" - ."\n" - .'* DataWorks'."\n" - .'* PAI'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'DataWorks', - ], - ], + 'abilityTreeCode' => '245169', + 'abilityTreeNodes' => ['FEATUREdide2SV6DS'], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ [ 'name' => 'Name', - 'in' => 'formData', - 'schema' => [ - 'title' => '数据集名称，支持模糊搜索', - 'description' => 'The dataset name. Supports fuzzy search.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test_dataset', - ], + 'in' => 'query', + 'schema' => ['description' => 'The image name, used for fuzzy search.', 'type' => 'string', 'example' => 'image', 'title' => '', 'required' => false], ], [ - 'name' => 'DataTypeList', - 'in' => 'formData', - 'style' => 'simple', + 'name' => 'Statuses', + 'in' => 'query', + 'allowEmptyValue' => true, + 'style' => 'json', 'schema' => [ - 'title' => '数据类型，可多选，当前支持'."\n" - .'- COMMON 通用'."\n" - .'- PIC 图片'."\n" - .'- TEXT 文本'."\n" - .'- TABLE 表格'."\n" - .'- VIDEO 视频'."\n" - .'- AUDIO 音频'."\n" - .'- INDEX 索引', - 'description' => 'The data type. Multiple selections are allowed. Valid values:'."\n" - ."\n" - .'* COMMON'."\n" - .'* PIC'."\n" - .'* TEXT'."\n" - .'* TABLE'."\n" - .'* VIDEO'."\n" - .'* AUDIO'."\n" - .'* INDEX'."\n", 'type' => 'array', 'items' => [ - 'description' => 'Data types'."\n" + 'description' => 'The image status:'."\n" ."\n" - .'Valid values:'."\n" + .'- Disabled: The image is disabled.'."\n" + ."\n" + .'- Expired: The image has expired.'."\n" ."\n" - .'* TABLE: Table.'."\n" - .'* VIDEO: Video.'."\n" - .'* COMMON: Common.'."\n" - .'* TEXT: Text.'."\n" - .'* PIC: Image.'."\n" - .'* INDEX: Index.'."\n" - .'* AUDIO: Audio.'."\n", + .'- Available: The image is available.'."\n" + ."\n" + .'- ReadOnly: The image is read-only.', 'type' => 'string', + 'example' => 'Enabled', + 'enum' => ['Disabled', 'Expired', 'Available', 'ReadOnly'], + 'title' => '', 'required' => false, - 'enumValueTitles' => [ - 'TABLE' => '', - 'VIDEO' => '', - 'COMMON' => '', - 'TEXT' => '', - 'PIC' => '', - 'INDEX' => '', - 'AUDIO' => '', - ], - 'example' => 'COMMON', ], + 'title' => '', + 'description' => 'The list of image statuses to query.', 'required' => false, - 'maxItems' => 10, - 'minItems' => 0, + 'example' => '', ], ], [ - 'name' => 'StorageTypeList', - 'in' => 'formData', - 'style' => 'simple', + 'name' => 'Stages', + 'in' => 'query', + 'allowEmptyValue' => true, + 'style' => 'json', 'schema' => [ - 'title' => '存储类型，可多选，当前支持'."\n" - .'- OSS 对象存储'."\n" - .'- NAS 通用型NAS文件存储'."\n" - .'- EXTREMENAS 极速型NAS文件存储'."\n" - .'- DLF_LANCE 数据湖构建'."\n" - .'- CPFS CPFS文件存储'."\n" - .'- BMCPFS 智算CPFS文件存储'."\n" - .'- MAXCOMPUTE MaxCompute表', - 'description' => 'The storage type. Multiple selections are allowed. Supported values:'."\n" - ."\n" - .'* OSS'."\n" - .'* NAS: General-purpose NAS file systems'."\n" - .'* EXTREMENAS: Extreme NAS file systems'."\n" - .'* DLF_LANCE: Data Lake Formation'."\n" - .'* CPFS: Cloud Parallel File Storage'."\n" - .'* BMCPFS: CPFS for Lingjun'."\n" - .'* MAXCOMPUTE: MaxCompute table'."\n", 'type' => 'array', 'items' => [ - 'description' => 'The storage type.'."\n", + 'description' => 'The publish stage:'."\n" + ."\n" + .'- Untest: Not tested.'."\n" + ."\n" + .'- Testing: Being tested.'."\n" + ."\n" + .'- TestFailed: Test failed.'."\n" + ."\n" + .'- Unpublished: Not published.'."\n" + ."\n" + .'- Publishing: Being published.'."\n" + ."\n" + .'- Published: Published.'."\n" + ."\n" + .'- PublishFailed: Publish failed.'."\n" + ."\n" + .'- Building: Being built.'."\n" + ."\n" + .'- BuildSuccess: Build succeeded.', 'type' => 'string', + 'example' => 'Published', + 'enum' => ['Untest', 'Testing', 'TestFailed', 'Unpublished', 'Publishing', 'Published', 'PublishFailed', 'Building', 'BuildSuccess', 'BuildFailed', 'Accelerating', 'AccelerateSuccess', 'AccelerateFailed'], + 'title' => '', 'required' => false, - 'example' => 'NAS', ], + 'title' => '', + 'description' => 'The list of image publish stages to query.', 'required' => false, - 'enumValueTitles' => [ - 'NAS' => '', - 'MAXCOMPUTE' => '', - 'CPFS' => '', - 'BMCPFS' => '', - 'EXTREMENAS' => '', - 'OSS' => '', - 'DLF_LANCE' => '', - ], - 'maxItems' => 10, - 'minItems' => 0, + 'example' => '', ], ], [ - 'name' => 'CreatorId', - 'in' => 'formData', + 'name' => 'Accessibility', + 'in' => 'query', 'schema' => [ - 'title' => '创建者ID', - 'description' => 'The creator ID.'."\n", + 'description' => 'The accessibility:'."\n" + ."\n" + .'- Public: Visible to all members.'."\n" + ."\n" + .'- Private: Visible only to the creator.', + 'enumValueTitles' => [], 'type' => 'string', + 'title' => '', 'required' => false, - 'example' => '12103XXX46492139', + 'example' => 'Public', ], ], [ - 'name' => 'SortBy', - 'in' => 'formData', + 'name' => 'ProjectIds', + 'in' => 'query', + 'allowEmptyValue' => true, + 'style' => 'json', 'schema' => [ - 'title' => '排序字段', - 'description' => 'The sort field. Default: CreateTime.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* ModifyTime: Modification time.'."\n" - .'* CreateTime: Creation time.'."\n" - .'* Name'."\n", - 'type' => 'string', + 'type' => 'array', + 'items' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'required' => false, 'example' => '10001'], + 'title' => '', + 'description' => 'The list of workspace IDs.', 'required' => false, - 'enumValueTitles' => [ - 'ModifyTime' => '', - 'CreateTime' => '', - 'Name' => '', - ], - 'example' => 'CreateTime', - 'default' => 'CreateTime', - 'enum' => [ - 'Name', - 'CreateTime', - 'ModifyTime', + 'example' => '', + ], + ], + [ + 'name' => 'SupportedModules', + 'in' => 'query', + 'allowEmptyValue' => true, + 'style' => 'json', + 'schema' => [ + 'type' => 'array', + 'items' => [ + 'description' => 'The supported module:'."\n" + ."\n" + .'- Scheduler: Scheduling.', + 'type' => 'string', + 'example' => 'Scheduler', + 'enum' => ['Scheduler'], + 'title' => '', + 'required' => false, ], + 'title' => '', + 'description' => 'The list of supported modules.', + 'required' => false, + 'example' => '', ], ], [ - 'name' => 'Order', - 'in' => 'formData', + 'name' => 'SupportedTaskTypes', + 'in' => 'query', + 'allowEmptyValue' => true, + 'style' => 'json', 'schema' => [ - 'title' => '排序方向', - 'description' => 'The sort order. Default: Desc.'."\n" + 'type' => 'array', + 'items' => ['description' => 'The supported task type:'."\n" ."\n" - .'Valid values:'."\n" + .'- Shell'."\n" ."\n" - .'* Asc: Ascending.'."\n" - .'* Desc: Descending.'."\n", - 'type' => 'string', + .'- Python'."\n" + ."\n" + .'- ServerIDE'."\n" + ."\n" + .'- Notebook'."\n" + ."\n" + .'- PyODPS 2'."\n" + ."\n" + .'- PyODPS 3', 'type' => 'string', 'example' => 'Shell', 'title' => '', 'required' => false], + 'title' => '', + 'description' => 'The list of supported task types.', 'required' => false, - 'enumValueTitles' => [ - 'Asc' => '', - 'Desc' => '', - ], - 'example' => 'Asc', - 'default' => 'Desc', - 'enum' => [ - 'Asc', - 'Desc', - ], + 'example' => '', ], ], [ - 'name' => 'PageNumber', - 'in' => 'formData', + 'name' => 'ProviderTypes', + 'in' => 'query', + 'allowEmptyValue' => true, + 'style' => 'json', 'schema' => [ - 'title' => '分页页码，默认为1', - 'description' => 'The page number. Default: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'type' => 'array', + 'items' => [ + 'description' => 'The image provider type:'."\n" + ."\n" + .'- ACR: ACR image repository.'."\n" + ."\n" + .'- DataWorks: DataWorks official image.', + 'type' => 'string', + 'example' => 'ACR', + 'enum' => ['ACR', 'DataWorks', 'PAI', 'MaxCompute'], + 'title' => '', + 'required' => false, + ], + 'title' => '', + 'description' => 'The list of image provider types.', 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', + 'example' => '', ], ], [ 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'title' => '分页大小，默认为10，最大100', - 'description' => 'The number of entries per page. Default: 10. Maximum: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], + 'in' => 'query', + 'schema' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '10', 'title' => '', 'required' => false], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1', 'title' => '', 'required' => false], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => ['description' => 'The list of sort fields. You can sort by scheduled time, start time, and other fields. The format is "SortField+SortOrder(Desc/Asc)", where Asc is the default and can be omitted. Valid values of sort fields:'."\n" + ."\n" + .'- CreateTime (Desc/Asc): The creation time.'."\n" + ."\n" + .'- Name (Desc/Asc): The image name.'."\n" + .' Default value: CreateTime Asc.', 'type' => 'string', 'example' => 'CreatedTime Desc', 'default' => 'CreatedTime Desc', 'title' => '', 'required' => false], + ], + [ + 'name' => 'SearchAll', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to search all images.', 'type' => 'boolean', 'default' => 'false', 'title' => '', 'required' => false, 'example' => ''], + ], + [ + 'name' => 'Official', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether the image is an official image.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'RequestId'."\n", - 'type' => 'string', - 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX'."\n", - ], - 'Success' => [ - 'title' => '请求是否成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'PagingInfo' => [ - 'title' => '分页信息', - 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'title' => '总数', - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'PageNumber' => [ - 'title' => '分页页码', - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '分页大小', - 'description' => 'The number of entries on this page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Datasets' => [ - 'title' => '数据集列表', - 'description' => 'The dataset list.'."\n", + 'ImageList' => [ 'type' => 'array', 'items' => [ - 'title' => '数据集对象', - 'description' => 'The dataset object.'."\n", - '$ref' => '#/components/schemas/Dataset', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The image ID.', 'type' => 'string', 'example' => 'Custom_image_xxxx_xxxx', 'title' => ''], + 'Name' => ['description' => 'The image name.', 'type' => 'string', 'example' => 'dataworks_image', 'title' => ''], + 'Version' => ['description' => 'The image version.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Description' => ['description' => 'The image description.', 'type' => 'string', 'example' => 'Test image created by xxx', 'title' => ''], + 'Creator' => ['description' => 'The ID of the creator.', 'type' => 'string', 'example' => '123', 'title' => ''], + 'Modifier' => ['description' => 'The ID of the modifier.', 'type' => 'string', 'example' => '123', 'title' => ''], + 'CreatedTime' => ['description' => 'The creation time, represented as a 64-bit timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1727055811000', 'title' => ''], + 'LastModifiedTime' => ['description' => 'The last modification time, represented as a 64-bit timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1727055811000', 'title' => ''], + 'Official' => ['description' => 'Indicates whether the image is an official image.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Accessibility' => [ + 'description' => 'The accessibility:'."\n" + ."\n" + .'- Public: Visible to all members.'."\n" + ."\n" + .'- Private: Visible only to the creator.', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'Public', + 'enum' => ['Tenant', 'Project', 'Public'], + 'title' => '', + ], + 'Status' => [ + 'description' => 'The image status:'."\n" + ."\n" + .'- Disabled: The image is disabled.'."\n" + ."\n" + .'- Expired: The image has expired.'."\n" + ."\n" + .'- Available: The image is available.'."\n" + ."\n" + .'- ReadOnly: The image is read-only.', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'Available', + 'title' => '', + ], + 'PublishStage' => [ + 'description' => 'The publish stage:'."\n" + ."\n" + .'- Untest: Not tested.'."\n" + ."\n" + .'- Testing: Being tested.'."\n" + ."\n" + .'- TestFailed: Test failed.'."\n" + ."\n" + .'- Unpublished: Not published.'."\n" + ."\n" + .'- Publishing: Being published.'."\n" + ."\n" + .'- Published: Published.'."\n" + ."\n" + .'- PublishFailed: Publish failed.'."\n" + ."\n" + .'- Building: Being built.'."\n" + ."\n" + .'- BuildSuccess: Build succeeded.'."\n" + ."\n" + .'- BuildFailed: Build failed.'."\n" + ."\n" + .'- Accelerating: Being accelerated.'."\n" + ."\n" + .'- AccelerateSuccess: Acceleration succeeded.'."\n" + ."\n" + .'- AccelerateFailed: Acceleration failed.', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'Published', + 'title' => '', + ], + 'Supported' => [ + 'type' => 'object', + 'properties' => [ + 'Module' => ['description' => 'The supported module:'."\n" + ."\n" + .'- Scheduler: Scheduling.', 'type' => 'string', 'title' => '', 'example' => 'Scheduler'], + 'TaskTypes' => [ + 'type' => 'array', + 'items' => ['description' => 'The supported task type:'."\n" + ."\n" + .'- Shell'."\n" + ."\n" + .'- Python'."\n" + ."\n" + .'- ServerIDE'."\n" + ."\n" + .'- Notebook'."\n" + ."\n" + .'- PyODPS 2'."\n" + ."\n" + .'- PyODPS 3', 'type' => 'string', 'title' => '', 'example' => 'Shell'], + 'title' => '', + 'description' => 'The list of supported task types.', + 'example' => '', + ], + ], + 'title' => '', + 'description' => 'The supported modules and task types.', + 'example' => '', + ], + 'IsDefault' => ['description' => 'Indicates whether the image is the default image.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'EnableSyncMaxCompute' => ['description' => 'Indicates whether synchronization with MaxCompute is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'ProviderType' => ['description' => 'The image provider type:'."\n" + ."\n" + .'- ACR: ACR image repository.'."\n" + ."\n" + .'- DataWorks: DataWorks official image.', 'type' => 'string', 'example' => 'ACR', 'title' => ''], + 'ProviderImageId' => ['description' => 'The image ID assigned by the provider.', 'type' => 'string', 'example' => 'acr_image_id', 'title' => ''], + 'ImageUri' => ['description' => 'The image URI.', 'type' => 'string', 'example' => 'registry.cn-hangzhou.aliyuncs.com/xxx/xxx:tag', 'title' => ''], + 'Namespace' => ['description' => 'The namespace.', 'type' => 'string', 'example' => 'namespace', 'title' => ''], + 'Size' => ['description' => 'The image size.', 'type' => 'string', 'example' => '1GB', 'title' => ''], + 'AcrInstanceId' => ['description' => 'The ACR instance ID.', 'type' => 'string', 'example' => 'cri-xxx', 'title' => ''], + 'ImageTag' => ['description' => 'The image tag.', 'type' => 'string', 'example' => 'v1.0.0', 'title' => ''], + 'RepositoryName' => ['description' => 'The repository name.', 'type' => 'string', 'example' => 'repo_name', 'title' => ''], + 'ImageVpcUri' => ['description' => 'The image VPC URI.', 'type' => 'string', 'example' => 'registry-vpc.cn-hangzhou.aliyuncs.com/xxx/xxx:tag', 'title' => ''], + 'AcrEndpoint' => ['description' => 'ACR Endpoint', 'type' => 'string', 'example' => 'registry.cn-hangzhou.aliyuncs.com', 'title' => ''], + 'AcrAssociatedVpcId' => ['description' => 'The VPC ID associated with the ACR instance.', 'type' => 'string', 'example' => 'vpc-xxx', 'title' => ''], + 'BuildConfig' => [ + 'type' => 'object', + 'properties' => [ + 'BuildType' => ['description' => 'The build type.', 'type' => 'string', 'example' => 'PackageInstallation', 'title' => ''], + 'PackageInstallationScripts' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The script type.', 'type' => 'string', 'example' => 'Python3', 'title' => ''], + 'Content' => ['description' => 'The script content. If the content specifies package names, separate them with commas (,).', 'type' => 'string', 'example' => 'requests', 'title' => ''], + ], + 'description' => 'The pre-installation script.', + 'title' => '', + 'example' => '', + ], + 'description' => 'The list of pre-installation scripts.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The image build configuration.', + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'description' => 'The image details.', + 'example' => '', ], + 'title' => '', + 'description' => 'The list of image details.', + 'example' => '', ], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'default' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], ], + 'title' => '', + 'description' => 'The pagination information.', + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID, which is used to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', 'title' => ''], ], + 'title' => '', + 'description' => 'Schema of Response', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListImages', + 'summary' => 'Retrieves a list of images.', + 'description' => '1. You must have DataWorks Basic Edition or a later version to use this API.'."\n" + ."\n" + .'2. **Before you use this API, make sure that the service-linked role AliyunServiceRoleForDataWorks is created.**', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\\\n\\",\\n \\"Success\\": true,\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Datasets\\": [\\n {\\n \\"Id\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Comment\\": \\"\\",\\n \\"ProjectId\\": 0,\\n \\"Origin\\": \\"\\",\\n \\"DataType\\": \\"\\",\\n \\"StorageType\\": \\"\\",\\n \\"CreatorId\\": \\"\\",\\n \\"Readme\\": \\"\\",\\n \\"LatestVersion\\": {\\n \\"Id\\": \\"\\",\\n \\"DatasetId\\": \\"\\",\\n \\"Comment\\": \\"\\",\\n \\"CreatorId\\": \\"\\",\\n \\"VersionNumber\\": 0,\\n \\"StorageType\\": \\"\\",\\n \\"Url\\": \\"\\",\\n \\"MountPath\\": \\"\\",\\n \\"CreateTime\\": 0,\\n \\"ModifyTime\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ],\\n \\"ImportInfo\\": {\\n \\"key\\": \\"\\"\\n }\\n },\\n \\"CreateTime\\": 0,\\n \\"ModifyTime\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListDatasets', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"PagingInfo\\": {\\n \\"ImageList\\": [\\n {\\n \\"Id\\": \\"Custom_image_xxxx_xxxx\\",\\n \\"Name\\": \\"dataworks_image\\",\\n \\"Version\\": \\"1\\",\\n \\"Description\\": \\"Test image created by xxx\\",\\n \\"Creator\\": \\"123\\",\\n \\"Modifier\\": \\"123\\",\\n \\"CreatedTime\\": 1727055811000,\\n \\"LastModifiedTime\\": 1727055811000,\\n \\"Official\\": true,\\n \\"Accessibility\\": \\"Public\\",\\n \\"Status\\": \\"Available\\",\\n \\"PublishStage\\": \\"Published\\",\\n \\"Supported\\": {\\n \\"Module\\": \\"Scheduler\\",\\n \\"TaskTypes\\": [\\n \\"Shell\\"\\n ]\\n },\\n \\"IsDefault\\": false,\\n \\"EnableSyncMaxCompute\\": false,\\n \\"ProviderType\\": \\"ACR\\",\\n \\"ProviderImageId\\": \\"acr_image_id\\",\\n \\"ImageUri\\": \\"registry.cn-hangzhou.aliyuncs.com/xxx/xxx:tag\\",\\n \\"Namespace\\": \\"namespace\\",\\n \\"Size\\": \\"1GB\\",\\n \\"AcrInstanceId\\": \\"cri-xxx\\",\\n \\"ImageTag\\": \\"v1.0.0\\",\\n \\"RepositoryName\\": \\"repo_name\\",\\n \\"ImageVpcUri\\": \\"registry-vpc.cn-hangzhou.aliyuncs.com/xxx/xxx:tag\\",\\n \\"AcrEndpoint\\": \\"registry.cn-hangzhou.aliyuncs.com\\",\\n \\"AcrAssociatedVpcId\\": \\"vpc-xxx\\",\\n \\"BuildConfig\\": {\\n \\"BuildType\\": \\"PackageInstallation\\",\\n \\"PackageInstallationScripts\\": [\\n {\\n \\"Type\\": \\"Python3\\",\\n \\"Content\\": \\"requests\\"\\n }\\n ]\\n }\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 10\\n },\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]', ], - 'GetDataset' => [ - 'summary' => 'Gets the details of a dataset.', - 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListLineageRelationships' => [ + 'summary' => 'Queries the data map for data lineage relationships between specified entities, such as tables, columns, and OSS objects.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -32118,484 +34327,585 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdideXGTG91', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'operationType' => 'list', + 'abilityTreeCode' => '268106', + 'abilityTreeNodes' => ['FEATUREdideE9OA4H'], ], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'SrcEntityId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the source entity. You can get the ID for a table or column from the response of the `ListTables` or `ListColumns` operation, or specify the ID of a custom entity.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'maxcompute-table:::project_name:[schema_name]:table_name'], + ], + [ + 'name' => 'DstEntityId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the destination entity. You can get the ID for a table or column from the response of the `ListTables` or `ListColumns` operation, or specify the ID of a custom entity.', 'type' => 'string', 'required' => true, 'example' => 'dlf-table::catalog_id:database_name::table_name', 'title' => ''], + ], + [ + 'name' => 'SrcEntityName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the source entity. Supports fuzzy matching.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'srcName'], + ], + [ + 'name' => 'DstEntityName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the destination entity. Supports fuzzy matching.', 'type' => 'string', 'required' => false, 'example' => 'dstName', 'title' => ''], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => 'The field to sort the results by. The default value is `Name`.', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'example' => 'Name', + 'default' => 'Name', + 'enum' => ['Name'], + 'title' => '', + ], + ], + [ + 'name' => 'Order', 'in' => 'query', 'schema' => [ - 'title' => '数据集ID', - 'description' => 'The dataset ID.'."\n", + 'description' => 'The sort order. The default value is `Asc`. Valid values:'."\n" + ."\n" + .'- `Asc`: ascending order'."\n" + ."\n" + .'- `Desc`: descending order', + 'enumValueTitles' => [], 'type' => 'string', - 'required' => true, - 'example' => 'dataworks-dataset:3pXXXb8o0ngr07njhps1', + 'example' => 'Asc', + 'default' => 'Asc', + 'enum' => ['Asc', 'Desc'], + 'title' => '', + 'required' => false, ], ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '1', 'example' => '1', 'default' => '1', 'title' => '', 'required' => false], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The page size. The default value is 10. The maximum value is 100.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10', 'title' => '', 'required' => false], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The schema of the response.'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '204EAF68-CCE3-5112-8DA0-E7A60F02XXXX', - ], - 'Success' => [ - 'title' => '请求是否成功', - 'description' => 'Indicates whether the request succeeded.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Dataset' => [ - 'description' => 'The dataset information.'."\n", - '$ref' => '#/components/schemas/Dataset', + 'RequestId' => ['description' => 'The ID of the request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => 'SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'PagingInfo' => [ + 'title' => '', + 'description' => 'The pagination information.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'PageNumber' => ['description' => 'The current page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'LineageRelationships' => [ + 'title' => '', + 'description' => 'An array of data lineage relationships.', + 'type' => 'array', + 'items' => ['description' => 'A data lineage relationship.', '$ref' => '#/components/schemas/LineageRelationship', 'title' => '', 'example' => ''], + 'example' => '', + ], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"204EAF68-CCE3-5112-8DA0-E7A60F02XXXX\\",\\n \\"Success\\": true,\\n \\"Dataset\\": {\\n \\"Id\\": \\"\\",\\n \\"Name\\": \\"\\",\\n \\"Comment\\": \\"\\",\\n \\"ProjectId\\": 0,\\n \\"Origin\\": \\"\\",\\n \\"DataType\\": \\"\\",\\n \\"StorageType\\": \\"\\",\\n \\"CreatorId\\": \\"\\",\\n \\"Readme\\": \\"\\",\\n \\"LatestVersion\\": {\\n \\"Id\\": \\"\\",\\n \\"DatasetId\\": \\"\\",\\n \\"Comment\\": \\"\\",\\n \\"CreatorId\\": \\"\\",\\n \\"VersionNumber\\": 0,\\n \\"StorageType\\": \\"\\",\\n \\"Url\\": \\"\\",\\n \\"MountPath\\": \\"\\",\\n \\"CreateTime\\": 0,\\n \\"ModifyTime\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ],\\n \\"ImportInfo\\": {\\n \\"key\\": \\"\\"\\n }\\n },\\n \\"CreateTime\\": 0,\\n \\"ModifyTime\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'GetDataset', - ], - 'CreateDataset' => [ - 'summary' => 'Creates a dataset. This operation is supported only in workspaces that the user has joined. Currently, only DataWorks datasets are supported. The maximum number of datasets allowed per tenant is 2,000.', - 'path' => '', - 'methods' => [ - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF\\",\\n \\"Success\\": true,\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 123,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"LineageRelationships\\": [\\n {\\n \\"SrcEntity\\": {\\n \\"Id\\": \\"maxcompute-table:123456XXX::test_project::test_tbl\\\\ndlf-table:123456XXX:test_catalog:test_db::test_tbl\\\\nhms-table:c-abc123xxx::test_db::test_tbl\\\\nholo-table:h-abc123xxx::test_db:test_schema:test_tbl\\\\ncustom-api:api123\\\\ncustom-table:table456\\",\\n \\"Name\\": \\"test_tbl\\",\\n \\"Attributes\\": {\\n \\"key\\": \\"key1:value1\\"\\n }\\n },\\n \\"DstEntity\\": {\\n \\"Id\\": \\"maxcompute-table:123456XXX::test_project::test_tbl\\\\ndlf-table:123456XXX:test_catalog:test_db::test_tbl\\\\nhms-table:c-abc123xxx::test_db::test_tbl\\\\nholo-table:h-abc123xxx::test_db:test_schema:test_tbl\\\\ncustom-api:api123\\\\ncustom-table:table456\\",\\n \\"Name\\": \\"test_tbl\\",\\n \\"Attributes\\": {\\n \\"key\\": \\"key1:value1\\"\\n }\\n },\\n \\"Task\\": {\\n \\"Id\\": \\"12345\\",\\n \\"Type\\": \\"custom-sql\\",\\n \\"Attributes\\": {\\n \\"key\\": \\"key1:value21\\"\\n }\\n },\\n \\"Id\\": \\"maxcompute-table.p.table:custom-table.xxx:custom-sql.123\\",\\n \\"CreateTime\\": 1743040581000\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListLineageRelationships', + 'description' => '1. This operation is available in DataWorks Standard Edition and later versions.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:ListLineageRelationships', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListLineages' => [ + 'summary' => 'Queries the upstream and downstream entities for a specified entity in Data Map. You can optionally include detailed lineage relationship information.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdideXGTG91', - ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'operationType' => 'list', + 'abilityTreeCode' => '268105', + 'abilityTreeNodes' => ['FEATUREdideE9OA4H'], ], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'title' => 'DataWorks工作空间ID', - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '12345', - ], + 'name' => 'SrcEntityId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the source entity. This can be a table or column ID returned by the `ListTables` or `ListColumns` API, or the ID of a custom entity.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'maxcompute-table:::project_name:[schema_name]:table_name'], ], [ - 'name' => 'Origin', - 'in' => 'formData', - 'schema' => [ - 'title' => '数据集来源，当前仅支持DataWorks', - 'description' => 'The source of the dataset. Currently, only DataWorks is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'DataWorks' => 'DataWorks', - ], - 'example' => 'DataWorks', - 'default' => 'DataWorks', - ], + 'name' => 'DstEntityId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the destination entity. This can be a table or column ID returned by the `ListTables` or `ListColumns` API, or the ID of a custom entity.', 'type' => 'string', 'required' => false, 'example' => 'dlf-table::catalog_id:database_name::table_name', 'title' => ''], ], [ - 'name' => 'Name', - 'in' => 'formData', - 'schema' => [ - 'title' => '数据集名称，非空字符串，长度不超过128', - 'description' => 'The name of the dataset. It cannot be an empty string and must not exceed 128 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test_oss_dataset', - ], + 'name' => 'SrcEntityName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the source entity. This parameter supports fuzzy matching.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'srcName1'], ], [ - 'name' => 'Comment', - 'in' => 'formData', - 'schema' => [ - 'title' => '数据集描述,长度不超过1024', - 'description' => 'The description of the dataset. It must not exceed 1,024 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'this is a comment', - ], + 'name' => 'DstEntityName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the destination entity. This parameter supports fuzzy matching.', 'type' => 'string', 'required' => false, 'example' => 'dstName1', 'title' => ''], ], [ - 'name' => 'DataType', - 'in' => 'formData', + 'name' => 'NeedAttachRelationship', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to include lineage relationships. Default: false.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', 'schema' => [ - 'title' => '数据类型，取值有'."\n" - .'- COMMON 通用（默认）'."\n" - .'- PIC 图片'."\n" - .'- TEXT 文本'."\n" - .'- TABLE 表格'."\n" - .'- VIDEO 视频'."\n" - .'- AUDIO 音频'."\n" - .'- INDEX 索引', - 'description' => 'The data type. Valid values:'."\n" - ."\n" - .'* COMMON: Common (Default)'."\n" - .'* PIC'."\n" - .'* TEXT'."\n" - .'* TABLE'."\n" - .'* VIDEO'."\n" - .'* AUDIO'."\n" - .'* INDEX'."\n", + 'description' => 'The field to sort the results by. The default is `Name`, which sorts by entity name.', 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'TABLE' => '', - 'VIDEO' => '', - 'COMMON' => '', - 'TEXT' => '', - 'PIC' => '', - 'INDEX' => '', - 'AUDIO' => '', - ], - 'example' => 'COMMON', - 'default' => 'COMMON', + 'example' => 'Name', + 'default' => 'Name', + 'enum' => ['Name'], + 'title' => '', ], ], [ - 'name' => 'StorageType', - 'in' => 'formData', + 'name' => 'Order', + 'in' => 'query', 'schema' => [ - 'title' => '存储类型，当前支持的取值有'."\n" - .'- OSS 对象存储'."\n" - .'- NAS 通用型NAS文件存储'."\n" - .'- EXTREMENAS 极速型NAS文件存储'."\n" - .'- DLF_LANCE 数据湖构建', - 'description' => 'The storage type. Currently supported values:'."\n" - ."\n" - .'* OSS'."\n" - .'* NAS: General-purpose NAS file systems'."\n" - .'* EXTREMENAS: Extreme NAS file systems'."\n" - .'* DLF_LANCE: Data Lake Formation'."\n" + 'description' => 'The sort order. Default: `Asc`. Valid values:'."\n" ."\n" - .'Valid values:'."\n" + .'- `Asc`: ascending'."\n" ."\n" - .'* NAS: General-purpose NAS file systems'."\n" - .'* MAXCOMPUTE: MaxCompute table'."\n" - .'* CPFS: Cloud Parallel File Storage'."\n" - .'* BMCPFS: CPFS for Lingjun'."\n" - .'* EXTREMENAS: Extreme NAS file systems'."\n" - .'* OSS: Object Storage Service'."\n" - .'* DLF_LANCE: Data Lake Formation.'."\n", + .'- `Desc`: descending', 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'NAS' => '', - 'EXTREMENAS' => '', - 'OSS' => '', - 'DLF_LANCE' => '', - ], - 'example' => 'OSS', + 'example' => 'Asc', + 'default' => 'Asc', + 'enum' => ['Asc', 'Desc'], + 'title' => '', + 'required' => false, ], ], [ - 'name' => 'InitVersion', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '数据集初始版本', - 'description' => 'The initial version of the dataset.'."\n", - 'type' => 'object', - 'properties' => [ - 'Comment' => [ - 'title' => '描述，长度不超过1024', - 'description' => 'The description. It must not exceed 1,024 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Initial Version', - ], - 'Url' => [ - 'title' => 'URL地址', - 'description' => 'URL'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'oss://test-oss-bucket/test_dir/', - ], - 'ImportInfo' => [ - 'title' => '数据集的存储导入配置'."\n" - .'对于NAS类型，需要提供以下属性，取值可参考DescribeFileSystems接口的返回信息'."\n" - .'- fileSystemId 文件系统ID'."\n" - .'- fileSystemStorageType 文件系统的存储规格'."\n" - .'- vpcId 挂载点的 VPC ID', - 'description' => 'The storage import configuration for the dataset. The required configuration information varies by storage type.'."\n" - ."\n" - .'**NAS**'."\n" - ."\n" - .'For valid values, refer to the response of the file storage API DescribeFileSystems.'."\n" - ."\n" - .'```JSON'."\n" - .'{'."\n" - .'"fileSystemId": "3b6XXX89c9", // The file system ID.'."\n" - .'"fileSystemStorageType": "Performance" // The storage specification of the file system.'."\n" - .'"vpcId": "vpc-uf66oxxxrqge1t2gson7s" // The VPC ID of the mount point.'."\n" - .'}'."\n" - .'```'."\n", - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'None', - 'description' => 'The storage import configuration information for the dataset.'."\n", - ], - ], - 'MountPath' => [ - 'title' => '挂载路径，需要以/mnt/开头，默认为/mnt/data', - 'description' => 'The mount path. It must start with /mnt/. Default value: /mnt/data.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '/mnt/data', - ], - ], - 'required' => true, - ], + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number to retrieve. Default: 1.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '1', 'example' => '1', 'default' => '1', 'title' => '', 'required' => false], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default: 10. Maximum: 100.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The data returned.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => '99EBE7CF-69C0-5089-BE3E-79563C31XXXX', - ], - 'Success' => [ - 'title' => '是否创建成功', - 'description' => 'Indicates whether the creation was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Id' => [ - 'title' => 'ID', - 'description' => 'ID'."\n", - 'type' => 'string', - 'example' => 'dataworks-dataset:3pXXXb8o0ngr07njhps1', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '0000-ABCD-EFG****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'PagingInfo' => [ + 'title' => '', + 'description' => 'The pagination details.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''], + 'PageNumber' => ['description' => 'The page number of the returned data.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned on the current page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'Lineages' => [ + 'title' => '', + 'description' => 'A list of lineage information.', + 'type' => 'array', + 'items' => [ + 'description' => 'A lineage entry.', + 'type' => 'object', + 'properties' => [ + 'SrcEntity' => ['description' => 'The source entity.', '$ref' => '#/components/schemas/LineageEntity', 'title' => '', 'example' => ''], + 'DstEntity' => ['description' => 'The destination entity.', '$ref' => '#/components/schemas/LineageEntity', 'title' => '', 'example' => ''], + 'Relationships' => [ + 'description' => 'A list of lineage relationships.', + 'type' => 'array', + 'items' => ['description' => 'A lineage relationship.', '$ref' => '#/components/schemas/LineageRelationship', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"99EBE7CF-69C0-5089-BE3E-79563C31XXXX\\",\\n \\"Success\\": true,\\n \\"Id\\": \\"dataworks-dataset:3pXXXb8o0ngr07njhps1\\"\\n}","type":"json"}]', - 'title' => 'CreateDataset', - ], - 'UpdateDataset' => [ - 'summary' => 'Updates dataset information. Only DataWorks datasets are supported. The operator must be the creator of the dataset or the administrator of the workspace where the dataset is located.', - 'path' => '', - 'methods' => [ - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"Success\\": true,\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 12,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Lineages\\": [\\n {\\n \\"SrcEntity\\": {\\n \\"Id\\": \\"maxcompute-table:123456XXX::test_project::test_tbl\\\\ndlf-table:123456XXX:test_catalog:test_db::test_tbl\\\\nhms-table:c-abc123xxx::test_db::test_tbl\\\\nholo-table:h-abc123xxx::test_db:test_schema:test_tbl\\\\ncustom-api:api123\\\\ncustom-table:table456\\",\\n \\"Name\\": \\"test_tbl\\",\\n \\"Attributes\\": {\\n \\"key\\": \\"key1:value1\\"\\n }\\n },\\n \\"DstEntity\\": {\\n \\"Id\\": \\"maxcompute-table:123456XXX::test_project::test_tbl\\\\ndlf-table:123456XXX:test_catalog:test_db::test_tbl\\\\nhms-table:c-abc123xxx::test_db::test_tbl\\\\nholo-table:h-abc123xxx::test_db:test_schema:test_tbl\\\\ncustom-api:api123\\\\ncustom-table:table456\\",\\n \\"Name\\": \\"test_tbl\\",\\n \\"Attributes\\": {\\n \\"key\\": \\"key1:value1\\"\\n }\\n },\\n \\"Relationships\\": [\\n {\\n \\"SrcEntity\\": {\\n \\"Id\\": \\"maxcompute-table:123456XXX::test_project::test_tbl\\\\ndlf-table:123456XXX:test_catalog:test_db::test_tbl\\\\nhms-table:c-abc123xxx::test_db::test_tbl\\\\nholo-table:h-abc123xxx::test_db:test_schema:test_tbl\\\\ncustom-api:api123\\\\ncustom-table:table456\\",\\n \\"Name\\": \\"test_tbl\\",\\n \\"Attributes\\": {\\n \\"key\\": \\"key1:value1\\"\\n }\\n },\\n \\"Task\\": {\\n \\"Id\\": \\"12345\\",\\n \\"Type\\": \\"custom-sql\\",\\n \\"Attributes\\": {\\n \\"key\\": \\"key1:value21\\"\\n }\\n },\\n \\"Id\\": \\"maxcompute-table.p.table:custom-table.xxx:custom-sql.123\\",\\n \\"CreateTime\\": 1743040581000\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListLineages', + 'description' => '1. To use this API, you must purchase DataWorks Standard Edition or a later edition.'."\n" + ."\n" + .'2. Use this API to query the upstream and downstream entities of a specific entity and their lineage relationships.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:ListLineages', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListMcpServers' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdideXGTG91', - ], + 'abilityTreeCode' => 'TBD', + 'abilityTreeNodes' => ['FEATUREdideYTM537'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'Q', 'in' => 'formData', - 'schema' => [ - 'title' => '数据集ID,仅支持更新DataWorks数据集', - 'description' => 'The dataset ID. Only DataWorks datasets are supported for update.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'dataworks-dataset:3pXXXb8o0ngr07njhps1', - ], + 'schema' => ['description' => 'The search keyword for a fuzzy search on MCP Server names.', 'type' => 'string', 'required' => false, 'example' => 'mcp', 'title' => ''], ], [ - 'name' => 'Name', + 'name' => 'Visibility', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '数据集名称，非空字符串，长度不超过128', - 'description' => 'The dataset name. A non-empty string, length not exceeding 128.'."\n", - 'type' => 'string', + 'type' => 'array', + 'items' => [ + 'description' => 'The visibility level. Valid values: TENANT (visible within the account), PROJECT (visible to specified projects), and USER (visible to specified users).', + 'type' => 'string', + 'enum' => ['TENANT', 'PROJECT', 'USER'], + 'required' => false, + 'example' => 'TENANT', + 'title' => '', + ], + 'description' => 'The visibility level for filtering the results.', 'required' => false, - 'example' => 'test_oss_dataset_new', + 'example' => '-', + 'title' => '', ], ], [ - 'name' => 'Comment', - 'in' => 'formData', - 'schema' => [ - 'title' => '数据集描述,长度不超过1024', - 'description' => 'The dataset description. Length not exceeding 1024.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'new comment', - ], + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of results to return per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], [ - 'name' => 'Readme', - 'in' => 'formData', - 'schema' => [ - 'title' => '使用说明，支持Markdown格式富文本', - 'description' => 'The user guide, supports Markdown formatted rich text.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '## introduction', - ], + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'The next page token from a previous response. Use this token to retrieve the next page of results. Leave this parameter empty for the first request.', 'type' => 'string', 'required' => false, 'example' => '12345', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n", - ], - 'Success' => [ - 'title' => '是否更新成功', - 'description' => 'Indicates whether the update is successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '824F80BA-1778-5D8A-BAFF-668A4D9C4CC7'], + 'PagingInfo' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['description' => 'The total count of entries that match the filter criteria.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'McpServers' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CreatorId' => ['description' => 'The creator ID.', 'type' => 'string', 'example' => '805298765622151', 'title' => ''], + 'ModifierId' => ['description' => 'The ID of the user who last modified the server.', 'type' => 'string', 'example' => '123456', 'title' => ''], + 'Name' => ['description' => 'The name of the MCP Server.', 'type' => 'string', 'example' => 'my-mcp-server', 'title' => ''], + 'Config' => [ + 'type' => 'object', + 'properties' => [ + 'Url' => ['description' => 'The service address of the MCP Server.', 'type' => 'string', 'example' => 'https://example.com/mcp/sse', 'title' => ''], + 'Transport' => ['description' => 'The transport protocol.', 'type' => 'string', 'example' => 'SSE', 'title' => ''], + 'CustomHeaders' => ['description' => 'The custom headers.', 'type' => 'object', 'example' => '{}', 'title' => ''], + ], + 'description' => 'The connection configuration of the MCP Server.', + 'title' => '', + 'example' => '', + ], + 'Visibility' => ['description' => 'The visibility level.****', 'type' => 'string', 'example' => 'TENANT', 'title' => ''], + 'GmtCreateTime' => ['description' => 'The creation time, as a millisecond timestamp.****', 'type' => 'string', 'format' => 'iso8601', 'example' => '1780555634000', 'title' => ''], + 'GmtModifiedTime' => ['description' => 'The last modified time, as a millisecond timestamp.****', 'type' => 'string', 'format' => 'iso8601', 'example' => '1780555634000', 'title' => ''], + ], + 'description' => '-', + 'title' => '', + 'example' => '', + ], + 'description' => 'A list of MCP Server objects.', + 'title' => '', + 'example' => '', + ], + 'MaxResults' => ['description' => 'The maximum number of results returned on the current page.****', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'NextToken' => ['description' => 'The token for the next page of results. A null value indicates that all results have been returned.****', 'type' => 'string', 'example' => '2', 'title' => ''], + ], + 'description' => 'The paging information.', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => 'The response object.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListMcpServers', + 'summary' => 'Retrieves a paginated list of MCP servers.', + 'description' => '## Request'."\n" + ."\n" + .'This operation retrieves a paginated list of all MCP Servers within your account. You can filter the list by search keyword and visibility level, and control pagination by specifying the maximum number of results and a next page token.'."\n" + ."\n" + .'- **Q**: Optional. The search keyword for a fuzzy search on MCP Server names.'."\n" + ."\n" + .'- **Visibility**: Optional. The visibility level for filtering the results.'."\n" + ."\n" + .'- **MaxResults**: Optional. The maximum number of results to return per page. By default, no limit is applied.'."\n" + ."\n" + .'- **NextToken**: Optional. The next page token from a previous response. Use this parameter to retrieve the next page of results.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\\\n\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'UpdateDataset', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"824F80BA-1778-5D8A-BAFF-668A4D9C4CC7\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 100,\\n \\"McpServers\\": [\\n {\\n \\"CreatorId\\": \\"805298765622151\\",\\n \\"ModifierId\\": \\"123456\\",\\n \\"Name\\": \\"my-mcp-server\\",\\n \\"Config\\": {\\n \\"Url\\": \\"https://example.com/mcp/sse\\",\\n \\"Transport\\": \\"SSE\\",\\n \\"CustomHeaders\\": {}\\n },\\n \\"Visibility\\": \\"TENANT\\",\\n \\"GmtCreateTime\\": \\"1780555634000\\",\\n \\"GmtModifiedTime\\": \\"1780555634000\\"\\n }\\n ],\\n \\"MaxResults\\": 100,\\n \\"NextToken\\": \\"2\\"\\n }\\n}","type":"json"}]', ], - 'DeleteDataset' => [ - 'summary' => 'Delete a dataset. Only DataWorks datasets are supported. This operation cascades to delete all associated dataset versions. Requires dataset creator or workspace administrator permissions.', - 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListMetaCollections' => [ + 'summary' => 'Queries a list of collections in Data Map. Collections include categories and data albums.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdideXGTG91', - ], + 'abilityTreeCode' => '266685', + 'abilityTreeNodes' => ['FEATUREdideE9XYA6'], 'autoTest' => true, - 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'Type', 'in' => 'query', 'schema' => [ - 'title' => '数据集ID，仅支持DataWorks数据集', - 'description' => 'The dataset ID. Only DataWorks datasets are supported.'."\n", + 'description' => 'The collection type. Valid values:'."\n" + ."\n" + .'- Category'."\n" + ."\n" + .'- Album'."\n" + ."\n" + .'- AlbumCategory: Album subcategory', 'type' => 'string', 'required' => true, - 'example' => 'dataworks-dataset:3pXXXb8o0ngr07njhps1', + 'enum' => ['Category', 'Album', 'AlbumCategory'], + 'example' => 'Category', + 'title' => '', ], ], + [ + 'name' => 'ParentId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the parent collection.', 'type' => 'string', 'required' => false, 'example' => 'as78d756asd', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The collection name. Supports fuzzy matching.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The collection description. Supports fuzzy matching.', 'type' => 'string', 'example' => 'Test collection', 'required' => false, 'title' => ''], + ], + [ + 'name' => 'CreateUser', + 'in' => 'query', + 'schema' => ['description' => 'The creator user ID. Valid only for album types. Default: The current user ID.', 'type' => 'string', 'required' => false, 'example' => '123456', 'title' => ''], + ], + [ + 'name' => 'Administrator', + 'in' => 'query', + 'schema' => ['description' => 'The administrator ID. Valid only for album types. Default: The current user ID.', 'type' => 'string', 'required' => false, 'example' => '12345', 'title' => ''], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => ['description' => 'The sort field. Valid values:'."\n" + ."\n" + .'- Id (default)'."\n" + ."\n" + .'- Name'."\n" + ."\n" + .'- CreateUser: Creator ID'."\n" + ."\n" + .'- CreateTime: Creation time'."\n" + ."\n" + .'- ModifyTime: Modification time', 'type' => 'string', 'required' => false, 'example' => 'Name', 'title' => ''], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => 'The sort order. Valid values:'."\n" + ."\n" + .'- Asc (default): Ascending order'."\n" + ."\n" + .'- Desc', 'type' => 'string', 'required' => false, 'example' => 'Asc', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Default: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default: 10. Maximum: 100.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => 'AAC30B35-820D-5F3E-A42C-E96BB****', - ], - 'Success' => [ - 'title' => '是否删除成功', - 'description' => 'Indicates whether the deletion succeeded.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'E25887B7-XXXX-54A5-9C4F-83A0DE367DDE'], + 'Data' => [ + 'title' => '', + 'description' => 'Pagination information.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['description' => 'The total number of records.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', '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' => ''], + 'MetaCollections' => [ + 'description' => 'The list of collections.', + 'type' => 'array', + 'items' => [ + 'description' => 'The collection.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The collection name.', 'type' => 'string', 'example' => 'test_category', 'title' => ''], + 'Id' => ['description' => 'The collection name.', 'type' => 'string', 'example' => '7a65sd7aasd', 'title' => ''], + 'ParentId' => ['description' => 'The ID of the parent collection. Can be empty.', 'type' => 'string', 'example' => 'as78d756asd', 'title' => ''], + 'Description' => ['description' => 'The collection description.', 'type' => 'string', 'example' => 'Test category', 'title' => ''], + 'Type' => ['description' => 'The collection type. Valid values:'."\n" + ."\n" + .'- Category'."\n" + ."\n" + .'- Album'."\n" + ."\n" + .'- AlbumCategory: Album subcategory', 'type' => 'string', 'example' => 'Category', 'title' => ''], + 'CreateUser' => ['description' => 'The creator user ID.', 'type' => 'string', 'example' => '456789', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time in milliseconds (timestamp).', 'type' => 'integer', 'format' => 'int64', 'example' => '1668568601000', 'title' => ''], + 'ModifyTime' => ['description' => 'The modification time in milliseconds (timestamp).', 'type' => 'integer', 'format' => 'int64', 'example' => '1668568601000', 'title' => ''], + 'Administrators' => [ + 'description' => 'The list of administrator IDs. Supported only for album types. Administrators must be users within the same tenant. Multiple administrators can be specified.', + 'type' => 'array', + 'items' => ['description' => 'The administrator ID.', 'type' => 'string', 'example' => '765432', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E25887B7-XXXX-54A5-9C4F-83A0DE367DDE\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 10,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"MetaCollections\\": [\\n {\\n \\"Name\\": \\"test_category\\",\\n \\"Id\\": \\"7a65sd7aasd\\",\\n \\"ParentId\\": \\"as78d756asd\\",\\n \\"Description\\": \\"Test category\\",\\n \\"Type\\": \\"Category\\",\\n \\"CreateUser\\": \\"456789\\",\\n \\"CreateTime\\": 1668568601000,\\n \\"ModifyTime\\": 1668568601000,\\n \\"Administrators\\": [\\n \\"765432\\"\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListMetaCollections', + 'description' => '1. DataWorks Professional Edition or a higher edition is required.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AAC30B35-820D-5F3E-A42C-E96BB****\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'DeleteDataset', + 'ramActions' => [], + 'translator' => 'manual', ], - 'ListDatasetVersions' => [ - 'summary' => 'Retrieves the version list for a given dataset.', + 'ListMetaEntities' => [ + 'summary' => 'Lists metadata entities. Support is currently limited to custom types.', 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -32607,195 +34917,169 @@ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdideXGTG91', - ], + 'abilityTreeNodes' => ['FEATUREdideX3KVYR'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'DatasetId', + 'name' => 'EntityType', 'in' => 'formData', - 'schema' => [ - 'title' => '数据集ID', - 'description' => 'The dataset ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'dataworks-dataset:3pXXXb8o0ngr07njhps1', - ], + 'schema' => ['description' => 'The type of the entity to list.', 'type' => 'string', 'required' => true, 'example' => 'custom_entity-customer_api', 'title' => ''], ], [ - 'name' => 'CreatorId', + 'name' => 'MaxResults', 'in' => 'formData', - 'schema' => [ - 'title' => '创建者ID', - 'description' => 'The creator ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '12103XXX46492139', - ], + 'schema' => ['description' => 'The maximum number of results to return per page. Default value: 10. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'default' => '10', 'title' => '', 'required' => false, 'example' => '10'], ], [ - 'name' => 'SortBy', + 'name' => 'NextToken', + 'in' => 'formData', + 'schema' => ['description' => 'The pagination token that specifies the next page of results. To retrieve the first page, do not specify this parameter. To retrieve subsequent pages, set this parameter to the `NextToken` value from the previous response.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'AAAAAaUpAxoCTD/+sbOf3f+uxvnYyILMeAjoTFQSX64R12GN'], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['description' => 'Filters entities by name. This is a containment match.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'xm_create_test'], + ], + [ + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => ['description' => 'Filters entities by comment. This is a token-based match.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'this is a comment'], + ], + [ + 'name' => 'AttributeFilters', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '排序字段', - 'description' => 'The sort field. Default: VersionNumber.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* ModifyTime: Modification time.'."\n" - .'* CreateTime: Creation time.'."\n" - .'* VersionNumber: Version number.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'ModifyTime' => '', - 'CreateTime' => '', - 'VersionNumber' => '', - ], - 'example' => 'CreateTime', - 'default' => 'VersionNumber', - 'enum' => [ - 'CreateTime', - 'ModifyTime', - 'VersionNumber', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The key of the entity attribute to filter by.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'key1'], + 'Values' => [ + 'type' => 'array', + 'items' => ['description' => 'A value for the entity attribute.', 'type' => 'string', 'required' => false, 'example' => 'value1', 'title' => ''], + 'title' => '', + 'description' => 'A list of values for the specified entity attribute.', + 'required' => false, + 'example' => '', + ], + ], + 'description' => 'A single filter condition for an entity attribute.', + 'required' => false, + 'title' => '', + 'example' => '', ], + 'title' => '', + 'description' => 'Conditions for filtering entities by entity attributes. The `AND` operator is used between different filters, and the `OR` operator is used for multiple values within a single filter.', + 'required' => false, + 'example' => '[]', ], ], [ - 'name' => 'Order', + 'name' => 'CustomAttributeFilters', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '排序方向', - 'description' => 'The sort order. Default: Desc.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Asc: Ascending.'."\n" - .'* Desc: Descending.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Asc' => '', - 'Desc' => '', - ], - 'example' => 'Desc', - 'default' => 'Desc', - 'enum' => [ - 'Asc', - 'Desc', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The key of the custom attribute to filter by.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'custom_attr_1'], + 'Values' => [ + 'type' => 'array', + 'items' => ['description' => 'A value for the custom attribute.', 'type' => 'string', 'required' => false, 'example' => 'value1', 'title' => ''], + 'title' => '', + 'description' => 'A list of values for the specified custom attribute.', + 'required' => false, + 'example' => '', + ], + ], + 'description' => 'A single filter condition for a custom attribute.', + 'required' => false, + 'title' => '', + 'example' => '', ], + 'title' => '', + 'description' => 'Conditions for filtering entities by custom attributes. The `AND` operator is used between different filters, and the `OR` operator is used for multiple values within a single filter. This parameter supports only `ENUM` custom attributes.', + 'required' => false, + 'example' => '[]', ], ], [ - 'name' => 'PageNumber', + 'name' => 'SortBy', 'in' => 'formData', 'schema' => [ - 'title' => '分页页码，默认为1', - 'description' => 'The page number. Default: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The field to use for sorting the results.', + 'type' => 'string', + 'default' => 'CreateTime', + 'enum' => ['Name', 'CreateTime', 'ModifyTime'], + 'title' => '', 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', + 'example' => 'Name', ], ], [ - 'name' => 'PageSize', + 'name' => 'Order', 'in' => 'formData', 'schema' => [ - 'title' => '分页大小，默认为10，最大100', - 'description' => 'The number of entries per page. Default: 10. Maximum: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The sort order. Valid values: `Asc` and `Desc`.', + 'type' => 'string', + 'default' => 'Asc', + 'enum' => ['Asc', 'Desc'], + 'title' => '', 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', + 'example' => 'Asc', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'RequestId', - 'description' => 'RequestId'."\n", - 'type' => 'string', - 'example' => 'E25887B7-579C-54A5-9C4F-83A0DE367XXX', - ], - 'Success' => [ - 'title' => '请求是否成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'ADFASDFASDFA-ADFASDF-ASDFADSDF-AFFADS'], + 'Success' => ['description' => 'Indicates whether the request succeeded.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], 'PagingInfo' => [ - 'title' => '分页信息', - 'description' => 'The pagination information.'."\n", 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'title' => '总数', - 'description' => 'The total number of entries.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'PageNumber' => [ - 'title' => '分页页码', - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'title' => '分页大小', - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'DatasetVersions' => [ - 'title' => '数据集版本列表', - 'description' => 'The dataset version list.'."\n", + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], + 'MaxResults' => ['description' => 'The maximum number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], + 'NextToken' => ['description' => 'The token used to retrieve the next page of results. If this parameter is empty, no more results are available.', 'type' => 'string', 'title' => '', 'example' => 'AAAAAdEdsXbwG2ZlbWCzN4wTTg6NmTbhyvglcoMCJsiEdngaTov15YaMyduvjIHYeTOIcEeXqCevM1qffZkwCkUTUYc='], + 'MetaEntities' => [ 'type' => 'array', - 'items' => [ - 'title' => '数据集版本', - 'description' => 'The dataset version.'."\n", - '$ref' => '#/components/schemas/DatasetVersion', - ], + 'items' => ['description' => 'A metadata entity object.', '$ref' => '#/components/schemas/MetaEntity', 'title' => '', 'example' => ''], + 'title' => '', + 'description' => 'A list of metadata entities.', + 'example' => '', ], ], + 'title' => '', + 'description' => 'Pagination information.', + 'example' => '', ], ], + 'title' => '', + 'description' => 'The response schema.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListMetaEntities', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E25887B7-579C-54A5-9C4F-83A0DE367XXX\\",\\n \\"Success\\": true,\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"DatasetVersions\\": [\\n {\\n \\"Id\\": \\"\\",\\n \\"DatasetId\\": \\"\\",\\n \\"Comment\\": \\"\\",\\n \\"CreatorId\\": \\"\\",\\n \\"VersionNumber\\": 0,\\n \\"StorageType\\": \\"\\",\\n \\"Url\\": \\"\\",\\n \\"MountPath\\": \\"\\",\\n \\"CreateTime\\": 0,\\n \\"ModifyTime\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ],\\n \\"ImportInfo\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListDatasetVersions', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ADFASDFASDFA-ADFASDF-ASDFADSDF-AFFADS\\",\\n \\"Success\\": true,\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 10,\\n \\"MaxResults\\": 10,\\n \\"NextToken\\": \\"AAAAAdEdsXbwG2ZlbWCzN4wTTg6NmTbhyvglcoMCJsiEdngaTov15YaMyduvjIHYeTOIcEeXqCevM1qffZkwCkUTUYc=\\",\\n \\"MetaEntities\\": [\\n {\\n \\"Id\\": \\"custom_entity-customer_api:api_001\\",\\n \\"EntityType\\": \\"custom_entity-customer_api\\",\\n \\"Name\\": \\"api_001\\",\\n \\"Comment\\": \\"this is a comment\\",\\n \\"OwnerId\\": \\"207924799988354\\",\\n \\"CustomAttributes\\": {\\n \\"key\\": [\\n \\"张三\\"\\n ]\\n },\\n \\"MetaEntityDef\\": {\\n \\"Name\\": \\"biz_api\\",\\n \\"EntityType\\": \\"custom_entity-biz_api\\",\\n \\"DisplayName\\": \\"业务API\\",\\n \\"Description\\": \\"test\\",\\n \\"AttributeDefs\\": [\\n {\\n \\"Name\\": \\"apiCode\\",\\n \\"DisplayName\\": \\"API编码\\",\\n \\"Type\\": \\"STRING\\",\\n \\"IsOptional\\": true,\\n \\"SearchFilterEnabled\\": false,\\n \\"DisplayEnabled\\": true,\\n \\"AllowedValues\\": [\\n \\"LABEL_1\\"\\n ],\\n \\"Description\\": \\"层级描述\\"\\n }\\n ],\\n \\"Extend\\": \\"NONE\\",\\n \\"CreateTime\\": 1780553640613,\\n \\"ModifyTime\\": 1780553640613\\n },\\n \\"CreateTime\\": 1780553640613,\\n \\"ModifyTime\\": 1763380628000,\\n \\"Attributes\\": {\\n \\"key\\": \\"v1\\"\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', ], - 'GetDatasetVersion' => [ - 'summary' => 'Gets information for a given dataset version.', + 'ListMetaEntityDefs' => [ + 'summary' => 'Retrieves a list of custom entity definitions, including custom entity types and extended table types.', 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -32804,365 +35088,756 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdideXGTG91', - ], + 'abilityTreeNodes' => ['FEATUREdideX3KVYR'], 'autoTest' => true, 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'query', + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '1', 'example' => '1', 'default' => '1', 'title' => '', 'required' => false], + ], + [ + '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', 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10', 'title' => '', 'required' => false], + ], + [ + 'name' => 'DisplayName', + 'in' => 'formData', + 'schema' => ['description' => 'The display name of the type definition. This parameter supports partial matching.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'CustomReport'], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['description' => 'A keyword to search for in the description. The system performs a fuzzy match.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'description'], + ], + [ + 'name' => 'Extend', + 'in' => 'formData', 'schema' => [ - 'title' => '数据集版本ID', - 'description' => 'The dataset version ID.'."\n", + 'description' => 'Filters the results by extension mode. Valid values: `NONE` and `TABLE`.', 'type' => 'string', - 'required' => true, - 'example' => ' '."\n" - .'dataworks-datasetVersion:3pXXXb8o0ngr07njhps1'."\n" - .':2', + 'enum' => ['NONE', 'TABLE'], + 'title' => '', + 'required' => false, + 'example' => 'NONE', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The sort field. Valid values: `Name`, `CreateTime`, and `ModifyTime`.', + 'type' => 'string', + 'default' => 'CreateTime', + 'enum' => ['Name', 'CreateTime', 'ModifyTime'], + 'title' => '', + 'required' => false, + 'example' => 'CreateTime', + ], + ], + [ + 'name' => 'Order', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The sort order. Valid values: `Asc` and `Desc`.', + 'type' => 'string', + 'default' => 'Asc', + 'enum' => ['Asc', 'Desc'], + 'title' => '', + 'required' => false, + 'example' => 'Asc', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => '4CDF7B72-020B-542A-8465-21CFFA8XXXXX', - ], - 'Success' => [ - 'title' => '请求是否成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'DatasetVersion' => [ - 'title' => '数据集版本', - 'description' => 'The dataset version.'."\n", - '$ref' => '#/components/schemas/DatasetVersion', + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'ADFASDFASDFA-ADFASDF-ASDFADSDF-AFFADS'], + 'Success' => ['description' => 'Indicates whether the request succeeded.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'PagingInfo' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['description' => 'The total count.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '10'], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'PageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '10'], + 'MetaEntityDefs' => [ + 'type' => 'array', + 'items' => ['description' => 'A custom entity definition.', '$ref' => '#/components/schemas/MetaEntityDef', 'title' => '', 'example' => ''], + 'title' => '', + 'description' => 'A list of custom entity definitions.', + 'example' => '', + ], + ], + 'title' => '', + 'description' => 'The pagination information.', + 'example' => '', ], ], + 'title' => '', + 'description' => 'The response schema.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListMetaEntityDefs', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4CDF7B72-020B-542A-8465-21CFFA8XXXXX\\",\\n \\"Success\\": true,\\n \\"DatasetVersion\\": {\\n \\"Id\\": \\"\\",\\n \\"DatasetId\\": \\"\\",\\n \\"Comment\\": \\"\\",\\n \\"CreatorId\\": \\"\\",\\n \\"VersionNumber\\": 0,\\n \\"StorageType\\": \\"\\",\\n \\"Url\\": \\"\\",\\n \\"MountPath\\": \\"\\",\\n \\"CreateTime\\": 0,\\n \\"ModifyTime\\": 0,\\n \\"Labels\\": [\\n {\\n \\"Key\\": \\"\\",\\n \\"Value\\": \\"\\"\\n }\\n ],\\n \\"ImportInfo\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n}","type":"json"}]', - 'title' => 'GetDatasetVersion', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ADFASDFASDFA-ADFASDF-ASDFADSDF-AFFADS\\",\\n \\"Success\\": true,\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 10,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"MetaEntityDefs\\": [\\n {\\n \\"Name\\": \\"biz_api\\",\\n \\"EntityType\\": \\"custom_entity-biz_api\\",\\n \\"DisplayName\\": \\"业务API\\",\\n \\"Description\\": \\"test\\",\\n \\"AttributeDefs\\": [\\n {\\n \\"Name\\": \\"apiCode\\",\\n \\"DisplayName\\": \\"API编码\\",\\n \\"Type\\": \\"STRING\\",\\n \\"IsOptional\\": true,\\n \\"SearchFilterEnabled\\": false,\\n \\"DisplayEnabled\\": true,\\n \\"AllowedValues\\": [\\n \\"LABEL_1\\"\\n ],\\n \\"Description\\": \\"层级描述\\"\\n }\\n ],\\n \\"Extend\\": \\"NONE\\",\\n \\"CreateTime\\": 1780553640613,\\n \\"ModifyTime\\": 1780553640613\\n }\\n ]\\n }\\n}","type":"json"}]', ], - 'CreateDatasetVersion' => [ - 'summary' => 'Creates a dataset version. Currently supports DataWorks datasets only, with a maximum of 20 versions.', - 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListMyApplications' => [ + 'summary' => 'Queries all resource access permission application orders initiated by the current user.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdideXGTG91', - ], + 'abilityTreeCode' => 'TBD', + 'abilityTreeNodes' => ['FEATUREdideYTM537'], 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'DatasetId', + 'name' => 'DefSchema', 'in' => 'formData', + 'schema' => ['description' => 'Filters by resource type.'."\n" + ."\n" + .'Note: The resource types supported by the system for applications are constrained by [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).name.'."\n" + ."\n" + .'See also: [ResourceSchema documentation for International site](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)', 'type' => 'string', 'required' => true, 'example' => 'MaxCompute', 'title' => ''], + ], + [ + 'name' => 'ResourceType', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '数据集ID，当前仅支持DataWorks数据集', - 'description' => 'The dataset ID. Currently supports DataWorks datasets only.'."\n", - 'type' => 'string', + 'description' => 'Filters by minimum permission resource type.'."\n" + ."\n" + .'Note: The minimum permission resource type is constrained by [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).resources[*].isValidLeaf being true.'."\n" + ."\n" + .'See also: [ResourceSchema documentation for International site](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)', + 'type' => 'array', + 'items' => ['description' => 'The resource type.', 'type' => 'string', 'required' => false, 'example' => 'table', 'title' => ''], 'required' => true, - 'example' => 'dataworks-dataset:3pXXXb8o0ngr07njhps1', + 'maxItems' => 5, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Comment', + 'name' => 'Resource', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '数据集版本描述,长度不超过1024', - 'description' => 'The description for this dataset version. Maximum length: 1,024 characters.'."\n", - 'type' => 'string', + 'description' => 'Filters by resource with exact or wildcard matching. The resource description is constrained by [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).'."\n" + ."\n" + .'See also: [ResourceSchema documentation for International site](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)', + 'type' => 'object', + 'properties' => [ + 'DefSchema' => ['description' => 'The resource type.'."\n" + ."\n" + .'Note: The resource types supported by the system for applications are constrained by [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).name.'."\n" + ."\n" + .'See also: [ResourceSchema documentation for International site](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)', 'type' => 'string', 'required' => false, 'example' => 'MaxCompute', 'title' => ''], + 'DefVersion' => ['description' => 'The resource parsing version, which is constrained by [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).version.'."\n" + ."\n" + .'[ResourceSchema documentation for International site](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)', 'type' => 'string', 'default' => 'v1.0.0', 'required' => false, 'example' => 'v1.0.0', 'title' => ''], + 'MetaData' => [ + 'description' => 'The resource metadata.'."\n" + ."\n" + .'Note: The metadata is constrained by [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).resources. A valid resource declaration must include the full-path metadata declarations from level 0 to the validLeaf level.'."\n" + ."\n" + .'See also: [ResourceSchema documentation for International site](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['description' => 'The resource metadata.', 'type' => 'any', 'example' => '{'."\n" + .' "workspace": "449056",'."\n" + .' "project": "sync_destination"'."\n" + .' }', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], 'required' => false, - 'example' => 'this is a comment'."\n", + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Url', + 'name' => 'StartTime', 'in' => 'formData', - 'schema' => [ - 'title' => 'URL地址', - 'description' => 'URL'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'oss://test-oss-bucket/test_dir/', - ], + 'schema' => ['description' => 'The start time of the application period (millisecond timestamp).'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1771948800000', 'title' => ''], ], [ - 'name' => 'MountPath', + 'name' => 'EndTime', 'in' => 'formData', - 'schema' => [ - 'title' => '挂载路径，需要以/mnt/开头，默认为/mnt/data', - 'description' => 'The mount path, which must start with /mnt/. Default value: /mnt/data.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '/mnt/data', - ], + 'schema' => ['description' => 'The end time of the application period (millisecond timestamp).'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1779724799999', 'title' => ''], ], [ - 'name' => 'ImportInfo', + 'name' => 'Statuses', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '数据集的存储导入配置'."\n" - .'对于NAS类型，需要提供以下属性，取值可参考DescribeFileSystems接口的返回信息'."\n" - .'- fileSystemId 文件系统ID'."\n" - .'- fileSystemStorageType 文件系统的存储规格'."\n" - .'- vpcId 挂载点的 VPC ID', - 'description' => 'The storage import configuration for the dataset. Required configuration varies by storage type.'."\n" - ."\n" - .'**NAS**'."\n" - ."\n" - .'For valid values, see the response from the file storage API DescribeFileSystems.'."\n" + 'description' => 'Filters by approval status. Valid values:'."\n" ."\n" - .'```JSON'."\n" - .'{'."\n" - .'"fileSystemId": "3b6XXX89c9", // The file system ID.'."\n" - .'"fileSystemStorageType": "Performance" // The file system storage type.'."\n" - .'"vpcId": "vpc-uf66oxxxrqge1t2gson7s" // The VPC ID for the mount point.'."\n" - .'}'."\n" - .'```'."\n", - 'type' => 'object', + .'- WaitApproval: pending approval.'."\n" + .'- Confirmed: pending authorization.'."\n" + .'- RejectApproval: approval rejected.'."\n" + .'- AuthorizeSucceed: authorization succeeded.'."\n" + .'- AuthorizeFailed: authorization failed.'."\n" + .'- Deleted: deleted.'."\n" + .'- Canceled: withdrawn.', + 'type' => 'array', + 'items' => ['description' => 'The resource status.', 'type' => 'string', 'required' => false, 'example' => 'WAIT_APPROVAL', 'title' => ''], 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'None', - 'description' => 'The dataset storage import configuration'."\n", - ], + 'example' => 'Deleted', + 'maxItems' => 3, + 'minItems' => 0, + 'title' => '', ], ], + [ + 'name' => 'NextToken', + 'in' => 'formData', + 'schema' => ['description' => 'The pagination cursor.'."\n", 'type' => 'string', 'required' => false, 'example' => 'eyJpZCI6MTIzfQ==', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 200.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '50', 'default' => '10', 'example' => '20', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The paginated result.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n", - ], - 'Success' => [ - 'title' => '是否创建成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Id' => [ - 'title' => 'ID', - 'description' => 'ID'."\n", - 'type' => 'string', - 'example' => 'dataworks-datasetVersion:3pXXXb8o0ngr07njhps1'."\n" - .':2', + 'RequestId' => ['title' => '', 'description' => 'The request ID, which is a UUID.'."\n", 'type' => 'string', 'example' => '0bc5df3a17****903790e8e8a'], + 'Data' => [ + 'description' => 'The data part of the paginated result.'."\n", + 'type' => 'object', + 'properties' => [ + 'PageSize' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 200.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'NextToken' => ['description' => 'The pagination cursor.'."\n", 'type' => 'string', 'example' => 'eyJpZCI6NDU2fQ==', 'title' => ''], + 'HasMore' => ['description' => 'Indicates whether more data is available.'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Data' => [ + 'description' => 'The list of application order details.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The approval process and application content.', + 'type' => 'object', + 'properties' => [ + 'ProcessInstanceId' => ['description' => 'The process instance ID.'."\n", 'type' => 'string', 'example' => '176906667488145', 'title' => ''], + 'DefSchema' => ['description' => 'The resource type.'."\n", 'type' => 'string', 'example' => 'MaxCompute', 'title' => ''], + 'Reason' => ['description' => 'The reason for the application.'."\n", 'type' => 'string', 'example' => '业务需要', 'title' => ''], + 'ApplicationTime' => ['description' => 'The time when the application was initiated.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1779695088000', 'title' => ''], + 'Status' => ['description' => 'The approval status. Valid values:'."\n" + ."\n" + .'- WaitApproval: pending approval.'."\n" + .'- Confirmed: pending authorization.'."\n" + .'- RejectApproval: approval rejected.'."\n" + .'- AuthorizeSucceed: authorization succeeded.'."\n" + .'- AuthorizeFailed: authorization failed.'."\n" + .'- Deleted: deleted.'."\n" + .'- Canceled: withdrawn.', 'type' => 'string', 'example' => 'Deleted', 'title' => ''], + 'Contents' => [ + 'description' => 'The application content.', + 'type' => 'array', + 'items' => [ + 'description' => 'The application content.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The primary key of the application content.'."\n", 'type' => 'string', 'example' => 'a8aa620037bb410ea13837f9b4d053d8', 'title' => ''], + 'ProcessInstanceId' => ['description' => 'The approval process instance ID of the initiated application.'."\n", 'type' => 'string', 'example' => '777799223', 'title' => ''], + 'TenantId' => ['description' => 'The tenant ID.'."\n", 'type' => 'string', 'example' => '69973837489', 'title' => ''], + 'ResourceName' => ['description' => 'The minimum permission resource type.'."\n", 'type' => 'string', 'example' => 'table', 'title' => ''], + 'DefSchema' => ['description' => 'The resource type.'."\n", 'type' => 'string', 'example' => 'MAXCOMPUTE', 'title' => ''], + 'AuthMethod' => ['description' => 'The authorization method.', 'type' => 'string', 'example' => 'default', 'title' => ''], + 'Resource' => [ + 'description' => '**The resource declaration.**'."\n", + 'type' => 'object', + 'properties' => [ + 'DefSchema' => ['description' => '**The ResourceSchema.name on which the resource parsing depends.**'."\n", 'type' => 'string', 'example' => 'MaxCompute', 'title' => ''], + 'DefVersion' => ['description' => '**The ResourceSchema.version on which the resource parsing depends.**'."\n", 'type' => 'string', 'example' => 'v1.0.0', 'title' => ''], + 'MetaData' => [ + 'description' => '**The resource metadata, whose content is constrained by ResourceSchema.**'."\n", + 'type' => 'object', + 'additionalProperties' => ['description' => 'The resource content.', 'type' => 'any', 'example' => '{'."\n" + .' "schema": "default",'."\n" + .' "threeTierModel": false,'."\n" + .' "project": "sync_dtestn",'."\n" + .' "workspace": "4477656",'."\n" + .' "table": "order",'."\n" + .' "tenant": "524257424864736"'."\n" + .' }'."\n", 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'Grantee' => [ + 'description' => '**The authorization target.**'."\n", + 'type' => 'object', + 'properties' => [ + 'PrincipalType' => ['description' => 'The principal type for authorization:'."\n" + .'- RamRole'."\n" + .'- RamUser'."\n" + .'- DataworksTenantMember'."\n" + .'- DataworksTenantRole'."\n" + .'- DataworksProjectMember'."\n" + .'- DataworksProjectRole'."\n" + .'- DlfRole'."\n", 'type' => 'string', 'example' => 'RamRole', 'title' => ''], + 'PrincipalId' => ['description' => 'The principal ID for authorization:'."\n" + .'- RamUser: DataWorks UserId.'."\n" + .'- RamRole: DataWorks UserId prefixed with "ROLE_".'."\n" + .'- DataworksTenantMember: DataWorks UserId.'."\n" + .'- DataworksTenantRole: DataWorks tenant roleCode.'."\n" + .'- DataworksProjectRole: DataWorks workspace roleCode.'."\n" + .'- DataworksProjectMember: DataWorks UserId.'."\n" + .'- DlfRole: DlfNext role name.'."\n", 'type' => 'string', 'example' => 'ROLE_3133343434', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'AccessTypes' => [ + 'description' => 'The resource operation permissions requested in the application.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The permission.', 'type' => 'string', 'example' => 'select', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'FinalAccessTypes' => [ + 'description' => 'The resource operation permissions that were finally approved.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The permission.', 'type' => 'string', 'example' => 'select', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'ExpirationTime' => ['description' => 'The permission expiration date (millisecond timestamp).'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1782354014507', 'title' => ''], + 'Status' => ['description' => 'The approval status. Valid values:'."\n" + ."\n" + .'- WaitApproval: pending approval.'."\n" + .'- Confirmed: pending authorization.'."\n" + .'- RejectApproval: approval rejected.'."\n" + .'- AuthorizeSucceed: authorization succeeded.'."\n" + .'- AuthorizeFailed: authorization failed.'."\n" + .'- Deleted: deleted.'."\n" + .'- Canceled: withdrawn.', 'type' => 'string', 'example' => 'Deleted', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2022-11-29 15:04:52', 'title' => ''], + 'UpdateTime' => ['description' => 'The update time.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2022-07-08 23:58:59', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query Permission Application Orders Initiated by Me', + 'description' => '## Request description'."\n" + .'- This API supports paginated queries, controlled by the `NextToken` and `PageSize` parameters.'."\n" + .'- `DefSchema` is a required parameter that specifies the resource type.'."\n" + .'- The `ResourceType` list can contain multiple resource types for more precise filtering of application orders.'."\n" + .'- You can set `StartTime` and `EndTime` to limit the time range of the query.'."\n" + .'- `Statuses` allows you to filter application orders by specific statuses, such as pending approval and authorized.'."\n" + .'- If you need to filter by specific resources or authorization targets, you can provide detailed information through the `Resource` and `Grantee` fields.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\\\n\\",\\n \\"Success\\": true,\\n \\"Id\\": \\"dataworks-datasetVersion:3pXXXb8o0ngr07njhps1\\\\n:2\\"\\n}","type":"json"}]', - 'title' => 'CreateDatasetVersion', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc5df3a17****903790e8e8a\\",\\n \\"Data\\": {\\n \\"PageSize\\": 20,\\n \\"NextToken\\": \\"eyJpZCI6NDU2fQ==\\",\\n \\"HasMore\\": false,\\n \\"Data\\": [\\n {\\n \\"ProcessInstanceId\\": \\"176906667488145\\",\\n \\"DefSchema\\": \\"MaxCompute\\",\\n \\"Reason\\": \\"业务需要\\",\\n \\"ApplicationTime\\": 1779695088000,\\n \\"Status\\": \\"Deleted\\",\\n \\"Contents\\": [\\n {\\n \\"Id\\": \\"a8aa620037bb410ea13837f9b4d053d8\\",\\n \\"ProcessInstanceId\\": \\"777799223\\",\\n \\"TenantId\\": \\"69973837489\\",\\n \\"ResourceName\\": \\"table\\",\\n \\"DefSchema\\": \\"MAXCOMPUTE\\",\\n \\"AuthMethod\\": \\"default\\",\\n \\"Resource\\": {\\n \\"DefSchema\\": \\"MaxCompute\\",\\n \\"DefVersion\\": \\"v1.0.0\\",\\n \\"MetaData\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"schema\\\\\\": \\\\\\"default\\\\\\",\\\\n \\\\\\"threeTierModel\\\\\\": false,\\\\n \\\\\\"project\\\\\\": \\\\\\"sync_dtestn\\\\\\",\\\\n \\\\\\"workspace\\\\\\": \\\\\\"4477656\\\\\\",\\\\n \\\\\\"table\\\\\\": \\\\\\"order\\\\\\",\\\\n \\\\\\"tenant\\\\\\": \\\\\\"524257424864736\\\\\\"\\\\n }\\\\n\\"\\n }\\n },\\n \\"Grantee\\": {\\n \\"PrincipalType\\": \\"RamRole\\",\\n \\"PrincipalId\\": \\"ROLE_3133343434\\"\\n },\\n \\"AccessTypes\\": [\\n \\"select\\"\\n ],\\n \\"FinalAccessTypes\\": [\\n \\"select\\"\\n ],\\n \\"ExpirationTime\\": 1782354014507,\\n \\"Status\\": \\"Deleted\\",\\n \\"CreateTime\\": 0,\\n \\"UpdateTime\\": 0\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', ], - 'UpdateDatasetVersion' => [ - 'summary' => 'Updates dataset version information. Only DataWorks datasets are supported. Requires dataset creator or workspace administrator permissions.', - 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListMyRelatedApprovals' => [ + 'summary' => 'Query all permission application orders where the current user is an approver or stakeholder.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdideXGTG91', - ], + 'abilityTreeCode' => 'TBD', + 'abilityTreeNodes' => ['FEATUREdideYTM537'], 'autoTest' => true, - 'tenantRelevance' => 'tenant', + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'DefSchema', + 'in' => 'formData', + 'schema' => ['description' => 'Filter by resource type.'."\n" + ."\n" + .'Note: The resource types supported by the system for applications are constrained by [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).name.'."\n" + ."\n" + .'Reference: [ResourceSchema International Site Documentation](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)', 'type' => 'string', 'required' => true, 'example' => 'MaxCompute', 'title' => ''], + ], + [ + 'name' => 'ResourceType', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '数据集版本ID,仅支持更新DataWorks数据集', - 'description' => 'The dataset version ID. Only DataWorks datasets can be updated.'."\n", - 'type' => 'string', + 'description' => 'Filter by minimum permission resource type.'."\n" + ."\n" + .'Note: The minimum permission resource type is constrained by [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).resources[*].isValidLeaf being true.'."\n" + ."\n" + .'Reference: [ResourceSchema International Site Documentation](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)', + 'type' => 'array', + 'items' => ['description' => 'Resource type', 'type' => 'string', 'required' => false, 'example' => 'project', 'title' => ''], 'required' => true, - 'example' => ' '."\n" - .'dataworks-datasetVersion:3pXXXb8o0ngr07njhps1'."\n" - .':2', + 'example' => '["table", "column"]', + 'maxItems' => 5, + 'title' => '', ], ], [ - 'name' => 'Comment', + 'name' => 'Resource', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '数据集版本描述,长度不超过1024', - 'description' => 'The dataset version description. Maximum length: 1024 characters.'."\n", - 'type' => 'string', + 'description' => 'Filter by resource with exact/generalized matching. The resource description is constrained by [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).'."\n" + ."\n" + .'Reference: [ResourceSchema International Site Documentation](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)', + 'type' => 'object', + 'properties' => [ + 'DefSchema' => ['description' => 'Resource type.'."\n" + ."\n" + .'Note: The resource types supported by the system for applications are constrained by [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).name.'."\n" + ."\n" + .'Reference: [ResourceSchema International Site Documentation](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)', 'type' => 'string', 'required' => false, 'example' => 'MaxCompute', 'title' => ''], + 'DefVersion' => ['description' => 'The resource parsing version is constrained by [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).version.'."\n" + ."\n" + .'[ResourceSchema International Site Documentation](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)', 'type' => 'string', 'default' => 'v1.0.0', 'required' => false, 'example' => 'v1.0.0', 'title' => ''], + 'MetaData' => [ + 'description' => 'Resource metadata.'."\n" + ."\n" + .'Note: The metadata is constrained by [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).resources. A valid resource declaration must include the full-path metadata declaration from level 0 to validLeaf layer.'."\n" + ."\n" + .'Reference: [ResourceSchema International Site Documentation](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['description' => 'Resource metadata', 'type' => 'any', 'example' => '{'."\n" + .' "workspace": "449056",'."\n" + .' "project": "sync_destination"'."\n" + .' }', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], 'required' => false, - 'example' => 'this is a comment', + 'title' => '', + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => ['description' => 'Application time start (millisecond timestamp)'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1771948800000', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => ['description' => 'Application time end (millisecond timestamp)'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1779724799999', 'title' => ''], + ], + [ + 'name' => 'Statuses', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'Filter by approval status. Enum values:'."\n" + ."\n" + .'- WaitApproval: Pending approval'."\n" + .'- Confirmed: Pending authorization'."\n" + .'- RejectApproval: Approval rejected'."\n" + .'- AuthorizeSucceed: Authorization succeeded'."\n" + .'- AuthorizeFailed: Authorization failed'."\n" + .'- Deleted: Deleted'."\n" + .'- Canceled: Withdrawn', + 'type' => 'array', + 'items' => ['description' => 'Approval status', 'type' => 'string', 'required' => false, 'example' => 'Deleted', 'title' => ''], + 'required' => false, + 'example' => 'WAIT_APPROVAL', + 'title' => '', + ], + ], + [ + 'name' => 'Grantee', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'Filter by authorization principal.'."\n" + ."\n" + .'Note: The authorization principal types supported by the system are constrained by [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).authPrincipal.'."\n" + ."\n" + .'Reference: [ResourceSchema International Site Documentation](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => 'A090666C-74FB-5629-ABFC-2FE99DD55XXX', - ], - 'Success' => [ - 'title' => '是否更新成功', - 'description' => 'Indicates whether the update succeeded.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'PrincipalType' => ['description' => 'Authorization principal type:'."\n" + ."\n" + .'- `RamRole`'."\n" + .'- `RamUser`'."\n" + .'- `DataworksTenantMember`'."\n" + .'- `DataworksTenantRole`'."\n" + .'- `DataworksProjectMember`'."\n" + .'- `DataworksProjectRole`'."\n" + .'- `DlfRole`'."\n", 'type' => 'string', 'required' => false, 'example' => 'RamRole', 'title' => ''], + 'PrincipalId' => ['description' => 'Authorization principal ID:'."\n" + ."\n" + .'- `RamUser`: Dataworks UserId'."\n" + .'- `RamRole`: Dataworks UserId prefixed with "ROLE_"'."\n" + .'- `DataworksTenantMember`: Dataworks UserId'."\n" + .'- `DataworksTenantRole`: Dataworks tenant roleCode'."\n" + .'- `DataworksProjectRole`: Dataworks workspace roleCode'."\n" + .'- `DataworksProjectMember`: Dataworks UserId'."\n" + .'- `DlfRole`: DlfNext role name'."\n", 'type' => 'string', 'required' => false, 'example' => 'ROLE_3133343434', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A090666C-74FB-5629-ABFC-2FE99DD55XXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'UpdateDatasetVersion', - ], - 'DeleteDatasetVersion' => [ - 'summary' => 'Deletes a dataset version. Only non-v1 DataWorks datasets are supported. To delete v1 datasets, use the DeleteDataset operation. Requires dataset creator or workspace administrator permissions.', - 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'AccessTypes', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'Filter by requested permissions.'."\n" + ."\n" + .'Note: Different resource levels support different application permission types, all constrained by [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).isValidLeaf, accessTypeRestrictions, and authMethodAccessTypes.'."\n" + ."\n" + .'Reference: [ResourceSchema International Site Documentation](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)', + 'type' => 'array', + 'items' => ['description' => 'Permission', 'type' => 'string', 'required' => false, 'example' => 'select', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdideXGTG91', + [ + 'name' => 'NextToken', + 'in' => 'formData', + 'schema' => ['description' => 'Pagination cursor'."\n", 'type' => 'string', 'required' => false, 'example' => 'eyJpZCI6MTIzfQ==', 'title' => ''], ], - 'autoTest' => true, - 'tenantRelevance' => 'tenant', - ], - 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'title' => '数据集版本ID，仅支持DataWorks数据集', - 'description' => 'The dataset version ID. Only DataWorks datasets are supported.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => ' '."\n" - .'dataworks-datasetVersion:3pXXXb8o0ngr07njhps1'."\n" - .':2', - ], + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['description' => 'Page size (default 10, maximum 200)'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '50', 'default' => '10', 'example' => '20', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => '6AABBBD3-F2E4-5860-8CF7-2E9CEE3BDXXX', - ], - 'Success' => [ - 'title' => '是否删除成功', - 'description' => 'Indicates whether the deletion succeeded.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['title' => '', 'description' => 'API request ID, generated by UUID'."\n", 'type' => 'string', 'example' => '0bc5df3a17****903790e8e8a'], + 'Data' => [ + 'description' => 'Paginated results', + 'type' => 'object', + 'properties' => [ + 'PageSize' => ['description' => 'Page size (default 10, maximum 200)'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'NextToken' => ['description' => 'Pagination cursor'."\n", 'type' => 'string', 'example' => 'eyJpZCI6NDU2fQ==', 'title' => ''], + 'HasMore' => ['description' => 'Whether there is more data'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Data' => [ + 'description' => 'Application order details', + 'type' => 'array', + 'items' => [ + 'description' => 'Approval process and application content', + 'type' => 'object', + 'properties' => [ + 'ProcessInstanceId' => ['description' => 'Process instance ID'."\n", 'type' => 'string', 'example' => '176906667488145', 'title' => ''], + 'DefSchema' => ['description' => 'Resource type'."\n", 'type' => 'string', 'example' => 'MaxCompute', 'title' => ''], + 'Reason' => ['description' => 'Application reason'."\n", 'type' => 'string', 'example' => '业务需要', 'title' => ''], + 'ApplicationTime' => ['description' => 'Application submission time'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1779695088000', 'title' => ''], + 'Status' => ['description' => 'Approval status. Enum values:'."\n" + ."\n" + .'- WaitApproval: Pending approval'."\n" + .'- Confirmed: Pending authorization'."\n" + .'- RejectApproval: Approval rejected'."\n" + .'- AuthorizeSucceed: Authorization succeeded'."\n" + .'- AuthorizeFailed: Authorization failed'."\n" + .'- Deleted: Deleted'."\n" + .'- Canceled: Withdrawn', 'type' => 'string', 'example' => 'Deleted', 'title' => ''], + 'Contents' => [ + 'description' => 'Application content', + 'type' => 'array', + 'items' => [ + 'description' => 'Application content', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'Unique identifier of the application content', 'type' => 'string', 'example' => '1009516415', 'title' => ''], + 'ProcessInstanceId' => ['description' => 'Approval process instance ID of the submitted application'."\n", 'type' => 'string', 'example' => '777799223', 'title' => ''], + 'TenantId' => ['description' => 'Tenant ID'."\n", 'type' => 'string', 'example' => '69973837489', 'title' => ''], + 'ResourceName' => ['description' => 'Minimum permission resource type'."\n", 'type' => 'string', 'example' => 'table', 'title' => ''], + 'DefSchema' => ['description' => 'Resource type'."\n", 'type' => 'string', 'example' => 'MaxCompute', 'title' => ''], + 'AuthMethod' => ['description' => 'Authorization method'."\n", 'type' => 'string', 'example' => 'default', 'title' => ''], + 'Resource' => [ + 'description' => 'Resource declaration'."\n", + 'type' => 'object', + 'properties' => [ + 'DefSchema' => ['description' => 'ResourceSchema.name that the resource parsing depends on'."\n", 'type' => 'string', 'example' => 'MaxCompute', 'title' => ''], + 'DefVersion' => ['description' => 'ResourceSchema.version that the resource parsing depends on'."\n", 'type' => 'string', 'example' => 'v1.0.0', 'title' => ''], + 'MetaData' => [ + 'description' => 'Resource metadata, data content is constrained by ResourceSchema'."\n", + 'type' => 'object', + 'additionalProperties' => ['description' => 'Resource content', 'type' => 'any', 'example' => '{'."\n" + .' "schema": "default",'."\n" + .' "threeTierModel": false,'."\n" + .' "project": "sync_dtestn",'."\n" + .' "workspace": "4477656",'."\n" + .' "table": "order",'."\n" + .' "tenant": "524257424864736"'."\n" + .' }', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'Grantee' => [ + 'description' => 'Authorization target'."\n", + 'type' => 'object', + 'properties' => [ + 'PrincipalType' => ['description' => 'Principal type. Enum values:'."\n" + ."\n" + .'- RamRole'."\n" + .'- RamUser'."\n" + .'- DataworksTenantMember'."\n" + .'- DataworksTenantRole'."\n" + .'- DataworksProjectMember'."\n" + .'- DataworksProjectRole'."\n" + .'- DlfRole', 'type' => 'string', 'example' => 'RamRole', 'title' => ''], + 'PrincipalId' => ['description' => 'Principal ID.'."\n" + ."\n" + .'Note: When principalType is a different type, it corresponds to different semantics:'."\n" + ."\n" + .'- RamUser: Dataworks UserId'."\n" + .'- RamRole: Dataworks UserId prefixed with "ROLE_"'."\n" + .'- DataworksTenantMember: Dataworks UserId'."\n" + .'- DataworksTenantRole: Dataworks tenant roleCode'."\n" + .'- DataworksProjectRole: Dataworks workspace roleCode'."\n" + .'- DataworksProjectMember: Dataworks UserId'."\n" + .'- DlfRole: DlfNext role name', 'type' => 'string', 'example' => 'ROLE_3133343434', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'AccessTypes' => [ + 'description' => 'Resource operation permissions requested in the application'."\n", + 'type' => 'array', + 'items' => ['description' => 'Permission', 'type' => 'string', 'example' => 'select', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'FinalAccessTypes' => [ + 'description' => 'Resource operation permissions finally approved'."\n", + 'type' => 'array', + 'items' => ['description' => 'Permission', 'type' => 'string', 'example' => 'select', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'ExpirationTime' => ['description' => 'Permission expiration date, millisecond timestamp'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1779695088000', 'title' => ''], + 'Status' => ['description' => 'Approval status. Enum values:'."\n" + ."\n" + .'- WaitApproval: Pending approval'."\n" + .'- Confirmed: Pending authorization'."\n" + .'- RejectApproval: Approval rejected'."\n" + .'- AuthorizeSucceed: Authorization succeeded'."\n" + .'- AuthorizeFailed: Authorization failed'."\n" + .'- Deleted: Deleted'."\n" + .'- Canceled: Withdrawn', 'type' => 'string', 'example' => 'Deleted', 'title' => ''], + 'CreateTime' => ['description' => 'Creation time'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2025-09-11 10:13:21', 'title' => ''], + 'UpdateTime' => ['description' => 'Update time'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2024-03-05 18:24:13', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query permission application orders related to me', + 'description' => '## Request Description'."\n" + .'- This API is used to retrieve all permission application orders where the current user is an approver, including pending and processed application orders.'."\n" + .'- You can use the `Statuses` parameter to filter application orders by specific status.'."\n" + .'- `NextToken` is used for paginated requests. It can be omitted or set to `null` for the first request. For subsequent requests, pass the `NextToken` value from the previous response.'."\n" + .'- `PageSize` defaults to 10, with a maximum of 200.'."\n" + .'- `DefSchema` and `ResourceType` are required fields. Other parameters can be filled in as needed.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6AABBBD3-F2E4-5860-8CF7-2E9CEE3BDXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'DeleteDatasetVersion', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc5df3a17****903790e8e8a\\",\\n \\"Data\\": {\\n \\"PageSize\\": 10,\\n \\"NextToken\\": \\"eyJpZCI6NDU2fQ==\\",\\n \\"HasMore\\": false,\\n \\"Data\\": [\\n {\\n \\"ProcessInstanceId\\": \\"176906667488145\\",\\n \\"DefSchema\\": \\"MaxCompute\\",\\n \\"Reason\\": \\"业务需要\\",\\n \\"ApplicationTime\\": 1779695088000,\\n \\"Status\\": \\"Deleted\\",\\n \\"Contents\\": [\\n {\\n \\"Id\\": \\"1009516415\\",\\n \\"ProcessInstanceId\\": \\"777799223\\",\\n \\"TenantId\\": \\"69973837489\\",\\n \\"ResourceName\\": \\"table\\",\\n \\"DefSchema\\": \\"MaxCompute\\",\\n \\"AuthMethod\\": \\"default\\",\\n \\"Resource\\": {\\n \\"DefSchema\\": \\"MaxCompute\\",\\n \\"DefVersion\\": \\"v1.0.0\\",\\n \\"MetaData\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"schema\\\\\\": \\\\\\"default\\\\\\",\\\\n \\\\\\"threeTierModel\\\\\\": false,\\\\n \\\\\\"project\\\\\\": \\\\\\"sync_dtestn\\\\\\",\\\\n \\\\\\"workspace\\\\\\": \\\\\\"4477656\\\\\\",\\\\n \\\\\\"table\\\\\\": \\\\\\"order\\\\\\",\\\\n \\\\\\"tenant\\\\\\": \\\\\\"524257424864736\\\\\\"\\\\n }\\"\\n }\\n },\\n \\"Grantee\\": {\\n \\"PrincipalType\\": \\"RamRole\\",\\n \\"PrincipalId\\": \\"ROLE_3133343434\\"\\n },\\n \\"AccessTypes\\": [\\n \\"select\\"\\n ],\\n \\"FinalAccessTypes\\": [\\n \\"select\\"\\n ],\\n \\"ExpirationTime\\": 1779695088000,\\n \\"Status\\": \\"Deleted\\",\\n \\"CreateTime\\": 0,\\n \\"UpdateTime\\": 0\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', ], - 'PreviewDatasetVersion' => [ - 'summary' => 'Previews the content of a specified dataset version. Currently only text file preview is supported for OSS-type datasets. Supported MIME types 1. application/json 2. application/xml 3. text/html 4. text/plain 5. application/octet-stream', - 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListNetworks' => [ + 'summary' => 'Retrieves a list of network resources for a serverless resource group.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -33171,98 +35846,127 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdideXGTG91', - ], - 'autoTest' => true, + 'abilityTreeCode' => '245178', + 'abilityTreeNodes' => ['FEATUREdide2SV6DS'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'title' => '数据集版本ID', - 'description' => 'The dataset version ID'."\n", - 'type' => 'string', - 'required' => true, - 'example' => ' '."\n" - .'dataworks-datasetVersion:3pXXXb8o0ngr07njhps1'."\n" - .':2', - ], + 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => true, 'example' => 'Serverless_res_group_524257424564736_6831777003****', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => ['description' => 'The fields used for sorting. Fields such as TriggerTime and StartedTime are supported. The value of this parameter is in the Sort field + Sort by (Desc/Asc) format. By default, results are sorted in ascending order. Valid values:'."\n" + ."\n" + .'- Id (Desc/Asc): the network ID'."\n" + ."\n" + .'- Status (Desc/Asc): the network status'."\n" + ."\n" + .'- CreateUser (Desc/Asc): the user who created the network'."\n" + ."\n" + .'- CreateTime (Desc/Asc): the time when the network was created'."\n" + ."\n" + .'Default value: CreateTime Asc.', 'type' => 'string', 'example' => 'CreateTime Asc', 'default' => 'CreateTime Asc', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => 'A6C6B486-E3A2-5D52-9E76-D9380485DXXX', - ], - 'Success' => [ - 'title' => '请求是否成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'PreviewResult' => [ - 'title' => '预览结果', - 'description' => 'Preview results'."\n", + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'example' => 'true'], + 'PagingInfo' => [ + 'title' => '', + 'description' => 'The pagination information.', 'type' => 'object', 'properties' => [ - 'SupportPreview' => [ - 'title' => '是否支持预览', - 'description' => 'Preview availability'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'MimeType' => [ - 'title' => 'MIME多媒体类型', - 'description' => 'The MIME type'."\n", - 'type' => 'string', - 'example' => 'text/plain', - ], - 'FileName' => [ - 'title' => '预览文件名称', - 'description' => 'File name'."\n", - 'type' => 'string', - 'example' => 'parth/data.csv', - ], - 'Content' => [ - 'title' => '预览内容', - 'description' => 'Content'."\n", - 'type' => 'string', - 'example' => 'this is content', + 'NetworkList' => [ + 'title' => '', + 'description' => 'The network resources of the serverless resource group.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The information about the network resource of the serverless resource group.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The network ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''], + 'ResourceGroupId' => ['description' => 'The ID of the serverless resource group.', 'type' => 'string', 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX', 'title' => ''], + 'VpcId' => ['description' => 'The ID of the virtual private cloud (VPC).', 'type' => 'string', 'example' => 'vpc-m2et4f3oc8msfbccXXXXX', 'title' => ''], + 'VswitchId' => ['description' => 'The VSwitch ID.', 'type' => 'string', 'example' => 'vsw-uf8usrhs7hjd9amsXXXXX', 'title' => ''], + 'SecurityGroupId' => ['description' => 'The security group ID.', 'type' => 'string', 'example' => 'sg-2ze13vamugr7jenXXXXX', 'title' => ''], + 'Status' => [ + 'description' => 'The status of the network resource. Valid values: Pending, Creating, Running, Deleting, and Deleted.', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'Running', + 'enum' => ['Pending', 'Running', 'Deleting', 'Deleted', 'Creating'], + 'title' => '', + ], + 'CreateUser' => ['description' => 'The ID of the user who creates the network resource.', 'type' => 'string', 'example' => '11075500042XXXXX', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the network resource was created. The value is a 64-bit timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1727055811000', 'title' => ''], + ], + 'example' => '', + ], + 'example' => '', ], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'default' => '100', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], ], + 'example' => '', ], + 'RequestId' => ['description' => 'The ID of the request. It is used to locate logs and troubleshoot problems.', 'type' => 'string', 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"PagingInfo\\": {\\n \\"NetworkList\\": [\\n {\\n \\"Id\\": 1000,\\n \\"ResourceGroupId\\": \\"Serverless_res_group_524257424564736_6831777003XXXXX\\",\\n \\"VpcId\\": \\"vpc-m2et4f3oc8msfbccXXXXX\\",\\n \\"VswitchId\\": \\"vsw-uf8usrhs7hjd9amsXXXXX\\",\\n \\"SecurityGroupId\\": \\"sg-2ze13vamugr7jenXXXXX\\",\\n \\"Status\\": \\"Running\\",\\n \\"CreateUser\\": \\"11075500042XXXXX\\",\\n \\"CreateTime\\": 1727055811000\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 100\\n },\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]', + 'title' => 'ListNetworks', + 'description' => 'This API operation is available for all DataWorks editions.', + 'changeSet' => [ + ['createdAt' => '2025-01-02T07:14:14.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A6C6B486-E3A2-5D52-9E76-D9380485DXXX\\",\\n \\"Success\\": true,\\n \\"PreviewResult\\": {\\n \\"SupportPreview\\": true,\\n \\"MimeType\\": \\"text/plain\\",\\n \\"FileName\\": \\"parth/data.csv\\",\\n \\"Content\\": \\"this is content\\"\\n }\\n}","type":"json"}]', - 'title' => 'PreviewDatasetVersion', - ], - 'ListPartitions' => [ - 'summary' => 'Queries a list of partitions in a table in Data Map. Only tables of the MaxCompute and E-MapReduce (EMR)-type Hive Metastore Service (HMS) metadata crawlers are supported.', - 'methods' => [ - 'get', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:ListNetworks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListNodeDependencies' => [ + 'summary' => 'Gets a paginated list of dependent nodes for a specified data development node.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -33272,260 +35976,520 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', - 'abilityTreeCode' => '268132', - 'abilityTreeNodes' => [ - 'FEATUREdideE9OA4H', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236793', + 'abilityTreeNodes' => ['FEATUREdideHO4TQP', 'FEATUREdide8FM783', 'FEATUREdideQUQUVB', 'FEATUREdideIQU97M'], ], 'parameters' => [ [ - 'name' => 'TableId', - 'in' => 'query', - 'schema' => [ - 'title' => '所属数据表的资源标识', - 'description' => 'The ID of the data table.You can refer to the ListTables API response and [Concepts related to metadata entities](~~2880092~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'maxcompute-column:11075xxxx::test_project:test_schema:test_table', - ], - ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'title' => '分区名称', - 'description' => 'The partition name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ds=20250101', - ], - ], - [ - 'name' => 'SortBy', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'title' => '排序字段，默认为CreateTime', - 'description' => 'The sort field. Default value: CreateTime. Valid values:'."\n" - ."\n" - .'* CreateTime: Creation time. Supported only for MaxCompute tables.'."\n" - .'* ModifyTime: Modification time. Supported only for MaxCompute tables.'."\n" - .'* Name: Name. Used for HMS-type tables.'."\n" - .'* RecordCount: Record count. Supported only for MaxCompute tables.'."\n" - .'* DataSize: Storage size. Supported only for MaxCompute tables.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'CreateTime', - 'default' => 'CreateTime', - 'enum' => [ - 'CreateTime', - 'ModifyTime', - 'Name', - 'RecordCount', - 'DataSize', - ], - ], + 'schema' => ['description' => 'The ID of the DataWorks workspace. You can go to the Workspace Management page in the [DataWorks console](https://workbench.data.aliyun.com/console) to obtain the workspace ID.'."\n" + ."\n" + .'This parameter is used to specify the DataWorks workspace for the API call.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10001', 'title' => ''], ], [ - 'name' => 'Order', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'title' => '排序方向，默认为Asc', - 'description' => 'The sort order. Default: Asc. Valid values:'."\n" - ."\n" - .'* Asc: Ascending order.'."\n" - .'* Desc: Descending order.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Asc', - 'default' => 'Asc', - 'enum' => [ - 'Asc', - 'Desc', - ], - ], + 'schema' => ['description' => 'The ID of the node.'."\n" + ."\n" + .'>'."\n" + ."\n" + .'The data type of this parameter is Long in SDKs earlier than V8.0.0, and is String in SDKs of V8.0.0 and later versions. **The change does not affect the normal use of the SDKs. The parameter is still returned as the type defined in the SDKs.** When you upgrade an SDK to a version later than V8.0.0, a compilation error may occur due to the type change. In this case, you must manually change the data type.'."\n" + ."\n" + .'>', 'type' => 'string', 'required' => true, 'example' => '860438872620113XXXX', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '分页页码，默认为1', - 'description' => 'The page number. Default: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'The number of the page to return. The value of this parameter must be a positive integer. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'default' => '1', 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '分页大小，默认为10，最大为100', - 'description' => 'The number of entries per page. Default: 10. Maximum: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], + 'schema' => ['description' => 'The number of entries to return on each page. Default value: 10. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '10', 'default' => '10', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response.'."\n", + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx', - ], - 'Success' => [ - 'title' => '请求是否成功', - 'description' => 'Indicates whether the request succeeded.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID. Use this ID to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => '204EAF68-CCE3-5112-8DA0-E7A60F02XXXX'], 'PagingInfo' => [ - 'title' => '分页结果', - 'description' => 'Pagination information.'."\n", + 'description' => 'The pagination settings.', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of entries.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - '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', - ], - 'PartitionList' => [ - 'title' => '数据表的分区列表', - 'description' => 'The list of table partitions.'."\n", + 'TotalCount' => ['description' => 'The total number of matching entries.', 'type' => 'string', 'example' => '90', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries to return on each page.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'PageNumber' => ['description' => 'The number of the page to return.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Nodes' => [ + 'description' => 'A list of dependent nodes.', 'type' => 'array', 'items' => [ - 'title' => '数据表的分区', - 'description' => 'The table partition.'."\n", - '$ref' => '#/components/schemas/Partition', + 'description' => 'Details of a dependent node.', + 'type' => 'object', + 'properties' => [ + 'Description' => ['description' => 'The description of the node.', 'type' => 'string', 'title' => '', 'example' => 'Node description'], + 'Name' => ['description' => 'The name of the data development node.', 'type' => 'string', 'title' => '', 'example' => 'Node name'], + 'ProjectId' => ['description' => 'The ID of the project that contains the node.', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'example' => '65133', 'title' => ''], + 'Owner' => ['description' => 'The owner of the data development node.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '110755000425XXXX'], + 'CreateTime' => ['description' => 'The creation timestamp of the data development node.', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '1724505917000'], + 'ModifyTime' => ['description' => 'The last modification timestamp of the data development node.', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '1724505917000'], + 'DataSource' => [ + 'title' => '', + 'description' => 'The data source.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The data source name.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'odps_first'], + 'Type' => ['description' => 'The data source type.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'odps'], + ], + 'deprecated' => false, + 'example' => '', + ], + 'TaskId' => ['description' => 'The ID of the scheduling task.', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '580667964888595XXXX'], + 'Tags' => [ + 'title' => '', + 'description' => 'A list of tags. This parameter is currently not in use.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'A single tag. This parameter is currently not in use.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'null'], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'null'], + ], + 'deprecated' => false, + 'example' => '', + ], + 'deprecated' => false, + 'example' => '', + ], + 'Strategy' => [ + 'title' => '', + 'description' => 'The scheduling strategy.', + 'type' => 'object', + 'properties' => [ + 'Timeout' => ['description' => 'The timeout period, in milliseconds.', 'type' => 'integer', 'format' => 'int32', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '0'], + 'InstanceMode' => [ + 'description' => 'The instance generation mode.'."\n" + ."\n" + .'- T+1'."\n" + ."\n" + .'- Immediately', + 'enumValueTitles' => [], + 'type' => 'string', + 'deprecated' => false, + 'pattern' => '', + 'default' => '', + 'enum' => ['T+1', 'Immediately'], + 'title' => '', + 'example' => 'T+1', + ], + 'RerunMode' => [ + 'description' => 'The rerun mode.'."\n" + ."\n" + .'- Allowed'."\n" + ."\n" + .'- Denied'."\n" + ."\n" + .'- FailureAllowed', + 'enumValueTitles' => [], + 'type' => 'string', + 'deprecated' => false, + 'pattern' => '', + 'default' => '', + 'enum' => ['Allowed', 'Denied', 'FailureAllowed'], + 'title' => '', + 'example' => 'Allowed', + ], + 'RerunTimes' => ['description' => 'The number of retries after a failure.', 'type' => 'integer', 'format' => 'int32', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '3'], + 'RerunInterval' => ['description' => 'The retry interval after a failure, in milliseconds.', 'type' => 'integer', 'format' => 'int32', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '180000'], + ], + 'deprecated' => false, + 'example' => '', + ], + 'Outputs' => [ + 'title' => '', + 'description' => 'Details about the node\'s outputs.', + 'type' => 'object', + 'properties' => [ + 'Variables' => [ + 'title' => '', + 'description' => 'A list of variables.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'A variable.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the variable.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'output'], + 'ArtifactType' => ['description' => 'The artifact type.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'Variable'], + 'Scope' => [ + 'description' => 'The scope of the variable.'."\n" + ."\n" + .'- NodeParameter'."\n" + ."\n" + .'- NodeContext'."\n" + ."\n" + .'- Workflow'."\n" + ."\n" + .'- Workspace', + 'enumValueTitles' => [], + 'type' => 'string', + 'deprecated' => false, + 'pattern' => '', + 'default' => '', + 'title' => '', + 'example' => 'NodeParameter', + ], + 'Type' => [ + 'description' => 'The type of the variable.'."\n" + ."\n" + .'- NoKvVariableExpression'."\n" + ."\n" + .'- Constant'."\n" + ."\n" + .'- PassThrough'."\n" + ."\n" + .'- System'."\n" + ."\n" + .'- NodeOutput', + 'enumValueTitles' => [], + 'type' => 'string', + 'deprecated' => false, + 'pattern' => '', + 'default' => '', + 'title' => '', + 'example' => 'Constant', + ], + 'Value' => ['description' => 'The value of the variable.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '111'], + 'Node' => [ + 'title' => '', + 'description' => 'The node to which the variable belongs.', + 'type' => 'object', + 'properties' => [ + 'Output' => ['description' => 'The node output that corresponds to the variable.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '463497880880954XXXX'], + ], + 'deprecated' => false, + 'example' => '', + ], + 'Id' => ['description' => 'The ID of the variable.'."\n" + ."\n" + .'>'."\n" + ."\n" + .'The data type for this parameter is `Long` for SDKs earlier than v8.0.0 and `String` for SDK v8.0.0 and later. **This change does not affect normal usage, as the parameter\'s data type matches the SDK definition.** However, upgrading from a pre-8.0.0 SDK version may cause a compilation error, requiring you to manually update the data type in your code.'."\n" + ."\n" + .'>', 'type' => 'string', 'deprecated' => false, 'example' => '543217824470354XXXX', 'title' => ''], + ], + 'deprecated' => false, + 'example' => '', + ], + 'deprecated' => false, + 'example' => '', + ], + 'NodeOutputs' => [ + 'title' => '', + 'description' => 'A list of node outputs.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'A node output item.', + 'type' => 'object', + 'properties' => [ + 'Data' => ['description' => 'The node output.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '463497880880954XXXX'], + 'RefTableName' => ['description' => 'A human-readable name for the node\'s target data table. This identifier is for display purposes only and does not enforce logical constraints.', 'type' => 'string', 'example' => 'testProject.testTableName', 'title' => ''], + ], + 'deprecated' => false, + 'example' => '', + ], + 'deprecated' => false, + 'example' => '', + ], + 'Tables' => [ + 'title' => '', + 'description' => 'A list of tables.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'A table output item.', + 'type' => 'object', + 'properties' => [ + 'Guid' => ['description' => 'The ID of the table.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'odps.autotest.test_output_table_1'], + ], + 'deprecated' => false, + 'example' => '', + ], + 'deprecated' => false, + 'example' => '', + ], + ], + 'deprecated' => false, + 'example' => '', + ], + 'Inputs' => [ + 'title' => '', + 'description' => 'Details about the node\'s inputs.', + 'type' => 'object', + 'properties' => [ + 'Variables' => [ + 'title' => '', + 'description' => 'A list of variables.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'A variable.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the variable.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'input'], + 'ArtifactType' => ['description' => 'The artifact type.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'Variable'], + 'Scope' => [ + 'description' => 'The scope of the variable.'."\n" + ."\n" + .'- NodeParameter'."\n" + ."\n" + .'- NodeContext'."\n" + ."\n" + .'- Workflow'."\n" + ."\n" + .'- Workspace', + 'enumValueTitles' => [], + 'type' => 'string', + 'deprecated' => false, + 'pattern' => '', + 'default' => '', + 'title' => '', + 'example' => 'NodeParameter', + ], + 'Type' => [ + 'description' => 'The type of the variable.'."\n" + ."\n" + .'- NoKvVariableExpression'."\n" + ."\n" + .'- Constant'."\n" + ."\n" + .'- PassThrough'."\n" + ."\n" + .'- System'."\n" + ."\n" + .'- NodeOutput', + 'enumValueTitles' => [], + 'type' => 'string', + 'deprecated' => false, + 'pattern' => '', + 'default' => '', + 'title' => '', + 'example' => 'Constant', + ], + 'Value' => ['description' => 'The value of the variable.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '111'], + 'Node' => [ + 'title' => '', + 'description' => 'The node to which the variable belongs.', + 'type' => 'object', + 'properties' => [ + 'Output' => ['description' => 'The node output.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '860438872620113XXXX'], + ], + 'deprecated' => false, + 'example' => '', + ], + 'Id' => ['description' => 'The ID of the variable.'."\n" + ."\n" + .'>'."\n" + ."\n" + .'The data type for this parameter is `Long` for SDKs earlier than v8.0.0 and `String` for SDK v8.0.0 and later. **This change does not affect normal usage, as the parameter\'s data type matches the SDK definition.** However, upgrading from a pre-8.0.0 SDK version may cause a compilation error, requiring you to manually update the data type in your code.'."\n" + ."\n" + .'>', 'type' => 'string', 'deprecated' => false, 'example' => '543218872620113XXXX', 'title' => ''], + ], + 'deprecated' => false, + 'example' => '', + ], + 'deprecated' => false, + 'example' => '', + ], + 'NodeOutputs' => [ + 'title' => '', + 'description' => 'A list of node outputs.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'A node output item.', + 'type' => 'object', + 'properties' => [ + 'Data' => ['description' => 'The node output.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '860438872620113XXXX'], + 'RefTableName' => ['description' => 'A human-readable name for the node\'s target data table. This identifier is for display purposes only and does not enforce logical constraints.', 'type' => 'string', 'example' => 'testProject.testTableName', 'title' => ''], + ], + 'deprecated' => false, + 'example' => '', + ], + 'deprecated' => false, + 'example' => '', + ], + 'Tables' => [ + 'title' => '', + 'description' => 'A list of tables.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'A table output item.', + 'type' => 'object', + 'properties' => [ + 'Guid' => ['description' => 'The ID of the table.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'odps.autotest.test_output_table_1'], + ], + 'deprecated' => false, + 'example' => '', + ], + 'deprecated' => false, + 'example' => '', + ], + ], + 'deprecated' => false, + 'example' => '', + ], + 'Trigger' => [ + 'title' => '', + 'description' => 'The trigger.', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The trigger type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- `Scheduler`: Periodic scheduling.'."\n" + ."\n" + .'- `Manual`: Manual scheduling.'."\n" + ."\n" + .'- `Streaming`: Stream-based scheduling.', + 'enumValueTitles' => [], + 'type' => 'string', + 'deprecated' => false, + 'pattern' => '', + 'default' => '', + 'title' => '', + 'example' => 'Scheduler', + ], + 'Cron' => ['description' => 'The cron expression used for scheduling.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '00 00 00 * * ?'], + 'StartTime' => ['description' => 'The time when scheduling becomes effective, in `yyyy-MM-dd HH:mm:ss` format.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '1970-01-01 00:00:00'], + 'EndTime' => ['description' => 'The time when scheduling expires, in `yyyy-MM-dd HH:mm:ss` format.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '9999-01-01 00:00:00'], + 'Timezone' => ['description' => 'The time zone.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'Asia/Shanghai'], + 'Id' => ['description' => 'The unique ID of the trigger.'."\n" + ."\n" + .'>'."\n" + ."\n" + .'The data type for this parameter is `Long` for SDKs earlier than v8.0.0 and `String` for SDK v8.0.0 and later. **This change does not affect normal usage, as the parameter\'s data type matches the SDK definition.** However, upgrading from a pre-8.0.0 SDK version may cause a compilation error, requiring you to manually update the data type in your code.'."\n" + ."\n" + .'>', 'type' => 'string', 'deprecated' => false, 'example' => '543680677872062XXXX', 'title' => ''], + ], + 'deprecated' => false, + 'example' => '', + ], + 'Script' => [ + 'title' => '', + 'description' => 'Details about the script.', + 'type' => 'object', + 'properties' => [ + 'Path' => ['description' => 'The path of the script.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'root/demo'], + 'Runtime' => [ + 'title' => '', + 'description' => 'The runtime environment.', + 'type' => 'object', + 'properties' => [ + 'Command' => ['description' => 'The command that is used to distinguish between node types.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'ODPS_SQL'], + ], + 'deprecated' => false, + 'example' => '', + ], + 'Id' => ['description' => 'The ID of the script.'."\n" + ."\n" + .'>'."\n" + ."\n" + .'The data type for this parameter is `Long` for SDKs earlier than v8.0.0 and `String` for SDK v8.0.0 and later. **This change does not affect normal usage, as the parameter\'s data type matches the SDK definition.** However, upgrading from a pre-8.0.0 SDK version may cause a compilation error, requiring you to manually update the data type in your code.'."\n" + ."\n" + .'>', 'type' => 'string', 'deprecated' => false, 'example' => '853573334108680XXXX', 'title' => ''], + ], + 'deprecated' => false, + 'required' => false, + 'example' => '', + ], + 'RuntimeResource' => [ + 'title' => '', + 'description' => 'Details about the resource group.', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupId' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'S_res_group_XXXX_XXXX'], + ], + 'deprecated' => false, + 'example' => '', + ], + 'Recurrence' => [ + 'description' => 'The execution mode of the node.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- `Normal`: The node runs as normal.'."\n" + ."\n" + .'- `Pause`: The node is paused. This action blocks the execution of downstream nodes that depend on this node.'."\n" + ."\n" + .'- `Skip`: The node is skipped (dry run). The system immediately returns a success status with an execution time of 0 seconds. This action does not block downstream nodes or consume resources.', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'Normal', + 'title' => '', + ], + 'Id' => ['description' => 'The unique ID of the data development node.'."\n" + ."\n" + .'>'."\n" + ."\n" + .'The data type for this parameter is `Long` for SDKs earlier than v8.0.0 and `String` for SDK v8.0.0 and later. **This change does not affect normal usage, as the parameter\'s data type matches the SDK definition.** However, upgrading from a pre-8.0.0 SDK version may cause a compilation error, requiring you to manually update the data type in your code.'."\n" + ."\n" + .'>', 'type' => 'string', 'example' => '723932906364267XXXX', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx\\",\\n \\"Success\\": true,\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"PartitionList\\": [\\n {\\n \\"TableId\\": \\"maxcompute-table:accountId::project::table\\",\\n \\"Name\\": \\"ds=20250101\\",\\n \\"CreateTime\\": 1700192563000,\\n \\"ModifyTime\\": 1700192563000,\\n \\"RecordCount\\": 1000000,\\n \\"DataSize\\": 4096\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListPartitions', - ], - 'GetPartition' => [ - 'summary' => 'Retrieves partition details for a data map table. Currently supports MaxCompute and HMS (EMR cluster) types only.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"204EAF68-CCE3-5112-8DA0-E7A60F02XXXX\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": \\"90\\",\\n \\"PageSize\\": \\"10\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"Nodes\\": [\\n {\\n \\"Description\\": \\"Node description\\",\\n \\"Name\\": \\"Node name\\",\\n \\"ProjectId\\": 65133,\\n \\"Owner\\": \\"110755000425XXXX\\",\\n \\"CreateTime\\": 1724505917000,\\n \\"ModifyTime\\": 1724505917000,\\n \\"DataSource\\": {\\n \\"Name\\": \\"odps_first\\",\\n \\"Type\\": \\"odps\\"\\n },\\n \\"TaskId\\": 0,\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"null\\",\\n \\"Value\\": \\"null\\"\\n }\\n ],\\n \\"Strategy\\": {\\n \\"Timeout\\": 0,\\n \\"InstanceMode\\": \\"T+1\\",\\n \\"RerunMode\\": \\"Allowed\\",\\n \\"RerunTimes\\": 3,\\n \\"RerunInterval\\": 180000\\n },\\n \\"Outputs\\": {\\n \\"Variables\\": [\\n {\\n \\"Name\\": \\"output\\",\\n \\"ArtifactType\\": \\"Variable\\",\\n \\"Scope\\": \\"NodeParameter\\",\\n \\"Type\\": \\"Constant\\",\\n \\"Value\\": \\"111\\",\\n \\"Node\\": {\\n \\"Output\\": \\"463497880880954XXXX\\"\\n },\\n \\"Id\\": \\"543217824470354XXXX\\"\\n }\\n ],\\n \\"NodeOutputs\\": [\\n {\\n \\"Data\\": \\"463497880880954XXXX\\",\\n \\"RefTableName\\": \\"testProject.testTableName\\"\\n }\\n ],\\n \\"Tables\\": [\\n {\\n \\"Guid\\": \\"odps.autotest.test_output_table_1\\"\\n }\\n ]\\n },\\n \\"Inputs\\": {\\n \\"Variables\\": [\\n {\\n \\"Name\\": \\"input\\",\\n \\"ArtifactType\\": \\"Variable\\",\\n \\"Scope\\": \\"NodeParameter\\",\\n \\"Type\\": \\"Constant\\",\\n \\"Value\\": \\"111\\",\\n \\"Node\\": {\\n \\"Output\\": \\"860438872620113XXXX\\"\\n },\\n \\"Id\\": \\"543218872620113XXXX\\"\\n }\\n ],\\n \\"NodeOutputs\\": [\\n {\\n \\"Data\\": \\"860438872620113XXXX\\",\\n \\"RefTableName\\": \\"testProject.testTableName\\"\\n }\\n ],\\n \\"Tables\\": [\\n {\\n \\"Guid\\": \\"odps.autotest.test_output_table_1\\"\\n }\\n ]\\n },\\n \\"Trigger\\": {\\n \\"Type\\": \\"Scheduler\\",\\n \\"Cron\\": \\"00 00 00 * * ?\\",\\n \\"StartTime\\": \\"1970-01-01 00:00:00\\",\\n \\"EndTime\\": \\"9999-01-01 00:00:00\\",\\n \\"Timezone\\": \\"Asia/Shanghai\\",\\n \\"Id\\": \\"543680677872062XXXX\\"\\n },\\n \\"Script\\": {\\n \\"Path\\": \\"root/demo\\",\\n \\"Runtime\\": {\\n \\"Command\\": \\"ODPS_SQL\\"\\n },\\n \\"Id\\": \\"853573334108680XXXX\\"\\n },\\n \\"RuntimeResource\\": {\\n \\"ResourceGroupId\\": \\"S_res_group_XXXX_XXXX\\"\\n },\\n \\"Recurrence\\": \\"Normal\\",\\n \\"Id\\": \\"723932906364267XXXX\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListNodeDependencies', + 'changeSet' => [ + ['createdAt' => '2025-01-13T07:36:03.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'abilityTreeCode' => '268141', - 'abilityTreeNodes' => [ - 'FEATUREdideE9XYA6', - ], + 'flowControl' => [ + 'flowControlList' => [], ], - 'parameters' => [ - [ - 'name' => 'TableId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The table ID. You can refer to the result returned by the ListTables operation and [Concepts related to metadata entities](~~2880092~~).'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'maxcompute-column:11075xxxx::test_project:test_schema:test_table', - ], - ], + 'ramActions' => [ [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'title' => '分区名称', - 'description' => 'The partition name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ds=20250101', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx', - ], - 'Success' => [ - 'title' => '请求是否成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Partition' => [ - 'description' => 'Partition details.'."\n", - '$ref' => '#/components/schemas/Partition', - ], + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx\\",\\n \\"Success\\": true,\\n \\"Partition\\": {\\n \\"TableId\\": \\"maxcompute-table:accountId::project::table\\",\\n \\"Name\\": \\"ds=20250101\\",\\n \\"CreateTime\\": 1700192563000,\\n \\"ModifyTime\\": 1700192563000,\\n \\"RecordCount\\": 1000000,\\n \\"DataSize\\": 4096\\n }\\n}","type":"json"}]', - 'title' => 'GetPartition', - 'description' => '1. This API operation is available for all DataWorks editions.'."\n" - .'2. This operation supports MaxCompute and HMS (EMR cluster) tables only.'."\n", ], - 'ListLineageRelationships' => [ - 'summary' => 'Queries the lineage between two entities, such as tables, fields, and Object Storage Service (OSS) files, in Data Map.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListNodes' => [ + 'summary' => 'Retrieves a paginated list of data development nodes that can be filtered by specified criteria.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -33535,255 +36499,582 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'list', - 'abilityTreeCode' => '268106', - 'abilityTreeNodes' => [ - 'FEATUREdideE9OA4H', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236792', + 'abilityTreeNodes' => ['FEATUREdideHO4TQP'], ], 'parameters' => [ [ - 'name' => 'SrcEntityId', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'title' => '父层级实体ID', - 'description' => 'The source entity ID. For more information, see the table ID or field ID in the response returned by the ListTables or ListColumns operation. You can also specify a custom entity ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'maxcompute-table:123456XXX::test_project::test_tbl'."\n" - .'dlf-table:123456XXX:test_catalog:test_db::test_tbl'."\n" - .'hms-table:c-abc123xxx::test_db::test_tbl'."\n" - .'holo-table:h-abc123xxx::test_db:test_schema:test_tbl'."\n" - .'custom-api:api123'."\n" - .'custom-table:table456', - ], + 'schema' => ['description' => 'The ID of the DataWorks workspace. To find this ID, log in to the [DataWorks console](https://workbench.data.aliyun.com/console) and navigate to the workspace configuration page.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12345', 'title' => ''], ], [ - 'name' => 'DstEntityId', + 'name' => 'Scene', 'in' => 'query', 'schema' => [ - 'description' => 'The destination entity ID. For more information, see the table ID or field ID in the response returned by the ListTables or ListColumns operation. You can also specify a custom entity ID.'."\n", + 'description' => 'The context for filtering nodes. In data development, this corresponds to the sections in the directory tree on the left. If you omit this parameter, no filtering is applied. Valid values:'."\n" + ."\n" + .'- DataworksProject: Nodes in the project directory.'."\n" + ."\n" + .'- DataworksManualWorkflow: manual workflow'."\n" + ."\n" + .'- DataworksManualTask: manual task', + 'enumValueTitles' => [], 'type' => 'string', - 'required' => true, - 'example' => 'maxcompute-table:123456XXX::test_project::test_tbl'."\n" - .'dlf-table:123456XXX:test_catalog:test_db::test_tbl'."\n" - .'hms-table:c-abc123xxx::test_db::test_tbl'."\n" - .'holo-table:h-abc123xxx::test_db:test_schema:test_tbl'."\n" - .'custom-api:api123'."\n" - .'custom-table:table456', + 'required' => false, + 'example' => 'DataworksProject', + 'title' => '', ], ], [ - 'name' => 'SrcEntityName', + 'name' => 'ContainerId', 'in' => 'query', - 'schema' => [ - 'title' => '名称', - 'description' => 'The source entity name. Supports fuzzy matching.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'srcName', - ], + 'schema' => ['description' => 'The ID of the container. If you specify this parameter, only nodes in the specified container are returned. This parameter is independent of the resource group (ResourceGroupId).'."\n" + ."\n" + .'>'."\n" + ."\n" + .'This parameter is of the Long type in SDK versions earlier than 8.0.0 and of the String type in SDK 8.0.0 and later. **This change does not affect SDK usage. The parameter is returned in the type defined for your SDK version.** The type change may cause compilation errors only when you upgrade the SDK across version 8.0.0. In this case, you must manually correct the data type.'."\n" + ."\n" + .'>', 'type' => 'string', 'required' => false, 'example' => '860438872620113XXXX', 'title' => ''], ], [ - 'name' => 'DstEntityName', + 'name' => 'Recurrence', 'in' => 'query', 'schema' => [ - 'description' => 'The destination entity name. Supports fuzzy matching.'."\n", + 'description' => 'Filters nodes by their scheduling type. Valid values:'."\n" + ."\n" + .'- Normal: The node runs as scheduled.'."\n" + ."\n" + .'- Pause: The node is paused and blocks its dependent downstream nodes.'."\n" + ."\n" + .'- Skip: The node is skipped, and the system immediately returns a success status with a 0-second execution time. This action does not block downstream nodes or consume resources.', + 'enumValueTitles' => [], 'type' => 'string', 'required' => false, - 'example' => 'dstName', + 'example' => 'Normal', + 'title' => '', ], ], [ - 'name' => 'SortBy', + 'name' => 'RerunMode', 'in' => 'query', 'schema' => [ - 'title' => '排序字段，默认为Name', - 'description' => 'The sort field. Default value: Name.'."\n", + 'description' => 'The rerun mode. Valid values:'."\n" + ."\n" + .'- Allowed: The node can be rerun regardless of whether it succeeded or failed.'."\n" + ."\n" + .'- FailureAllowed: The node can be rerun only if its previous run failed.'."\n" + ."\n" + .'- Denied: The node cannot be rerun regardless of whether it succeeded or failed.', + 'enumValueTitles' => [], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Name', - 'default' => 'Name', - 'enum' => [ - 'Name', - ], + 'example' => 'Allowed', + 'title' => '', ], ], [ - 'name' => 'Order', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'title' => '排序方向，默认为Asc', - 'description' => 'The order in which schemas are sorted. Default value: Asc. Valid values:'."\n" - ."\n" - .'* Asc: ascending.'."\n" - .'* Desc: descending.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Asc', - 'default' => 'Asc', - 'enum' => [ - 'Asc', - 'Desc', - ], - ], + 'schema' => ['description' => 'The node name. Fuzzy search is supported.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '分页页码，默认为1', - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'The page number of the results to return.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '2147483647', 'minimum' => '1', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '分页大小，默认为10，最大为100', - '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', - ], + 'schema' => ['description' => 'The number of entries per page. Default: 10. Maximum: 100.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '10', 'default' => '10', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID. Used for locating and troubleshooting issues.'."\n", - 'type' => 'string', - 'example' => 'SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF', - ], - 'Success' => [ - 'title' => '请求是否成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID. You can use this ID to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => '2197B9C4-39CE-55EA-8EEA-FDBAE52DXXXX'], 'PagingInfo' => [ - 'title' => '分页结果', - 'description' => 'The pagination result.'."\n", + 'description' => 'The paging information.', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total count.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The page size.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'LineageRelationships' => [ - 'title' => '数据表列表', - 'description' => 'The list of data tables.'."\n", + 'TotalCount' => ['description' => 'The total number of entries that meet the specified filter criteria.', 'type' => 'string', 'example' => '42', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'PageNumber' => ['description' => 'The page number of the returned data.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Nodes' => [ + 'description' => 'The list of nodes.', 'type' => 'array', 'items' => [ - 'description' => 'The lineage structure.'."\n", - '$ref' => '#/components/schemas/LineageRelationship', + 'description' => 'The details of a node.', + 'type' => 'object', + 'properties' => [ + 'Description' => ['description' => 'The description of the node.', 'type' => 'string', 'title' => '', 'example' => 'Node description'."\n"], + 'Name' => ['description' => 'The name of the node.', 'type' => 'string', 'title' => '', 'example' => 'test'], + 'ProjectId' => ['description' => 'The ID of the DataWorks workspace. You can find this ID on the Workspace Management page in the [DataWorks console](https://workbench.data.aliyun.com/console).', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'example' => '33233', 'title' => ''], + 'Owner' => ['description' => 'The owner of the node.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '110755000425XXXX'], + 'CreateTime' => ['description' => 'The creation timestamp of the node.', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '1722910655000'], + 'ModifyTime' => ['description' => 'The last modification timestamp of the node.', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '1722910655000'], + 'DataSource' => [ + 'title' => '', + 'description' => 'The data source.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the data source.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'odps_first'], + 'Type' => ['description' => 'The type of the data source.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'odps'], + ], + 'deprecated' => false, + 'example' => '', + ], + 'TaskId' => ['description' => 'The ID of the scheduling task.', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '88888888888'], + 'Tags' => [ + 'title' => '', + 'description' => 'The tags for the node. This parameter is not in use.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'A single tag. This parameter is not in use.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'null'], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'null'], + ], + 'deprecated' => false, + 'example' => '', + ], + 'deprecated' => false, + 'example' => '', + ], + 'Strategy' => [ + 'title' => '', + 'description' => 'The scheduling strategy.', + 'type' => 'object', + 'properties' => [ + 'Timeout' => ['description' => 'The timeout duration.', 'type' => 'integer', 'format' => 'int32', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '0'], + 'InstanceMode' => [ + 'description' => 'The instance generation mode.'."\n" + ."\n" + .'- `T+1`'."\n" + ."\n" + .'- `Immediately`', + 'enumValueTitles' => [], + 'type' => 'string', + 'deprecated' => false, + 'pattern' => '', + 'default' => '', + 'enum' => ['T+1', 'Immediately'], + 'title' => '', + 'example' => 'T+1', + ], + 'RerunMode' => [ + 'description' => 'The rerun mode.'."\n" + ."\n" + .'- `Allowed`'."\n" + ."\n" + .'- `Denied`'."\n" + ."\n" + .'- `FailureAllowed`', + 'enumValueTitles' => [], + 'type' => 'string', + 'deprecated' => false, + 'pattern' => '', + 'default' => '', + 'enum' => ['Allowed', 'Denied', 'FailureAllowed'], + 'title' => '', + 'example' => 'Allowed', + ], + 'RerunTimes' => ['description' => 'The number of retries.', 'type' => 'integer', 'format' => 'int32', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '3'], + 'RerunInterval' => ['description' => 'The retry interval, in milliseconds.', 'type' => 'integer', 'format' => 'int32', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '180000'], + ], + 'deprecated' => false, + 'example' => '', + ], + 'Outputs' => [ + 'title' => '', + 'description' => 'The node outputs.', + 'type' => 'object', + 'properties' => [ + 'Variables' => [ + 'title' => '', + 'description' => 'The list of variables.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The details of a variable.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the variable.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'output'."\n"], + 'ArtifactType' => ['description' => 'The artifact type.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'Variable'], + 'Scope' => [ + 'description' => 'The scope of the variable.'."\n" + ."\n" + .'- `NodeParameter`'."\n" + ."\n" + .'- `NodeContext`'."\n" + ."\n" + .'- `Workflow`'."\n" + ."\n" + .'- `Workspace`', + 'enumValueTitles' => [], + 'type' => 'string', + 'deprecated' => false, + 'pattern' => '', + 'default' => '', + 'title' => '', + 'example' => 'NodeParameter', + ], + 'Type' => [ + 'description' => 'The type of the variable.'."\n" + ."\n" + .'- `NoKvVariableExpression`'."\n" + ."\n" + .'- `Constant`'."\n" + ."\n" + .'- `PassThrough`'."\n" + ."\n" + .'- `System`'."\n" + ."\n" + .'- `NodeOutput`', + 'enumValueTitles' => [], + 'type' => 'string', + 'deprecated' => false, + 'pattern' => '', + 'default' => '', + 'title' => '', + 'example' => 'Constant', + ], + 'Value' => ['description' => 'The value of the variable.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '111'], + 'Node' => [ + 'title' => '', + 'description' => 'The node to which the variable belongs.', + 'type' => 'object', + 'properties' => [ + 'Output' => ['description' => 'The node output.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '860438872620113XXXX'], + ], + 'deprecated' => false, + 'example' => '', + ], + 'Id' => ['description' => 'The variable ID.'."\n" + ."\n" + .'>'."\n" + ."\n" + .'This parameter is a `Long` in SDKs earlier than v8.0.0 and a `String` in v8.0.0 and later. **This change does not impact normal SDK use, as the parameter is returned in the type defined by your SDK.** Upgrading the SDK across v8.0.0 may cause compilation errors, which you must resolve by manually updating the data type.'."\n" + ."\n" + .'>', 'type' => 'string', 'deprecated' => false, 'example' => '623731286945488XXXX', 'title' => ''], + ], + 'deprecated' => false, + 'example' => '', + ], + 'deprecated' => false, + 'example' => '', + ], + 'NodeOutputs' => [ + 'title' => '', + 'description' => 'The list of node outputs.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'A node output item.', + 'type' => 'object', + 'properties' => [ + 'Data' => ['description' => 'The node output.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '860438872620113XXXX'], + 'RefTableName' => ['description' => 'A human-readable name for the output data table. This name is for display purposes only and has no functional effect.', 'type' => 'string', 'example' => 'testProject.testTableName', 'title' => ''], + ], + 'deprecated' => false, + 'example' => '', + ], + 'deprecated' => false, + 'example' => '', + ], + 'Tables' => [ + 'title' => '', + 'description' => 'The list of tables.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'A table output item.', + 'type' => 'object', + 'properties' => [ + 'Guid' => ['description' => 'The ID of the table.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'odps.autotest.test_output_table_1'], + ], + 'deprecated' => false, + 'example' => '', + ], + 'deprecated' => false, + 'example' => '', + ], + ], + 'deprecated' => false, + 'example' => '', + ], + 'Inputs' => [ + 'title' => '', + 'description' => 'The node inputs.', + 'type' => 'object', + 'properties' => [ + 'Variables' => [ + 'title' => '', + 'description' => 'The list of variables.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The details of a variable.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the variable.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'input'], + 'ArtifactType' => ['description' => 'The artifact type.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'Variable'], + 'Scope' => [ + 'description' => 'The scope of the variable.'."\n" + ."\n" + .'- `WorkSpace`'."\n" + ."\n" + .'- `NodeParameter`'."\n" + ."\n" + .'- `NodeContext`'."\n" + ."\n" + .'- `Workflow`', + 'enumValueTitles' => [], + 'type' => 'string', + 'deprecated' => false, + 'pattern' => '', + 'default' => '', + 'title' => '', + 'example' => 'NodeParameter', + ], + 'Type' => [ + 'description' => 'The type of the variable.'."\n" + ."\n" + .'- `NoKvVariableExpression`'."\n" + ."\n" + .'- `Constant`'."\n" + ."\n" + .'- `PassThrough`'."\n" + ."\n" + .'- `System`'."\n" + ."\n" + .'- `NodeOutput`', + 'enumValueTitles' => [], + 'type' => 'string', + 'deprecated' => false, + 'pattern' => '', + 'default' => '', + 'title' => '', + 'example' => 'Constant', + ], + 'Value' => ['description' => 'The value of the variable.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '222'], + 'Node' => [ + 'title' => '', + 'description' => 'The node to which the variable belongs.', + 'type' => 'object', + 'properties' => [ + 'Output' => ['description' => 'The node output.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '623731286945488XXXX'], + ], + 'deprecated' => false, + 'example' => '', + ], + 'Id' => ['description' => 'The variable ID.'."\n" + ."\n" + .'>'."\n" + ."\n" + .'This parameter is a `Long` in SDKs earlier than v8.0.0 and a `String` in v8.0.0 and later. **This change does not impact normal SDK use, as the parameter is returned in the type defined by your SDK.** Upgrading the SDK across v8.0.0 may cause compilation errors, which you must resolve by manually updating the data type.'."\n" + ."\n" + .'>', 'type' => 'string', 'deprecated' => false, 'example' => '543211286945488XXXX', 'title' => ''], + ], + 'deprecated' => false, + 'example' => '', + ], + 'deprecated' => false, + 'example' => '', + ], + 'NodeOutputs' => [ + 'title' => '', + 'description' => 'The list of node outputs.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'A node output item.', + 'type' => 'object', + 'properties' => [ + 'Data' => ['description' => 'The node output.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '623731286945488XXXX'], + 'RefTableName' => ['description' => 'A human-readable name for the input data table. This name is for display purposes only and has no functional effect.', 'type' => 'string', 'example' => 'testProject.testTableName', 'title' => ''], + ], + 'deprecated' => false, + 'example' => '', + ], + 'deprecated' => false, + 'example' => '', + ], + 'Tables' => [ + 'title' => '', + 'description' => 'The list of tables.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'A table output item.', + 'type' => 'object', + 'properties' => [ + 'Guid' => ['description' => 'The ID of the table.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'odps.autotest.test_output_table_1'], + ], + 'deprecated' => false, + 'example' => '', + ], + 'deprecated' => false, + 'example' => '', + ], + ], + 'deprecated' => false, + 'example' => '', + ], + 'Trigger' => [ + 'title' => '', + 'description' => 'The trigger.', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The type of the trigger.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- `Scheduler`: periodic scheduling'."\n" + ."\n" + .'- `Manual`: manual trigger'."\n" + ."\n" + .'- `Streaming`: streaming task', + 'enumValueTitles' => [], + 'type' => 'string', + 'deprecated' => false, + 'pattern' => '', + 'default' => '', + 'title' => '', + 'example' => 'Scheduler', + ], + 'Cron' => ['description' => 'The cron expression.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '00 00 00 * * ?'], + 'StartTime' => ['description' => 'The start of the trigger\'s validity period.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '1970-01-01 00:00:00'], + 'EndTime' => ['description' => 'The end of the trigger\'s validity period.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '9999-01-01 00:00:00'], + 'Timezone' => ['description' => 'The time zone.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'Asia/Shanghai'], + 'Id' => ['description' => 'The ID of the trigger.'."\n" + ."\n" + .'>'."\n" + ."\n" + .'This parameter is a `Long` in SDKs earlier than v8.0.0 and a `String` in v8.0.0 and later. **This change does not impact normal SDK use, as the parameter is returned in the type defined by your SDK.** Upgrading the SDK across v8.0.0 may cause compilation errors, which you must resolve by manually updating the data type.'."\n" + ."\n" + .'>', 'type' => 'string', 'deprecated' => false, 'example' => '543680677872062XXXX', 'title' => ''], + ], + 'deprecated' => false, + 'example' => '', + ], + 'Script' => [ + 'title' => '', + 'description' => 'Information about the script.', + 'type' => 'object', + 'properties' => [ + 'Path' => ['description' => 'The path of the script.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'root/demo'], + 'Runtime' => [ + 'title' => '', + 'description' => 'The runtime.', + 'type' => 'object', + 'properties' => [ + 'Command' => ['description' => 'The command that identifies the node type.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'ODPS_SQL'], + ], + 'deprecated' => false, + 'example' => '', + ], + 'Id' => ['description' => 'The ID of the script.'."\n" + ."\n" + .'>'."\n" + ."\n" + .'This parameter is a `Long` in SDKs earlier than v8.0.0 and a `String` in v8.0.0 and later. **This change does not impact normal SDK use, as the parameter is returned in the type defined by your SDK.** Upgrading the SDK across v8.0.0 may cause compilation errors, which you must resolve by manually updating the data type.'."\n" + ."\n" + .'>', 'type' => 'string', 'deprecated' => false, 'example' => '853573334108680XXXX', 'title' => ''], + ], + 'deprecated' => false, + 'required' => false, + 'example' => '', + ], + 'RuntimeResource' => [ + 'title' => '', + 'description' => 'Information about the resource group.', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupId' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '123456XXX'], + 'ResourceGroup' => ['description' => 'The identifier of the resource group. You can obtain this identifier by calling the [ListResourceGroups](~~173913~~) operation.', 'type' => 'string', 'example' => 'S_res_group_XXXX', 'title' => ''], + ], + 'deprecated' => false, + 'example' => '', + ], + 'Recurrence' => [ + 'description' => 'The scheduling type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- `Normal`: The node runs as scheduled.'."\n" + ."\n" + .'- `Pause`: The node is paused and blocks the execution of its downstream nodes.'."\n" + ."\n" + .'- `Skip`: The node is skipped. The system immediately returns a success status with an execution duration of 0 seconds. This does not block downstream nodes or consume resources.', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'Normal', + 'title' => '', + ], + 'Id' => ['description' => 'The unique identifier of the data development node.'."\n" + ."\n" + .'>'."\n" + ."\n" + .'This parameter is a `Long` in SDKs earlier than v8.0.0 and a `String` in v8.0.0 and later. **This change does not impact normal SDK use, as the parameter is returned in the type defined by your SDK.** Upgrading the SDK across v8.0.0 may cause compilation errors, which you must resolve by manually updating the data type.'."\n" + ."\n" + .'>', 'type' => 'string', 'example' => '860438872620113XXXX', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF\\",\\n \\"Success\\": true,\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 123,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"LineageRelationships\\": [\\n {\\n \\"SrcEntity\\": {\\n \\"Id\\": \\"maxcompute-table:123456::test_project::test_tbl\\",\\n \\"Name\\": \\"test_tbl\\",\\n \\"Attributes\\": {\\n \\"key\\": \\"key1:value1\\"\\n }\\n },\\n \\"DstEntity\\": {\\n \\"Id\\": \\"maxcompute-table:123456::test_project::test_tbl\\",\\n \\"Name\\": \\"test_tbl\\",\\n \\"Attributes\\": {\\n \\"key\\": \\"key1:value1\\"\\n }\\n },\\n \\"Task\\": {\\n \\"Id\\": \\"12345\\",\\n \\"Type\\": \\"custom-sql\\",\\n \\"Attributes\\": {\\n \\"key\\": \\"key1:value21\\"\\n }\\n },\\n \\"Id\\": \\"maxcompute-table.p.table:custom-table.xxx:custom-sql.123\\",\\n \\"CreateTime\\": 1743040581000\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListLineageRelationships', - ], - 'GetLineageRelationship' => [ - 'summary' => 'Queries the information about a lineage in Data Map.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2197B9C4-39CE-55EA-8EEA-FDBAE52DXXXX\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": \\"42\\",\\n \\"PageSize\\": \\"10\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"Nodes\\": [\\n {\\n \\"Description\\": \\"Node description\\\\n\\",\\n \\"Name\\": \\"test\\",\\n \\"ProjectId\\": 33233,\\n \\"Owner\\": \\"110755000425XXXX\\",\\n \\"CreateTime\\": 1722910655000,\\n \\"ModifyTime\\": 1722910655000,\\n \\"DataSource\\": {\\n \\"Name\\": \\"odps_first\\",\\n \\"Type\\": \\"odps\\"\\n },\\n \\"TaskId\\": 88888888888,\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"null\\",\\n \\"Value\\": \\"null\\"\\n }\\n ],\\n \\"Strategy\\": {\\n \\"Timeout\\": 0,\\n \\"InstanceMode\\": \\"T+1\\",\\n \\"RerunMode\\": \\"Allowed\\",\\n \\"RerunTimes\\": 3,\\n \\"RerunInterval\\": 180000\\n },\\n \\"Outputs\\": {\\n \\"Variables\\": [\\n {\\n \\"Name\\": \\"output\\\\n\\",\\n \\"ArtifactType\\": \\"Variable\\",\\n \\"Scope\\": \\"NodeParameter\\",\\n \\"Type\\": \\"Constant\\",\\n \\"Value\\": \\"111\\",\\n \\"Node\\": {\\n \\"Output\\": \\"860438872620113XXXX\\"\\n },\\n \\"Id\\": \\"623731286945488XXXX\\"\\n }\\n ],\\n \\"NodeOutputs\\": [\\n {\\n \\"Data\\": \\"860438872620113XXXX\\",\\n \\"RefTableName\\": \\"testProject.testTableName\\"\\n }\\n ],\\n \\"Tables\\": [\\n {\\n \\"Guid\\": \\"odps.autotest.test_output_table_1\\"\\n }\\n ]\\n },\\n \\"Inputs\\": {\\n \\"Variables\\": [\\n {\\n \\"Name\\": \\"input\\",\\n \\"ArtifactType\\": \\"Variable\\",\\n \\"Scope\\": \\"NodeParameter\\",\\n \\"Type\\": \\"Constant\\",\\n \\"Value\\": \\"222\\",\\n \\"Node\\": {\\n \\"Output\\": \\"623731286945488XXXX\\"\\n },\\n \\"Id\\": \\"543211286945488XXXX\\"\\n }\\n ],\\n \\"NodeOutputs\\": [\\n {\\n \\"Data\\": \\"623731286945488XXXX\\",\\n \\"RefTableName\\": \\"testProject.testTableName\\"\\n }\\n ],\\n \\"Tables\\": [\\n {\\n \\"Guid\\": \\"odps.autotest.test_output_table_1\\"\\n }\\n ]\\n },\\n \\"Trigger\\": {\\n \\"Type\\": \\"Scheduler\\",\\n \\"Cron\\": \\"00 00 00 * * ?\\",\\n \\"StartTime\\": \\"1970-01-01 00:00:00\\",\\n \\"EndTime\\": \\"9999-01-01 00:00:00\\",\\n \\"Timezone\\": \\"Asia/Shanghai\\",\\n \\"Id\\": \\"543680677872062XXXX\\"\\n },\\n \\"Script\\": {\\n \\"Path\\": \\"root/demo\\",\\n \\"Runtime\\": {\\n \\"Command\\": \\"ODPS_SQL\\"\\n },\\n \\"Id\\": \\"853573334108680XXXX\\"\\n },\\n \\"RuntimeResource\\": {\\n \\"ResourceGroupId\\": \\"123456XXX\\",\\n \\"ResourceGroup\\": \\"S_res_group_XXXX\\"\\n },\\n \\"Recurrence\\": \\"Normal\\",\\n \\"Id\\": \\"860438872620113XXXX\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListNodes', + 'changeSet' => [ + ['createdAt' => '2025-04-02T02:48:34.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-01-13T07:48:25.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-01-13T07:36:01.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2024-10-11T02:17:18.000Z', 'description' => 'Request parameters changed'], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'abilityTreeCode' => '268092', - 'abilityTreeNodes' => [ - 'FEATUREdideE9XYA6', - ], + 'flowControl' => [ + 'flowControlList' => [], ], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => 'The lineage ID. You can refer to the return result of the ListLineageRelationships operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '110xxxx:custom-table.xxxxx:maxcompute-table.project.test_big_lineage_080901:custom-sqlxx.00001', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '58D5334A-B013-430E', - ], - 'LineageRelationship' => [ - 'description' => 'The lineage structure.'."\n", - '$ref' => '#/components/schemas/LineageRelationship', - ], + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"58D5334A-B013-430E\\",\\n \\"LineageRelationship\\": {\\n \\"SrcEntity\\": {\\n \\"Id\\": \\"maxcompute-table:123456::test_project::test_tbl\\",\\n \\"Name\\": \\"test_tbl\\",\\n \\"Attributes\\": {\\n \\"key\\": \\"key1:value1\\"\\n }\\n },\\n \\"DstEntity\\": {\\n \\"Id\\": \\"maxcompute-table:123456::test_project::test_tbl\\",\\n \\"Name\\": \\"test_tbl\\",\\n \\"Attributes\\": {\\n \\"key\\": \\"key1:value1\\"\\n }\\n },\\n \\"Task\\": {\\n \\"Id\\": \\"12345\\",\\n \\"Type\\": \\"custom-sql\\",\\n \\"Attributes\\": {\\n \\"key\\": \\"key1:value21\\"\\n }\\n },\\n \\"Id\\": \\"maxcompute-table.p.table:custom-table.xxx:custom-sql.123\\",\\n \\"CreateTime\\": 1743040581000\\n }\\n}","type":"json"}]', - 'title' => 'GetLineageRelationship', ], - 'DeleteLineageRelationship' => [ - 'summary' => 'Deletes a lineage in Data Map.', - 'methods' => [ - 'delete', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListParameterVersions' => [ + 'summary' => 'Lists parameter versions.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -33792,357 +37083,128 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'list', 'riskType' => 'none', - 'abilityTreeCode' => '268096', - 'abilityTreeNodes' => [ - 'FEATUREdideE9XYA6', - ], + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB'], + 'autoTest' => true, ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'formData', - 'schema' => [ - 'description' => 'The lineage ID. You can refer to the ListLineageRelationships operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '110xxxx:custom-table.xxxxx:maxcompute-table.project.test_big_lineage_080901:custom-sqlxx.00001'."\n", - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '952795279527ab****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true: success.'."\n" - .'* false: failure.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"952795279527ab****\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'DeleteLineageRelationship', - ], - 'CreateLineageRelationship' => [ - 'summary' => 'Registers lineage relationships in Data Map. At least one end of the relationship must be a custom object. This interface allows you to connect custom objects (such as external reports or third-party system tables) with metadata entities managed by DataWorks.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '268107', - 'abilityTreeNodes' => [ - 'FEATUREdideE9OA4H', - ], - ], - 'parameters' => [ - [ - 'name' => 'SrcEntity', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The source entity.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/LineageEntity', - ], - ], - [ - 'name' => 'DstEntity', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The destination entity.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/LineageEntity', - ], - ], - [ - 'name' => 'Task', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The task information.'."\n", - 'required' => false, - '$ref' => '#/components/schemas/LineageTask', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID. The unique identifier of a request.'."\n", - 'type' => 'string', - 'example' => 'C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490', - ], - 'Success' => [ - 'title' => '请求是否成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Id' => [ - 'description' => 'The lineage ID.'."\n", - 'type' => 'string', - 'example' => '110xxxx:custom-table.xxxxx:maxcompute-table.project.test_big_lineage_080901:custom-sqlxx.00001'."\n", - ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490\\",\\n \\"Success\\": true,\\n \\"Id\\": \\"4as3dasf654a\\"\\n}","type":"json"}]', - 'title' => 'CreateLineageRelationship', - ], - 'ListLineages' => [ - 'summary' => 'Queries a list of ancestor and descendant entities of an entity in Data Map. You can specify whether to return the lineage between the entities.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '268105', - 'abilityTreeNodes' => [ - 'FEATUREdideE9OA4H', - ], - ], - 'parameters' => [ - [ - 'name' => 'SrcEntityId', - 'in' => 'query', - 'schema' => [ - 'title' => '父层级实体ID', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'maxcompute-table:::project_name:[schema_name]:table_name', - ], - ], - [ - 'name' => 'DstEntityId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'dlf-table::catalog_id:database_name::table_name', - ], - ], - [ - 'name' => 'SrcEntityName', - 'in' => 'query', - 'schema' => [ - 'title' => '名称', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'srcName1', - ], - ], - [ - 'name' => 'DstEntityName', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'dstName1', - ], - ], - [ - 'name' => 'NeedAttachRelationship', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - 'default' => 'false', - ], + 'schema' => ['description' => 'The parameter ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12345', 'title' => ''], ], [ 'name' => 'SortBy', - 'in' => 'query', - 'schema' => [ - 'title' => '排序字段，默认为Name', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Name', - 'default' => 'Name', - 'enum' => [ - 'Name', - ], - ], + 'in' => 'formData', + 'schema' => ['description' => 'Specifies the sort criterion in the format \\ \\. You can omit Asc for ascending order. The only valid value for the sort field is:'."\n" + ."\n" + .'- Version (Desc/Asc)', 'type' => 'string', 'example' => 'Version Desc', 'required' => false, 'title' => ''], ], [ - 'name' => 'Order', - 'in' => 'query', - 'schema' => [ - 'title' => '排序方向，默认为Asc', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'Asc', - 'default' => 'Asc', - 'enum' => [ - 'Asc', - 'Desc', - ], - ], + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies the number of entries to return per page. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'default' => '20', 'required' => false, 'title' => ''], ], [ 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'title' => '分页页码，默认为1', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'title' => '分页大小，默认为10，最大为100', - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '100', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], + 'in' => 'formData', + 'schema' => ['description' => 'Specifies the page number of the results to return. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1', 'required' => false, 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => '', - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'Success' => [ - 'title' => '请求是否成功', - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], 'PagingInfo' => [ - 'title' => '分页结果', - 'description' => '', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'PageNumber' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Lineages' => [ - 'title' => '数据表列表', - 'description' => '', + 'TotalCount' => ['description' => 'The total count.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '20'], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ParameterVersion' => [ 'type' => 'array', 'items' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'SrcEntity' => [ - 'description' => '', - '$ref' => '#/components/schemas/LineageEntity', - ], - 'DstEntity' => [ - 'description' => '', - '$ref' => '#/components/schemas/LineageEntity', - ], - 'Relationships' => [ - 'description' => '', + 'Id' => ['description' => 'The parameter ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '12345', 'title' => ''], + 'Name' => ['description' => 'The parameter name.', 'type' => 'string', 'example' => 'workspace.para', 'title' => ''], + 'Type' => ['description' => 'The type of the parameter. Valid values:'."\n" + ."\n" + .'- `PlainConstant`: a plaintext constant.'."\n" + ."\n" + .'- `SecretConstant`: a secret constant.'."\n" + ."\n" + .'- `Variable`: a variable.', 'type' => 'string', 'example' => 'PlainConstant', 'title' => ''], + 'Scope' => ['description' => 'The scope of the parameter.', 'type' => 'string', 'example' => 'Project', 'title' => ''], + 'ProjectId' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''], + 'Version' => ['description' => 'The version number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Description' => ['description' => 'The parameter description.', 'type' => 'string', 'example' => 'This is a test parameter.', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1640000000000', 'title' => ''], + 'ModifyTime' => ['description' => 'The modification time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1640000000000', 'title' => ''], + 'Owner' => ['description' => 'The ID of the owner.', 'type' => 'string', 'example' => '123456789', 'title' => ''], + 'CreateUser' => ['description' => 'The ID of the creator.', 'type' => 'string', 'example' => '123456789', 'title' => ''], + 'ModifyUser' => ['description' => 'The ID of the modifier.', 'type' => 'string', 'example' => '123456789', 'title' => ''], + 'Properties' => [ 'type' => 'array', 'items' => [ - 'description' => '', - '$ref' => '#/components/schemas/LineageRelationship', + 'type' => 'object', + 'properties' => [ + 'EnvType' => ['description' => 'The environment type. Valid values:'."\n" + ."\n" + .'- `Prod`: production environment'."\n" + ."\n" + .'- `Dev`: development environment', 'type' => 'string', 'example' => 'Prod', 'title' => ''], + 'Value' => ['description' => 'The parameter value.', 'type' => 'string', 'example' => 'value123', 'title' => ''], + ], + 'title' => '', + 'description' => 'A configuration of the parameter value for a specific environment.', + 'example' => '', ], + 'title' => '', + 'description' => 'The environment-specific configurations of the parameter value.', + 'example' => '', ], ], + 'title' => '', + 'description' => 'The details of a parameter version.', + 'example' => '', ], + 'title' => '', + 'description' => 'The list of parameter versions.', + 'example' => '', ], ], + 'title' => '', + 'description' => 'The pagination information.', + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', 'title' => ''], ], + 'title' => '', + 'description' => 'The data returned by the API.', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"Success\\": true,\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 12,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Lineages\\": [\\n {\\n \\"SrcEntity\\": {\\n \\"Id\\": \\"maxcompute-table:123456::test_project::test_tbl\\",\\n \\"Name\\": \\"test_tbl\\",\\n \\"Attributes\\": {\\n \\"key\\": \\"key1:value1\\"\\n }\\n },\\n \\"DstEntity\\": {\\n \\"Id\\": \\"maxcompute-table:123456::test_project::test_tbl\\",\\n \\"Name\\": \\"test_tbl\\",\\n \\"Attributes\\": {\\n \\"key\\": \\"key1:value1\\"\\n }\\n },\\n \\"Relationships\\": [\\n {\\n \\"SrcEntity\\": {\\n \\"Id\\": \\"maxcompute-table:123456::test_project::test_tbl\\",\\n \\"Name\\": \\"test_tbl\\",\\n \\"Attributes\\": {\\n \\"key\\": \\"key1:value1\\"\\n }\\n },\\n \\"Task\\": {\\n \\"Id\\": \\"12345\\",\\n \\"Type\\": \\"custom-sql\\",\\n \\"Attributes\\": {\\n \\"key\\": \\"key1:value21\\"\\n }\\n },\\n \\"Id\\": \\"maxcompute-table.p.table:custom-table.xxx:custom-sql.123\\",\\n \\"CreateTime\\": 1743040581000\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListLineages', - ], - 'ListMetaCollections' => [ - 'summary' => 'Queries a list of collections in Data Map. Collections include categories and data albums.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListParameterVersions', + 'description' => 'This feature is available in DataWorks Professional Edition and higher editions.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 10,\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"ParameterVersion\\": [\\n {\\n \\"Id\\": 12345,\\n \\"Name\\": \\"workspace.para\\",\\n \\"Type\\": \\"PlainConstant\\",\\n \\"Scope\\": \\"Project\\",\\n \\"ProjectId\\": 1000,\\n \\"Version\\": 1,\\n \\"Description\\": \\"This is a test parameter.\\",\\n \\"CreateTime\\": 1640000000000,\\n \\"ModifyTime\\": 1640000000000,\\n \\"Owner\\": \\"123456789\\",\\n \\"CreateUser\\": \\"123456789\\",\\n \\"ModifyUser\\": \\"123456789\\",\\n \\"Properties\\": [\\n {\\n \\"EnvType\\": \\"Prod\\",\\n \\"Value\\": \\"value123\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'ListParameters' => [ + 'summary' => 'Query parameters.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -34154,620 +37216,789 @@ 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '266685', - 'abilityTreeNodes' => [ - 'FEATUREdideE9XYA6', - ], + 'abilityTreeNodes' => ['FEATUREdide7WF1GB'], 'autoTest' => true, ], 'parameters' => [ [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'description' => 'The collection type. Valid values:'."\n" - ."\n" - .'* Category'."\n" - .'* Album'."\n" - .'* AlbumCategory: Album subcategory'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Category', - 'enum' => [ - 'Category', - 'Album', - 'AlbumCategory', - ], - ], + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The workspace ID. Call the ListProjects operation to get the workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'required' => false, 'title' => ''], ], [ - 'name' => 'ParentId', - 'in' => 'query', + 'name' => 'Scope', + 'in' => 'formData', 'schema' => [ - 'description' => 'The ID of the parent collection.'."\n", + 'description' => 'The scope of the parameter. The default value is Project. Other values are not supported.', 'type' => 'string', + 'example' => 'Project', + 'default' => 'Project', + 'enum' => ['Project'], 'required' => false, - 'example' => 'category.123', + 'title' => '', ], ], [ - 'name' => 'Name', - 'in' => 'query', + 'name' => 'Type', + 'in' => 'formData', 'schema' => [ - 'description' => 'The collection name. Supports fuzzy matching.'."\n", + 'description' => 'The type of the parameter. Valid values:'."\n" + ."\n" + .'- PlainConstant: A plaintext constant.'."\n" + ."\n" + .'- SecretConstant: A secret constant.'."\n" + ."\n" + .'- Variable: A variable.', 'type' => 'string', + 'example' => 'PlainConstant', + 'enum' => ['PlainConstant', 'SecretConstant', 'Variable'], 'required' => false, - 'example' => 'test', + 'title' => '', ], ], [ - 'name' => 'Description', - 'in' => 'query', + 'name' => 'Ids', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The collection description. Supports fuzzy matching.'."\n", - 'type' => 'string', + 'type' => 'array', + 'items' => ['description' => 'The parameter ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', 'title' => ''], + 'description' => 'A list of parameter IDs.', 'required' => false, + 'title' => '', 'example' => '', ], ], [ - 'name' => 'CreateUser', - 'in' => 'query', + 'name' => 'Names', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The creator user ID. Valid only for album types. Default: The current user ID.'."\n", - 'type' => 'string', + 'type' => 'array', + 'items' => ['description' => 'The parameter name.', 'type' => 'string', 'required' => false, 'example' => 'workspace.para', 'title' => ''], + 'description' => 'A list of parameter names.', 'required' => false, - 'example' => '123456', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Administrator', - 'in' => 'query', - 'schema' => [ - 'description' => 'The administrator ID. Valid only for album types. Default: The current user ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '12345', - ], + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => ['description' => 'The account ID of the owner.', 'type' => 'string', 'example' => '123456789', 'required' => false, 'title' => ''], ], [ 'name' => 'SortBy', - 'in' => 'query', - 'schema' => [ - 'description' => 'The sort field. Valid values:'."\n" - ."\n" - .'* Id (default)'."\n" - .'* Name'."\n" - .'* CreateUser: Creator ID'."\n" - .'* CreateTime: Creation time'."\n" - .'* ModifyTime: Modification time'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Name', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The field to sort the parameters by. Specify the value in the "FieldName SortOrder" format. The Asc sort order is optional. Supported values are:'."\n" + ."\n" + .'- ModifyTime (Desc/Asc)'."\n" + ."\n" + .'- CreateTime (Desc/Asc)'."\n" + ."\n" + .'- Name (Desc/Asc)', 'type' => 'string', 'example' => 'ModifyTime Desc', 'required' => false, 'title' => ''], ], [ - 'name' => 'Order', - 'in' => 'query', - 'schema' => [ - 'description' => 'The sort order. Valid values:'."\n" - ."\n" - .'* Asc (default): Ascending order'."\n" - .'* Desc'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Asc', - ], + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['description' => 'The number of entries per page. Default: 20.', 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'default' => '20', 'required' => false, 'title' => ''], ], [ 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default: 10. Maximum: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The page number. Default: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1', 'required' => false, 'title' => ''], ], ], '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' => 'E25887B7-579C-54A5-9C4F-83A0DE367DDE', - ], - 'Data' => [ - 'title' => '分页结果', - 'description' => 'Pagination information.'."\n", + 'PagingInfo' => [ 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of records.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - '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', - ], - 'MetaCollections' => [ - 'description' => 'The list of collections.'."\n", + 'TotalCount' => ['description' => 'The total number of parameters.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + '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' => ''], + 'Parameters' => [ 'type' => 'array', 'items' => [ - 'description' => 'The collection.'."\n", 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'The collection name.'."\n", - 'type' => 'string', - 'example' => 'test_category', - ], - 'Id' => [ - 'description' => 'The collection name.'."\n", - 'type' => 'string', - 'example' => 'category.123'."\n" - ."\n", - ], - 'ParentId' => [ - 'description' => 'The ID of the parent collection. Can be empty.'."\n", - 'type' => 'string', - 'example' => 'category.1', - ], - 'Description' => [ - 'description' => 'The collection description.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Type' => [ - 'description' => 'The collection type. Valid values:'."\n" - ."\n" - .'* Category'."\n" - .'* Album'."\n" - .'* AlbumCategory: Album subcategory'."\n", - 'type' => 'string', - 'example' => 'Category', - ], - 'CreateUser' => [ - 'description' => 'The creator user ID.'."\n", - 'type' => 'string', - 'example' => '456789', - ], - 'CreateTime' => [ - 'description' => 'The creation time in milliseconds (timestamp).'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1668568601000', - ], - 'ModifyTime' => [ - 'description' => 'The modification time in milliseconds (timestamp).'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1668568601000', - ], - 'Administrators' => [ - 'description' => 'The list of administrator IDs. Supported only for album types. Administrators must be users within the same tenant. Multiple administrators can be specified.'."\n", + 'Id' => ['description' => 'The parameter ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '12345', 'title' => ''], + 'Name' => ['description' => 'The parameter name.', 'type' => 'string', 'example' => 'workspace.para', 'title' => ''], + 'Type' => ['description' => 'The parameter type. Valid values:'."\n" + ."\n" + .'- `PlainConstant`: a plaintext constant'."\n" + ."\n" + .'- `SecretConstant`: an encrypted constant'."\n" + ."\n" + .'- `Variable`: a variable', 'type' => 'string', 'example' => 'PlainConstant', 'title' => ''], + 'Scope' => ['description' => 'The parameter scope.', 'type' => 'string', 'example' => 'Project', 'title' => ''], + 'ProjectId' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''], + 'Version' => ['description' => 'The version number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Description' => ['description' => 'The parameter description.', 'type' => 'string', 'example' => 'This is a test parameter.', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the parameter was created. This value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1640000000000', 'title' => ''], + 'ModifyTime' => ['description' => 'The time when the parameter was last modified. This value is a UNIX timestamp in milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '1640000000000', 'title' => ''], + 'Owner' => ['description' => 'The Alibaba Cloud account ID of the owner.', 'type' => 'string', 'example' => '123456789', 'title' => ''], + 'CreateUser' => ['description' => 'The Alibaba Cloud account ID of the creator.', 'type' => 'string', 'example' => '123456789', 'title' => ''], + 'ModifyUser' => ['description' => 'The Alibaba Cloud account ID of the user who last modified the parameter.', 'type' => 'string', 'example' => '123456789', 'title' => ''], + 'Properties' => [ 'type' => 'array', 'items' => [ - 'description' => 'The administrator ID.'."\n", - 'type' => 'string', - 'example' => '765432', + 'type' => 'object', + 'properties' => [ + 'EnvType' => ['description' => 'The environment type. Valid values:'."\n" + ."\n" + .'- `Prod`: production environment'."\n" + ."\n" + .'- `Dev`: development environment', 'type' => 'string', 'example' => 'Prod', 'title' => ''], + 'Value' => ['description' => 'The parameter value.', 'type' => 'string', 'example' => 'value123', 'title' => ''], + ], + 'title' => '', + 'description' => 'An object that contains the parameter value for a specific environment.', + 'example' => '', ], + 'title' => '', + 'description' => 'The environment-specific values for the parameter.', + 'example' => '', ], ], + 'title' => '', + 'description' => 'The details of a parameter.', + 'example' => '', ], + 'title' => '', + 'description' => 'A list of parameters.', + 'example' => '', ], ], + 'title' => '', + 'description' => 'The pagination information.', + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', 'title' => ''], ], + 'title' => '', + 'description' => 'The response data.', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E25887B7-XXXX-54A5-9C4F-83A0DE367DDE\\",\\n \\"Data\\": {\\n \\"TotalCount\\": 10,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"MetaCollections\\": [\\n {\\n \\"Name\\": \\"test_category\\",\\n \\"Id\\": \\"7a65sd7aasd\\",\\n \\"ParentId\\": \\"as78d756asd\\",\\n \\"Description\\": \\"测试类目\\",\\n \\"Type\\": \\"Category\\",\\n \\"CreateUser\\": \\"456789\\",\\n \\"CreateTime\\": 1668568601000,\\n \\"ModifyTime\\": 1668568601000,\\n \\"Administrators\\": [\\n \\"765432\\"\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListMetaCollections', - ], - 'CreateMetaCollection' => [ - 'summary' => 'Creates a collection in Data Map. Collections include categories, subcategories, data albums, and categories that are created in the data albums.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListParameters', + 'description' => 'This feature is available in DataWorks Professional Edition or higher.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 100,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Parameters\\": [\\n {\\n \\"Id\\": 12345,\\n \\"Name\\": \\"workspace.para\\",\\n \\"Type\\": \\"PlainConstant\\",\\n \\"Scope\\": \\"Project\\",\\n \\"ProjectId\\": 1000,\\n \\"Version\\": 1,\\n \\"Description\\": \\"This is a test parameter.\\",\\n \\"CreateTime\\": 1640000000000,\\n \\"ModifyTime\\": 1640000000000,\\n \\"Owner\\": \\"123456789\\",\\n \\"CreateUser\\": \\"123456789\\",\\n \\"ModifyUser\\": \\"123456789\\",\\n \\"Properties\\": [\\n {\\n \\"EnvType\\": \\"Prod\\",\\n \\"Value\\": \\"value123\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'ListPartitions' => [ + 'summary' => 'Queries a list of partitions in a table in Data Map. Only tables of the MaxCompute and E-MapReduce (EMR)-type Hive Metastore Service (HMS) metadata crawlers are supported.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'abilityTreeCode' => '266523', - 'abilityTreeNodes' => [ - 'FEATUREdideE9XYA6', - ], - 'tenantRelevance' => 'publicInformation', + 'operationType' => 'list', + 'abilityTreeCode' => '268132', + 'abilityTreeNodes' => ['FEATUREdideE9OA4H'], ], 'parameters' => [ [ - 'name' => 'ParentId', + 'name' => 'TableId', 'in' => 'query', - 'schema' => [ - 'description' => 'The parent collection ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'category.123', - ], + 'schema' => ['description' => 'The ID of the data table.You can refer to the ListTables API response and [Concepts related to metadata entities](~~2880092~~).', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'maxcompute-table:::project_name:[schema_name]:table_name'], ], [ 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the collection.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test_album', - ], + 'schema' => ['description' => 'The partition name.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'ds=20250101'], ], [ - 'name' => 'Type', + 'name' => 'SortBy', 'in' => 'query', 'schema' => [ - 'description' => 'The collection name.'."\n" + 'description' => 'The sort field. Default value: CreateTime. Valid values:'."\n" ."\n" - .'* Category'."\n" - .'* Album'."\n" - .'* AlbumCategory: Album subcategory.'."\n", - 'type' => 'string', - 'required' => true, + .'- CreateTime: Creation time. Supported only for MaxCompute tables.'."\n" + ."\n" + .'- ModifyTime: Modification time. Supported only for MaxCompute tables.'."\n" + ."\n" + .'- Name: Name. Used for HMS-type tables.'."\n" + ."\n" + .'- RecordCount: Record count. Supported only for MaxCompute tables.'."\n" + ."\n" + .'- DataSize: Storage size. Supported only for MaxCompute tables.', 'enumValueTitles' => [], - 'example' => 'Category', - 'enum' => [ - 'Category', - 'Album', - 'AlbumCategory', - ], - ], - ], - [ - 'name' => 'Description', - 'in' => 'query', - 'schema' => [ - 'description' => 'The collection description.'."\n", 'type' => 'string', 'required' => false, - 'example' => 'test comment', - ], - ], - ], - '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' => 'E6F0DBDD-5AD****', - ], - 'Id' => [ - 'description' => 'The collection ID returned after a successful creation.'."\n", - 'type' => 'string', - 'example' => 'category.123', - ], - ], + 'example' => 'CreateTime', + 'default' => 'CreateTime', + 'enum' => ['CreateTime', 'ModifyTime', 'Name', 'RecordCount', 'DataSize'], + 'title' => '', ], ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E6F0DBDD-5AD****\\",\\n \\"Id\\": \\"4as3dasf654a\\"\\n}","type":"json"}]', - 'title' => 'CreateMetaCollection', - ], - 'GetMetaCollection' => [ - 'summary' => 'Queries the information about a collection in Data Map. Collections include categories and data albums.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '266716', - 'abilityTreeNodes' => [ - 'FEATUREdideE9XYA6', - ], - ], - 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'Order', 'in' => 'query', 'schema' => [ - 'description' => 'The collection ID.'."\n", + 'description' => 'The sort order. Default: Asc. Valid values:'."\n" + ."\n" + .'- Asc: Ascending order.'."\n" + ."\n" + .'- Desc: Descending order.', + 'enumValueTitles' => [], 'type' => 'string', - 'required' => true, - 'example' => 'category.123', + 'example' => 'Asc', + 'default' => 'Asc', + 'enum' => ['Asc', 'Desc'], + 'title' => '', + 'required' => false, ], ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Default: 1.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '1', 'example' => '1', 'default' => '1', 'title' => '', 'required' => false], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default: 10. Maximum: 100.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10', 'title' => '', 'required' => false], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response.'."\n", + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1AFAE64E-D1BE-432B-A9****', - ], - 'MetaCollection' => [ - 'description' => 'The collection details.'."\n", + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request succeeded.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'PagingInfo' => [ + 'title' => '', + 'description' => 'Pagination information.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => 'The collection ID.'."\n", - 'type' => 'string', - 'example' => 'category.123', - ], - 'Type' => [ - 'description' => 'The collection type. Valid values:'."\n" - ."\n" - .'* Category'."\n" - .'* Album'."\n" - .'* AlbumCategory: Album subcategory.'."\n", - 'type' => 'string', - 'example' => 'Category', - ], - 'ParentId' => [ - 'description' => 'The parent collection ID. This parameter can be empty.'."\n", - 'type' => 'string', - 'example' => 'category.12'."\n" - ."\n", - ], - 'Name' => [ - 'description' => 'The collection name.'."\n", - 'type' => 'string', - 'example' => 'test_category', - ], - 'Description' => [ - 'description' => 'The collection description.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'CreateTime' => [ - 'description' => 'The creation time in milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1668568601000', - ], - 'ModifyTime' => [ - 'description' => 'The last modified time in milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1668568601000', - ], - 'CreateUser' => [ - 'description' => 'The ID of the creator.'."\n", - 'type' => 'string', - 'example' => '456789', - ], - 'Administrators' => [ - 'description' => 'The list of administrator IDs. Valid only for the album type. The IDs must belong to users in the same tenant. Multiple IDs can be specified.'."\n", + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', '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' => ''], + 'PartitionList' => [ + 'title' => '', + 'description' => 'The list of table partitions.', 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the administrator.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '765432', - ], + 'items' => ['description' => 'The table partition.', '$ref' => '#/components/schemas/Partition', 'title' => '', 'example' => ''], + 'example' => '', ], ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1AFAE64E-D1BE-432B-A9****\\",\\n \\"MetaCollection\\": {\\n \\"Id\\": \\"as78d756asd\\",\\n \\"Type\\": \\"Category\\",\\n \\"ParentId\\": \\"4as3dasf654a\\",\\n \\"Name\\": \\"test_category\\",\\n \\"Description\\": \\"test\\",\\n \\"CreateTime\\": 1668568601000,\\n \\"ModifyTime\\": 1668568601000,\\n \\"CreateUser\\": \\"456789\\",\\n \\"Administrators\\": [\\n 765432\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'GetMetaCollection', - ], - 'UpdateMetaCollection' => [ - 'summary' => 'Updates the information about a collection in Data Map, including the collection name, description, and administrator. Collections include categories and data albums. If you want to update the information about a data album, the account that you use must be attached the AliyunDataWorksFullAccess policy, or you are the data album creator or administrator.', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx\\",\\n \\"Success\\": true,\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"PartitionList\\": [\\n {\\n \\"TableId\\": \\"maxcompute-table:accountId::project::table\\",\\n \\"Name\\": \\"ds=20250101\\",\\n \\"CreateTime\\": 1700192563000,\\n \\"ModifyTime\\": 1700192563000,\\n \\"RecordCount\\": 1000000,\\n \\"DataSize\\": 4096\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListPartitions', + 'description' => '1. DataWorks Basic Edition or a higher edition is required.'."\n" + ."\n" + .'2. Only maxcompute and hms (EMR cluster) table types are supported.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:ListPartitions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListPendingApprovals' => [ + 'summary' => 'Retrieves the list of pending permission request orders for which the current user is the approver.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'list', 'riskType' => 'none', - 'abilityTreeCode' => '266814', - 'abilityTreeNodes' => [ - 'FEATUREdideE9XYA6', - ], + 'chargeType' => 'free', + 'abilityTreeCode' => 'TBD', + 'abilityTreeNodes' => ['FEATUREdideYTM537'], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'query', + 'name' => 'DefSchema', + 'in' => 'formData', + 'schema' => ['description' => 'Filters by resource type.'."\n" + ."\n" + .'Note: The supported resource types for requests are constrained by [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).name.'."\n" + ."\n" + .'Reference: [ResourceSchema International Documentation](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)', 'type' => 'string', 'required' => true, 'example' => 'MaxCompute', 'title' => ''], + ], + [ + 'name' => 'ResourceType', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The collection ID.'."\n", - 'type' => 'string', + 'description' => 'Filters by minimum permission resource type.'."\n" + ."\n" + .'Note: The minimum permission resource type is constrained by [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).resources[*].isValidLeaf being true.'."\n" + ."\n" + .'Reference: [ResourceSchema International Documentation](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)', + 'type' => 'array', + 'items' => ['description' => 'Resource type', 'type' => 'string', 'required' => false, 'example' => 'table', 'title' => ''], 'required' => true, - 'example' => 'category.123', + 'example' => '["table", "column"]', + 'maxItems' => 5, + 'title' => '', ], ], [ - 'name' => 'Name', - 'in' => 'query', + 'name' => 'Resource', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'Filters by resource with exact or fuzzy matching. Resource descriptions are constrained by [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).'."\n" + ."\n" + .'Reference: [ResourceSchema International Documentation](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)', + 'type' => 'object', + 'properties' => [ + 'DefSchema' => ['description' => 'Resource type.'."\n" + ."\n" + .'Note: The supported resource types for requests are constrained by [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).name.'."\n" + ."\n" + .'Reference: [ResourceSchema International Documentation](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)', 'type' => 'string', 'required' => false, 'example' => 'MaxCompute', 'title' => ''], + 'DefVersion' => ['description' => 'Resource parsing version is constrained by [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).version.'."\n" + ."\n" + .'Reference: [ResourceSchema International Documentation](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)', 'type' => 'string', 'default' => 'v1.0.0', 'required' => false, 'example' => 'v1.0.0', 'title' => ''], + 'MetaData' => [ + 'description' => 'Resource metadata.'."\n" + ."\n" + .'Note: Metadata is constrained by [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).resources. A valid resource declaration must include the full path metadata declaration from level 0 to the validLeaf level.'."\n" + ."\n" + .'Reference: [ResourceSchema International Documentation](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['description' => 'Resource metadata', 'type' => 'any', 'example' => '{'."\n" + .' "workspace": "449056",'."\n" + .' "project": "sync_destination"'."\n" + .' }', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], 'required' => false, - 'example' => 'new_name', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Description', - 'in' => 'query', + 'name' => 'StartTime', + 'in' => 'formData', + 'schema' => ['description' => 'Start time of the application period (millisecond timestamp).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1771948800000', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => ['description' => 'End time of the application period (millisecond timestamp).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1779724799999', 'title' => ''], + ], + [ + 'name' => 'Grantee', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'Filters by authorization principal.'."\n" + ."\n" + .'Note: The supported authorization principal types are constrained by [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).authPrincipal.'."\n" + ."\n" + .'Reference: [ResourceSchema International Documentation](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)', + 'type' => 'object', + 'properties' => [ + 'PrincipalType' => ['description' => 'Authorization principal type.', 'type' => 'string', 'required' => false, 'example' => 'RamRole', 'title' => ''], + 'PrincipalId' => ['description' => 'Authorization principal ID.', 'type' => 'string', 'required' => false, 'example' => 'ROLE_3133343434', 'title' => ''], + ], 'required' => false, - 'example' => 'new comment', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Administrators', - 'in' => 'query', - 'style' => 'simple', + 'name' => 'AccessTypes', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The collection administrator IDs. This parameter is available only for data albums. The administrator must be an account within the same tenant.'."\n", + 'description' => 'Filters by requested permissions.'."\n" + ."\n" + .'Note: Different resource levels support different permission types. All are uniformly constrained by [ResourceSchema](https://help.aliyun.com/zh/dataworks/developer-reference/resourceschema-template-instructions).isValidLeaf, accessTypeRestrictions, and authMethodAccessTypes.'."\n" + ."\n" + .'Reference: [ResourceSchema International Documentation](https://www.alibabacloud.com/help/zh/dataworks/developer-reference/resourceschema-template-instructions)', 'type' => 'array', - 'items' => [ - 'description' => 'The collection administrator ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123434', - ], + 'items' => ['description' => 'Permission', 'type' => 'string', 'required' => false, 'example' => 'select', 'title' => ''], 'required' => false, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'NextToken', + 'in' => 'formData', + 'schema' => ['description' => 'Cursor.'."\n", 'type' => 'string', 'required' => false, 'example' => 'eyJpZCI6MTIzfQ==', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['description' => 'Page size (default: 10, maximum: 200).'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '50', 'default' => '10', 'example' => '20', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'title' => '', + 'description' => 'API request response. The error code is non-empty when the call fails.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '0E1C0122-F79F-5C26-B546-47A321691868', + 'RequestId' => ['title' => '', 'description' => 'API request ID, generated as UUID.'."\n", 'type' => 'string', 'example' => '0bc5df3a17****903790e8e8a'], + 'Data' => [ + 'description' => 'Paginated results.'."\n", + 'type' => 'object', + 'properties' => [ + 'PageSize' => ['description' => 'Page size (default: 10, maximum: 200).'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'NextToken' => ['description' => 'Cursor.'."\n", 'type' => 'string', 'example' => 'eyJpZCI6MTIzfQ==', 'title' => ''], + 'HasMore' => ['description' => 'Whether more data is available.'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Data' => [ + 'description' => 'Data list in the paginated results.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Approval process and request content.', + 'type' => 'object', + 'properties' => [ + 'ProcessInstanceId' => ['description' => 'Process instance ID.'."\n", 'type' => 'string', 'example' => '176906667488145', 'title' => ''], + 'DefSchema' => ['description' => 'Resource type.'."\n", 'type' => 'string', 'example' => 'MaxCompute', 'title' => ''], + 'Reason' => ['description' => 'Reason for the request.'."\n", 'type' => 'string', 'example' => '业务需要', 'title' => ''], + 'ApplicationTime' => ['description' => 'Time when the request was submitted.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '申请时间', 'title' => ''], + 'Status' => ['description' => 'Approval status. Enumeration:'."\n" + ."\n" + .'- WaitApproval: Pending approval'."\n" + .'- Confirmed: Pending authorization'."\n" + .'- RejectApproval: Approval rejected'."\n" + .'- AuthorizeSucceed: Authorization succeeded'."\n" + .'- AuthorizeFailed: Authorization failed'."\n" + .'- Deleted: Deleted'."\n" + .'- Canceled: Canceled', 'type' => 'string', 'example' => 'Deleted', 'title' => ''], + 'Contents' => [ + 'description' => 'Request content.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Request content', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'Unique identifier of the request content.', 'type' => 'string', 'example' => '210001918826', 'title' => ''], + 'ProcessInstanceId' => ['description' => '**Process instance ID.**', 'type' => 'string', 'example' => '176906667488145', 'title' => ''], + 'TenantId' => ['description' => 'Tenant ID.'."\n", 'type' => 'string', 'example' => '69973837489', 'title' => ''], + 'ResourceName' => ['description' => 'Minimum permission resource type.'."\n", 'type' => 'string', 'example' => 'table', 'title' => ''], + 'DefSchema' => ['description' => 'Resource type.'."\n", 'type' => 'string', 'example' => 'MaxCompute', 'title' => ''], + 'AuthMethod' => ['description' => 'Authorization method.'."\n", 'type' => 'string', 'example' => 'default', 'title' => ''], + 'Resource' => [ + 'description' => 'Resource declaration.'."\n", + 'type' => 'object', + 'properties' => [ + 'DefSchema' => ['description' => 'ResourceSchema.name that the resource parsing depends on.'."\n", 'type' => 'string', 'example' => 'MaxCompute', 'title' => ''], + 'DefVersion' => ['description' => 'ResourceSchema.version that the resource parsing depends on.'."\n", 'type' => 'string', 'example' => 'v1.0.0', 'title' => ''], + 'MetaData' => [ + 'description' => 'Resource metadata. The data content is constrained by ResourceSchema.'."\n", + 'type' => 'object', + 'additionalProperties' => ['description' => 'Resource content', 'type' => 'any', 'example' => '{'."\n" + .' "schema": "default",'."\n" + .' "threeTierModel": false,'."\n" + .' "project": "sync_dtestn",'."\n" + .' "workspace": "4477656",'."\n" + .' "table": "order",'."\n" + .' "tenant": "524257424864736"'."\n" + .' }', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'Grantee' => [ + 'description' => 'Authorization principal description.'."\n", + 'type' => 'object', + 'properties' => [ + 'PrincipalType' => ['description' => 'Principal type. Enumeration:'."\n" + ."\n" + .'- RamRole'."\n" + .'- RamUser'."\n" + .'- DataworksTenantMember'."\n" + .'- DataworksTenantRole'."\n" + .'- DataworksProjectMember'."\n" + .'- DataworksProjectRole'."\n" + .'- DlfRole', 'type' => 'string', 'example' => 'RamUser', 'title' => ''], + 'PrincipalId' => ['description' => 'Principal ID.'."\n" + ."\n" + .'Note: The semantics of the ID vary depending on the principalType:'."\n" + .'- RamUser: DataWorks UserId'."\n" + .'- RamRole: DataWorks UserId prefixed with "ROLE_"'."\n" + .'- DataworksTenantMember: DataWorks UserId'."\n" + .'- DataworksTenantRole: DataWorks tenant roleCode'."\n" + .'- DataworksProjectRole: DataWorks workspace roleCode'."\n" + .'- DataworksProjectMember: DataWorks UserId'."\n" + .'- DlfRole: DlfNext role name', 'type' => 'string', 'example' => '213463068144525171', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'AccessTypes' => [ + 'description' => 'Resource operation permissions requested in the application.'."\n", + 'type' => 'array', + 'items' => ['description' => 'Permission', 'type' => 'string', 'example' => 'select', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'FinalAccessTypes' => [ + 'description' => 'Resource operation permissions finally approved.'."\n", + 'type' => 'array', + 'items' => ['description' => 'select', 'type' => 'string', 'example' => 'select', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'ExpirationTime' => ['description' => 'Permission expiration date, millisecond timestamp.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1782354014507', 'title' => ''], + 'Status' => ['description' => 'Approval status. Enumeration:'."\n" + ."\n" + .'- WaitApproval: Pending approval'."\n" + .'- Confirmed: Pending authorization'."\n" + .'- RejectApproval: Approval rejected'."\n" + .'- AuthorizeSucceed: Authorization succeeded'."\n" + .'- AuthorizeFailed: Authorization failed'."\n" + .'- Deleted: Deleted'."\n" + .'- Canceled: Canceled', 'type' => 'string', 'example' => 'Deleted', 'title' => ''], + 'CreateTime' => ['description' => 'Creation time.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2025-09-11 10:13:21', 'title' => ''], + 'UpdateTime' => ['description' => 'Update time.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2022-07-06 19:13:05', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query Pending Permission Request Orders', + 'description' => '## Request Description'."\n" + .'This API is used to query all pending permission request orders for which the current logged-in user is the approver. It supports filtering by multiple conditions, including resource type, time range, and approval status, to more precisely locate specific request orders.'."\n" + ."\n" + .'- **ResourceType**: Specifies the resource type (such as table), which can have multiple values.'."\n" + .'- **Resource**: Provides specific resource search conditions, such as the project, database, or table name.'."\n" + .'- **StartTime and EndTime**: Define the time range during which the request was submitted.'."\n" + .'- **Statuses**: Allows filtering results by approval status, for example, to view only pending approval requests.'."\n" + .'- **Grantee**: Filters request orders based on the authorization principal information.'."\n" + .'- **AccessTypes**: Filters based on the specific permission types requested (such as read or update).'."\n" + .'- **PageSize and NextToken**: Used for pagination control, specifying the amount of data returned per request and the cursor needed to retrieve the next page of data.'."\n" + ."\n" + .'Notes:'."\n" + .'- If no filtering conditions are provided, all matching records are returned by default.'."\n" + .'- The `NextToken` parameter can be empty or omitted for the first call. Subsequent page requests must use the `NextToken` value provided in the previous response.'."\n" + ."\n\n" + .'- The default value of `PageSize` is 10, and the maximum value is 200. If the specified value exceeds the maximum limit, the maximum value is used.'."\n" + .'- When there is no more data to return, the `HasMore` field is set to `false`, and `NextToken` will be empty or absent.'."\n" + ."\n" + .'## Response Description'."\n" + .'After a successful call to this API, the response body contains paginated results and detailed information for each request order, such as the application time, resource description, authorization principal, requested permissions, and more. Additionally, the approval process status and other related metadata are provided.'."\n" + ."\n" + .'- **Data**: The paginated result set, including page size (`PageSize`), cursor (`NextToken`), and whether more data is available (`HasMore`).'."\n" + .'- **ApplicationQueryResponse**: The specific content of each request order, including the reason for the request, submission time, status, and a detailed list of request content.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0E1C0122-F79F-5C26-B546-47A321691868\\"\\n}","type":"json"}]', - 'title' => 'UpdateMetaCollection', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc5df3a17****903790e8e8a\\",\\n \\"Data\\": {\\n \\"PageSize\\": 10,\\n \\"NextToken\\": \\"eyJpZCI6MTIzfQ==\\",\\n \\"HasMore\\": false,\\n \\"Data\\": [\\n {\\n \\"ProcessInstanceId\\": \\"176906667488145\\",\\n \\"DefSchema\\": \\"MaxCompute\\",\\n \\"Reason\\": \\"业务需要\\",\\n \\"ApplicationTime\\": 0,\\n \\"Status\\": \\"Deleted\\",\\n \\"Contents\\": [\\n {\\n \\"Id\\": \\"210001918826\\",\\n \\"ProcessInstanceId\\": \\"176906667488145\\",\\n \\"TenantId\\": \\"69973837489\\",\\n \\"ResourceName\\": \\"table\\",\\n \\"DefSchema\\": \\"MaxCompute\\",\\n \\"AuthMethod\\": \\"default\\",\\n \\"Resource\\": {\\n \\"DefSchema\\": \\"MaxCompute\\",\\n \\"DefVersion\\": \\"v1.0.0\\",\\n \\"MetaData\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"schema\\\\\\": \\\\\\"default\\\\\\",\\\\n \\\\\\"threeTierModel\\\\\\": false,\\\\n \\\\\\"project\\\\\\": \\\\\\"sync_dtestn\\\\\\",\\\\n \\\\\\"workspace\\\\\\": \\\\\\"4477656\\\\\\",\\\\n \\\\\\"table\\\\\\": \\\\\\"order\\\\\\",\\\\n \\\\\\"tenant\\\\\\": \\\\\\"524257424864736\\\\\\"\\\\n }\\"\\n }\\n },\\n \\"Grantee\\": {\\n \\"PrincipalType\\": \\"RamUser\\",\\n \\"PrincipalId\\": \\"213463068144525171\\"\\n },\\n \\"AccessTypes\\": [\\n \\"select\\"\\n ],\\n \\"FinalAccessTypes\\": [\\n \\"select\\"\\n ],\\n \\"ExpirationTime\\": 1782354014507,\\n \\"Status\\": \\"Deleted\\",\\n \\"CreateTime\\": 0,\\n \\"UpdateTime\\": 0\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', ], - 'DeleteMetaCollection' => [ - 'summary' => 'Deletes a collection in Data Map. Collections include categories and data albums. If you want to delete a data album, the account that you use must be attached the AliyunDataWorksFullAccess policy, or you are the data album creator or administrator.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListPipelineRunItems' => [ + 'summary' => 'Queries the information about deployment objects by deployment process ID.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'list', 'riskType' => 'none', - 'abilityTreeCode' => '266820', - 'abilityTreeNodes' => [ - 'FEATUREdideE9XYA6', - ], + 'chargeType' => 'free', + 'abilityTreeCode' => '267918', + 'abilityTreeNodes' => ['FEATUREdide4AR6E0'], ], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => 'The collection ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'category.123', - ], + 'schema' => ['description' => 'The ID of the DataWorks workspace. You can obtain the workspace ID from the workspace configuration page in the DataWorks console.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10001', 'title' => ''], + ], + [ + 'name' => 'PipelineRunId', + 'in' => 'query', + 'schema' => ['description' => 'The workflow task ID. To obtain the ID, see [ListPipelineRuns](~~438042~~).', 'type' => 'string', 'required' => true, 'example' => ' '."\n" + .'097c73fe-ed6e-4fb1-b109-a5d59e46cd58'."\n", 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number, for pagination.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '2147483647', 'minimum' => '1', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The requested page number, used for pagination.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '10', 'default' => '10', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '45D14A7A-7C28-5547-AB0A-35FBCD9DE7B5', + 'RequestId' => ['description' => 'The request ID. You can use this ID to troubleshoot issues if errors occur.', 'type' => 'string', 'example' => 'C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490', 'title' => ''], + 'PagingInfo' => [ + 'description' => 'Pagination information.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['description' => 'The total number of entries that match the conditions.', 'type' => 'integer', 'format' => 'int32', 'example' => '12', 'title' => ''], + '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' => ''], + 'PipelineRunItems' => [ + 'description' => 'The list of deployments.', + 'type' => 'array', + 'items' => [ + 'description' => 'Details of a deployment.', + 'type' => 'object', + 'properties' => [ + 'Version' => ['description' => 'The deployment version.', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '1'], + 'Name' => ['description' => 'The deployment name.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'CreateTime' => ['description' => 'The deployment creation time.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1724984066000'], + 'ModifyTime' => ['description' => 'The time when the deployment was last modified.', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '1724984066000'], + 'Status' => [ + 'description' => 'The deployment status. Valid values:'."\n" + ."\n" + .'- Init: Initializing'."\n" + ."\n" + .'- Running'."\n" + ."\n" + .'- Success'."\n" + ."\n" + .'- Fail'."\n" + ."\n" + .'- Termination', + 'type' => 'string', + 'deprecated' => false, + 'pattern' => '', + 'default' => '', + 'enum' => ['Init', 'Running', 'Success', 'Fail', 'Termination'], + 'title' => '', + 'example' => 'Running', + ], + 'Message' => ['description' => 'The error message if the deployment failed.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'Error Message'], + 'Type' => ['description' => 'The deployment type. Valid values:'."\n" + ."\n" + .'- Node'."\n" + ."\n" + .'- WorkflowDefinition: Workflow definition.'."\n" + ."\n" + .'- Resource'."\n" + ."\n" + .'- Function: The object is a function.', 'type' => 'string', 'example' => 'Node', 'title' => ''], + 'Spec' => ['description' => 'The FlowSpec information describing this deployment. For detailed specifications, see [FlowSpec](https://github.com/aliyun/dataworks-spec/blob/master/README_zh_CN.md).', 'type' => 'string', 'example' => '{ "version": "1.1.0", "kind": "Node", "spec": { "nodes": [ { "recurrence": "Normal", "id": "860438872620113XXXX", "timeout": 0, "instanceMode": "T+1", "rerunMode": "Allowed", "rerunTimes": 3, "rerunInterval": 180000, "datasource": { "name": "odps_test", "type": "odps" }, "script": { "language": "odps-sql", "path": "XX/OpenAPI_Test/ODPS_SQL_Test", "runtime": { "command": "ODPS_SQL", "commandTypeId": 10 }, "content": "select now();", "id": "853573334108680XXXX" }, "trigger": { "type": "Scheduler", "id": "543680677872062XXXX", "cron": "00 00 00 * * ?", "startTime": "1970-01-01 00:00:00", "endTime": "9999-01-01 00:00:00", "timezone": "Asia/Shanghai", "delaySeconds": 0 }, "runtimeResource": { "resourceGroup": "S_res_group_XXXX_XXXX", "id": "623731286945488XXXX", "resourceGroupId": "7201XXXX" }, "name": "ODPS_SQL_Test", "owner": "110755000425XXXX", "metadata": { "owner": "110755000425XXXX", "ownerName": "XXXXX@test.XXX.com", "projectId": "307XXX" }, "inputs": { "nodeOutputs": [ { "data": "lwttest_standard_root", "artifactType": "NodeOutput" } ] }, "outputs": { "nodeOutputs": [ { "data": "860438872620113XXXX", "artifactType": "NodeOutput", "refTableName": "ODPS_SQL_Test", "isDefault": true } ] } } ], "flow": [ { "nodeId": "860438872620113XXXX", "depends": [ { "type": "Normal", "output": "lwttest_standard_root" } ] } ] }, "metadata": { "uuid": "860438872620113XXXX" } }', 'title' => ''], + 'Id' => ['description' => 'The unique identifier of the deployment.'."\n" + ."\n" + .'> Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.', 'type' => 'string', 'deprecated' => false, 'example' => '860438872620113XXXX', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"45D14A7A-7C28-5547-AB0A-35FBCD9DE7B5\\"\\n}","type":"json"}]', - 'title' => 'DeleteMetaCollection', - ], - 'ListEntitiesInMetaCollection' => [ - 'summary' => 'Queries a list of entities in a collection in Data Map. Collections include categories and data albums. Entities can only be tables.', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 12,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"PipelineRunItems\\": [\\n {\\n \\"Version\\": 1,\\n \\"Name\\": \\"test\\",\\n \\"CreateTime\\": 1724984066000,\\n \\"ModifyTime\\": 1724984066000,\\n \\"Status\\": \\"Running\\",\\n \\"Message\\": \\"Error Message\\",\\n \\"Type\\": \\"Node\\",\\n \\"Spec\\": \\"{ \\\\\\"version\\\\\\": \\\\\\"1.1.0\\\\\\", \\\\\\"kind\\\\\\": \\\\\\"Node\\\\\\", \\\\\\"spec\\\\\\": { \\\\\\"nodes\\\\\\": [ { \\\\\\"recurrence\\\\\\": \\\\\\"Normal\\\\\\", \\\\\\"id\\\\\\": \\\\\\"860438872620113XXXX\\\\\\", \\\\\\"timeout\\\\\\": 0, \\\\\\"instanceMode\\\\\\": \\\\\\"T+1\\\\\\", \\\\\\"rerunMode\\\\\\": \\\\\\"Allowed\\\\\\", \\\\\\"rerunTimes\\\\\\": 3, \\\\\\"rerunInterval\\\\\\": 180000, \\\\\\"datasource\\\\\\": { \\\\\\"name\\\\\\": \\\\\\"odps_test\\\\\\", \\\\\\"type\\\\\\": \\\\\\"odps\\\\\\" }, \\\\\\"script\\\\\\": { \\\\\\"language\\\\\\": \\\\\\"odps-sql\\\\\\", \\\\\\"path\\\\\\": \\\\\\"XX/OpenAPI_Test/ODPS_SQL_Test\\\\\\", \\\\\\"runtime\\\\\\": { \\\\\\"command\\\\\\": \\\\\\"ODPS_SQL\\\\\\", \\\\\\"commandTypeId\\\\\\": 10 }, \\\\\\"content\\\\\\": \\\\\\"select now();\\\\\\", \\\\\\"id\\\\\\": \\\\\\"853573334108680XXXX\\\\\\" }, \\\\\\"trigger\\\\\\": { \\\\\\"type\\\\\\": \\\\\\"Scheduler\\\\\\", \\\\\\"id\\\\\\": \\\\\\"543680677872062XXXX\\\\\\", \\\\\\"cron\\\\\\": \\\\\\"00 00 00 * * ?\\\\\\", \\\\\\"startTime\\\\\\": \\\\\\"1970-01-01 00:00:00\\\\\\", \\\\\\"endTime\\\\\\": \\\\\\"9999-01-01 00:00:00\\\\\\", \\\\\\"timezone\\\\\\": \\\\\\"Asia/Shanghai\\\\\\", \\\\\\"delaySeconds\\\\\\": 0 }, \\\\\\"runtimeResource\\\\\\": { \\\\\\"resourceGroup\\\\\\": \\\\\\"S_res_group_XXXX_XXXX\\\\\\", \\\\\\"id\\\\\\": \\\\\\"623731286945488XXXX\\\\\\", \\\\\\"resourceGroupId\\\\\\": \\\\\\"7201XXXX\\\\\\" }, \\\\\\"name\\\\\\": \\\\\\"ODPS_SQL_Test\\\\\\", \\\\\\"owner\\\\\\": \\\\\\"110755000425XXXX\\\\\\", \\\\\\"metadata\\\\\\": { \\\\\\"owner\\\\\\": \\\\\\"110755000425XXXX\\\\\\", \\\\\\"ownerName\\\\\\": \\\\\\"XXXXX@test.XXX.com\\\\\\", \\\\\\"projectId\\\\\\": \\\\\\"307XXX\\\\\\" }, \\\\\\"inputs\\\\\\": { \\\\\\"nodeOutputs\\\\\\": [ { \\\\\\"data\\\\\\": \\\\\\"lwttest_standard_root\\\\\\", \\\\\\"artifactType\\\\\\": \\\\\\"NodeOutput\\\\\\" } ] }, \\\\\\"outputs\\\\\\": { \\\\\\"nodeOutputs\\\\\\": [ { \\\\\\"data\\\\\\": \\\\\\"860438872620113XXXX\\\\\\", \\\\\\"artifactType\\\\\\": \\\\\\"NodeOutput\\\\\\", \\\\\\"refTableName\\\\\\": \\\\\\"ODPS_SQL_Test\\\\\\", \\\\\\"isDefault\\\\\\": true } ] } } ], \\\\\\"flow\\\\\\": [ { \\\\\\"nodeId\\\\\\": \\\\\\"860438872620113XXXX\\\\\\", \\\\\\"depends\\\\\\": [ { \\\\\\"type\\\\\\": \\\\\\"Normal\\\\\\", \\\\\\"output\\\\\\": \\\\\\"lwttest_standard_root\\\\\\" } ] } ] }, \\\\\\"metadata\\\\\\": { \\\\\\"uuid\\\\\\": \\\\\\"860438872620113XXXX\\\\\\" } }\\",\\n \\"Id\\": \\"860438872620113XXXX\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListPipelineRunItems', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListPipelineRuns' => [ + 'summary' => 'Retrieve a paginated list of deployment processes. You can also filter this list based on specific criteria.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -34778,347 +38009,555 @@ 'systemTags' => [ 'operationType' => 'list', 'riskType' => 'none', - 'abilityTreeCode' => '267198', - 'abilityTreeNodes' => [ - 'FEATUREdideE9XYA6', - ], + 'chargeType' => 'free', + 'abilityTreeCode' => '267909', + 'abilityTreeNodes' => ['FEATUREdide4AR6E0'], ], 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => 'The collection ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'category.123', - ], - ], - [ - 'name' => 'EntityType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The entity type.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dlf-table', - ], - ], - [ - 'name' => 'EntityName', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => 'The entity name. Supports fuzzy matching.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test1', - ], + 'schema' => ['description' => 'The ID of the DataWorks workspace. You can obtain this ID from the Workspace Management page in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n" + ."\n" + .'This parameter specifies the DataWorks workspace to use for the API call.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000', 'title' => ''], ], [ - 'name' => 'EntityDescription', + 'name' => 'Creator', 'in' => 'query', - 'schema' => [ - 'description' => 'The description specified when the entity was added to the collection. Supports fuzzy matching. Valid only for the album type.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'schema' => ['description' => 'Filters the results by the creator of the pipeline.', 'type' => 'string', 'required' => false, 'example' => '110755000425****'."\n", 'title' => ''], ], [ - 'name' => 'SortBy', + 'name' => 'Status', 'in' => 'query', - 'schema' => [ - 'description' => 'The sort field. Valid values:'."\n" - ."\n" - .'* Name (default)'."\n" - .'* CreateTime'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Name', - ], + 'schema' => ['description' => 'Filters the results by the current status of the pipeline.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- `Init`: initializing'."\n" + ."\n" + .'- `Running`: running'."\n" + ."\n" + .'- `Success`: succeeded'."\n" + ."\n" + .'- `Fail`: failed'."\n" + ."\n" + .'- `Termination`: terminated'."\n" + ."\n" + .'- `Cancel`: canceled', 'type' => 'string', 'required' => false, 'example' => 'Running', 'title' => ''], ], [ - 'name' => 'Order', + 'name' => 'ObjectId', 'in' => 'query', - 'schema' => [ - 'description' => 'The sort order. Valid values:'."\n" - ."\n" - .'* Asc (default): ascending order.'."\n" - .'* Desc'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Asc', - ], + 'schema' => ['description' => 'The ID of the artifact.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '860438872620113XXXX'."\n"], ], [ 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The page number. Pages start from 1. The default value is 1.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '2147483647', 'minimum' => '1', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of records per page. Default value: 10. 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.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '10', 'default' => '10', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response.'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'F05080B0-CCE6-5D22-B284-34A51C5D4E28', - ], + 'RequestId' => ['description' => 'The request ID. Use this ID to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => '7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX'."\n", 'title' => ''], 'PagingInfo' => [ - 'description' => 'The pagination result.'."\n", + 'description' => 'The pagination information.', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of records.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'PageNumber' => [ - 'description' => 'The current page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of records per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Entities' => [ - 'description' => 'The list of entities in the collection.'."\n", + 'TotalCount' => ['description' => 'The total number of entries that meet the filter criteria.', 'type' => 'integer', 'format' => 'int32', 'example' => '2524', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'PageNumber' => ['description' => 'The returned page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PipelineRuns' => [ + 'description' => 'A list of deployment pipeline runs.', 'type' => 'array', 'items' => [ - 'description' => 'The entity in the collection.'."\n", + 'description' => 'A deployment pipeline run.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the entity. Currently, only the Table type is supported. If the entity is deleted, this field is empty.'."\n", - 'type' => 'string', - 'example' => 'dlf-table:123456789:test_catalog:test_database::test_table', - ], - 'Type' => [ - 'description' => 'The entity type.'."\n", - 'type' => 'string', - 'example' => 'dlf-table', - ], - 'Name' => [ - 'description' => 'The entity name.'."\n", - 'type' => 'string', - 'example' => 'test_table', - ], - 'Comment' => [ - 'description' => 'The entity comment.'."\n", + 'Id' => ['description' => 'The ID of the deployment pipeline run.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '097c73fe-ed6e-4fb1-b109-a5d59e46cd58'], + 'ProjectId' => ['description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '70199'], + 'CreateTime' => ['description' => 'The creation timestamp of the deployment pipeline run.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1702736654000'], + 'ModifyTime' => ['description' => 'The last modification timestamp of the deployment pipeline run.', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '1702736654000'], + 'Creator' => ['description' => 'The creator of the deployment pipeline run.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '110755000425XXXX'], + 'Status' => [ + 'description' => 'The status of the deployment pipeline run.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- `Init`: Initializing'."\n" + ."\n" + .'- `Running`: Running'."\n" + ."\n" + .'- `Success`: Succeeded'."\n" + ."\n" + .'- `Fail`: Failed'."\n" + ."\n" + .'- `Termination`: Terminated'."\n" + ."\n" + .'- `Cancel`: Canceled', 'type' => 'string', - 'example' => 'test', - ], - 'CreateTime' => [ - 'description' => 'The creation time in milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1737078994080', - ], - 'ModifyTime' => [ - 'description' => 'The last modified time in milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1737078994080', + 'deprecated' => false, + 'pattern' => '', + 'default' => '', + 'enum' => ['Init', 'Running', 'Success', 'Fail', 'Termination', 'Cancel'], + 'title' => '', + 'example' => 'Running', ], - 'Description' => [ - 'description' => 'The description specified when the entity was added to the collection. Valid only for albums.'."\n", - 'type' => 'string', - 'example' => 'test', + 'Message' => ['description' => 'The error message returned if the deployment pipeline run fails.', 'type' => 'string', 'example' => 'Error message', 'title' => ''], + 'Stages' => [ + 'title' => '', + 'description' => 'A list of deployment stages.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'A deployment stage.', + 'type' => 'object', + 'properties' => [ + 'Code' => ['description' => 'The code of the deployment stage.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'DEV_CHECK'], + 'Step' => ['description' => 'The step number of the deployment stage.', 'type' => 'integer', 'format' => 'int32', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '1'], + 'Type' => ['description' => 'The type of the deployment stage.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- `Deploy`: A deploy operation'."\n" + ."\n" + .'- `Check`: A check operation'."\n" + ."\n" + .'- `Offline`: An offline operation'."\n" + ."\n" + .'- `Build`: A build operation'."\n" + ."\n" + .'- `Delete`: A delete operation', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'Check'], + 'Name' => ['description' => 'The stage name.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'Check before going online to development'."\n"], + 'Description' => ['description' => 'The stage description.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'Check before going online to development'."\n"], + 'Message' => ['description' => 'The error message returned if the deployment stage fails.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'Error message'."\n"], + 'Status' => ['description' => 'The status of the deployment stage.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- `Init`: Initializing'."\n" + ."\n" + .'- `Running`: Running'."\n" + ."\n" + .'- `Success`: Succeeded'."\n" + ."\n" + .'- `Fail`: Failed'."\n" + ."\n" + .'- `Termination`: Terminated'."\n" + ."\n" + .'- `Cancel`: Canceled', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'Running'], + 'Detail' => [ + 'title' => '', + 'description' => 'Additional information about the deployment stage.', + 'type' => 'object', + 'deprecated' => false, + 'additionalProperties' => ['description' => 'Additional details for the stage, returned as key-value pairs.', 'type' => 'any', 'example' => '{'."\n" + .' "checkerList": ['."\n" + .' {'."\n" + .' "code": "BuildPackageChecker",'."\n" + .' "name": "package check"'."\n" + .' },'."\n" + .' {'."\n" + .' "code": "NodeParentDependency",'."\n" + .' "name": "downstream dependency check"'."\n" + .' },'."\n" + .' {'."\n" + .' "code": "NodeInProcess",'."\n" + .' "name": "offline process check"'."\n" + .' }'."\n" + .' ]'."\n" + .'}', 'title' => ''], + 'example' => '', + ], + ], + 'deprecated' => false, + 'example' => '', + ], + 'deprecated' => false, + 'example' => '', ], + 'Description' => ['description' => 'The description of the deployment pipeline run.', 'type' => 'string', 'example' => 'Release process description', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F05080B0-CCE6-5D22-B284-34A51C5D4E28\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 1,\\n \\"Entities\\": [\\n {\\n \\"Id\\": \\"maxcompute-table:::project_name:[schema_name]:table_name\\",\\n \\"Type\\": \\"maxcompute-table\\",\\n \\"Name\\": \\"test_table\\",\\n \\"Comment\\": \\"test\\",\\n \\"CreateTime\\": 1737078994080,\\n \\"ModifyTime\\": 1737078994080,\\n \\"Description\\": \\"test\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListEntitiesInMetaCollection', - ], - 'AddEntityIntoMetaCollection' => [ - 'summary' => 'Adds an entity to a collection in Data Map. Collections include categories and data albums. Entities can be only tables. If you want to add an entity to a data album, the account that you use must be attached the AliyunDataWorksFullAccess policy, or you are the data album creator or administrator.', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX\\\\n\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 2524,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"PipelineRuns\\": [\\n {\\n \\"Id\\": \\"097c73fe-ed6e-4fb1-b109-a5d59e46cd58\\",\\n \\"ProjectId\\": 70199,\\n \\"CreateTime\\": 1702736654000,\\n \\"ModifyTime\\": 1702736654000,\\n \\"Creator\\": \\"110755000425XXXX\\",\\n \\"Status\\": \\"Running\\",\\n \\"Message\\": \\"Error message\\",\\n \\"Stages\\": [\\n {\\n \\"Code\\": \\"DEV_CHECK\\",\\n \\"Step\\": 1,\\n \\"Type\\": \\"Check\\",\\n \\"Name\\": \\"Check before going online to development\\\\n\\",\\n \\"Description\\": \\"Check before going online to development\\\\n\\",\\n \\"Message\\": \\"Error message\\\\n\\",\\n \\"Status\\": \\"Running\\",\\n \\"Detail\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"checkerList\\\\\\": [\\\\n {\\\\n \\\\\\"code\\\\\\": \\\\\\"BuildPackageChecker\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"package check\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"code\\\\\\": \\\\\\"NodeParentDependency\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"downstream dependency check\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"code\\\\\\": \\\\\\"NodeInProcess\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"offline process check\\\\\\"\\\\n }\\\\n ]\\\\n}\\"\\n }\\n }\\n ],\\n \\"Description\\": \\"Release process description\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListPipelineRuns', + 'description' => '>'."\n" + ."\n" + .'Earlier SDK versions may not include this interface. If so, use the ListDeployments interface. It accepts the same parameters.'."\n" + ."\n" + .'>', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'ListProcessDefinitions' => [ + 'summary' => 'Queries process definitions of a specified type.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'list', 'riskType' => 'none', - 'abilityTreeCode' => '267213', - 'abilityTreeNodes' => [ - 'FEATUREdideE9XYA6', - ], + 'chargeType' => 'free', + 'abilityTreeCode' => '244496', + 'abilityTreeNodes' => ['FEATUREdideYTM537'], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'MetaCollectionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The collection ID. You can refer to the return result of the ListMetaCollections operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'category.123', - ], - ], - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => 'The entity ID. Currently, only table entities are supported. You can call the ListTables operation to obtain the ID.'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [], - 'example' => 'maxcompute-table'."\n", - ], - ], - [ - 'name' => 'Remark', - 'in' => 'query', - 'schema' => [ - 'description' => 'Remarks added when adding the entity to a collection. This parameter is currently valid only for album collections.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'name' => 'Type', + 'in' => 'formData', + 'schema' => ['description' => 'The type of the process definition. Valid values:'."\n" + ."\n" + .'- MaxCompute'."\n" + ."\n" + .'- DataService'."\n" + ."\n" + .'- Extension'."\n" + ."\n" + .'- Hologres'."\n" + ."\n" + .'- EMR (You cannot create custom definitions for this type.)'."\n" + ."\n" + .'- DataAssetGovernance (You cannot create custom definitions for this type.)'."\n" + ."\n" + .'- Lindorm (You cannot create custom definitions for this type.)'."\n" + ."\n" + .'- DlfNext (You cannot create custom definitions for this type.)'."\n" + ."\n" + .'- DlfV1 (You cannot create custom definitions for this type.)'."\n" + ."\n" + .'- StarRocks (You cannot create custom definitions for this type.)', 'type' => 'string', 'required' => false, 'default' => 'MaxComputeTable', 'example' => 'MaxCompute', 'title' => ''], ], ], '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' => 'C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '0bc5df3a17***903790e8e8a'], + 'PagingInfo' => [ + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'ProcessDefinitions' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the process definition.', 'type' => 'string', 'example' => '10354346', 'title' => ''], + 'Name' => ['description' => 'The name of the process definition.', 'type' => 'string', 'example' => 'MaxCompute 表审批', 'title' => ''], + 'Description' => ['description' => 'The description of the process definition.', 'type' => 'string', 'example' => 'lwt_ide_simple 项目 MaxCompute 表审批策略', 'title' => ''], + 'Type' => ['description' => 'The type of the process definition. Valid values:'."\n" + ."\n" + .'- MaxCompute'."\n" + ."\n" + .'- DataService'."\n" + ."\n" + .'- Extension'."\n" + ."\n" + .'- Hologres'."\n" + ."\n" + .'- DlfV1 (You cannot create custom definitions for this type.)'."\n" + ."\n" + .'- EMR (You cannot create custom definitions for this type.)'."\n" + ."\n" + .'- DataAssetGovernance (You cannot create custom definitions for this type.)'."\n" + ."\n" + .'- Lindorm (You cannot create custom definitions for this type.)'."\n" + ."\n" + .'- StarRocks (You cannot create custom definitions for this type.)'."\n" + ."\n" + .'- DlfNext (You cannot create custom definitions for this type.)'."\n" + ."\n" + .'- DataWorks (You cannot create custom definitions for this type.)', 'type' => 'string', 'example' => 'MaxCompute', 'title' => ''], + 'SubType' => ['description' => 'The subtype. Valid values:'."\n" + ."\n" + .'- Table'."\n" + ."\n" + .'- Column'."\n" + ."\n" + .'- Database'."\n" + ."\n" + .'- Schema'."\n" + ."\n" + .'- Default', 'type' => 'string', 'example' => 'Table', 'title' => ''], + 'IsSystem' => ['description' => 'Indicates whether this is a default system policy. System policies have restricted update capabilities.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Enabled' => ['description' => 'Indicates whether the process definition is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Priority' => ['description' => 'The priority. A smaller value indicates a higher priority.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'Scopes' => [ + 'type' => 'array', + 'items' => ['description' => 'A phase in which the rule is effective.', 'type' => 'string', 'example' => 'Deployment', 'title' => ''], + 'description' => 'The phases in which the rule is effective. Valid values:'."\n" + ."\n" + .'- `Deployment`: The policy is checked when an application is submitted.'."\n" + ."\n" + .'- `Running`: The policy is checked during process execution to determine if approval can be skipped. (Supported only for the MaxCompute type)', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'A summary of a process definition.', + 'title' => '', + 'example' => '', + ], + 'description' => 'A list of process definitions. For more information, see the `ProcessDefinition` object.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The pagination information.', + 'title' => '', + 'example' => '', ], ], + 'description' => '- **Request ID**'."\n" + ."\n" + .'- **Error message**: Populated if the call fails.'."\n" + ."\n" + .'- **Error code**: Populated if the call fails.'."\n" + ."\n" + .'- **A list of process definitions**: For more information, see the ProcessDefinition object.', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C99E2BE6-9DEA-5C2E-8F51-1DDCFEADE490\\"\\n}","type":"json"}]', - 'title' => 'AddEntityIntoMetaCollection', - ], - 'RemoveEntityFromMetaCollection' => [ - 'summary' => 'Removes an entity from a collection in Data Map. Collections include categories and data albums. Entities can be only tables. If you want to remove an entity from a data album, the account that you use must be attached the AliyunDataWorksFullAccess policy, or you are the data album creator or administrator.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListProcessDefinitions', + 'description' => '## Description'."\n" + ."\n" + .'- Queries process definitions of a specified policy type.'."\n" + ."\n" + .'- This operation supports paginated queries. You can use the`PageSize` and`PageNumber` parameters to control the page size and page number.'."\n" + ."\n" + .'- You can also use the`NextToken` and`MaxResults` parameters to page through large result sets.'."\n" + ."\n" + .'- The response includes the total count, page size, current page number, and a list of process definitions.'."\n" + ."\n" + .'- Each process definition includes key attributes, such as its ID, enabled status, and priority.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc5df3a17***903790e8e8a\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 100,\\n \\"ProcessDefinitions\\": [\\n {\\n \\"Id\\": \\"10354346\\",\\n \\"Name\\": \\"MaxCompute 表审批\\",\\n \\"Description\\": \\"lwt_ide_simple 项目 MaxCompute 表审批策略\\",\\n \\"Type\\": \\"MaxCompute\\",\\n \\"SubType\\": \\"Table\\",\\n \\"IsSystem\\": false,\\n \\"Enabled\\": true,\\n \\"Priority\\": \\"1\\",\\n \\"Scopes\\": [\\n \\"Deployment\\"\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListProjectMembers' => [ + 'summary' => 'Gets a paginated list of workspace member details.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'list', 'riskType' => 'none', - 'abilityTreeCode' => '267220', - 'abilityTreeNodes' => [ - 'FEATUREdideE9XYA6', - ], + 'chargeType' => 'free', + 'abilityTreeCode' => '244503', + 'abilityTreeNodes' => ['FEATUREdideYTM537'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'MetaCollectionId', - 'in' => 'query', + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the DataWorks workspace. To obtain this ID, log in to the [DataWorks Console](https://workbench.data.aliyun.com/console) and go to the Workspace Management page.'."\n" + ."\n" + .'This parameter specifies the DataWorks workspace for the API call.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '62136', 'title' => ''], + ], + [ + 'name' => 'UserIds', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The collection ID. You can call the ListMetaCollections operation to query the ID.'."\n", - 'type' => 'string', + 'description' => 'A list of DataWorks user IDs to filter the results. You can find these IDs on the [Tenant Members and Roles](https://dataworks.console.aliyun.com/product/ms_menu) page in the Management Center.', + 'type' => 'array', + 'items' => ['description' => 'A DataWorks user ID.', 'type' => 'string', 'required' => false, 'example' => '123422344899', 'title' => ''], 'required' => false, - 'example' => 'category.123', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Id', - 'in' => 'query', + 'name' => 'RoleCodes', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The entity ID. Currently, entities can only be tables. You can call the ListTables operation to query the ID.'."\n", - 'type' => 'string', + 'description' => 'A list of role codes for the workspace to filter the results. You can call the [ListProjectRoles](~~2853930~~) operation to obtain the role codes.', + 'type' => 'array', + 'items' => ['description' => 'A role code for the workspace.', 'type' => 'string', 'required' => false, 'example' => 'role_project_guest', 'title' => ''], 'required' => false, - 'example' => 'dlf-table:123456789:test_catalog:test_database::test_table', + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => ['description' => 'The page number. Pages start from page 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' => 'Schema of Response', + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '6D6CD444-DFA0-5180-9763-4A8730F2B382', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The unique ID of the request, used to track logs and troubleshoot issues.', 'type' => 'string', 'example' => '9FBBBB1F-DD5E-5D8E-8F50-37F77460F056'], + 'PagingInfo' => [ + 'description' => 'The paging information.', + 'type' => 'object', + 'properties' => [ + 'PageSize' => ['description' => 'The number of entries to return on each 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 matching entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '12', 'title' => ''], + 'ProjectMembers' => [ + 'description' => 'The list of Workspace members.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of a single Workspace member.', + 'type' => 'object', + 'properties' => [ + 'ProjectId' => ['description' => 'The ID of the DataWorks Workspace.', 'type' => 'integer', 'format' => 'int64', 'example' => '62136', 'title' => ''], + 'UserId' => ['description' => 'The ID of the DataWorks user.', 'type' => 'string', 'example' => '123422344899', 'title' => ''], + 'Status' => [ + 'description' => 'The status of the Workspace member.'."\n" + ."\n" + .'- `Normal`: The member is active.'."\n" + ."\n" + .'- `Forbidden`: The member is disabled.', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'Normal', + 'title' => '', + ], + 'Roles' => [ + 'description' => 'The roles assigned to the Workspace member.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of an assigned role.', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => 'The code of the role.', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'role_project_guest', + 'title' => '', + ], + 'Name' => ['description' => 'The name of the role.', 'type' => 'string', 'example' => 'Visitors', 'title' => ''], + 'Type' => ['description' => 'The type of the role.'."\n" + ."\n" + .'- `UserCustom`: A user-defined role.'."\n" + ."\n" + .'- `System`: A system role.', 'type' => 'string', 'example' => 'System', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'UserName' => ['description' => 'The name of the DataWorks user.', 'type' => 'string', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6D6CD444-DFA0-5180-9763-4A8730F2B382\\"\\n}","type":"json"}]', - 'title' => 'RemoveEntityFromMetaCollection', - ], - 'ListAlertRules' => [ - 'summary' => 'Queries a list of custom monitoring alert rules.', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9FBBBB1F-DD5E-5D8E-8F50-37F77460F056\\",\\n \\"PagingInfo\\": {\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"TotalCount\\": 12,\\n \\"ProjectMembers\\": [\\n {\\n \\"ProjectId\\": 62136,\\n \\"UserId\\": \\"123422344899\\",\\n \\"Status\\": \\"Normal\\",\\n \\"Roles\\": [\\n {\\n \\"Code\\": \\"role_project_guest\\",\\n \\"Name\\": \\"Visitors\\",\\n \\"Type\\": \\"System\\"\\n }\\n ],\\n \\"UserName\\": \\"\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListProjectMembers', + 'description' => 'This feature is available in DataWorks Basic Edition and higher.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:ListProjectMembers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListProjectRoles' => [ + 'summary' => 'Returns a paginated list of roles in a workspace.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -35127,384 +38566,188 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '249251', - 'abilityTreeNodes' => [ - 'FEATUREdideRJGWWC', - ], + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '244505', + 'abilityTreeNodes' => ['FEATUREdideYTM537'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'Owner', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the owner of the rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1933790683****', - ], - ], - [ - 'name' => 'TaskIds', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The IDs of the scheduling tasks.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the scheduling task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1234', - ], - 'required' => false, - ], + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the DataWorks workspace. You can find the ID on the Workspace Management page in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n" + ."\n" + .'This parameter specifies the DataWorks workspace for which you want to list roles.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '21229', 'title' => ''], ], [ - 'name' => 'Types', - 'in' => 'query', + 'name' => 'Codes', + 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'The alert triggering condition.'."\n", + 'description' => 'An array of workspace role codes.', 'type' => 'array', 'items' => [ - 'description' => 'The alert type. Valid values:'."\n" + 'description' => 'The code of a workspace role.'."\n" + ."\n" + .'- `role_project_admin`: Workspace Admin'."\n" + ."\n" + .'- `role_project_dev`: Developer'."\n" ."\n" - .'* Finished: An instance is successfully run.'."\n" - .'* UnFinished: An instance does not finish running before a specified point in time.'."\n" - .'* Error: An error occurs on an instance.'."\n" - .'* CycleUnfinished: An instance does not finish running as expected within a specific cycle.'."\n" - .'* Timeout: An instance times out.'."\n" - .'* InstanceTransferComplete: An instance is generated by the auto triggered node.'."\n" - .'* InstanceTransferFluctuate: The number of generated instances fluctuates.'."\n" - .'* ExhaustedError: An error persists after an instance is automatically rerun.'."\n" - .'* InstanceKeyword: An instance with errors contains specified keywords.'."\n" - .'* InstanceErrorCount: The number of instances on which an error occurs reaches a specified threshold.'."\n" - .'* InstanceErrorPercentage: The proportion of instances on which an error occurs in the workspace to the total number of instances reaches a specified threshold.'."\n" - .'* ResourceGroupPercentage: The usage rate of the resource group reaches a specified threshold.'."\n" - .'* ResourceGroupWaitCount: The number of instances that are waiting for resources in the resource group reaches a specified threshold.'."\n", + .'- `role_project_dg_admin`: Data Governance Admin'."\n" + ."\n" + .'- `role_project_guest`: Guest'."\n" + ."\n" + .'- `role_project_security`: Security Admin'."\n" + ."\n" + .'- `role_project_deploy`: Deployer'."\n" + ."\n" + .'- `role_project_owner`: Workspace Owner'."\n" + ."\n" + .'- `role_project_data_analyst`: Data Analyst'."\n" + ."\n" + .'- `role_project_pe`: O\\&M'."\n" + ."\n" + .'- `role_project_erd`: Model Designer', + 'enumValueTitles' => [], 'type' => 'string', 'required' => false, - 'example' => 'Error', + 'example' => 'role_project_guest', + 'title' => '', ], 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Receiver', - 'in' => 'query', + 'name' => 'Names', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the alert recipient.'."\n", - 'type' => 'string', + 'description' => 'An array of workspace role names.', + 'type' => 'array', + 'items' => ['description' => 'The name of a workspace role.', 'type' => 'string', 'required' => false, 'example' => 'Visitors', 'title' => ''], 'required' => false, - 'example' => '1933790683****', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Name', - 'in' => 'query', + 'name' => 'Type', + 'in' => 'formData', 'schema' => [ - 'description' => 'The name of the rule.'."\n", + 'description' => 'The type of the workspace role.'."\n" + ."\n" + .'- `UserCustom`: Custom Role'."\n" + ."\n" + .'- `System`: System Role', + 'enumValueTitles' => [], 'type' => 'string', 'required' => false, - 'example' => 'error_rule', + 'example' => 'System', + 'title' => '', ], ], [ 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Pages start from page 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'minimum' => '1', - 'example' => '1', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The page number to return.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'maximum' => '100', - 'example' => '10', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The number of entries to return 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 response parameters.'."\n", + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'A6C6B486-E3A2-5D52-9E76-D9380485D946', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID. Use this ID to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => '61649187-0BCF-5E75-8D4B-64FDBEBBB447'], 'PagingInfo' => [ - 'description' => 'The pagination information.'."\n", + 'description' => 'The pagination information.', 'type' => 'object', 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - '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', - ], - 'AlertRules' => [ - 'description' => 'The rules.'."\n", + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'string', 'example' => '10', 'title' => ''], + 'PageNumber' => ['description' => 'The returned page number.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of matching entries.', 'type' => 'string', 'example' => '42', 'title' => ''], + 'ProjectRoles' => [ + 'description' => 'A list of workspace roles.', 'type' => 'array', 'items' => [ + 'description' => 'Details of a workspace role.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => 'The rule ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '22125', - ], - 'Name' => [ - 'description' => 'The name of the rule.'."\n", - 'type' => 'string', - 'example' => 'error_test', - ], - 'Owner' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the owner of the rule.'."\n", - 'type' => 'string', - 'example' => '1933790683****', - ], - 'Enabled' => [ - 'description' => 'Indicates whether the rule is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'TriggerCondition' => [ - 'description' => 'The alert triggering condition.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The alert type. Valid values:'."\n" - ."\n" - .'* Finished: An instance is successfully run.'."\n" - .'* UnFinished: An instance does not finish running before a specified point in time.'."\n" - .'* Error: An error occurs on an instance.'."\n" - .'* CycleUnfinished: An instance does not finish running as expected within a specific cycle.'."\n" - .'* Timeout: An instance times out.'."\n" - .'* InstanceTransferComplete: An instance is generated by the auto triggered node.'."\n" - .'* InstanceTransferFluctuate: The number of generated instances fluctuates.'."\n" - .'* ExhaustedError: An error persists after an instance is automatically rerun.'."\n" - .'* InstanceKeyword: An instance with errors contains specified keywords.'."\n" - .'* InstanceErrorCount: The number of instances on which an error occurs reaches a specified threshold.'."\n" - .'* InstanceErrorPercentage: The proportion of instances on which an error occurs in the workspace to the total number of instances reaches a specified threshold.'."\n" - .'* ResourceGroupPercentage: The usage rate of the resource group reaches a specified threshold.'."\n" - .'* ResourceGroupWaitCount: The number of instances that are waiting for resources in the resource group reaches a specified threshold.'."\n", - 'type' => 'string', - 'example' => 'Error', - ], - 'Extension' => [ - 'description' => 'The extended information about the rule. This parameter is required for specific types of alerts.'."\n", - 'type' => 'object', - 'properties' => [ - 'Error' => [ - 'description' => 'The configuration for an alert of the Error type.'."\n", - 'type' => 'object', - 'properties' => [ - 'StreamTaskIds' => [ - 'description' => 'The IDs of the real-time computing tasks. This parameter is required when you monitor real-time computing tasks.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the real-time computing task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - ], - 'AutoRerunAlertEnabled' => [ - 'description' => 'Indicates whether an alert is triggered if a batch synchronization task is automatically rerun upon a failure.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - ], - ], - 'Timeout' => [ - 'description' => 'The configuration for an alert of the Timeout type.'."\n", - 'type' => 'object', - 'properties' => [ - 'TimeoutInMinutes' => [ - 'description' => 'The timeout period. Unit: minutes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - ], - ], - 'UnFinished' => [ - 'description' => 'The configuration for an alert of the UnFinished type.'."\n", - 'type' => 'object', - 'properties' => [ - 'UnFinishedTime' => [ - 'description' => 'The latest completion time of the instance. The period is in the hh:mm format. Valid values of hh: \\[0,47]. Valid values of mm: \\[0,59].'."\n", - 'type' => 'string', - 'example' => '12:00', - ], - ], - ], - 'CycleUnfinished' => [ - 'description' => 'The configuration for an alert of the CycleUnfinished type.'."\n", - 'type' => 'object', - 'properties' => [ - 'CycleAndTime' => [ - 'description' => 'The configurations of the scheduling cycle and timeout period of the instance.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'CycleId' => [ - 'description' => 'The ID of the scheduling cycle of the instance. Valid values: \\[1,288].'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Time' => [ - 'description' => 'The latest completion time of the instance within the scheduling cycle. The time is in the hh:mm format. Valid values of hh: \\[0,47]. Valid values of mm: \\[0,59].'."\n", - 'type' => 'string', - 'example' => '01:00', - ], - ], - 'description' => '', - ], - ], - ], - ], - 'InstanceErrorCount' => [ - 'description' => 'The configuration for an alert of the InstanceErrorCount type.'."\n", - 'type' => 'object', - 'properties' => [ - 'Count' => [ - 'description' => 'The maximum number of instances on which an error occurs. Valid values: \\[1,10000].'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - ], - ], - 'InstanceErrorPercentage' => [ - 'description' => 'The configuration for an alert of the InstanceErrorPercentage type.'."\n", - 'type' => 'object', - 'properties' => [ - 'Percentage' => [ - 'description' => 'The maximum percentage of instances on which an error occurs in the workspace to the total number of instances. Valid values: \\[1-100].'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - ], - ], - 'InstanceTransferFluctuate' => [ - 'description' => 'The configuration for an alert of the InstanceTransferFluctuate type.'."\n", - 'type' => 'object', - 'properties' => [ - 'Trend' => [ - 'description' => 'The way in which the number of auto triggered node instances that are generated in your workspace fluctuates. Valid values:'."\n" - ."\n" - .'* abs: the absolute value. The number of instances increases or decreases.'."\n" - .'* increase: The number of instances increases.'."\n" - .'* decrease: The number of instances decreases.'."\n", - 'type' => 'string', - 'example' => 'abs', - ], - 'Percentage' => [ - 'description' => 'The maximum percentage of fluctuation in the number of auto triggered node instances that are generated in your workspace. Valid values: \\[1-100].'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - ], - ], - ], - ], - 'Target' => [ - 'description' => 'The monitored objects.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the monitored objects. Valid values:'."\n" - ."\n" - .'* Task: node'."\n" - .'* Baseline: baseline'."\n" - .'* Project: workspace'."\n" - .'* BizProcess: workflow'."\n", - 'type' => 'string', - 'example' => 'Task', - ], - 'Ids' => [ - 'description' => 'The IDs of monitored objects.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the monitored object.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '32567', - ], - ], - 'AllowTasks' => [ - 'description' => 'The nodes that are not to be monitored.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the node that is not to be monitored.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123123', - ], - ], - ], + 'ProjectId' => ['description' => 'The ID of the DataWorks workspace.'."\n" + ."\n" + .'Note: For system-defined roles, this parameter returns -1.', 'type' => 'integer', 'format' => 'int64', 'example' => '21229', 'title' => ''], + 'Code' => ['description' => 'The code of the workspace role.', 'type' => 'string', 'example' => 'role_project_guest'."\n", 'title' => ''], + 'Name' => ['description' => 'The name of the workspace role.', 'type' => 'string', 'example' => 'Visitors', 'title' => ''], + 'Type' => ['description' => 'The type of the workspace role.', 'type' => 'string', 'example' => 'System', 'title' => ''], + 'ModulePermissions' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ModuleId' => ['type' => 'integer', 'format' => 'int64', 'example' => '2', 'description' => '', 'title' => ''], + 'ModuleName' => ['type' => 'string', 'example' => 'HoloStudio', 'description' => '', 'title' => ''], + 'PermissionType' => ['type' => 'string', 'example' => 'Read', 'description' => '', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A6C6B486-E3A2-5D52-9E76-D938048****\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 5,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"AlertRules\\": [\\n {\\n \\"Id\\": 22125,\\n \\"Name\\": \\"error_test\\",\\n \\"Owner\\": \\"1933790683****\\",\\n \\"Enabled\\": true,\\n \\"TriggerCondition\\": {\\n \\"Type\\": \\"Error\\",\\n \\"Extension\\": {\\n \\"Error\\": {\\n \\"StreamTaskIds\\": [\\n 123\\n ],\\n \\"AutoRerunAlertEnabled\\": false\\n },\\n \\"Timeout\\": {\\n \\"TimeoutInMinutes\\": 10\\n },\\n \\"UnFinished\\": {\\n \\"UnFinishedTime\\": \\"12:00\\"\\n },\\n \\"CycleUnfinished\\": {\\n \\"CycleAndTime\\": [\\n {\\n \\"CycleId\\": 1,\\n \\"Time\\": \\"01:00\\"\\n }\\n ]\\n },\\n \\"InstanceErrorCount\\": {\\n \\"Count\\": 10\\n },\\n \\"InstanceErrorPercentage\\": {\\n \\"Percentage\\": 10\\n },\\n \\"InstanceTransferFluctuate\\": {\\n \\"Trend\\": \\"abs\\",\\n \\"Percentage\\": 10\\n }\\n },\\n \\"Target\\": {\\n \\"Type\\": \\"Task\\",\\n \\"Ids\\": [\\n 32567\\n ],\\n \\"AllowTasks\\": [\\n 123123\\n ]\\n }\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListAlertRules', - ], - 'GetAlertRule' => [ - 'summary' => 'Queries a custom alert monitoring rule.', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListProjectRoles', + 'description' => 'This feature is available in DataWorks Basic Edition and higher.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:ListProjectRoles', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"61649187-0BCF-5E75-8D4B-64FDBEBBB447\\",\\n \\"PagingInfo\\": {\\n \\"PageSize\\": \\"10\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"TotalCount\\": \\"42\\",\\n \\"ProjectRoles\\": [\\n {\\n \\"ProjectId\\": 21229,\\n \\"Code\\": \\"role_project_guest\\\\n\\",\\n \\"Name\\": \\"Visitors\\",\\n \\"Type\\": \\"System\\",\\n \\"ModulePermissions\\": [\\n {\\n \\"ModuleId\\": 2,\\n \\"ModuleName\\": \\"HoloStudio\\",\\n \\"PermissionType\\": \\"Read\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListProjects' => [ + 'summary' => 'Queries a list of DataWorks workspaces of the tenant to which your account belongs.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -35513,1823 +38756,1444 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '249232', - 'abilityTreeNodes' => [ - 'FEATUREdideRJGWWC', - ], + 'operationType' => 'list', + 'abilityTreeCode' => '244496', + 'abilityTreeNodes' => ['FEATUREdideYTM537'], + 'tenantRelevance' => 'publicInformation', ], 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'query', + 'name' => 'Ids', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The IDs of the DataWorks workspaces.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the DataWorks workspace. You can log on to the [DataWorks console](https://dataworks.console.aliyun.com/workspace/list) and go to the Workspace page to query the ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123456', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'Names', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The names of the DataWorks workspaces.', + 'type' => 'array', + 'items' => ['description' => 'The name of the DataWorks workspace. You can log on to the [DataWorks console](https://dataworks.console.aliyun.com/workspace/list) and go to the Workspace page to query the name.', 'type' => 'string', 'required' => false, 'example' => 'sora_finance', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'AliyunResourceGroupId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the Alibaba Cloud resource group to which the workspaces belong. You can log on to the [Resource Management console](https://resourcemanager.console.aliyun.com/resource-groups) and go to the Resource Group page to query the ID.'."\n" + ."\n" + .'This parameter is used to query the information about workspaces that belong to a specific resource group.', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmzbn****', 'title' => ''], + ], + [ + 'name' => 'Status', + 'in' => 'formData', 'schema' => [ - 'description' => 'The rule ID.'."\n", + 'description' => 'The status of the workspaces. Valid values:'."\n" + ."\n" + .'- Available'."\n" + ."\n" + .'- Initializing'."\n" + ."\n" + .'- InitFailed'."\n" + ."\n" + .'- Forbidden'."\n" + ."\n" + .'- Deleting'."\n" + ."\n" + .'- DeleteFailed'."\n" + ."\n" + .'- Frozen'."\n" + ."\n" + .'- Updating'."\n" + ."\n" + .'- UpdateFailed', + 'enumValueTitles' => [], 'type' => 'string', 'required' => false, - 'example' => '28547072', + 'example' => 'Available', + 'title' => '', ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'DevEnvironmentEnabled', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether the development environment is enabled. Valid values:'."\n" + ."\n" + .'- true: The development environment is enabled. In this case, the development environment is isolated from the production environment in a workspace.'."\n" + ."\n" + .'- false: The development environment is disabled. In this case, only the production environment is used in a workspace.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'DevRoleDisabled', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether the Develop role is disabled. Valid values:'."\n" + ."\n" + .'- false (default)'."\n" + ."\n" + .'- true', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'PaiTaskEnabled', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether scheduling of Platform for AI (PAI) tasks is enabled. Valid values:'."\n" + ."\n" + .'- true: Scheduling of PAI tasks is enabled. In this case, you can create a PAI node in a DataWorks workspace and configure scheduling properties for the node to implement periodic scheduling of PAI tasks.'."\n" + ."\n" + .'- false: Scheduling of PAI tasks is disabled.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'AliyunResourceTags', + 'in' => 'formData', + 'style' => 'json', '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', + 'description' => 'The tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tag. You can log on to the [Resource Management console](https://resourcemanager.console.aliyun.com/tags) and go to the Tag page to query the tag key and tag value.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'batch', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'blue', 'title' => ''], ], - 'AlertRule' => [ - 'description' => 'The information about the rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The rule ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16035', - ], - 'Name' => [ - 'description' => 'The name of the rule.'."\n", - 'type' => 'string', - 'example' => 'error_rule', - ], - 'Owner' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the owner of the rule.'."\n", - 'type' => 'string', - 'example' => '279961421580845157', - ], - 'Enabled' => [ - 'description' => 'Indicates whether the rule is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Notification' => [ - 'description' => 'The configuration for the alert notification.'."\n", - 'type' => 'object', - 'properties' => [ - 'SilenceStartTime' => [ - 'description' => 'The start time for silence. The time is in the HH:mm:ss format.'."\n", - 'type' => 'string', - 'example' => '00:00:00', - ], - 'SilenceEndTime' => [ - 'description' => 'The end time for silence. The time is in the HH:mm:ss format.'."\n", - 'type' => 'string', - 'example' => '00:00:00', - ], - 'IntervalInMinutes' => [ - 'description' => 'The interval at which an alert notification is sent. Unit: minutes. Valid values: \\[5,10000].'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'Maximum' => [ - 'description' => 'The maximum number of times an alert notification can be sent within a calendar day. Valid values: \\[1, 10000].'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'Channels' => [ - 'description' => 'The alert notification channels.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The alert notification channel. Valid values:'."\n" - ."\n" - .'* Mail'."\n" - .'* Phone'."\n" - .'* Sms: text message'."\n" - .'* Dingding: DingTalk'."\n" - .'* Feishu: Lark'."\n" - .'* Weixin: WeCom'."\n" - .'* Webhook: custom webhook'."\n", - 'type' => 'string', - 'example' => 'Sms', - ], - ], - 'Receivers' => [ - 'description' => 'The alert recipients.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ReceiverType' => [ - 'description' => 'The type of the alert recipient. Valid valves:'."\n" - ."\n" - .'* AliUid: Alibaba Cloud account ID.'."\n" - .'* Shift Schedules: the personnel in a shift schedule.'."\n" - .'* TaskOwner: the task owner. The task owner can receive custom alerts and event alerts.'."\n" - .'* Owner: the baseline owner. The baseline owner can receive baseline alerts.'."\n" - .'* WebhookUrl: URL of a custom webhook.'."\n" - .'* DingdingUrl: DingTalk webhook URL.'."\n" - .'* FeishuUrl: Lark webhook URL.'."\n" - .'* WeixinUrl: WeCom webhook URL.'."\n", - 'type' => 'string', - 'example' => 'WebhookUrl', - ], - 'ReceiverValues' => [ - 'description' => 'The alert recipients.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the alert recipient. If the ReceiverType parameter is set to AliUid, set this parameter to an Alibaba Cloud account ID. If the ReceiverType parameter is set to ShiftSchedule, set this parameter to a shift schedule ID. If the ReceiverType parameter is set to WebhookUrl, DingdingUrl, FeishuUrl, or WeixinUrl, set this parameter to a corresponding URL.'."\n", - 'type' => 'string', - 'example' => '123123123', - ], - ], - 'Extension' => [ - 'description' => 'The additional configuration of the alert recipient. If the ReceiverType parameter is set to DingdingUrl, you can set this parameter to {"atAll":true} to remind all members in a DingTalk group.'."\n", - 'type' => 'string', - 'example' => '{"atAll":true}', - ], - ], - 'description' => '', - ], - ], - ], - ], - 'TriggerCondition' => [ - 'description' => 'The alert triggering condition.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The alert type. Valid values:'."\n" - ."\n" - .'* Finished: An instance is successfully run.'."\n" - .'* UnFinished: An instance does not finish running before a specified point in time.'."\n" - .'* Error: An error occurs on an instance.'."\n" - .'* CycleUnfinished: An instance does not finish running as expected within a specific cycle.'."\n" - .'* Timeout: An instance times out.'."\n" - .'* InstanceTransferComplete: An instance is generated by the auto triggered node.'."\n" - .'* InstanceTransferFluctuate: The number of generated instances fluctuates.'."\n" - .'* ExhaustedError: An error persists after an instance is automatically rerun.'."\n" - .'* InstanceKeyword: An instance with errors contains specified keywords.'."\n" - .'* InstanceErrorCount: The number of instances on which an error occurs reaches a specified threshold.'."\n" - .'* InstanceErrorPercentage: The proportion of instances on which an error occurs in the workspace to the total number of instances reaches a specified threshold.'."\n" - .'* ResourceGroupPercentage: The usage rate of the resource group reaches a specified threshold.'."\n" - .'* ResourceGroupWaitCount: The number of instances that are waiting for resources in the resource group reaches a specified threshold.'."\n", - 'type' => 'string', - 'example' => 'Error', - ], - 'Extension' => [ - 'description' => 'The extended information about the rule. This parameter is required for specific types of alerts.'."\n", - 'type' => 'object', - 'properties' => [ - 'Error' => [ - 'description' => 'The configuration for an alert of the Error type.'."\n", - 'type' => 'object', - 'properties' => [ - 'StreamTaskIds' => [ - 'description' => 'The IDs of the real-time computing tasks. This parameter is required when you monitor real-time computing tasks.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the real-time computing task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123123', - ], - ], - 'AutoRerunAlertEnabled' => [ - 'description' => 'Indicates whether an alert is triggered if a batch synchronization task is automatically rerun upon a failure.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - ], - ], - 'Timeout' => [ - 'description' => 'The configuration for an alert of the Timeout type.'."\n", - 'type' => 'object', - 'properties' => [ - 'TimeoutInMinutes' => [ - 'description' => 'The timeout period. Unit: minutes. Valid values: \\[1, 21600].'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - ], - ], - 'UnFinished' => [ - 'description' => 'The configuration for an alert of the UnFinished type.'."\n", - 'type' => 'object', - 'properties' => [ - 'UnFinishedTime' => [ - 'description' => 'The latest completion time of the instance. The period is in the hh:mm format. Valid values of hh: \\[0,47]. Valid values of mm: \\[0,59].'."\n", - 'type' => 'string', - 'example' => '12:00', - ], - ], - ], - 'CycleUnfinished' => [ - 'description' => 'The configuration for an alert of the CycleUnfinished type.'."\n", - 'type' => 'object', - 'properties' => [ - 'CycleAndTime' => [ - 'description' => 'The configurations of the scheduling cycle and timeout period of the instance.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'CycleId' => [ - 'description' => 'The ID of the scheduling cycle of the instance. Valid values: \\[1,288].'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Time' => [ - 'description' => 'The latest completion time of the instance within the scheduling cycle. The time is in the hh:mm format. Valid values of hh: \\[0,47]. Valid values of mm: \\[0,59].'."\n", - 'type' => 'string', - 'example' => '12:00', - ], - ], - 'description' => '', - ], - ], - ], - ], - 'InstanceErrorCount' => [ - 'description' => 'The configuration for an alert of the InstanceErrorCount type.'."\n", - 'type' => 'object', - 'properties' => [ - 'Count' => [ - 'description' => 'The maximum number of instances on which an error occurs. Valid values: \\[1,10000].'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - ], - ], - 'InstanceErrorPercentage' => [ - 'description' => 'The configuration for an alert of the InstanceErrorPercentage type.'."\n", - 'type' => 'object', - 'properties' => [ - 'Percentage' => [ - 'description' => 'The maximum percentage of instances on which an error occurs in the workspace to the total number of instances. Valid values: \\[1-100].'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - ], - ], - 'InstanceTransferFluctuate' => [ - 'description' => 'The configuration for an alert of the InstanceTransferFluctuate type.'."\n", + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', '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.', 'type' => 'integer', 'format' => 'int32', 'default' => '10', 'required' => false, 'example' => '10', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '6D24AD9A-652F-59E2-AC1F-05029300F8A4'], + 'PagingInfo' => [ + 'description' => 'The pagination information.', + 'type' => 'object', + 'properties' => [ + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'Projects' => [ + 'description' => 'The workspaces.', + 'type' => 'array', + 'items' => [ + 'description' => 'The workspace.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123456', 'title' => ''], + 'Name' => ['description' => 'The name of the workspace.', 'type' => 'string', 'example' => 'sora_finance', 'title' => ''], + 'DisplayName' => ['description' => 'The display name of the workspace.', 'type' => 'string', 'example' => 'Sora financial analysis'."\n", 'title' => ''], + 'Description' => ['description' => 'The description of the workspace.', 'type' => 'string', 'example' => 'Financial analysis group project data development', 'title' => ''], + 'Owner' => ['description' => 'The ID of the Alibaba Cloud account to which the workspace belongs.', 'type' => 'string', 'example' => '123532153125', 'title' => ''], + 'AliyunResourceGroupId' => ['description' => 'The ID of the Alibaba Cloud resource group to which the workspace belongs.', 'type' => 'string', 'example' => 'rg-acfmzbn7pti3zfa', 'title' => ''], + 'Status' => ['description' => 'The status of the workspace. Valid values:'."\n" + ."\n" + .'- Available'."\n" + ."\n" + .'- Initializing'."\n" + ."\n" + .'- InitFailed'."\n" + ."\n" + .'- Forbidden'."\n" + ."\n" + .'- Deleting'."\n" + ."\n" + .'- DeleteFailed'."\n" + ."\n" + .'- Frozen'."\n" + ."\n" + .'- Updating'."\n" + ."\n" + .'- UpdateFailed', 'type' => 'string', 'example' => 'Available', 'title' => ''], + 'PaiTaskEnabled' => ['description' => 'Indicates whether scheduling of PAI tasks is enabled. Valid values:'."\n" + ."\n" + .'- true: Scheduling of PAI tasks is enabled. In this case, you can create a PAI node in a DataWorks workspace and configure scheduling properties for the node to implement periodic scheduling of PAI tasks.'."\n" + ."\n" + .'- false: Scheduling of PAI tasks is disabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'DevEnvironmentEnabled' => ['description' => 'Indicates whether the development environment is enabled. Valid values:'."\n" + ."\n" + .'- true: The development environment is enabled. In this case, the development environment is isolated from the production environment in the workspace.'."\n" + ."\n" + .'- false: The development environment is disabled. In this case, only the production environment is used in the workspace.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'DevRoleDisabled' => ['description' => 'Indicates whether the Develop role is disabled. Valid values:'."\n" + ."\n" + .'- false (default)'."\n" + ."\n" + .'- true', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'AliyunResourceTags' => [ + 'description' => 'The tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tag.', 'type' => 'object', 'properties' => [ - 'Trend' => [ - 'description' => 'The way in which the number of auto triggered node instances that are generated in your workspace fluctuates. Valid values:'."\n" - ."\n" - .'* abs: the absolute value. The number of instances increases or decreases.'."\n" - .'* increase: The number of instances increases.'."\n" - .'* decrease: The number of instances decreases.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'Percentage' => [ - 'description' => 'The maximum percentage of fluctuation in the number of auto triggered node instances that are generated in your workspace. Valid values: \\[1-100].'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - ], - ], - ], - ], - 'Target' => [ - 'description' => 'The monitored objects.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the monitored objects. Valid values:'."\n" - ."\n" - .'* Task: node'."\n" - .'* Baseline: baseline'."\n" - .'* project: workspace'."\n" - .'* BizProcess: workflow'."\n", - 'type' => 'string', - 'example' => 'Task', - ], - 'Ids' => [ - 'description' => 'The IDs of monitored objects.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the monitored object.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '32570', - ], - ], - 'AllowTasks' => [ - 'description' => 'The nodes that are not to be monitored.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the node that is not to be monitored.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123123', + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'batch', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'blue', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8abcb91f-d266-4073-b907-2ed****\\",\\n \\"AlertRule\\": {\\n \\"Id\\": 16035,\\n \\"Name\\": \\"error_rule\\",\\n \\"Owner\\": \\"279961421580845157\\",\\n \\"Enabled\\": true,\\n \\"Notification\\": {\\n \\"SilenceStartTime\\": \\"00:00:00\\",\\n \\"SilenceEndTime\\": \\"00:00:00\\",\\n \\"IntervalInMinutes\\": 30,\\n \\"Maximum\\": 3,\\n \\"Channels\\": [\\n \\"Sms\\"\\n ],\\n \\"Receivers\\": [\\n {\\n \\"ReceiverType\\": \\"WebhookUrl\\",\\n \\"ReceiverValues\\": [\\n \\"123123123\\"\\n ],\\n \\"Extension\\": \\"{\\\\\\"atAll\\\\\\":true}\\"\\n }\\n ]\\n },\\n \\"TriggerCondition\\": {\\n \\"Type\\": \\"Error\\",\\n \\"Extension\\": {\\n \\"Error\\": {\\n \\"StreamTaskIds\\": [\\n 123123\\n ],\\n \\"AutoRerunAlertEnabled\\": false\\n },\\n \\"Timeout\\": {\\n \\"TimeoutInMinutes\\": 10\\n },\\n \\"UnFinished\\": {\\n \\"UnFinishedTime\\": \\"12:00\\"\\n },\\n \\"CycleUnfinished\\": {\\n \\"CycleAndTime\\": [\\n {\\n \\"CycleId\\": 1,\\n \\"Time\\": \\"12:00\\"\\n }\\n ]\\n },\\n \\"InstanceErrorCount\\": {\\n \\"Count\\": 10\\n },\\n \\"InstanceErrorPercentage\\": {\\n \\"Percentage\\": 10\\n },\\n \\"InstanceTransferFluctuate\\": {\\n \\"Trend\\": \\"10\\",\\n \\"Percentage\\": 10\\n }\\n },\\n \\"Target\\": {\\n \\"Type\\": \\"Task\\",\\n \\"Ids\\": [\\n 32570\\n ],\\n \\"AllowTasks\\": [\\n 123123\\n ]\\n }\\n }\\n }\\n}","type":"json"}]', - 'title' => 'GetAlertRule', - ], - 'UpdateAlertRule' => [ - 'summary' => 'Updates the information about a custom alert monitoring rule.', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6D24AD9A-652F-59E2-AC1F-05029300F8A4\\",\\n \\"PagingInfo\\": {\\n \\"PageSize\\": 1,\\n \\"PageNumber\\": 10,\\n \\"TotalCount\\": 100,\\n \\"Projects\\": [\\n {\\n \\"Id\\": 123456,\\n \\"Name\\": \\"sora_finance\\",\\n \\"DisplayName\\": \\"Sora financial analysis\\\\n\\",\\n \\"Description\\": \\"Financial analysis group project data development\\",\\n \\"Owner\\": \\"123532153125\\",\\n \\"AliyunResourceGroupId\\": \\"rg-acfmzbn7pti3zfa\\",\\n \\"Status\\": \\"Available\\",\\n \\"PaiTaskEnabled\\": true,\\n \\"DevEnvironmentEnabled\\": true,\\n \\"DevRoleDisabled\\": false,\\n \\"AliyunResourceTags\\": [\\n {\\n \\"Key\\": \\"batch\\",\\n \\"Value\\": \\"blue\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListProjects', + 'description' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:ListProjects', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListResourceGroupAssociateProjects' => [ + 'summary' => 'Query the list of workspaces with which a resource group is associated', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '249192', - 'abilityTreeNodes' => [ - 'FEATUREdideRJGWWC', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdide2SV6DS'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'ResourceGroupId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the serverless resource group.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'Serverless_res_group_524257424564736_6831777003****'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The rule ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '105412', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'example' => 'true'], + 'ProjectIdList' => [ + 'title' => '', + 'description' => 'The list of workspace IDs.', + 'type' => 'array', + 'items' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'example' => '', + ], + 'RequestId' => ['description' => 'The request ID. You can use this ID to troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX'."\n"], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListResourceGroupAssociateProjects', + 'description' => '1. DataWorks Basic Edition or a more advanced edition is required to use this feature.'."\n" + ."\n" + .'2. **Make sure that the service-linked role AliyunServiceRoleForDataWorks has been created before you call this operation.**'."\n" + ."\n" + .'3. This operation returns only the workspaces that the current caller has access to. Unauthorized workspaces are not included in the response.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'collection_name', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:ListResourceGroupAssociateProjects', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'DwResourceGroup', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:dwresourcegroup/{#DwResourceGroupId}'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"ProjectIdList\\": [\\n 123\\n ],\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\\\n\\"\\n}","type":"json"}]', + ], + 'ListResourceGroupMetricData' => [ + 'summary' => 'Queries the metric data of a resource group.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdide2SV6DS'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ [ - 'name' => 'Owner', - 'in' => 'query', + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => ['description' => 'The unique identifier for the general-purpose resource group.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX'], + ], + [ + 'name' => 'MetricName', + 'in' => 'formData', 'schema' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the owner of the rule.'."\n", + 'description' => 'The metric name. Valid values:'."\n" + ."\n" + .'- CUSpec: Maximum CU capacity of the resource group, in CUs.'."\n" + ."\n" + .'- CUUsage: CU usage of the resource group, in CUs.'."\n" + ."\n" + .'- CUUtilization: CU utilization of the resource group, in %.'."\n" + ."\n" + .'- SlotSpec: Maximum number of concurrent slots for resource group scheduling, in slots.'."\n" + ."\n" + .'- SlotUsage: Used concurrency for resource group scheduling, in slots.'."\n" + ."\n" + .'- SchedulerCUMaxSpec: Maximum CU quota for data computing, in CUs.'."\n" + ."\n" + .'- SchedulerCUUsage: CU usage for data computing, in CUs.'."\n" + ."\n" + .'- SchedulerCUMinSpec: Minimum guaranteed CUs for data computing, in CUs.'."\n" + ."\n" + .'- DataIntegrationCUMaxSpec: Maximum CU quota for Data Integration, in CUs.'."\n" + ."\n" + .'- DataIntegrationCUUsage: CU usage for Data Integration, in CUs.'."\n" + ."\n" + .'- DataIntegrationCUMinSpec: Minimum guaranteed CUs for Data Integration, in CUs.'."\n" + ."\n" + .'- DataServiceCUMaxSpec: Maximum CU quota for DataService Studio, in CUs.'."\n" + ."\n" + .'- DataServiceCUUsage: CU usage for DataService Studio, in CUs.'."\n" + ."\n" + .'- DataServiceCUMinSpec: Minimum guaranteed CUs for DataService Studio, in CUs.'."\n" + ."\n" + .'- ServerIdeCUMaxSpec: Maximum CU quota for personal development environment, in CUs.'."\n" + ."\n" + .'- ServerIdeCUUsage: CU usage for personal development environment, in CUs.'."\n" + ."\n" + .'- ServerIdeCUMinSpec: Minimum guaranteed CUs for personal development environment, in CUs.', + 'enumValueTitles' => [], 'type' => 'string', - 'required' => false, - 'example' => '193379****', + 'required' => true, + 'enum' => ['CUSpec', 'CUUsage', 'CUUtilization', 'SlotSpec', 'SlotUsage', 'SchedulerCUMaxSpec', 'SchedulerCUUsage', 'SchedulerCUMinSpec', 'DataIntegrationCUMaxSpec', 'DataIntegrationCUUsage', 'DataIntegrationCUMinSpec', 'DataServiceCUMaxSpec', 'DataServiceCUUsage', 'DataServiceCUMinSpec', 'ServerIdeCUMaxSpec', 'ServerIdeCUUsage', 'ServerIdeCUMinSpec'], + 'title' => '', + 'example' => 'CUSpec', ], ], [ - 'name' => 'Enabled', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the rule.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'name' => 'Period', + 'in' => 'formData', + 'schema' => ['description' => 'The statistical period for monitoring data.'."\n" + ."\n" + .'Value: A multiple of 60.'."\n" + ."\n" + .'Unit: Seconds.'."\n" + ."\n" + .'Default: 60.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '60'], ], [ - 'name' => 'TriggerCondition', - 'in' => 'query', - 'style' => 'json', + 'name' => 'BeginTime', + 'in' => 'formData', + 'schema' => ['description' => 'The start time.'."\n" + ."\n" + .'Supported format: Unix timestamp in milliseconds (the number of milliseconds that have elapsed since January 1, 1970).'."\n" + ."\n" + .'The interval between BeginTime and EndTime must be less than or equal to 31 days.'."\n" + ."\n" + .'Default: The current time minus 2 hours, expressed as a millisecond Unix timestamp.', 'type' => 'integer', 'format' => 'int64', 'minimum' => '0', 'title' => '', 'required' => false, 'example' => '1593950832000'], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + 'schema' => ['description' => 'The end time.'."\n" + ."\n" + .'Supported format: Unix timestamp in milliseconds (the number of milliseconds that have elapsed since January 1, 1970).'."\n" + ."\n" + .'The interval between BeginTime and EndTime must be less than or equal to 31 days.'."\n" + ."\n" + .'Default: The current time, expressed as a millisecond Unix timestamp.', 'type' => 'integer', 'format' => 'int64', 'minimum' => '0', 'title' => '', 'required' => false, 'example' => '1750176000000'], + ], + [ + 'name' => 'NextToken', + 'in' => 'formData', + 'schema' => ['description' => 'The pagination cursor.'."\n" + ."\n" + .'> If this parameter is not set, the first page of data is retrieved. If a value is returned for this parameter, it indicates that there is a next page. You can use the returned NextToken as a parameter to request the next page of data until it returns Null, which means all data has been retrieved.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'FFqBJBxE8I0PE0IUO6K69k7m2FfyWNNc2qQ9ReUkazhz9VA7dWZKlxBcjUwOV0imSM'], + ], + [ + 'name' => 'Length', + 'in' => 'formData', + 'schema' => ['description' => 'The number of records to display on each page for paginated queries.'."\n" + ."\n" + .'> The maximum value of Length for a single request is 1440.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '1440', 'minimum' => '0', 'title' => '', 'required' => false, 'example' => '100'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The alert triggering condition.'."\n", + 'title' => 'Schema of Response', + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => 'The alert type. Valid values:'."\n" - ."\n" - .'* Finished: An instance is successfully run.'."\n" - .'* UnFinished: An instance does not finish running before a specified point in time.'."\n" - .'* Error: An error occurs on an instance.'."\n" - .'* CycleUnfinished: An instance does not finish running as expected within a specific cycle.'."\n" - .'* Timeout: An instance times out.'."\n" - .'* InstanceTransferComplete: An instance is generated by the auto triggered node.'."\n" - .'* InstanceTransferFluctuate: The number of generated instances fluctuates.'."\n" - .'* ExhaustedError: An error persists after an instance is automatically rerun.'."\n" - .'* InstanceKeyword: An instance with errors contains specified keywords.'."\n" - .'* InstanceErrorCount: The number of instances on which an error occurs reaches a specified threshold.'."\n" - .'* InstanceErrorPercentage: The proportion of instances on which an error occurs in the workspace to the total number of instances reaches a specified threshold.'."\n" - .'* ResourceGroupPercentage: The usage rate of the resource group reaches a specified threshold.'."\n" - .'* ResourceGroupWaitCount: The number of instances that are waiting for resources in the resource group reaches a specified threshold.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ERROR', - ], - 'Extension' => [ - 'description' => 'The extended information about the rule. This parameter is required for specific types of alerts.'."\n", - 'type' => 'object', - 'properties' => [ - 'Error' => [ - 'description' => 'The configuration for an alert of the Error type.'."\n", - 'type' => 'object', - 'properties' => [ - 'StreamTaskIds' => [ - 'description' => 'The IDs of the real-time computing tasks. This parameter is required when you monitor real-time computing tasks.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the real-time computing task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123123', - ], - 'required' => false, - ], - 'AutoRerunAlertEnabled' => [ - 'description' => 'Specifies whether to trigger an alert if a batch synchronization task is automatically rerun upon a failure.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - 'required' => false, - ], - 'Timeout' => [ - 'description' => 'The configuration for an alert of the Timeout type.'."\n", - 'type' => 'object', - 'properties' => [ - 'TimeoutInMinutes' => [ - 'description' => 'The timeout period. Unit: minutes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - 'required' => false, - ], - 'UnFinished' => [ - 'description' => 'The configuration for an alert of the UnFinished type.'."\n", - 'type' => 'object', - 'properties' => [ - 'UnFinishedTime' => [ - 'description' => 'The latest completion time of the instance. The period is in the hh:mm format. Valid values of hh: \\[0,47]. Valid values of mm: \\[0,59].'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '12:00', - ], - ], - 'required' => false, - ], - 'CycleUnfinished' => [ - 'description' => 'The configuration for an alert of the CycleUnfinished type.'."\n", - 'type' => 'object', - 'properties' => [ - 'CycleAndTime' => [ - 'description' => 'The configurations of the scheduling cycle and timeout period of the instance.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'CycleId' => [ - 'description' => 'The ID of the scheduling cycle of the instance. Valid values: \\[1,288].'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'Time' => [ - 'description' => 'The latest completion time of the instance within the scheduling cycle. The time is in the hh:mm format. Valid values of hh: \\[0,47]. Valid values of mm: \\[0,59].'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '01:00'."\n", - ], - ], - 'required' => false, - 'description' => '', - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'InstanceErrorCount' => [ - 'description' => 'The configuration for an alert of the InstanceErrorCount type.'."\n", - 'type' => 'object', - 'properties' => [ - 'Count' => [ - 'description' => 'The maximum number of instances on which an error occurs. Valid values: \\[1,10000].'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - 'required' => false, - ], - 'InstanceErrorPercentage' => [ - 'description' => 'The configuration for an alert of the InstanceErrorPercentage type.'."\n", - 'type' => 'object', - 'properties' => [ - 'Percentage' => [ - 'description' => 'The maximum percentage of instances on which an error occurs in the workspace to the total number of instances. Valid values: \\[1-100].'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - 'required' => false, - ], - 'InstanceTransferFluctuate' => [ - 'description' => 'The configuration for an alert of the InstanceTransferFluctuate type.'."\n", - 'type' => 'object', - 'properties' => [ - 'Trend' => [ - 'description' => 'The way in which the number of auto triggered node instances that are generated in your workspace fluctuates. Valid values:'."\n" - ."\n" - .'* abs: the absolute value. The number of instances increases or decreases.'."\n" - .'* increase: The number of instances increases.'."\n" - .'* decrease: The number of instances decreases.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abs', - ], - 'Percentage' => [ - 'description' => 'The maximum percentage of fluctuation in the number of auto triggered node instances that are generated in your workspace. Valid values: \\[1-100].'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'Target' => [ - 'description' => 'The monitored objects.'."\n", + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'example' => 'true'], + 'MetricData' => [ + 'title' => '', + 'description' => 'Monitoring metric data.', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => 'The type of the monitored objects. Valid values:'."\n" - ."\n" - .'* Task: node'."\n" - .'* Baseline: baseline'."\n" - .'* project: workspace'."\n" - .'* BizProcess: workflow'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Task', - ], - 'Ids' => [ - 'description' => 'The IDs of monitored objects.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the monitored object.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1894580', - ], - 'required' => false, - ], - 'AllowTasks' => [ - 'description' => 'The nodes that are not to be monitored.'."\n", + 'Id' => ['description' => 'The unique identifier for the resource group.', 'type' => 'string', 'title' => '', 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX'."\n"], + 'MetricName' => ['description' => 'The metric name. Valid values:'."\n" + ."\n" + .'- CUSpec: Maximum CU capacity of the resource group, in CUs.'."\n" + ."\n" + .'- CUUsage: CU usage of the resource group, in CUs.'."\n" + ."\n" + .'- CUUtilization: CU utilization of the resource group, in %.'."\n" + ."\n" + .'- SlotSpec: Maximum number of concurrent slots for resource group scheduling, in slots.'."\n" + ."\n" + .'- SlotUsage: Used concurrency for resource group scheduling, in slots.'."\n" + ."\n" + .'- SchedulerCUMaxSpec: Maximum CU quota for data computing, in CUs.'."\n" + ."\n" + .'- SchedulerCUUsage: CU usage for data computing, in CUs.'."\n" + ."\n" + .'- SchedulerCUMinSpec: Minimum guaranteed CUs for data computing, in CUs.'."\n" + ."\n" + .'- DataIntegrationCUMaxSpec: Maximum CU quota for Data Integration, in CUs.'."\n" + ."\n" + .'- DataIntegrationCUUsage: CU usage for Data Integration, in CUs.'."\n" + ."\n" + .'- DataIntegrationCUMinSpec: Minimum guaranteed CUs for Data Integration, in CUs.'."\n" + ."\n" + .'- DataServiceCUMaxSpec: Maximum CU quota for DataService Studio, in CUs.'."\n" + ."\n" + .'- DataServiceCUUsage: CU usage for DataService Studio, in CUs.'."\n" + ."\n" + .'- DataServiceCUMinSpec: Minimum guaranteed CUs for DataService Studio, in CUs.'."\n" + ."\n" + .'- ServerIdeCUMaxSpec: Maximum CU quota for personal development environment, in CUs.'."\n" + ."\n" + .'- ServerIdeCUUsage: CU usage for personal development environment, in CUs.'."\n" + ."\n" + .'- ServerIdeCUMinSpec: Minimum guaranteed CUs for personal development environment, in CUs.', 'type' => 'string', 'title' => '', 'example' => 'CUSpec'], + 'NextToken' => ['description' => 'The pagination cursor.', 'type' => 'string', 'title' => '', 'example' => 'tSBOXZcAmk+akxRkwRuXnGQEsIDODyd5ulPqgytNTbLp4bhb7fuvz13FXtm87Kfl'], + 'Metrics' => [ + 'title' => '', + 'description' => 'The list of metric data.', 'type' => 'array', 'items' => [ - 'description' => 'The ID of the node that is not to be monitored.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1111', + 'title' => '', + 'description' => 'The metric data.', + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => 'The value of the metric data.', 'type' => 'number', 'format' => 'double', 'title' => '', 'example' => '1.0'], + 'Timestamp' => ['description' => 'The timestamp.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1761184929633'], + ], + 'example' => '', ], - 'required' => false, + 'example' => '', ], ], - 'required' => false, + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID, used for locating logs and troubleshooting.', 'type' => 'string', 'title' => '', 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX'."\n"], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListResourceGroupMetricData', + 'description' => '1. DataWorks Basic Edition or a more advanced edition is required to use this feature.'."\n" + ."\n" + .'2. **Make sure that the service-linked role AliyunServiceRoleForDataWorks has been created before you call this operation.**'."\n" + ."\n" + .'3. This operation applies only to serverless resource groups.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:ListResourceGroupMetricData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'DwResourceGroup', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:dwresourcegroup/{#DwResourceGroupId}'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"MetricData\\": {\\n \\"Id\\": \\"Serverless_res_group_524257424564736_6831777003XXXXX\\\\n\\",\\n \\"MetricName\\": \\"CUSpec\\",\\n \\"NextToken\\": \\"tSBOXZcAmk+akxRkwRuXnGQEsIDODyd5ulPqgytNTbLp4bhb7fuvz13FXtm87Kfl\\",\\n \\"Metrics\\": [\\n {\\n \\"Value\\": 1,\\n \\"Timestamp\\": 1761184929633\\n }\\n ]\\n },\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\\\n\\"\\n}","type":"json"}]', + ], + 'ListResourceGroups' => [ + 'summary' => 'Retrieves a list of resource groups.', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '245169', + 'abilityTreeNodes' => ['FEATUREdide2SV6DS'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the resource group. Fuzzy search is supported.', 'type' => 'string', 'example' => 'Resource', 'title' => '', 'required' => false], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the workspace.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => '', 'required' => false], + ], + [ + 'name' => 'Statuses', + 'in' => 'query', + 'allowEmptyValue' => true, + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'The statuses of the resource groups to query.', + 'type' => 'array', + 'items' => [ + 'description' => 'The status of the resource group. Valid values include:'."\n" + ."\n" + .'- `Normal`: The resource group is running.'."\n" + ."\n" + .'- `Stop`: The resource group is stopped, typically because it has expired.'."\n" + ."\n" + .'- `Deleted`: The resource group is deleted, released, or destroyed.'."\n" + ."\n" + .'- `Creating`: The resource group is being created.'."\n" + ."\n" + .'- `CreateFailed`: The resource group failed to be created.'."\n" + ."\n" + .'- `Updating`: The resource group is being updated, for example, by scaling up, scaling down, or changing configurations.'."\n" + ."\n" + .'- `UpdateFailed`: The resource group failed to be updated, for example, due to a scaling or upgrade failure.'."\n" + ."\n" + .'- `Deleting`: The resource group is being deleted, released, or destroyed.'."\n" + ."\n" + .'- `DeleteFailed`: The resource group failed to be deleted, for example, due to a release or destroy failure.'."\n" + ."\n" + .'- `Timeout`: The operation has timed out.'."\n" + ."\n" + .'- `Frozen`: The resource group is frozen.'."\n" + ."\n" + .'- `Starting`: The resource group is starting.', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'Normal', + 'enum' => ['Normal', 'Stop', 'Deleted', 'Creating', 'CreateFailed', 'Updating', 'UpdateFailed', 'Deleting', 'DeleteFailed', 'Timeout', 'Freezed', 'Starting'], + 'title' => '', + 'required' => false, ], 'required' => false, + 'example' => '', ], ], [ - 'name' => 'Notification', + 'name' => 'ResourceGroupTypes', 'in' => 'query', + 'allowEmptyValue' => true, 'style' => 'json', 'schema' => [ - 'description' => 'The configuration for the alert notification.'."\n", - 'type' => 'object', - 'properties' => [ - 'SilenceStartTime' => [ - 'description' => 'The start time for silence. The time is in the HH:mm:ss format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '00:00:00'."\n", - ], - 'SilenceEndTime' => [ - 'description' => 'The end time for silence. The time is in the HH:mm:ss format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '00:00:00'."\n", - ], - 'IntervalInMinutes' => [ - 'description' => 'The interval at which an alert notification is sent. Unit: minutes. Valid values: \\[5,10000].'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], - 'Maximum' => [ - 'description' => 'The maximum number of times an alert notification can be sent within a calendar day. Valid values: \\[1, 10000].'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], - 'Channels' => [ - 'description' => 'The alert notification channels.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The alert notification channel. Valid values:'."\n" - ."\n" - .'* Mail'."\n" - .'* Phone'."\n" - .'* Sms: text message'."\n" - .'* Dingding: DingTalk'."\n" - .'* Feishu: Lark'."\n" - .'* Weixin: WeCom'."\n" - .'* Webhook: custom webhook'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Sms', - ], - 'required' => false, - ], - 'Receivers' => [ - 'description' => 'The alert recipients.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ReceiverType' => [ - 'description' => 'The type of the alert recipient. Valid valves:'."\n" - ."\n" - .'* AliUid: Alibaba Cloud account ID.'."\n" - .'* Shift Schedules: the personnel in a shift schedule.'."\n" - .'* TaskOwner: the task owner. The task owner can receive custom alerts and event alerts.'."\n" - .'* Owner: the baseline owner. The baseline owner can receive baseline alerts.'."\n" - .'* WebhookUrl: URL of a custom webhook.'."\n" - .'* DingdingUrl: DingTalk webhook URL.'."\n" - .'* FeishuUrl: Lark webhook URL.'."\n" - .'* WeixinUrl: WeCom webhook URL.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TaskOwner', - ], - 'ReceiverValues' => [ - 'description' => 'The alert recipients.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the alert recipient. If the ReceiverType parameter is set to AliUid, set this parameter to an Alibaba Cloud account ID. If the ReceiverType parameter is set to ShiftSchedule, set this parameter to a shift schedule ID. If the ReceiverType parameter is set to WebhookUrl, DingdingUrl, FeishuUrl, or WeixinUrl, set this parameter to a corresponding URL.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123123', - ], - 'required' => false, - ], - 'Extension' => [ - 'description' => 'The additional configuration of the alert recipient. If the ReceiverType parameter is set to DingdingUrl, you can set this parameter to {"atAll":true} to remind all members in a DingTalk group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"atAll":true}'."\n", - ], - ], - 'required' => false, - 'description' => '', - ], - 'required' => false, - ], + 'title' => '', + 'description' => 'The types of the resource groups to query. **If this parameter is not specified, general-purpose resource groups are queried by default.**', + 'type' => 'array', + 'items' => [ + 'description' => 'The type of the resource group. Valid values include:'."\n" + ."\n" + .'- `CommonV2`: General-purpose resource group (new version).'."\n" + ."\n" + .'- `ExclusiveDataIntegration`: exclusive data integration resource group.'."\n" + ."\n" + .'- `ExclusiveScheduler`: exclusive scheduler resource group.'."\n" + ."\n" + .'- `ExclusiveDataService`: exclusive data service resource group.', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'CommonV2', + 'enum' => ['CommonV2', 'ExclusiveScheduler', 'ExclusiveDataIntegration', 'ExclusiveDataService'], + 'title' => '', + 'required' => false, ], 'required' => false, + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'PaymentType', + 'in' => 'query', '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' => 'D85FEE2B-6174-5817-AF9E-FDD02FEDA5BC', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'description' => 'The billing method of the resource group. Valid values include:'."\n" + ."\n" + .'- `PrePaid`: subscription.'."\n" + ."\n" + .'- `PostPaid`: pay-as-you-go.', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'PrePaid', + 'enum' => ['PrePaid', 'PostPaid'], + 'title' => '', + 'required' => false, + ], + ], + [ + 'name' => 'AliyunResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The Alibaba Cloud resource group ID.', 'type' => 'string', 'example' => 'rg-aek2kqofrgXXXXX', 'title' => '', 'required' => false], + ], + [ + 'name' => 'AliyunResourceTags', + 'in' => 'query', + 'allowEmptyValue' => true, + 'style' => 'json', + 'schema' => [ + 'title' => '', + 'description' => 'The list of Alibaba Cloud tags.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'An Alibaba Cloud tag.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'key', 'title' => '', 'required' => false], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'value', 'title' => '', 'required' => false], ], + 'required' => false, + 'example' => '', ], + 'required' => false, + 'example' => '', ], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D85FEE2B-6174-5817-AF9E-FDD02FEDA5BC\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'UpdateAlertRule', - ], - 'DeleteAlertRule' => [ - 'summary' => 'Deletes a custom monitoring alert rule.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'default' => '100', 'title' => '', 'required' => false], ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '249142', - 'abilityTreeNodes' => [ - 'FEATUREdideRJGWWC', + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1', 'title' => '', 'required' => false], ], - ], - 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The rule ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '105412', - ], + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => ['description' => 'The sorting criterion for the results. The format is `FieldName SortOrder`. `SortOrder` can be `Asc` (ascending) or `Desc` (descending). If you do not specify `SortOrder`, the default is `Asc`. The following fields are supported:'."\n" + ."\n" + .'- `Id`: Resource group ID'."\n" + ."\n" + .'- `Name`: Resource group name'."\n" + ."\n" + .'- `Remark`: Resource group remarks'."\n" + ."\n" + .'- `Type`: Resource group type'."\n" + ."\n" + .'- `Status`: Resource group status'."\n" + ."\n" + .'- `Spec`: Resource group specifications'."\n" + ."\n" + .'- `CreateUser`: The user who created the resource group'."\n" + ."\n" + .'- `CreateTime`: The time when the resource group was created'."\n" + ."\n" + .'Default value: `CreateTime Asc`', 'type' => 'string', 'example' => 'CreateTime Asc', 'default' => 'CreateTime Asc', 'title' => '', 'required' => false], ], ], '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' => '8754EE08-4AA2-5F77-ADD7-754DBBDA9F75', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'PagingInfo' => [ + 'title' => '', + 'description' => 'The pagination information.', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupList' => [ + 'title' => '', + 'description' => 'The list of resource groups.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'The details of a resource group.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The unique identifier of the resource group.', 'type' => 'string', 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX', 'title' => ''], + 'Name' => ['description' => 'The name of the resource group.', 'type' => 'string', 'example' => 'common_resource_group', 'title' => ''], + 'Remark' => ['description' => 'The description of the resource group.', 'type' => 'string', 'example' => 'Create a general-purpose resource group for common tasks.', 'title' => ''], + 'PaymentType' => [ + 'description' => 'The billing method of the resource group. `PrePaid` indicates subscription and `PostPaid` indicates pay-as-you-go.', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'PrePaid', + 'enum' => ['PrePaid', 'PostPaid'], + 'title' => '', + ], + 'Status' => [ + 'description' => 'The status of the resource group. Valid values:'."\n" + ."\n" + .'- `Normal`: Running.'."\n" + ."\n" + .'- `Stop`: Frozen due to expiration.'."\n" + ."\n" + .'- `Deleted`: Released.'."\n" + ."\n" + .'- `Creating`: Creation in progress.'."\n" + ."\n" + .'- `CreateFailed`: Creation failed.'."\n" + ."\n" + .'- `Updating`: Update in progress.'."\n" + ."\n" + .'- `UpdateFailed`: Update failed.'."\n" + ."\n" + .'- `Deleting`: Release in progress.'."\n" + ."\n" + .'- `DeleteFailed`: Release failed.'."\n" + ."\n" + .'- `Timeout`: The operation timed out.'."\n" + ."\n" + .'- `Freezed`: Frozen.'."\n" + ."\n" + .'- `Starting`: Starting.', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'Normal', + 'enum' => ['Normal', 'Stop', 'Deleted', 'Creating', 'CreateFailed', 'Updating', 'UpdateFailed', 'Deleting', 'DeleteFailed', 'Timeout', 'Freezed', 'Starting'], + 'title' => '', + ], + 'Spec' => [ + 'title' => '', + 'description' => 'The specifications of the resource group.', + 'type' => 'object', + 'properties' => [ + 'Standard' => ['description' => 'The resource specifications.', 'type' => 'string', 'example' => '2CU', 'title' => ''], + 'Amount' => ['description' => 'The number of resource units.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + ], + 'example' => '', + ], + 'ResourceGroupType' => [ + 'description' => 'The type of the resource group. Valid values:'."\n" + ."\n" + .'- `CommonV2`: The new general-purpose resource group.'."\n" + ."\n" + .'- `ExclusiveDataIntegration`: The exclusive resource group for data integration.'."\n" + ."\n" + .'- `ExclusiveScheduler`: The exclusive resource group for scheduling.'."\n" + ."\n" + .'- `ExclusiveDataService`: The exclusive resource group for data services.', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'CommonV2', + 'enum' => ['CommonV2', 'ExclusiveDataIntegration', 'ExclusiveScheduler', 'ExclusiveDataService'], + 'title' => '', + ], + 'OrderInstanceId' => ['description' => 'The ID of the order for the resource group.', 'type' => 'string', 'example' => 'c442b330-3b10-4584-959e-736e4edXXXXX', 'title' => ''], + 'CreateUser' => ['description' => 'The user ID of the creator.', 'type' => 'string', 'example' => '11075500042XXXXX', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time of the resource group, as a 64-bit timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1727055811000', 'title' => ''], + 'DefaultVpcId' => ['description' => 'The ID of the default Virtual Private Cloud (VPC) bound to the general-purpose resource group.', 'type' => 'string', 'example' => 'vpc-m2et4f3oc8msfbccXXXXX', 'title' => ''], + 'DefaultVswicthId' => ['description' => 'The ID of the default vSwitch bound to the general-purpose resource group.', 'type' => 'string', 'example' => 'vsw-uf8usrhs7hjd9amsXXXXX', 'title' => ''], + 'AliyunResourceGroupId' => ['description' => 'The Alibaba Cloud resource group ID.', 'type' => 'string', 'example' => 'rg-aek2kqofrgXXXXX', 'title' => ''], + 'AliyunResourceTags' => [ + 'title' => '', + 'description' => 'A list of Alibaba Cloud tags.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => 'An Alibaba Cloud tag.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'Key', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'Value', 'title' => ''], + ], + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'example' => '', + ], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'default' => '100', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + ], + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID. You can use this ID to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"PagingInfo\\": {\\n \\"ResourceGroupList\\": [\\n {\\n \\"Id\\": \\"Serverless_res_group_524257424564736_6831777003XXXXX\\",\\n \\"Name\\": \\"common_resource_group\\",\\n \\"Remark\\": \\"Create a general-purpose resource group for common tasks.\\",\\n \\"PaymentType\\": \\"PrePaid\\",\\n \\"Status\\": \\"Normal\\",\\n \\"Spec\\": {\\n \\"Standard\\": \\"2CU\\",\\n \\"Amount\\": 1\\n },\\n \\"ResourceGroupType\\": \\"CommonV2\\",\\n \\"OrderInstanceId\\": \\"c442b330-3b10-4584-959e-736e4edXXXXX\\",\\n \\"CreateUser\\": \\"11075500042XXXXX\\",\\n \\"CreateTime\\": 1727055811000,\\n \\"DefaultVpcId\\": \\"vpc-m2et4f3oc8msfbccXXXXX\\",\\n \\"DefaultVswicthId\\": \\"vsw-uf8usrhs7hjd9amsXXXXX\\",\\n \\"AliyunResourceGroupId\\": \\"rg-aek2kqofrgXXXXX\\",\\n \\"AliyunResourceTags\\": [\\n {\\n \\"Key\\": \\"Key\\",\\n \\"Value\\": \\"Value\\"\\n }\\n ]\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 100\\n },\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]', + 'title' => 'ListResourceGroups', + 'description' => '1. This operation requires DataWorks Basic Edition or higher.'."\n" + ."\n" + .'2. **Before you call this operation, make sure that you have created the service-linked role AliyunServiceRoleForDataWorks.**', + 'changeSet' => [ + ['createdAt' => '2025-02-21T06:57:06.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-02-10T12:42:36.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2025-01-02T07:14:14.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8754EE08-4AA2-5F77-ADD7-754DBBDA9F75\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'DeleteAlertRule', - ], - 'CreateAlertRule' => [ - 'summary' => 'Creates a custom monitoring alert rule.', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:ListResourceGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'DwResourceGroup', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:dwresourcegroup/*'], + ], + ], + ], ], + 'translator' => 'machine', + ], + 'ListResources' => [ + 'summary' => 'Queries a list of file resources in DataStudio. You can also specify filter conditions to query specific file resources.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '249177', - 'abilityTreeNodes' => [ - 'FEATUREdideRJGWWC', - ], + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235477', + 'abilityTreeNodes' => ['FEATUREdideJ3TPTK'], ], 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the rule.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'xm_create_test', - ], + '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.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10002', 'title' => ''], ], [ 'name' => 'Owner', 'in' => 'query', + 'schema' => ['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.', 'type' => 'string', 'required' => false, 'example' => '110755000425XXXX', 'title' => ''], + ], + [ + 'name' => 'Type', + 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the Alibaba Cloud account used by the owner of the rule.'."\n", + 'description' => 'The resource type. This parameter specifies a filter condition.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- Python'."\n" + ."\n" + .'- Jar'."\n" + ."\n" + .'- Archive'."\n" + ."\n" + .'- File', + 'enumValueTitles' => ['Archive' => 'Archive', 'Jar' => 'Jar', 'File' => 'File', 'Python' => 'Python'], 'type' => 'string', - 'required' => true, - 'example' => '279114181716147735', + 'required' => false, + 'example' => 'Python', + 'title' => '', ], ], [ - 'name' => 'Enabled', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'Indicates whether the rule is enabled.'."\n", - 'type' => 'boolean', - 'required' => true, - 'example' => 'true', - ], + 'schema' => ['description' => 'The name of the file resource. Supports fuzzy search.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'TriggerCondition', + 'name' => 'PageNumber', 'in' => 'query', - 'style' => 'json', + 'schema' => ['description' => 'The page number of the data to retrieve, used for pagination.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '2147483647', 'minimum' => '1', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The page number of the data to retrieve, used for pagination.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '10', 'default' => '10', 'required' => false, 'example' => '10', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The alert triggering condition.'."\n", + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => 'The alert type. Valid values:'."\n" - ."\n" - .'* Finished: An instance is successfully run.'."\n" - .'* UnFinished: An instance does not finish running before a specified point in time.'."\n" - .'* Error: An error occurs on an instance.'."\n" - .'* CycleUnfinished: An instance does not finish running as expected within a specific cycle.'."\n" - .'* Timeout: An instance times out.'."\n" - .'* InstanceTransferComplete: An instance is generated by the auto triggered node.'."\n" - .'* InstanceTransferFluctuate: The number of generated instances fluctuates.'."\n" - .'* ExhaustedError: An error persists after an instance is automatically rerun.'."\n" - .'* InstanceKeyword: An instance with errors contains specified keywords.'."\n" - .'* InstanceErrorCount: The number of instances on which an error occurs reaches a specified threshold.'."\n" - .'* InstanceErrorPercentage: The proportion of instances on which an error occurs in the workspace to the total number of instances reaches a specified threshold.'."\n" - .'* ResourceGroupPercentage: The usage rate of the resource group reaches a specified threshold.'."\n" - .'* ResourceGroupWaitCount: The number of instances that are waiting for resources in the resource group reaches a specified threshold.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Error', - ], - 'Extension' => [ - 'description' => 'The extended information about the rule. This parameter is required for specific types of alerts.'."\n", + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '99EBE7CF-69C0-5089-BE3E-79563C31XXXX', 'title' => ''], + 'PagingInfo' => [ + 'description' => 'The pagination information.', 'type' => 'object', 'properties' => [ - 'Error' => [ - 'description' => 'The configuration for an alert of the Error type.'."\n", - 'type' => 'object', - 'properties' => [ - 'StreamTaskIds' => [ - 'description' => 'The IDs of the real-time computing tasks. This parameter is required when you monitor real-time computing tasks.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the real-time computing task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123', + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '131', 'title' => ''], + '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' => ''], + 'Resources' => [ + 'description' => 'The returned resource list.', + 'type' => 'array', + 'items' => [ + 'description' => 'The elements in the resource list.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The resource name.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'math.py'], + 'ProjectId' => ['description' => 'The ID of the DataWorks workspace. To obtain the workspace ID, log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and navigate to the workspace configuration page.', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '344247'], + 'Owner' => ['description' => 'The owner of the file resource.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '110755000425XXXX'], + 'CreateTime' => ['description' => 'The time when the file resource was created. This value is a UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1724505917000', 'title' => ''], + 'ModifyTime' => ['description' => 'The timestamp when the file resource was last modified.', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '1724505917000'], + 'DataSource' => [ + 'title' => '', + 'description' => 'The data source.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the data source.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'odps_first'], + 'Type' => ['description' => 'The type of the data source.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'odps'], + ], + 'deprecated' => false, + 'example' => '', ], - 'required' => false, - ], - 'AutoRerunAlertEnabled' => [ - 'description' => 'Specifies whether to trigger an alert if a batch synchronization task is automatically rerun upon a failure.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - 'required' => false, - ], - 'Timeout' => [ - 'description' => 'The configuration for an alert of the Timeout type.'."\n", - 'type' => 'object', - 'properties' => [ - 'TimeoutInMinutes' => [ - 'description' => 'The timeout period. Unit: minutes. Valid values: \\[1, 21600].'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - 'required' => false, - ], - 'UnFinished' => [ - 'description' => 'The configuration for an alert of the UnFinished type.'."\n", - 'type' => 'object', - 'properties' => [ - 'UnFinishedTime' => [ - 'description' => 'The latest completion time of the instance. The period is in the hh:mm format. Valid values of hh: \\[0,47]. Valid values of mm: \\[0,59].'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '30:00', - ], - ], - 'required' => false, - ], - 'CycleUnfinished' => [ - 'description' => 'The configuration for an alert of the CycleUnfinished type.'."\n", - 'type' => 'object', - 'properties' => [ - 'CycleAndTime' => [ - 'description' => 'The configurations of the scheduling cycle and timeout period of the instance.'."\n", - 'type' => 'array', - 'items' => [ + 'Script' => [ + 'title' => '', + 'description' => 'The script information.', 'type' => 'object', 'properties' => [ - 'CycleId' => [ - 'description' => 'The ID of the scheduling cycle of the instance. Valid values: \\[1,288].'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'Time' => [ - 'description' => 'The latest completion time of the instance within the scheduling cycle. The time is in the hh:mm format. Valid values of hh: \\[0,47]. Valid values of mm: \\[0,59].'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '12:00', + 'Path' => ['description' => 'The script path.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'root/demo'], + 'Runtime' => [ + 'title' => '', + 'description' => 'Runtime', + 'type' => 'object', + 'properties' => [ + 'Command' => ['description' => 'Command. This parameter indicates the file type.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'ODPS_PYTHON'], + ], + 'deprecated' => false, + 'example' => '', ], + 'Id' => ['description' => 'The ID of the script.'."\n" + ."\n" + .'> This field is of type Long in SDK versions prior to 8.0.0, and of type String in SDK version 8.0.0 and later. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.', 'type' => 'string', 'deprecated' => false, 'example' => '123348864897630XXXX', 'title' => ''], ], + 'deprecated' => false, 'required' => false, - 'description' => '', + 'example' => '', ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'InstanceErrorCount' => [ - 'description' => 'The configuration for an alert of the InstanceErrorCount type.'."\n", - 'type' => 'object', - 'properties' => [ - 'Count' => [ - 'description' => 'The maximum number of instances on which an error occurs. Valid values: \\[1,10000].'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '5', - ], - ], - 'required' => false, - ], - 'InstanceErrorPercentage' => [ - 'description' => 'The configuration for an alert of the InstanceErrorPercentage type.'."\n", - 'type' => 'object', - 'properties' => [ - 'Percentage' => [ - 'description' => 'The maximum percentage of instances on which an error occurs in the workspace to the total number of instances. Valid values: \\[1-100].'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '5', - ], - ], - 'required' => false, - ], - 'InstanceTransferFluctuate' => [ - 'description' => 'The configuration for an alert of the InstanceTransferFluctuate type.'."\n", - 'type' => 'object', - 'properties' => [ - 'Trend' => [ - 'description' => 'The way in which the number of auto triggered node instances that are generated in your workspace fluctuates. Valid values:'."\n" + 'Type' => [ + 'description' => 'The resource type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- Python'."\n" + ."\n" + .'- Jar'."\n" + ."\n" + .'- Archive'."\n" + ."\n" + .'- File', + 'enumValueTitles' => ['Archive' => 'Archive', 'Jar' => 'Jar', 'File' => 'File', 'Python' => 'Python'], + 'type' => 'string', + 'deprecated' => false, + 'pattern' => '', + 'default' => '', + 'enum' => ['jar', 'python', 'file', 'archive'], + 'title' => '', + 'example' => 'Jar', + ], + 'SourceType' => [ + 'description' => 'The source storage type of the file resource.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- Local'."\n" + ."\n" + .'- OSS', + 'enumValueTitles' => ['Local' => 'Local', 'Oss' => 'Oss'], + 'type' => 'string', + 'deprecated' => false, + 'pattern' => '', + 'default' => '', + 'enum' => ['local', 'oss'], + 'title' => '', + 'example' => 'Local', + ], + 'SourcePath' => ['description' => 'Source path of the file resource. This parameter is empty if the type is Local.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'XXX/unknown/ide/1/XXX/20240820200851_963a9da676de44ef8d06a6576a8c4d6a.py'], + 'TargetType' => [ + 'description' => 'The destination storage type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- Gateway'."\n" + ."\n" + .'- OSS'."\n" + ."\n" + .'- HDFS', + 'enumValueTitles' => ['Gateway' => 'Gateway', 'Hdfs' => 'Hdfs', 'Oss' => 'Oss'], + 'type' => 'string', + 'deprecated' => false, + 'pattern' => '', + 'default' => '', + 'enum' => ['gateway', 'oss', 'hdfs'], + 'title' => '', + 'example' => 'Oss', + ], + 'TargetPath' => ['description' => 'The destination storage path.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'XXX/unknown/ide/1/XXX/20240820200851_963a9da676de44ef8d06a6576a8c4d6a.py'], + 'Id' => ['description' => 'The unique identifier of the file resource.'."\n" ."\n" - .'* abs: the absolute value. The number of instances increases or decreases.'."\n" - .'* increase: The number of instances increases.'."\n" - .'* decrease: The number of instances decreases.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abs', - ], - 'Percentage' => [ - 'description' => 'The maximum percentage of fluctuation in the number of auto triggered node instances that are generated in your workspace. Valid values: \\[1-100].'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'Target' => [ - 'description' => 'The monitored objects.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the monitored objects. Valid values:'."\n" - ."\n" - .'* Task: node'."\n" - .'* Baseline: baseline'."\n" - .'* Project: workspace'."\n" - .'* BizProcess: workflow'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Task', - ], - 'Ids' => [ - 'description' => 'The IDs of monitored objects.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the monitored object.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123123', - ], - 'required' => false, - ], - 'AllowTasks' => [ - 'description' => 'The nodes that are not to be monitored.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the node that is not to be monitored.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123', - ], - 'required' => false, - ], - ], - 'required' => false, - ], - ], - 'required' => true, - ], - ], - [ - 'name' => 'Notification', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The configuration for the alert notification.'."\n", - 'type' => 'object', - 'properties' => [ - 'SilenceStartTime' => [ - 'description' => 'The start time for silence. The time is in the HH:mm format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '00:00:00'."\n", - ], - 'SilenceEndTime' => [ - 'description' => 'The end time for silence. The time is in the HH:mm format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '00:00:00'."\n", - ], - 'IntervalInMinutes' => [ - 'description' => 'The interval at which an alert notification is sent. Unit: minutes. Valid values: \\[5,10000].'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], - 'Maximum' => [ - 'description' => 'The maximum number of times an alert notification can be sent within a calendar day. Valid values: \\[1, 10000].'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], - 'Channels' => [ - 'description' => 'The alert notification channels.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The alert notification channel. Valid values:'."\n" - ."\n" - .'* Mail'."\n" - .'* Phone'."\n" - .'* Sms: text message'."\n" - .'* Dingding: DingTalk'."\n" - .'* Feishu: Lark'."\n" - .'* Weixin: WeCom'."\n" - .'* Webhook: custom webhook'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Sms', - ], - 'required' => true, - ], - 'Receivers' => [ - 'description' => 'The alert recipients.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ReceiverType' => [ - 'description' => 'The type of the alert recipient. Valid valves:'."\n" - ."\n" - .'* AliUid: Alibaba Cloud account ID.'."\n" - .'* Shift Schedules: the personnel in a shift schedule.'."\n" - .'* TaskOwner: the task owner. The task owner can receive custom alerts and event alerts.'."\n" - .'* Owner: the baseline owner. The baseline owner can receive baseline alerts.'."\n" - .'* WebhookUrl: URL of a custom webhook.'."\n" - .'* DingdingUrl: DingTalk webhook URL.'."\n" - .'* FeishuUrl: Lark webhook URL.'."\n" - .'* WeixinUrl: WeCom webhook URL.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TaskOwner', - ], - 'ReceiverValues' => [ - 'description' => 'The ID of the alert recipient.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the alert recipient. If the ReceiverType parameter is set to AliUid, set this parameter to an Alibaba Cloud account ID. If the ReceiverType parameter is set to ShiftSchedule, set this parameter to a shift schedule ID. If the ReceiverType parameter is set to WebhookUrl, DingdingUrl, FeishuUrl, or WeixinUrl, set this parameter to a corresponding URL.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123123123', + .'> Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.', 'type' => 'string', 'example' => '631478864897630XXXX', 'title' => ''], ], - 'required' => false, - ], - 'Extension' => [ - 'description' => 'The additional configuration of the alert recipient. If the ReceiverType parameter is set to DingdingUrl, you can set this parameter to {"atAll":true} to remind all members in a DingTalk group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"atAll":true}'."\n", + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'required' => false, - 'description' => '', ], - 'required' => true, + 'title' => '', + 'example' => '', ], ], - 'required' => false, + 'example' => '', ], ], ], - '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' => 'A6C6B486-E3A2-5D52-9E76-D9380485D946'."\n", - ], - 'Id' => [ - 'description' => 'The rule ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123123', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"99EBE7CF-69C0-5089-BE3E-79563C31XXXX\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 131,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Resources\\": [\\n {\\n \\"Name\\": \\"math.py\\",\\n \\"ProjectId\\": 344247,\\n \\"Owner\\": \\"110755000425XXXX\\",\\n \\"CreateTime\\": 1724505917000,\\n \\"ModifyTime\\": 1724505917000,\\n \\"DataSource\\": {\\n \\"Name\\": \\"odps_first\\",\\n \\"Type\\": \\"odps\\"\\n },\\n \\"Script\\": {\\n \\"Path\\": \\"root/demo\\",\\n \\"Runtime\\": {\\n \\"Command\\": \\"ODPS_PYTHON\\"\\n },\\n \\"Id\\": \\"123348864897630XXXX\\"\\n },\\n \\"Type\\": \\"Jar\\",\\n \\"SourceType\\": \\"Local\\",\\n \\"SourcePath\\": \\"XXX/unknown/ide/1/XXX/20240820200851_963a9da676de44ef8d06a6576a8c4d6a.py\\",\\n \\"TargetType\\": \\"Oss\\",\\n \\"TargetPath\\": \\"XXX/unknown/ide/1/XXX/20240820200851_963a9da676de44ef8d06a6576a8c4d6a.py\\",\\n \\"Id\\": \\"631478864897630XXXX\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListResources', + 'changeSet' => [ + ['createdAt' => '2025-01-13T07:36:04.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A6C6B486-E3A2-5D52-9E76-D9380485D946\\\\n\\",\\n \\"Id\\": 123123\\n}","type":"json"}]', - 'title' => 'CreateAlertRule', ], - 'DeleteTask' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'ListRoutes' => [ + 'summary' => 'Retrieves a list of routes for a network resource.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '247745', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - ], + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '245173', + 'abilityTreeNodes' => ['FEATUREdide2SV6DS'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The task ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234', - ], + 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => true, 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX', 'title' => ''], ], [ - 'name' => 'ProjectEnv', + 'name' => 'NetworkId', 'in' => 'query', - 'schema' => [ - 'description' => 'The environment of the workspace.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Prod: production environment'."\n" - .'* Dev: development environment'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Prod' => '', - 'Dev' => '', - ], - 'example' => 'Prod', - 'default' => 'Prod', - 'enum' => [ - 'Prod', - 'Dev', - ], - ], + 'schema' => ['description' => 'The network ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'default' => '100', 'title' => '', 'required' => false], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1', 'title' => '', 'required' => false], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => ['description' => 'The fields used for sorting. Fields such as TriggerTime and StartedTime are supported. The value of this parameter is in the Sort field + Sort by (Desc/Asc) format. By default, results are sorted in ascending order. Valid values:'."\n" + ."\n" + .'- Id (Desc/Asc): the route ID'."\n" + ."\n" + .'- DestinationCidr (Desc/Asc): the destination CIDR block of the route'."\n" + ."\n" + .'- CreateTime (Desc/Asc): the time when the route is created'."\n" + ."\n" + .'Default value: CreateTime Asc.', 'type' => 'string', 'example' => 'CreateTime Asc', 'default' => 'CreateTime Asc', 'title' => '', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n", - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'example' => 'true'], + 'PagingInfo' => [ + 'title' => '', + 'description' => 'The pagination information.', + 'type' => 'object', + 'properties' => [ + 'RouteList' => [ + 'title' => '', + 'description' => 'The routes of the network resource.', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The route ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''], + 'ResourceGroupId' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'example' => 'Serverless_res_group_524257424564736_6831777003****', 'title' => ''], + 'ResourceId' => ['description' => 'The ID of the network resource.', 'type' => 'string', 'example' => 'ns-679XXXXXX', 'title' => ''], + 'DestinationCidr' => ['description' => 'The destination CIDR block of the route.', 'type' => 'string', 'example' => '192.168.0.0/16', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time, which is a 64-bit timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1727055811000', 'title' => ''], + 'NetworkId' => ['description' => 'The network resource ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''], + ], + 'example' => '', + ], + 'example' => '', + ], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'default' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'default' => '100', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + ], + 'example' => '', ], + 'RequestId' => ['description' => 'The ID of the request. It is used to locate logs and troubleshoot problems.', 'type' => 'string', 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', 'title' => ''], ], - 'description' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\\\n\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'DeleteTask', - 'summary' => 'Deletes a task.', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", - ], - 'UpdateTask' => [ - 'summary' => 'Update a task. The changes are synchronized to Data Studio, which creates a new saved version.', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"PagingInfo\\": {\\n \\"RouteList\\": [\\n {\\n \\"Id\\": 1000,\\n \\"ResourceGroupId\\": \\"Serverless_res_group_524257424564736_6831777003****\\",\\n \\"ResourceId\\": \\"ns-679XXXXXX\\",\\n \\"DestinationCidr\\": \\"192.168.0.0/16\\",\\n \\"CreateTime\\": 1727055811000,\\n \\"NetworkId\\": 1000\\n }\\n ],\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 100,\\n \\"TotalCount\\": 100\\n },\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]', + 'title' => 'ListRoutes', + 'description' => 'This API operation is available for all DataWorks editions.', + 'changeSet' => [ + ['createdAt' => '2025-01-23T11:24:23.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-01-02T07:14:14.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'ListSchemas' => [ + 'summary' => 'Queries the list of schemas under a specified database or MaxCompute project in Data Map. Currently supports MaxCompute and Holo types.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'list', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '247744', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - 'FEATUREdideD0YY7B', - 'FEATUREdideVFMENL', - ], + 'abilityTreeCode' => '267987', + 'abilityTreeNodes' => ['FEATUREdideE9XYA6'], ], 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The task ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234', - ], - ], - [ - 'name' => 'ClientUniqueCode', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The unique code of the client. This code uniquely identifies a task. This parameter is used to create a task asynchronously and implement the idempotence of the task. If you do not specify this parameter when you create the task, the system automatically generates a unique code. The unique code is uniquely associated with the task ID. If you specify this parameter when you update or delete the task, the value of this parameter must be the unique code that is used to create the task.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Task_0bc5213917368545132902xxxxxxxx', - ], - ], - [ - 'name' => 'EnvType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The project environment.'."\n" - ."\n" - .'* Prod'."\n" - .'* Dev'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Prod', - 'default' => 'Prod', - 'enum' => [ - 'Prod', - 'Dev', - ], - ], + 'name' => 'ParentMetaEntityId', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The parent entity ID. For more information, see [Concepts related to metadata entities](~~2880092~~). For the Hologres metadata crawler type, you can call the ListDatabases operation to query the settings of the `ParentMetaEntityId` parameter.'."\n" + ."\n" + .'Configure the `ParentMetaEntityId` parameter in the `${EntityType}:${Instance ID or escaped URL}:${Catalog identifier}:${Database name}` format. If a level does not exist, leave the level empty.'."\n" + ."\n" + .'> If you want to query the information about a MaxCompute schema, specify an empty string at the Instance ID level as a placeholder and a MaxCompute project name at the Database name level. Make sure that the schema feature is enabled for the MaxCompute project.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'maxcompute-project:::project_name'], ], [ 'name' => 'Name', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SQL node', - ], + 'in' => 'query', + 'schema' => ['description' => 'The name. Fuzzy match is supported.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'abc'], ], [ - 'name' => 'Description', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The description of the task.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'name' => 'Comment', + 'in' => 'query', + 'schema' => ['description' => 'The comment. Fuzzy match is supported.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'test comment'], ], [ - 'name' => 'Owner', - 'in' => 'formData', + 'name' => 'Types', + 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => 'The account ID of the task owner.'."\n", - 'type' => 'string', + 'title' => '', + 'description' => 'The types. Exact match is supported. If this parameter is left empty, all types are queried.', + 'type' => 'array', + 'items' => ['description' => 'The schema type.', 'type' => 'string', 'required' => false, 'example' => 'MANAGED', 'title' => ''], 'required' => false, - 'example' => '1000', + 'example' => '', ], ], [ - 'name' => 'InstanceMode', - 'in' => 'formData', + 'name' => 'SortBy', + 'in' => 'query', 'schema' => [ - 'description' => 'The instance generation mode.'."\n" + 'description' => 'The field used for sorting. Default value: CreateTime. Valid values:'."\n" ."\n" - .'* T+1: the next day'."\n" - .'* Immediately Note: Scheduled instances are generated only if the scheduled time is at least 10 minutes after the publish time. Real-time instance generation is unavailable during the global instance generation period (23:30 to 24:00). You can publish nodes during this period, but instances for the new nodes will not be generated automatically.'."\n", - 'type' => 'string', - 'required' => false, + .'- CreateTime'."\n" + ."\n" + .'- ModifyTime'."\n" + ."\n" + .'- Name'."\n" + ."\n" + .'- Type', 'enumValueTitles' => [], - 'example' => 'T+1', - 'default' => 'T+1', - 'enum' => [ - 'T+1', - 'Immediately', - ], - ], - ], - [ - 'name' => 'Timeout', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Task execution timeout in seconds. Must be greater than 3600.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'type' => 'string', + 'example' => 'CreateTime', + 'pattern' => '^[\\w.,;/@-]+$', + 'default' => 'CreateTime', + 'enum' => ['CreateTime', 'ModifyTime', 'Name', 'Type'], + 'title' => '', 'required' => false, - 'example' => '3600', ], ], [ - 'name' => 'RerunMode', - 'in' => 'formData', + 'name' => 'Order', + 'in' => 'query', 'schema' => [ - 'description' => 'The rerun mode. Valid values:'."\n" + 'description' => 'The order in which schemas are sorted. Default value: Asc. Valid values:'."\n" ."\n" - .'* AllDenied: The task cannot be rerun.'."\n" - .'* FailureAllowed: The task can be rerun only after it fails.'."\n" - .'* AllAllowed: The task can always be rerun.'."\n", - 'type' => 'string', - 'required' => false, + .'- Asc: ascending order'."\n" + ."\n" + .'- Desc: descending order', 'enumValueTitles' => [], - 'example' => 'AllAllowed', - 'enum' => [ - 'AllAllowed', - 'FailureAllowed', - 'AllDenied', - ], - ], - ], - [ - 'name' => 'RerunTimes', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of times that the task is rerun. This parameter takes effect only if the RerunMode parameter is set to AllAllowed or FailureAllowed.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'type' => 'string', 'required' => false, - 'example' => '3', + 'example' => 'Asc', + 'default' => 'Asc', + 'enum' => ['Asc', 'Desc'], + 'title' => '', ], ], [ - 'name' => 'RerunInterval', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The rerun interval. Unit: milliseconds. Must not exceed 1800000.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '60', - ], + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '1', 'default' => '1', 'title' => '', 'required' => false, 'example' => '1'], ], [ - 'name' => 'Script', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The run script information.'."\n", - 'type' => 'object', - 'properties' => [ - 'Content' => [ - 'description' => 'The script content.'."\n", - 'type' => 'string', - 'deprecated' => true, - 'required' => false, - 'example' => 'echo "helloWorld"', - ], - 'Parameters' => [ - 'description' => 'The script parameter list.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'para1=$bizdate', - ], - ], - 'required' => false, - ], + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 10. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10', 'title' => '', 'required' => false], ], - [ - 'name' => 'Trigger', - 'in' => 'formData', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The triggering method.'."\n", + 'title' => 'Schema of Response', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'title' => '`Scheduler` 周期触发', - 'description' => 'The triggering type. Valid values:'."\n" - ."\n" - .'* Scheduler: periodically triggered'."\n" - .'* Manual'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Scheduler', - 'enum' => [ - 'Scheduler', - 'Manual', - ], - ], - 'Recurrence' => [ - 'description' => 'The running mode of the task after it is triggered. This parameter takes effect only if the Type parameter is set to Scheduler. Valid values:'."\n" - ."\n" - .'* Pause'."\n" - .'* Skip'."\n" - .'* Normal'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Normal', - 'enum' => [ - 'Normal', - 'Skip', - 'Pause', - ], - ], - 'Cron' => [ - 'description' => 'The Cron expression. This parameter takes effect only if the Type parameter is set to Scheduler.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '00 00 00 * * ?', - ], - 'StartTime' => [ - 'description' => 'The time when periodic triggering takes effect. This parameter takes effect only if the Type parameter is set to Scheduler. The value of this parameter is in the`yyyy-mm-dd hh:mm:ss` format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1970-01-01 00:00:00', - ], - 'EndTime' => [ - 'description' => 'The expiration time of periodic triggering. Takes effect only when type is set to Scheduler. The value of this parameter is in the`yyyy-mm-dd hh:mm:ss` format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '9999-01-01 00:00:00', - ], - 'CycleType' => [ - 'description' => 'Cycle type. This parameter takes effect only when Type is set to Scheduler and the cron expression specifies hourly scheduling. Default value: Daily'."\n" - ."\n" - .'* Daily: Schedules jobs on a daily basis.'."\n" - .'* NotDaily: Schedules jobs on an hourly basis.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Daily', - 'enum' => [ - 'Daily', - 'NotDaily', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '235BBA5E-3428-XXXXXX'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'PagingInfo' => [ + 'description' => 'The pagination information.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['description' => 'Total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'PageNumber' => ['description' => 'Page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'Schemas' => [ + 'description' => 'The schemas.', + 'type' => 'array', + 'items' => ['description' => 'The schema.', '$ref' => '#/components/schemas/Schema', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', + ], ], + 'title' => '', + 'example' => '', ], ], - 'required' => false, + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"235BBA5E-3428-XXXXXX\\",\\n \\"Success\\": true,\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 1,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Schemas\\": [\\n {\\n \\"Id\\": \\"maxcompute-schema:123456XXX::test_project:default\\\\nholo-schema:h-abc123xxx::test_db:test_schema\\",\\n \\"Name\\": \\"test_db\\",\\n \\"Comment\\": \\"test comment\\",\\n \\"Type\\": \\"MANAGED\\",\\n \\"ParentMetaEntityId\\": \\"maxcompute-project:123456XXX::test_project\\\\nholo-database:h-abc123xxx::test_db\\",\\n \\"CreateTime\\": 1736852168000,\\n \\"ModifyTime\\": 1736852168000\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Query the list of database schemas in Data Map', + 'description' => '1. You must purchase DataWorks Basic Edition or higher to use this feature.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'RuntimeResource', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'Runtime environment configurations, such as resource group information.'."\n", - 'type' => 'object', - 'properties' => [ - 'ResourceGroupId' => [ - 'description' => 'The identifier of the scheduling resource group used in the task runtime configuration.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', - ], - 'Image' => [ - 'description' => 'The image ID used in the task runtime configuration.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'i-xxxxxx', - ], - 'Cu' => [ - 'description' => 'The default number of compute units (CUs) configured for task running.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0.25', - ], + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:ListSchemas', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'required' => false, ], ], + ], + ], + 'ListSecurityStrategies' => [ + 'summary' => 'Retrieves a paginated list of security policies based on specified conditions. This operation requires DataWorks tenant administrator or security administrator permissions.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'DataSource', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The information about the associated data source.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the data source.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'odps_test', - ], - ], - 'required' => false, - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => 'TBD', + 'abilityTreeNodes' => ['FEATUREdideYTM537'], + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ [ - 'name' => 'Inputs', + 'name' => 'ControlModule', 'in' => 'formData', - 'style' => 'json', 'schema' => [ - 'description' => 'The input information.'."\n", - 'type' => 'object', - 'properties' => [ - 'Variables' => [ - 'description' => 'The variables.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '类型', - 'description' => 'The type. Valid values:'."\n" - ."\n" - .'* Constant: constant value.'."\n" - .'* PassThrough: node output.'."\n" - .'* System: variable.'."\n" - .'* NodeOutput: script output.'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [], - 'example' => 'Constant', - 'enum' => [ - 'System', - 'Constant', - 'NodeOutput', - 'PassThrough', - ], - ], - 'Value' => [ - 'description' => 'The value of the variable.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'value1', - ], - 'Name' => [ - 'description' => 'The name of the variable.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'key1', - ], - ], - 'required' => false, - 'description' => '', - ], - 'required' => false, - ], - ], + 'description' => '**The control module.**', + 'type' => 'string', + 'default' => 'DataStudio', + 'enum' => ['DataQuery', 'DataStudio'], 'required' => false, + 'example' => 'DataQuery', + 'title' => '', ], ], [ - 'name' => 'Outputs', + 'name' => 'ControlSubModule', 'in' => 'formData', - 'style' => 'json', 'schema' => [ - 'description' => 'The output information.'."\n", - 'type' => 'object', - 'properties' => [ - 'TaskOutputs' => [ - 'description' => 'The task outputs.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Output' => [ - 'title' => '输出标识符，示例：pre.odps_sql_demo_0', - 'description' => 'The identifier of the output.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'pre.odps_sql_demo_0', - ], - ], - 'required' => false, - 'description' => '', - ], - 'required' => false, - ], - 'Variables' => [ - 'description' => 'The variables.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '类型', - 'description' => 'The type. Valid values:'."\n" - ."\n" - .'* Constant: constant value.'."\n" - .'* PassThrough: node output.'."\n" - .'* System: variable.'."\n" - .'* NodeOutput: script output.'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [], - 'example' => 'Constant', - 'enum' => [ - 'System', - 'Constant', - 'NodeOutput', - 'PassThrough', - ], - ], - 'Value' => [ - 'description' => 'The value of the variable.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'value1', - ], - 'Name' => [ - 'description' => 'The name of the variable.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'key1', - ], - ], - 'required' => false, - 'description' => '', - ], - 'required' => false, - ], - ], + 'description' => '**The control submodule.**', + 'type' => 'string', + 'enum' => ['MyCatalog'], 'required' => false, + 'example' => 'MyCatalog', + 'title' => '', ], ], [ - 'name' => 'Dependencies', + 'name' => 'PageNumber', 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The dependency information.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '依赖类型', - 'description' => 'The dependency type. Valid values:'."\n" - ."\n" - .'* CrossCycleDependsOnChildren: Depends on level-1 downstream nodes across cycles'."\n" - .'* CrossCycleDependsOnSelf: Depends on itself across cycles.'."\n" - .'* CrossCycleDependsOnOtherNode: Depends on other nodes across cycles.'."\n" - .'* Normal: Depends on nodes in the same cycle.'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [], - 'example' => 'Normal', - 'enum' => [ - 'Normal', - 'CrossCycleDependsOnSelf', - 'CrossCycleDependsOnChildren', - 'CrossCycleDependsOnOtherNode', - ], - ], - 'UpstreamOutput' => [ - 'title' => '依赖任务的输出标识符,或者任务ID', - 'description' => 'The output identifier of the upstream task. (This parameter is returned only if `Normal` is set and the node input is configured.)'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'pre.odps_sql_demo_0', - ], - 'UpstreamTaskId' => [ - 'description' => 'The ID of the upstream task. (This parameter is returned only if `Normal` or `CrossCycleDependsOnOtherNode` is set and the node input is not configured.)'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1234', - ], - ], - 'required' => false, - 'description' => '', - ], - 'required' => false, - ], + 'schema' => ['description' => 'The page number. Starts from 1. Default: 1.', 'type' => 'integer', 'format' => 'int32', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Tags', + 'name' => 'PageSize', 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The tags.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Value' => [ - 'description' => 'The value of a tag.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'value1', - ], - 'Key' => [ - 'description' => 'The key of a tag.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'key1', - ], - ], - 'required' => false, - 'description' => '', - ], - 'required' => false, - ], + 'schema' => ['description' => 'The number of entries per page. Default: 20.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'default' => '20', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ @@ -37337,271 +40201,249 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - 'description' => '', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'UpdateTask', - ], - 'BatchUpdateTasks' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '250636', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - 'FEATUREdideD0YY7B', - 'FEATUREdideVFMENL', - ], - ], - 'parameters' => [ - [ - 'name' => 'Tasks', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The list of tasks.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The task ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234', - ], - 'EnvType' => [ - 'description' => 'The project environment.'."\n" - ."\n" - .'* Prod: Production'."\n" - .'* Dev: Development'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Prod', - 'default' => 'Prod', - 'enum' => [ - 'Prod', - 'Dev', - ], - ], - 'Name' => [ - 'description' => 'The name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SQL node', - ], - 'Description' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'Owner' => [ - 'description' => 'The account ID of the task owner.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1000', - ], - 'Timeout' => [ - 'description' => 'The task execution timeout in seconds. The value should be greater than 3600.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3600', - ], - 'RerunMode' => [ - 'description' => 'The rerun mode. Valid values:'."\n" - ."\n" - .'* AllDenied: The task cannot be rerun.'."\n" - .'* FailureAllowed: The task can be rerun only after it fails.'."\n" - .'* AllAllowed: The task can always be rerun.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'AllAllowed', - 'enum' => [ - 'AllAllowed', - 'FailureAllowed', - 'AllDenied', - ], - ], - 'RerunTimes' => [ - 'description' => 'The number of retry attempts. Takes effect when the task is configured to allow reruns.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], - 'RerunInterval' => [ - 'description' => 'The retry interval in seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '60', - ], - 'Trigger' => [ - 'description' => 'The task trigger configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The trigger type. Valid values:'."\n" - ."\n" - .'* Scheduler: periodically triggered'."\n" - .'* Manual'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Scheduler', - 'enum' => [ - 'Scheduler', - 'Manual', - ], - ], - 'Recurrence' => [ - 'description' => 'The running mode of the task after it is triggered. This parameter takes effect only if the Type parameter is set to Scheduler. Valid values:'."\n" - ."\n" - .'* Pause'."\n" - .'* Skip'."\n" - .'* Normal'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Normal', - 'enum' => [ - 'Normal', - 'Skip', - 'Pause', - ], - ], - 'Cron' => [ - 'description' => 'The cron expression. Takes effect when type=Scheduler.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '00 00 00 * * ?', - ], - 'StartTime' => [ - 'description' => 'The time when periodic triggering takes effect. This parameter takes effect only if the Type parameter is set to Scheduler. The value of this parameter is in the `yyyy-mm-dd hh:mm:ss` format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1970-01-01 00:00:00', - ], - 'EndTime' => [ - 'description' => 'The expiration time of periodic triggering. Takes effect only when type is set to Scheduler. The value of this parameter is in the`yyyy-mm-dd hh:mm:ss` format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '9999-01-01 00:00:00', - ], - ], - 'required' => false, - ], - 'RuntimeResource' => [ - 'description' => 'Runtime environment configurations, such as resource group information.'."\n", - 'type' => 'object', - 'properties' => [ - 'ResourceGroupId' => [ - 'description' => 'The identifier of the scheduling resource group used in the task runtime configuration.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', - ], - 'Image' => [ - 'description' => 'The image ID used in the task runtime configuration.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'i-xxxxxx', - ], - 'Cu' => [ - 'description' => 'The default number of compute units (CUs) configured for task running.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0.25', - ], - ], - 'required' => false, - ], - 'DataSource' => [ - 'description' => 'Associated data source information.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The data source name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'odps_test', - ], - ], - 'required' => false, - ], - 'Tags' => [ - 'description' => 'The list of task tags.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'key1', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'value1', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '0bc5df3a17****903790e8e8a'], + 'PagingInfo' => [ + 'type' => 'object', + 'properties' => [ + 'PageNumber' => ['description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The page size. Default value: 20.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total count.', 'type' => 'integer', 'format' => 'int32', 'example' => '12', 'title' => ''], + 'SecurityStrategies' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The policy ID.', 'type' => 'string', 'example' => '12345', 'title' => ''], + 'Name' => ['description' => 'The policy name.', 'type' => 'string', 'example' => '默认数据分析策略', 'title' => ''], + 'Description' => ['description' => 'The policy description.', 'type' => 'string', 'example' => '控制数据分析模块的查询结果安全行为', 'title' => ''], + 'SchemaName' => [ + 'description' => 'The name of the schema template.', + 'enumValueTitles' => ['DataStudioMyCatalogSecurityStrategySchema' => 'DataStudioMyCatalogSecurityStrategySchema', 'DataQuerySecurityStrategySchema' => 'DataQuerySecurityStrategySchema', 'DataStudioSecurityStrategySchema' => 'DataStudioSecurityStrategySchema'], + 'type' => 'string', + 'enum' => ['DataQuerySecurityStrategySchema', 'DataStudioSecurityStrategySchema', 'DataStudioMyCatalogSecurityStrategySchema'], + 'example' => 'DataQuerySecurityStrategySchema', + 'title' => '', + ], + 'ControlModule' => [ + 'description' => 'The control module.', + 'type' => 'string', + 'enum' => ['DataQuery', 'DataStudio'], + 'example' => 'DataQuery', + 'title' => '', + ], + 'ControlSubModule' => [ + 'description' => 'The control submodule.', + 'type' => 'string', + 'enum' => ['MyCatalog'], + 'example' => 'MyCatalog', + 'title' => '', + ], + 'ControlDwScope' => [ + 'description' => 'The control scope. Valid values: `Workspace` and `Tenant`.', + 'type' => 'string', + 'enum' => ['Tenant', 'Workspace'], + 'example' => 'Tenant', + 'title' => '', + ], + 'Workspaces' => [ + 'type' => 'array', + 'items' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '343434', 'title' => ''], + 'description' => 'The associated workspace IDs.', + 'title' => '', + 'example' => '', + ], + 'Enabled' => ['description' => 'Whether the policy is enabled.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'OriginPolicyId' => ['description' => 'The source ID of the system default policy.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''], + 'Creator' => ['description' => 'The user ID of the creator.', 'type' => 'string', 'example' => '203322746501002787', 'title' => ''], + 'Updater' => ['description' => 'The ID of the user who last updated the policy.', 'type' => 'string', 'example' => '203322746501002787', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2026-05-25T20:46:19', 'title' => ''], + 'UpdateTime' => ['description' => 'The time of the last update.', 'type' => 'string', 'example' => '2026-05-25T20:46:19', 'title' => ''], + 'Content' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The `name` of the associated `SecurityStrategySchema`.', + 'type' => 'string', + 'enum' => ['DataQuerySecurityStrategySchema', 'DataStudioSecurityStrategySchema', 'DataStudioMyCatalogSecurityStrategySchema'], + 'example' => 'DataQuerySecurityStrategySchema', + 'title' => '', + ], + 'DisplayName' => ['description' => 'The `displayName` of the associated `SecurityStrategySchema`.', 'type' => 'string', 'example' => '数据分析', 'title' => ''], + 'DisplayNameEn' => ['description' => 'The `displayNameEn` of the associated `SecurityStrategySchema`.', 'type' => 'string', 'example' => 'Data Query', 'title' => ''], + 'ControlModule' => [ + 'description' => 'The control module. This value is from the `controlModule` property of the associated `SecurityStrategySchema`.', + 'type' => 'string', + 'enum' => ['DataQuery', 'DataStudio'], + 'example' => 'DataQuery', + 'title' => '', + ], + 'ControlSubModule' => [ + 'description' => 'The control submodule. This value is from the `controlSubModule` property of the associated `SecurityStrategySchema`.', + 'type' => 'string', + 'enum' => ['MyCatalog'], + 'example' => 'MyCatalog', + 'title' => '', + ], + 'ControlDwScope' => [ + 'description' => 'The control scope.', + 'enumValueTitles' => ['Tenant' => 'Tenant', 'Workspace' => 'Workspace'], + 'type' => 'string', + 'enum' => ['Tenant', 'Workspace'], + 'example' => 'Tenant', + 'title' => '', + ], + 'SystemPolicyName' => ['description' => 'The name of the system policy. If this property is not empty, the system automatically creates a default policy.', 'type' => 'string', 'example' => 'SYSTEM_GENERATE_DEFAULT_DATA_QUERY', 'title' => ''], + 'SystemPolicyDisplayName' => ['description' => 'The display name of the system policy.', 'type' => 'string', 'example' => 'Default system generate data query policy', 'title' => ''], + 'Controllers' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Controller' => ['description' => 'The identifier of the control item. For valid values, see the list of control items for each schema.', 'type' => 'string', 'example' => 'viewCount', 'title' => ''], + 'DisplayName' => ['description' => 'The display name.', 'type' => 'string', 'example' => '查询结果-单次展示记录值上限', 'title' => ''], + 'DisplayNameEn' => ['description' => 'The display name in English.', 'type' => 'string', 'example' => 'Query Results - Single Display Record Limit', 'title' => ''], + 'Enable' => ['description' => 'Whether the control item is enabled.', 'type' => 'boolean', 'title' => '', 'example' => ''], + 'ControllerValueType' => ['description' => 'The data type of the value. Valid values: `Boolean`, `Integer`, `Long`, and `String`.', 'type' => 'string', 'example' => 'Integer', 'title' => ''], + 'UserConfigValue' => ['description' => 'The value set for the control item. The data type of this value is specified by `ControllerValueType`.', 'type' => 'any', 'example' => '20', 'title' => ''], + 'BasicEditionDefaultValue' => ['description' => 'The default value for Basic Edition.', 'type' => 'any', 'example' => '10000', 'title' => ''], + 'StandardEditionDefaultValue' => ['description' => 'The default value for Standard Edition.', 'type' => 'any', 'example' => '10000', 'title' => ''], + 'ProfessionalEditionDefaultValue' => ['description' => 'The default value for Professional Edition.', 'type' => 'any', 'example' => '10000', 'title' => ''], + 'EnterpriseEditionDefaultValue' => ['description' => 'The default value for Enterprise Edition.', 'type' => 'any', 'example' => '10000', 'title' => ''], + 'BasicEditionIntervalValue' => [ + 'type' => 'array', + 'items' => ['description' => 'A boundary value of the range.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'description' => 'The valid value range for Basic Edition, specified as \\[min, max].', + 'title' => '', + 'example' => '', + ], + 'StandardEditionIntervalValue' => [ + 'type' => 'array', + 'items' => ['description' => 'A boundary value of the range.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'description' => 'The valid value range for Standard Edition, specified as \\[min, max].', + 'title' => '', + 'example' => '', + ], + 'ProfessionalEditionIntervalValue' => [ + 'type' => 'array', + 'items' => ['description' => 'A boundary value of the range.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'description' => 'The valid value range for Professional Edition, specified as \\[min, max].', + 'title' => '', + 'example' => '', + ], + 'EnterpriseEditionIntervalValue' => [ + 'type' => 'array', + 'items' => ['description' => 'A boundary value of the range.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'description' => 'The valid value range for Enterprise Edition, specified as \\[min, max].', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'A control item.', + 'title' => '', + 'example' => '', + ], + 'description' => 'A list of control items. The available items depend on the schema. For details, see the `Controller` definition and the list of control items for each schema.', + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'The policy content. The content is constrained by `SecurityStrategySchema`.', + 'title' => '', + 'example' => '', + ], ], + 'description' => 'A security policy.', + 'title' => '', + 'example' => '', ], - 'required' => false, - 'description' => '', + 'description' => 'The list of security policies.', + 'title' => '', + 'example' => '', ], - 'required' => false, ], + 'description' => 'The pagination result.', + 'title' => '', + 'example' => '', ], - 'required' => false, - 'description' => '', ], - 'required' => false, - 'maxItems' => 50, + 'title' => '', + 'description' => 'The schema of the response.', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListSecurityStrategies', + 'description' => '## Request'."\n" + ."\n" + .'- This API retrieves a paginated list of configured security policies.'."\n" + ."\n" + .'- The `ControlModule` and `ControlSubModule` parameters filter policies by a specific module or submodule.'."\n" + ."\n" + .'- The `PageNum` and `PageSize` parameters control pagination. `PageNum` specifies the page number to retrieve (default: 1), and `PageSize` specifies the number of policies to return per page (default: 20).'."\n" + ."\n" + .'- Use the `MaxResults` and `NextToken` private parameters for advanced pagination.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc5df3a17****903790e8e8a\\",\\n \\"PagingInfo\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 12,\\n \\"SecurityStrategies\\": [\\n {\\n \\"Id\\": \\"12345\\",\\n \\"Name\\": \\"默认数据分析策略\\",\\n \\"Description\\": \\"控制数据分析模块的查询结果安全行为\\",\\n \\"SchemaName\\": \\"DataQuerySecurityStrategySchema\\",\\n \\"ControlModule\\": \\"DataQuery\\",\\n \\"ControlSubModule\\": \\"MyCatalog\\",\\n \\"ControlDwScope\\": \\"Tenant\\",\\n \\"Workspaces\\": [\\n 343434\\n ],\\n \\"Enabled\\": false,\\n \\"OriginPolicyId\\": 12,\\n \\"Creator\\": \\"203322746501002787\\",\\n \\"Updater\\": \\"203322746501002787\\",\\n \\"CreateTime\\": \\"2026-05-25T20:46:19\\",\\n \\"UpdateTime\\": \\"2026-05-25T20:46:19\\",\\n \\"Content\\": {\\n \\"Name\\": \\"DataQuerySecurityStrategySchema\\",\\n \\"DisplayName\\": \\"数据分析\\",\\n \\"DisplayNameEn\\": \\"Data Query\\",\\n \\"ControlModule\\": \\"DataQuery\\",\\n \\"ControlSubModule\\": \\"MyCatalog\\",\\n \\"ControlDwScope\\": \\"Tenant\\",\\n \\"SystemPolicyName\\": \\"SYSTEM_GENERATE_DEFAULT_DATA_QUERY\\",\\n \\"SystemPolicyDisplayName\\": \\"Default system generate data query policy\\",\\n \\"Controllers\\": [\\n {\\n \\"Controller\\": \\"viewCount\\",\\n \\"DisplayName\\": \\"查询结果-单次展示记录值上限\\",\\n \\"DisplayNameEn\\": \\"Query Results - Single Display Record Limit\\",\\n \\"Enable\\": false,\\n \\"ControllerValueType\\": \\"Integer\\",\\n \\"UserConfigValue\\": \\"20\\",\\n \\"BasicEditionDefaultValue\\": \\"10000\\",\\n \\"StandardEditionDefaultValue\\": \\"10000\\",\\n \\"ProfessionalEditionDefaultValue\\": \\"10000\\",\\n \\"EnterpriseEditionDefaultValue\\": \\"10000\\",\\n \\"BasicEditionIntervalValue\\": [\\n 0\\n ],\\n \\"StandardEditionIntervalValue\\": [\\n 0\\n ],\\n \\"ProfessionalEditionIntervalValue\\": [\\n 0\\n ],\\n \\"EnterpriseEditionIntervalValue\\": [\\n 0\\n ]\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListSkills' => [ + 'summary' => 'Lists the Skills in your account.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'Comment', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => 'TBD', + 'abilityTreeNodes' => ['FEATUREdideYTM537'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'MaxResults', + 'in' => 'query', + 'schema' => ['description' => 'The maximum number of results to return per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['description' => 'The pagination token for the next page of results. Omit this for the first request. For subsequent requests, set this to the `NextToken` from the previous response.', 'type' => 'string', 'required' => false, 'example' => '5', 'title' => ''], + ], + [ + 'name' => 'Q', + 'in' => 'formData', + 'schema' => ['description' => 'The search keyword for a fuzzy match on Skill names.', 'type' => 'string', 'required' => false, 'example' => 'analysis', 'title' => ''], + ], + [ + 'name' => 'Visibility', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The remarks.'."\n", - 'type' => 'string', + 'type' => 'array', + 'items' => [ + 'description' => 'The visibility level.', + 'type' => 'string', + 'enum' => ['TENANT', 'PROJECT', 'USER'], + 'required' => false, + 'example' => '123456', + 'title' => '', + ], + 'description' => 'Filters the results by visibility level. You can specify multiple values.', 'required' => false, - 'example' => 'this is a comment'."\n", + 'title' => '', + 'example' => '', ], ], ], @@ -37610,735 +40452,351 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX', - ], - 'SuccessInfo' => [ - 'description' => 'The result of the batch operation, which is in the MAP structure. The task ID serves as a key, and the result serves as a value.'."\n", + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '824F80BA-1778-5D8A-BAFF-668A4D9C4CC7'], + 'PagingInfo' => [ 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'type' => 'boolean', - 'description' => 'Indicates whether the request was successful.'."\n", - 'example' => 'true', - ], - 'Message' => [ - 'type' => 'string', - 'example' => 'The task does not exist.', - 'description' => 'The error message.'."\n", + 'properties' => [ + 'TotalCount' => ['description' => 'The total number of results that match the query.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'MaxResults' => ['description' => 'The maximum number of results returned in this response.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'NextToken' => ['description' => 'The token for the next page of results. This parameter is null or empty if all results have been returned.', 'type' => 'string', 'example' => '5', 'title' => ''], + 'Skills' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '**The Skill name.**', 'type' => 'string', 'example' => 'my-skill', 'title' => ''], + 'Description' => ['description' => '**The Skill description.**', 'type' => 'string', 'example' => '数据分析技能', 'title' => ''], + 'CreatorId' => ['description' => '**The creator ID.**', 'type' => 'string', 'example' => '123456', 'title' => ''], + 'ModifierId' => ['description' => '**The modifier ID.**', 'type' => 'string', 'example' => '123456', 'title' => ''], + 'Visibility' => ['description' => '**The visibility level.**', 'type' => 'string', 'example' => 'TENANT', 'title' => ''], + 'GmtCreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'format' => 'iso8601', 'example' => '1780555634000', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'description' => 'The list of Skills.', + 'title' => '', + 'example' => '', ], - 'description' => 'The result.'."\n", ], + 'description' => 'The pagination information.', + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'title' => '', + 'description' => 'The returned data.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListSkills', + 'description' => '## Request'."\n" + ."\n" + .'This operation lists the Skills in your account. You can filter the results by criteria such as a search keyword and visibility level.'."\n" + ."\n" + .'- **Q**: An optional search keyword for a fuzzy match on Skill names.'."\n" + ."\n" + .'- **Visibility**: An optional parameter to filter Skills by their visibility level. You can specify multiple values.'."\n" + ."\n" + .'- **MaxResults**: An optional parameter that specifies the maximum number of results to return per page.'."\n" + ."\n" + .'- **NextToken**: An optional pagination token for retrieving the next page of results. Omit this parameter for the first request. For subsequent requests, pass the `NextToken` value from the previous response to fetch the next page.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"SuccessInfo\\": {\\n \\"key\\": {\\n \\"Success\\": true,\\n \\"Message\\": \\"The task does not exist.\\"\\n }\\n }\\n}","type":"json"}]', - 'title' => 'BatchUpdateTasks', - 'summary' => 'Performs incremental updates on multiple tasks at a time.', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"824F80BA-1778-5D8A-BAFF-668A4D9C4CC7\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 100,\\n \\"MaxResults\\": 100,\\n \\"NextToken\\": \\"5\\",\\n \\"Skills\\": [\\n {\\n \\"Name\\": \\"my-skill\\",\\n \\"Description\\": \\"数据分析技能\\",\\n \\"CreatorId\\": \\"123456\\",\\n \\"ModifierId\\": \\"123456\\",\\n \\"Visibility\\": \\"TENANT\\",\\n \\"GmtCreateTime\\": \\"1780555634000\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], - 'GetTask' => [ - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'ListTables' => [ + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '221964', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - 'FEATUREdideD0YY7B', - 'FEATUREdideVFMENL', - ], + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '266735', + 'abilityTreeNodes' => ['FEATUREdideE9OA4H'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'ParentMetaEntityId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the parent-level metadata entity. You can obtain this value from the response of the ListDatabases or ListSchemas operation. For more information, see [Metadata entity concepts](~~2880092~~).'."\n" + ."\n" + .'- The value can be the database to which the table belongs. The ParentMetaEntityId format is `${EntityType}:${InstanceID or encoded URL}:${DataCatalogIdentifier}:${DatabaseName}`. Use an empty string as a placeholder for levels that do not exist.'."\n" + ."\n" + .'- The value can also be the database schema to which the table belongs. The ParentMetaEntityId format is `${EntityType}:${InstanceID or encoded URL}:${DataCatalogIdentifier}:${DatabaseName}:${SchemaName}`. Use an empty string as a placeholder for levels that do not exist.'."\n" + ."\n" + .'> - You can set ParentMetaEntityId to a database schema only when the database type supports schemas (`maxcompute/holo/postgresql/sqlserver/hybriddb_for_postgresql/oracle`, and the three-level model must be enabled for the maxcompute type). Otherwise, you can set this parameter only to a database.'."\n" + .'> - For the maxcompute and dlf types, use an empty string as a placeholder for the instance ID. For the maxcompute type, the database name is the MaxCompute project name.'."\n" + .'> - For the starrocks type, the data catalog identifier is the catalog name. For the dlf type, the data catalog identifier is the catalog ID. Other types do not support the catalog level. Use an empty string as a placeholder.'."\n" + ."\n" + .'The following examples show the ParentMetaEntityId formats for common types:'."\n" + ."\n" + .'- `maxcompute-project:::project_name`'."\n" + ."\n" + .'- `maxcompute-schema:::project_name:schema_name` (only when the three-level model is enabled for the project)'."\n" + ."\n" + .'- `dlf-database::catalog_id:database_name`'."\n" + ."\n" + .'- `hms-database:instance_id::database_name`'."\n" + ."\n" + .'- `holo-schema:instance_id::database_name:schema_name`'."\n" + ."\n" + .'- `mysql-database:(instance_id|encoded_jdbc_url)::database_name`'."\n" + ."\n" + .'> Where: '."\n" + .'> - `instance_id`: The instance ID. This value is required when the data source is registered in instance mode.'."\n" + .'> - `encoded_jdbc_url`: The URL-encoded JDBC connection string. This value is required when the data source is registered by using a connection string.'."\n" + .'> - `catalog_id`: The DLF catalog ID.'."\n" + .'> - `project_name`: The MaxCompute project name.'."\n" + .'> - `database_name`: The database name.'."\n" + .'> - `schema_name`: The schema name.', 'type' => 'string', 'required' => true, 'example' => 'maxcompute-project:::project_name'], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The name. Fuzzy match is supported.', 'type' => 'string', 'required' => false, 'example' => 'abc'], + ], + [ + 'name' => 'Comment', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The comment. Fuzzy match is supported.', 'type' => 'string', 'required' => false, 'example' => 'this is a comment'."\n"], + ], + [ + 'name' => 'TableTypes', 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => 'The task ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234', + 'title' => '', + 'description' => 'The list of table types to query. If this parameter is left empty, all types are queried.', + 'type' => 'array', + 'items' => ['description' => 'The table type. Valid values vary based on the database type.', 'type' => 'string', 'required' => false, 'example' => 'TABLE', 'title' => ''], + 'required' => false, + 'example' => '', ], ], [ - 'name' => 'ProjectEnv', + 'name' => 'SortBy', 'in' => 'query', 'schema' => [ - 'description' => 'The environment of the workspace. Valid values:'."\n" - ."\n" - .'* Prod: production environment'."\n" - .'* Dev: development environment'."\n", + 'title' => '', + 'description' => 'The field by which to sort the results. Default value: CreateTime. Valid values:'."\n" + .'- CreateTime: creation time'."\n" + .'- ModifyTime: modification time'."\n" + .'- Name: name'."\n" + .'- TableType: table type', + 'enumValueTitles' => [], 'type' => 'string', 'required' => false, + 'example' => 'CreateTime', + 'default' => 'CreateTime', + 'enum' => ['CreateTime', 'ModifyTime', 'Name', 'TableType'], + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'The sort order. Default value: Asc. Valid values:'."\n" + .'- Asc: ascending order'."\n" + .'- Desc: descending order', 'enumValueTitles' => [], - 'example' => 'Prod', - 'default' => 'Prod', - 'enum' => [ - 'Prod', - 'Dev', - ], + 'type' => 'string', + 'example' => 'Asc', + 'default' => 'Asc', + 'enum' => ['Asc', 'Desc'], + 'required' => false, ], ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The page number. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'minimum' => '1', 'example' => '1', 'default' => '1', 'required' => false], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The page size. Default value: 10. Maximum value: 100.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '1', 'example' => '10', 'default' => '10', 'required' => false], + ], + [ + 'name' => 'IncludeExtendedProperties', + 'in' => 'query', + 'schema' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX', - ], - 'Task' => [ - 'description' => 'The details of the task.'."\n", + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'E25887B7-579C-54A5-9C4F-83A****', 'title' => ''], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true'], + 'PagingInfo' => [ + 'title' => '', + 'description' => 'The pagination result.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'The name of the task.'."\n", - 'type' => 'string', - 'example' => 'SQL node', - ], - 'Description' => [ - 'description' => 'The description of the task.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'WorkflowId' => [ - 'description' => 'The workflow ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'InstanceMode' => [ - 'description' => 'The instance generation mode. Valid values:'."\n" - ."\n" - .'* T+1'."\n" - .'* Immediately'."\n", - 'type' => 'string', - 'example' => 'T+1', - ], - 'Type' => [ - 'title' => '任务类型', - 'description' => 'The type of the task.'."\n", - 'type' => 'string', - 'example' => 'ODPS_SQL', - ], - 'BaselineId' => [ - 'title' => '基线ID', - 'description' => 'The baseline ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'Priority' => [ - 'title' => '任务优先级，最大值8，最小值1', - 'description' => 'The priority of the task. Valid values: 1 to 8. A larger value indicates a higher priority. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Timeout' => [ - 'title' => '任务执行超时时间，单位秒', - 'description' => 'The timeout period of task running. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3600', - ], - 'RerunMode' => [ - 'title' => '任务是否允许重跑的配置', - 'description' => 'The rerun mode. Valid values:'."\n" - ."\n" - .'* AllDenied: The task cannot be rerun regardless of whether the task is successfully run or fails to be run.'."\n" - .'* FailureAllowed: The task can be rerun only after it fails to be run.'."\n" - .'* AllAllowed: The task can be rerun regardless of whether the task is successfully run or fails to be run.'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'AllAllowed', - ], - 'RerunTimes' => [ - 'title' => '重试次数', - 'description' => 'The number of times that the task is rerun. This parameter takes effect only if the RerunMode parameter is set to AllAllowed or FailureAllowed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'RerunInterval' => [ - 'title' => '重试时间间隔，单位秒', - 'description' => 'The rerun interval. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - ], - 'Script' => [ - 'title' => '运行脚本信息', - 'description' => 'The script information.'."\n", - 'type' => 'object', - 'properties' => [ - 'Content' => [ - 'description' => 'The script content.'."\n", - 'type' => 'string', - 'example' => 'echo "helloWorld"', - ], - 'Parameters' => [ - 'description' => 'The script parameters.'."\n", - 'type' => 'string', - 'example' => 'para1=$bizdate', - ], - ], - ], - 'Trigger' => [ - 'title' => '任务触发方式', - 'description' => 'The method to trigger task scheduling.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The trigger type. Valid values:'."\n" - ."\n" - .'* Scheduler: periodic scheduling'."\n" - .'* Manual: manual scheduling'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Scheduler', - ], - 'Recurrence' => [ - 'description' => 'The running mode of the task after it is triggered. This parameter takes effect only if the Type parameter is set to Scheduler. Valid values:'."\n" - ."\n" - .'* Pause'."\n" - .'* Skip'."\n" - .'* Normal'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Normal', - ], - 'Cron' => [ - 'description' => 'The CRON expression of the task. This parameter takes effect only if the Type parameter is set to Scheduler.'."\n", - 'type' => 'string', - 'example' => '00 00 00 * * ?', - ], - 'StartTime' => [ - 'description' => 'The start time of the time range during which the task is periodically scheduled. This parameter takes effect only if the Type parameter is set to Scheduler.'."\n", - 'type' => 'string', - 'example' => '1970-01-01 00:00:00', - ], - 'EndTime' => [ - 'description' => 'The end time of the time range during which the task is periodically scheduled. This parameter takes effect only if the Type parameter is set to Scheduler.'."\n", - 'type' => 'string', - 'example' => '9999-01-01 00:00:00', - ], - ], - ], - 'RuntimeResource' => [ - 'title' => '运行环境配置，如资源组信息', - 'description' => 'The configurations of the runtime environment, such as the resource group information.'."\n", - 'type' => 'object', - 'properties' => [ - 'ResourceGroupId' => [ - 'description' => 'The ID of the resource group for scheduling configured for task running.'."\n", - 'type' => 'string', - 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', - ], - 'Image' => [ - 'description' => 'The ID of the image configured for task running.'."\n", - 'type' => 'string', - 'example' => 'i-xxxxxx'."\n", - ], - 'Cu' => [ - 'description' => 'The default number of compute units (CUs) configured for task running.'."\n", - 'type' => 'string', - 'example' => '0.25', - ], - ], - ], - 'DataSource' => [ - 'title' => '数据源', - 'description' => 'The information about the associated data source.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the data source.'."\n", - 'type' => 'string', - 'example' => 'mysql_test', - ], - ], - ], - 'Inputs' => [ - 'title' => '输入信息', - 'description' => 'The input information.'."\n", - 'type' => 'object', - 'properties' => [ - 'Variables' => [ - 'description' => 'The variables.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the variable.'."\n", - 'type' => 'string', - 'example' => 'key1', - ], - 'Type' => [ - 'title' => '类型', - 'description' => 'The type. Valid values:'."\n" - ."\n" - .'* Constant: constant'."\n" - .'* PassThrough: node output'."\n" - .'* System: variable'."\n" - .'* NodeOutput: script output'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Constant'."\n", - ], - 'Value' => [ - 'description' => 'The value of the variable.'."\n", - 'type' => 'string', - 'example' => 'Value1'."\n", - ], - ], - 'description' => '', - ], - ], - ], - 'required' => false, - ], - 'Outputs' => [ - 'title' => '输出信息', - 'description' => 'The output information.'."\n", - 'type' => 'object', - 'properties' => [ - 'TaskOutputs' => [ - 'description' => 'The task outputs.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Output' => [ - 'title' => '输出标识符，示例：pre.odps_sql_demo_0', - 'description' => 'The identifier of the output.'."\n", - 'type' => 'string', - 'example' => 'pre.odps_sql_demo_0', - ], - ], - 'description' => '', - ], - ], - 'Variables' => [ - 'description' => 'The variables.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the variable.'."\n", - 'type' => 'string', - 'example' => 'key1', - ], - 'Type' => [ - 'title' => '类型', - 'description' => 'The type. Valid values:'."\n" - ."\n" - .'* Constant: constant'."\n" - .'* PassThrough: node output'."\n" - .'* System: variable'."\n" - .'* NodeOutput: script output'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Constant'."\n", - ], - 'Value' => [ - 'description' => 'The value of the variable.'."\n", - 'type' => 'string', - 'example' => 'value1', - ], - ], - 'description' => '', - ], - ], - ], - 'required' => false, - ], - 'Dependencies' => [ - 'title' => '依赖信息', - 'description' => 'The dependency information.'."\n", + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The page size.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'Tables' => [ + 'title' => '', + 'description' => 'The list of data tables.', 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '依赖类型', - 'description' => 'The dependency type. Valid values:'."\n" - ."\n" - .'* CrossCycleDependsOnChildren: cross-cycle dependency on level-1 descendant nodes'."\n" - .'* CrossCycleDependsOnSelf: cross-cycle dependency on the current node'."\n" - .'* CrossCycleDependsOnOtherNode: cross-cycle dependency on other nodes'."\n" - .'* Normal: same-cycle scheduling dependency'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Normal', - ], - 'UpstreamOutput' => [ - 'title' => '依赖任务的输出标识符,或者任务ID', - 'description' => 'The identifier of the output of the ancestor task. This parameter is returned only if `same-cycle scheduling dependencies` and the node input are configured.'."\n", - 'type' => 'string', - 'example' => 'pre.odps_sql_demo_0', - ], - 'UpstreamTaskId' => [ - 'description' => 'The ancestor task ID. This parameter is returned only if `cross-cycle scheduling dependencies` or `same-cycle scheduling dependencies` and the node input are not configured.'."\n", - 'type' => 'string', - 'example' => '1234', - ], - ], - 'description' => '', - ], - ], - 'SubTasks' => [ - 'title' => '复杂任务嵌套配置，如循环节点', - 'description' => 'The configurations of the subtasks, such as a do-while node.'."\n", - 'type' => 'object', - 'properties' => [ - 'SubTasks' => [ - 'description' => 'The subtasks.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the task.'."\n", - 'type' => 'string', - 'example' => 'SQL node', - ], - 'Description' => [ - 'description' => 'The description of the task.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'WorkflowId' => [ - 'description' => 'The ID of the workflow to which the task belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'Type' => [ - 'title' => '任务类型', - 'description' => 'The type of the task.'."\n", - 'type' => 'string', - 'example' => 'ODPS_SQL'."\n", - ], - 'BaselineId' => [ - 'title' => '基线ID', - 'description' => 'The baseline ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'The baseline ID.', - ], - 'Priority' => [ - 'title' => '任务优先级，最大值8，最小值1', - 'description' => 'The priority of the task. Valid values: 1 to 8. A larger value indicates a higher priority. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Timeout' => [ - 'title' => '任务执行超时时间，单位秒', - 'description' => 'The timeout period of task running. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3600', - ], - 'RerunMode' => [ - 'title' => '任务是否允许重跑的配置', - 'description' => 'The rerun mode. Valid values:'."\n" - ."\n" - .'* AllDenied: The task cannot be rerun regardless of whether the task is successfully run or fails to be run.'."\n" - .'* FailureAllowed: The task can be rerun only after it fails to be run.'."\n" - .'* AllAllowed: The task can be rerun regardless of whether the task is successfully run or fails to be run.'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'AllAllowed', - ], - 'RerunTimes' => [ - 'title' => '重试次数', - 'description' => 'The number of times that the task is rerun. This parameter takes effect only if the RerunMode parameter is set to AllAllowed or FailureAllowed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'RerunInterval' => [ - 'title' => '重试时间间隔，单位秒', - 'description' => 'The rerun interval. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '180', - ], - 'Trigger' => [ - 'title' => '任务触发方式', - 'description' => 'The method to trigger task scheduling.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The trigger type. Valid values:'."\n" - ."\n" - .'* Scheduler: periodic scheduling'."\n" - .'* Manual: manual scheduling'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Scheduler', - ], - 'Recurrence' => [ - 'description' => 'The running mode of the task after it is triggered. This parameter takes effect only if the Type parameter is set to Scheduler. Valid values:'."\n" - ."\n" - .'* Pause'."\n" - .'* Skip'."\n" - .'* Normal'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Normal'."\n", - ], - 'Cron' => [ - 'description' => 'The CRON expression of the task. This parameter takes effect only if the Type parameter is set to Scheduler.'."\n", - 'type' => 'string', - 'example' => '00 00 00 * * ?'."\n", - ], - 'StartTime' => [ - 'description' => 'The start time of the time range during which the task is periodically scheduled. This parameter takes effect only if the Type parameter is set to Scheduler.'."\n", - 'type' => 'string', - 'example' => '1970-01-01 00:00:00'."\n", - ], - 'EndTime' => [ - 'description' => 'The end time of the time range during which the task is periodically scheduled. This parameter takes effect only if the Type parameter is set to Scheduler.'."\n", - 'type' => 'string', - 'example' => '9999-01-01 00:00:00'."\n", - ], - ], - ], - 'RuntimeResource' => [ - 'title' => '运行环境配置，如资源组信息', - 'description' => 'The runtime environment configuration of the task, such as the resource group.'."\n", - 'type' => 'object', - 'properties' => [ - 'ResourceGroupId' => [ - 'description' => 'The ID of the resource group for scheduling configured for task running.'."\n", - 'type' => 'string', - 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', - ], - 'Image' => [ - 'description' => 'The ID of the image configured for task running.'."\n", - 'type' => 'string', - 'example' => 'i-xxxxxx', - ], - 'Cu' => [ - 'description' => 'The default number of CUs configured for task running.'."\n", - 'type' => 'string', - 'example' => '0.25', - ], - ], - ], - 'DataSource' => [ - 'title' => '数据源', - 'description' => 'The information about the associated data source.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the data source.'."\n", - 'type' => 'string', - 'example' => 'mysql_test'."\n", - ], - ], - ], - 'Id' => [ - 'description' => 'The task ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'ProjectId' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'ProjectEnv' => [ - 'description' => 'The environment of the workspace. This parameter is deprecated and replaced by the EnvType parameter. Valid values:'."\n" - ."\n" - .'* Prod: production environment'."\n" - .'* Dev: development environment'."\n", - 'type' => 'string', - 'deprecated' => true, - 'enumValueTitles' => [], - 'example' => 'Prod', - ], - 'EnvType' => [ - 'description' => 'The environment of the workspace. Valid values:'."\n" - ."\n" - .'* Prod: production environment'."\n" - .'* Dev: development environment'."\n", - 'type' => 'string', - 'example' => 'Prod', - ], - 'Owner' => [ - 'description' => 'The account ID of the task owner.'."\n", - 'type' => 'string', - 'example' => '1000'."\n", - ], - 'CreateTime' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403'."\n", - ], - 'ModifyTime' => [ - 'description' => 'The modification time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403'."\n", - ], - 'CreateUser' => [ - 'description' => 'The account ID of the creator.'."\n", - 'type' => 'string', - 'example' => '1000'."\n", - ], - 'ModifyUser' => [ - 'description' => 'The account ID of the modifier.'."\n", - 'type' => 'string', - 'example' => '1000'."\n", - ], - ], - 'description' => '', - ], - ], - 'Type' => [ - 'title' => '子任务类型', - 'description' => 'The type of the subtask. Valid values:'."\n" - ."\n" - .'* DoWhile: do-while node'."\n" - .'* Combined: node group'."\n" - .'* ForEach: for-each node'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Combined', - ], - ], + 'items' => ['title' => '', 'description' => 'The details of the data table.', '$ref' => '#/components/schemas/Table', 'example' => ''], + 'example' => '', ], - 'Tags' => [ - 'title' => '任务标签', - 'description' => 'The tags.'."\n", + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query data tables in data map', + 'summary' => 'Queries the list of data tables in DataWorks Data Map. For types that do not support the schema level, you can query data tables under a specified database. For types that support the schema level, you can query data tables under a specified database, MaxCompute project, or schema. The response contains only basic table information and does not include technical metadata or business metadata.', + 'description' => '1. DataWorks Basic Edition or a higher edition is required.', + 'responseParamsDescription' => '**Note**:'."\n" + ."\n" + .'The `Table` objects returned in `Tables` are simplified structures that **do not include** the following properties:'."\n" + .' - `TechnicalMetadata`'."\n" + .' - `BusinessMetadata`'."\n" + ."\n" + .'To obtain the technical metadata or business metadata of a table, call the `GetTable` operation to retrieve the complete `Table` object.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:ListTables', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E25887B7-579C-54A5-9C4F-83A****\\",\\n \\"Success\\": true,\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"Tables\\": [\\n {\\n \\"Id\\": \\"dlf-table::catalog_id:database_name::table_name\\",\\n \\"Name\\": \\"table_name\\",\\n \\"Comment\\": \\"测试表\\",\\n \\"TableType\\": \\"TABLE\\",\\n \\"PartitionKeys\\": [\\n \\"ds\\"\\n ],\\n \\"ParentMetaEntityId\\": \\"dlf-database::catalog_id:database_name\\",\\n \\"CreateTime\\": 1736852168000,\\n \\"ModifyTime\\": 1736852168000,\\n \\"TechnicalMetadata\\": {\\n \\"Owner\\": \\"test_user\\",\\n \\"Location\\": \\"oss://test-bucket/test_tbl\\",\\n \\"Compressed\\": false,\\n \\"InputFormat\\": \\"org.apache.hadoop.hive.ql.io.parquet.MapredParquetInputFormat\\",\\n \\"OutputFormat\\": \\"org.apache.hadoop.hive.ql.io.parquet.MapredParquetOutputFormat\\",\\n \\"SerializationLibrary\\": \\"org.apache.hadoop.hive.ql.io.parquet.serde.ParquetHiveSerDe\\",\\n \\"Parameters\\": {\\n \\"key\\": \\"value\\"\\n }\\n },\\n \\"BusinessMetadata\\": {\\n \\"Readme\\": \\"## 使用说明\\",\\n \\"CustomAttributes\\": {\\n \\"key\\": [\\n \\"张三\\"\\n ]\\n },\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"tag_key\\",\\n \\"Value\\": \\"tag_value\\"\\n }\\n ],\\n \\"Categories\\": [\\n [\\n {\\n \\"Id\\": \\"CATEGORY.456\\",\\n \\"Name\\": \\"测试类目\\",\\n \\"ParentId\\": \\"CATEGORY.123\\"\\n }\\n ]\\n ],\\n \\"UpstreamTasks\\": [\\n {\\n \\"Id\\": 123456,\\n \\"Name\\": \\"test_task\\"\\n }\\n ],\\n \\"Extension\\": {\\n \\"ProjectId\\": 234,\\n \\"EnvType\\": \\"Dev\\",\\n \\"ViewCount\\": 0,\\n \\"ReadCount\\": 0,\\n \\"FavorCount\\": 0\\n }\\n },\\n \\"StatisticsInfos\\": {\\n \\"key\\": \\"\\"\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListTaskInstanceOperationLogs' => [ + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '240664', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB'], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234', 'title' => ''], + ], + [ + 'name' => 'Date', + 'in' => 'query', + 'schema' => ['description' => 'The operation date, accurate to the day. The default value is the current day. You can query only the operation logs generated within the previous 31 days. This value is a UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1710239005403'."\n", 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A1****'."\n", 'title' => ''], + 'PagingInfo' => [ + 'description' => 'The pagination information.', + 'type' => 'object', + 'properties' => [ + 'OperationLogs' => [ + 'description' => 'The operation logs.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'key1', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => 'value1', - ], + 'User' => ['description' => 'The account ID of the operator.', 'type' => 'string', 'example' => '1000'."\n", 'title' => ''], + 'CreateTime' => ['description' => 'The time when the operation log was generated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'."\n", 'title' => ''], + 'OperationSeq' => ['description' => 'The serial number of the operation.', 'type' => 'integer', 'format' => 'int64', 'example' => '1111', 'title' => ''], + 'OperationContent' => ['description' => 'The operation content.', 'type' => 'string', 'example' => 'Freeze tasks', 'title' => ''], + 'TaskInstanceId' => ['description' => 'The ID of the instance on which the operation was performed.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'Id' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'ProjectId' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'ProjectEnv' => [ - 'description' => 'The environment of the workspace. This parameter is deprecated and replaced by the EnvType parameter. Valid values:'."\n" - ."\n" - .'* Prod: production environment'."\n" - .'* Dev: development environment'."\n", - 'type' => 'string', - 'deprecated' => true, - 'enumValueTitles' => [], - 'example' => 'Prod', - ], - 'EnvType' => [ - 'description' => 'The environment of the workspace. Valid values:'."\n" - ."\n" - .'* Prod: production environment'."\n" - .'* Dev: development environment'."\n", - 'type' => 'string', - 'example' => 'Prod', - ], - 'Owner' => [ - 'description' => 'The account ID of the task owner.'."\n", - 'type' => 'string', - 'example' => '1000', - ], - 'CreateTime' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403'."\n", - ], - 'ModifyTime' => [ - 'description' => 'The modification time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403'."\n", - ], - 'CreateUser' => [ - 'description' => 'The account ID of the creator.'."\n", - 'type' => 'string', - 'example' => '1000'."\n", - ], - 'ModifyUser' => [ - 'description' => 'The account ID of the modifier.'."\n", - 'type' => 'string', - 'example' => '1000', - ], + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '100'."\n", 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10'."\n", 'title' => ''], + 'PageNumber' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"Task\\": {\\n \\"Name\\": \\"SQL node\\",\\n \\"Description\\": \\"test\\",\\n \\"WorkflowId\\": 1234,\\n \\"InstanceMode\\": \\"T+1\\",\\n \\"Type\\": \\"ODPS_SQL\\",\\n \\"BaselineId\\": 1234,\\n \\"Priority\\": 1,\\n \\"Timeout\\": 3600,\\n \\"RerunMode\\": \\"AllAllowed\\",\\n \\"RerunTimes\\": 3,\\n \\"RerunInterval\\": 60,\\n \\"Script\\": {\\n \\"Content\\": \\"echo \\\\\\"helloWorld\\\\\\"\\",\\n \\"Parameters\\": \\"para1=$bizdate\\"\\n },\\n \\"Trigger\\": {\\n \\"Type\\": \\"Scheduler\\",\\n \\"Recurrence\\": \\"Normal\\",\\n \\"Cron\\": \\"00 00 00 * * ?\\",\\n \\"StartTime\\": \\"1970-01-01 00:00:00\\",\\n \\"EndTime\\": \\"9999-01-01 00:00:00\\"\\n },\\n \\"RuntimeResource\\": {\\n \\"ResourceGroupId\\": \\"S_res_group_524258031846018_1684XXXXXXXXX\\",\\n \\"Image\\": \\"i-xxxxxx\\\\n\\",\\n \\"Cu\\": \\"0.25\\"\\n },\\n \\"DataSource\\": {\\n \\"Name\\": \\"mysql_test\\"\\n },\\n \\"Inputs\\": {\\n \\"Variables\\": [\\n {\\n \\"Name\\": \\"key1\\",\\n \\"Type\\": \\"Constant\\\\n\\",\\n \\"Value\\": \\"Value1\\\\n\\"\\n }\\n ]\\n },\\n \\"Outputs\\": {\\n \\"TaskOutputs\\": [\\n {\\n \\"Output\\": \\"pre.odps_sql_demo_0\\"\\n }\\n ],\\n \\"Variables\\": [\\n {\\n \\"Name\\": \\"key1\\",\\n \\"Type\\": \\"Constant\\\\n\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ]\\n },\\n \\"Dependencies\\": [\\n {\\n \\"Type\\": \\"Normal\\",\\n \\"UpstreamOutput\\": \\"pre.odps_sql_demo_0\\",\\n \\"UpstreamTaskId\\": \\"1234\\"\\n }\\n ],\\n \\"SubTasks\\": {\\n \\"SubTasks\\": [\\n {\\n \\"Name\\": \\"SQL node\\\\n\\",\\n \\"Description\\": \\"test\\",\\n \\"WorkflowId\\": 1234,\\n \\"Type\\": \\"ODPS_SQL\\\\n\\",\\n \\"BaselineId\\": 0,\\n \\"Priority\\": 1,\\n \\"Timeout\\": 3600,\\n \\"RerunMode\\": \\"AllAllowed\\",\\n \\"RerunTimes\\": 3,\\n \\"RerunInterval\\": 180,\\n \\"Trigger\\": {\\n \\"Type\\": \\"Scheduler\\",\\n \\"Recurrence\\": \\"Normal\\\\n\\",\\n \\"Cron\\": \\"00 00 00 * * ?\\\\n\\",\\n \\"StartTime\\": \\"1970-01-01 00:00:00\\\\n\\",\\n \\"EndTime\\": \\"9999-01-01 00:00:00\\\\n\\"\\n },\\n \\"RuntimeResource\\": {\\n \\"ResourceGroupId\\": \\"S_res_group_524258031846018_1684XXXXXXXXX\\",\\n \\"Image\\": \\"i-xxxxxx\\",\\n \\"Cu\\": \\"0.25\\"\\n },\\n \\"DataSource\\": {\\n \\"Name\\": \\"mysql_test\\\\n\\"\\n },\\n \\"Id\\": 1234,\\n \\"ProjectId\\": 100,\\n \\"ProjectEnv\\": \\"Prod\\",\\n \\"EnvType\\": \\"Prod\\",\\n \\"Owner\\": \\"1000\\\\n\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"1000\\\\n\\",\\n \\"ModifyUser\\": \\"1000\\\\n\\"\\n }\\n ],\\n \\"Type\\": \\"Combined\\"\\n },\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"Id\\": 1234,\\n \\"ProjectId\\": 100,\\n \\"ProjectEnv\\": \\"Prod\\",\\n \\"EnvType\\": \\"Prod\\",\\n \\"Owner\\": \\"1000\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"1000\\\\n\\",\\n \\"ModifyUser\\": \\"1000\\"\\n }\\n}","type":"json"}]', - 'title' => 'GetTask', - 'summary' => 'Queries the information about a task.', - ], - 'ListTasks' => [ - 'summary' => 'Queries a list of tasks by page. You can also specify filter conditions to query tasks.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A1****\\\\n\\",\\n \\"PagingInfo\\": {\\n \\"OperationLogs\\": [\\n {\\n \\"User\\": \\"1000\\\\n\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"OperationSeq\\": 1111,\\n \\"OperationContent\\": \\"Freeze tasks\\",\\n \\"TaskInstanceId\\": 1234\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1\\n }\\n}","type":"json"}]', + 'title' => 'ListTaskInstanceOperationLogs', + 'summary' => 'Retrieves a paginated list of operation logs for a task instance.', + 'description' => 'This API operation is available for all DataWorks editions.'."\n" + ."\n" + .'Only operation logs generated within the previous 31 days can be queried.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'ListTaskInstances' => [ + 'summary' => 'Queries a list of instances. You can also specify filter conditions to query specific instances.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -38350,1724 +40808,945 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '238059', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - 'FEATUREdideD0YY7B', - 'FEATUREdideVFMENL', - ], + 'abilityTreeCode' => '240660', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB', 'FEATUREdideD0YY7B', 'FEATUREdideVFMENL'], ], 'parameters' => [ [ - 'name' => 'ProjectEnv', + 'name' => 'ProjectId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The workspace environment.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Prod'."\n" - .'* Dev'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Prod' => '', - 'Dev' => '', - ], - 'example' => 'Prod', - 'default' => 'Prod', - 'enum' => [ - 'Prod', - 'Dev', - ], - ], + 'schema' => ['description' => 'The DataWorks workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '100'."\n", 'title' => ''], ], [ - 'name' => 'ProjectId', + 'name' => 'Bizdate', 'in' => 'formData', - 'schema' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '100', - ], + 'schema' => ['description' => 'The data timestamp. The value of this parameter is 00:00:00 of the day before the scheduling time of the instance. The value is a UNIX timestamp. Unit: milliseconds. Example: 1743350400000.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1710239005403', 'title' => ''], ], [ - 'name' => 'Name', + 'name' => 'TaskId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the task. Fuzzy match is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SQL node', - ], + 'schema' => ['description' => 'The ID of the task for which the instance is generated.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234', 'title' => ''], ], [ - 'name' => 'Ids', + 'name' => 'TaskIds', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'The ID of the task.', + 'description' => 'The IDs of the tasks. You can query multiple instances at a time by task ID.', 'type' => 'array', - 'items' => [ - 'description' => 'The account ID of the owner of the task.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1234', - ], + 'items' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234', 'title' => ''], 'required' => false, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'TaskName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the task. Fuzzy match is supported.', 'type' => 'string', 'required' => false, 'example' => 'SQL node', 'title' => ''], + ], [ 'name' => 'Owner', 'in' => 'formData', - 'schema' => [ - 'description' => 'The account ID of the task owner.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1000', - ], + 'schema' => ['description' => 'The account ID of the task owner.', 'type' => 'string', 'required' => false, 'example' => '1000', 'title' => ''], ], [ 'name' => 'TaskType', 'in' => 'formData', - 'schema' => [ - 'description' => 'The type of the task. Valid values:'."\n" - ."\n" - .'* ODPS_SQL'."\n" - .'* SPARK'."\n" - .'* PY_ODPS'."\n" - .'* PY_ODPS3'."\n" - .'* ODPS_SCRIPT'."\n" - .'* ODPS_MR'."\n" - .'* COMPONENT_SQL'."\n" - .'* EMR_HIVE'."\n" - .'* EMR_MR'."\n" - .'* EMR_SPARK_SQL'."\n" - .'* EMR_SPARK'."\n" - .'* EMR_SHELL'."\n" - .'* EMR_PRESTO'."\n" - .'* EMR_IMPALA'."\n" - .'* SPARK_STREAMING'."\n" - .'* EMR_KYUUBI'."\n" - .'* EMR_TRINO'."\n" - .'* HOLOGRES_SQL'."\n" - .'* HOLOGRES_SYNC_DDL'."\n" - .'* HOLOGRES_SYNC_DATA'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ODPS_SQL'."\n", - ], + 'schema' => ['description' => 'The type of the task for which the instance is generated.', 'type' => 'string', 'required' => false, 'example' => 'ODPS_SQL', 'title' => ''], ], [ 'name' => 'RuntimeResource', 'in' => 'formData', - 'schema' => [ - 'description' => 'The information about the resource group. Set this parameter to the ID of a resource group for scheduling.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', - ], + 'schema' => ['description' => 'The information about the resource group. Set this parameter to the identifier of a resource group for scheduling.', 'type' => 'string', 'required' => false, 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX'."\n", 'title' => ''], ], [ 'name' => 'WorkflowId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the workflow to which the task belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1234', - ], + 'schema' => ['description' => 'The ID of the workflow to which the instance belongs.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234'."\n", 'title' => ''], ], [ - 'name' => 'TriggerType', + 'name' => 'UnifiedWorkflowInstanceId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The trigger type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Scheduler: Triggered by schedule.'."\n" - .'* Manual: Triggered manually.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'Scheduler' => '', - 'Manual' => '', - ], - 'example' => 'Scheduler'."\n", - 'enum' => [ - 'Scheduler', - 'Manual', - ], - ], + 'schema' => ['description' => 'The unified workflow instance ID. For all task instances under a specific data timestamp within a single trigger, this field has the same value.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234', 'title' => ''], ], [ - 'name' => 'TriggerRecurrence', + 'name' => 'WorkflowInstanceType', 'in' => 'formData', 'schema' => [ - 'description' => 'The run mode when triggered. Valid only if TriggerType is Scheduler.'."\n" + 'description' => 'The type of the workflow instance. Valid values:'."\n" ."\n" - .'Valid values:'."\n" + .'- SmokeTest: Testing'."\n" + ."\n" + .'- Manual: Manually triggered node'."\n" ."\n" - .'* Pause'."\n" - .'* Skip'."\n" - .'* Normal'."\n", + .'- SupplementData: Data backfill'."\n" + ."\n" + .'- ManualWorkflow: Manually triggered workflow'."\n" + ."\n" + .'- Normal: Scheduled execution'."\n" + ."\n" + .'- TriggerWorkflow: Triggered Workflow', + 'enumValueTitles' => [], 'type' => 'string', + 'enum' => ['Normal', 'ManualWorkflow', 'Manual', 'SupplementData', 'SmokeTest', 'TriggerWorkflow'], + 'title' => '', 'required' => false, - 'enumValueTitles' => [ - 'Pause' => '', - 'Skip' => '', - 'Normal' => '', - ], 'example' => 'Normal'."\n", - 'enum' => [ - 'Normal', - 'Skip', - 'Pause', - ], ], ], [ - 'name' => 'SortBy', + 'name' => 'WorkflowInstanceId', + 'in' => 'formData', + 'schema' => ['description' => 'The workflow instance ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234', 'title' => ''], + ], + [ + 'name' => 'ProjectEnv', 'in' => 'formData', 'schema' => [ - 'description' => 'The field that is used to sort tasks. This parameter is configured in the format of "Sorting field Sorting order". You can set the sorting order to Desc or Asc. If you do not specify the sorting order, Asc is used by default. Valid values:'."\n" - ."\n" - .'* `ModifyTime (Desc/Asc)`'."\n" - ."\n" - .'* `CreateTime (Desc/Asc)`'."\n" + 'description' => 'The environment of the workspace. Valid values:'."\n" ."\n" - .'* `Id (Desc/Asc)`'."\n" + .'- Prod: production environment'."\n" ."\n" - .' Default value: `Id Desc`.'."\n", + .'- Dev: development environment', + 'enumValueTitles' => [], 'type' => 'string', + 'default' => 'Prod', + 'enum' => ['Prod', 'Dev'], 'required' => false, - 'example' => 'Id Desc', + 'example' => 'Prod', + 'title' => '', ], ], [ - 'name' => 'PageSize', + 'name' => 'Id', 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The ID of the instance. The instance may be rerun. If the instance is rerun and you configure this parameter, the system returns the historical information of the instance, including the rerun information. You can use the RunNumber parameter to distinguish each entry in the historical information.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'Ids', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The IDs of the instances. You can query multiple instances at a time by instance ID.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the instance.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234', 'title' => ''], 'required' => false, - 'example' => '1', + 'title' => '', + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'TriggerType', + 'in' => 'formData', 'schema' => [ - 'title' => 'ResultModel', - 'description' => 'ResultModel'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n", - ], - 'PagingInfo' => [ - 'description' => 'The pagination information.'."\n", - 'type' => 'object', - 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - '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', - ], - 'Tasks' => [ - 'description' => 'The tasks.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the task.'."\n", - 'type' => 'string', - 'example' => 'SQL node', - ], - 'Description' => [ - 'description' => 'The description of the task.'."\n", - 'type' => 'string', - 'example' => 'test'."\n", - ], - 'WorkflowId' => [ - 'description' => 'The ID of the workflow to which the task belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'InstanceMode' => [ - 'description' => 'The instance generation mode. Valid values:'."\n" - ."\n" - .'* T+1'."\n" - .'* Immediately'."\n", - 'type' => 'string', - 'example' => 'T+1', - ], - 'Type' => [ - 'title' => '任务类型', - 'description' => 'The type of the task.'."\n", - 'type' => 'string', - 'example' => 'ODPS_SQL', - ], - 'BaselineId' => [ - 'title' => '基线ID', - 'description' => 'The baseline ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'Priority' => [ - 'title' => '任务优先级，最大值8，最小值1', - 'description' => 'The priority of the task. Valid values: 1 to 8. A larger value indicates a higher priority. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Timeout' => [ - 'title' => '任务执行超时时间，单位秒', - 'description' => 'The timeout period of task running. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3600', - ], - 'RerunMode' => [ - 'title' => '任务是否允许重跑的配置', - 'description' => 'The rerun mode.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* AllDenied: The task cannot be rerun regardless of whether the task is successfully run or fails to run.'."\n" - .'* FailureAllowed: The task can be rerun only after it fails to run.'."\n" - .'* AllAllowed: The task can be rerun regardless of whether it is successfully run or fails to run.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'AllDenied' => '', - 'FailureAllowed' => '', - 'AllAllowed' => '', - ], - 'example' => 'AllAllowed'."\n", - ], - 'RerunTimes' => [ - 'title' => '重试次数', - 'description' => 'The number of times that the task is rerun. This parameter takes effect only if the RerunMode parameter is set to AllAllowed or FailureAllowed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'RerunInterval' => [ - 'title' => '重试时间间隔，单位秒', - 'description' => 'The rerun interval. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - ], - 'Trigger' => [ - 'title' => '任务触发方式', - 'description' => 'The method to trigger task scheduling.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The trigger type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Scheduler: scheduling cycle-based trigger'."\n" - .'* Manual: manual trigger'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Scheduler' => '', - 'Manual' => '', - ], - 'example' => 'Scheduler'."\n", - ], - 'Recurrence' => [ - 'description' => 'The running mode of the task after it is triggered. This parameter takes effect only if the Type parameter is set to Scheduler.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Pause'."\n" - .'* Skip'."\n" - .'* Normal'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Pause' => '', - 'Skip' => '', - 'Normal' => '', - ], - 'example' => 'Normal'."\n", - ], - 'Cron' => [ - 'description' => 'The CRON expression of the task. This parameter takes effect only if the Type parameter is set to Scheduler.'."\n", - 'type' => 'string', - 'example' => '00 00 00 * * ?', - ], - 'StartTime' => [ - 'description' => 'The start time of the time range during which the task is periodically scheduled. This parameter takes effect only if the Type parameter is set to Scheduler.'."\n", - 'type' => 'string', - 'example' => '1970-01-01 00:00:00'."\n", - ], - 'EndTime' => [ - 'description' => 'The end time of the time range during which the task is periodically scheduled. This parameter takes effect only if the Type parameter is set to Scheduler.'."\n", - 'type' => 'string', - 'example' => '9999-01-01 00:00:00'."\n", - ], - ], - ], - 'RuntimeResource' => [ - 'title' => '运行环境配置，如资源组信息', - 'description' => 'The configurations of the runtime environment, such as the resource group information.'."\n", - 'type' => 'object', - 'properties' => [ - 'ResourceGroupId' => [ - 'description' => 'The ID of the resource group for scheduling configured for task running.'."\n", - 'type' => 'string', - 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', - ], - 'Image' => [ - 'description' => 'The ID of the image configured for task running.'."\n", - 'type' => 'string', - 'example' => 'i-xxxxxx'."\n", - ], - 'Cu' => [ - 'description' => 'The default number of compute units (CUs) configured for task running.'."\n", - 'type' => 'string', - 'example' => '0.25', - ], - ], - ], - 'DataSource' => [ - 'title' => '数据源', - 'description' => 'The information about the associated data source.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the data source.'."\n", - 'type' => 'string', - 'example' => 'mysql_test'."\n", - ], - ], - ], - 'Id' => [ - 'description' => 'The task ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'ProjectId' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'ProjectEnv' => [ - 'description' => 'The environment of the workspace.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Prod: production environment'."\n" - .'* Dev: development environment'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Prod' => '', - 'Dev' => '', - ], - 'example' => 'Prod', - ], - 'Owner' => [ - 'description' => 'The account ID of the task owner.'."\n", - 'type' => 'string', - 'example' => '1000', - ], - 'CreateTime' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], - 'ModifyTime' => [ - 'description' => 'The modification time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], - 'CreateUser' => [ - 'description' => 'The account ID of the creator.'."\n", - 'type' => 'string', - 'example' => '1000', - ], - 'ModifyUser' => [ - 'description' => 'The account ID of the modifier.'."\n", - 'type' => 'string', - 'example' => '1000', - ], - 'ScriptParameters' => [ - 'description' => 'The list of script parameters.', - 'type' => 'string', - 'example' => 'para1=$bizdate para2=$[yyyymmdd] ', - ], - ], - 'description' => '', - ], - ], - ], - ], - ], + 'description' => 'The trigger type. Valid values:'."\n" + ."\n" + .'- Scheduler: scheduling cycle-based trigger'."\n" + ."\n" + .'- Manual: manual trigger', + 'enumValueTitles' => [], + 'type' => 'string', + 'enum' => ['Scheduler', 'Manual'], + 'required' => false, + 'example' => 'Normal'."\n", + 'title' => '', ], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\\\n\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 100,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Tasks\\": [\\n {\\n \\"Name\\": \\"SQL node\\\\n\\",\\n \\"Description\\": \\"test\\\\n\\",\\n \\"WorkflowId\\": 1234,\\n \\"InstanceMode\\": \\"T+1\\",\\n \\"Type\\": \\"ODPS_SQL\\",\\n \\"BaselineId\\": 1234,\\n \\"Priority\\": 1,\\n \\"Timeout\\": 3600,\\n \\"RerunMode\\": \\"AllAllowed\\\\n\\",\\n \\"RerunTimes\\": 3,\\n \\"RerunInterval\\": 60,\\n \\"Trigger\\": {\\n \\"Type\\": \\"Scheduler\\\\n\\",\\n \\"Recurrence\\": \\"Normal\\\\n\\",\\n \\"Cron\\": \\"00 00 00 * * ?\\",\\n \\"StartTime\\": \\"1970-01-01 00:00:00\\\\n\\",\\n \\"EndTime\\": \\"9999-01-01 00:00:00\\\\n\\"\\n },\\n \\"RuntimeResource\\": {\\n \\"ResourceGroupId\\": \\"S_res_group_524258031846018_1684XXXXXXXXX\\",\\n \\"Image\\": \\"i-xxxxxx\\\\n\\",\\n \\"Cu\\": \\"0.25\\"\\n },\\n \\"DataSource\\": {\\n \\"Name\\": \\"mysql_test\\\\n\\"\\n },\\n \\"Id\\": 1234,\\n \\"ProjectId\\": 100,\\n \\"ProjectEnv\\": \\"Prod\\",\\n \\"Owner\\": \\"1000\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"1000\\",\\n \\"ModifyUser\\": \\"1000\\",\\n \\"ScriptParameters\\": \\"para1=$bizdate para2=$[yyyymmdd] \\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListTasks', - ], - 'ListUpstreamTasks' => [ - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '240488', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - 'FEATUREdideD0YY7B', - 'FEATUREdideVFMENL', - ], - ], - 'parameters' => [ [ - 'name' => 'ProjectEnv', - 'in' => 'query', + 'name' => 'TriggerRecurrence', + 'in' => 'formData', 'schema' => [ - 'description' => 'The environment of the workspace. Valid values:'."\n" + 'description' => 'The running mode of the instance after it is triggered. This parameter takes effect only if the TriggerType parameter is set to Scheduler. Valid values:'."\n" + ."\n" + .'- Pause'."\n" + ."\n" + .'- Skip'."\n" ."\n" - .'* Prod: production environment'."\n" - .'* Dev: development environment'."\n", + .'- Normal', + 'enumValueTitles' => [], 'type' => 'string', - 'deprecated' => false, + 'enum' => ['Normal', 'Skip', 'Pause'], 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Prod', - 'default' => 'Prod', - 'enum' => [ - 'Prod', - 'Dev', - ], + 'example' => 'Normal', + 'title' => '', ], ], [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => 'The task ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234', - ], + 'name' => 'SortBy', + 'in' => 'formData', + 'schema' => ['description' => 'The field used for sorting. Fields such as TriggerTime and StartedTime are supported. The value of this parameter is in the Sort field + Sort by (Desc/Asc) format. By default, results are sorted in ascending order. Valid values:'."\n" + ."\n" + .'- `TriggerTime (Desc/Asc)`'."\n" + ."\n" + .'- `StartedTime (Desc/Asc)`'."\n" + ."\n" + .'- `FinishedTime (Desc/Asc)`'."\n" + ."\n" + .'- `CreateTime (Desc/Asc)`'."\n" + ."\n" + .'- `Id (Desc/Asc)`'."\n" + ."\n" + .' Default value: `Id Desc`.', 'type' => 'string', 'required' => false, 'example' => 'Id Desc', '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', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ 'name' => 'PageNumber', - 'in' => 'query', + 'in' => 'formData', + 'schema' => ['description' => 'The page number. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Status', + 'in' => 'formData', 'schema' => [ - 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The status of the task instance.'."\n" + ."\n" + .'- `NotRun`: Not started'."\n" + ."\n" + .'- `Running`'."\n" + ."\n" + .'- `Failure`'."\n" + ."\n" + .'- `Success`'."\n" + ."\n" + .'- `WaitTime`: Awaiting scheduled time'."\n" + ."\n" + .'- `WaitResource`: Awaiting resources', + 'type' => 'string', + 'enum' => ['NotRun', 'Running', 'Failure', 'Success', 'WaitTime', 'WaitResource'], 'required' => false, - 'example' => '1', + 'example' => 'Success', + 'title' => '', ], ], + [ + 'name' => 'Filter', + 'in' => 'formData', + 'schema' => ['description' => 'The filter. It is in JSON format, and multiple filter conditions are combined with a logical AND. Currently supported fields include: `startedTimeStart`, `startedTimeEnd`, `finishedTimeStart`, `finishedTimeEnd`, `createTimeStart`, `createTimeEnd`.', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "startedTimeStart": "1763481600000",'."\n" + .' "startedTimeEnd": "1763481600000",'."\n" + .' "finishedTimeStart": "1763481600000",'."\n" + .' "finishedTimeEnd": "1763481600000",'."\n" + .' "createTimeStart": "1763481600000",'."\n" + .' "createTimeEnd": "1763481600000"'."\n" + .'}'."\n", 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n", - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX', 'title' => ''], 'PagingInfo' => [ - 'description' => 'The pagination information.'."\n", + 'description' => 'Pagination information.', 'type' => 'object', 'properties' => [ - 'Tasks' => [ - 'description' => 'The tasks. This parameter is deprecated and replaced by the UpstreamTasks parameter.'."\n", + 'TaskInstances' => [ + 'description' => 'The list of task instances.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'The name of the task.'."\n", - 'type' => 'string', - 'example' => 'SQL node', - ], - 'Description' => [ - 'description' => 'The description of the task.'."\n", + 'TaskId' => ['description' => 'The ID of the task for which the instance is generated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'."\n", 'title' => ''], + 'TaskType' => ['description' => 'The type of the task for which the instance is generated.', 'type' => 'string', 'title' => '', 'example' => 'ODPS_SQL'."\n"], + 'TaskName' => ['description' => 'The name of the task for which the instance is generated.', 'type' => 'string', 'example' => 'SQL node'."\n", 'title' => ''], + 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'test'."\n", 'title' => ''], + 'WorkflowId' => ['description' => 'The ID of the workflow to which the instance belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'."\n", 'title' => ''], + 'WorkflowName' => ['description' => 'The name of the workflow to which the instance belongs.', 'type' => 'string', 'example' => 'Test workflow'."\n", 'title' => ''], + 'TriggerType' => [ + 'description' => 'The trigger type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- Scheduler: scheduling cycle-based trigger'."\n" + ."\n" + .'- Manual: manual trigger', + 'enumValueTitles' => [], 'type' => 'string', - 'example' => 'test', - ], - 'WorkflowId' => [ - 'description' => 'The ID of the workflow to which the task belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', + 'example' => 'Scheduler'."\n", + 'title' => '', ], - 'InstanceMode' => [ - 'description' => 'The instance generation mode. Valid values:'."\n" + 'TriggerRecurrence' => [ + 'description' => 'The running mode of the instance after it is triggered. This parameter takes effect only if the TriggerType parameter is set to Scheduler.'."\n" + ."\n" + .'Valid values:'."\n" ."\n" - .'* T+1'."\n" - .'* Immediately'."\n", + .'- Pause'."\n" + ."\n" + .'- Skip'."\n" + ."\n" + .'- Normal', + 'enumValueTitles' => [], 'type' => 'string', - 'example' => 'T+1', + 'example' => 'Normal'."\n", + 'title' => '', ], - 'Type' => [ - 'title' => '任务类型', - 'description' => 'The type of the task.'."\n", + 'WorkflowInstanceId' => ['description' => 'The workflow instance ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'UnifiedWorkflowInstanceId' => ['description' => 'Unified workflow instance ID. All task instances triggered under the same data timestamp share the same value for this field.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'WorkflowInstanceType' => [ + 'description' => 'The type of the workflow instance.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- SmokeTest'."\n" + ."\n" + .'- SupplementData'."\n" + ."\n" + .'- Manual'."\n" + ."\n" + .'- ManualWorkflow'."\n" + ."\n" + .'- Normal'."\n" + ."\n" + .'- ManualFlow', + 'enumValueTitles' => [], 'type' => 'string', - 'example' => 'ODPS_SQL'."\n", - ], - 'BaselineId' => [ - 'title' => '基线ID', - 'description' => 'The baseline ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'Priority' => [ - 'title' => '任务优先级，最大值8，最小值1', - 'description' => 'The priority of the task. Valid values: 1 to 8. A larger value indicates a higher priority. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Timeout' => [ - 'title' => '任务执行超时时间，单位秒', - 'description' => 'The timeout period of task running. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3600', + 'example' => 'Normal', + 'title' => '', ], + 'Timeout' => ['description' => 'The timeout period of task running. Unit: seconds.'."\n" + ."\n" + .'Note: The value of this parameter is rounded up by hour.', 'type' => 'integer', 'format' => 'int32', 'example' => '3600', 'title' => ''], 'RerunMode' => [ - 'title' => '任务是否允许重跑的配置', - 'description' => 'The rerun mode.'."\n" + 'description' => 'The rerun mode'."\n" ."\n" .'Valid values:'."\n" ."\n" - .'* AllDenied: The task cannot be rerun regardless of whether it is successfully run or fails to run.'."\n" - .'* FailureAllowed: The task can be rerun only after it fails to run.'."\n" - .'* AllAllowed: The task can be rerun regardless of whether it is successfully run or fails to run.'."\n", + .'- AllDenied: The task cannot be rerun regardless of whether the task is successfully run or fails to run.'."\n" + ."\n" + .'- FailureAllowed: The task can be rerun only after it fails to run.'."\n" + ."\n" + .'- AllAllowed: The task can be rerun regardless of whether the task is successfully run or fails to run.', + 'enumValueTitles' => [], 'type' => 'string', - 'enumValueTitles' => [ - 'AllDenied' => '', - 'FailureAllowed' => '', - 'AllAllowed' => '', - ], - 'example' => 'AllAllowed', - ], - 'RerunTimes' => [ - 'title' => '重试次数', - 'description' => 'The number of times that the task is rerun. This parameter takes effect only if the RerunMode parameter is set to AllAllowed or FailureAllowed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'RerunInterval' => [ - 'title' => '重试时间间隔，单位秒', - 'description' => 'The rerun interval. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', + 'title' => '', + 'example' => 'AllAllowed'."\n", ], - 'Trigger' => [ - 'title' => '任务触发方式', - 'description' => 'The method to trigger task scheduling.'."\n", + 'RunNumber' => ['description' => 'The number of times the task is run. By default, the value starts from 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PeriodNumber' => ['description' => 'The sequence number of the cycle. This parameter indicates the cycle of the task instance on the current day.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'BaselineId' => ['description' => 'The baseline ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'Priority' => ['description' => 'The priority of the task. Minimum value: 1. Maximum value: 8. A larger value indicates a higher priority. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RuntimeResource' => [ + 'description' => 'The information about the resource group with which the instance is associated.', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => 'The trigger type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Scheduler: scheduling cycle-based trigger'."\n" - .'* Manual: manual trigger'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Scheduler' => '', - 'Manual' => '', - ], - 'example' => 'Scheduler', - ], - 'Recurrence' => [ - 'description' => 'The running mode of the task after it is triggered. This parameter takes effect only if the Type parameter is set to Scheduler.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Pause'."\n" - .'* Skip'."\n" - .'* Normal'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Pause' => '', - 'Skip' => '', - 'Normal' => '', - ], - 'example' => 'Normal', - ], - 'Cron' => [ - 'description' => 'The CRON expression of the task. This parameter takes effect only if the Type parameter is set to Scheduler.'."\n", - 'type' => 'string', - 'example' => '00 00 00 * * ?'."\n", - ], - 'StartTime' => [ - 'description' => 'The start time of the time range during which the task is periodically scheduled. This parameter takes effect only if the Type parameter is set to Scheduler.'."\n", - 'type' => 'string', - 'example' => '1970-01-01 00:00:00'."\n", - ], - 'EndTime' => [ - 'description' => 'The end time of the time range during which the task is periodically scheduled. This parameter takes effect only if the Type parameter is set to Scheduler.'."\n", - 'type' => 'string', - 'example' => '9999-01-01 00:00:00'."\n", - ], - 'Timezone' => [ - 'description' => 'The time zone.'."\n", - 'type' => 'string', - 'example' => 'Asia/Shanghai', - ], + 'ResourceGroupId' => ['description' => 'The ID of the resource group for scheduling configured for task running.', 'type' => 'string', 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', 'title' => ''], + 'Image' => ['description' => 'The ID of the image configured for task running.', 'type' => 'string', 'example' => 'i-xxxxxx'."\n", 'title' => ''], + 'Cu' => ['description' => 'The default number of CUs configured for task running.', 'type' => 'string', 'example' => '0.25'."\n", 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'RuntimeResource' => [ - 'title' => '运行环境配置，如资源组信息', - 'description' => 'The configurations of the runtime environment, such as the resource group information.'."\n", + 'Runtime' => [ + 'description' => 'The runtime information about the instance.', 'type' => 'object', 'properties' => [ - 'ResourceGroupId' => [ - 'description' => 'The ID of the resource group for scheduling configured for task running.'."\n", - 'type' => 'string', - 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', - ], - 'Image' => [ - 'description' => 'The ID of the image configured for task running.'."\n", - 'type' => 'string', - 'example' => 'i-xxxxxx', - ], - 'Cu' => [ - 'description' => 'The default number of compute units (CUs) configured for task running.'."\n", - 'type' => 'string', - 'example' => '0.25', - ], + 'ProcessId' => ['description' => 'The instance run ID.', 'type' => 'string', 'example' => 'T3_123'."\n", 'title' => ''], + 'Gateway' => ['description' => 'The host for running.', 'type' => 'string', 'example' => 'cn-shanghai.1.2'."\n", 'title' => ''], ], + 'title' => '', + 'example' => '', ], 'DataSource' => [ - 'title' => '数据源', - 'description' => 'The information about the associated data source.'."\n", + 'description' => 'The information about the associated data source.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'The name of the data source.'."\n", - 'type' => 'string', - 'example' => 'mysql_test'."\n", - ], + 'Name' => ['description' => 'The name of the data source.', 'type' => 'string', 'example' => 'mysql_test'."\n", 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'Id' => [ - 'description' => 'The task ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234'."\n", - ], - 'ProjectId' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', + 'Status' => [ + 'description' => 'The status of the instance.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- NotRun: The instance is not run.'."\n" + ."\n" + .'- Running: The instance is running.'."\n" + ."\n" + .'- WaitTime: The instance is waiting for the scheduling time to arrive.'."\n" + ."\n" + .'- CheckingCondition: Branch conditions are being checked for the instance.'."\n" + ."\n" + .'- WaitResource: The instance is waiting for resources.'."\n" + ."\n" + .'- Failure: The instance fails to be run.'."\n" + ."\n" + .'- Success: The instance is successfully run.'."\n" + ."\n" + .'- Checking: Data quality is being checked for the instance.', + 'enumValueTitles' => [], + 'type' => 'string', + 'title' => '', + 'example' => 'Success', ], + 'TriggerTime' => ['description' => 'The scheduling time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'."\n", 'title' => ''], + 'Bizdate' => ['description' => 'The data timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'."\n", 'title' => ''], + 'StartedTime' => ['description' => 'The time when the instance started to run.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'."\n", 'title' => ''], + 'FinishedTime' => ['description' => 'The time when the instance finished running.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'."\n", 'title' => ''], + 'Id' => ['description' => 'The instance ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'."\n", 'title' => ''], + 'ProjectId' => ['description' => 'The DataWorks workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], 'ProjectEnv' => [ - 'description' => 'The environment of the workspace. This parameter is deprecated and replaced by the EnvType parameter.'."\n" + 'description' => 'The environment of the workspace.'."\n" ."\n" .'Valid values:'."\n" ."\n" - .'* Prod'."\n" - .'* Dev'."\n", - 'type' => 'string', - 'deprecated' => true, - 'enumValueTitles' => [ - 'Prod' => '', - 'Dev' => '', - ], - 'example' => 'Prod', - ], - 'EnvType' => [ - 'description' => 'The environment of the workspace. Valid values:'."\n" + .'- Prod: production environment'."\n" ."\n" - .'* Prod'."\n" - .'* Dev'."\n", + .'- Dev: development environment', + 'enumValueTitles' => [], 'type' => 'string', 'example' => 'Prod', + 'title' => '', ], - 'Owner' => [ - 'description' => 'The account ID of the task owner.'."\n", - 'type' => 'string', - 'example' => '1000', - ], - 'StepType' => [ - 'description' => 'The scheduling dependency type. Valid values:'."\n" - ."\n" - .'* Normal: same-cycle scheduling dependency'."\n" - .'* CrossCycle: cross-cycle scheduling dependency'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'CreateTime' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403'."\n", - ], - 'ModifyTime' => [ - 'description' => 'The modification time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403'."\n", - ], - 'CreateUser' => [ - 'description' => 'The account ID of the creator.'."\n", - 'type' => 'string', - 'example' => '1000', - ], - 'ModifyUser' => [ - 'description' => 'The account ID of the modifier.'."\n", - 'type' => 'string', - 'example' => '1000', - ], + 'Owner' => ['description' => 'The account ID of the task owner.', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'."\n", 'title' => ''], + 'ModifyTime' => ['description' => 'The modification time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'."\n", 'title' => ''], + 'CreateUser' => ['description' => 'The account ID of the user who creates the instance.', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'ModifyUser' => ['description' => 'The account ID of the user who modifies the instance.', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'ScriptParameters' => ['description' => 'The script parameter list.', 'type' => 'string', 'example' => 'para1=val1 para2=val2', 'title' => ''], + 'WaitingResourceTime' => ['description' => 'The timestamp for when it started waiting for resources.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + 'WaitingTriggerTime' => ['description' => 'The timestamp for when it started waiting for the scheduled time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'UpstreamTasks' => [ - 'description' => 'The ancestor tasks.'."\n", + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + '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' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"PagingInfo\\": {\\n \\"TaskInstances\\": [\\n {\\n \\"TaskId\\": 1234,\\n \\"TaskType\\": \\"ODPS_SQL\\\\n\\",\\n \\"TaskName\\": \\"SQL node\\\\n\\",\\n \\"Description\\": \\"test\\\\n\\",\\n \\"WorkflowId\\": 1234,\\n \\"WorkflowName\\": \\"Test workflow\\\\n\\",\\n \\"TriggerType\\": \\"Scheduler\\\\n\\",\\n \\"TriggerRecurrence\\": \\"Normal\\\\n\\",\\n \\"WorkflowInstanceId\\": 1234,\\n \\"UnifiedWorkflowInstanceId\\": 1234,\\n \\"WorkflowInstanceType\\": \\"Normal\\",\\n \\"Timeout\\": 3600,\\n \\"RerunMode\\": \\"AllAllowed\\\\n\\",\\n \\"RunNumber\\": 1,\\n \\"PeriodNumber\\": 1,\\n \\"BaselineId\\": 1234,\\n \\"Priority\\": 1,\\n \\"RuntimeResource\\": {\\n \\"ResourceGroupId\\": \\"S_res_group_524258031846018_1684XXXXXXXXX\\",\\n \\"Image\\": \\"i-xxxxxx\\\\n\\",\\n \\"Cu\\": \\"0.25\\\\n\\"\\n },\\n \\"Runtime\\": {\\n \\"ProcessId\\": \\"T3_123\\\\n\\",\\n \\"Gateway\\": \\"cn-shanghai.1.2\\\\n\\"\\n },\\n \\"DataSource\\": {\\n \\"Name\\": \\"mysql_test\\\\n\\"\\n },\\n \\"Status\\": \\"Success\\",\\n \\"TriggerTime\\": 1710239005403,\\n \\"Bizdate\\": 1710239005403,\\n \\"StartedTime\\": 1710239005403,\\n \\"FinishedTime\\": 1710239005403,\\n \\"Id\\": 1234,\\n \\"ProjectId\\": 100,\\n \\"ProjectEnv\\": \\"Prod\\",\\n \\"Owner\\": \\"1000\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"1000\\",\\n \\"ModifyUser\\": \\"1000\\",\\n \\"ScriptParameters\\": \\"para1=val1 para2=val2\\",\\n \\"WaitingResourceTime\\": 1710239005403,\\n \\"WaitingTriggerTime\\": 1710239005403\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1\\n }\\n}","type":"json"}]', + 'title' => 'ListTaskInstances', + 'description' => 'You must purchase DataWorks Basic Edition or a higher edition to use this feature.', + 'changeSet' => [ + ['createdAt' => '2025-05-23T02:37:51.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-01-21T03:12:29.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-11-21T01:59:29.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-11-20T07:55:32.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:ListTaskInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'TaskInstance', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:taskinstance/*'], + ], + ], + ], + ], + ], + 'ListTaskOperationLogs' => [ + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '240490', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB'], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234', 'title' => ''], + ], + [ + 'name' => 'Date', + 'in' => 'query', + 'schema' => ['description' => 'The operation date, accurate to the day. The default value is the current day. You can query only the operation logs generated within the previous 31 days.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1710239005403'."\n", 'title' => ''], + ], + [ + 'name' => 'ProjectEnv', + 'in' => 'query', + 'schema' => [ + 'description' => 'The environment of the workspace. Valid values:'."\n" + ."\n" + .'- Prod: production environment'."\n" + ."\n" + .'- Dev: development environment', + 'enumValueTitles' => [], + 'type' => 'string', + 'default' => 'Prod', + 'enum' => ['Prod', 'Dev'], + 'required' => false, + 'example' => 'Prod', + 'title' => '', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n", 'title' => ''], + 'PagingInfo' => [ + 'description' => 'The pagination information.', + 'type' => 'object', + 'properties' => [ + 'OperationLogs' => [ + 'description' => 'The operation logs.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'DependencyType' => [ - 'title' => '依赖类型', - 'description' => 'The scheduling dependency type. Valid values:'."\n" - ."\n" - .'* Normal: same-cycle scheduling dependency'."\n" - .'* CrossCycle: cross-cycle scheduling dependency'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'Task' => [ - 'description' => 'The information about the task.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the task.'."\n", - 'type' => 'string', - 'example' => 'SQL node', - ], - 'Description' => [ - 'description' => 'The description of the task.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'WorkflowId' => [ - 'description' => 'The ID of the workflow to which the task belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'InstanceMode' => [ - 'description' => 'The instance generation mode. Valid values:'."\n" - ."\n" - .'* T+1'."\n" - .'* Immediately'."\n", - 'type' => 'string', - 'example' => 'T+1', - ], - 'Type' => [ - 'title' => '任务类型', - 'description' => 'The type of the task.'."\n", - 'type' => 'string', - 'example' => 'ODPS_SQL', - ], - 'BaselineId' => [ - 'title' => '基线ID', - 'description' => 'The baseline ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'Priority' => [ - 'title' => '任务优先级，最大值8，最小值1', - 'description' => 'The priority of the task. Valid values: 1 to 8.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Timeout' => [ - 'title' => '任务执行超时时间，单位秒', - 'description' => 'The timeout period of task running. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3600', - ], - 'RerunMode' => [ - 'title' => '任务是否允许重跑的配置', - 'description' => 'The rerun mode. Valid values:'."\n" - ."\n" - .'* AllDenied: The task cannot be rerun regardless of whether the task is successfully run or fails to run.'."\n" - .'* FailureAllowed: The task can be rerun only after it fails to run.'."\n" - .'* AllAllowed: The task can be rerun regardless of whether the task is successfully run or fails to run.'."\n", - 'type' => 'string', - 'example' => 'AllAllowed'."\n", - ], - 'RerunTimes' => [ - 'title' => '重试次数', - 'description' => 'The number of times that the task is rerun. This parameter takes effect only if the RerunMode parameter is set to AllAllowed or FailureAllowed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'RerunInterval' => [ - 'title' => '重试时间间隔，单位秒', - 'description' => 'The rerun interval. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - ], - 'Trigger' => [ - 'title' => '任务触发方式', - 'description' => 'The trigger method.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The trigger type. Valid values:'."\n" - ."\n" - .'* Scheduler: scheduling cycle-based trigger'."\n" - .'* Manual: manual trigger'."\n", - 'type' => 'string', - 'example' => 'Scheduler', - ], - 'Recurrence' => [ - 'description' => 'The running mode of the task after it is triggered. This parameter takes effect only if the Type parameter is set to Scheduler. Valid values:'."\n" - ."\n" - .'* Pause'."\n" - .'* Skip'."\n" - .'* Normal'."\n", - 'type' => 'string', - 'example' => 'Normal'."\n", - ], - 'Cron' => [ - 'description' => 'The CRON expression. This parameter takes effect only if the Type parameter is set to Scheduler.'."\n", - 'type' => 'string', - 'example' => '00 00 00 * * ?', - ], - 'StartTime' => [ - 'description' => 'The start time of the time range during which the task is periodically scheduled. This parameter takes effect only if the Type parameter is set to Scheduler.'."\n", - 'type' => 'string', - 'example' => '1970-01-01 00:00:00', - ], - 'EndTime' => [ - 'description' => 'The end time of the time range during which the task is periodically scheduled. This parameter takes effect only if the Type parameter is set to Scheduler.'."\n", - 'type' => 'string', - 'example' => '9999-01-01 00:00:00', - ], - 'Timezone' => [ - 'description' => 'The time zone.'."\n", - 'type' => 'string', - 'example' => 'Asia/Shanghai', - ], - ], - ], - 'RuntimeResource' => [ - 'title' => '运行环境配置，如资源组信息', - 'description' => 'The configurations of the runtime environment, such as the resource group information.'."\n", - 'type' => 'object', - 'properties' => [ - 'ResourceGroupId' => [ - 'description' => 'The ID of the resource group for scheduling configured for task running.'."\n", - 'type' => 'string', - 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', - ], - 'Image' => [ - 'description' => 'The ID of the image configured for task running.'."\n", - 'type' => 'string', - 'example' => 'i-xxxxxx', - ], - 'Cu' => [ - 'description' => 'The default number of compute units (CUs) configured for task running.'."\n", - 'type' => 'string', - 'example' => '0.25', - ], - ], - ], - 'DataSource' => [ - 'title' => '数据源', - 'description' => 'The information about the associated data source.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the data source.'."\n", - 'type' => 'string', - 'example' => 'mysql_test', - ], - ], - ], - 'Id' => [ - 'description' => 'The task ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'ProjectId' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'EnvType' => [ - 'description' => 'The environment of the workspace. Valid values:'."\n" - ."\n" - .'* Prod'."\n" - .'* Dev'."\n", - 'type' => 'string', - 'example' => 'Prod', - ], - 'Owner' => [ - 'description' => 'The account ID of the task owner.'."\n", - 'type' => 'string', - 'example' => '1000', - ], - 'CreateTime' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], - 'ModifyTime' => [ - 'description' => 'The modification time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], - 'CreateUser' => [ - 'description' => 'The account ID of the creator.'."\n", - 'type' => 'string', - 'example' => '1000', - ], - 'ModifyUser' => [ - 'description' => 'The account ID of the modifier.'."\n", - 'type' => 'string', - 'example' => '1000', - ], - ], - ], + 'User' => ['description' => 'The account ID of the operator.', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the operation log was generated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'."\n", 'title' => ''], + 'OperationSeq' => ['description' => 'The serial number of the operation.', 'type' => 'integer', 'format' => 'int64', 'example' => '1111', 'title' => ''], + 'OperationContent' => ['description' => 'The operation content.', 'type' => 'string', 'example' => 'Freeze tasks', 'title' => ''], + 'TaskId' => ['description' => 'The ID of the task on which the operation was performed.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - '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 entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + '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' => ''], ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\\\n\\",\\n \\"PagingInfo\\": {\\n \\"Tasks\\": [\\n {\\n \\"Name\\": \\"SQL node\\\\n\\",\\n \\"Description\\": \\"test\\",\\n \\"WorkflowId\\": 1234,\\n \\"InstanceMode\\": \\"T+1\\",\\n \\"Type\\": \\"ODPS_SQL\\\\n\\",\\n \\"BaselineId\\": 1234,\\n \\"Priority\\": 1,\\n \\"Timeout\\": 3600,\\n \\"RerunMode\\": \\"AllAllowed\\",\\n \\"RerunTimes\\": 3,\\n \\"RerunInterval\\": 60,\\n \\"Trigger\\": {\\n \\"Type\\": \\"Scheduler\\",\\n \\"Recurrence\\": \\"Normal\\",\\n \\"Cron\\": \\"00 00 00 * * ?\\\\n\\",\\n \\"StartTime\\": \\"1970-01-01 00:00:00\\\\n\\",\\n \\"EndTime\\": \\"9999-01-01 00:00:00\\\\n\\",\\n \\"Timezone\\": \\"Asia/Shanghai\\"\\n },\\n \\"RuntimeResource\\": {\\n \\"ResourceGroupId\\": \\"S_res_group_524258031846018_1684XXXXXXXXX\\",\\n \\"Image\\": \\"i-xxxxxx\\",\\n \\"Cu\\": \\"0.25\\"\\n },\\n \\"DataSource\\": {\\n \\"Name\\": \\"mysql_test\\\\n\\"\\n },\\n \\"Id\\": 1234,\\n \\"ProjectId\\": 100,\\n \\"ProjectEnv\\": \\"Prod\\",\\n \\"EnvType\\": \\"Prod\\",\\n \\"Owner\\": \\"1000\\",\\n \\"StepType\\": \\"Normal\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"1000\\",\\n \\"ModifyUser\\": \\"1000\\"\\n }\\n ],\\n \\"UpstreamTasks\\": [\\n {\\n \\"DependencyType\\": \\"Normal\\",\\n \\"Task\\": {\\n \\"Name\\": \\"SQL node\\",\\n \\"Description\\": \\"test\\",\\n \\"WorkflowId\\": 1234,\\n \\"InstanceMode\\": \\"T+1\\",\\n \\"Type\\": \\"ODPS_SQL\\",\\n \\"BaselineId\\": 1234,\\n \\"Priority\\": 1,\\n \\"Timeout\\": 3600,\\n \\"RerunMode\\": \\"AllAllowed\\\\n\\",\\n \\"RerunTimes\\": 3,\\n \\"RerunInterval\\": 60,\\n \\"Trigger\\": {\\n \\"Type\\": \\"Scheduler\\",\\n \\"Recurrence\\": \\"Normal\\\\n\\",\\n \\"Cron\\": \\"00 00 00 * * ?\\",\\n \\"StartTime\\": \\"1970-01-01 00:00:00\\",\\n \\"EndTime\\": \\"9999-01-01 00:00:00\\",\\n \\"Timezone\\": \\"Asia/Shanghai\\"\\n },\\n \\"RuntimeResource\\": {\\n \\"ResourceGroupId\\": \\"S_res_group_524258031846018_1684XXXXXXXXX\\",\\n \\"Image\\": \\"i-xxxxxx\\",\\n \\"Cu\\": \\"0.25\\"\\n },\\n \\"DataSource\\": {\\n \\"Name\\": \\"mysql_test\\"\\n },\\n \\"Id\\": 1234,\\n \\"ProjectId\\": 100,\\n \\"EnvType\\": \\"Prod\\",\\n \\"Owner\\": \\"1000\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"1000\\",\\n \\"ModifyUser\\": \\"1000\\"\\n }\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1\\n }\\n}","type":"json"}]', - 'title' => 'ListUpstreamTasks', - 'summary' => 'Queries a list of ancestor tasks of a task by page.', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", - ], - 'ListDownstreamTasks' => [ - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\\\n\\",\\n \\"PagingInfo\\": {\\n \\"OperationLogs\\": [\\n {\\n \\"User\\": \\"1000\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"OperationSeq\\": 1111,\\n \\"OperationContent\\": \\"Freeze tasks\\",\\n \\"TaskId\\": 1234\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1\\n }\\n}","type":"json"}]', + 'title' => 'ListTaskOperationLogs', + 'summary' => 'Retrieves a paginated list of operation logs for a task.', + 'description' => 'This API operation is available for all DataWorks editions.'."\n" + ."\n" + .'Only operation logs generated within the previous 31 days can be queried.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:ListTaskOperationLogs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListTasks' => [ + 'summary' => 'Queries a list of tasks by page. You can also specify filter conditions to query tasks.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '240489', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - 'FEATUREdideD0YY7B', - 'FEATUREdideVFMENL', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238059', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB', 'FEATUREdideD0YY7B', 'FEATUREdideVFMENL'], ], 'parameters' => [ - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => 'The task ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234', - ], - ], [ 'name' => 'ProjectEnv', - 'in' => 'query', + 'in' => 'formData', 'schema' => [ - 'description' => 'The environment of the workspace.'."\n" + 'description' => 'The workspace environment.'."\n" ."\n" .'Valid values:'."\n" ."\n" - .'* Prod: production environment'."\n" - .'* Dev: development environment'."\n", + .'- Prod'."\n" + ."\n" + .'- Dev', + 'enumValueTitles' => ['Prod' => '', 'Dev' => ''], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [ - 'Prod' => '', - 'Dev' => '', - ], - 'example' => 'Prod', 'default' => 'Prod', - 'enum' => [ - 'Prod', - 'Dev', - ], + 'enum' => ['Prod', 'Dev'], + 'example' => 'Prod', + 'title' => '', ], ], [ - 'name' => 'PageSize', - 'in' => 'query', + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '100', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the task. Fuzzy match is supported.', 'type' => 'string', 'required' => false, 'example' => 'SQL node'."\n", 'title' => ''], + ], + [ + 'name' => 'Ids', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The ID of the task.', + 'type' => 'array', + 'items' => ['description' => 'The account ID of the owner of the task.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234', 'title' => ''], 'required' => false, - 'example' => '10', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'PageNumber', - 'in' => 'query', + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => ['description' => 'The account ID of the task owner.', 'type' => 'string', 'required' => false, 'example' => '1000', 'title' => ''], + ], + [ + 'name' => 'TaskType', + 'in' => 'formData', + 'schema' => ['description' => 'The type of the task. Valid values:'."\n" + ."\n" + .'- ODPS\\_SQL'."\n" + ."\n" + .'- SPARK'."\n" + ."\n" + .'- PY\\_ODPS'."\n" + ."\n" + .'- PY\\_ODPS3'."\n" + ."\n" + .'- ODPS\\_SCRIPT'."\n" + ."\n" + .'- ODPS\\_MR'."\n" + ."\n" + .'- COMPONENT\\_SQL'."\n" + ."\n" + .'- EMR\\_HIVE'."\n" + ."\n" + .'- EMR\\_MR'."\n" + ."\n" + .'- EMR\\_SPARK\\_SQL'."\n" + ."\n" + .'- EMR\\_SPARK'."\n" + ."\n" + .'- EMR\\_SHELL'."\n" + ."\n" + .'- EMR\\_PRESTO'."\n" + ."\n" + .'- EMR\\_IMPALA'."\n" + ."\n" + .'- SPARK\\_STREAMING'."\n" + ."\n" + .'- EMR\\_KYUUBI'."\n" + ."\n" + .'- EMR\\_TRINO'."\n" + ."\n" + .'- HOLOGRES\\_SQL'."\n" + ."\n" + .'- HOLOGRES\\_SYNC\\_DDL'."\n" + ."\n" + .'- HOLOGRES\\_SYNC\\_DATA', 'type' => 'string', 'required' => false, 'example' => 'ODPS_SQL'."\n", 'title' => ''], + ], + [ + 'name' => 'RuntimeResource', + 'in' => 'formData', + 'schema' => ['description' => 'The information about the resource group. Set this parameter to the ID of a resource group for scheduling.', 'type' => 'string', 'required' => false, 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', 'title' => ''], + ], + [ + 'name' => 'WorkflowId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the workflow to which the task belongs.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234', 'title' => ''], + ], + [ + 'name' => 'TriggerType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The trigger type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- Scheduler: Triggered by schedule.'."\n" + ."\n" + .'- Manual: Triggered manually.', + 'enumValueTitles' => ['Scheduler' => '', 'Manual' => ''], + 'type' => 'string', + 'enum' => ['Scheduler', 'Manual'], + 'required' => false, + 'example' => 'Scheduler'."\n", + 'title' => '', + ], + ], + [ + 'name' => 'TriggerRecurrence', + 'in' => 'formData', 'schema' => [ - 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The run mode when triggered. Valid only if TriggerType is Scheduler.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- Pause'."\n" + ."\n" + .'- Skip'."\n" + ."\n" + .'- Normal', + 'enumValueTitles' => ['Pause' => '', 'Skip' => '', 'Normal' => ''], + 'type' => 'string', + 'enum' => ['Normal', 'Skip', 'Pause'], 'required' => false, - 'example' => '1', + 'example' => 'Normal'."\n", + 'title' => '', ], ], + [ + 'name' => 'SortBy', + 'in' => 'formData', + 'schema' => ['description' => 'The field that is used to sort tasks. This parameter is configured in the format of "Sorting field Sorting order". You can set the sorting order to Desc or Asc. If you do not specify the sorting order, Asc is used by default. Valid values:'."\n" + ."\n" + .'- `ModifyTime (Desc/Asc)`'."\n" + ."\n" + .'- `CreateTime (Desc/Asc)`'."\n" + ."\n" + .'- `Id (Desc/Asc)`'."\n" + ."\n" + .' Default value: `Id Desc`.', 'type' => 'string', 'required' => false, 'example' => 'Id Desc', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => ['description' => 'The page number. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'ResultModel', + 'description' => 'ResultModel', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n", 'title' => ''], 'PagingInfo' => [ - 'description' => 'The pagination information.'."\n", + 'description' => 'The pagination information.', 'type' => 'object', 'properties' => [ + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + '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' => ''], 'Tasks' => [ - 'description' => 'The tasks. This parameter is deprecated and replaced by the DownstreamTasks parameter.'."\n", + 'description' => 'The tasks.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'The name of the task.'."\n", - 'type' => 'string', - 'example' => 'SQL node', - ], - 'Description' => [ - 'description' => 'The description of the task.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'WorkflowId' => [ - 'description' => 'The ID of the workflow to which the task belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'InstanceMode' => [ - 'description' => 'The instance generation mode. Valid values:'."\n" - ."\n" - .'* T+1'."\n" - .'* Immediately'."\n", - 'type' => 'string', - 'example' => 'T+1', - ], - 'Type' => [ - 'title' => '任务类型', - 'description' => 'The type of the task.'."\n", - 'type' => 'string', - 'example' => 'ODPS_SQL', - ], - 'BaselineId' => [ - 'title' => '基线ID', - 'description' => 'The baseline ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'Priority' => [ - 'title' => '任务优先级，最大值8，最小值1', - 'description' => 'The priority of the task. Valid values: 1 to 8. A larger value indicates a higher priority. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Timeout' => [ - 'title' => '任务执行超时时间，单位秒', - 'description' => 'The timeout period of task running. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3600', - ], + 'Name' => ['description' => 'The name of the task.', 'type' => 'string', 'example' => 'SQL node'."\n", 'title' => ''], + 'Description' => ['description' => 'The description of the task.', 'type' => 'string', 'example' => 'test'."\n", 'title' => ''], + 'WorkflowId' => ['description' => 'The ID of the workflow to which the task belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'InstanceMode' => ['description' => 'The instance generation mode. Valid values:'."\n" + ."\n" + .'- T+1'."\n" + ."\n" + .'- Immediately', 'type' => 'string', 'example' => 'T+1', 'title' => ''], + 'Type' => ['description' => 'The type of the task.', 'type' => 'string', 'title' => '', 'example' => 'ODPS_SQL'], + 'BaselineId' => ['description' => 'The baseline ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1234'], + 'Priority' => ['description' => 'The priority of the task. Valid values: 1 to 8. A larger value indicates a higher priority. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'Timeout' => ['description' => 'The timeout period of task running. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '3600'], 'RerunMode' => [ - 'title' => '任务是否允许重跑的配置', 'description' => 'The rerun mode.'."\n" ."\n" .'Valid values:'."\n" ."\n" - .'* AllDenied: The task cannot be rerun regardless of whether it is successfully run or fails to run.'."\n" - .'* FailureAllowed: The task can be rerun only after it fails to run.'."\n" - .'* AllAllowed: The task can be rerun regardless of whether it is successfully run or fails to run.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'AllDenied' => '', - 'FailureAllowed' => '', - 'AllAllowed' => '', - ], - 'example' => 'AllAllowed', - ], - 'RerunTimes' => [ - 'title' => '重试次数', - 'description' => 'The number of times that the task is rerun. This parameter takes effect only if the RerunMode parameter is set to AllAllowed or FailureAllowed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'RerunInterval' => [ - 'title' => '重试时间间隔，单位秒', - 'description' => 'The rerun interval. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - ], - 'Trigger' => [ - 'title' => '任务触发方式', - 'description' => 'The method to trigger task scheduling.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The trigger type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Scheduler: scheduling cycle-based trigger'."\n" - .'* Manual: manual trigger'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Scheduler' => '', - 'Manual' => '', - ], - 'example' => 'Scheduler', - ], - 'Recurrence' => [ - 'description' => 'The running mode of the task after it is triggered. This parameter takes effect only if the Type parameter is set to Scheduler.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Pause'."\n" - .'* Skip'."\n" - .'* Normal'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Pause' => '', - 'Skip' => '', - 'Normal' => '', - ], - 'example' => 'Normal'."\n", - ], - 'Cron' => [ - 'description' => 'The CRON expression of the task. This parameter takes effect only if the Type parameter is set to Scheduler.'."\n", - 'type' => 'string', - 'example' => '00 00 00 * * ?', - ], - 'StartTime' => [ - 'description' => 'The start time of the time range during which the task is periodically scheduled. This parameter takes effect only if the Type parameter is set to Scheduler.'."\n", - 'type' => 'string', - 'example' => '1970-01-01 00:00:00', - ], - 'EndTime' => [ - 'description' => 'The end time of the time range during which the task is periodically scheduled. This parameter takes effect only if the Type parameter is set to Scheduler.'."\n", - 'type' => 'string', - 'example' => '9999-01-01 00:00:00', - ], - 'Timezone' => [ - 'description' => 'The time zone.'."\n", - 'type' => 'string', - 'example' => 'Asia/Shanghai', - ], - ], - ], - 'RuntimeResource' => [ - 'title' => '运行环境配置，如资源组信息', - 'description' => 'The configurations of the runtime environment, such as the resource group information.'."\n", - 'type' => 'object', - 'properties' => [ - 'ResourceGroupId' => [ - 'description' => 'The ID of the resource group for scheduling configured for task running.'."\n", - 'type' => 'string', - 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX'."\n", - ], - 'Image' => [ - 'description' => 'The ID of the image configured for task running.'."\n", - 'type' => 'string', - 'example' => 'i-xxxxxx', - ], - 'Cu' => [ - 'description' => 'The default number of compute units (CUs) configured for task running.'."\n", - 'type' => 'string', - 'example' => '0.25', - ], - ], - ], - 'DataSource' => [ - 'title' => '数据源', - 'description' => 'The information about the associated data source.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the data source.'."\n", - 'type' => 'string', - 'example' => 'mysql_test'."\n", - ], - ], - ], - 'Id' => [ - 'description' => 'The task ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'ProjectId' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'ProjectEnv' => [ - 'description' => 'The environment of the workspace. This parameter is deprecated and replaced by the EnvType parameter.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Prod'."\n" - .'* Dev'."\n", - 'type' => 'string', - 'deprecated' => true, - 'enumValueTitles' => [ - 'Prod' => '', - 'Dev' => '', - ], - 'example' => 'Prod', - ], - 'EnvType' => [ - 'description' => 'The environment of the workspace. Valid values:'."\n" - ."\n" - .'* Prod'."\n" - .'* Dev'."\n", - 'type' => 'string', - 'example' => 'Prod', - ], - 'Owner' => [ - 'description' => 'The account ID of the task owner.'."\n", - 'type' => 'string', - 'example' => '1000', - ], - 'StepType' => [ - 'description' => 'The scheduling dependency type. Valid values:'."\n" + .'- AllDenied: The task cannot be rerun regardless of whether the task is successfully run or fails to run.'."\n" ."\n" - .'* Normal: same-cycle scheduling dependency'."\n" - .'* CrossCycle: cross-cycle scheduling dependency'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'CreateTime' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], - 'ModifyTime' => [ - 'description' => 'The modification time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], - 'CreateUser' => [ - 'description' => 'The account ID of the creator.'."\n", - 'type' => 'string', - 'example' => '1000', - ], - 'ModifyUser' => [ - 'description' => 'The account ID of the modifier.'."\n", - 'type' => 'string', - 'example' => '1000', - ], - ], - 'description' => '', - ], - ], - 'DownstreamTasks' => [ - 'description' => 'The descendant tasks.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DependencyType' => [ - 'title' => '依赖类型', - 'description' => 'The scheduling dependency type. Valid values:'."\n" + .'- FailureAllowed: The task can be rerun only after it fails to run.'."\n" ."\n" - .'* Normal: same-cycle scheduling dependency'."\n" - .'* CrossCycle: cross-cycle scheduling dependency'."\n", + .'- AllAllowed: The task can be rerun regardless of whether it is successfully run or fails to run.', + 'enumValueTitles' => ['AllDenied' => '', 'FailureAllowed' => '', 'AllAllowed' => ''], 'type' => 'string', - 'example' => 'Normal', + 'title' => '', + 'example' => 'AllAllowed'."\n", ], - 'Task' => [ - 'description' => 'The information about the task.'."\n", + 'RerunTimes' => ['description' => 'The number of times that the task is rerun. This parameter takes effect only if the RerunMode parameter is set to AllAllowed or FailureAllowed.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '3'], + 'RerunInterval' => ['description' => 'The rerun interval. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '60'], + 'Trigger' => [ + 'title' => '', + 'description' => 'The method to trigger task scheduling.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'The name of the task.'."\n", - 'type' => 'string', - 'example' => 'SQL node', - ], - 'Description' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'WorkflowId' => [ - 'description' => 'The ID of the workflow to which the task belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'InstanceMode' => [ - 'description' => 'The instance generation mode. Valid values:'."\n" - ."\n" - .'* T+1'."\n" - .'* Immediately'."\n", - 'type' => 'string', - 'example' => 'T+1', - ], - 'Type' => [ - 'title' => '任务类型', - 'description' => 'The type of the task.'."\n", - 'type' => 'string', - 'example' => 'ODPS_SQL', - ], - 'BaselineId' => [ - 'title' => '基线ID', - 'description' => 'The baseline ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'Priority' => [ - 'title' => '任务优先级，最大值8，最小值1', - 'description' => 'The priority of the task. Valid values: 1 to 8.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Timeout' => [ - 'title' => '任务执行超时时间，单位秒', - 'description' => 'The timeout period of task running. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3600', - ], - 'RerunMode' => [ - 'title' => '任务是否允许重跑的配置', - 'description' => 'The rerun mode. Valid values:'."\n" - ."\n" - .'* AllDenied: The task cannot be rerun regardless of whether the task is successfully run or fails to run.'."\n" - .'* FailureAllowed: The task can be rerun only after it fails to run.'."\n" - .'* AllAllowed: The task can be rerun regardless of whether it is successfully run or fails to run.'."\n", - 'type' => 'string', - 'example' => 'AllAllowed', - ], - 'RerunTimes' => [ - 'title' => '重试次数', - 'description' => 'The number of times that the task is rerun. This parameter takes effect only if the RerunMode parameter is set to AllAllowed or FailureAllowed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'RerunInterval' => [ - 'title' => '重试时间间隔，单位秒', - 'description' => 'The rerun interval. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - ], - 'Trigger' => [ - 'title' => '任务触发方式', - 'description' => 'The trigger method.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The trigger type. Valid values:'."\n" - ."\n" - .'* Scheduler: scheduling cycle-based trigger'."\n" - .'* Manual: manual trigger'."\n", - 'type' => 'string', - 'example' => 'Scheduler', - ], - 'Recurrence' => [ - 'description' => 'The running mode of the task after it is triggered. This parameter takes effect only if the Type parameter is set to Scheduler. Valid values:'."\n" - ."\n" - .'* Pause'."\n" - .'* Skip'."\n" - .'* Normal'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'Cron' => [ - 'description' => 'The CRON expression. This parameter takes effect only if the Type parameter is set to Scheduler.'."\n", - 'type' => 'string', - 'example' => '00 00 00 * * ?', - ], - 'StartTime' => [ - 'description' => 'The start time of the time range during which the task is periodically scheduled. This parameter takes effect only if the Type parameter is set to Scheduler.'."\n", - 'type' => 'string', - 'example' => '1970-01-01 00:00:00', - ], - 'EndTime' => [ - 'description' => 'The end time of the time range during which the task is periodically scheduled. This parameter takes effect only if the Type parameter is set to Scheduler.'."\n", - 'type' => 'string', - 'example' => '9999-01-01 00:00:00', - ], - 'Timezone' => [ - 'description' => 'The time zone.'."\n", - 'type' => 'string', - 'example' => 'Asia/Shanghai', - ], - ], - ], - 'RuntimeResource' => [ - 'title' => '运行环境配置，如资源组信息', - 'description' => 'The configurations of the runtime environment, such as the resource group information.'."\n", - 'type' => 'object', - 'properties' => [ - 'ResourceGroupId' => [ - 'description' => 'The ID of the resource group for scheduling configured for task running.'."\n", - 'type' => 'string', - 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', - ], - 'Image' => [ - 'description' => 'The ID of the image configured for task running.'."\n", - 'type' => 'string', - 'example' => 'i-xxxxxx', - ], - 'Cu' => [ - 'description' => 'The default number of compute units (CUs) configured for task running.'."\n", - 'type' => 'string', - 'example' => '0.25', - ], - ], - ], - 'DataSource' => [ - 'title' => '数据源', - 'description' => 'The information about the associated data source.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the data source.'."\n", - 'type' => 'string', - 'example' => 'mysql_test', - ], - ], - ], - 'Id' => [ - 'description' => 'The task ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'ProjectId' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'EnvType' => [ - 'description' => 'The environment of the workspace. Valid values:'."\n" + 'Type' => [ + 'description' => 'The trigger type.'."\n" ."\n" - .'* Prod'."\n" - .'* Dev'."\n", - 'type' => 'string', - 'example' => 'Prod', - ], - 'Owner' => [ - 'description' => 'The account ID of the task owner.'."\n", - 'type' => 'string', - 'example' => '1000', - ], - 'CreateTime' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], - 'ModifyTime' => [ - 'description' => 'The modification time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], - 'CreateUser' => [ - 'description' => 'The account ID of the creator.'."\n", + .'Valid values:'."\n" + ."\n" + .'- Scheduler: scheduling cycle-based trigger'."\n" + ."\n" + .'- Manual: manual trigger', + 'enumValueTitles' => ['Scheduler' => '', 'Manual' => ''], 'type' => 'string', - 'example' => '1000', + 'example' => 'Scheduler'."\n", + 'title' => '', ], - 'ModifyUser' => [ - 'description' => 'The account ID of the modifier.'."\n", + 'Recurrence' => [ + 'description' => 'The running mode of the task after it is triggered. This parameter takes effect only if the Type parameter is set to Scheduler.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- Pause'."\n" + ."\n" + .'- Skip'."\n" + ."\n" + .'- Normal', + 'enumValueTitles' => ['Pause' => '', 'Skip' => '', 'Normal' => ''], 'type' => 'string', - 'example' => '1000', + 'example' => 'Normal'."\n", + 'title' => '', ], + 'Cron' => ['description' => 'The CRON expression of the task. This parameter takes effect only if the Type parameter is set to Scheduler.', 'type' => 'string', 'example' => '00 00 00 * * ?', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the time range during which the task is periodically scheduled. This parameter takes effect only if the Type parameter is set to Scheduler.', 'type' => 'string', 'example' => '1970-01-01 00:00:00'."\n", 'title' => ''], + 'EndTime' => ['description' => 'The end time of the time range during which the task is periodically scheduled. This parameter takes effect only if the Type parameter is set to Scheduler.', 'type' => 'string', 'example' => '9999-01-01 00:00:00'."\n", 'title' => ''], + ], + 'example' => '', + ], + 'RuntimeResource' => [ + 'title' => '', + 'description' => 'The configurations of the runtime environment, such as the resource group information.', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupId' => ['description' => 'The ID of the resource group for scheduling configured for task running.', 'type' => 'string', 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', 'title' => ''], + 'Image' => ['description' => 'The ID of the image configured for task running.', 'type' => 'string', 'example' => 'i-xxxxxx'."\n", 'title' => ''], + 'Cu' => ['description' => 'The default number of compute units (CUs) configured for task running.', 'type' => 'string', 'example' => '0.25', 'title' => ''], + ], + 'example' => '', + ], + 'DataSource' => [ + 'title' => '', + 'description' => 'The information about the associated data source.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the data source.', 'type' => 'string', 'example' => 'mysql_test'."\n", 'title' => ''], ], + 'example' => '', + ], + 'Id' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'ProjectId' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'ProjectEnv' => [ + 'description' => 'The environment of the workspace.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- Prod: production environment'."\n" + ."\n" + .'- Dev: development environment', + 'enumValueTitles' => ['Prod' => '', 'Dev' => ''], + 'type' => 'string', + 'example' => 'Prod', + 'title' => '', ], + 'Owner' => ['description' => 'The account ID of the task owner.', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + 'ModifyTime' => ['description' => 'The modification time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + 'CreateUser' => ['description' => 'The account ID of the creator.', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'ModifyUser' => ['description' => 'The account ID of the modifier.', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'ScriptParameters' => ['description' => 'The list of script parameters.', 'type' => 'string', 'example' => 'para1=$bizdate para2=$[yyyymmdd] ', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - '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', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListTasks', + 'description' => 'DataWorks Basic Edition or higher is required.', + 'changeSet' => [ + ['createdAt' => '2025-01-21T03:12:29.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-01-15T02:50:51.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-01-06T09:33:04.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-11-20T07:55:32.000Z', 'description' => 'Response parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"PagingInfo\\": {\\n \\"Tasks\\": [\\n {\\n \\"Name\\": \\"SQL node\\\\n\\",\\n \\"Description\\": \\"test\\",\\n \\"WorkflowId\\": 1234,\\n \\"InstanceMode\\": \\"T+1\\",\\n \\"Type\\": \\"ODPS_SQL\\",\\n \\"BaselineId\\": 1234,\\n \\"Priority\\": 1,\\n \\"Timeout\\": 3600,\\n \\"RerunMode\\": \\"AllAllowed\\",\\n \\"RerunTimes\\": 3,\\n \\"RerunInterval\\": 60,\\n \\"Trigger\\": {\\n \\"Type\\": \\"Scheduler\\",\\n \\"Recurrence\\": \\"Normal\\\\n\\",\\n \\"Cron\\": \\"00 00 00 * * ?\\",\\n \\"StartTime\\": \\"1970-01-01 00:00:00\\",\\n \\"EndTime\\": \\"9999-01-01 00:00:00\\",\\n \\"Timezone\\": \\"Asia/Shanghai\\"\\n },\\n \\"RuntimeResource\\": {\\n \\"ResourceGroupId\\": \\"S_res_group_524258031846018_1684XXXXXXXXX\\\\n\\",\\n \\"Image\\": \\"i-xxxxxx\\",\\n \\"Cu\\": \\"0.25\\"\\n },\\n \\"DataSource\\": {\\n \\"Name\\": \\"mysql_test\\\\n\\"\\n },\\n \\"Id\\": 1234,\\n \\"ProjectId\\": 100,\\n \\"ProjectEnv\\": \\"Prod\\",\\n \\"EnvType\\": \\"Prod\\",\\n \\"Owner\\": \\"1000\\",\\n \\"StepType\\": \\"Normal\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"1000\\",\\n \\"ModifyUser\\": \\"1000\\"\\n }\\n ],\\n \\"DownstreamTasks\\": [\\n {\\n \\"DependencyType\\": \\"Normal\\",\\n \\"Task\\": {\\n \\"Name\\": \\"SQL node\\",\\n \\"Description\\": \\"test\\",\\n \\"WorkflowId\\": 1234,\\n \\"InstanceMode\\": \\"T+1\\",\\n \\"Type\\": \\"ODPS_SQL\\",\\n \\"BaselineId\\": 1234,\\n \\"Priority\\": 1,\\n \\"Timeout\\": 3600,\\n \\"RerunMode\\": \\"AllAllowed\\",\\n \\"RerunTimes\\": 3,\\n \\"RerunInterval\\": 60,\\n \\"Trigger\\": {\\n \\"Type\\": \\"Scheduler\\",\\n \\"Recurrence\\": \\"Normal\\",\\n \\"Cron\\": \\"00 00 00 * * ?\\",\\n \\"StartTime\\": \\"1970-01-01 00:00:00\\",\\n \\"EndTime\\": \\"9999-01-01 00:00:00\\",\\n \\"Timezone\\": \\"Asia/Shanghai\\"\\n },\\n \\"RuntimeResource\\": {\\n \\"ResourceGroupId\\": \\"S_res_group_524258031846018_1684XXXXXXXXX\\",\\n \\"Image\\": \\"i-xxxxxx\\",\\n \\"Cu\\": \\"0.25\\"\\n },\\n \\"DataSource\\": {\\n \\"Name\\": \\"mysql_test\\"\\n },\\n \\"Id\\": 1234,\\n \\"ProjectId\\": 100,\\n \\"EnvType\\": \\"Prod\\",\\n \\"Owner\\": \\"1000\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"1000\\",\\n \\"ModifyUser\\": \\"1000\\"\\n }\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1\\n }\\n}","type":"json"}]', - 'title' => 'ListDownstreamTasks', - 'summary' => 'Queries a list of descendant tasks of a task by page.', - ], - 'ListTaskOperationLogs' => [ - 'methods' => [ - 'get', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'Task', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:task/*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\\\n\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 100,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"Tasks\\": [\\n {\\n \\"Name\\": \\"SQL node\\\\n\\",\\n \\"Description\\": \\"test\\\\n\\",\\n \\"WorkflowId\\": 1234,\\n \\"InstanceMode\\": \\"T+1\\",\\n \\"Type\\": \\"ODPS_SQL\\",\\n \\"BaselineId\\": 1234,\\n \\"Priority\\": 1,\\n \\"Timeout\\": 3600,\\n \\"RerunMode\\": \\"AllAllowed\\\\n\\",\\n \\"RerunTimes\\": 3,\\n \\"RerunInterval\\": 60,\\n \\"Trigger\\": {\\n \\"Type\\": \\"Scheduler\\\\n\\",\\n \\"Recurrence\\": \\"Normal\\\\n\\",\\n \\"Cron\\": \\"00 00 00 * * ?\\",\\n \\"StartTime\\": \\"1970-01-01 00:00:00\\\\n\\",\\n \\"EndTime\\": \\"9999-01-01 00:00:00\\\\n\\"\\n },\\n \\"RuntimeResource\\": {\\n \\"ResourceGroupId\\": \\"S_res_group_524258031846018_1684XXXXXXXXX\\",\\n \\"Image\\": \\"i-xxxxxx\\\\n\\",\\n \\"Cu\\": \\"0.25\\"\\n },\\n \\"DataSource\\": {\\n \\"Name\\": \\"mysql_test\\\\n\\"\\n },\\n \\"Id\\": 1234,\\n \\"ProjectId\\": 100,\\n \\"ProjectEnv\\": \\"Prod\\",\\n \\"Owner\\": \\"1000\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"1000\\",\\n \\"ModifyUser\\": \\"1000\\",\\n \\"ScriptParameters\\": \\"para1=$bizdate para2=$[yyyymmdd] \\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListUpstreamTaskInstances' => [ + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -40076,74 +41755,24 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'get', - 'abilityTreeCode' => '240490', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - ], + 'abilityTreeCode' => '240661', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB', 'FEATUREdideD0YY7B', 'FEATUREdideVFMENL'], ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The task ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234', - ], - ], - [ - 'name' => 'Date', - 'in' => 'query', - 'schema' => [ - 'description' => 'The operation date, accurate to the day. The default value is the current day. You can query only the operation logs generated within the previous 31 days.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1710239005403'."\n", - ], - ], - [ - 'name' => 'ProjectEnv', - 'in' => 'query', - 'schema' => [ - 'description' => 'The environment of the workspace. Valid values:'."\n" - ."\n" - .'* Prod: production environment'."\n" - .'* Dev: development environment'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Prod', - 'default' => 'Prod', - 'enum' => [ - 'Prod', - 'Dev', - ], - ], + 'schema' => ['description' => 'The instance ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234', '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', - ], + 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', '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, - 'example' => '1', - ], + 'schema' => ['description' => 'The page number. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -40151,776 +41780,877 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n", - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n", 'title' => ''], 'PagingInfo' => [ - 'description' => 'The pagination information.'."\n", + 'description' => 'The pagination information.', 'type' => 'object', 'properties' => [ - 'OperationLogs' => [ - 'description' => 'The operation logs.'."\n", + 'TaskInstances' => [ + 'description' => 'The instances. This parameter is deprecated and replaced by the UpstreamTaskInstances parameter.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'User' => [ - 'description' => 'The account ID of the operator.'."\n", + 'StepType' => ['description' => 'The scheduling dependency type. Valid values:'."\n" + ."\n" + .'- Normal: same-cycle scheduling dependency'."\n" + ."\n" + .'- CrossCycle: cross-cycle scheduling dependency', 'type' => 'string', 'title' => '', 'example' => 'Normal'], + 'TaskId' => ['description' => 'The ID of the task for which the instance is generated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'TaskType' => ['description' => 'The type of the task for which the instance is generated.', 'type' => 'string', 'title' => '', 'example' => 'ODPS_SQL'."\n"], + 'TaskName' => ['description' => 'The name of the task for which the instance is generated.', 'type' => 'string', 'example' => 'SQL node'."\n", 'title' => ''], + 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'WorkflowId' => ['description' => 'The ID of the workflow to which the instance belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'WorkflowName' => ['description' => 'The name of the workflow to which the instance belongs.', 'type' => 'string', 'example' => 'Test workflow', 'title' => ''], + 'TriggerType' => [ + 'description' => 'The trigger type. Valid values:'."\n" + ."\n" + .'- Scheduler: scheduling cycle-based trigger'."\n" + ."\n" + .'- Manual: manual trigger', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'Scheduler', + 'title' => '', + ], + 'TriggerRecurrence' => [ + 'description' => 'The running mode of the instance after it is triggered. This parameter takes effect only if the TriggerType parameter is set to Scheduler. Valid values:'."\n" + ."\n" + .'- Pause'."\n" + ."\n" + .'- Skip'."\n" + ."\n" + .'- Normal', + 'enumValueTitles' => [], 'type' => 'string', - 'example' => '1000', + 'example' => 'Normal'."\n", + 'title' => '', + ], + 'WorkflowInstanceId' => ['description' => 'The workflow instance ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'WorkflowInstanceType' => [ + 'description' => 'The type of the workflow instance. Valid values:'."\n" + ."\n" + .'- SmokeTest'."\n" + ."\n" + .'- SupplementData'."\n" + ."\n" + .'- Manual'."\n" + ."\n" + .'- ManualWorkflow'."\n" + ."\n" + .'- Normal'."\n" + ."\n" + .'- ManualFlow', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'Normal'."\n", + 'title' => '', + ], + 'Timeout' => ['description' => 'The timeout period of task running. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '3600', 'title' => ''], + 'RerunMode' => [ + 'description' => 'The rerun mode. Valid values:'."\n" + ."\n" + .'- AllDenied: The task cannot be rerun regardless of whether the task is successfully run or fails to run.'."\n" + ."\n" + .'- FailureAllowed: The task can be rerun only after it fails to run.'."\n" + ."\n" + .'- AllAllowed: The task can be rerun regardless of whether the task is successfully run or fails to run.', + 'enumValueTitles' => [], + 'type' => 'string', + 'title' => '', + 'example' => 'AllAllowed'."\n", + ], + 'RunNumber' => ['description' => 'The number of times the instance is run. By default, the value starts from 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PeriodNumber' => ['description' => 'The sequence number of the period. Indicates which cycle of the day the task instance is in.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'BaselineId' => ['description' => 'The baseline ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'Priority' => ['description' => 'The priority of the task. Valid values: 1 to 8. A larger value indicates a higher priority. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RuntimeResource' => [ + 'description' => 'The configurations of the runtime environment, such as the resource group information.', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupId' => ['description' => 'The ID of the resource group for scheduling configured for task running.', 'type' => 'string', 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX'."\n", 'title' => ''], + 'Image' => ['description' => 'The ID of the image configured for task running.', 'type' => 'string', 'example' => 'i-xxxxxx'."\n", 'title' => ''], + 'Cu' => ['description' => 'The default number of compute units (CUs) configured for task running.', 'type' => 'string', 'example' => '0.25', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'CreateTime' => [ - 'description' => 'The time when the operation log was generated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403'."\n", + 'Runtime' => [ + 'description' => 'The runtime information about the instance.', + 'type' => 'object', + 'properties' => [ + 'ProcessId' => ['description' => 'The instance run ID.', 'type' => 'string', 'example' => 'T3_123', 'title' => ''], + 'Gateway' => ['description' => 'The host for running.', 'type' => 'string', 'example' => 'cn-shanghai.1.2', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'OperationSeq' => [ - 'description' => 'The serial number of the operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1111', + 'DataSource' => [ + 'description' => 'The information about the associated data source.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the data source.', 'type' => 'string', 'example' => 'mysql_test', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'OperationContent' => [ - 'description' => 'The operation content.'."\n", + 'Status' => [ + 'description' => 'The status of the instance. Valid values:'."\n" + ."\n" + .'- NotRun: The instance is not run.'."\n" + ."\n" + .'- Running: The instance is running.'."\n" + ."\n" + .'- WaitTime: The instance is waiting for the scheduling time to arrive.'."\n" + ."\n" + .'- CheckingCondition: Branch conditions are being checked for the instance.'."\n" + ."\n" + .'- WaitResource: The instance is waiting for resources.'."\n" + ."\n" + .'- Failure: The instance fails to be run.'."\n" + ."\n" + .'- Success: The instance is successfully run.'."\n" + ."\n" + .'- Checking: Data quality is being checked for the instance.', + 'enumValueTitles' => [], 'type' => 'string', - 'example' => 'Freeze tasks', + 'title' => '', + 'example' => 'Success'."\n", ], - 'TaskId' => [ - 'description' => 'The ID of the task on which the operation was performed.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', + 'TriggerTime' => ['description' => 'The scheduling time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + 'Bizdate' => ['description' => 'The data timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + 'StartedTime' => ['description' => 'The time when the instance started to run.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + 'FinishedTime' => ['description' => 'The time when the instance finished running.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + 'Id' => ['description' => 'The instance ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'ProjectId' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'ProjectEnv' => [ + 'description' => 'The environment of the workspace. Valid values:'."\n" + ."\n" + .'- Prod: production environment'."\n" + ."\n" + .'- Dev: development environment', + 'enumValueTitles' => [], + 'type' => 'string', + 'deprecated' => true, + 'example' => 'Prod'."\n", + 'title' => '', ], + 'EnvType' => ['description' => 'The environment of the workspace. Valid values:'."\n" + ."\n" + .'- Prod'."\n" + ."\n" + .'- Dev', 'type' => 'string', 'example' => 'Prod', 'title' => ''], + 'Owner' => ['description' => 'The account ID of the task owner.', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + 'ModifyTime' => ['description' => 'The modification time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + 'CreateUser' => ['description' => 'The account ID of the creator.', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'ModifyUser' => ['description' => 'The account ID of the modifier.', 'type' => 'string', 'example' => '1000', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - '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', + 'UpstreamTaskInstances' => [ + 'description' => 'The ancestor instances.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'DependencyType' => ['description' => 'The scheduling dependency type. Valid values:'."\n" + ."\n" + .'- Normal'."\n" + ."\n" + .'- CrossCycle', 'type' => 'string', 'title' => '', 'example' => 'Normal'], + 'TaskInstance' => [ + 'title' => '', + 'description' => 'The information about a task instance.', + 'type' => 'object', + 'properties' => [ + 'TaskId' => ['description' => 'The ID of the task for which the instance is generated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'TaskType' => ['description' => 'The type of the task for which the instance is generated.', 'type' => 'string', 'title' => '', 'example' => 'ODPS_SQL'], + 'TaskName' => ['description' => 'The name of the task for which the instance is generated.', 'type' => 'string', 'example' => 'SQL node', 'title' => ''], + 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'WorkflowId' => ['description' => 'The ID of the workflow to which the instance belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'WorkflowName' => ['description' => 'The name of the workflow to which the instance belongs.', 'type' => 'string', 'example' => 'Test workflow', 'title' => ''], + 'TriggerType' => ['description' => 'The trigger type. Valid values:'."\n" + ."\n" + .'- Scheduler: scheduling cycle-based trigger'."\n" + ."\n" + .'- Manual: manual trigger', 'type' => 'string', 'example' => 'Scheduler', 'title' => ''], + 'TriggerRecurrence' => ['description' => 'The running mode of the instance after it is triggered. This parameter takes effect only if the TriggerType parameter is set to Scheduler. Valid values:'."\n" + ."\n" + .'- Pause'."\n" + ."\n" + .'- Skip'."\n" + ."\n" + .'- Normal', 'type' => 'string', 'example' => 'Normal', 'title' => ''], + 'WorkflowInstanceId' => ['description' => 'The workflow instance ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'WorkflowInstanceType' => ['description' => 'The type of the workflow instance. Valid values:'."\n" + ."\n" + .'- Normal'."\n" + ."\n" + .'- Manual'."\n" + ."\n" + .'- SmokeTest'."\n" + ."\n" + .'- SupplementData'."\n" + ."\n" + .'- ManualWorkflow', 'type' => 'string', 'example' => 'Normal', 'title' => ''], + 'Timeout' => ['description' => 'The timeout period of task running. Unit: seconds.'."\n" + ."\n" + .'Note: The value of this parameter is rounded up by hour.', 'type' => 'integer', 'format' => 'int32', 'example' => '3600', 'title' => ''], + 'RerunMode' => ['description' => 'The rerun mode.', 'type' => 'string', 'title' => '', 'example' => 'AllAllowed'], + 'RunNumber' => ['description' => 'The number of times the instance is run. By default, the value starts from 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PeriodNumber' => ['description' => 'The sequence number of the cycle. This parameter indicates the cycle of the task instance on the current day.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'BaselineId' => ['description' => 'The baseline ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'Priority' => ['description' => 'The priority of the task. Minimum value: 1. Maximum value: 8. A larger value indicates a higher priority. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'RuntimeResource' => [ + 'description' => 'The configurations of the runtime environment, such as the resource group information.', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupId' => ['description' => 'The ID of the resource group for scheduling configured for task running.', 'type' => 'string', 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', 'title' => ''], + 'Image' => ['description' => 'The ID of the image configured for task running.', 'type' => 'string', 'example' => 'i-xxxxxx', 'title' => ''], + 'Cu' => ['description' => 'The default number of compute units (CUs) configured for task running.', 'type' => 'string', 'example' => '0.25', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Runtime' => [ + 'description' => 'The runtime information about the instance.', + 'type' => 'object', + 'properties' => [ + 'ProcessId' => ['description' => 'The instance run ID.', 'type' => 'string', 'example' => 'T3_123', 'title' => ''], + 'Gateway' => ['description' => 'The host for running.', 'type' => 'string', 'example' => 'cn-shanghai.1.2', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'DataSource' => [ + 'description' => 'The information about the associated data source.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the data source.', 'type' => 'string', 'example' => 'mysql_test', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Status' => ['description' => 'The status of the instance. Valid values:'."\n" + ."\n" + .'- NotRun: The instance is not run.'."\n" + ."\n" + .'- Running: The instance is running.'."\n" + ."\n" + .'- WaitTime: The instance is waiting for the scheduling time to arrive.'."\n" + ."\n" + .'- CheckingCondition: Branch conditions are being checked for the instance.'."\n" + ."\n" + .'- WaitResource: The instance is waiting for resources.'."\n" + ."\n" + .'- Failure: The instance fails to be run.'."\n" + ."\n" + .'- Success: The instance is successfully run.'."\n" + ."\n" + .'- Checking: Data quality is being checked for the instance.'."\n" + ."\n" + .'- WaitTrigger: The instance is waiting to be triggered by external scheduling systems.', 'type' => 'string', 'title' => '', 'example' => 'Success'], + 'TriggerTime' => ['description' => 'The scheduling time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + 'Bizdate' => ['description' => 'The data timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + 'StartedTime' => ['description' => 'The time when the instance started to run.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + 'FinishedTime' => ['description' => 'The time when the instance finished running.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + 'Id' => ['description' => 'The instance ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'ProjectId' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'EnvType' => ['description' => 'The environment in which the data source is used. Valid values:'."\n" + ."\n" + .'- Dev'."\n" + ."\n" + .'- Prod', 'type' => 'string', 'example' => 'Prod', 'title' => ''], + 'Owner' => ['description' => 'The account ID of the task owner.', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + 'ModifyTime' => ['description' => 'The modification time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + 'CreateUser' => ['description' => 'The account ID of the creator.', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'ModifyUser' => ['description' => 'The account ID of the modifier.', 'type' => 'string', 'example' => '1000', 'title' => ''], + ], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + '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' => ''], ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\\\n\\",\\n \\"PagingInfo\\": {\\n \\"TaskInstances\\": [\\n {\\n \\"StepType\\": \\"Normal\\",\\n \\"TaskId\\": 1234,\\n \\"TaskType\\": \\"ODPS_SQL\\\\n\\",\\n \\"TaskName\\": \\"SQL node\\\\n\\",\\n \\"Description\\": \\"test\\",\\n \\"WorkflowId\\": 1234,\\n \\"WorkflowName\\": \\"Test workflow\\",\\n \\"TriggerType\\": \\"Scheduler\\",\\n \\"TriggerRecurrence\\": \\"Normal\\\\n\\",\\n \\"WorkflowInstanceId\\": 1234,\\n \\"WorkflowInstanceType\\": \\"Normal\\\\n\\",\\n \\"Timeout\\": 3600,\\n \\"RerunMode\\": \\"AllAllowed\\\\n\\",\\n \\"RunNumber\\": 1,\\n \\"PeriodNumber\\": 1,\\n \\"BaselineId\\": 1234,\\n \\"Priority\\": 1,\\n \\"RuntimeResource\\": {\\n \\"ResourceGroupId\\": \\"S_res_group_524258031846018_1684XXXXXXXXX\\\\n\\",\\n \\"Image\\": \\"i-xxxxxx\\\\n\\",\\n \\"Cu\\": \\"0.25\\"\\n },\\n \\"Runtime\\": {\\n \\"ProcessId\\": \\"T3_123\\",\\n \\"Gateway\\": \\"cn-shanghai.1.2\\"\\n },\\n \\"DataSource\\": {\\n \\"Name\\": \\"mysql_test\\"\\n },\\n \\"Status\\": \\"Success\\\\n\\",\\n \\"TriggerTime\\": 1710239005403,\\n \\"Bizdate\\": 1710239005403,\\n \\"StartedTime\\": 1710239005403,\\n \\"FinishedTime\\": 1710239005403,\\n \\"Id\\": 1234,\\n \\"ProjectId\\": 100,\\n \\"ProjectEnv\\": \\"Prod\\\\n\\",\\n \\"EnvType\\": \\"Prod\\",\\n \\"Owner\\": \\"1000\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"1000\\",\\n \\"ModifyUser\\": \\"1000\\"\\n }\\n ],\\n \\"UpstreamTaskInstances\\": [\\n {\\n \\"DependencyType\\": \\"Normal\\",\\n \\"TaskInstance\\": {\\n \\"TaskId\\": 1234,\\n \\"TaskType\\": \\"ODPS_SQL\\",\\n \\"TaskName\\": \\"SQL node\\",\\n \\"Description\\": \\"test\\",\\n \\"WorkflowId\\": 1234,\\n \\"WorkflowName\\": \\"Test workflow\\",\\n \\"TriggerType\\": \\"Scheduler\\",\\n \\"TriggerRecurrence\\": \\"Normal\\",\\n \\"WorkflowInstanceId\\": 1234,\\n \\"WorkflowInstanceType\\": \\"Normal\\",\\n \\"Timeout\\": 3600,\\n \\"RerunMode\\": \\"AllAllowed\\",\\n \\"RunNumber\\": 1,\\n \\"PeriodNumber\\": 1,\\n \\"BaselineId\\": 1234,\\n \\"Priority\\": 1,\\n \\"RuntimeResource\\": {\\n \\"ResourceGroupId\\": \\"S_res_group_524258031846018_1684XXXXXXXXX\\",\\n \\"Image\\": \\"i-xxxxxx\\",\\n \\"Cu\\": \\"0.25\\"\\n },\\n \\"Runtime\\": {\\n \\"ProcessId\\": \\"T3_123\\",\\n \\"Gateway\\": \\"cn-shanghai.1.2\\"\\n },\\n \\"DataSource\\": {\\n \\"Name\\": \\"mysql_test\\"\\n },\\n \\"Status\\": \\"Success\\",\\n \\"TriggerTime\\": 1710239005403,\\n \\"Bizdate\\": 1710239005403,\\n \\"StartedTime\\": 1710239005403,\\n \\"FinishedTime\\": 1710239005403,\\n \\"Id\\": 1234,\\n \\"ProjectId\\": 100,\\n \\"EnvType\\": \\"Prod\\",\\n \\"Owner\\": \\"1000\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"1000\\",\\n \\"ModifyUser\\": \\"1000\\"\\n }\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1\\n }\\n}","type":"json"}]', + 'title' => 'ListUpstreamTaskInstances', + 'summary' => 'Queries a list of ancestor instances of an instance by page.', + 'description' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-01-21T03:12:29.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-01-06T09:33:04.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-11-20T07:55:32.000Z', 'description' => 'Response parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\\\n\\",\\n \\"PagingInfo\\": {\\n \\"OperationLogs\\": [\\n {\\n \\"User\\": \\"1000\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"OperationSeq\\": 1111,\\n \\"OperationContent\\": \\"Freeze tasks\\",\\n \\"TaskId\\": 1234\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1\\n }\\n}","type":"json"}]', - 'title' => 'ListTaskOperationLogs', - 'summary' => 'Queries a list of operation logs of a task by page.', - 'description' => 'This API operation is available for all DataWorks editions.'."\n" - ."\n" - .'You can call this operation to query only the operation logs generated within the previous 31 days.', - ], - 'UpdateTaskInstances' => [ - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListUpstreamTasks' => [ + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '245367', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '240488', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB', 'FEATUREdideD0YY7B', 'FEATUREdideVFMENL'], ], 'parameters' => [ [ - 'name' => 'TaskInstances', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The instances.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234', - ], - 'Priority' => [ - 'description' => 'The priority of the instance. Valid values: 1, 3, 5, 7, and 8.'."\n" - ."\n" - .'A larger value indicates a higher priority. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'enumValueTitles' => [ - 1 => '1', - 3 => '3', - 5 => '5', - 7 => '7', - '8', - ], - 'example' => '1', - 'enum' => [ - '1', - '3', - '5', - '7', - '8', - ], - ], - 'RuntimeResource' => [ - 'description' => 'The resource group information. Set this parameter to the ID of a resource group for scheduling.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', - ], - 'DataSource' => [ - 'description' => 'The information about the associated data source.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the data source.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mysql_test'."\n", - ], - ], - 'required' => false, - ], - ], - 'required' => false, - 'description' => '', - ], - 'required' => false, - 'maxItems' => 50, - ], - ], - [ - 'name' => 'Comment', - 'in' => 'formData', + 'name' => 'ProjectEnv', + 'in' => 'query', 'schema' => [ - 'description' => 'The remarks.'."\n", + 'description' => 'The environment of the workspace. Valid values:'."\n" + ."\n" + .'- Prod: production environment'."\n" + ."\n" + .'- Dev: development environment', + 'enumValueTitles' => [], 'type' => 'string', + 'deprecated' => false, + 'default' => 'Prod', + 'enum' => ['Prod', 'Dev'], 'required' => false, - 'example' => 'this is a comment', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n", - ], - 'SuccessInfo' => [ - 'description' => 'The result of the batch operation, which is in the MAP structure. The instance ID serves as a key, and the result serves as a value.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'type' => 'boolean', - 'description' => 'Indicates whether the request was successful.'."\n", - 'example' => 'true', - ], - 'Message' => [ - 'type' => 'string', - 'example' => '', - 'description' => 'The error message.'."\n", - ], - ], - 'description' => 'The result.'."\n", - ], - ], - ], - 'description' => '', + 'example' => 'Prod', + 'title' => '', ], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\\\n\\",\\n \\"SuccessInfo\\": {\\n \\"key\\": {\\n \\"Success\\": true,\\n \\"Message\\": \\"该实例不存在。\\"\\n }\\n }\\n}","type":"json"}]', - 'title' => 'UpdateTaskInstances', - 'summary' => 'Modifies properties configured for multiple instances at a time. The properties include the priority, resource group for scheduling, and data source.', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", - ], - 'GetTaskInstance' => [ - 'summary' => 'Queries the information about an instance.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234', 'title' => ''], ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '240659', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - 'FEATUREdideD0YY7B', - 'FEATUREdideVFMENL', + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], - ], - 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234', - ], + 'schema' => ['description' => 'The page number. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The returned data.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n", - ], - 'TaskInstance' => [ - 'description' => 'The details of the task instance.'."\n", + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n", 'title' => ''], + 'PagingInfo' => [ + 'description' => 'The pagination information.', 'type' => 'object', 'properties' => [ - 'TaskId' => [ - 'description' => 'The ID of the task for which the instance is generated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'TaskType' => [ - 'title' => '任务类型', - 'description' => 'The type of the task for which the instance is generated.'."\n", - 'type' => 'string', - 'example' => 'ODPS_SQL', - ], - 'TaskName' => [ - 'description' => 'The name of the task for which the instance is generated.'."\n", - 'type' => 'string', - 'example' => 'SQL node', - ], - 'Description' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'WorkflowId' => [ - 'description' => 'The ID of the workflow to which the instance belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'WorkflowName' => [ - 'description' => 'The name of the workflow to which the instance belongs.'."\n", - 'type' => 'string', - 'example' => 'Test workflow', - ], - 'TriggerType' => [ - 'description' => 'The method to trigger instance scheduling. The value of the Trigger.Type parameter in the response of the GetTask operation is used. Valid values:'."\n" - ."\n" - .'* Scheduler'."\n" - .'* Manual'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Scheduler', - ], - 'TriggerRecurrence' => [ - 'description' => 'The running mode of the instance after it is triggered. This parameter takes effect only if the TriggerType parameter is set to Scheduler. Valid values:'."\n" - ."\n" - .'* Pause'."\n" - .'* Skip'."\n" - .'* Normal'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Normal', - ], - 'WorkflowInstanceId' => [ - 'description' => 'The workflow instance ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'WorkflowInstanceType' => [ - 'description' => 'The type of the workflow instance. Valid values:'."\n" - ."\n" - .'* SmokeTest'."\n" - .'* SupplementData'."\n" - .'* Manual'."\n" - .'* ManualWorkflow'."\n" - .'* Normal'."\n" - .'* ManualFlow'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Normal', - ], - 'UnifiedWorkflowInstanceId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'Timeout' => [ - 'description' => 'The timeout period of task running. Unit: seconds.'."\n" - ."\n" - .'Note: The value of this parameter is rounded up by hour.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RerunMode' => [ - 'title' => '任务是否允许重跑的配置', - 'description' => 'The rerun mode. Valid values:'."\n" - ."\n" - .'* AllDenied: The task cannot be rerun regardless of whether the task is successfully run or fails to run.'."\n" - .'* AllAllowed: The task can be rerun regardless of whether the task is successfully run or fails to run.'."\n" - .'* FailureAllowed: The task can be rerun only after it fails to run.'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'AllAllowed', - ], - 'RunNumber' => [ - 'description' => 'The number of times the instance is run. By default, the value starts from 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PeriodNumber' => [ - 'description' => 'The sequence number of the cycle. This parameter indicates the cycle of the task instance on the current day.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'BaselineId' => [ - 'description' => 'The baseline ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'Priority' => [ - 'description' => 'The task priority. Valid values: 1 to 8. A larger value indicates a higher priority. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Script' => [ - 'description' => 'The script information.'."\n", - 'type' => 'object', - 'properties' => [ - 'Content' => [ - 'description' => 'The script content.'."\n", - 'type' => 'string', - 'example' => 'echo "helloWorld"', - ], - 'Parameters' => [ - 'description' => 'The script parameters.'."\n", - 'type' => 'string', - 'example' => 'para1=$bizdate', - ], - ], - ], - 'RuntimeResource' => [ - 'description' => 'The information about the resource group with which the instance is associated.'."\n", - 'type' => 'object', - 'properties' => [ - 'ResourceGroupId' => [ - 'description' => 'The ID of the resource group for scheduling configured for task running.'."\n", - 'type' => 'string', - 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', - ], - 'Image' => [ - 'description' => 'The ID of the image configured for task running.'."\n", - 'type' => 'string', - 'example' => 'i-xxxxxx', - ], - 'Cu' => [ - 'description' => 'The default number of CUs configured for task running.'."\n", - 'type' => 'string', - 'example' => '0.25', - ], - ], - ], - 'Runtime' => [ - 'description' => 'The runtime information about the instance.'."\n", - 'type' => 'object', - 'properties' => [ - 'ProcessId' => [ - 'description' => 'The instance run ID.'."\n", - 'type' => 'string', - 'example' => 'T3_123', - ], - 'Gateway' => [ - 'description' => 'The host for running.'."\n", - 'type' => 'string', - 'example' => 'cn-shanghai.1.2', - ], - ], - ], - 'DataSource' => [ - 'description' => 'The information about the associated data source.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the data source.'."\n", - 'type' => 'string', - 'example' => 'mysql_test', - ], - ], - ], - 'Inputs' => [ - 'description' => 'The input information.'."\n", - 'type' => 'object', - 'properties' => [ - 'Variables' => [ - 'description' => 'The variables.'."\n", - 'type' => 'array', - 'items' => [ + 'Tasks' => [ + 'description' => 'The tasks. This parameter is deprecated and replaced by the UpstreamTasks parameter.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the task.', 'type' => 'string', 'example' => 'SQL node'."\n", 'title' => ''], + 'Description' => ['description' => 'The description of the task.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'WorkflowId' => ['description' => 'The ID of the workflow to which the task belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'InstanceMode' => ['description' => 'The instance generation mode. Valid values:'."\n" + ."\n" + .'- T+1'."\n" + ."\n" + .'- Immediately', 'type' => 'string', 'example' => 'T+1', 'title' => ''], + 'Type' => ['description' => 'The type of the task.', 'type' => 'string', 'title' => '', 'example' => 'ODPS_SQL'."\n"], + 'BaselineId' => ['description' => 'The baseline ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1234'], + 'Priority' => ['description' => 'The priority of the task. Valid values: 1 to 8. A larger value indicates a higher priority. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'Timeout' => ['description' => 'The timeout period of task running. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '3600'], + 'RerunMode' => [ + 'description' => 'The rerun mode.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- AllDenied: The task cannot be rerun regardless of whether it is successfully run or fails to run.'."\n" + ."\n" + .'- FailureAllowed: The task can be rerun only after it fails to run.'."\n" + ."\n" + .'- AllAllowed: The task can be rerun regardless of whether it is successfully run or fails to run.', + 'enumValueTitles' => ['AllDenied' => '', 'FailureAllowed' => '', 'AllAllowed' => ''], + 'type' => 'string', + 'title' => '', + 'example' => 'AllAllowed', + ], + 'RerunTimes' => ['description' => 'The number of times that the task is rerun. This parameter takes effect only if the RerunMode parameter is set to AllAllowed or FailureAllowed.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '3'], + 'RerunInterval' => ['description' => 'The rerun interval. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '60'], + 'Trigger' => [ + 'title' => '', + 'description' => 'The method to trigger task scheduling.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'The name of the variable.'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Key1', - ], 'Type' => [ - 'title' => '类型', - 'description' => 'The type. Valid values:'."\n" + 'description' => 'The trigger type.'."\n" + ."\n" + .'Valid values:'."\n" ."\n" - .'* Constant: constant'."\n" - .'* PassThrough: node output'."\n" - .'* System: variable'."\n" - .'* NodeOutput: script output'."\n", + .'- Scheduler: scheduling cycle-based trigger'."\n" + ."\n" + .'- Manual: manual trigger', + 'enumValueTitles' => ['Scheduler' => '', 'Manual' => ''], 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Constant', + 'example' => 'Scheduler', + 'title' => '', ], - 'Value' => [ - 'description' => 'The value of the variable.'."\n", + 'Recurrence' => [ + 'description' => 'The running mode of the task after it is triggered. This parameter takes effect only if the Type parameter is set to Scheduler.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- Pause'."\n" + ."\n" + .'- Skip'."\n" + ."\n" + .'- Normal', + 'enumValueTitles' => ['Pause' => '', 'Skip' => '', 'Normal' => ''], 'type' => 'string', - 'example' => 'Value1', + 'example' => 'Normal', + 'title' => '', ], + 'Cron' => ['description' => 'The CRON expression of the task. This parameter takes effect only if the Type parameter is set to Scheduler.', 'type' => 'string', 'example' => '00 00 00 * * ?'."\n", 'title' => ''], + 'StartTime' => ['description' => 'The start time of the time range during which the task is periodically scheduled. This parameter takes effect only if the Type parameter is set to Scheduler.', 'type' => 'string', 'example' => '1970-01-01 00:00:00'."\n", 'title' => ''], + 'EndTime' => ['description' => 'The end time of the time range during which the task is periodically scheduled. This parameter takes effect only if the Type parameter is set to Scheduler.', 'type' => 'string', 'example' => '9999-01-01 00:00:00'."\n", 'title' => ''], + 'Timezone' => ['description' => 'The time zone.', 'type' => 'string', 'example' => 'Asia/Shanghai', 'title' => ''], ], - 'description' => '', + 'example' => '', ], - ], - ], - ], - 'Outputs' => [ - 'description' => 'The output information.'."\n", - 'type' => 'object', - 'properties' => [ - 'TaskOutputs' => [ - 'description' => 'The task outputs.'."\n", - 'type' => 'array', - 'items' => [ + 'RuntimeResource' => [ + 'title' => '', + 'description' => 'The configurations of the runtime environment, such as the resource group information.', 'type' => 'object', 'properties' => [ - 'Output' => [ - 'title' => '输出标识符，示例：pre.odps_sql_demo_0', - 'description' => 'The output identifier.'."\n", - 'type' => 'string', - 'example' => 'pre.odps_sql_demo_0', - ], + 'ResourceGroupId' => ['description' => 'The ID of the resource group for scheduling configured for task running.', 'type' => 'string', 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', 'title' => ''], + 'Image' => ['description' => 'The ID of the image configured for task running.', 'type' => 'string', 'example' => 'i-xxxxxx', 'title' => ''], + 'Cu' => ['description' => 'The default number of compute units (CUs) configured for task running.', 'type' => 'string', 'example' => '0.25', 'title' => ''], ], - 'description' => '', + 'example' => '', ], - ], - 'Variables' => [ - 'description' => 'The variables.'."\n", - 'type' => 'array', - 'items' => [ + 'DataSource' => [ + 'title' => '', + 'description' => 'The information about the associated data source.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'The name of the variable.'."\n", - 'type' => 'string', - 'example' => 'key1', - ], - 'Type' => [ - 'title' => '类型', - 'description' => 'The type. Valid values:'."\n" - ."\n" - .'* Constant: constant'."\n" - .'* PassThrough: node output'."\n" - .'* System: variable'."\n" - .'* NodeOutput: script output'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Constant', - ], - 'Value' => [ - 'description' => 'The value of the variable.'."\n", - 'type' => 'string', - 'example' => 'value1', - ], + 'Name' => ['description' => 'The name of the data source.', 'type' => 'string', 'example' => 'mysql_test'."\n", 'title' => ''], ], - 'description' => '', + 'example' => '', + ], + 'Id' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'."\n", 'title' => ''], + 'ProjectId' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'ProjectEnv' => [ + 'description' => 'The environment of the workspace. This parameter is deprecated and replaced by the EnvType parameter.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- Prod'."\n" + ."\n" + .'- Dev', + 'enumValueTitles' => ['Prod' => '', 'Dev' => ''], + 'type' => 'string', + 'deprecated' => true, + 'example' => 'Prod', + 'title' => '', ], + 'EnvType' => ['description' => 'The environment of the workspace. Valid values:'."\n" + ."\n" + .'- Prod'."\n" + ."\n" + .'- Dev', 'type' => 'string', 'example' => 'Prod', 'title' => ''], + 'Owner' => ['description' => 'The account ID of the task owner.', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'StepType' => ['description' => 'The scheduling dependency type. Valid values:'."\n" + ."\n" + .'- Normal: same-cycle scheduling dependency'."\n" + ."\n" + .'- CrossCycle: cross-cycle scheduling dependency', 'type' => 'string', 'example' => 'Normal', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'."\n", 'title' => ''], + 'ModifyTime' => ['description' => 'The modification time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403'."\n", 'title' => ''], + 'CreateUser' => ['description' => 'The account ID of the creator.', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'ModifyUser' => ['description' => 'The account ID of the modifier.', 'type' => 'string', 'example' => '1000', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'Tags' => [ - 'title' => '任务标签', - 'description' => 'The tags of the task.'."\n", + 'UpstreamTasks' => [ + 'description' => 'The ancestor tasks.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'key1', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => 'value1', + 'DependencyType' => ['description' => 'The scheduling dependency type. Valid values:'."\n" + ."\n" + .'- Normal: same-cycle scheduling dependency'."\n" + ."\n" + .'- CrossCycle: cross-cycle scheduling dependency', 'type' => 'string', 'title' => '', 'example' => 'Normal'], + 'Task' => [ + 'description' => 'The information about the task.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the task.', 'type' => 'string', 'example' => 'SQL node', 'title' => ''], + 'Description' => ['description' => 'The description of the task.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'WorkflowId' => ['description' => 'The ID of the workflow to which the task belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'InstanceMode' => ['description' => 'The instance generation mode. Valid values:'."\n" + ."\n" + .'- T+1'."\n" + ."\n" + .'- Immediately', 'type' => 'string', 'example' => 'T+1', 'title' => ''], + 'Type' => ['description' => 'The type of the task.', 'type' => 'string', 'title' => '', 'example' => 'ODPS_SQL'], + 'BaselineId' => ['description' => 'The baseline ID.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1234'], + 'Priority' => ['description' => 'The priority of the task. Valid values: 1 to 8.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], + 'Timeout' => ['description' => 'The timeout period of task running. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '3600'], + 'RerunMode' => ['description' => 'The rerun mode. Valid values:'."\n" + ."\n" + .'- AllDenied: The task cannot be rerun regardless of whether the task is successfully run or fails to run.'."\n" + ."\n" + .'- FailureAllowed: The task can be rerun only after it fails to run.'."\n" + ."\n" + .'- AllAllowed: The task can be rerun regardless of whether the task is successfully run or fails to run.', 'type' => 'string', 'title' => '', 'example' => 'AllAllowed'."\n"], + 'RerunTimes' => ['description' => 'The number of times that the task is rerun. This parameter takes effect only if the RerunMode parameter is set to AllAllowed or FailureAllowed.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '3'], + 'RerunInterval' => ['description' => 'The rerun interval. Unit: seconds.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '60'], + 'Trigger' => [ + 'title' => '', + 'description' => 'The trigger method.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The trigger type. Valid values:'."\n" + ."\n" + .'- Scheduler: scheduling cycle-based trigger'."\n" + ."\n" + .'- Manual: manual trigger', 'type' => 'string', 'example' => 'Scheduler', 'title' => ''], + 'Recurrence' => ['description' => 'The running mode of the task after it is triggered. This parameter takes effect only if the Type parameter is set to Scheduler. Valid values:'."\n" + ."\n" + .'- Pause'."\n" + ."\n" + .'- Skip'."\n" + ."\n" + .'- Normal', 'type' => 'string', 'example' => 'Normal'."\n", 'title' => ''], + 'Cron' => ['description' => 'The CRON expression. This parameter takes effect only if the Type parameter is set to Scheduler.', 'type' => 'string', 'example' => '00 00 00 * * ?', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the time range during which the task is periodically scheduled. This parameter takes effect only if the Type parameter is set to Scheduler.', 'type' => 'string', 'example' => '1970-01-01 00:00:00', 'title' => ''], + 'EndTime' => ['description' => 'The end time of the time range during which the task is periodically scheduled. This parameter takes effect only if the Type parameter is set to Scheduler.', 'type' => 'string', 'example' => '9999-01-01 00:00:00', 'title' => ''], + 'Timezone' => ['description' => 'The time zone.', 'type' => 'string', 'example' => 'Asia/Shanghai', 'title' => ''], + ], + 'example' => '', + ], + 'RuntimeResource' => [ + 'title' => '', + 'description' => 'The configurations of the runtime environment, such as the resource group information.', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupId' => ['description' => 'The ID of the resource group for scheduling configured for task running.', 'type' => 'string', 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', 'title' => ''], + 'Image' => ['description' => 'The ID of the image configured for task running.', 'type' => 'string', 'example' => 'i-xxxxxx', 'title' => ''], + 'Cu' => ['description' => 'The default number of compute units (CUs) configured for task running.', 'type' => 'string', 'example' => '0.25', 'title' => ''], + ], + 'example' => '', + ], + 'DataSource' => [ + 'title' => '', + 'description' => 'The information about the associated data source.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the data source.', 'type' => 'string', 'example' => 'mysql_test', 'title' => ''], + ], + 'example' => '', + ], + 'Id' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'ProjectId' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'EnvType' => ['description' => 'The environment of the workspace. Valid values:'."\n" + ."\n" + .'- Prod'."\n" + ."\n" + .'- Dev', 'type' => 'string', 'example' => 'Prod', 'title' => ''], + 'Owner' => ['description' => 'The account ID of the task owner.', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + 'ModifyTime' => ['description' => 'The modification time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + 'CreateUser' => ['description' => 'The account ID of the creator.', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'ModifyUser' => ['description' => 'The account ID of the modifier.', 'type' => 'string', 'example' => '1000', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'Status' => [ - 'title' => '实例运行状态', - 'description' => 'The status of the instance. Valid values:'."\n" - ."\n" - .'* NotRun: The instance is not run.'."\n" - .'* Running: The instance is running.'."\n" - .'* WaitTime: The instance is waiting for the scheduling time to arrive.'."\n" - .'* CheckingCondition: Branch conditions are being checked for the instance.'."\n" - .'* WaitResource: The instance is waiting for resources.'."\n" - .'* Failure: The instance fails to be run.'."\n" - .'* Success: The instance is successfully run.'."\n" - .'* Checking: Data quality is being checked for the instance.'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Success', - ], - 'TriggerTime' => [ - 'description' => 'The scheduling time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], - 'Bizdate' => [ - 'description' => 'The data timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], - 'StartedTime' => [ - 'description' => 'The time when the instance started to run.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], - 'FinishedTime' => [ - 'description' => 'The time when the instance finished running.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], - 'Id' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'ProjectId' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'ProjectEnv' => [ - 'description' => 'The environment of the workspace. Valid values:'."\n" - ."\n" - .'* Prod: production environment'."\n" - .'* Dev: development environment'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Prod', - ], - 'Owner' => [ - 'description' => 'The account ID of the task owner.'."\n", - 'type' => 'string', - 'example' => '1000', - ], - 'CreateTime' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], - 'ModifyTime' => [ - 'description' => 'The modification time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], - 'CreateUser' => [ - 'description' => 'The account ID of the creator.'."\n", - 'type' => 'string', - 'example' => '1000', - ], - 'ModifyUser' => [ - 'description' => 'The account ID of the modifier.'."\n", - 'type' => 'string', - 'example' => '1000', - ], - 'WaitingResourceTime' => [ - 'description' => 'The timestamp for when it started waiting for resources.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], - 'WaitingTriggerTime' => [ - 'description' => 'The timestamp for when it started waiting for the scheduled time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + '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' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\\\n\\",\\n \\"PagingInfo\\": {\\n \\"Tasks\\": [\\n {\\n \\"Name\\": \\"SQL node\\\\n\\",\\n \\"Description\\": \\"test\\",\\n \\"WorkflowId\\": 1234,\\n \\"InstanceMode\\": \\"T+1\\",\\n \\"Type\\": \\"ODPS_SQL\\\\n\\",\\n \\"BaselineId\\": 1234,\\n \\"Priority\\": 1,\\n \\"Timeout\\": 3600,\\n \\"RerunMode\\": \\"AllAllowed\\",\\n \\"RerunTimes\\": 3,\\n \\"RerunInterval\\": 60,\\n \\"Trigger\\": {\\n \\"Type\\": \\"Scheduler\\",\\n \\"Recurrence\\": \\"Normal\\",\\n \\"Cron\\": \\"00 00 00 * * ?\\\\n\\",\\n \\"StartTime\\": \\"1970-01-01 00:00:00\\\\n\\",\\n \\"EndTime\\": \\"9999-01-01 00:00:00\\\\n\\",\\n \\"Timezone\\": \\"Asia/Shanghai\\"\\n },\\n \\"RuntimeResource\\": {\\n \\"ResourceGroupId\\": \\"S_res_group_524258031846018_1684XXXXXXXXX\\",\\n \\"Image\\": \\"i-xxxxxx\\",\\n \\"Cu\\": \\"0.25\\"\\n },\\n \\"DataSource\\": {\\n \\"Name\\": \\"mysql_test\\\\n\\"\\n },\\n \\"Id\\": 1234,\\n \\"ProjectId\\": 100,\\n \\"ProjectEnv\\": \\"Prod\\",\\n \\"EnvType\\": \\"Prod\\",\\n \\"Owner\\": \\"1000\\",\\n \\"StepType\\": \\"Normal\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"1000\\",\\n \\"ModifyUser\\": \\"1000\\"\\n }\\n ],\\n \\"UpstreamTasks\\": [\\n {\\n \\"DependencyType\\": \\"Normal\\",\\n \\"Task\\": {\\n \\"Name\\": \\"SQL node\\",\\n \\"Description\\": \\"test\\",\\n \\"WorkflowId\\": 1234,\\n \\"InstanceMode\\": \\"T+1\\",\\n \\"Type\\": \\"ODPS_SQL\\",\\n \\"BaselineId\\": 1234,\\n \\"Priority\\": 1,\\n \\"Timeout\\": 3600,\\n \\"RerunMode\\": \\"AllAllowed\\\\n\\",\\n \\"RerunTimes\\": 3,\\n \\"RerunInterval\\": 60,\\n \\"Trigger\\": {\\n \\"Type\\": \\"Scheduler\\",\\n \\"Recurrence\\": \\"Normal\\\\n\\",\\n \\"Cron\\": \\"00 00 00 * * ?\\",\\n \\"StartTime\\": \\"1970-01-01 00:00:00\\",\\n \\"EndTime\\": \\"9999-01-01 00:00:00\\",\\n \\"Timezone\\": \\"Asia/Shanghai\\"\\n },\\n \\"RuntimeResource\\": {\\n \\"ResourceGroupId\\": \\"S_res_group_524258031846018_1684XXXXXXXXX\\",\\n \\"Image\\": \\"i-xxxxxx\\",\\n \\"Cu\\": \\"0.25\\"\\n },\\n \\"DataSource\\": {\\n \\"Name\\": \\"mysql_test\\"\\n },\\n \\"Id\\": 1234,\\n \\"ProjectId\\": 100,\\n \\"EnvType\\": \\"Prod\\",\\n \\"Owner\\": \\"1000\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"1000\\",\\n \\"ModifyUser\\": \\"1000\\"\\n }\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1\\n }\\n}","type":"json"}]', + 'title' => 'ListUpstreamTasks', + 'summary' => 'Queries a list of ancestor tasks of a task by page.', + 'description' => 'This API operation is available for all DataWorks editions.', + 'changeSet' => [ + ['createdAt' => '2025-01-21T03:12:29.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-01-13T08:44:56.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-01-06T09:33:04.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2024-11-20T07:55:32.000Z', 'description' => 'Response parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77****\\",\\n \\"TaskInstance\\": {\\n \\"TaskId\\": 1234,\\n \\"TaskType\\": \\"ODPS_SQL\\",\\n \\"TaskName\\": \\"SQL node\\\\n\\",\\n \\"Description\\": \\"test\\",\\n \\"WorkflowId\\": 1234,\\n \\"WorkflowName\\": \\"Test workflow\\",\\n \\"TriggerType\\": \\"Scheduler\\",\\n \\"TriggerRecurrence\\": \\"Normal\\",\\n \\"WorkflowInstanceId\\": 1234,\\n \\"WorkflowInstanceType\\": \\"Normal\\",\\n \\"UnifiedWorkflowInstanceId\\": 1234,\\n \\"Timeout\\": 3600,\\n \\"RerunMode\\": \\"AllAllowed\\",\\n \\"RunNumber\\": 1,\\n \\"PeriodNumber\\": 1,\\n \\"BaselineId\\": 1234,\\n \\"Priority\\": 1,\\n \\"Script\\": {\\n \\"Content\\": \\"echo \\\\\\"helloWorld\\\\\\"\\",\\n \\"Parameters\\": \\"para1=$bizdate\\"\\n },\\n \\"RuntimeResource\\": {\\n \\"ResourceGroupId\\": \\"S_res_group_524258031846018_1684XXXXXXXXX\\",\\n \\"Image\\": \\"i-xxxxxx\\",\\n \\"Cu\\": \\"0.25\\"\\n },\\n \\"Runtime\\": {\\n \\"ProcessId\\": \\"T3_123\\",\\n \\"Gateway\\": \\"cn-shanghai.1.2\\"\\n },\\n \\"DataSource\\": {\\n \\"Name\\": \\"mysql_test\\"\\n },\\n \\"Inputs\\": {\\n \\"Variables\\": [\\n {\\n \\"Name\\": \\"Key1\\",\\n \\"Type\\": \\"Constant\\",\\n \\"Value\\": \\"Value1\\"\\n }\\n ]\\n },\\n \\"Outputs\\": {\\n \\"TaskOutputs\\": [\\n {\\n \\"Output\\": \\"pre.odps_sql_demo_0\\"\\n }\\n ],\\n \\"Variables\\": [\\n {\\n \\"Name\\": \\"key1\\",\\n \\"Type\\": \\"Constant\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ]\\n },\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"Status\\": \\"Success\\",\\n \\"TriggerTime\\": 1710239005403,\\n \\"Bizdate\\": 1710239005403,\\n \\"StartedTime\\": 1710239005403,\\n \\"FinishedTime\\": 1710239005403,\\n \\"Id\\": 1234,\\n \\"ProjectId\\": 100,\\n \\"ProjectEnv\\": \\"Prod\\",\\n \\"Owner\\": \\"1000\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"1000\\",\\n \\"ModifyUser\\": \\"1000\\",\\n \\"WaitingResourceTime\\": 1710239005403,\\n \\"WaitingTriggerTime\\": 1710239005403\\n }\\n}","type":"json"}]', - 'title' => 'GetTaskInstance', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", - ], - 'GetTaskInstanceLog' => [ - 'methods' => [ - 'get', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListWorkflowDefinitions' => [ + 'summary' => 'Queries a list of workflows in DataStudio. You can also specify filter conditions to query specific workflows.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '240663', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - ], + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235375', + 'abilityTreeNodes' => ['FEATUREdideHO4TQP', 'FEATUREdide8FM783', 'FEATUREdideQUQUVB', 'FEATUREdideIQU97M'], ], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234', - ], + '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.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000', 'title' => ''], ], [ - 'name' => 'RunNumber', + 'name' => 'Type', 'in' => 'query', 'schema' => [ - 'description' => 'The sequence number of an instance run. Minimum value: 1. By default, the latest run is used.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'Filter condition: The type of the workflow. The default value is CycleWorkflow.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- CycleWorkflow'."\n" + ."\n" + .'- ManualWorkflow', + 'enumValueTitles' => [], + 'type' => 'string', 'required' => false, - 'example' => '1', + 'default' => 'CycleWorkflow', + 'example' => 'CycleWorkflow', + 'title' => '', ], ], + [ + 'name' => 'Owner', + 'in' => 'query', + 'schema' => ['description' => 'Filter condition: The type of the workflow. The default value is CycleWorkflow.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- CycleWorkflow'."\n" + ."\n" + .'- ManualWorkflow', 'type' => 'string', 'required' => false, 'example' => '110755000425XXXX', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the workflow. Fuzzy search is supported.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number of the data to retrieve, used for pagination.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '2147483647', 'minimum' => '1', 'default' => '1', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The page number of the data to retrieve, used for pagination.', 'type' => 'integer', 'format' => 'int32', 'maximum' => '100', 'minimum' => '10', 'default' => '10', 'required' => false, 'example' => '10', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n", - ], - 'TaskInstanceLog' => [ - 'description' => 'The run log of the instance.'."\n", - 'type' => 'string', - 'example' => 'This is running log', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '8C3ED0C5-ABAB-55E1-854B-DAC02B11XXXX', 'title' => ''], + 'PagingInfo' => [ + 'description' => 'The pagination information.', + 'type' => 'object', + 'properties' => [ + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '227', 'title' => ''], + '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' => ''], + 'WorkflowDefinitions' => [ + 'description' => 'The workflows.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ProjectId' => ['description' => 'The ID of the DataWorks workspace to which the workflow belongs.', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'required' => true, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '4710'], + 'Owner' => ['description' => 'Owner', 'type' => 'string', 'deprecated' => false, 'required' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '110755000425XXXX'], + 'CreateTime' => ['description' => 'The timestamp when the workflow was created.', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'required' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '1698057323000'], + 'ModifyTime' => ['description' => 'The timestamp when the workflow was last modified.', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'required' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => '1698057323000'], + 'Description' => ['description' => 'Description', 'type' => 'string', 'deprecated' => false, 'required' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'Workflow description'], + 'Type' => [ + 'description' => 'The type of the workflow.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- CycleWorkflow'."\n" + ."\n" + .'- ManualWorkflow', + 'enumValueTitles' => [], + 'type' => 'string', + 'deprecated' => false, + 'required' => false, + 'pattern' => '', + 'default' => '', + 'enum' => ['CycleWorkflow', 'ManualWorkflow'], + 'title' => '', + 'example' => 'CycleWorkflow', + ], + 'Script' => [ + 'title' => '', + 'description' => 'The script information.', + 'type' => 'object', + 'properties' => [ + 'Path' => ['description' => 'The script path.', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'XX/OpenAPI_test/workflow_test/OpenAPI_test_workflow_Demo'], + 'Runtime' => [ + 'title' => '', + 'description' => 'Runtime', + 'type' => 'object', + 'properties' => [ + 'Command' => ['description' => 'Command', 'type' => 'string', 'deprecated' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'WORKFLOW'], + ], + 'deprecated' => false, + 'example' => '', + ], + 'Id' => ['description' => 'The ID of the script.'."\n" + ."\n" + .'> This field is of type Long in SDK versions prior to 8.0.0, and of type String in SDK version 8.0.0 and later. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures due to the type change may occur only when upgrading the SDK across version 8.0.0, in which case users need to manually correct the data type.', 'type' => 'string', 'deprecated' => false, 'example' => '698002781368644XXXX', 'title' => ''], + ], + 'deprecated' => false, + 'required' => false, + 'example' => '', + ], + 'Name' => ['description' => 'The name of the workflow.', 'type' => 'string', 'deprecated' => false, 'required' => false, 'pattern' => '', 'default' => '', 'title' => '', 'example' => 'OpenAPI test workflow Demo'], + 'Id' => ['description' => 'The unique identifier of the workflow.'."\n" + ."\n" + .'> Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.', 'type' => 'string', 'deprecated' => false, 'example' => '463497880880954XXXX', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8C3ED0C5-ABAB-55E1-854B-DAC02B11XXXX\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 227,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"WorkflowDefinitions\\": [\\n {\\n \\"ProjectId\\": 4710,\\n \\"Owner\\": \\"110755000425XXXX\\",\\n \\"CreateTime\\": 1698057323000,\\n \\"ModifyTime\\": 1698057323000,\\n \\"Description\\": \\"Workflow description\\",\\n \\"Type\\": \\"CycleWorkflow\\",\\n \\"Script\\": {\\n \\"Path\\": \\"XX/OpenAPI_test/workflow_test/OpenAPI_test_workflow_Demo\\",\\n \\"Runtime\\": {\\n \\"Command\\": \\"WORKFLOW\\"\\n },\\n \\"Id\\": \\"698002781368644XXXX\\"\\n },\\n \\"Name\\": \\"OpenAPI test workflow Demo\\",\\n \\"Id\\": \\"463497880880954XXXX\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListWorkflowDefinitions', + 'changeSet' => [ + ['createdAt' => '2025-01-13T07:36:00.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\\\n\\",\\n \\"TaskInstanceLog\\": \\"This is running log\\"\\n}","type":"json"}]', - 'title' => 'GetTaskInstanceLog', - 'summary' => 'Queries the run log generated during a specific run of an instance.', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", - ], - 'ListTaskInstances' => [ - 'summary' => 'Queries a list of instances. You can also specify filter conditions to query specific instances.', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'ListWorkflowInstances' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -40932,193 +42662,310 @@ 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '240660', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - 'FEATUREdideD0YY7B', - 'FEATUREdideVFMENL', - ], + 'abilityTreeCode' => '260653', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB', 'FEATUREdideD0YY7B', 'FEATUREdideVFMENL'], ], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '100'."\n", - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '100', 'title' => ''], ], [ - 'name' => 'Bizdate', + 'name' => 'BizDate', 'in' => 'formData', - 'schema' => [ - 'description' => 'The data timestamp. The value of this parameter is 00:00:00 of the day before the scheduling time of the instance. The value is a UNIX timestamp. Unit: milliseconds. Example: 1743350400000.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1710239005403', - ], + 'schema' => ['description' => 'The business date. This is generally 00:00:00 of the day before the scheduled instance trigger time, in millisecond-level timestamp format, such as 1743350400000.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1710239005403', 'title' => ''], ], [ - 'name' => 'TaskId', + 'name' => 'Type', 'in' => 'formData', 'schema' => [ - 'description' => 'The ID of the task for which the instance is generated.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The type of the workflow instance.'."\n" + ."\n" + .'- Normal: Periodic scheduling'."\n" + ."\n" + .'- Manual: Manual task'."\n" + ."\n" + .'- SmokeTest: Testing'."\n" + ."\n" + .'- SupplementData: Backfill data'."\n" + ."\n" + .'- ManualWorkflow: Manual workflow'."\n" + ."\n" + .'- TriggerWorkflow: Trigger-based workflow', + 'enumValueTitles' => [], + 'type' => 'string', + 'default' => 'Normal', + 'enum' => ['Normal', 'ManualWorkflow', 'Manual', 'SupplementData', 'SmokeTest', 'TriggerWorkflow'], + 'title' => '', 'required' => false, - 'example' => '1234', + 'example' => 'Normal', ], ], [ - 'name' => 'TaskIds', + 'name' => 'WorkflowId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the workflow to which the instance belongs.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234', 'title' => ''], + ], + [ + 'name' => 'UnifiedWorkflowInstanceId', + 'in' => 'formData', + 'schema' => ['description' => 'The unified workflow instance ID. All workflow instances within the same business date of a single trigger share the same value for this field.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['description' => 'The name. Fuzzy match is supported.', 'type' => 'string', 'required' => false, 'example' => 'WorkflowInstance1', 'title' => ''], + ], + [ + 'name' => 'Ids', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'The IDs of the tasks. You can query multiple instances at a time by task ID.'."\n", + 'description' => 'The list of workflow instance IDs. You can use this parameter to query multiple workflow instances at a time.', 'type' => 'array', - 'items' => [ - 'description' => 'The task ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1234', - ], + 'items' => ['description' => 'The workflow instance ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234', 'title' => ''], 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'TaskName', + 'name' => 'Owner', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the task. Fuzzy match is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SQL node', - ], + 'schema' => ['description' => 'The account ID of the owner.', 'type' => 'string', 'required' => false, 'example' => '1000', 'title' => ''], ], [ - 'name' => 'Owner', + 'name' => 'SortBy', 'in' => 'formData', - 'schema' => [ - 'description' => 'The account ID of the task owner.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1000', - ], + 'schema' => ['description' => 'The list of sort fields. Sorting by trigger time, start time, and other fields is supported. The format is "sort field + sort order (Desc/Asc)" (Asc can be omitted). Valid values of the sort field:'."\n" + ."\n" + .'- TriggerTime (Desc/Asc)'."\n" + ."\n" + .'- StartedTime (Desc/Asc)'."\n" + ."\n" + .'- FinishedTime (Desc/Asc)'."\n" + ."\n" + .'- CreateTime (Desc/Asc)'."\n" + ."\n" + .'- Id (Desc/Asc)'."\n" + ."\n" + .'Default value: Id Desc', 'type' => 'string', 'required' => false, 'example' => 'Id Desc', 'title' => ''], ], [ - 'name' => 'TaskType', + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => ['description' => 'The number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => ['description' => 'The page number, starting from 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Tags', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The type of the task for which the instance is generated.'."\n", - 'type' => 'string', + 'description' => 'The list of tags. Results are returned if any one of the specified tags is matched.', + 'type' => 'array', + 'items' => ['description' => 'The tag. Format: `key:value`. If the value is empty, the format is: `key:`', 'type' => 'string', 'required' => false, 'example' => 'key:value', 'title' => ''], 'required' => false, - 'example' => 'ODPS_SQL', 'title' => '', + 'example' => '', ], ], [ - 'name' => 'RuntimeResource', + 'name' => 'Filter', 'in' => 'formData', - 'schema' => [ - 'description' => 'The information about the resource group. Set this parameter to the identifier of a resource group for scheduling.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX'."\n", - ], + 'schema' => ['description' => 'The filter. In JSON format, multiple filter conditions have an AND relationship. Currently supported fields are: `status, executionDate`.', 'type' => 'string', 'required' => false, 'example' => '{ '."\n" + .' "status": "Success",'."\n" + .' "executionDate": "1763481600000"'."\n" + .'}', 'title' => ''], ], [ - 'name' => 'WorkflowId', + 'name' => 'EnvType', 'in' => 'formData', 'schema' => [ - 'description' => 'The ID of the workflow to which the instance belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1234'."\n", + 'type' => 'string', + 'example' => 'Prod', + 'default' => 'Prod', + 'enum' => ['Prod', 'Dev'], + 'description' => '', + 'title' => '', ], ], - [ - 'name' => 'UnifiedWorkflowInstanceId', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID. Used for locating logs and troubleshooting issues.', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX', 'title' => ''], + 'PagingInfo' => [ + 'description' => 'The pagination information.', + 'type' => 'object', + 'properties' => [ + 'WorkflowInstances' => [ + 'description' => 'The list of workflow instances.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The unique identifier of the workflow instance.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'WorkflowTaskInstanceId' => ['description' => 'The task instance ID corresponding to the workflow instance.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'UnifiedWorkflowInstanceId' => ['description' => 'The unified workflow instance ID. All workflow instances within the same business date of a single trigger share the same value for this field.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'Name' => ['description' => 'The name.', 'type' => 'string', 'example' => 'WorkflowInstance1', 'title' => ''], + 'Type' => ['description' => 'The type of the workflow instance.'."\n" + ."\n" + .'- Normal: Periodic scheduling'."\n" + ."\n" + .'- Manual: Manual task'."\n" + ."\n" + .'- SmokeTest: Testing'."\n" + ."\n" + .'- SupplementData: Backfill data'."\n" + ."\n" + .'- ManualWorkflow: Manual workflow'."\n" + ."\n" + .'- TriggerWorkflow: Trigger-based workflow', 'type' => 'string', 'title' => '', 'example' => 'Normal'], + 'Status' => ['description' => 'The running status of the workflow instance.'."\n" + ."\n" + .'- NotRun: Not run'."\n" + ."\n" + .'- Running: Running'."\n" + ."\n" + .'- WaitTime: Waiting for TriggerTime'."\n" + ."\n" + .'- CheckingCondition: Checking branch conditions'."\n" + ."\n" + .'- WaitResource: Waiting for resources'."\n" + ."\n" + .'- Failure: Failed'."\n" + ."\n" + .'- Success: Succeeded'."\n" + ."\n" + .'- Checking: Submitted for Data Quality check', 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'BizDate' => ['description' => 'The business date.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + 'StartedTime' => ['description' => 'The time when the instance started running.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + 'FinishedTime' => ['description' => 'The time when the instance finished running.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + 'ProjectId' => ['description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'EnvType' => ['description' => 'The project environment.'."\n" + ."\n" + .'- Prod (production)'."\n" + ."\n" + .'- Dev (development)', 'type' => 'string', 'example' => 'Prod', 'title' => ''], + 'Owner' => ['description' => 'The account ID of the workflow owner.', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + 'ModifyTime' => ['description' => 'The modification time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + 'CreateUser' => ['description' => 'The account ID of the user who created the instance.', 'type' => 'string', 'example' => '100', 'title' => ''], + 'ModifyUser' => ['description' => 'The account ID of the user who last modified the instance.', 'type' => 'string', 'example' => '100', 'title' => ''], + 'WorkflowParameters' => ['description' => 'The workflow parameters.', 'type' => 'string', 'example' => '周期工作流：'."\n" + .'key1=value1 key2=value2'."\n" + .'手动业务流程：'."\n" + .'{"key1":"value1", "key2": "value2"}', 'title' => ''], + 'WorkflowId' => ['description' => 'The ID of the workflow to which the instance belongs.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'Tags' => [ + 'title' => '', + 'description' => 'The task tags.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'key1', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'value1', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'TotalCount' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + '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' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1234', + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListWorkflowInstances', + 'summary' => 'Returns a paginated list of workflow instances that can be filtered by specific criteria.', + 'description' => 'Available with DataWorks Basic Edition or higher.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'WorkflowInstanceType', - 'in' => 'formData', - 'schema' => [ - 'title' => '工作流实例类型', - 'description' => 'The type of the workflow instance. Valid values:'."\n" - ."\n" - .'* SmokeTest: Testing'."\n" - .'* Manual: Manually triggered node'."\n" - .'* SupplementData: Data backfill'."\n" - .'* ManualWorkflow: Manually triggered workflow'."\n" - .'* Normal: Scheduled execution'."\n" - .'* TriggerWorkflow: Triggered Workflow'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Normal'."\n", - 'enum' => [ - 'Normal', - 'ManualWorkflow', - 'Manual', - 'SupplementData', - 'SmokeTest', - 'TriggerWorkflow', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"PagingInfo\\": {\\n \\"WorkflowInstances\\": [\\n {\\n \\"Id\\": 1234,\\n \\"WorkflowTaskInstanceId\\": 1234,\\n \\"UnifiedWorkflowInstanceId\\": 1234,\\n \\"Name\\": \\"WorkflowInstance1\\",\\n \\"Type\\": \\"Normal\\",\\n \\"Status\\": \\"Success\\",\\n \\"BizDate\\": 1710239005403,\\n \\"StartedTime\\": 1710239005403,\\n \\"FinishedTime\\": 1710239005403,\\n \\"ProjectId\\": 100,\\n \\"EnvType\\": \\"Prod\\",\\n \\"Owner\\": \\"1000\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"100\\",\\n \\"ModifyUser\\": \\"100\\",\\n \\"WorkflowParameters\\": \\"周期工作流：\\\\nkey1=value1 key2=value2\\\\n手动业务流程：\\\\n{\\\\\\"key1\\\\\\":\\\\\\"value1\\\\\\", \\\\\\"key2\\\\\\": \\\\\\"value2\\\\\\"}\\",\\n \\"WorkflowId\\": 1234,\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ]\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1\\n }\\n}","type":"json"}]', + ], + 'ListWorkflows' => [ + 'summary' => 'Queries a list of workflows by page. You can also specify filter conditions to query workflows.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '253457', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB', 'FEATUREdideD0YY7B', 'FEATUREdideVFMENL'], + ], + 'parameters' => [ [ - 'name' => 'WorkflowInstanceId', + 'name' => 'ProjectId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The workflow instance ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1234', - ], + 'schema' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '100', 'title' => ''], ], [ - 'name' => 'ProjectEnv', + 'name' => 'EnvType', 'in' => 'formData', 'schema' => [ 'description' => 'The environment of the workspace. Valid values:'."\n" ."\n" - .'* Prod: production environment'."\n" - .'* Dev: development environment'."\n", - 'type' => 'string', - 'required' => false, + .'- Prod: production environment'."\n" + ."\n" + .'- Dev: development environment', 'enumValueTitles' => [], - 'example' => 'Prod', + 'type' => 'string', 'default' => 'Prod', - 'enum' => [ - 'Prod', - 'Dev', - ], - ], - ], - [ - 'name' => 'Id', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the instance. The instance may be rerun. If the instance is rerun and you configure this parameter, the system returns the historical information of the instance, including the rerun information. You can use the RunNumber parameter to distinguish each entry in the historical information.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'enum' => ['Prod', 'Dev'], 'required' => false, - 'example' => '1234', + 'example' => 'Prod', + 'title' => '', ], ], [ @@ -41126,140 +42973,78 @@ 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'The IDs of the instances. You can query multiple instances at a time by instance ID.'."\n", + 'description' => 'The IDs of the workflows. You can query multiple workflows at a time by workflow ID.', 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1234', - ], + 'items' => ['description' => 'The workflow ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234', 'title' => ''], 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'TriggerType', + 'name' => 'Name', 'in' => 'formData', - 'schema' => [ - 'description' => 'The trigger type. Valid values:'."\n" - ."\n" - .'* Scheduler: scheduling cycle-based trigger'."\n" - .'* Manual: manual trigger'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Normal'."\n", - 'enum' => [ - 'Scheduler', - 'Manual', - ], - ], + 'schema' => ['description' => 'The name of the workflow. Fuzzy match is supported.', 'type' => 'string', 'required' => false, 'example' => 'Workflow1', 'title' => ''], ], [ - 'name' => 'TriggerRecurrence', + 'name' => 'Owner', 'in' => 'formData', - 'schema' => [ - 'description' => 'The running mode of the instance after it is triggered. This parameter takes effect only if the TriggerType parameter is set to Scheduler. Valid values:'."\n" - ."\n" - .'* Pause'."\n" - .'* Skip'."\n" - .'* Normal'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Normal', - 'enum' => [ - 'Normal', - 'Skip', - 'Pause', - ], - ], + 'schema' => ['description' => 'The account ID of the workflow owner.', 'type' => 'string', 'required' => false, 'example' => '1000', 'title' => ''], ], [ - 'name' => 'SortBy', + 'name' => 'TriggerType', 'in' => 'formData', 'schema' => [ - 'description' => 'The field used for sorting. Fields such as TriggerTime and StartedTime are supported. The value of this parameter is in the Sort field + Sort by (Desc/Asc) format. By default, results are sorted in ascending order. Valid values:'."\n" - ."\n" - .'* `TriggerTime (Desc/Asc)`'."\n" - ."\n" - .'* `StartedTime (Desc/Asc)`'."\n" - ."\n" - .'* `FinishedTime (Desc/Asc)`'."\n" + 'description' => 'The trigger type.'."\n" ."\n" - .'* `CreateTime (Desc/Asc)`'."\n" + .'- Scheduler'."\n" ."\n" - .'* `Id (Desc/Asc)`'."\n" + .'- Manual'."\n" ."\n" - .' Default value: `Id Desc`.'."\n", + .'- TriggerWorkflow', + 'enumValueTitles' => [], 'type' => 'string', + 'default' => 'Scheduler', + 'enum' => ['Scheduler', 'Manual', 'TriggerWorkflow'], 'required' => false, - 'example' => 'Id Desc', + 'example' => 'Scheduler', + 'title' => '', ], ], [ - 'name' => 'PageSize', + 'name' => 'SortBy', 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The field used for sorting. Fields such as TriggerTime and StartedTime are supported. The value of this parameter is in the Sort field + Sort by (Desc/Asc) format. By default, results are sorted in ascending order. Valid values:'."\n" + ."\n" + .'- ModifyTime (Desc/Asc)'."\n" + ."\n" + .'- CreateTime (Desc/Asc)'."\n" + ."\n" + .'- Id (Desc/Asc)'."\n" + ."\n" + .'Default value: Id Desc.', 'type' => 'string', 'required' => false, 'example' => 'Id Desc', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'PageSize', 'in' => 'formData', - '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 number of entries per page. Default value: 10.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'Status', + 'name' => 'PageNumber', 'in' => 'formData', - 'schema' => [ - 'description' => 'The status of the task instance.'."\n" - ."\n" - .'* `NotRun`: Not started'."\n" - .'* `Running`'."\n" - .'* `Failure`'."\n" - .'* `Success`'."\n" - .'* `WaitTime`: Awaiting scheduled time'."\n" - .'* `WaitResource`: Awaiting resources'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Success', - 'enum' => [ - 'NotRun', - 'Running', - 'Failure', - 'Success', - 'WaitTime', - 'WaitResource', - ], - ], + 'schema' => ['description' => 'The page number. Pages start from page 1. Default value: 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Filter', + 'name' => 'Tags', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'List of tags. A result is returned if it matches any one of the specified tags.', + 'type' => 'array', + 'items' => ['description' => 'Tag. Format: `key:value`. If the value is empty, the format is: `key:`', 'type' => 'string', 'required' => false, 'example' => 'key:value', 'title' => ''], 'required' => false, - 'example' => '{'."\n" - .' "startedTimeStart": "1763481600000",'."\n" - .' "startedTimeEnd": "1763481600000",'."\n" - .' "finishedTimeStart": "1763481600000",'."\n" - .' "finishedTimeEnd": "1763481600000",'."\n" - .' "createTimeStart": "1763481600000",'."\n" - .' "createTimeEnd": "1763481600000"'."\n" - .'}'."\n", + 'title' => '', + 'example' => '', ], ], ], @@ -41268,1819 +43053,797 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX', 'title' => ''], 'PagingInfo' => [ - 'description' => 'Pagination information.'."\n", + 'description' => 'Pagination information.', 'type' => 'object', 'properties' => [ - 'TaskInstances' => [ - 'description' => 'The list of task instances.'."\n", + 'Workflows' => [ + 'description' => 'The workflows.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'TaskId' => [ - 'description' => 'The ID of the task for which the instance is generated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234'."\n", - ], - 'TaskType' => [ - 'title' => '任务类型', - 'description' => 'The type of the task for which the instance is generated.'."\n", - 'type' => 'string', - 'example' => 'ODPS_SQL'."\n", - ], - 'TaskName' => [ - 'description' => 'The name of the task for which the instance is generated.'."\n", - 'type' => 'string', - 'example' => 'SQL node', - ], - 'Description' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'test'."\n", - ], - 'WorkflowId' => [ - 'description' => 'The ID of the workflow to which the instance belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234'."\n", - ], - 'WorkflowName' => [ - 'description' => 'The name of the workflow to which the instance belongs.'."\n", - 'type' => 'string', - 'example' => 'Test workflow', - ], - 'TriggerType' => [ - 'description' => 'The trigger type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Scheduler: scheduling cycle-based trigger'."\n" - .'* Manual: manual trigger'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Scheduler'."\n", - ], - 'TriggerRecurrence' => [ - 'description' => 'The running mode of the instance after it is triggered. This parameter takes effect only if the TriggerType parameter is set to Scheduler.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Pause'."\n" - .'* Skip'."\n" - .'* Normal'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Normal'."\n", - ], - 'WorkflowInstanceId' => [ - 'description' => 'The workflow instance ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'UnifiedWorkflowInstanceId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'WorkflowInstanceType' => [ - 'description' => 'The type of the workflow instance.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* SmokeTest'."\n" - .'* SupplementData'."\n" - .'* Manual'."\n" - .'* ManualWorkflow'."\n" - .'* Normal'."\n" - .'* ManualFlow'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Normal', - ], - 'Timeout' => [ - 'description' => 'The timeout period of task running. Unit: seconds.'."\n" - ."\n" - .'Note: The value of this parameter is rounded up by hour.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RerunMode' => [ - 'title' => '任务是否允许重跑的配置', - 'description' => 'The rerun mode'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* AllDenied: The task cannot be rerun regardless of whether the task is successfully run or fails to run.'."\n" - .'* FailureAllowed: The task can be rerun only after it fails to run.'."\n" - .'* AllAllowed: The task can be rerun regardless of whether the task is successfully run or fails to run.'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'AllAllowed'."\n", - ], - 'RunNumber' => [ - 'description' => 'The number of times the task is run. By default, the value starts from 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PeriodNumber' => [ - 'description' => 'The sequence number of the cycle. This parameter indicates the cycle of the task instance on the current day.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'BaselineId' => [ - 'description' => 'The baseline ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'Priority' => [ - 'description' => 'The priority of the task. Minimum value: 1. Maximum value: 8. A larger value indicates a higher priority. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RuntimeResource' => [ - 'description' => 'The information about the resource group with which the instance is associated.'."\n", - 'type' => 'object', - 'properties' => [ - 'ResourceGroupId' => [ - 'description' => 'The ID of the resource group for scheduling configured for task running.'."\n", - 'type' => 'string', - 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', - ], - 'Image' => [ - 'description' => 'The ID of the image configured for task running.'."\n", - 'type' => 'string', - 'example' => 'i-xxxxxx'."\n", - ], - 'Cu' => [ - 'description' => 'The default number of CUs configured for task running.'."\n", - 'type' => 'string', - 'example' => '0.25'."\n", - ], - ], - ], - 'Runtime' => [ - 'description' => 'The runtime information about the instance.'."\n", + 'Id' => ['description' => 'The workflow ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'Name' => ['description' => 'The name.', 'type' => 'string', 'example' => 'Workflow1', 'title' => ''], + 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'Trigger' => [ + 'description' => 'The trigger method.', 'type' => 'object', 'properties' => [ - 'ProcessId' => [ - 'description' => 'The instance run ID.'."\n", - 'type' => 'string', - 'example' => 'T3_123'."\n", - ], - 'Gateway' => [ - 'description' => 'The host for running.'."\n", - 'type' => 'string', - 'example' => 'cn-shanghai.1.2'."\n", - ], + 'Type' => ['description' => 'The trigger type. Valid values:'."\n" + ."\n" + .'- Scheduler: scheduling cycle-based trigger'."\n" + ."\n" + .'- Manual: manual trigger', 'type' => 'string', 'title' => '', 'example' => 'Scheduler'], + 'Recurrence' => ['description' => 'The running mode of the workflow after it is triggered. This parameter takes effect only if the Type parameter is set to Scheduler. Valid values:'."\n" + ."\n" + .'- Pause'."\n" + ."\n" + .'- Skip'."\n" + ."\n" + .'- Normal', 'type' => 'string', 'example' => 'Normal', 'title' => ''], + 'Cron' => ['description' => 'The CRON expression. This parameter takes effect only if the Type parameter is set to Scheduler.', 'type' => 'string', 'example' => '00 00 00 * * ?', 'title' => ''], + 'StartTime' => ['description' => 'The start time of the time range during which the workflow is periodically scheduled. This parameter takes effect only if the Type parameter is set to Scheduler.', 'type' => 'string', 'example' => '1970-01-01 00:00:00', 'title' => ''], + 'EndTime' => ['description' => 'The end time of the time range during which the workflow is periodically scheduled. This parameter takes effect only if the Type parameter is set to Scheduler.', 'type' => 'string', 'example' => '9999-01-01 00:00:00', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'DataSource' => [ - 'description' => 'The information about the associated data source.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the data source.'."\n", - 'type' => 'string', - 'example' => 'mysql_test'."\n", + 'Parameters' => ['description' => 'The parameters.', 'type' => 'string', 'example' => 'para1=$bizdate para2=$[yyyymmdd] ', 'title' => ''], + 'ClientUniqueCode' => ['description' => 'The unique code of the client. This parameter is used to create a workflow asynchronously and implement the idempotence of the workflow. If you do not specify this parameter when you create the workflow, the system automatically generates a unique code. The unique code is uniquely associated with the workflow ID. If you specify this parameter when you update or delete the workflow, the value of this parameter must be the unique code that is used to create the workflow.', 'type' => 'string', 'example' => 'Workflow_0bc5213917368545132902xxxxxxxx', 'title' => ''], + 'ProjectId' => ['description' => 'The workspace ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '100', 'title' => ''], + 'EnvType' => ['description' => 'The environment of the workspace. Valid values:'."\n" + ."\n" + .'- Prod'."\n" + ."\n" + .'- Dev', 'type' => 'string', 'example' => 'Prod', 'title' => ''], + 'Owner' => ['description' => 'The account ID of the owner.', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + 'ModifyTime' => ['description' => 'The modification time.', 'type' => 'integer', 'format' => 'int64', 'example' => '1710239005403', 'title' => ''], + 'CreateUser' => ['description' => 'The account ID of the creator.', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'ModifyUser' => ['description' => 'The account ID of the modifier.', 'type' => 'string', 'example' => '1000', 'title' => ''], + 'Tags' => [ + 'title' => '', + 'description' => 'The task tag.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The key of a tag.', 'type' => 'string', 'example' => 'key1', 'title' => ''], + 'Value' => ['description' => 'The value of a tag.', 'type' => 'string', 'example' => 'value1', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - ], - 'Status' => [ - 'title' => '实例运行状态', - 'description' => 'The status of the instance.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* NotRun: The instance is not run.'."\n" - .'* Running: The instance is running.'."\n" - .'* WaitTime: The instance is waiting for the scheduling time to arrive.'."\n" - .'* CheckingCondition: Branch conditions are being checked for the instance.'."\n" - .'* WaitResource: The instance is waiting for resources.'."\n" - .'* Failure: The instance fails to be run.'."\n" - .'* Success: The instance is successfully run.'."\n" - .'* Checking: Data quality is being checked for the instance.'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Success', - ], - 'TriggerTime' => [ - 'description' => 'The scheduling time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403'."\n", - ], - 'Bizdate' => [ - 'description' => 'The data timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403'."\n", - ], - 'StartedTime' => [ - 'description' => 'The time when the instance started to run.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403'."\n", - ], - 'FinishedTime' => [ - 'description' => 'The time when the instance finished running.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403'."\n", - ], - 'Id' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234'."\n", - ], - 'ProjectId' => [ - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'ProjectEnv' => [ - 'description' => 'The environment of the workspace.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Prod: production environment'."\n" - .'* Dev: development environment'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Prod', - ], - 'Owner' => [ - 'description' => 'The account ID of the task owner.'."\n", - 'type' => 'string', - 'example' => '1000', - ], - 'CreateTime' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403'."\n", - ], - 'ModifyTime' => [ - 'description' => 'The modification time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403'."\n", - ], - 'CreateUser' => [ - 'description' => 'The account ID of the user who creates the instance.'."\n", - 'type' => 'string', - 'example' => '1000', - ], - 'ModifyUser' => [ - 'description' => 'The account ID of the user who modifies the instance.'."\n", - 'type' => 'string', - 'example' => '1000', - ], - 'ScriptParameters' => [ - 'description' => 'The script parameter list.'."\n", - 'type' => 'string', - 'example' => 'para1=val1 para2=val2', - ], - 'WaitingResourceTime' => [ - 'description' => 'The timestamp for when it started waiting for resources.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], - 'WaitingTriggerTime' => [ - 'description' => 'The timestamp for when it started waiting for the scheduled time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - '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 entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + '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' => ''], ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"PagingInfo\\": {\\n \\"Workflows\\": [\\n {\\n \\"Id\\": 1234,\\n \\"Name\\": \\"Workflow1\\",\\n \\"Description\\": \\"test\\",\\n \\"Trigger\\": {\\n \\"Type\\": \\"Scheduler\\",\\n \\"Recurrence\\": \\"Normal\\",\\n \\"Cron\\": \\"00 00 00 * * ?\\",\\n \\"StartTime\\": \\"1970-01-01 00:00:00\\",\\n \\"EndTime\\": \\"9999-01-01 00:00:00\\"\\n },\\n \\"Parameters\\": \\"para1=$bizdate para2=$[yyyymmdd] \\",\\n \\"ClientUniqueCode\\": \\"Workflow_0bc5213917368545132902xxxxxxxx\\",\\n \\"ProjectId\\": 100,\\n \\"EnvType\\": \\"Prod\\",\\n \\"Owner\\": \\"1000\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"1000\\",\\n \\"ModifyUser\\": \\"1000\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ]\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1\\n }\\n}","type":"json"}]', + 'title' => 'ListWorkflows', + 'description' => 'You must purchase DataWorks Basic Edition or a higher edition to use this feature.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"PagingInfo\\": {\\n \\"TaskInstances\\": [\\n {\\n \\"TaskId\\": 1234,\\n \\"TaskType\\": \\"ODPS_SQL\\\\n\\",\\n \\"TaskName\\": \\"SQL node\\\\n\\",\\n \\"Description\\": \\"test\\\\n\\",\\n \\"WorkflowId\\": 1234,\\n \\"WorkflowName\\": \\"Test workflow\\\\n\\",\\n \\"TriggerType\\": \\"Scheduler\\\\n\\",\\n \\"TriggerRecurrence\\": \\"Normal\\\\n\\",\\n \\"WorkflowInstanceId\\": 1234,\\n \\"UnifiedWorkflowInstanceId\\": 1234,\\n \\"WorkflowInstanceType\\": \\"Normal\\",\\n \\"Timeout\\": 3600,\\n \\"RerunMode\\": \\"AllAllowed\\\\n\\",\\n \\"RunNumber\\": 1,\\n \\"PeriodNumber\\": 1,\\n \\"BaselineId\\": 1234,\\n \\"Priority\\": 1,\\n \\"RuntimeResource\\": {\\n \\"ResourceGroupId\\": \\"S_res_group_524258031846018_1684XXXXXXXXX\\",\\n \\"Image\\": \\"i-xxxxxx\\\\n\\",\\n \\"Cu\\": \\"0.25\\\\n\\"\\n },\\n \\"Runtime\\": {\\n \\"ProcessId\\": \\"T3_123\\\\n\\",\\n \\"Gateway\\": \\"cn-shanghai.1.2\\\\n\\"\\n },\\n \\"DataSource\\": {\\n \\"Name\\": \\"mysql_test\\\\n\\"\\n },\\n \\"Status\\": \\"Success\\",\\n \\"TriggerTime\\": 1710239005403,\\n \\"Bizdate\\": 1710239005403,\\n \\"StartedTime\\": 1710239005403,\\n \\"FinishedTime\\": 1710239005403,\\n \\"Id\\": 1234,\\n \\"ProjectId\\": 100,\\n \\"ProjectEnv\\": \\"Prod\\",\\n \\"Owner\\": \\"1000\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"1000\\",\\n \\"ModifyUser\\": \\"1000\\",\\n \\"ScriptParameters\\": \\"para1=val1 para2=val2\\",\\n \\"WaitingResourceTime\\": 1710239005403,\\n \\"WaitingTriggerTime\\": 1710239005403\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1\\n }\\n}","type":"json"}]', - 'title' => 'ListTaskInstances', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", + 'ramActions' => [], ], - 'ListUpstreamTaskInstances' => [ - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'LoadAgentSession' => [ + 'summary' => 'Loads the message history of an existing session and returns it as an SSE stream. If the session does not exist, the server sends a JSONRPCResponse.error with a code of 400 through the SSE stream. The Content-Type is text/event-stream. Use this operation to restore session context.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https', 'sse'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '240661', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - 'FEATUREdideD0YY7B', - 'FEATUREdideVFMENL', - ], + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdideEWGMTH'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ + [ + 'name' => 'Jsonrpc', + 'in' => 'formData', + 'schema' => ['description' => 'The JSON-RPC version. The value must be `2.0`.', 'type' => 'string', 'required' => false, 'example' => '2.0', 'title' => ''], + ], [ 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The client-generated request ID, which is returned in the response.', 'type' => 'string', 'required' => false, 'example' => '4as3dasf654a', 'title' => ''], ], [ - 'name' => 'PageSize', - 'in' => 'query', + 'name' => 'Params', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'type' => 'object', + 'properties' => [ + 'SessionId' => ['description' => 'The ID of the target session. If the session does not exist, an SSE error frame is returned.', 'type' => 'string', 'required' => false, 'example' => 'sess_0f12abc34', 'title' => ''], + 'Meta' => [ + 'type' => 'object', + 'properties' => [ + 'IsReload' => ['description' => 'Specifies whether to use resumable transfer. If the SSE stream is interrupted due to issues like an unstable network connection, you can set this parameter to `true` to re-fetch the stream data from the point of failure.', 'type' => 'boolean', 'required' => false, 'example' => 'true or false', 'title' => ''], + 'BeginLogOffset' => ['description' => 'In a resumable transfer scenario, this specifies the offset from which to resume fetching the SSE output.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000', 'title' => ''], + ], + 'description' => 'DataWorks-specific extended parameters for ACP.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'Business parameters.', 'required' => false, - 'example' => '10', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'PageNumber', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The unique request ID generated for this request.', 'type' => 'string', 'title' => '', 'example' => '0D41C608-0C60-5EB0-B986-1460909CF642'], + 'Timestamp' => ['description' => 'The timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1769479322828', 'title' => ''], + 'Jsonrpc' => ['description' => 'The JSON-RPC version. The value is `2.0`.', 'type' => 'string', 'example' => '2.0', 'title' => ''], + 'Id' => ['description' => 'The client-generated request ID, returned from the request.', 'type' => 'string', 'example' => '676303114031776', 'title' => ''], + 'Result' => ['description' => 'The result object of the SSE frame. This field is present when the operation is successful.', 'type' => 'any', 'example' => '{"stopReason":"end_turn"}', 'title' => ''], + 'Error' => ['description' => 'The error object of the SSE frame. This field is present when an error occurs.', 'type' => 'any', 'example' => '{"code": 400, "errorCode": "0x50000000001", "message": "not exist session", "data": null}', 'title' => ''], + 'Method' => ['description' => 'The method of the SSE frame.', 'type' => 'string', 'example' => 'session/update', 'title' => ''], + 'Params' => ['description' => 'The parameters of the SSE frame.', 'type' => 'any', 'example' => '{"sessionId":"af4f5ef8-e8f5-481c-ad1f-94886c6c0aed","update":{"sessionUpdate":"agent_message_chunk","content":{"type":"text","text":"hello world"}}}', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'LoadAgentSession', + 'description' => '## Request'."\n" + ."\n" + .'- This operation retrieves session details and streams the Agent response using Server-Sent Events (SSE).'."\n" + ."\n" + .'- If the target session does not exist, the operation returns an error frame with an error code of 400.'."\n" + ."\n" + .'- The response includes information about the Agent\'s request processing, such as message chunks, thought processes, and tool call status updates.'."\n" + ."\n" + .'- The `stopReason` field indicates why the Agent stops the current turn. Possible values include reaching the maximum turn limit or being canceled.'."\n" + ."\n" + .'- The returned content conforms to the Agent Client Protocol (ACP). For more information, see https\\://agentclientprotocol.com.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dataworks:LoadAgentSession', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0D41C608-0C60-5EB0-B986-1460909CF642\\",\\n \\"Timestamp\\": 1769479322828,\\n \\"Jsonrpc\\": \\"2.0\\",\\n \\"Id\\": \\"676303114031776\\",\\n \\"Result\\": \\"{\\\\\\"stopReason\\\\\\":\\\\\\"end_turn\\\\\\"}\\",\\n \\"Error\\": \\"{\\\\\\"code\\\\\\": 400, \\\\\\"errorCode\\\\\\": \\\\\\"0x50000000001\\\\\\", \\\\\\"message\\\\\\": \\\\\\"not exist session\\\\\\", \\\\\\"data\\\\\\": null}\\",\\n \\"Method\\": \\"session/update\\",\\n \\"Params\\": \\"{\\\\\\"sessionId\\\\\\":\\\\\\"af4f5ef8-e8f5-481c-ad1f-94886c6c0aed\\\\\\",\\\\\\"update\\\\\\":{\\\\\\"sessionUpdate\\\\\\":\\\\\\"agent_message_chunk\\\\\\",\\\\\\"content\\\\\\":{\\\\\\"type\\\\\\":\\\\\\"text\\\\\\",\\\\\\"text\\\\\\":\\\\\\"hello world\\\\\\"}}}\\"\\n}","type":"json"}]', + ], + 'MoveFunction' => [ + 'summary' => 'Moves a user-defined function (UDF) to a path in DataStudio.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236059', + 'abilityTreeNodes' => ['FEATUREdideZOYJZL'], + ], + '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 ID.'."\n" + ."\n" + .'This parameter indicates the DataWorks workspace to which the API operation is applied.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12345', 'title' => ''], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => 'The unique identifier of the UDF.'."\n" + ."\n" + .'> This field is of the Long type in SDK versions prior to 8.0.0, and of the String type in SDK versions 8.0.0 and later. This change does not affect normal SDK usage; the parameter will still be returned according to the type defined in the SDK.. However, compilation failures may occur due to the type change only when upgrading the SDK across version 8.0.0. In this case, you must manually update the data type.', 'type' => 'string', 'required' => true, 'example' => '543217824470354XXXX', 'title' => ''], + ], + [ + 'name' => 'Path', + 'in' => 'formData', + 'schema' => ['description' => 'The unique identifier of the UDF.'."\n" + ."\n" + .'> Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect normal SDK usage; the parameter will still be returned according to the type defined in the SDK.. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.', 'type' => 'string', 'required' => true, 'example' => 'root/demo', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n", - ], - 'PagingInfo' => [ - 'description' => 'The pagination information.'."\n", - 'type' => 'object', - 'properties' => [ - 'TaskInstances' => [ - 'description' => 'The instances. This parameter is deprecated and replaced by the UpstreamTaskInstances parameter.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'StepType' => [ - 'title' => '依赖类型', - 'description' => 'The scheduling dependency type. Valid values:'."\n" - ."\n" - .'* Normal: same-cycle scheduling dependency'."\n" - .'* CrossCycle: cross-cycle scheduling dependency'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'TaskId' => [ - 'description' => 'The ID of the task for which the instance is generated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'TaskType' => [ - 'title' => '任务类型', - 'description' => 'The type of the task for which the instance is generated.'."\n", - 'type' => 'string', - 'example' => 'ODPS_SQL'."\n", - ], - 'TaskName' => [ - 'description' => 'The name of the task for which the instance is generated.'."\n", - 'type' => 'string', - 'example' => 'SQL node', - ], - 'Description' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'WorkflowId' => [ - 'description' => 'The ID of the workflow to which the instance belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'WorkflowName' => [ - 'description' => 'The name of the workflow to which the instance belongs.'."\n", - 'type' => 'string', - 'example' => 'Test workflow', - ], - 'TriggerType' => [ - 'description' => 'The trigger type. Valid values:'."\n" - ."\n" - .'* Scheduler: scheduling cycle-based trigger'."\n" - .'* Manual: manual trigger'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Scheduler', - ], - 'TriggerRecurrence' => [ - 'description' => 'The running mode of the instance after it is triggered. This parameter takes effect only if the TriggerType parameter is set to Scheduler. Valid values:'."\n" - ."\n" - .'* Pause'."\n" - .'* Skip'."\n" - .'* Normal'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Normal'."\n", - ], - 'WorkflowInstanceId' => [ - 'description' => 'The workflow instance ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'WorkflowInstanceType' => [ - 'description' => 'The type of the workflow instance. Valid values:'."\n" - ."\n" - .'* SmokeTest'."\n" - .'* SupplementData'."\n" - .'* Manual'."\n" - .'* ManualWorkflow'."\n" - .'* Normal'."\n" - .'* ManualFlow'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Normal'."\n", - ], - 'Timeout' => [ - 'description' => 'The timeout period of task running. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RerunMode' => [ - 'title' => '任务是否允许重跑的配置', - 'description' => 'The rerun mode. Valid values:'."\n" - ."\n" - .'* AllDenied: The task cannot be rerun regardless of whether the task is successfully run or fails to run.'."\n" - .'* FailureAllowed: The task can be rerun only after it fails to run.'."\n" - .'* AllAllowed: The task can be rerun regardless of whether the task is successfully run or fails to run.'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'AllAllowed'."\n", - ], - 'RunNumber' => [ - 'description' => 'The number of times the instance is run. By default, the value starts from 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PeriodNumber' => [ - 'description' => 'The sequence number of the period. Indicates which cycle of the day the task instance is in.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'BaselineId' => [ - 'description' => 'The baseline ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'Priority' => [ - 'description' => 'The priority of the task. Valid values: 1 to 8. A larger value indicates a higher priority. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RuntimeResource' => [ - 'description' => 'The configurations of the runtime environment, such as the resource group information.'."\n", - 'type' => 'object', - 'properties' => [ - 'ResourceGroupId' => [ - 'description' => 'The ID of the resource group for scheduling configured for task running.'."\n", - 'type' => 'string', - 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX'."\n", - ], - 'Image' => [ - 'description' => 'The ID of the image configured for task running.'."\n", - 'type' => 'string', - 'example' => 'i-xxxxxx'."\n", - ], - 'Cu' => [ - 'description' => 'The default number of compute units (CUs) configured for task running.'."\n", - 'type' => 'string', - 'example' => '0.25', - ], - ], - ], - 'Runtime' => [ - 'description' => 'The runtime information about the instance.'."\n", - 'type' => 'object', - 'properties' => [ - 'ProcessId' => [ - 'description' => 'The instance run ID.'."\n", - 'type' => 'string', - 'example' => 'T3_123', - ], - 'Gateway' => [ - 'description' => 'The host for running.'."\n", - 'type' => 'string', - 'example' => 'cn-shanghai.1.2', - ], - ], - ], - 'DataSource' => [ - 'description' => 'The information about the associated data source.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the data source.'."\n", - 'type' => 'string', - 'example' => 'mysql_test', - ], - ], - ], - 'Status' => [ - 'title' => '实例运行状态', - 'description' => 'The status of the instance. Valid values:'."\n" - ."\n" - .'* NotRun: The instance is not run.'."\n" - .'* Running: The instance is running.'."\n" - .'* WaitTime: The instance is waiting for the scheduling time to arrive.'."\n" - .'* CheckingCondition: Branch conditions are being checked for the instance.'."\n" - .'* WaitResource: The instance is waiting for resources.'."\n" - .'* Failure: The instance fails to be run.'."\n" - .'* Success: The instance is successfully run.'."\n" - .'* Checking: Data quality is being checked for the instance.'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Success'."\n", - ], - 'TriggerTime' => [ - 'description' => 'The scheduling time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], - 'Bizdate' => [ - 'description' => 'The data timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], - 'StartedTime' => [ - 'description' => 'The time when the instance started to run.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], - 'FinishedTime' => [ - 'description' => 'The time when the instance finished running.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], - 'Id' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'ProjectId' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'ProjectEnv' => [ - 'description' => 'The environment of the workspace. Valid values:'."\n" - ."\n" - .'* Prod: production environment'."\n" - .'* Dev: development environment'."\n", - 'type' => 'string', - 'deprecated' => true, - 'enumValueTitles' => [], - 'example' => 'Prod'."\n", - ], - 'EnvType' => [ - 'description' => 'The environment of the workspace. Valid values:'."\n" - ."\n" - .'* Prod'."\n" - .'* Dev'."\n", - 'type' => 'string', - 'example' => 'Prod', - ], - 'Owner' => [ - 'description' => 'The account ID of the task owner.'."\n", - 'type' => 'string', - 'example' => '1000', - ], - 'CreateTime' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], - 'ModifyTime' => [ - 'description' => 'The modification time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], - 'CreateUser' => [ - 'description' => 'The account ID of the creator.'."\n", - 'type' => 'string', - 'example' => '1000', - ], - 'ModifyUser' => [ - 'description' => 'The account ID of the modifier.'."\n", - 'type' => 'string', - 'example' => '1000', - ], - ], - 'description' => '', - ], - ], - 'UpstreamTaskInstances' => [ - 'description' => 'The ancestor instances.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'DependencyType' => [ - 'title' => '依赖类型', - 'description' => 'The scheduling dependency type. Valid values:'."\n" - ."\n" - .'* Normal'."\n" - .'* CrossCycle'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'TaskInstance' => [ - 'title' => '任务实例', - 'description' => 'The information about a task instance.'."\n", - 'type' => 'object', - 'properties' => [ - 'TaskId' => [ - 'description' => 'The ID of the task for which the instance is generated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'TaskType' => [ - 'title' => '任务类型', - 'description' => 'The type of the task for which the instance is generated.'."\n", - 'type' => 'string', - 'example' => 'ODPS_SQL', - ], - 'TaskName' => [ - 'description' => 'The name of the task for which the instance is generated.'."\n", - 'type' => 'string', - 'example' => 'SQL node', - ], - 'Description' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'WorkflowId' => [ - 'description' => 'The ID of the workflow to which the instance belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'WorkflowName' => [ - 'description' => 'The name of the workflow to which the instance belongs.'."\n", - 'type' => 'string', - 'example' => 'Test workflow', - ], - 'TriggerType' => [ - 'description' => 'The trigger type. Valid values:'."\n" - ."\n" - .'* Scheduler: scheduling cycle-based trigger'."\n" - .'* Manual: manual trigger'."\n", - 'type' => 'string', - 'example' => 'Scheduler', - ], - 'TriggerRecurrence' => [ - 'description' => 'The running mode of the instance after it is triggered. This parameter takes effect only if the TriggerType parameter is set to Scheduler. Valid values:'."\n" - ."\n" - .'* Pause'."\n" - .'* Skip'."\n" - .'* Normal'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'WorkflowInstanceId' => [ - 'description' => 'The workflow instance ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'WorkflowInstanceType' => [ - 'description' => 'The type of the workflow instance. Valid values:'."\n" - ."\n" - .'* Normal'."\n" - .'* Manual'."\n" - .'* SmokeTest'."\n" - .'* SupplementData'."\n" - .'* ManualWorkflow'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'Timeout' => [ - 'description' => 'The timeout period of task running. Unit: seconds.'."\n" - ."\n" - .'Note: The value of this parameter is rounded up by hour.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3600', - ], - 'RerunMode' => [ - 'title' => '任务是否允许重跑的配置', - 'description' => 'The rerun mode.'."\n", - 'type' => 'string', - 'example' => 'AllAllowed', - ], - 'RunNumber' => [ - 'description' => 'The number of times the instance is run. By default, the value starts from 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PeriodNumber' => [ - 'description' => 'The sequence number of the cycle. This parameter indicates the cycle of the task instance on the current day.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'BaselineId' => [ - 'description' => 'The baseline ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'Priority' => [ - 'description' => 'The priority of the task. Minimum value: 1. Maximum value: 8. A larger value indicates a higher priority. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RuntimeResource' => [ - 'description' => 'The configurations of the runtime environment, such as the resource group information.'."\n", - 'type' => 'object', - 'properties' => [ - 'ResourceGroupId' => [ - 'description' => 'The ID of the resource group for scheduling configured for task running.'."\n", - 'type' => 'string', - 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', - ], - 'Image' => [ - 'description' => 'The ID of the image configured for task running.'."\n", - 'type' => 'string', - 'example' => 'i-xxxxxx', - ], - 'Cu' => [ - 'description' => 'The default number of compute units (CUs) configured for task running.'."\n", - 'type' => 'string', - 'example' => '0.25', - ], - ], - ], - 'Runtime' => [ - 'description' => 'The runtime information about the instance.'."\n", - 'type' => 'object', - 'properties' => [ - 'ProcessId' => [ - 'description' => 'The instance run ID.'."\n", - 'type' => 'string', - 'example' => 'T3_123', - ], - 'Gateway' => [ - 'description' => 'The host for running.'."\n", - 'type' => 'string', - 'example' => 'cn-shanghai.1.2', - ], - ], - ], - 'DataSource' => [ - 'description' => 'The information about the associated data source.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the data source.'."\n", - 'type' => 'string', - 'example' => 'mysql_test', - ], - ], - ], - 'Status' => [ - 'title' => '实例运行状态', - 'description' => 'The status of the instance. Valid values:'."\n" - ."\n" - .'* NotRun: The instance is not run.'."\n" - .'* Running: The instance is running.'."\n" - .'* WaitTime: The instance is waiting for the scheduling time to arrive.'."\n" - .'* CheckingCondition: Branch conditions are being checked for the instance.'."\n" - .'* WaitResource: The instance is waiting for resources.'."\n" - .'* Failure: The instance fails to be run.'."\n" - .'* Success: The instance is successfully run.'."\n" - .'* Checking: Data quality is being checked for the instance.'."\n" - .'* WaitTrigger: The instance is waiting to be triggered by external scheduling systems.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'TriggerTime' => [ - 'description' => 'The scheduling time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], - 'Bizdate' => [ - 'description' => 'The data timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], - 'StartedTime' => [ - 'description' => 'The time when the instance started to run.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], - 'FinishedTime' => [ - 'description' => 'The time when the instance finished running.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], - 'Id' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'ProjectId' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'EnvType' => [ - 'description' => 'The environment in which the data source is used. Valid values:'."\n" - ."\n" - .'* Dev'."\n" - .'* Prod'."\n", - 'type' => 'string', - 'example' => 'Prod', - ], - 'Owner' => [ - 'description' => 'The account ID of the task owner.'."\n", - 'type' => 'string', - 'example' => '1000', - ], - 'CreateTime' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], - 'ModifyTime' => [ - 'description' => 'The modification time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], - 'CreateUser' => [ - 'description' => 'The account ID of the creator.'."\n", - 'type' => 'string', - 'example' => '1000', - ], - 'ModifyUser' => [ - 'description' => 'The account ID of the modifier.'."\n", - 'type' => 'string', - 'example' => '1000', - ], - ], - ], - ], - 'description' => '', - ], - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - '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', - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '48C0E2F0-52BA-5888-BDFA-28F1B9AFXXXX'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], - 'description' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\\\n\\",\\n \\"PagingInfo\\": {\\n \\"TaskInstances\\": [\\n {\\n \\"StepType\\": \\"Normal\\",\\n \\"TaskId\\": 1234,\\n \\"TaskType\\": \\"ODPS_SQL\\\\n\\",\\n \\"TaskName\\": \\"SQL node\\\\n\\",\\n \\"Description\\": \\"test\\",\\n \\"WorkflowId\\": 1234,\\n \\"WorkflowName\\": \\"Test workflow\\",\\n \\"TriggerType\\": \\"Scheduler\\",\\n \\"TriggerRecurrence\\": \\"Normal\\\\n\\",\\n \\"WorkflowInstanceId\\": 1234,\\n \\"WorkflowInstanceType\\": \\"Normal\\\\n\\",\\n \\"Timeout\\": 3600,\\n \\"RerunMode\\": \\"AllAllowed\\\\n\\",\\n \\"RunNumber\\": 1,\\n \\"PeriodNumber\\": 1,\\n \\"BaselineId\\": 1234,\\n \\"Priority\\": 1,\\n \\"RuntimeResource\\": {\\n \\"ResourceGroupId\\": \\"S_res_group_524258031846018_1684XXXXXXXXX\\\\n\\",\\n \\"Image\\": \\"i-xxxxxx\\\\n\\",\\n \\"Cu\\": \\"0.25\\"\\n },\\n \\"Runtime\\": {\\n \\"ProcessId\\": \\"T3_123\\",\\n \\"Gateway\\": \\"cn-shanghai.1.2\\"\\n },\\n \\"DataSource\\": {\\n \\"Name\\": \\"mysql_test\\"\\n },\\n \\"Status\\": \\"Success\\\\n\\",\\n \\"TriggerTime\\": 1710239005403,\\n \\"Bizdate\\": 1710239005403,\\n \\"StartedTime\\": 1710239005403,\\n \\"FinishedTime\\": 1710239005403,\\n \\"Id\\": 1234,\\n \\"ProjectId\\": 100,\\n \\"ProjectEnv\\": \\"Prod\\\\n\\",\\n \\"EnvType\\": \\"Prod\\",\\n \\"Owner\\": \\"1000\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"1000\\",\\n \\"ModifyUser\\": \\"1000\\"\\n }\\n ],\\n \\"UpstreamTaskInstances\\": [\\n {\\n \\"DependencyType\\": \\"Normal\\",\\n \\"TaskInstance\\": {\\n \\"TaskId\\": 1234,\\n \\"TaskType\\": \\"ODPS_SQL\\",\\n \\"TaskName\\": \\"SQL node\\",\\n \\"Description\\": \\"test\\",\\n \\"WorkflowId\\": 1234,\\n \\"WorkflowName\\": \\"Test workflow\\",\\n \\"TriggerType\\": \\"Scheduler\\",\\n \\"TriggerRecurrence\\": \\"Normal\\",\\n \\"WorkflowInstanceId\\": 1234,\\n \\"WorkflowInstanceType\\": \\"Normal\\",\\n \\"Timeout\\": 3600,\\n \\"RerunMode\\": \\"AllAllowed\\",\\n \\"RunNumber\\": 1,\\n \\"PeriodNumber\\": 1,\\n \\"BaselineId\\": 1234,\\n \\"Priority\\": 1,\\n \\"RuntimeResource\\": {\\n \\"ResourceGroupId\\": \\"S_res_group_524258031846018_1684XXXXXXXXX\\",\\n \\"Image\\": \\"i-xxxxxx\\",\\n \\"Cu\\": \\"0.25\\"\\n },\\n \\"Runtime\\": {\\n \\"ProcessId\\": \\"T3_123\\",\\n \\"Gateway\\": \\"cn-shanghai.1.2\\"\\n },\\n \\"DataSource\\": {\\n \\"Name\\": \\"mysql_test\\"\\n },\\n \\"Status\\": \\"Success\\",\\n \\"TriggerTime\\": 1710239005403,\\n \\"Bizdate\\": 1710239005403,\\n \\"StartedTime\\": 1710239005403,\\n \\"FinishedTime\\": 1710239005403,\\n \\"Id\\": 1234,\\n \\"ProjectId\\": 100,\\n \\"EnvType\\": \\"Prod\\",\\n \\"Owner\\": \\"1000\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"1000\\",\\n \\"ModifyUser\\": \\"1000\\"\\n }\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1\\n }\\n}","type":"json"}]', - 'title' => 'ListUpstreamTaskInstances', - 'summary' => 'Queries a list of ancestor instances of an instance by page.', - ], - 'ListTaskInstanceOperationLogs' => [ - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"48C0E2F0-52BA-5888-BDFA-28F1B9AFXXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'MoveFunction', + 'changeSet' => [ + ['createdAt' => '2025-01-13T07:35:59.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'MoveNode' => [ + 'summary' => 'Moves a node to a path in DataStudio.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '240664', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - ], + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236795', + 'abilityTreeNodes' => ['FEATUREdideHO4TQP', 'FEATUREdide8FM783', 'FEATUREdideQUQUVB', 'FEATUREdideIQU97M'], ], '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 query the ID.'."\n" + ."\n" + .'You can use this parameter to specify the DataWorks workspace on which you want to perform the API operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000', 'title' => ''], + ], [ 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the node.', 'type' => 'string', 'required' => true, 'example' => '652567824470354XXXX', 'title' => ''], ], [ - 'name' => 'Date', - 'in' => 'query', + 'name' => 'Path', + 'in' => 'formData', + 'schema' => ['description' => 'The unique identifier of the Data Studio node.'."\n" + ."\n" + .'> This field is of the Long type in SDK versions prior to 8.0.0, and of the String type in SDK versions 8.0.0 and later. This change does not affect normal SDK usage; the parameter will still be returned according to the type defined in the SDK. However, compilation failures may occur due to the type change only when upgrading the SDK across version 8.0.0. In this case, you must manually update the data type.', 'type' => 'string', 'required' => true, 'example' => 'root/demo', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The operation date, accurate to the day. The default value is the current day. You can query only the operation logs generated within the previous 31 days. This value is a UNIX timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1710239005403'."\n", + 'title' => 'Schema of Response', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'C99E2BE6-9DEA-5C2E-8F51-1DDCFEADXXXX'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C99E2BE6-9DEA-5C2E-8F51-1DDCFEADXXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'MoveNode', + 'changeSet' => [ + ['createdAt' => '2025-01-13T07:36:02.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + ], + 'MoveResource' => [ + 'summary' => 'Moves a file resource to a path in DataStudio.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235504', + 'abilityTreeNodes' => ['FEATUREdideJ3TPTK'], + ], + 'parameters' => [ [ - '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' => '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 ID.'."\n" + ."\n" + .'You can use this parameter to specify the DataWorks workspace on which you want to perform the API operation.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000', 'title' => ''], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => 'The unique identifier of the Data Studio file resource.'."\n" + ."\n" + .'> This field is of the Long type in SDK versions prior to 8.0.0, and of the String type in SDK versions 8.0.0 and later. This change does not affect normal SDK usage; the parameter will still be returned according to the type defined in the SDK. However, compilation failures may occur due to the type change only when upgrading the SDK across version 8.0.0. In this case, you must manually update the data type.', 'type' => 'string', 'required' => true, 'example' => '652567824470354XXXX', 'title' => ''], + ], + [ + 'name' => 'Path', + 'in' => 'formData', + 'schema' => ['description' => 'The unique identifier of the Data Studio file resource.'."\n" + ."\n" + .'> Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. However, compilation failures may occur due to the type change only when upgrading the SDK across version 8.0.0. In this case, you must manually update the data type.', 'type' => 'string', 'required' => true, 'example' => 'root/demo', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n", - ], - 'PagingInfo' => [ - 'description' => 'The pagination information.'."\n", - 'type' => 'object', - 'properties' => [ - 'OperationLogs' => [ - 'description' => 'The operation logs.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'User' => [ - 'description' => 'The account ID of the operator.'."\n", - 'type' => 'string', - 'example' => '1000'."\n", - ], - 'CreateTime' => [ - 'description' => 'The time when the operation log was generated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403'."\n", - ], - 'OperationSeq' => [ - 'description' => 'The serial number of the operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1111', - ], - 'OperationContent' => [ - 'description' => 'The operation content.'."\n", - 'type' => 'string', - 'example' => 'Freeze tasks', - ], - 'TaskInstanceId' => [ - 'description' => 'The ID of the instance on which the operation was performed.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - ], - 'description' => '', - ], - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100'."\n", - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10'."\n", - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F332BED4-DD73-5972-A9C2-642BA6CFXXXX'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], - 'description' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F332BED4-DD73-5972-A9C2-642BA6CFXXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'MoveResource', + 'changeSet' => [ + ['createdAt' => '2025-01-13T07:36:00.000Z', 'description' => 'Request parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A1****\\\\n\\",\\n \\"PagingInfo\\": {\\n \\"OperationLogs\\": [\\n {\\n \\"User\\": \\"1000\\\\n\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"OperationSeq\\": 1111,\\n \\"OperationContent\\": \\"Freeze tasks\\",\\n \\"TaskInstanceId\\": 1234\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1\\n }\\n}","type":"json"}]', - 'title' => 'ListTaskInstanceOperationLogs', - 'summary' => 'Queries a list of operation logs of an instance by page.', - 'description' => 'This API operation is available for all DataWorks editions.'."\n" - ."\n" - .'You can call this operation to query only the operation logs generated within the previous 31 days.'."\n", - ], - 'ListDownstreamTaskInstances' => [ - 'methods' => [ - 'get', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'MoveWorkflowDefinition' => [ + 'summary' => 'Moves a workflow to a path in DataStudio.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '240662', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - 'FEATUREdideD0YY7B', - 'FEATUREdideVFMENL', - ], + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235450', + 'abilityTreeNodes' => ['FEATUREdideHO4TQP', 'FEATUREdide8FM783', 'FEATUREdideQUQUVB', 'FEATUREdideIQU97M'], ], '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 ID. This parameter indicates the DataWorks workspace to which the API operation is applied.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10001', 'title' => ''], + ], [ 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The unique identifier of the Data Studio workflow.'."\n" + ."\n" + .'> This field is of the Long type in SDK versions prior to 8.0.0, and of the String type in SDK versions 8.0.0 and later. This change does not affect normal SDK usage; the parameter will still be returned according to the type defined in the SDK. However, compilation failures may occur due to the type change only when upgrading the SDK across version 8.0.0. In this case, you must manually update the data type.', 'type' => 'string', 'required' => true, 'example' => '543217824470354XXXX', 'title' => ''], ], [ - 'name' => 'PageSize', - 'in' => 'query', + 'name' => 'Path', + 'in' => 'formData', + 'schema' => ['description' => 'The path to which you want to move the workflow. You do not need to specify a workflow name in the path.'."\n" + ."\n" + .'For example, if you want to move the test workflow to root/demo/test, you must set this parameter to root/demo.', 'type' => 'string', 'required' => true, 'example' => 'root/demo', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', + 'title' => 'Schema of Response', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '05ADAF4F-7709-5FB1-B606-3513483FXXXX'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"05ADAF4F-7709-5FB1-B606-3513483FXXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'MoveWorkflowDefinition', + 'changeSet' => [ + ['createdAt' => '2025-01-13T07:36:01.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'PreviewDatasetVersion' => [ + 'summary' => 'Previews the content of a specified dataset version. Currently only text file preview is supported for OSS-type datasets. Supported MIME types 1. application/json 2. application/xml 3. text/html 4. text/plain 5. application/octet-stream', + 'path' => '', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'PageNumber', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdideXGTG91'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Id', '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 dataset version ID', 'type' => 'string', 'required' => true, 'title' => '', 'example' => ' '."\n" + .'dataworks-datasetVersion:3pXXXb8o0ngr07njhps1'."\n" + .':2'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX', - ], - 'PagingInfo' => [ - 'description' => 'The pagination information.'."\n", + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'A6C6B486-E3A2-5D52-9E76-D9380485DXXX'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'PreviewResult' => [ + 'title' => '', + 'description' => 'Preview results', 'type' => 'object', 'properties' => [ - 'TaskInstances' => [ - 'description' => 'The instances. This parameter is deprecated and replaced by the DownstreamTaskInstances parameter.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'StepType' => [ - 'title' => '依赖类型', - 'description' => 'The scheduling dependency type. Valid values:'."\n" - ."\n" - .'* Normal: same-cycle scheduling dependency'."\n" - .'* CrossCycle: cross-cycle scheduling dependency'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'TaskId' => [ - 'description' => 'The ID of the task for which the instance is generated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'TaskType' => [ - 'title' => '任务类型', - 'description' => 'The type of the task for which the instance is generated.'."\n", - 'type' => 'string', - 'example' => 'ODPS_SQL', - ], - 'TaskName' => [ - 'description' => 'The name of the task for which the instance is generated.'."\n", - 'type' => 'string', - 'example' => 'SQL node', - ], - 'Description' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'WorkflowId' => [ - 'description' => 'The ID of the workflow to which the instance belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'WorkflowName' => [ - 'description' => 'The name of the workflow to which the instance belongs.'."\n", - 'type' => 'string', - 'example' => 'Test workflow', - ], - 'TriggerType' => [ - 'description' => 'The method to trigger instance scheduling.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Scheduler: scheduling cycle-based trigger'."\n" - .'* Manual: manual trigger'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Scheduler' => '', - 'Manual' => '', - ], - 'example' => 'Scheduler', - ], - 'TriggerRecurrence' => [ - 'description' => 'The running mode of the instance after it is triggered. This parameter takes effect only if the TriggerType parameter is set to Scheduler.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Pause'."\n" - .'* Skip'."\n" - .'* Normal'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Pause' => '', - 'Skip' => '', - 'Normal' => '', - ], - 'example' => 'Normal', - ], - 'WorkflowInstanceId' => [ - 'description' => 'The workflow instance ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'WorkflowInstanceType' => [ - 'description' => 'The type of the workflow instance.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* SmokeTest'."\n" - .'* SupplementData'."\n" - .'* Manual'."\n" - .'* ManualWorkflow'."\n" - .'* Normal'."\n" - .'* ManualFlow'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'SmokeTest' => '', - 'SupplementData' => '', - 'Manual' => '', - 'ManualWorkflow' => '', - 'Normal' => '', - 'ManualFlow' => '', - ], - 'example' => 'Normal', - ], - 'Timeout' => [ - 'description' => 'The timeout period of task running. Unit: seconds.'."\n" - ."\n" - .'Note: The value of this parameter is rounded up by hour.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RerunMode' => [ - 'title' => '任务是否允许重跑的配置', - 'description' => 'The rerun mode.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* AllDenied: The task cannot be rerun regardless of whether it is successfully run or fails to run.'."\n" - .'* FailureAllowed: The task can be rerun only after it fails to run.'."\n" - .'* AllAllowed: The task can be rerun regardless of whether it is successfully run or fails to run.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'AllDenied' => '', - 'FailureAllowed' => '', - 'AllAllowed' => '', - ], - 'example' => 'AllAllowed', - ], - 'RunNumber' => [ - 'description' => 'The number of times the instance is run. By default, the value starts from 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PeriodNumber' => [ - 'description' => 'The sequence number of the cycle. This parameter indicates the cycle of the task instance on the current day.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'BaselineId' => [ - 'description' => 'The baseline ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'Priority' => [ - 'description' => 'The priority of the task. Valid values: 1 to 8. A larger value indicates a higher priority. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RuntimeResource' => [ - 'description' => 'The information about the resource group with which the instance is associated.'."\n", - 'type' => 'object', - 'properties' => [ - 'ResourceGroupId' => [ - 'description' => 'The ID of the resource group for scheduling configured for task running.'."\n", - 'type' => 'string', - 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', - ], - 'Image' => [ - 'description' => 'The ID of the image configured for task running.'."\n", - 'type' => 'string', - 'example' => 'i-xxxxxx', - ], - 'Cu' => [ - 'description' => 'The default number of compute units (CUs) configured for task running.'."\n", - 'type' => 'string', - 'example' => '0.25', - ], - ], - ], - 'Runtime' => [ - 'description' => 'The runtime information about the instance.'."\n", - 'type' => 'object', - 'properties' => [ - 'ProcessId' => [ - 'description' => 'The instance run ID.'."\n", - 'type' => 'string', - 'example' => 'T3_123'."\n", - ], - 'Gateway' => [ - 'description' => 'The host for running.'."\n", - 'type' => 'string', - 'example' => 'cn-shanghai.1.2', - ], - ], - ], - 'DataSource' => [ - 'description' => 'The information about the associated data source.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the data source.'."\n", - 'type' => 'string', - 'example' => 'mysql_test'."\n", - ], - ], - ], - 'Status' => [ - 'title' => '实例运行状态', - 'description' => 'The status of the instance. Valid values:'."\n" - ."\n" - .'* NotRun: The instance is not run.'."\n" - .'* Running: The instance is running.'."\n" - .'* WaitTime: The instance is waiting for the scheduling time to arrive.'."\n" - .'* CheckingCondition: Branch conditions are being checked for the instance.'."\n" - .'* WaitResource: The instance is waiting for resources.'."\n" - .'* Failure: The instance fails to be run.'."\n" - .'* Success: The instance is successfully run.'."\n" - .'* Checking: Data quality is being checked for the instance.'."\n" - .'* WaitTrigger: The instance is waiting to be triggered by external scheduling systems.'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Success', - ], - 'TriggerTime' => [ - 'description' => 'The scheduling time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403'."\n", - ], - 'Bizdate' => [ - 'description' => 'The data timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403'."\n", - ], - 'StartedTime' => [ - 'description' => 'The time when the instance started to run.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403'."\n", - ], - 'FinishedTime' => [ - 'description' => 'The time when the instance finished running.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403'."\n", - ], - 'Id' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'ProjectId' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'ProjectEnv' => [ - 'description' => 'The environment of the workspace. This parameter is deprecated and replaced by the EnvType parameter. Valid values:'."\n", - 'type' => 'string', - 'deprecated' => true, - 'enumValueTitles' => [], - 'example' => 'Prod', - ], - 'EnvType' => [ - 'description' => 'The environment in which the data source is used. Valid values:'."\n" - ."\n" - .'* Dev'."\n" - .'* Prod'."\n", - 'type' => 'string', - 'example' => 'Prod', - ], - 'Owner' => [ - 'description' => 'The account ID of the task owner.'."\n", - 'type' => 'string', - 'example' => '100', - ], - 'CreateTime' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403'."\n", - ], - 'ModifyTime' => [ - 'description' => 'The modification time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403'."\n", - ], - 'CreateUser' => [ - 'description' => 'The account ID of the creator.'."\n", - 'type' => 'string', - 'example' => '1000'."\n", - ], - 'ModifyUser' => [ - 'description' => 'The account ID of the modifier.'."\n", - 'type' => 'string', - 'example' => '1000'."\n", - ], - ], - 'description' => '', - ], - ], - 'DownstreamTaskInstances' => [ - 'description' => 'The descendant instances.'."\n", - 'type' => 'array', - 'items' => [ + 'SupportPreview' => ['description' => 'Preview availability', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'MimeType' => ['description' => 'The MIME type', 'type' => 'string', 'title' => '', 'example' => 'text/plain'], + 'FileName' => ['description' => 'File name', 'type' => 'string', 'title' => '', 'example' => 'parth/data.csv'], + 'Content' => ['description' => 'Content', 'type' => 'string', 'title' => '', 'example' => 'this is content'], + ], + 'example' => '', + ], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'PreviewDatasetVersion', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:PreviewDatasetVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A6C6B486-E3A2-5D52-9E76-D9380485DXXX\\",\\n \\"Success\\": true,\\n \\"PreviewResult\\": {\\n \\"SupportPreview\\": true,\\n \\"MimeType\\": \\"text/plain\\",\\n \\"FileName\\": \\"parth/data.csv\\",\\n \\"Content\\": \\"this is content\\"\\n }\\n}","type":"json"}]', + ], + 'PromptAgentSession' => [ + 'summary' => 'Sends a prompt to an existing session and streams the agent response.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https', 'sse'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeNodes' => ['FEATUREdideEWGMTH'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Jsonrpc', + 'in' => 'formData', + 'schema' => ['description' => 'The JSON-RPC version. Fixed value: 2.0.', 'type' => 'string', 'required' => false, 'example' => '2.0', 'title' => ''], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => 'The ID passed in by the caller. The value is returned as-is in the response.', 'type' => 'string', 'required' => false, 'example' => '1021418411', 'title' => ''], + ], + [ + 'name' => 'Params', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'SessionId' => ['description' => 'The ID of the target session. If the session does not exist, an SSE error frame is returned.', 'type' => 'string', 'required' => false, 'example' => 'sess_0f12abc34', 'title' => ''], + 'Prompt' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => '**The content block type.**', 'type' => 'string', 'example' => 'text', 'required' => false, 'title' => ''], + 'Text' => ['description' => '**The text content.**', 'type' => 'string', 'example' => 'Sales in the last 7 days', 'required' => false, 'title' => ''], + 'Uri' => ['description' => 'The URI of the file.', 'type' => 'string', 'example' => 'oss://${bucket}/${ossKey}', 'required' => false, 'title' => ''], + 'Name' => ['description' => 'The file name.', 'type' => 'string', 'example' => 'xxx.csv', 'required' => false, 'title' => ''], + 'MimeType' => ['description' => 'The MIME type of the file.', 'type' => 'string', 'example' => 'text/csv‌', 'required' => false, 'title' => ''], + 'Size' => ['description' => 'The size of the file. Unit: bytes.', 'type' => 'integer', 'example' => '1231231', 'format' => 'int64', 'required' => false, 'title' => ''], + 'Title' => ['description' => 'The title of the file.', 'type' => 'string', 'example' => 'Sales_Order_Details.csv', 'required' => false, 'title' => ''], + 'Description' => ['description' => 'The description of the file.', 'type' => 'string', 'example' => 'Sales_Order_Details.csv', 'required' => false, 'title' => ''], + 'Meta' => [ 'type' => 'object', 'properties' => [ - 'DependencyType' => [ - 'title' => '依赖类型', - 'description' => 'The scheduling dependency type. Valid values:'."\n" - ."\n" - .'* Normal'."\n" - .'* CrossCycle'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'TaskInstance' => [ - 'title' => '任务实例', - 'description' => 'The information about a task instance.'."\n", - 'type' => 'object', - 'properties' => [ - 'TaskId' => [ - 'description' => 'The ID of the task for which the instance is generated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'TaskType' => [ - 'title' => '任务类型', - 'description' => 'The type of the task for which the instance is generated.'."\n", - 'type' => 'string', - 'example' => 'ODPS_SQL', - ], - 'TaskName' => [ - 'description' => 'The name of the task for which the instance is generated.'."\n", - 'type' => 'string', - 'example' => 'SQL node', - ], - 'Description' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'WorkflowId' => [ - 'description' => 'The ID of the workflow to which the instance belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'WorkflowName' => [ - 'description' => 'The name of the workflow to which the instance belongs.'."\n", - 'type' => 'string', - 'example' => 'Test workflow', - ], - 'TriggerType' => [ - 'description' => 'The trigger type. Valid values:'."\n" - ."\n" - .'* Scheduler: scheduling cycle-based trigger'."\n" - .'* Manual: manual trigger'."\n", - 'type' => 'string', - 'example' => 'Scheduler', - ], - 'TriggerRecurrence' => [ - 'description' => 'The running mode of the instance after it is triggered. This parameter takes effect only if the TriggerType parameter is set to Scheduler. Valid values:'."\n" - ."\n" - .'* Pause'."\n" - .'* Skip'."\n" - .'* Normal'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'WorkflowInstanceId' => [ - 'description' => 'The workflow instance ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'WorkflowInstanceType' => [ - 'description' => 'The type of the workflow instance. Valid values:'."\n" - ."\n" - .'* Normal'."\n" - .'* Manual'."\n" - .'* SmokeTest'."\n" - .'* SupplementData'."\n" - .'* ManualWorkflow'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'Timeout' => [ - 'description' => 'The timeout period of task running. Unit: seconds.'."\n" - ."\n" - .'Note: The value of this parameter is rounded up by hour.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3600', - ], - 'RerunMode' => [ - 'title' => '任务是否允许重跑的配置', - 'description' => 'The rerun mode.'."\n", - 'type' => 'string', - 'example' => 'AllAllowed', - ], - 'RunNumber' => [ - 'description' => 'The number of times the instance is run. By default, the value starts from 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PeriodNumber' => [ - 'description' => 'The sequence number of the cycle. This parameter indicates the cycle of the task instance on the current day.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'BaselineId' => [ - 'description' => 'The baseline ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'Priority' => [ - 'description' => 'The priority of the task. Minimum value: 1. Maximum value: 8. A larger value indicates a higher priority. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'RuntimeResource' => [ - 'description' => 'The configurations of the runtime environment, such as the resource group information.'."\n", - 'type' => 'object', - 'properties' => [ - 'ResourceGroupId' => [ - 'description' => 'The ID of the resource group for scheduling configured for task running.'."\n", - 'type' => 'string', - 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', - ], - 'Image' => [ - 'description' => 'The ID of the image configured for task running.'."\n", - 'type' => 'string', - 'example' => 'i-xxxxxx', - ], - 'Cu' => [ - 'description' => 'The default number of compute units (CUs) configured for task running.'."\n", - 'type' => 'string', - 'example' => '0.25', - ], - ], - ], - 'Runtime' => [ - 'description' => 'The runtime information about the instance.'."\n", - 'type' => 'object', - 'properties' => [ - 'ProcessId' => [ - 'description' => 'The instance run ID.'."\n", - 'type' => 'string', - 'example' => 'T3_123', - ], - 'Gateway' => [ - 'description' => 'The host for running.'."\n", - 'type' => 'string', - 'example' => 'cn-shanghai.1.2', - ], - ], - ], - 'DataSource' => [ - 'description' => 'The information about the associated data source.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the data source.'."\n", - 'type' => 'string', - 'example' => 'mysql_test', - ], - ], - ], - 'Status' => [ - 'title' => '实例运行状态', - 'description' => 'The status of the instance. Valid values:'."\n" - ."\n" - .'* NotRun: The instance is not run.'."\n" - .'* Running: The instance is running.'."\n" - .'* WaitTime: The instance is waiting for the scheduling time to arrive.'."\n" - .'* CheckingCondition: Branch conditions are being checked for the instance.'."\n" - .'* WaitResource: The instance is waiting for resources.'."\n" - .'* Failure: The instance fails to be run.'."\n" - .'* Success: The instance is successfully run.'."\n" - .'* Checking: Data quality is being checked for the instance.'."\n" - .'* WaitTrigger: The instance is waiting to be triggered by external scheduling systems.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'TriggerTime' => [ - 'description' => 'The scheduling time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], - 'Bizdate' => [ - 'description' => 'The data timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], - 'StartedTime' => [ - 'description' => 'The time when the instance started to run.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], - 'FinishedTime' => [ - 'description' => 'The time when the instance finished running.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], - 'Id' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'ProjectId' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'EnvType' => [ - 'description' => 'The environment in which the data source is used. Valid values:'."\n" - ."\n" - .'* Dev'."\n" - .'* Prod'."\n", - 'type' => 'string', - 'example' => 'Prod', - ], - 'Owner' => [ - 'description' => 'The account ID of the task owner.'."\n", - 'type' => 'string', - 'example' => '1000', - ], - 'CreateTime' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], - 'ModifyTime' => [ - 'description' => 'The modification time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], - 'CreateUser' => [ - 'description' => 'The account ID of the creator.'."\n", - 'type' => 'string', - 'example' => '1000', - ], - 'ModifyUser' => [ - 'description' => 'The account ID of the modifier.'."\n", - 'type' => 'string', - 'example' => '1000', - ], - ], - ], + 'Hide' => ['description' => 'Specifies whether to hide the prompt from the user. For example, if a user asks "Sales amount in the last 7 days" in a chat dialog, the calling system may use RAG to retrieve relevant business domain knowledge and append it to the agent context before calling the API. If you do not want to display this supplemental information to the user, set this parameter to true.', 'type' => 'boolean', 'required' => false, 'example' => 'true or false', 'title' => ''], ], - 'description' => '', + 'description' => 'The prompt metadata extended by DataWorks.', + 'required' => false, + 'title' => '', + 'example' => '', ], ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - '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', - ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], + 'description' => 'The array of user message content blocks. For more information, see https\\://agentclientprotocol.com/protocol/content', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Meta' => [ + 'type' => 'object', + 'properties' => [ + 'Context' => ['description' => 'A Map-type value. In custom agent scenarios, you can use this parameter to replace placeholder parameters.', 'type' => 'any', 'required' => false, 'example' => '{'."\n" + .' "key1": "value1",'."\n" + .' "key2": "value2"'."\n" + .'}', 'title' => ''], + ], + 'description' => 'The extended metadata.', + 'required' => false, + 'title' => '', + 'example' => '', ], ], + 'description' => 'The business parameters.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'Id of the request', 'type' => 'string', 'title' => '', 'example' => 'D5D70885-7CC7-594A-80C7-2EF1B00FFB4B'], + 'Timestamp' => ['description' => 'The timestamp.', 'type' => 'integer', 'format' => 'int64', 'example' => '1747447032', 'title' => ''], + 'Jsonrpc' => ['description' => 'The JSON-RPC version. Fixed value: 2.0.', 'type' => 'string', 'example' => '2.0', 'title' => ''], + 'Id' => ['description' => 'The ID passed in by the caller. The value is returned as-is in the response.', 'type' => 'string', 'example' => '631478864897630XXXX', 'title' => ''], + 'Result' => ['description' => 'The SSE frame result set. The response content conforms to the open-source Agent Client Protocol (ACP) specification. For more information, see https\\://agentclientprotocol.com/protocol/prompt-turn', 'type' => 'any', 'example' => '{"stopReason":"end_turn"}'."\n", 'title' => ''], + 'Error' => ['description' => 'The error information returned in the SSE frame. The response content conforms to the open-source Agent Client Protocol (ACP) specification. For more information, see https\\://agentclientprotocol.com/protocol/prompt-turn', 'type' => 'any', 'example' => '{"code": 400, "errorCode": "0x50000000001", "message": "not exist session", "data": null}', 'title' => ''], + 'Method' => ['description' => 'The SSE method. The response content conforms to the open-source Agent Client Protocol (ACP) specification. For more information, see https\\://agentclientprotocol.com/protocol/prompt-turn', 'type' => 'string', 'example' => 'session/update', 'title' => ''], + 'Params' => ['description' => 'The SSE params. The response content conforms to the open-source Agent Client Protocol (ACP) specification. For more information, see https\\://agentclientprotocol.com/protocol/prompt-turn', 'type' => 'any', 'example' => '{"sessionId":"af4f5ef8-e8f5-481c-ad1f-94886c6c0aed","update":{"sessionUpdate":"agent_message_chunk","content":{"type":"text","text":"hello world"}}}', 'title' => ''], + ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'PromptAgentSession', + 'description' => '## Request'."\n" + ."\n" + .'- This API sends a user prompt to a specified session ID and streams the agent\'s response over SSE (Server-Sent Events).'."\n" + ."\n" + .'- The response may include message chunks, thought process, and tool calling status updates.'."\n" + ."\n" + .'- If the specified session does not exist, the API returns a 400 error in an SSE error frame.'."\n" + ."\n" + .'- The `stopReason` field indicates why the agent ended the turn.'."\n" + ."\n" + .'- You can use multiple types of content blocks in the prompt, such as text and OSS file download links.'."\n" + ."\n" + .'- You can provide additional metadata in the `Meta` parameter to pass more context to the server.'."\n" + ."\n" + .'- The response content conforms to the open-source Agent Client Protocol (ACP) specification. For more information, see https\\://agentclientprotocol.com'."\n" + ."\n" + .'- \\*\\*Review the billing methods and pricing for Data Agent before you use this API\\*\\*: https\\://help.aliyun.com/zh/dataworks/dataworks-data-agent-agent-billing', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"PagingInfo\\": {\\n \\"TaskInstances\\": [\\n {\\n \\"StepType\\": \\"Normal\\",\\n \\"TaskId\\": 1234,\\n \\"TaskType\\": \\"ODPS_SQL\\",\\n \\"TaskName\\": \\"SQL node\\\\n\\",\\n \\"Description\\": \\"test\\",\\n \\"WorkflowId\\": 1234,\\n \\"WorkflowName\\": \\"Test workflow\\",\\n \\"TriggerType\\": \\"Scheduler\\",\\n \\"TriggerRecurrence\\": \\"Normal\\",\\n \\"WorkflowInstanceId\\": 1234,\\n \\"WorkflowInstanceType\\": \\"Normal\\",\\n \\"Timeout\\": 3600,\\n \\"RerunMode\\": \\"AllAllowed\\",\\n \\"RunNumber\\": 1,\\n \\"PeriodNumber\\": 1,\\n \\"BaselineId\\": 1234,\\n \\"Priority\\": 1,\\n \\"RuntimeResource\\": {\\n \\"ResourceGroupId\\": \\"S_res_group_524258031846018_1684XXXXXXXXX\\",\\n \\"Image\\": \\"i-xxxxxx\\",\\n \\"Cu\\": \\"0.25\\"\\n },\\n \\"Runtime\\": {\\n \\"ProcessId\\": \\"T3_123\\\\n\\",\\n \\"Gateway\\": \\"cn-shanghai.1.2\\"\\n },\\n \\"DataSource\\": {\\n \\"Name\\": \\"mysql_test\\\\n\\"\\n },\\n \\"Status\\": \\"Success\\",\\n \\"TriggerTime\\": 1710239005403,\\n \\"Bizdate\\": 1710239005403,\\n \\"StartedTime\\": 1710239005403,\\n \\"FinishedTime\\": 1710239005403,\\n \\"Id\\": 1234,\\n \\"ProjectId\\": 100,\\n \\"ProjectEnv\\": \\"Prod\\",\\n \\"EnvType\\": \\"Prod\\",\\n \\"Owner\\": \\"100\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"1000\\\\n\\",\\n \\"ModifyUser\\": \\"1000\\\\n\\"\\n }\\n ],\\n \\"DownstreamTaskInstances\\": [\\n {\\n \\"DependencyType\\": \\"Normal\\",\\n \\"TaskInstance\\": {\\n \\"TaskId\\": 1234,\\n \\"TaskType\\": \\"ODPS_SQL\\",\\n \\"TaskName\\": \\"SQL node\\",\\n \\"Description\\": \\"test\\",\\n \\"WorkflowId\\": 1234,\\n \\"WorkflowName\\": \\"Test workflow\\",\\n \\"TriggerType\\": \\"Scheduler\\",\\n \\"TriggerRecurrence\\": \\"Normal\\",\\n \\"WorkflowInstanceId\\": 1234,\\n \\"WorkflowInstanceType\\": \\"Normal\\",\\n \\"Timeout\\": 3600,\\n \\"RerunMode\\": \\"AllAllowed\\",\\n \\"RunNumber\\": 1,\\n \\"PeriodNumber\\": 1,\\n \\"BaselineId\\": 1234,\\n \\"Priority\\": 1,\\n \\"RuntimeResource\\": {\\n \\"ResourceGroupId\\": \\"S_res_group_524258031846018_1684XXXXXXXXX\\",\\n \\"Image\\": \\"i-xxxxxx\\",\\n \\"Cu\\": \\"0.25\\"\\n },\\n \\"Runtime\\": {\\n \\"ProcessId\\": \\"T3_123\\",\\n \\"Gateway\\": \\"cn-shanghai.1.2\\"\\n },\\n \\"DataSource\\": {\\n \\"Name\\": \\"mysql_test\\"\\n },\\n \\"Status\\": \\"Success\\",\\n \\"TriggerTime\\": 1710239005403,\\n \\"Bizdate\\": 1710239005403,\\n \\"StartedTime\\": 1710239005403,\\n \\"FinishedTime\\": 1710239005403,\\n \\"Id\\": 1234,\\n \\"ProjectId\\": 100,\\n \\"EnvType\\": \\"Prod\\",\\n \\"Owner\\": \\"1000\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"1000\\",\\n \\"ModifyUser\\": \\"1000\\"\\n }\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1\\n }\\n}","type":"json"}]', - 'title' => 'ListDownstreamTaskInstances', - 'summary' => 'Queries a list of descendant instances of an instance by page.', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dataworks:PromptAgentSession', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D5D70885-7CC7-594A-80C7-2EF1B00FFB4B\\",\\n \\"Timestamp\\": 1747447032,\\n \\"Jsonrpc\\": \\"2.0\\",\\n \\"Id\\": \\"631478864897630XXXX\\",\\n \\"Result\\": \\"{\\\\\\"stopReason\\\\\\":\\\\\\"end_turn\\\\\\"}\\\\n\\",\\n \\"Error\\": \\"{\\\\\\"code\\\\\\": 400, \\\\\\"errorCode\\\\\\": \\\\\\"0x50000000001\\\\\\", \\\\\\"message\\\\\\": \\\\\\"not exist session\\\\\\", \\\\\\"data\\\\\\": null}\\",\\n \\"Method\\": \\"session/update\\",\\n \\"Params\\": \\"{\\\\\\"sessionId\\\\\\":\\\\\\"af4f5ef8-e8f5-481c-ad1f-94886c6c0aed\\\\\\",\\\\\\"update\\\\\\":{\\\\\\"sessionUpdate\\\\\\":\\\\\\"agent_message_chunk\\\\\\",\\\\\\"content\\\\\\":{\\\\\\"type\\\\\\":\\\\\\"text\\\\\\",\\\\\\"text\\\\\\":\\\\\\"hello world\\\\\\"}}}\\"\\n}","type":"json"}]', + 'translator' => 'manual', ], - 'SuspendTaskInstances' => [ - 'methods' => [ - 'post', + 'RemoveEntityFromMetaCollection' => [ + 'summary' => 'Remove an entity object from a Data Map collection. The collection supports Data Map categories and data albums, and the entity currently supports only the Data Table type.'."\n" + .'When removing an entity from a data album, the caller must have the AliyunDataWorksFullAccess permission or be the creator or administrator of the album.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'abilityTreeCode' => '267220', + 'abilityTreeNodes' => ['FEATUREdideE9XYA6'], + ], + 'parameters' => [ + [ + 'name' => 'MetaCollectionId', + 'in' => 'query', + 'schema' => ['description' => 'The collection ID. You can call the ListMetaCollections operation to query the ID.', 'type' => 'string', 'required' => false, 'example' => 'as78d756asd', 'title' => ''], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The entity ID. Currently, entities can only be tables. You can call the ListTables operation to query the ID.', 'type' => 'string', 'required' => false, 'example' => 'maxcompute-table:::project_name:[schema_name]:table_name', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '6D6CD444-DFA0-5180-9763-4A8730F2B382'], + ], + 'example' => '', + ], + ], ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6D6CD444-DFA0-5180-9763-4A8730F2B382\\"\\n}","type":"json"}]', + 'title' => 'Remove an entity object from a Data Map collection '."\n", + 'description' => '1. You must purchase DataWorks Professional Edition or a higher version to use this feature.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'RemoveTaskInstanceDependencies' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -43089,39 +43852,33 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'abilityTreeCode' => '244303', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - ], + 'abilityTreeCode' => '245921', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB'], ], 'parameters' => [ [ - 'name' => 'Ids', + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234', 'title' => ''], + ], + [ + 'name' => 'UpstreamTaskInstanceIds', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'The ID list of the task instance.', + 'description' => 'The IDs of ancestor instances of the instance', 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the task instance.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1234', - ], + 'items' => ['description' => 'The instance ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234', 'title' => ''], 'required' => false, 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ 'name' => 'Comment', 'in' => 'formData', - 'schema' => [ - 'description' => 'Remarks.', - 'type' => 'string', - 'required' => false, - 'example' => 'this is a comment', - ], + 'schema' => ['description' => 'The remarks.', 'type' => 'string', 'required' => false, 'example' => 'this is a comment'."\n", 'title' => ''], ], ], 'responses' => [ @@ -43129,249 +43886,352 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n", - ], - 'SuccessInfo' => [ - 'description' => 'The result of the batch operation, which is in the MAP structure. The instance ID serves as a key, and the result serves as a value.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'type' => 'boolean', - 'description' => 'Whether the operation is successful.', - 'example' => 'true', - ], - 'Message' => [ - 'type' => 'string', - 'example' => 'The instance does not exist.', - 'description' => 'The error message.'."\n", - ], - ], - 'description' => 'The result.'."\n", - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n", 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\\\n\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'RemoveTaskInstanceDependencies', + 'summary' => 'Removes multiple upstream dependencies of an instance at a time.', + 'description' => 'This API operation is available for all DataWorks editions.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17****\\\\n\\",\\n \\"SuccessInfo\\": {\\n \\"key\\": {\\n \\"Success\\": true,\\n \\"Message\\": \\"The instance does not exist.\\"\\n }\\n }\\n}","type":"json"}]', - 'title' => 'SuspendTaskInstances', - 'summary' => 'Suspends multiple instances at a time.', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", + 'ramActions' => [], ], - 'ResumeTaskInstances' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'RenameFunction' => [ + 'summary' => 'Renames a user-defined function (UDF) in DataStudio.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'abilityTreeCode' => '244302', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236048', + 'abilityTreeNodes' => ['FEATUREdideZOYJZL'], ], 'parameters' => [ [ - 'name' => 'Ids', + 'name' => 'ProjectId', 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The ID list of the task instance.', - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the task instance.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1234', - ], - 'required' => false, - 'maxItems' => 100, - ], + '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, 'example' => '10002', 'title' => ''], ], [ - 'name' => 'Comment', + 'name' => 'Id', 'in' => 'formData', - 'schema' => [ - 'description' => 'Remarks.', - 'type' => 'string', - 'required' => false, - 'example' => 'this is a comment'."\n", - ], + 'schema' => ['description' => 'The unique identifier of the Data Studio UDF.'."\n" + ."\n" + .'> This field is of the Long type in SDK versions prior to 8.0.0, and of the String type in SDK versions 8.0.0 and later. This change does not affect normal SDK usage; the parameter will still be returned according to the type defined in the SDK. However, compilation failures may occur due to the type change only when upgrading the SDK across version 8.0.0. In this case, you must manually update the data type.', 'type' => 'string', 'required' => true, 'example' => '543217824470354****', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['description' => 'The unique identifier of the Data Studio UDF.'."\n" + ."\n" + .'> Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.', 'type' => 'string', 'required' => true, 'example' => 'Rename', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n", - ], - 'SuccessInfo' => [ - 'description' => 'The result of the batch operation, which is in the MAP structure. The instance ID serves as a key, and the result serves as a value.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'type' => 'boolean', - 'description' => 'Whether the operation is successful.', - 'example' => 'true', - ], - 'Message' => [ - 'type' => 'string', - 'example' => 'The instance does not exist.'."\n", - 'description' => 'The error message.'."\n", - ], - ], - 'description' => 'The result.'."\n", - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1ED4C97F-BA2A-57C5-BA7C-8853627EXXXX'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'string', 'example' => 'true', 'title' => ''], ], - 'description' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1ED4C97F-BA2A-57C5-BA7C-8853627EXXXX\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => 'RenameFunction', + 'changeSet' => [ + ['createdAt' => '2025-01-13T07:35:59.000Z', 'description' => 'Request parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17****\\",\\n \\"SuccessInfo\\": {\\n \\"key\\": {\\n \\"Success\\": true,\\n \\"Message\\": \\"The instance does not exist.\\\\n\\"\\n }\\n }\\n}","type":"json"}]', - 'title' => 'ResumeTaskInstances', - 'summary' => 'Resumes multiple suspended instances at a time.', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", - ], - 'StopTaskInstances' => [ - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'RenameNode' => [ + 'summary' => 'Renames a node in DataStudio.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'abilityTreeCode' => '244301', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236794', + 'abilityTreeNodes' => ['FEATUREdideHO4TQP', 'FEATUREdide8FM783', 'FEATUREdideQUQUVB', 'FEATUREdideIQU97M'], ], 'parameters' => [ [ - 'name' => 'Ids', + 'name' => 'ProjectId', 'in' => 'formData', - 'style' => 'json', + '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, 'example' => '12345', 'title' => ''], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => 'The unique identifier of the Data Studio node.'."\n" + ."\n" + .'> This field is of the Long type in SDK versions prior to 8.0.0, and of the String type in SDK versions 8.0.0 and later. This change does not affect normal SDK usage; the parameter will still be returned according to the type defined in the SDK. However, compilation failures may occur due to the type change only when upgrading the SDK across version 8.0.0. In this case, you must manually update the data type.', 'type' => 'string', 'required' => true, 'example' => '652567824470354****', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['description' => 'The unique identifier of the Data Studio node.'."\n" + ."\n" + .'> This field is of the Long type in SDK versions prior to 8.0.0, and of the String type in SDK versions 8.0.0 and later. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.', 'type' => 'string', 'required' => true, 'example' => 'Rename', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The ID list of the task instance.', - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the task instance.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1234', + 'title' => 'Schema of Response', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '4CDF7B72-020B-542A-8465-21CFFA81XXXX'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], - 'required' => false, - 'maxItems' => 100, + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4CDF7B72-020B-542A-8465-21CFFA81XXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'RenameNode', + 'changeSet' => [ + ['createdAt' => '2025-01-13T07:35:59.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'Comment', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + ], + 'RenameResource' => [ + 'summary' => 'Renames a file resource in DataStudio.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235503', + 'abilityTreeNodes' => ['FEATUREdideJ3TPTK'], + ], + '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 query 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, 'example' => '10000', 'title' => ''], + ], + [ + 'name' => 'Id', 'in' => 'formData', + 'schema' => ['description' => 'The unique identifier of the Data Studio file resource.'."\n" + ."\n" + .'> This field is of the Long type in SDK versions prior to 8.0.0, and of the String type in SDK versions 8.0.0 and later. This change does not affect normal SDK usage; the parameter will still be returned according to the type defined in the SDK. However, compilation failures may occur due to the type change only when upgrading the SDK across version 8.0.0. In this case, you must manually update the data type.', 'type' => 'string', 'required' => true, 'example' => '543217824470354****', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['description' => 'The unique identifier of the Data Studio file resource.'."\n" + ."\n" + .'> Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.', 'type' => 'string', 'required' => true, 'example' => 'Rename', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Remarks.', - 'type' => 'string', - 'required' => false, - 'example' => 'this is a comment'."\n", + 'title' => 'Schema of Response', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '4CDF7B72-020B-542A-8465-21CFFA8XXXXX'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', ], ], ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4CDF7B72-020B-542A-8465-21CFFA8XXXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'RenameResource', + 'changeSet' => [ + ['createdAt' => '2025-01-13T07:36:03.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'RenameWorkflowDefinition' => [ + 'summary' => 'Renames a workflow in DataStudio.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235462', + 'abilityTreeNodes' => ['FEATUREdideHO4TQP', 'FEATUREdideQUQUVB', 'FEATUREdideLJFKLG', 'FEATUREdideIQU97M'], + ], + '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. You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000', 'title' => ''], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The unique identifier of the Data Studio workflow.'."\n" + ."\n" + .'> This field is of the Long type in SDK versions prior to 8.0.0, and of the String type in SDK versions 8.0.0 and later. This change does not affect normal SDK usage; the parameter will still be returned according to the type defined in the SDK. However, compilation failures may occur due to the type change only when upgrading the SDK across version 8.0.0. In this case, you must manually update the data type.', 'type' => 'string', 'required' => true, 'example' => '463497880880954****', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The unique identifier of the workflow.'."\n" + ."\n" + .'> Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.', 'type' => 'string', 'required' => true, 'example' => 'Rename', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n", - ], - 'SuccessInfo' => [ - 'description' => 'The result of the batch operation, which is in the MAP structure. The instance ID serves as a key, and the result serves as a value.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'type' => 'boolean', - 'description' => 'Whether the operation is successful.', - 'example' => 'true', - ], - 'Message' => [ - 'type' => 'string', - 'example' => 'The instance does not exist.', - 'description' => 'The error message.'."\n", - ], - ], - 'description' => 'The returned result.'."\n", - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID. You can troubleshoot issues based on the ID.', 'type' => 'string', 'example' => '975BD43D-C421-595C-A29C-565A8AD5XXXX'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], - 'description' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"975BD43D-C421-595C-A29C-565A8AD5XXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'RenameWorkflowDefinition', + 'changeSet' => [ + ['createdAt' => '2025-01-13T07:36:00.000Z', 'description' => 'Request parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17****\\",\\n \\"SuccessInfo\\": {\\n \\"key\\": {\\n \\"Success\\": true,\\n \\"Message\\": \\"The instance does not exist.\\"\\n }\\n }\\n}","type":"json"}]', - 'title' => 'StopTaskInstances', - 'summary' => 'Stops multiple instances at a time.', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", - ], - 'SetSuccessTaskInstances' => [ - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'RerunTaskInstances' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'abilityTreeCode' => '244304', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '244270', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB'], ], 'parameters' => [ [ @@ -43379,28 +44239,24 @@ 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'The ID list of the task instance.', + 'description' => 'The list of node instance IDs.', 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the task instance.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1234', - ], + 'items' => ['description' => 'The node instance ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234', 'title' => ''], 'required' => false, 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ 'name' => 'Comment', 'in' => 'formData', - 'schema' => [ - 'description' => 'Remarks.', - 'type' => 'string', - 'required' => false, - 'example' => 'this is a comment'."\n", - ], + 'schema' => ['description' => 'The remarks.', 'type' => 'string', 'required' => false, 'example' => 'this is a comment'."\n", 'title' => ''], + ], + [ + 'name' => 'UseLatestConfig', + 'in' => 'formData', + 'schema' => ['type' => 'boolean', 'default' => 'false', 'description' => '', 'title' => '', 'example' => ''], ], ], 'responses' => [ @@ -43408,144 +44264,248 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n", - ], + 'RequestId' => ['description' => 'The request ID, which is used to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A1****', 'title' => ''], 'SuccessInfo' => [ - 'description' => 'The result of the batch operation, which is in the MAP structure. The instance ID serves as a key, and the result serves as a value.'."\n", + 'description' => 'The result information of the batch operation. The structure is a map in which the key is the node instance ID and the value is the result information.', 'type' => 'object', 'additionalProperties' => [ 'type' => 'object', 'properties' => [ - 'Success' => [ - 'type' => 'boolean', - 'description' => 'Whether the operation is successful.', - 'example' => 'true', - ], - 'Message' => [ - 'type' => 'string', - 'example' => 'The instance does not exist.', - 'description' => 'The error message.'."\n", - ], + 'Success' => ['description' => '操作是否成功。', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Message' => ['description' => '错误信息。', 'type' => 'string', 'example' => 'The instance does not exist.', 'title' => ''], ], - 'description' => 'The returned result.'."\n", + 'description' => '结果信息。', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17****\\",\\n \\"SuccessInfo\\": {\\n \\"key\\": {\\n \\"Success\\": true,\\n \\"Message\\": \\"The instance does not exist.\\"\\n }\\n }\\n}","type":"json"}]', - 'title' => 'SetSuccessTaskInstances', - 'summary' => 'Sets the statuses of multiple instances to successful at a time.', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", - ], - 'RerunTaskInstances' => [ - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Rerun node instances', + 'summary' => 'Reruns multiple node instances in a batch.', + 'description' => 'You must purchase DataWorks Basic Edition or a more advanced edition to use this operation.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A1****\\",\\n \\"SuccessInfo\\": {\\n \\"key\\": {\\n \\"Success\\": true,\\n \\"Message\\": \\"The instance does not exist.\\"\\n }\\n }\\n}","type":"json"}]', + ], + 'RerunWorkflowInstances' => [ + 'summary' => 'Rerun a workflow instance', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'abilityTreeCode' => '244270', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdideVFMENL'], ], 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123', 'title' => ''], + ], + [ + 'name' => 'EnvType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The environment of the workspace. Valid values:'."\n" + ."\n" + .'Prod Dev', + 'type' => 'string', + 'default' => 'Prod', + 'enum' => ['Prod', 'Dev'], + 'required' => false, + 'example' => 'Prod', + 'title' => '', + ], + ], + [ + 'name' => 'WorkflowId', + 'in' => 'formData', + 'schema' => ['description' => 'The workflow ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123', 'title' => ''], + ], + [ + 'name' => 'Type', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The type of the workflow instance. Valid values:'."\n" + ."\n" + .'ManualWorkflow.', + 'type' => 'string', + 'required' => true, + 'enum' => ['ManualWorkflow'], + 'example' => 'ManualWorkflow', + 'title' => '', + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['description' => 'The manual workflow name, used for fuzzy matching.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'StartTriggerTime', + 'in' => 'formData', + 'schema' => ['description' => 'The start trigger time (creation time) of the manual workflow instance used for matching. This parameter must be used together with EndTriggerTime.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1710239005403', 'title' => ''], + ], + [ + 'name' => 'EndTriggerTime', + 'in' => 'formData', + 'schema' => ['description' => 'The end trigger time of the manual workflow instance used for matching. This parameter must be used together with the StartTriggerTime.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1710239005403', 'title' => ''], + ], + [ + 'name' => 'Bizdate', + 'in' => 'formData', + 'schema' => ['description' => 'The business date used for matching manual workflow instances.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1710239005403', 'title' => ''], + ], + [ + 'name' => 'Status', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The status used for matching manual workflow instances.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- Success'."\n" + ."\n" + .'- Failure', + 'type' => 'string', + 'enum' => ['Success', 'Failure'], + 'required' => false, + 'example' => 'Failure', + 'title' => '', + ], + ], [ 'name' => 'Ids', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'The ID list of the task instance.', + 'description' => 'The instance IDs used for matching manual workflow instances.', 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the task instance.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1234', - ], + 'items' => ['description' => 'The manual workflow instance ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12345', 'title' => ''], 'required' => false, - 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Comment', + 'name' => 'Filter', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'Remarks.', - 'type' => 'string', + 'description' => 'The match conditions for internal instances of manual workflow instances.', + 'type' => 'object', + 'properties' => [ + 'RerunDownstreamEnabled' => ['description' => 'Specifies whether to rerun the matched instances and all downstream instances.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + 'TaskIds' => [ + 'description' => 'The internal task IDs used for matching manual workflow instances.', + 'type' => 'array', + 'items' => ['description' => 'The internal task ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12345', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'TaskName' => ['description' => 'The internal task name used for matching the manual workflow instance.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'TaskInstanceStatuses' => [ + 'description' => 'The statuses of internal tasks used for matching manual workflow instances.', + 'type' => 'array', + 'items' => [ + 'description' => 'The status of internal instances.', + 'type' => 'string', + 'enum' => ['NotRun', 'Failure', 'Success'], + 'required' => false, + 'example' => 'Failure', + 'title' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'TaskTypes' => [ + 'description' => 'Match internal tasks within the manual workflow by type.', + 'type' => 'array', + 'items' => ['description' => 'The type of the internal task. For possible values of TaskType, see DataWorks nodes.', 'type' => 'string', 'required' => false, 'example' => 'ODPS_SQL'."\n", 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], 'required' => false, - 'example' => 'this is a comment'."\n", + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n", - ], - 'SuccessInfo' => [ - 'description' => 'The result of the batch operation, which is in the MAP structure. The instance ID serves as a key, and the result serves as a value.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'type' => 'boolean', - 'description' => 'Whether the operation is successful.', - 'example' => 'true', - ], - 'Message' => [ - 'type' => 'string', - 'example' => 'The instance does not exist.', - 'description' => 'The error message.'."\n", - ], - ], - 'description' => 'The returned result.'."\n", - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID. Used for troubleshooting and log tracking.', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n"], + 'OperationId' => ['description' => 'The operation ID. You can use this value to query the creation result via the GetRerunWorkflowInstancesResult operation.', 'type' => 'string', 'example' => 'e15ad21c-b0e9-4792-8f55-b037xxxxxxxx'."\n", 'title' => ''], ], - 'description' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A1****\\",\\n \\"SuccessInfo\\": {\\n \\"key\\": {\\n \\"Success\\": true,\\n \\"Message\\": \\"The instance does not exist.\\"\\n }\\n }\\n}","type":"json"}]', - 'title' => 'RerunTaskInstances', - 'summary' => 'Reruns multiple instances at a time.', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", - ], - 'RemoveTaskInstanceDependencies' => [ - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Rerun a workflow instance', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:RerunWorkflowInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\\\n\\",\\n \\"OperationId\\": \\"e15ad21c-b0e9-4792-8f55-b037xxxxxxxx\\\\n\\"\\n}","type":"json"}]', + ], + 'ResumeTaskInstances' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -43554,50 +44514,28 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'abilityTreeCode' => '245921', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - ], - ], - 'parameters' => [ - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234', - ], - ], + 'abilityTreeCode' => '244302', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB'], + ], + 'parameters' => [ [ - 'name' => 'UpstreamTaskInstanceIds', + 'name' => 'Ids', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'The IDs of ancestor instances of the instance'."\n", + 'description' => 'The ID list of the task instance.', 'type' => 'array', - 'items' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1234', - ], + 'items' => ['description' => 'The ID of the task instance.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234', 'title' => ''], 'required' => false, 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ 'name' => 'Comment', 'in' => 'formData', - 'schema' => [ - 'description' => 'The remarks.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'this is a comment'."\n", - ], + 'schema' => ['description' => 'Remarks.', 'type' => 'string', 'required' => false, 'example' => 'this is a comment'."\n", 'title' => ''], ], ], 'responses' => [ @@ -43605,184 +44543,150 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n", - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17****', 'title' => ''], + 'SuccessInfo' => [ + 'description' => 'The result of the batch operation, which is in the MAP structure. The instance ID serves as a key, and the result serves as a value.', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Whether the operation is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The instance does not exist.'."\n", 'title' => ''], + ], + 'description' => 'The result.', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17****\\",\\n \\"SuccessInfo\\": {\\n \\"key\\": {\\n \\"Success\\": true,\\n \\"Message\\": \\"The instance does not exist.\\\\n\\"\\n }\\n }\\n}","type":"json"}]', + 'title' => 'ResumeTaskInstances', + 'summary' => 'Resumes multiple suspended instances at a time.', + 'description' => 'This API operation is available for all DataWorks editions.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\\\n\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'RemoveTaskInstanceDependencies', - 'summary' => 'Removes multiple upstream dependencies of an instance at a time.', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", + 'ramActions' => [], ], - 'TriggerSchedulerTaskInstance' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'RevokeMemberProjectRoles' => [ + 'summary' => 'Revokes roles that are assigned to a member in a workspace.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '244928', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - 'FEATUREdideD0YY7B', - 'FEATUREdideVFMENL', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '244501', + 'abilityTreeNodes' => ['FEATUREdideYTM537'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'TaskId', + 'name' => 'ProjectId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The task ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234', - ], + 'schema' => ['description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://dataworks.console.aliyun.com/workspace/list) and go to the Workspace page to query the ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '105149', 'title' => ''], ], [ - 'name' => 'EnvType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The environment of the workspace. Valid values:'."\n" - ."\n" - .'* Prod: production environment'."\n" - .'* Dev: development environment'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Prod', - 'default' => 'Prod', - 'enum' => [ - 'Prod', - 'Dev', - ], - ], + 'name' => 'UserId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the account used by the member in the workspace. You can log on to the [DataWorks console](https://dataworks.console.aliyun.com/product/ms_menu), choose More > Management Center in the left-side navigation pane, select the desired workspace on the Management Center page, and then click Go to Management Center. In the left-side navigation pane of the SettingCenter page, click Tenant Members and Roles. On the Tenant Members and Roles page, view the ID of the account used by the member in the workspace.', 'type' => 'string', 'required' => true, 'example' => '123422344899'."\n", 'title' => ''], ], [ - 'name' => 'TriggerTime', + 'name' => 'RoleCodes', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The time defined by the HTTP Trigger node. This value is a UNIX timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The codes of the roles in the workspace. You can call the [ListProjectRoles](~~2853930~~) operation to query the codes of all roles in the workspace.'."\n" + ."\n" + .'You must configure this parameter to specify the roles that you want to revoke from the member in the workspace.', + 'type' => 'array', + 'items' => ['description' => 'The code of a role in the workspace.', 'type' => 'string', 'required' => false, 'example' => 'role_project_guest', 'title' => ''], 'required' => true, - 'example' => '1710239005403'."\n", + 'maxItems' => 10, + 'minItems' => 1, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n", - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.', 'type' => 'string', 'example' => '676271D6-53B4-57BE-89FA-72F7AE1418DF'], ], - 'description' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\\\n\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'TriggerSchedulerTaskInstance', - 'summary' => 'Triggers a task to run by using an HTTP Trigger node at a specified time.', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", - ], - 'DeleteWorkflow' => [ - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"676271D6-53B4-57BE-89FA-72F7AE1418DF\\"\\n}","type":"json"}]', + 'title' => 'RevokeMemberProjectRoles', + 'description' => 'This API operation is available for all DataWorks editions.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:RevokeMemberProjectRoles', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'RollbackParameter' => [ + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '253458', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - 'FEATUREdideD0YY7B', - 'FEATUREdideVFMENL', - ], + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB'], + 'autoTest' => true, ], 'parameters' => [ [ 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => 'The workflow ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234', - ], - ], - [ - 'name' => 'EnvType', 'in' => 'formData', - 'schema' => [ - 'description' => 'The environment of the workspace. Valid values:'."\n" - ."\n" - .'* Prod: production environment'."\n" - .'* Dev: development environment'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Prod', - 'default' => 'Prod', - 'enum' => [ - 'Prod', - 'Dev', - ], - ], + 'schema' => ['description' => 'The parameter ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12345', 'title' => ''], ], [ - 'name' => 'ClientUniqueCode', + 'name' => 'RollbackVersion', 'in' => 'formData', - 'schema' => [ - 'description' => 'The unique code of the client. This parameter is used to create a workflow asynchronously and implement the idempotence of the workflow. If you do not specify this parameter when you create the workflow, the system automatically generates a unique code. The unique code is uniquely associated with the workflow ID. If you specify this parameter when you update or delete the workflow, the value of this parameter must be the unique code that is used to create the workflow.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Workflow_0bc5213917368545132902xxxxxxxx', - ], + 'schema' => ['description' => 'The rollback version.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], ], 'responses' => [ @@ -43790,36 +44694,29 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'example' => 'true'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'description' => 'Response schema', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'RollbackParameter', + 'summary' => 'Rolls back a specified parameter.', + 'description' => 'This operation is available only in DataWorks Professional Edition or a later version.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'DeleteWorkflow', - 'summary' => 'Deletes a workflow.', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]', ], - 'UpdateWorkflow' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'SetSuccessTaskInstances' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -43828,695 +44725,452 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'abilityTreeCode' => '253479', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - 'FEATUREdideD0YY7B', - 'FEATUREdideVFMENL', - ], + 'abilityTreeCode' => '244304', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB'], ], 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The workflow ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234', - ], - ], - [ - 'name' => 'EnvType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The project environment.'."\n" - ."\n" - .'* Prod'."\n" - .'* Dev'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Prod', - 'default' => 'Prod', - 'enum' => [ - 'Prod', - ], - ], - ], - [ - 'name' => 'Name', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the workflow.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'My Workflow'."\n", - ], - ], - [ - 'name' => 'Owner', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The account ID of the owner.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1000', - ], - ], - [ - 'name' => 'Trigger', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The trigger method.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The trigger type. Valid values:'."\n" - ."\n" - .'* Scheduler: periodically triggered'."\n" - .'* Manual'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [], - 'example' => 'Scheduler', - 'enum' => [ - 'Scheduler', - 'Manual', - ], - ], - 'Cron' => [ - 'description' => 'The Cron expression. This parameter takes effect only if the Type parameter is set to Scheduler.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '00 00 00 * * ?', - ], - 'StartTime' => [ - 'description' => 'The time when periodic triggering takes effect. This parameter takes effect only if the Type parameter is set to Scheduler. The value of this parameter is in the`yyyy-mm-dd hh:mm:ss` format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1970-01-01 00:00:00', - ], - 'EndTime' => [ - 'description' => 'The expiration time of periodic triggering. Takes effect only when type is set to Scheduler. The value of this parameter is in the`yyyy-mm-dd hh:mm:ss` format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '9999-01-01 00:00:00', - ], - ], - 'required' => true, - ], - ], - [ - 'name' => 'Description', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - ], - [ - 'name' => 'Dependencies', + 'name' => 'Ids', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'The dependency information.'."\n", + 'description' => 'The ID list of the task instance.', 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '依赖类型', - 'description' => 'The dependency type. Valid values:'."\n" - ."\n" - .'* CrossCycleDependsOnChildren: Depends on level-1 downstream nodes across cycles'."\n" - .'* CrossCycleDependsOnSelf: Depends on itself across cycles.'."\n" - .'* CrossCycleDependsOnOtherNode: Depends on other nodes across cycles.'."\n" - .'* Normal: Depends on nodes in the same cycle.'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [], - 'example' => 'Normal', - 'enum' => [ - 'Normal', - 'CrossCycleDependsOnSelf', - 'CrossCycleDependsOnChildren', - 'CrossCycleDependsOnOtherNode', - ], - ], - 'UpstreamOutput' => [ - 'title' => '依赖任务的输出标识符,或者任务ID', - 'description' => 'The output identifier of the upstream task. (This parameter is returned only if `Normal` is set and the node input is configured.)'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'pre.odps_sql_demo_0', - ], - 'UpstreamTaskId' => [ - 'description' => 'The ID of the upstream task. (This parameter is returned only if `Normal` or `CrossCycleDependsOnOtherNode` is set and the node input is not configured.)'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1234', - ], - ], - 'required' => false, - 'description' => '', - ], - 'required' => false, - ], - ], - [ - 'name' => 'Parameters', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The parameters.'."\n", - 'type' => 'string', + 'items' => ['description' => 'The ID of the task instance.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234', 'title' => ''], 'required' => false, - 'example' => 'para1=$bizdate para2=$[yyyymmdd] ', + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Tasks', + 'name' => 'Comment', 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'Details about tasks.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the task. Specifying this field triggers a full update for the corresponding task. If left unspecified, a new task will be created.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1234', - ], - 'Name' => [ - 'description' => 'The name of the task.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'SQL node', - ], - 'Description' => [ - 'description' => 'The description of the task.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Test', - ], - 'Type' => [ - 'description' => 'The type of the task.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ODPS_SQL', - ], - 'Owner' => [ - 'description' => 'The account ID of the owner.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1000', - ], - 'BaseLineId' => [ - 'description' => 'The baseline ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1234', - ], - 'Timeout' => [ - 'description' => 'The task execution timeout in seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3600', - ], - 'RerunMode' => [ - 'description' => 'Configuration for whether the task can be rerun.'."\n" - ."\n" - .'* AllDenied: The task cannot be rerun.'."\n" - .'* FailureAllowed: The task can be rerun only after it fails.'."\n" - .'* AllAllowed: The task can always be rerun.'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [], - 'example' => 'AllAllowed', - 'enum' => [ - 'AllAllowed', - 'FailureAllowed', - 'AllDenied', - ], - ], - 'RerunTimes' => [ - 'description' => 'The number of retry attempts. Takes effect when the task is configured to allow reruns.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3', - ], - 'RerunInterval' => [ - 'description' => 'The retry interval in seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '60', - ], - 'Script' => [ - 'description' => 'The run script information.'."\n", - 'type' => 'object', - 'properties' => [ - 'Content' => [ - 'description' => 'The script content.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'echo "helloWorld"', - ], - 'Parameters' => [ - 'description' => 'The script parameter list.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'para1=$bizdate', - ], - ], - 'required' => false, - ], - 'Trigger' => [ - 'description' => 'The trigger method.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The trigger type. Valid values:'."\n" - ."\n" - .'* Scheduler: periodically triggered'."\n" - .'* Manual'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Scheduler', - 'default' => 'Scheduler', - 'enum' => [ - 'Scheduler', - 'Manual', - ], - ], - 'Recurrence' => [ - 'description' => 'The running mode of the task after it is triggered. This parameter takes effect only if the Type parameter is set to Scheduler. Valid values:'."\n" - ."\n" - .'* Pause'."\n" - .'* Skip'."\n" - .'* Normal'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [], - 'example' => 'Normal', - 'enum' => [ - 'Normal', - 'Skip', - 'Pause', - ], - ], - ], - 'required' => true, - ], - 'RuntimeResource' => [ - 'description' => 'Runtime environment configurations, such as resource group information.'."\n", - 'type' => 'object', - 'properties' => [ - 'ResourceGroupId' => [ - 'description' => 'The identifier of the scheduling resource group used in the task runtime configuration.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', - ], - 'Image' => [ - 'description' => 'The image ID used in the task runtime configuration.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'i-xxxxxx', - ], - 'Cu' => [ - 'description' => 'The default number of compute units (CUs) configured for task running.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0.25', - ], - ], - 'required' => true, - ], - 'DataSource' => [ - 'description' => 'The information about the associated data source.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The data source name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'odps_test', - ], - ], - 'required' => false, - ], - 'Inputs' => [ - 'description' => 'The input information. By default, all input information is deleted if this parameter is set to null.'."\n", - 'type' => 'object', - 'properties' => [ - 'Variables' => [ - 'description' => 'The variables. By default, the settings of all input variables are deleted if this parameter is set to null or not specified.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the variable.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'key1', - ], - 'Type' => [ - 'title' => '类型', - 'description' => 'The type. Valid values:'."\n" - ."\n" - .'* Constant: constant value.'."\n" - .'* PassThrough: node output.'."\n" - .'* System: variable.'."\n" - .'* NodeOutput: script output.'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [], - 'example' => 'Constant', - 'enum' => [ - 'System', - 'Constant', - 'NodeOutput', - 'PassThrough', - ], - ], - 'Value' => [ - 'description' => 'The value of the variable.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'value1', - ], - ], - 'required' => false, - 'description' => '', - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'Outputs' => [ - 'description' => 'The output information. By default, all output information is deleted if this parameter is set to null.'."\n", - 'type' => 'object', - 'properties' => [ - 'TaskOutputs' => [ - 'description' => 'The task outputs. By default, all task output information is deleted if this parameter is set to null or not specified.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Output' => [ - 'title' => '输出标识符，示例：pre.odps_sql_demo_0', - 'description' => 'The identifier of the output.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'pre.odps_sql_demo_0', - ], - ], - 'required' => false, - 'description' => '', - ], - 'required' => false, - ], - 'Variables' => [ - 'description' => 'The variables. Note: The settings of all output variables are deleted if this parameter is set to null or not specified.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the variable.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'key1', - ], - 'Type' => [ - 'title' => '类型', - 'description' => 'The type. Valid values:'."\n" - ."\n" - .'* Constant: constant value.'."\n" - .'* PassThrough: node output.'."\n" - .'* System: variable.'."\n" - .'* NodeOutput: script output.'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [], - 'example' => 'Constant', - 'enum' => [ - 'System', - 'Constant', - 'NodeOutput', - 'PassThrough', - ], - ], - 'Value' => [ - 'description' => 'The value of the variable.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'value1', - ], - ], - 'required' => false, - 'description' => '', - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'Dependencies' => [ - 'description' => 'The dependency information. Note: If this parameter is left empty or set to an empty array, all dependency configurations will be deleted.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '依赖类型', - 'description' => 'The dependency type. Valid values:'."\n" - ."\n" - .'* CrossCycleDependsOnChildren: Depends on level-1 downstream nodes across cycles'."\n" - .'* CrossCycleDependsOnSelf: Depends on itself across cycles.'."\n" - .'* CrossCycleDependsOnOtherNode: Depends on other nodes across cycles.'."\n" - .'* Normal: Depends on nodes in the same cycle.'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [], - 'example' => 'Normal', - 'enum' => [ - 'Normal', - 'CrossCycleDependsOnSelf', - 'CrossCycleDependsOnChildren', - 'CrossCycleDependsOnOtherNode', - ], - ], - 'UpstreamOutput' => [ - 'title' => '依赖任务的输出标识符, DependencyType=Normal时 需要填此值', - 'description' => 'The output identifier of the upstream task. (This parameter is returned only if `Normal` is set and the node input is configured.)'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'pre.odps_sql_demo_0', - ], - 'UpstreamTaskId' => [ - 'title' => '依赖任务的任务ID, DependencyType=CrossCycleDependsOnOtherNode时 需要填此值', - 'description' => 'The ID of the upstream task. (This parameter is returned only if `Normal` or `CrossCycleDependsOnOtherNode` is set and the node input is not configured.)'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1234', - ], - ], - 'required' => false, - 'description' => '', - ], - 'required' => false, - ], - 'Tags' => [ - 'description' => 'The list of task tags. Note: If this field is unspecified or set to an empty array, all existing Tag configurations will be deleted by default.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of a tag.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'key1', - ], - 'Value' => [ - 'description' => 'The value of a tag.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'value1', - ], - ], - 'required' => false, - 'description' => '', - ], - 'required' => false, - ], - 'ClientUniqueCode' => [ - 'description' => 'The client-side unique token for the task, used to ensure asynchronous processing and idempotency. If not specified during creation, the system will automatically generate one. This token is uniquely associated with the resource ID. If provided when updating or deleting resources, this parameter must match the client token used during creation.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Task_0bc5213917368545132902xxxxxxxx', - ], - 'EnvType' => [ - 'description' => 'The project environment.'."\n" - ."\n" - .'* Prod'."\n" - .'* Dev'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Prod', - 'default' => 'Prod', - 'enum' => [ - 'Prod', - 'Dev', + 'schema' => ['description' => 'Remarks.', 'type' => 'string', 'required' => false, 'example' => 'this is a comment'."\n", 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17****', 'title' => ''], + 'SuccessInfo' => [ + 'description' => 'The result of the batch operation, which is in the MAP structure. The instance ID serves as a key, and the result serves as a value.', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Whether the operation is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The instance does not exist.', 'title' => ''], ], + 'description' => 'The returned result.', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'required' => false, - 'description' => '', ], - 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17****\\",\\n \\"SuccessInfo\\": {\\n \\"key\\": {\\n \\"Success\\": true,\\n \\"Message\\": \\"The instance does not exist.\\"\\n }\\n }\\n}","type":"json"}]', + 'title' => 'SetSuccessTaskInstances', + 'summary' => 'Sets the statuses of multiple instances to successful at a time.', + 'description' => 'This API operation is available for all DataWorks editions.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'StartDIJob' => [ + 'summary' => 'Starts a new-version synchronization task.', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'Outputs', - 'in' => 'formData', + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '235100', + 'abilityTreeNodes' => ['FEATUREdideBP0OJZ'], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the synchronization task.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000', 'title' => ''], + ], + [ + 'name' => 'ForceToRerun', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to forcefully rerun all synchronization steps. If you do not configure this parameter, the system does not perform the forcible rerun operation.'."\n" + ."\n" + .'- If the system does not perform the forcible rerun operation, only the steps that are not run start to run.'."\n" + ."\n" + .'- If the system performs the forcible rerun operation, all steps start to rerun.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'RealtimeStartSettings', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'The output information.'."\n", + 'description' => 'The settings for starting real-time synchronization.'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "StartTime":1663765058'."\n" + .'}'."\n" + .'```', 'type' => 'object', 'properties' => [ - 'TaskOutputs' => [ - 'description' => 'The task outputs.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Output' => [ - 'title' => '输出标识符，示例：pre.odps_sql_demo_0', - 'description' => 'The identifier of the output.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'pre.odps_sql_demo_0', - ], - ], - 'required' => false, - 'description' => '', + 'StartTime' => ['description' => 'The start time.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1671516776', 'title' => ''], + 'FailoverSettings' => [ + 'description' => 'This parameter is deprecated. Use advanced parameters for failover settings when you create a task.', + 'type' => 'object', + 'properties' => [ + 'Interval' => ['description' => 'This parameter is deprecated. Use advanced parameters for failover settings when you create a task.', 'type' => 'integer', 'format' => 'int64', 'deprecated' => true, 'required' => false, 'example' => '10', 'title' => ''], + 'UpperLimit' => ['description' => 'This parameter is deprecated. Use advanced parameters for failover settings when you create a task.', 'type' => 'integer', 'format' => 'int64', 'deprecated' => true, 'required' => false, 'example' => '30', 'title' => ''], ], + 'deprecated' => true, 'required' => false, + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Tags', + 'name' => 'DIJobId', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is deprecated. Use the Id parameter instead.', 'type' => 'integer', 'format' => 'int64', 'deprecated' => true, 'required' => false, 'example' => '10000', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '999431B2-6013-577F-B684-36F7433C753B'], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"999431B2-6013-577F-B684-36F7433C753B\\"\\n}","type":"json"}]', + 'title' => 'StartDIJob', + 'description' => 'This API operation is available for all DataWorks editions.', + 'changeSet' => [ + ['createdAt' => '2025-01-09T07:20:21.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-01-06T05:34:14.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-10-15T07:52:06.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'StartWorkflowInstances' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '260768', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB'], + ], + 'parameters' => [ + [ + 'name' => 'Ids', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'The tags.'."\n", + 'description' => 'The IDs of workflow instances.', 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'key1', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'value1', + 'items' => ['description' => 'The ID of the workflow instance.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234', 'title' => ''], + 'required' => true, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => ['description' => 'The remarks.', 'type' => 'string', 'required' => false, 'example' => 'this is a comment', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17****', 'title' => ''], + 'SuccessInfo' => [ + 'description' => 'The result of the batch operation, which is in the MAP structure. The workflow instance ID serves as a key, and the result serves as a value.', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => '该实例不存在。', 'title' => ''], + ], + 'description' => 'The result.', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'required' => false, - 'description' => '', ], - 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17****\\",\\n \\"SuccessInfo\\": {\\n \\"key\\": {\\n \\"Success\\": true,\\n \\"Message\\": \\"该实例不存在。\\"\\n }\\n }\\n}","type":"json"}]', + 'title' => 'Start Workflow Instance', + 'summary' => 'Start multiple workflow instances in batch.', + 'description' => 'You must purchase DataWorks Basic Edition or a higher edition to use this feature.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'StopDIJob' => [ + 'summary' => 'Stops a synchronization task.', + 'methods' => ['get'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '235119', + 'abilityTreeNodes' => ['FEATUREdideBP0OJZ'], + ], + 'parameters' => [ [ - 'name' => 'ClientUniqueCode', + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the synchronization task.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '11668', 'title' => ''], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The instance ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234', 'title' => ''], + ], + [ + 'name' => 'DIJobId', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is deprecated and is replaced by the Id parameter.', 'type' => 'integer', 'format' => 'int64', 'deprecated' => true, 'required' => false, 'example' => '11668', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.', 'type' => 'string', 'example' => '92F778C7-8F00-53B1-AE1A-B3B17101247D'], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"92F778C7-8F00-53B1-AE1A-B3B17101247D\\"\\n}","type":"json"}]', + 'title' => 'StopDIJob', + 'description' => 'This API operation is available for all DataWorks editions.', + 'changeSet' => [ + ['createdAt' => '2025-01-06T05:34:15.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-10-15T07:52:06.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'StopProcessInstance' => [ + 'summary' => 'Withdraws or terminates a specified process instance.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '243667', + 'abilityTreeNodes' => ['FEATUREdideYTM537'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ProcessInstanceId', + 'in' => 'formData', + 'schema' => ['description' => 'The process instance ID. This operation supports approval forms from both the old and new versions of Security Center.', 'type' => 'string', 'required' => true, 'example' => '176906667488145', 'title' => ''], + ], + [ + 'name' => 'ClientToken', 'in' => 'formData', + 'schema' => ['description' => 'A token to ensure that the request is idempotent. We recommend that you use a universally unique identifier (UUID).', 'type' => 'string', 'required' => false, 'example' => 'ABFUOEUOTRTRJKE', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The unique code of the client. This parameter is used to create a workflow asynchronously and implement the idempotence of the workflow. If you do not specify this parameter when you create the workflow, the system automatically generates a unique code. The unique code is uniquely associated with the workflow ID. If you specify this parameter when you update or delete the workflow, the value of this parameter must be the unique code that is used to create the workflow.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Workflow_0bc5213917368545132902xxxxxxxx', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID. Use this ID to locate logs and troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => '0bc5df3a17****903790e8e8a'], + ], + 'title' => '', + 'description' => 'The response object.', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'StopProcessInstance', + 'description' => '## Description'."\n" + ."\n" + .'- Requesters can use this operation to withdraw an approval process they initiated.'."\n" + ."\n" + .'- Only the initiator of the approval process can call this operation.'."\n" + ."\n" + .'- After a successful call, the operation terminates the approval process and updates its status to withdrawn.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc5df3a17****903790e8e8a\\"\\n}","type":"json"}]', + ], + 'StopTaskInstances' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'InstanceMode', + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '244301', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB'], + ], + 'parameters' => [ + [ + 'name' => 'Ids', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The instance generation mode.'."\n" - ."\n" - .'* T+1: the next day'."\n" - .'* Immediately Note: Periodic instances will only be generated normally if the workflow\'s scheduled time is more than 10 minutes after the workflow publication time. Real-time instance generation is not available during the batch instance generation period (23:30 to 24:00). While workflows can be published during this time, instances will not be regenerated immediately after submission.'."\n", - 'type' => 'string', + 'description' => 'The ID list of the task instance.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the task instance.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234', 'title' => ''], 'required' => false, - 'example' => 'T+1', - 'default' => 'T+1', - 'enum' => [ - 'T+1', - 'Immediately', - ], + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => ['description' => 'Remarks.', 'type' => 'string', 'required' => false, 'example' => 'this is a comment'."\n", 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17****', 'title' => ''], + 'SuccessInfo' => [ + 'description' => 'The result of the batch operation, which is in the MAP structure. The instance ID serves as a key, and the result serves as a value.', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Whether the operation is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The instance does not exist.', 'title' => ''], + ], + 'description' => 'The returned result.', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'UpdateWorkflow', - 'summary' => 'Updates a specified workflow in full update mode.', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", - ], - 'GetWorkflow' => [ - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17****\\",\\n \\"SuccessInfo\\": {\\n \\"key\\": {\\n \\"Success\\": true,\\n \\"Message\\": \\"The instance does not exist.\\"\\n }\\n }\\n}","type":"json"}]', + 'title' => 'StopTaskInstances', + 'summary' => 'Stops multiple instances at a time.', + 'description' => 'This API operation is available for all DataWorks editions.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'StopWorkflowInstances' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -44524,44 +45178,28 @@ ], 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '250954', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - 'FEATUREdideD0YY7B', - 'FEATUREdideVFMENL', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '260769', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB'], ], 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'query', + 'name' => 'Ids', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The workflow ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The workflow instance IDs.', + 'type' => 'array', + 'items' => ['description' => 'The workflow instance ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234', 'title' => ''], 'required' => true, - 'example' => '1234', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'EnvType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The environment of the workspace. Valid values:'."\n" - ."\n" - .'* Prod: production environment'."\n" - .'* Dev: development environment'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Prod', - 'default' => 'Prod', - 'enum' => [ - 'Prod', - 'Dev', - ], - ], + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => ['description' => 'The remarks.', 'type' => 'string', 'required' => false, 'example' => 'this is a comment', 'title' => ''], ], ], 'responses' => [ @@ -44569,1081 +45207,529 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX', - ], - 'Workflow' => [ - 'description' => 'The information about the workflow.'."\n", + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17****', 'title' => ''], + 'SuccessInfo' => [ + 'description' => 'The result of the batch operation, which is in the MAP structure. The workflow instance ID serves as a key, and the result serves as a value.', 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The workflow ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'ProjectId' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'EnvType' => [ - 'description' => 'The environment of the workspace. Valid values:'."\n" - ."\n" - .'* Prod: production environment'."\n" - .'* Dev: development environment'."\n", - 'type' => 'string', - 'example' => 'Prod', - ], - 'Owner' => [ - 'description' => 'The account ID of the workflow owner.'."\n", - 'type' => 'string', - 'example' => '1000', - ], - 'Name' => [ - 'description' => 'The name of the workflow.'."\n", - 'type' => 'string', - 'example' => 'Workflow', - ], - 'Description' => [ - 'description' => 'The description of the workflow.'."\n", - 'type' => 'string', - 'example' => 'Test workflow', - ], - 'Trigger' => [ - 'description' => 'The trigger method.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '`Scheduler` 周期触发', - 'description' => 'The trigger type. Valid values:'."\n" - ."\n" - .'* Scheduler: scheduling cycle-based trigger'."\n" - .'* Manual: manual trigger'."\n", - 'type' => 'string', - 'example' => 'Scheduler', - ], - 'Recurrence' => [ - 'description' => 'The running mode of the workflow after it is triggered. This parameter takes effect only if the Type parameter is set to Scheduler. Valid values:'."\n" - ."\n" - .'* Pause'."\n" - .'* Skip'."\n" - .'* Normal'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'Cron' => [ - 'description' => 'The CRON expression. This parameter takes effect only if the Type parameter is set to Scheduler.'."\n", - 'type' => 'string', - 'example' => '00 00 00 * * ?', - ], - 'StartTime' => [ - 'description' => 'The start time of the time range during which the workflow is periodically scheduled. This parameter takes effect only if the Type parameter is set to Scheduler.'."\n", - 'type' => 'string', - 'example' => '1970-01-01 00:00:00', - ], - 'EndTime' => [ - 'description' => 'The end time of the time range during which the workflow is periodically scheduled. This parameter takes effect only if the Type parameter is set to Scheduler.'."\n", - 'type' => 'string', - 'example' => '1970-01-01 00:00:00', - ], - ], - ], - 'Dependencies' => [ - 'description' => 'The dependency information.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '依赖类型', - 'description' => 'The scheduling dependency type. Valid values:'."\n" - ."\n" - .'* CrossCycleDependsOnChildren: cross-cycle dependency on the level-1 descendant nodes of a node'."\n" - .'* CrossCycleDependsOnSelf: cross-cycle dependency on the current node'."\n" - .'* CrossCycleDependsOnOtherNode: cross-cycle dependency on other nodes'."\n" - .'* Normal: same-cycle scheduling dependency'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'UpstreamOutput' => [ - 'title' => '依赖任务的输出标识符, DependencyType=Normal时 需要填此值', - 'description' => 'The identifier of the output of the ancestor task. This parameter is returned only if `same-cycle scheduling dependencies` and the node input are configured.'."\n", - 'type' => 'string', - 'example' => 'pre.odps_sql_demo_0', - ], - 'UpstreamTaskId' => [ - 'title' => '依赖任务的任务ID, DependencyType=CrossCycleDependsOnOtherNode时 需要填此值', - 'description' => 'The ancestor task ID. This parameter is returned only if `cross-cycle scheduling dependencies` or `same-cycle scheduling dependencies` and the node input are not configured.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - ], - 'description' => '', - ], - ], - 'Parameters' => [ - 'description' => 'The parameters.'."\n", - 'type' => 'string', - 'example' => 'para1=$bizdate para2=$[yyyymmdd] ', - ], - 'Tasks' => [ - 'description' => 'The tasks.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The task ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'ProjectId' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'EnvType' => [ - 'description' => 'The environment of the workspace. Valid values:'."\n" - ."\n" - .'* Prod'."\n" - .'* Dev'."\n", - 'type' => 'string', - 'example' => 'Prod', - ], - 'Owner' => [ - 'description' => 'The account ID of the task owner.'."\n", - 'type' => 'string', - 'example' => '1000', - ], - 'Name' => [ - 'description' => 'The name of the task.'."\n", - 'type' => 'string', - 'example' => 'SQL node', - ], - 'Description' => [ - 'description' => 'The description of the task.'."\n", - 'type' => 'string', - 'example' => 'Test', - ], - 'WorkflowId' => [ - 'description' => 'The ID of the workflow to which the task belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'Type' => [ - 'title' => '任务类型', - 'description' => 'The type of the task.'."\n", - 'type' => 'string', - 'example' => 'ODPS_SQL', - ], - 'BaselineId' => [ - 'title' => '基线ID', - 'description' => 'The baseline ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'Priority' => [ - 'title' => '任务优先级，最大值8，最小值1', - 'description' => 'The priority of the task. Valid values: 1 to 8. A larger value indicates a higher priority. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Timeout' => [ - 'title' => '任务执行超时时间，单位为秒', - 'description' => 'The timeout period of task running. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3600', - ], - 'RerunMode' => [ - 'title' => '任务是否允许重跑的配置', - 'description' => 'The rerun mode. Valid values:'."\n" - ."\n" - .'* AllDenied: The task cannot be rerun regardless of whether the task is successfully run or fails to run.'."\n" - .'* FailureAllowed: The task can be rerun only after it fails to run.'."\n" - .'* AllAllowed: The task can be rerun regardless of whether the task is successfully run or fails to run.'."\n", - 'type' => 'string', - 'example' => 'AllAllowed', - ], - 'RerunTimes' => [ - 'title' => '重试次数', - 'description' => 'The number of times that the task is rerun. This parameter takes effect only if the RerunMode parameter is set to AllAllowed or FailureAllowed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'RerunInterval' => [ - 'title' => '重试时间间隔，单位秒', - 'description' => 'The rerun interval. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - ], - 'RuntimeResource' => [ - 'title' => '运行环境配置，如资源组信息', - 'description' => 'The configurations of the runtime environment, such as the resource group information.'."\n", - 'type' => 'object', - 'properties' => [ - 'ResourceGroupId' => [ - 'description' => 'The ID of the resource group for scheduling configured for task running.'."\n", - 'type' => 'string', - 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', - ], - 'Image' => [ - 'description' => 'The ID of the image configured for task running.'."\n", - 'type' => 'string', - 'example' => 'i-xxxxxx', - ], - 'Cu' => [ - 'description' => 'The default number of compute units (CUs) configured for task running.'."\n", - 'type' => 'string', - 'example' => '0.25', - ], - ], - ], - 'DataSource' => [ - 'title' => '数据源', - 'description' => 'The information about the associated data source.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the data source.'."\n", - 'type' => 'string', - 'example' => 'mysql_test', - ], - ], - ], - 'CreateTime' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], - 'ModifyTime' => [ - 'description' => 'The modification time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], - 'CreateUser' => [ - 'description' => 'The account ID of the creator.'."\n", - 'type' => 'string', - 'example' => '1000', - ], - 'ModifyUser' => [ - 'description' => 'The account ID of the modifier.'."\n", - 'type' => 'string', - 'example' => '1000', - ], - 'TriggerRecurrence' => [ - 'description' => 'The running mode of the task after it is triggered. Valid values:'."\n" - ."\n" - .'* Pause'."\n" - .'* Skip'."\n" - .'* Normal'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'ClientUniqueCode' => [ - 'description' => 'The unique code of the client. This parameter is used to create a task asynchronously and implement the idempotence of the task. If you do not specify this parameter when you create the task, the system automatically generates a unique code. The unique code is uniquely associated with the task ID. If you specify this parameter when you update or delete the task, the value of this parameter must be the unique code that is used to create the task.'."\n", - 'type' => 'string', - 'example' => 'Task_0bc5213917368545132902xxxxxxxx', - ], - ], - 'description' => '', - ], - ], - 'Outputs' => [ - 'title' => '输出信息', - 'description' => 'The output information.'."\n", - 'type' => 'object', - 'properties' => [ - 'TaskOutputs' => [ - 'description' => 'The task outputs.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Output' => [ - 'title' => '输出标识符，示例：pre.odps_sql_demo_0', - 'description' => 'The identifier of the output.'."\n", - 'type' => 'string', - 'example' => 'pre.odps_sql_demo_0', - ], - ], - 'description' => '', - ], - ], - ], - ], - 'Tags' => [ - 'title' => '任务标签', - 'description' => 'The tags.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'key1', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => 'value1', - ], - ], - 'description' => '', - ], - ], - 'CreateTime' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], - 'ModifyTime' => [ - 'description' => 'The modification time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], - 'CreateUser' => [ - 'description' => 'The account ID of the creator.'."\n", - 'type' => 'string', - 'example' => '1000', - ], - 'ModifyUser' => [ - 'description' => 'The account ID of the modifier.'."\n", - 'type' => 'string', - 'example' => '1000', - ], - 'ClientUniqueCode' => [ - 'description' => 'The unique code of the client. This parameter is used to create a workflow asynchronously and implement the idempotence of the workflow. If you do not specify this parameter when you create the workflow, the system automatically generates a unique code. The unique code is uniquely associated with the workflow ID. If you specify this parameter when you update or delete the workflow, the value of this parameter must be the unique code that is used to create the workflow.'."\n", - 'type' => 'string', - 'example' => 'Workflow_0bc5213917368545132902xxxxxxxx', + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The instance does not exist.', 'title' => ''], ], + 'description' => 'The result.', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'description' => '', + 'title' => '', + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17****\\",\\n \\"SuccessInfo\\": {\\n \\"key\\": {\\n \\"Success\\": true,\\n \\"Message\\": \\"The instance does not exist.\\"\\n }\\n }\\n}","type":"json"}]', + 'title' => 'StopWorkflowInstances', + 'summary' => 'Stops multiple workflow instances at a time.', + 'description' => 'This API operation is available for all DataWorks editions.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"Workflow\\": {\\n \\"Id\\": 1234,\\n \\"ProjectId\\": 100,\\n \\"EnvType\\": \\"Prod\\",\\n \\"Owner\\": \\"1000\\",\\n \\"Name\\": \\"Workflow\\",\\n \\"Description\\": \\"Test workflow\\",\\n \\"Trigger\\": {\\n \\"Type\\": \\"Scheduler\\",\\n \\"Recurrence\\": \\"Normal\\",\\n \\"Cron\\": \\"00 00 00 * * ?\\",\\n \\"StartTime\\": \\"1970-01-01 00:00:00\\",\\n \\"EndTime\\": \\"1970-01-01 00:00:00\\"\\n },\\n \\"Dependencies\\": [\\n {\\n \\"Type\\": \\"Normal\\",\\n \\"UpstreamOutput\\": \\"pre.odps_sql_demo_0\\",\\n \\"UpstreamTaskId\\": 1234\\n }\\n ],\\n \\"Parameters\\": \\"para1=$bizdate para2=$[yyyymmdd] \\",\\n \\"Tasks\\": [\\n {\\n \\"Id\\": 1234,\\n \\"ProjectId\\": 100,\\n \\"EnvType\\": \\"Prod\\",\\n \\"Owner\\": \\"1000\\",\\n \\"Name\\": \\"SQL node\\",\\n \\"Description\\": \\"Test\\",\\n \\"WorkflowId\\": 1234,\\n \\"Type\\": \\"ODPS_SQL\\",\\n \\"BaselineId\\": 1234,\\n \\"Priority\\": 1,\\n \\"Timeout\\": 3600,\\n \\"RerunMode\\": \\"AllAllowed\\",\\n \\"RerunTimes\\": 3,\\n \\"RerunInterval\\": 60,\\n \\"RuntimeResource\\": {\\n \\"ResourceGroupId\\": \\"S_res_group_524258031846018_1684XXXXXXXXX\\",\\n \\"Image\\": \\"i-xxxxxx\\",\\n \\"Cu\\": \\"0.25\\"\\n },\\n \\"DataSource\\": {\\n \\"Name\\": \\"mysql_test\\"\\n },\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"1000\\",\\n \\"ModifyUser\\": \\"1000\\",\\n \\"TriggerRecurrence\\": \\"Normal\\",\\n \\"ClientUniqueCode\\": \\"Task_0bc5213917368545132902xxxxxxxx\\"\\n }\\n ],\\n \\"Outputs\\": {\\n \\"TaskOutputs\\": [\\n {\\n \\"Output\\": \\"pre.odps_sql_demo_0\\"\\n }\\n ]\\n },\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ],\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"1000\\",\\n \\"ModifyUser\\": \\"1000\\",\\n \\"ClientUniqueCode\\": \\"Workflow_0bc5213917368545132902xxxxxxxx\\"\\n }\\n}","type":"json"}]', - 'title' => 'GetWorkflow', - 'summary' => 'Queries the information about a workflow.', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", ], - 'ListWorkflows' => [ - 'summary' => 'Queries a list of workflows by page. You can also specify filter conditions to query workflows.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'SubmitFile' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '253457', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - 'FEATUREdideD0YY7B', - 'FEATUREdideVFMENL', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '268112', + 'abilityTreeNodes' => ['FEATUREdide8FM783'], ], 'parameters' => [ [ 'name' => 'ProjectId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '100', - ], + '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 specify either this parameter or the ProjectIdentifier parameter to identify the DataWorks workspace when you call this operation.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '100001', 'title' => ''], ], [ - 'name' => 'EnvType', + 'name' => 'ProjectIdentifier', 'in' => 'formData', - 'schema' => [ - 'description' => 'The environment of the workspace. Valid values:'."\n" - ."\n" - .'* Prod: production environment'."\n" - .'* Dev: development environment'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Prod', - 'default' => 'Prod', - 'enum' => [ - 'Prod', - 'Dev', - ], - ], + 'schema' => ['description' => 'The name of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace page to query the workspace name. You must specify either this parameter or the ProjectId parameter to identify the DataWorks workspace when you call this operation.', 'type' => 'string', 'required' => false, 'example' => 'dw_project', 'title' => ''], ], [ - 'name' => 'Ids', + 'name' => 'FileId', 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The IDs of the workflows. You can query multiple workflows at a time by workflow ID.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The workflow ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1234', - ], - 'required' => false, - ], + 'schema' => ['description' => 'The file ID. You can call the [ListFiles](~~173942~~) operation to obtain the ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1000000', 'title' => ''], ], [ - 'name' => 'Name', + 'name' => 'Comment', 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the workflow. Fuzzy match is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Workflow1', - ], + 'schema' => ['description' => 'The description of the submission.', 'type' => 'string', 'required' => false, 'example' => 'Submit a task for the first time', 'title' => ''], ], [ - 'name' => 'Owner', + 'name' => 'SkipAllDeployFileExtensions', 'in' => 'formData', - 'schema' => [ - 'description' => 'The account ID of the workflow owner.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1000', - ], + 'schema' => ['description' => 'Whether to skip the pre-deployment check after the file is submitted:'."\n" + ."\n" + .'- false: Do not skip. After the file is submitted, the system automatically triggers the pre-deployment check. The file becomes available for deployment only after the check is passed.'."\n" + ."\n" + .'- true: Skip. After the file is submitted, the system does not trigger the pre-deployment check. The file can proceed directly to deployment.', 'type' => 'boolean', 'default' => 'false', 'required' => false, 'example' => 'false', 'title' => ''], ], - [ - 'name' => 'TriggerType', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The trigger type.'."\n" - ."\n" - .'* Scheduler'."\n" - .'* Manual'."\n" - .'* TriggerWorkflow'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Scheduler', - 'default' => 'Scheduler', - 'enum' => [ - 'Scheduler', - 'Manual', - 'TriggerWorkflow', + 'description' => 'The response.', + 'type' => 'object', + 'properties' => [ + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The deployment package ID. You must specify this ID as a parameter when you call the [GetDeployment](~~173950~~) operation to query the details of the deployment.', 'type' => 'integer', 'format' => 'int64', 'example' => '3000001', '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 call was successful.'."\n" + ."\n" + .'- true: success.'."\n" + ."\n" + .'- false: failure.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'SortBy', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The field used for sorting. Fields such as TriggerTime and StartedTime are supported. The value of this parameter is in the Sort field + Sort by (Desc/Asc) format. By default, results are sorted in ascending order. Valid values:'."\n" - ."\n" - .'* ModifyTime (Desc/Asc)'."\n" - .'* CreateTime (Desc/Asc)'."\n" - .'* Id (Desc/Asc)'."\n" - ."\n" - .'Default value: Id Desc.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Id Desc', - ], + ], + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'Forbidden.Access', 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', 'description' => 'No permission, please authorize'], ], - [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 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' => ''], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + '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' => 'Commits a file to the development environment of the scheduling system to generate a task.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'SuspendTaskInstances' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'PageNumber', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'AK' => [], ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '244303', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB'], + ], + 'parameters' => [ [ - 'name' => 'Tags', + 'name' => 'Ids', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => '', + 'description' => 'The ID list of the task instance.', 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'key:value', - ], + 'items' => ['description' => 'The ID of the task instance.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234', 'title' => ''], 'required' => false, + 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => ['description' => 'Remarks.', 'type' => 'string', 'required' => false, 'example' => 'this is a comment', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX', - ], - 'PagingInfo' => [ - 'description' => 'Pagination information.'."\n", + 'RequestId' => ['description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17****'."\n", 'title' => ''], + 'SuccessInfo' => [ + 'description' => 'The result of the batch operation, which is in the MAP structure. The instance ID serves as a key, and the result serves as a value.', 'type' => 'object', - 'properties' => [ - 'Workflows' => [ - 'description' => 'The workflows.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The workflow ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'Name' => [ - 'description' => 'The name.'."\n", - 'type' => 'string', - 'example' => 'Workflow1', - ], - 'Description' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'Trigger' => [ - 'description' => 'The trigger method.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '`Scheduler` 周期触发', - 'description' => 'The trigger type. Valid values:'."\n" - ."\n" - .'* Scheduler: scheduling cycle-based trigger'."\n" - .'* Manual: manual trigger'."\n", - 'type' => 'string', - 'example' => 'Scheduler', - ], - 'Recurrence' => [ - 'description' => 'The running mode of the workflow after it is triggered. This parameter takes effect only if the Type parameter is set to Scheduler. Valid values:'."\n" - ."\n" - .'* Pause'."\n" - .'* Skip'."\n" - .'* Normal'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'Cron' => [ - 'description' => 'The CRON expression. This parameter takes effect only if the Type parameter is set to Scheduler.'."\n", - 'type' => 'string', - 'example' => '00 00 00 * * ?', - ], - 'StartTime' => [ - 'description' => 'The start time of the time range during which the workflow is periodically scheduled. This parameter takes effect only if the Type parameter is set to Scheduler.'."\n", - 'type' => 'string', - 'example' => '1970-01-01 00:00:00', - ], - 'EndTime' => [ - 'description' => 'The end time of the time range during which the workflow is periodically scheduled. This parameter takes effect only if the Type parameter is set to Scheduler.'."\n", - 'type' => 'string', - 'example' => '9999-01-01 00:00:00', - ], - ], - ], - 'Parameters' => [ - 'description' => 'The parameters.'."\n", - 'type' => 'string', - 'example' => 'para1=$bizdate para2=$[yyyymmdd] ', - ], - 'ClientUniqueCode' => [ - 'description' => 'The unique code of the client. This parameter is used to create a workflow asynchronously and implement the idempotence of the workflow. If you do not specify this parameter when you create the workflow, the system automatically generates a unique code. The unique code is uniquely associated with the workflow ID. If you specify this parameter when you update or delete the workflow, the value of this parameter must be the unique code that is used to create the workflow.'."\n", - 'type' => 'string', - 'example' => 'Workflow_0bc5213917368545132902xxxxxxxx', - ], - 'ProjectId' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'EnvType' => [ - 'description' => 'The environment of the workspace. Valid values:'."\n" - ."\n" - .'* Prod'."\n" - .'* Dev'."\n", - 'type' => 'string', - 'example' => 'Prod', - ], - 'Owner' => [ - 'description' => 'The account ID of the owner.'."\n", - 'type' => 'string', - 'example' => '1000', - ], - 'CreateTime' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], - 'ModifyTime' => [ - 'description' => 'The modification time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], - 'CreateUser' => [ - 'description' => 'The account ID of the creator.'."\n", - 'type' => 'string', - 'example' => '1000', - ], - 'ModifyUser' => [ - 'description' => 'The account ID of the modifier.'."\n", - 'type' => 'string', - 'example' => '1000', - ], - 'Tags' => [ - 'title' => '任务标签', - 'description' => 'The task tag.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of a tag.'."\n", - 'type' => 'string', - 'example' => 'key1', - ], - 'Value' => [ - 'description' => 'The value of a tag.'."\n", - 'type' => 'string', - 'example' => 'value1', - ], - ], - 'description' => '', - ], - ], - ], - 'description' => '', - ], - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - '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', + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Whether the operation is successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'The instance does not exist.', 'title' => ''], ], + 'description' => 'The result.', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17****\\\\n\\",\\n \\"SuccessInfo\\": {\\n \\"key\\": {\\n \\"Success\\": true,\\n \\"Message\\": \\"The instance does not exist.\\"\\n }\\n }\\n}","type":"json"}]', + 'title' => 'SuspendTaskInstances', + 'summary' => 'Suspends multiple instances at a time.', + 'description' => 'This API operation is available for all DataWorks editions.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"PagingInfo\\": {\\n \\"Workflows\\": [\\n {\\n \\"Id\\": 1234,\\n \\"Name\\": \\"Workflow1\\",\\n \\"Description\\": \\"test\\",\\n \\"Trigger\\": {\\n \\"Type\\": \\"Scheduler\\",\\n \\"Recurrence\\": \\"Normal\\",\\n \\"Cron\\": \\"00 00 00 * * ?\\",\\n \\"StartTime\\": \\"1970-01-01 00:00:00\\",\\n \\"EndTime\\": \\"9999-01-01 00:00:00\\"\\n },\\n \\"Parameters\\": \\"para1=$bizdate para2=$[yyyymmdd] \\",\\n \\"ClientUniqueCode\\": \\"Workflow_0bc5213917368545132902xxxxxxxx\\",\\n \\"ProjectId\\": 100,\\n \\"EnvType\\": \\"Prod\\",\\n \\"Owner\\": \\"1000\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"1000\\",\\n \\"ModifyUser\\": \\"1000\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ]\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1\\n }\\n}","type":"json"}]', - 'title' => 'ListWorkflows', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", + 'ramActions' => [], ], - 'GetRerunWorkflowInstancesResult' => [ - 'summary' => 'Query the result of asynchronous workflow instance reruns.', - 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], + 'TagDataAssets' => [ + 'summary' => 'Adds tags to data assets.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdideVFMENL', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '253894', + 'abilityTreeNodes' => ['FEATUREdideKQ371B'], ], 'parameters' => [ [ - 'name' => 'OperationId', + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The tags that you want to add to data assets.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tag that you want to add to data assets, in the key:value structure.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => true, 'maxLength' => 128, 'minLength' => 1, 'pattern' => '^[\\u4E00-\\u9FA5A-Za-z0-9_\\-@#*<>|\\[\\]()+=&%$!~]+$', 'example' => 'key', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'maxLength' => 128, 'minLength' => 0, 'pattern' => '^[\\u4E00-\\u9FA5A-Za-z0-9_\\-@#*<>|\\[\\]()+=&%$.!~]+$', 'required' => false, 'example' => 'value', 'title' => ''], + ], + 'required' => true, + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'maxItems' => 20, + 'minItems' => 1, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'DataAssetIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The data asset IDs.', + 'type' => 'array', + 'items' => ['description' => 'The data asset ID.', 'type' => 'string', 'required' => true, 'example' => '7259557000', 'title' => ''], + 'required' => true, + 'maxItems' => 100, + 'minItems' => 1, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'DataAssetType', 'in' => 'query', 'schema' => [ - 'description' => 'The operation ID used to asynchronously query the result of the workflow instance rerun. This value is obtained from the RerunWorkflowInstances operation.'."\n", + 'description' => 'The type of the data asset. Valid values:'."\n" + ."\n" + .'- ACS::DataWorks::Table'."\n" + ."\n" + .'- ACS::DataWorks::Task', + 'enumValueTitles' => [], 'type' => 'string', 'required' => true, - 'example' => 'e15ad21c-b0e9-4792-8f55-b037xxxxxxxx'."\n", + 'enum' => ['ACS::DataWorks::Task', 'ACS::DataWorks::Table'], + 'example' => 'ACS::DataWorks::Task', + 'title' => '', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The DataWorks workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000', 'title' => ''], + ], + [ + 'name' => 'EnvType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The environment of the workspace to which the data asset belongs. Valid values:'."\n" + ."\n" + .'- Dev: development environment'."\n" + ."\n" + .'- Prod: production environment', + 'enumValueTitles' => [], + 'type' => 'string', + 'enum' => ['Dev', 'Prod'], + 'required' => false, + 'example' => 'Prod', + 'title' => '', ], ], + [ + 'name' => 'AutoTraceEnabled', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable lineage-based automatic backtracking.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID, used for log tracing and troubleshooting.'."\n", - 'type' => 'string', - 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n", - ], - 'Result' => [ - 'description' => 'The result of the workflow instance rerun.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status. NotRun Success Failure'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'FailureMessage' => [ - 'description' => 'The failure message. Returned if the rerun fails.'."\n", - 'type' => 'string', - 'example' => 'Invalid Param xxx'."\n", - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0bc1ec92159376'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IdempotentParameterMismatch', - 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', - ], + ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => 'TagDataAssets', + 'description' => 'This API operation is available only for DataWorks Enterprise Edition or a more advanced edition.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\\\n\\",\\n \\"Result\\": {\\n \\"Status\\": \\"Success\\",\\n \\"FailureMessage\\": \\"Invalid Param xxx\\\\n\\"\\n }\\n}","type":"json"}]', - 'title' => 'GetRerunWorkflowInstancesResult', + 'ramActions' => [], ], - 'RerunWorkflowInstances' => [ - 'summary' => 'Reruns workflow instances.', - 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'TestDataSourceConnectivity' => [ + 'summary' => 'Test the connectivity of a data source on a resource group.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdideVFMENL', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '250948', + 'abilityTreeNodes' => ['FEATUREdideRWC5F7'], ], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The project ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123', - ], + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX'], ], [ - 'name' => 'EnvType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The environment of the workspace. Valid values:'."\n" - ."\n" - .'Prod Dev'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Prod', - 'default' => 'Prod', - 'enum' => [ - 'Prod', - 'Dev', - ], - ], + 'name' => 'DataSourceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the data source for which you want to test the network connectivity.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '144544'], ], [ - 'name' => 'WorkflowId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The workflow ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123', - ], + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The DataWorks workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '10001'], ], - [ - 'name' => 'Type', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The type of the workflow instance. Valid values:'."\n" - ."\n" - .'ManualWorkflow.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ManualWorkflow', - 'enum' => [ - 'ManualWorkflow', + 'title' => 'Schema of Response', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4CDF7B72-020B-542A-8465-21CFFA81****', 'title' => ''], + 'Connectivity' => [ + 'description' => 'The details of the connectivity test.', + 'type' => 'object', + 'properties' => [ + 'ConnectState' => ['description' => 'The result of the connectivity test. Valid values: Connectable: The network can be connected. ConfigError: The network can be connected, but the configurations are incorrect. Unreachable: The network cannot be connected. Unsupport: An error is reported due to other causes. For example, the desired resource group is being initialized.', 'type' => 'string', 'title' => '', 'example' => 'Connectable'], + 'ConnectMessage' => ['description' => 'The error message returned if the connectivity test fails. No such a message is returned if the connectivity test is successful.', 'type' => 'string', 'title' => '', 'example' => '连接数据库失败'], + 'DetailLogs' => [ + 'description' => 'The detailed logs of each step in the connectivity test.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StartTime' => ['description' => 'The start time of a step.', 'type' => 'integer', 'format' => 'int64', 'example' => '1730217600001', 'title' => ''], + 'EndTime' => ['description' => 'The end time of a step.', 'type' => 'integer', 'format' => 'int64', 'example' => '1730217604002', 'title' => ''], + 'Code' => ['description' => 'The code of the test item.', 'type' => 'string', 'example' => 'validate_input_parameters', 'title' => ''], + 'Message' => ['description' => 'The name of the step.', 'type' => 'string', 'example' => 'Validate input parameters', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4CDF7B72-020B-542A-8465-21CFFA81****\\",\\n \\"Connectivity\\": {\\n \\"ConnectState\\": \\"Connectable\\",\\n \\"ConnectMessage\\": \\"连接数据库失败\\",\\n \\"DetailLogs\\": [\\n {\\n \\"StartTime\\": 1730217600001,\\n \\"EndTime\\": 1730217604002,\\n \\"Code\\": \\"validate_input_parameters\\",\\n \\"Message\\": \\"Validate input parameters\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'Test the connectivity of a data source ', + 'description' => '1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.'."\n" + ."\n" + .'2. You must have at least one of the following roles in the DataWorks project space:
'."\n" + .' Tenant Owner, Space Administrator, Deployment, Developer, Project Owner, or O\\&M.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ [ - 'name' => 'Name', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The manual workflow name, used for fuzzy matching.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - ], - [ - 'name' => 'StartTriggerTime', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The start trigger time (creation time) of the manual workflow instance used for matching. This parameter must be used together with EndTriggerTime.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1710239005403', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:TestDataSourceConnectivity', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'translator' => 'manual', + ], + 'TriggerSchedulerTaskInstance' => [ + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'EndTriggerTime', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The end trigger time of the manual workflow instance used for matching. This parameter must be used together with the StartTriggerTime.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1710239005403', - ], + 'AK' => [], ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '244928', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB', 'FEATUREdideD0YY7B', 'FEATUREdideVFMENL'], + ], + 'parameters' => [ [ - 'name' => 'Bizdate', + 'name' => 'TaskId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The business date used for matching manual workflow instances.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1710239005403', - ], + 'schema' => ['description' => 'The task ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234', 'title' => ''], ], [ - 'name' => 'Status', - 'in' => 'formData', + 'name' => 'EnvType', + 'in' => 'query', 'schema' => [ - 'description' => 'The status used for matching manual workflow instances.'."\n" + 'description' => 'The environment of the workspace. Valid values:'."\n" ."\n" - .'Valid values:'."\n" + .'- Prod: production environment'."\n" ."\n" - .'* Success'."\n" - .'* Failure'."\n", + .'- Dev: development environment', + 'enumValueTitles' => [], 'type' => 'string', + 'default' => 'Prod', + 'enum' => ['Prod', 'Dev'], 'required' => false, - 'example' => 'Failure', - 'enum' => [ - 'Success', - 'Failure', - ], - ], - ], - [ - 'name' => 'Ids', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The instance IDs used for matching manual workflow instances.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The manual workflow instance ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '12345', - ], - 'required' => false, + 'example' => 'Prod', + 'title' => '', ], ], [ - 'name' => 'Filter', + 'name' => 'TriggerTime', 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The match conditions for internal instances of manual workflow instances.'."\n", - 'type' => 'object', - 'properties' => [ - 'RerunDownstreamEnabled' => [ - 'description' => 'Specifies whether to rerun the matched instances and all downstream instances.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - 'TaskIds' => [ - 'description' => 'The internal task IDs used for matching manual workflow instances.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The internal task ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '12345', - ], - 'required' => false, - ], - 'TaskName' => [ - 'description' => 'The internal task name used for matching the manual workflow instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'TaskInstanceStatuses' => [ - 'description' => 'The statuses of internal tasks used for matching manual workflow instances.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The status of internal instances.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Failure', - 'enum' => [ - 'NotRun', - 'Failure', - 'Success', - ], - ], - 'required' => false, - ], - 'TaskTypes' => [ - 'description' => 'Match internal tasks within the manual workflow by type.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The type of the internal task. For possible values of TaskType, see DataWorks nodes.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ODPS_SQL'."\n", - ], - 'required' => false, - ], - ], - 'required' => false, - ], + 'schema' => ['description' => 'The time defined by the HTTP Trigger node. This value is a UNIX timestamp.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1710239005403'."\n", 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID. Used for troubleshooting and log tracking.'."\n", - 'type' => 'string', - 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n", - ], - 'OperationId' => [ - 'description' => 'The operation ID. You can use this value to query the creation result via the GetRerunWorkflowInstancesResult operation.'."\n", - 'type' => 'string', - 'example' => 'e15ad21c-b0e9-4792-8f55-b037xxxxxxxx'."\n", - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n", 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\\\n\\",\\n \\"OperationId\\": \\"e15ad21c-b0e9-4792-8f55-b037xxxxxxxx\\\\n\\"\\n}","type":"json"}]', - 'title' => 'RerunWorkflowInstances', - ], - 'CreateWorkflowInstances' => [ - 'summary' => 'Creates a workflow instance, such as a data backfill workflow instance, based on configurations.', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\\\n\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'TriggerSchedulerTaskInstance', + 'summary' => 'Triggers a task to run by using an HTTP Trigger node at a specified time.', + 'description' => 'This API operation is available for all DataWorks editions.', + 'changeSet' => [ + ['createdAt' => '2025-01-06T09:33:04.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'UnTagDataAssets' => [ + 'summary' => 'Removes tags from data assets.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -45652,543 +45738,427 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '259200', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - 'FEATUREdideD0YY7B', - 'FEATUREdideVFMENL', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '253905', + 'abilityTreeNodes' => ['FEATUREdideKQ371B'], ], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'formData', + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The project ID.', - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The tags that you want to remove.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tag that you want to remove, in the key:value structure.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => true, 'maxLength' => 128, 'minLength' => 1, 'pattern' => '^[\\u4E00-\\u9FA5A-Za-z0-9_\\-@#*<>|\\[\\]()+=&%$!~]+$', 'example' => 'key', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'maxLength' => 128, 'minLength' => 0, 'pattern' => '^[\\u4E00-\\u9FA5A-Za-z0-9_\\-@#*<>|\\[\\]()+=&%$!.~]+$', 'required' => false, 'example' => 'value', 'title' => ''], + ], + 'required' => true, + 'title' => '', + 'example' => '', + ], 'required' => true, - 'example' => '100', + 'maxItems' => 20, + 'minItems' => 1, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'EnvType', - 'in' => 'formData', + 'name' => 'DataAssetIds', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The project environment. Valid values:'."\n" - ."\n" - .'* Prod'."\n" - .'* Dev'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Prod', - 'default' => 'Prod', - 'enum' => [ - 'Prod', - 'Dev', - ], + 'description' => 'The data asset IDs.', + 'type' => 'array', + 'items' => ['description' => 'The data asset ID.', 'type' => 'string', 'required' => true, 'example' => '7259557000', 'title' => ''], + 'required' => true, + 'maxItems' => 100, + 'minItems' => 1, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'WorkflowId', - 'in' => 'formData', + 'name' => 'DataAssetType', + 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the workflow to which the instance belongs. This parameter is set to 1 for auto triggered tasks.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The type of the data asset. Valid values:'."\n" + ."\n" + .'- ACS::DataWorks::Table'."\n" + ."\n" + .'- ACS::DataWorks::Task', + 'enumValueTitles' => [], + 'type' => 'string', 'required' => true, - 'example' => '1', + 'enum' => ['ACS::DataWorks::Task', 'ACS::DataWorks::Table'], + 'example' => 'ACS::DataWorks::Task', + 'title' => '', ], ], [ - 'name' => 'Name', - 'in' => 'formData', + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The DataWorks workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', 'title' => ''], + ], + [ + 'name' => 'EnvType', + 'in' => 'query', 'schema' => [ - 'description' => 'The name.', + 'description' => 'The environment of the workspace to which the data asset belongs. Valid values:'."\n" + ."\n" + .'- Dev: development environment'."\n" + ."\n" + .'- Prod: production environment', + 'enumValueTitles' => [], 'type' => 'string', - 'required' => true, - 'example' => 'WorkflowInstance1', + 'enum' => ['Prod', 'Dev'], + 'required' => false, + 'example' => 'Prod', + 'title' => '', ], ], - [ - 'name' => 'Periods', - 'in' => 'formData', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The configuration of the data backfilling period.'."\n", + 'title' => 'Schema of Response', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'BizDates' => [ - 'description' => 'The data timestamps. You can specify up to seven data timestamps.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'StartBizDate' => [ - 'description' => 'The data timestamp at which the data starts to be backfilled. Configure this parameter in the `yyyy-mm-dd` format.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '2024-11-20', - ], - 'EndBizDate' => [ - 'description' => 'The data timestamp at which data is no longer backfilled. Configure this parameter in the `yyyy-mm-dd` format.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '2024-11-24', - ], - ], - 'required' => false, - 'description' => '', - ], - 'required' => true, - ], - 'StartTime' => [ - 'description' => 'The start time of data backfill. Configure this parameter in the `hh:mm:ss` format. The time must be in the 24-hour clock. Default value: 00:00:00.'."\n" - ."\n" - .'If you configure this parameter, you must also configure the EndTime parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '00:00:00', - ], - 'EndTime' => [ - 'description' => 'The end time of data backfill. Configure this parameter in the `hh:mm:ss` format. The time must be in the 24-hour clock. Default value: 23:59:59.'."\n" - ."\n" - .'If you configure this parameter, you must also configure the StartTime parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '23:59:59', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '8754EE08-4AA2-5F77-ADD7-754DBBDA9F75'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'string', 'example' => 'true', 'title' => ''], ], - 'required' => false, + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8754EE08-4AA2-5F77-ADD7-754DBBDA9F75\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => 'UnTagDataAssets', + 'description' => 'This API operation is available only for DataWorks Enterprise Edition or a more advanced edition.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'UpdateAlertRule' => [ + 'summary' => 'Updates the information about a custom alert monitoring rule.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '249192', + 'abilityTreeNodes' => ['FEATUREdideRJGWWC'], + ], + 'parameters' => [ [ - 'name' => 'Type', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The type of the workflow instance. Valid values:'."\n" - ."\n" - .'* SupplementData: Data backfill. The usage of RootTaskIds and IncludeTaskIds varies based on the backfill mode. See the description of the DefaultRunProperties.Mode parameter.'."\n" - .'* ManualWorkflow: Manually triggered workflow. WorkflowId is required for a manual workflow. RootTaskIds is optional. If not specified, the system uses the default root task list of the manual workflow.'."\n" - .'* Manual: Manual task. You only need to specify RootTaskIds. This is the list of manual tasks to run.'."\n" - .'* SmokeTest: Smoke test. You only need to specify RootTaskIds. This is the list of test tasks to run.'."\n" - .'* TriggerWorkflow: Triggered Workflow You must specify the WorkflowId of the triggered workflow. IncludeTaskIds is optional. If you do not specify IncludeTaskIds, the entire workflow runs.'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [], - 'example' => 'SupplementData', - 'enum' => [ - 'ManualWorkflow', - 'SupplementData', - 'Manual', - 'SmokeTest', - 'TriggerWorkflow', - ], - ], + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '105412', 'title' => ''], ], [ - 'name' => 'WorkflowParameters', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The workflow parameters. This parameter takes effect when a specific workflow is specified (`WorkflowId != 1`). For scheduled workflows and triggered workflows, the format is key=value, and these parameters have lower priority than task parameters. For manual workflows, the format is JSON, and these parameters have higher priority than task parameters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{ '."\n" - .' "key1": "value1", '."\n" - .' "key2": "value2" '."\n" - .'}', - ], + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the rule.', 'type' => 'string', 'required' => false, 'example' => 'collection_name', 'title' => ''], ], [ - 'name' => 'TaskParameters', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The task-specific parameters. The value is in the JSON format. The key specifies the task ID. You can call the GetTask operation to obtain the format of the value by querying the script parameters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "1001": "key1=val2 key2=val2", '."\n" - .' "1002": "key1=val2 key2=val2"'."\n" - .'}', - ], + 'name' => 'Owner', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the Alibaba Cloud account used by the owner of the rule.', 'type' => 'string', 'required' => false, 'example' => '193379****', 'title' => ''], ], [ - 'name' => 'AutoStartEnabled', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The default value is true.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'name' => 'Enabled', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable the rule.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'DefaultRunProperties', - 'in' => 'formData', + 'name' => 'TriggerCondition', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'The runtime configuration.'."\n", + 'description' => 'The alert triggering condition.', 'type' => 'object', 'properties' => [ - 'RootTaskIds' => [ - 'description' => 'The list of root task IDs.'."\n" - ."\n" - .'* When Type is set to SupplementData, RootTaskIds is required unless Mode is set to Chain.'."\n" - .'* When Type is set to ManualWorkflow, RootTaskIds is optional. If it is not specified, the default root nodes of the manual workflow are used.'."\n" - .'* When Type is set to Manual, RootTaskIds is required and specifies the list of manual tasks to run.'."\n" - .'* When Type is set to SmokeTest, RootTaskIds is required and specifies the list of test tasks to run.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The task ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1234', - ], - 'required' => false, - ], - 'IncludeTaskIds' => [ - 'description' => 'The IDs of the tasks to run.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The task ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1234', - ], - 'required' => false, - ], - 'ExcludeTaskIds' => [ - 'description' => 'The IDs of the tasks not to run.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The task ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '4321', - ], - 'required' => false, - ], - 'IncludeProjectIds' => [ - 'description' => 'The IDs of the projects to run.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The project ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '100', - ], - 'required' => false, - ], - 'ExcludeProjectIds' => [ - 'description' => 'The IDs of the projects not to run.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The project ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '200', - ], - 'required' => false, - ], - 'Mode' => [ - 'description' => 'The data backfill mode. Default value: ManualSelection. Required when Type is set to SupplementData.'."\n" - ."\n" - .'* General: You can specify only one value for `RootTaskIds`. The `IncludeTaskIds` parameter is optional. If it\'s not specified, it defaults to including `RootTaskIds`.'."\n" - .'* ManualSelection: You can specify multiple values for `RootTaskIds`. The `IncludeTaskIds` parameter is optional. If it is not specified, it defaults to including `RootTaskIds`.'."\n" - .'* Chain: If you set the Mode parameter to Chain, leave the `RootTaskIds` parameter empty and set the `IncludeTaskIds` parameter to the start task ID and the end task ID.'."\n" - .'* AllDownstream: Only one `RootTaskId` can be specified.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'ManualSelection', - 'default' => 'ManualSelection', - 'enum' => [ - 'General', - 'ManualSelection', - 'Chain', - 'AllDownstream', - 'Huge', - ], - ], - 'Analysis' => [ - 'description' => 'The analysis configuration. Required when Type = SupplementData.'."\n", + 'Type' => ['description' => 'The alert type. Valid values:'."\n" + ."\n" + .'- Finished: An instance is successfully run.'."\n" + ."\n" + .'- UnFinished: An instance does not finish running before a specified point in time.'."\n" + ."\n" + .'- Error: An error occurs on an instance.'."\n" + ."\n" + .'- CycleUnfinished: An instance does not finish running as expected within a specific cycle.'."\n" + ."\n" + .'- Timeout: An instance times out.'."\n" + ."\n" + .'- InstanceTransferComplete: An instance is generated by the auto triggered node.'."\n" + ."\n" + .'- InstanceTransferFluctuate: The number of generated instances fluctuates.'."\n" + ."\n" + .'- ExhaustedError: An error persists after an instance is automatically rerun.'."\n" + ."\n" + .'- InstanceKeyword: An instance with errors contains specified keywords.'."\n" + ."\n" + .'- InstanceErrorCount: The number of instances on which an error occurs reaches a specified threshold.'."\n" + ."\n" + .'- InstanceErrorPercentage: The proportion of instances on which an error occurs in the workspace to the total number of instances reaches a specified threshold.'."\n" + ."\n" + .'- ResourceGroupPercentage: The usage rate of the resource group reaches a specified threshold.'."\n" + ."\n" + .'- ResourceGroupWaitCount: The number of instances that are waiting for resources in the resource group reaches a specified threshold.', 'type' => 'string', 'required' => false, 'example' => 'ERROR', 'title' => ''], + 'Extension' => [ + 'description' => 'The extended information about the rule. This parameter is required for specific types of alerts.', 'type' => 'object', 'properties' => [ - 'Enabled' => [ - 'description' => 'Specifies whether to enable the analysis feature. Required when Type = SupplementData.'."\n", - 'type' => 'boolean', + 'Error' => [ + 'description' => 'The configuration for an alert of the Error type.', + 'type' => 'object', + 'properties' => [ + 'StreamTaskIds' => [ + 'description' => 'The IDs of the real-time computing tasks. This parameter is required when you monitor real-time computing tasks.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the real-time computing task.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123123', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'AutoRerunAlertEnabled' => ['description' => 'Specifies whether to trigger an alert if a batch synchronization task is automatically rerun upon a failure.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], 'required' => false, - 'example' => 'true', + 'title' => '', + 'example' => '', ], - 'Blocked' => [ - 'description' => 'Specifies whether to block execution if the analysis fails. Required when Type = SupplementData.'."\n", - 'type' => 'boolean', + 'Timeout' => [ + 'description' => 'The configuration for an alert of the Timeout type.', + 'type' => 'object', + 'properties' => [ + 'TimeoutInMinutes' => ['description' => 'The timeout period. Unit: minutes.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], 'required' => false, - 'example' => 'true', + 'title' => '', + 'example' => '', ], - ], - 'required' => false, - ], - 'RunPolicy' => [ - 'description' => 'The run policy. If the parameter is left empty, the task configuration is used.'."\n", - 'type' => 'object', - 'properties' => [ - 'StartTime' => [ - 'description' => 'The start time of running. Configure this parameter in the `hh:mm:ss` format (24-hour clock). This parameter is required if you configure the RunPolicy parameter.'."\n", - 'type' => 'string', + 'UnFinished' => [ + 'description' => 'The configuration for an alert of the UnFinished type.', + 'type' => 'object', + 'properties' => [ + 'UnFinishedTime' => ['description' => 'The latest completion time of the instance. The period is in the hh:mm format. Valid values of hh: \\[0,47]. Valid values of mm: \\[0,59].', 'type' => 'string', 'required' => false, 'example' => '12:00', 'title' => ''], + ], 'required' => false, - 'example' => '00:00:00', + 'title' => '', + 'example' => '', ], - 'EndTime' => [ - 'description' => 'The end time of running. Configure this parameter in the `hh:mm:ss` format (24-hour clock). This parameter is required if you configure the RunPolicy parameter. Valid values:'."\n", - 'type' => 'string', + 'CycleUnfinished' => [ + 'description' => 'The configuration for an alert of the CycleUnfinished type.', + 'type' => 'object', + 'properties' => [ + 'CycleAndTime' => [ + 'description' => 'The configurations of the scheduling cycle and timeout period of the instance.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CycleId' => ['description' => 'The ID of the scheduling cycle of the instance. Valid values: \\[1,288].', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'Time' => ['description' => 'The latest completion time of the instance within the scheduling cycle. The time is in the hh:mm format. Valid values of hh: \\[0,47]. Valid values of mm: \\[0,59].', 'type' => 'string', 'required' => false, 'example' => '01:00'."\n", 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], 'required' => false, - 'example' => '23:59:59', + 'title' => '', + 'example' => '', ], - 'Type' => [ - 'title' => 'Daily 每天', - 'description' => 'The time period type. This parameter is required if you configure the RunPolicy parameter. Valid values:'."\n" - ."\n" - .'* Daily'."\n" - .'* Weekend'."\n", - 'type' => 'string', + 'InstanceErrorCount' => [ + 'description' => 'The configuration for an alert of the InstanceErrorCount type.', + 'type' => 'object', + 'properties' => [ + 'Count' => ['description' => 'The maximum number of instances on which an error occurs. Valid values: \\[1,10000].', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Daily', - 'enum' => [ - 'Daily', - 'Weekend', + 'title' => '', + 'example' => '', + ], + 'InstanceErrorPercentage' => [ + 'description' => 'The configuration for an alert of the InstanceErrorPercentage type.', + 'type' => 'object', + 'properties' => [ + 'Percentage' => ['description' => 'The maximum percentage of instances on which an error occurs in the workspace to the total number of instances. Valid values: \\[1-100].', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'Immediately' => [ - 'description' => 'Specifies whether a task whose scheduled run time is in the future can be run immediately. Default value: false.'."\n", - 'type' => 'boolean', + 'InstanceTransferFluctuate' => [ + 'description' => 'The configuration for an alert of the InstanceTransferFluctuate type.', + 'type' => 'object', + 'properties' => [ + 'Trend' => ['description' => 'The way in which the number of auto triggered node instances that are generated in your workspace fluctuates. Valid values:'."\n" + ."\n" + .'- abs: the absolute value. The number of instances increases or decreases.'."\n" + ."\n" + .'- increase: The number of instances increases.'."\n" + ."\n" + .'- decrease: The number of instances decreases.', 'type' => 'string', 'required' => false, 'example' => 'abs', 'title' => ''], + 'Percentage' => ['description' => 'The maximum percentage of fluctuation in the number of auto triggered node instances that are generated in your workspace. Valid values: \\[1-100].', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + ], 'required' => false, - 'example' => 'false', + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], - 'Alert' => [ - 'description' => 'The alert settings.'."\n", + 'Target' => [ + 'description' => 'The monitored objects.', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'title' => '报警策略', - 'description' => 'The alerting policy. Valid values:'."\n" - ."\n" - .'* Success: Alerts on success.'."\n" - .'* Failure: Alerts on failure.'."\n" - .'* SuccessFailure: Alerts on both success and failure.'."\n", - 'type' => 'string', + 'Type' => ['description' => 'The type of the monitored objects. Valid values:'."\n" + ."\n" + .'- Task: node'."\n" + ."\n" + .'- Baseline: baseline'."\n" + ."\n" + .'- project: workspace'."\n" + ."\n" + .'- BizProcess: workflow', 'type' => 'string', 'required' => false, 'example' => 'Task', 'title' => ''], + 'Ids' => [ + 'description' => 'The IDs of monitored objects.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the monitored object.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1894580', 'title' => ''], 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Succes', - 'enum' => [ - 'Success', - 'Failure', - 'SuccessFailure', - ], + 'title' => '', + 'example' => '', ], - 'NoticeType' => [ - 'title' => '通知方式', - 'description' => 'The alert notification method. Valid values:'."\n" - ."\n" - .'* Sms: SMS only.'."\n" - .'* Mail: Mail only.'."\n" - .'* SmsMail: SMS and mail.'."\n", - 'type' => 'string', + 'AllowTasks' => [ + 'description' => 'The nodes that are not to be monitored.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the node that is not to be monitored.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1111', 'title' => ''], 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Sms', - 'enum' => [ - 'Sms', - 'Mail', - 'SmsMail', - ], + 'title' => '', + 'example' => '', ], ], 'required' => false, - ], - 'Parallelism' => [ - 'title' => '并行度', - 'description' => 'The task concurrency. Values from 2 to 10 indicate concurrency. A value of 1 indicates sequential execution. Required when Type = SupplementData.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2', - ], - 'Order' => [ - 'title' => '运行顺序', - 'description' => 'The execution order. Default value: Asc.'."\n" - ."\n" - .'* Asc: ascending by business date.'."\n" - .'* Desc: descending by business date.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Asc', - 'default' => 'Asc', - 'enum' => [ - 'Asc', - 'Desc', - ], - ], - 'RuntimeResource' => [ - 'title' => '自定义资源组Identifier', - 'description' => 'The custom scheduling resource group ID. If left empty, the task configuration is used.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', - ], - 'Priority' => [ - 'title' => '自定义优先级', - 'description' => 'The execution priority, range: 1–11. A higher value indicates higher priority.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'PriorityWeightStrategy' => [ - 'description' => 'The priority weighting policy.'."\n" - ."\n" - .'* `Disable` (default): Do not enable.'."\n" - .'* `Upstream`: The priority is based on the total weight of upstream nodes. The deeper the hierarchy, the higher the weight.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Upstream', - 'enum' => [ - 'Disable', - 'Upstream', - ], + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Comment', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The reason for the creation.', - 'type' => 'string', - 'required' => false, - 'example' => 'create for test', - ], - ], - [ - 'name' => 'Tags', - 'in' => 'formData', + 'name' => 'Notification', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'The task tag list.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'tagValue', - ], - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'tagKey', - ], - ], - 'required' => false, - 'description' => '', - ], - 'required' => false, - ], - ], - [ - 'name' => 'TagCreationPolicy', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The tag creation policy. Valid values:'."\n" - ."\n" - .'* Append: New tags are added on top of the existing tags of the manual workflow.'."\n" - .'* Overwrite: Existing tags of the manual workflow are not inherited. New tags are created directly.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Append', - 'enum' => [ - 'Append', - 'Overwrite', - ], - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ + 'description' => 'The configuration for the alert notification.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request. It is used to locate logs and troubleshoot problems.', - 'type' => 'string', - 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX', - ], - 'OperationId' => [ - 'description' => 'The ID of the operation. You can use this field to query the results of the creation operation through the GetCreateWorkflowInstancesResult interface.', - 'type' => 'string', - 'example' => 'e15ad21c-b0e9-4792-8f55-b037xxxxxxxx', + 'SilenceStartTime' => ['description' => 'The start time for silence. The time is in the HH:mm:ss format.', 'type' => 'string', 'required' => false, 'example' => '00:00:00'."\n", 'title' => ''], + 'SilenceEndTime' => ['description' => 'The end time for silence. The time is in the HH:mm:ss format.', 'type' => 'string', 'required' => false, 'example' => '00:00:00'."\n", 'title' => ''], + 'IntervalInMinutes' => ['description' => 'The interval at which an alert notification is sent. Unit: minutes. Valid values: \\[5,10000].', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], + 'Maximum' => ['description' => 'The maximum number of times an alert notification can be sent within a calendar day. Valid values: \\[1, 10000].', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + 'Channels' => [ + 'description' => 'The alert notification channels.', + 'type' => 'array', + 'items' => ['description' => 'The alert notification channel. Valid values:'."\n" + ."\n" + .'- Mail'."\n" + ."\n" + .'- Phone'."\n" + ."\n" + .'- Sms: text message'."\n" + ."\n" + .'- Dingding: DingTalk'."\n" + ."\n" + .'- Feishu: Lark'."\n" + ."\n" + .'- Weixin: WeCom'."\n" + ."\n" + .'- Webhook: custom webhook', 'type' => 'string', 'required' => false, 'example' => 'Sms', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', ], - ], - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"OperationId\\": \\"e15ad21c-b0e9-4792-8f55-b037xxxxxxxx\\"\\n}","type":"json"}]', - 'title' => 'CreateWorkflowInstances', - ], - 'GetCreateWorkflowInstancesResult' => [ - 'summary' => 'Queries the result of asynchronously creating a workflow instance.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '259199', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - 'FEATUREdideD0YY7B', - 'FEATUREdideVFMENL', - ], - ], - 'parameters' => [ - [ - 'name' => 'OperationId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The operation ID. This parameter is used to query the result of asynchronously creating a workflow instance. You can call the CreateWorkflowInstances operation to query the ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'e15ad21c-b0e9-4792-8f55-b037xxxxxxxx', + 'Receivers' => [ + 'description' => 'The alert recipients.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ReceiverType' => ['description' => 'The type of the alert recipient. Valid valves:'."\n" + ."\n" + .'- AliUid: Alibaba Cloud account ID.'."\n" + ."\n" + .'- Shift Schedules: the personnel in a shift schedule.'."\n" + ."\n" + .'- TaskOwner: the task owner. The task owner can receive custom alerts and event alerts.'."\n" + ."\n" + .'- Owner: the baseline owner. The baseline owner can receive baseline alerts.'."\n" + ."\n" + .'- WebhookUrl: URL of a custom webhook.'."\n" + ."\n" + .'- DingdingUrl: DingTalk webhook URL.'."\n" + ."\n" + .'- FeishuUrl: Lark webhook URL.'."\n" + ."\n" + .'- WeixinUrl: WeCom webhook URL.', 'type' => 'string', 'required' => false, 'example' => 'TaskOwner', 'title' => ''], + 'ReceiverValues' => [ + 'description' => 'The alert recipients.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the alert recipient. If the ReceiverType parameter is set to AliUid, set this parameter to an Alibaba Cloud account ID. If the ReceiverType parameter is set to ShiftSchedule, set this parameter to a shift schedule ID. If the ReceiverType parameter is set to WebhookUrl, DingdingUrl, FeishuUrl, or WeixinUrl, set this parameter to a corresponding URL.', 'type' => 'string', 'required' => false, 'example' => '123123', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Extension' => ['description' => 'The additional configuration of the alert recipient. If the ReceiverType parameter is set to DingdingUrl, you can set this parameter to {"atAll":true} to remind all members in a DingTalk group.', 'type' => 'string', 'required' => false, 'example' => '{"atAll":true}'."\n", 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -46196,110 +46166,78 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX', - ], - 'Result' => [ - 'description' => 'The creation result of the workflow instance.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The creation status. Valid values:'."\n" - ."\n" - .'* Creating'."\n" - .'* Created'."\n" - .'* CreateFailure'."\n", - 'type' => 'string', - 'example' => 'Created', - ], - 'FailureMessage' => [ - 'description' => 'The error message. This parameter is returned only if the creation fails.'."\n", - 'type' => 'string', - 'example' => 'Invalid Param xxx', - ], - 'WorkflowInstanceIds' => [ - 'description' => 'The workflow instance IDs. This parameter is returned only if the creation is successful.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The workflow instance ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - ], - 'WorkflowTaskInstanceIds' => [ - 'description' => 'The list of task instance IDs corresponding to the workflow instance. This field is returned after successful creation.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The task instance ID corresponding to the workflow instance.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - ], - 'UnifiedWorkflowInstanceIds' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'D85FEE2B-6174-5817-AF9E-FDD02FEDA5BC'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"Result\\": {\\n \\"Status\\": \\"Created\\",\\n \\"FailureMessage\\": \\"Invalid Param xxx\\",\\n \\"WorkflowInstanceIds\\": [\\n 1234\\n ],\\n \\"WorkflowTaskInstanceIds\\": [\\n 1234\\n ],\\n \\"UnifiedWorkflowInstanceIds\\": [\\n 1234\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'GetCreateWorkflowInstancesResult', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", - ], - 'GetWorkflowInstance' => [ - 'summary' => 'Queries the information about a workflow instance.', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D85FEE2B-6174-5817-AF9E-FDD02FEDA5BC\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'UpdateAlertRule', + 'changeSet' => [ + ['createdAt' => '2024-12-27T03:06:33.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'UpdateBusiness' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '260634', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - 'FEATUREdideD0YY7B', - 'FEATUREdideVFMENL', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '268602', + 'abilityTreeNodes' => ['FEATUREdide8FM783'], ], 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the workflow instance.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234', - ], + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://dataworks.console.aliyun.com/workspace/list) and go to the Workspace 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' => '10001', 'title' => ''], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the DataWorks workspace. You can log on to the [DataWorks console](https://dataworks.console.aliyun.com/workspace/list) and go to the Workspace page to obtain the name. You must configure either this parameter or the `ProjectId` parameter to determine the DataWorks workspace to which the operation is applied.', 'type' => 'string', 'required' => false, 'example' => 'project_dw', 'title' => ''], + ], + [ + 'name' => 'BusinessName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the workflow.'."\n" + ."\n" + .'You can call the [ListBusiness](~~173945~~) operation to query the name.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'firstBusiness', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['description' => 'The description of the workflow.', 'type' => 'string', 'required' => false, 'example' => 'modified from first business', 'title' => ''], + ], + [ + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => ['description' => 'The owner of the workflow.'."\n" + ."\n" + .'You can call the [ListBusiness](~~173945~~) operation to query the owner.', 'type' => 'string', 'required' => false, 'example' => '34842****', 'title' => ''], + ], + [ + 'name' => 'BusinessId', + 'in' => 'formData', + 'schema' => ['description' => 'The workflow ID.'."\n" + ."\n" + .'You can call the [ListBusiness](~~173945~~) operation to query the ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '300001', 'title' => ''], ], ], 'responses' => [ @@ -46307,715 +46245,403 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX', - ], - 'WorkflowInstance' => [ - 'description' => 'The information about the workflow instance.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the workflow instance.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'WorkflowId' => [ - 'description' => 'The ID of the workflow to which the instance belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'WorkflowTaskInstanceId' => [ - 'description' => 'The task instance ID corresponding to the workflow instance.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'UnifiedWorkflowInstanceId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'Name' => [ - 'description' => 'The name of the workflow instance.'."\n", - 'type' => 'string', - 'example' => 'WorkInstance1', - ], - 'Type' => [ - 'title' => '工作流类型', - 'description' => 'The type of the workflow instance. Valid values:'."\n" - ."\n" - .'* Normal: Scheduled execution'."\n" - .'* Manual: Manually triggered node'."\n" - .'* SmokeTest: Testing'."\n" - .'* SupplementData: Data backfill'."\n" - .'* ManualWorkflow: Manually triggered workflow'."\n" - .'* TriggerWorkflow: Triggered Workflow'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'Status' => [ - 'description' => 'The status of the workflow instance. Valid values:'."\n" - ."\n" - .'* NotRun: The instance is not run.'."\n" - .'* Running: The instance is running.'."\n" - .'* WaitTime: The instance is waiting for the scheduling time to arrive.'."\n" - .'* CheckingCondition: Branch conditions are being checked for the instance.'."\n" - .'* WaitResource: The instance is waiting for resources.'."\n" - .'* Failure: The instance fails to be run.'."\n" - .'* Success: The instance is successfully run.'."\n" - .'* Checking: Data quality is being checked for the instance.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'BizDate' => [ - 'description' => 'The data timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], - 'StartedTime' => [ - 'description' => 'The time when the instance started to run.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], - 'FinishedTime' => [ - 'description' => 'The time when the instance finished running.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], - 'ProjectId' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'EnvType' => [ - 'description' => 'The environment of the workspace. Valid values:'."\n" - ."\n" - .'* Prod'."\n" - .'* Dev'."\n", - 'type' => 'string', - 'example' => 'Prod', - ], - 'Owner' => [ - 'description' => 'The account ID of the workflow owner.'."\n", - 'type' => 'string', - 'example' => '1000', - ], - 'CreateTime' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], - 'ModifyTime' => [ - 'description' => 'The modification time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], - 'CreateUser' => [ - 'description' => 'The account ID of the creator.'."\n", - 'type' => 'string', - 'example' => '1000', - ], - 'ModifyUser' => [ - 'description' => 'The account ID of the modifier.'."\n", - 'type' => 'string', - 'example' => '1000', - ], - 'WorkflowParameters' => [ - 'description' => 'The workflow parameters.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Tags' => [ - 'title' => '任务标签', - 'description' => 'The task tag.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of a tag.'."\n", - 'type' => 'string', - 'example' => 'key1', - ], - 'Value' => [ - 'description' => 'The value of a tag.'."\n", - 'type' => 'string', - 'example' => 'value1', - ], - ], - 'description' => '', - ], - ], - ], - ], + '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' => '0000-ABCD-EFG****', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', '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' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"WorkflowInstance\\": {\\n \\"Id\\": 1234,\\n \\"WorkflowId\\": 1234,\\n \\"WorkflowTaskInstanceId\\": 1234,\\n \\"UnifiedWorkflowInstanceId\\": 1234,\\n \\"Name\\": \\"WorkInstance1\\",\\n \\"Type\\": \\"Normal\\",\\n \\"Status\\": \\"Success\\",\\n \\"BizDate\\": 1710239005403,\\n \\"StartedTime\\": 1710239005403,\\n \\"FinishedTime\\": 1710239005403,\\n \\"ProjectId\\": 100,\\n \\"EnvType\\": \\"Prod\\",\\n \\"Owner\\": \\"1000\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"1000\\",\\n \\"ModifyUser\\": \\"1000\\",\\n \\"WorkflowParameters\\": \\"周期工作流：\\\\nkey1=value1 key2=value2\\\\n手动业务流程：\\\\n{\\\\\\"key1\\\\\\":\\\\\\"value1\\\\\\", \\\\\\"key2\\\\\\": \\\\\\"value2\\\\\\"}\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'GetWorkflowInstance', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", - ], - 'ListWorkflowInstances' => [ - 'summary' => 'Queries a list of workflow instances by page. You can also specify filter conditions to query workflow instances.', - '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.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' => 'UpdateBusiness', + 'summary' => 'Updates a workflow.', + '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"}]', + ], + 'UpdateColumnBusinessMetadata' => [ + 'summary' => 'Updates the business metadata for a column in a data map. This operation can only update the business description and custom attributes.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '260653', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - 'FEATUREdideD0YY7B', - 'FEATUREdideVFMENL', - ], + 'abilityTreeCode' => '268008', + 'abilityTreeNodes' => ['FEATUREdideE9XYA6'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '100', - ], - ], - [ - 'name' => 'BizDate', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The data timestamp. The value of this parameter is 00:00:00 of the day before the scheduling time of the instance. The value is a UNIX timestamp. Unit: milliseconds. Example: 1743350400000.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1710239005403', - ], - ], - [ - 'name' => 'Type', - 'in' => 'formData', - 'schema' => [ - 'title' => '工作流实例类型', - 'description' => 'The type of the workflow instance. Valid values:'."\n" - ."\n" - .'* Normal: Scheduled execution'."\n" - .'* Manual: Manually triggered node'."\n" - .'* SmokeTest: Smoke test'."\n" - .'* SupplementData: Data backfill'."\n" - .'* ManualWorkflow: Manually triggered workflow'."\n" - .'* TriggerWorkflow: Triggered Workflow'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Normal', - 'default' => 'Normal', - 'enum' => [ - 'Normal', - 'ManualWorkflow', - 'Manual', - 'SupplementData', - 'SmokeTest', - 'TriggerWorkflow', - ], - ], - ], - [ - 'name' => 'WorkflowId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the workflow to which the instance belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1234', - ], - ], - [ - 'name' => 'UnifiedWorkflowInstanceId', + 'name' => 'Id', 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1234', - ], + 'schema' => ['description' => 'The ID of the column. You can obtain this ID from the response of the `ListColumns` operation. For more information, see [Metadata Entity Concepts](~~2880092~~).', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'maxcompute-column:::project_name:[schema_name]:table_name:column_name'], ], [ - 'name' => 'Name', + 'name' => 'Description', 'in' => 'formData', - 'schema' => [ - 'description' => 'The instance name. Fuzzy match is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'WorkflowInstance1', - ], + 'schema' => ['description' => 'The business description of the column.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'test description'], ], [ - 'name' => 'Ids', + 'name' => 'CustomAttributes', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'The IDs of the workflow instances. You can query multiple instances at a time by instance ID.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The workflow instance ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1234', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'array', + 'items' => ['description' => 'The attribute value.', 'type' => 'string', 'example' => '张三', 'title' => ''], + 'title' => '', + 'description' => 'An array that contains the custom attribute value. This array can contain at most one element.', + 'example' => '', ], + 'example' => '{"biz_owner":["张三"]}', + 'title' => '', + 'description' => 'The custom attributes of the column, specified as key-value pairs. The key is the attribute identifier, and the value is an array that can contain at most one element. An empty array deletes the attribute\'s value. To avoid overwriting the column\'s business description, omit the `Description` parameter from the request. An empty object (`{}`) indicates that no custom attributes are updated.', 'required' => false, ], ], - [ - 'name' => 'Owner', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The account ID of the workflow instance owner.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1000', - ], - ], - [ - 'name' => 'SortBy', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The fields used for sorting. Fields such as TriggerTime and StartedTime are supported. The value of this parameter is in the Sort field + Sort by (Desc/Asc) format. By default, results are sorted in ascending order. Valid values:'."\n" - ."\n" - .'* TriggerTime (Desc/Asc)'."\n" - .'* StartedTime (Desc/Asc)'."\n" - .'* FinishedTime (Desc/Asc)'."\n" - .'* CreateTime (Desc/Asc)'."\n" - .'* Id (Desc/Asc)'."\n" - ."\n" - .'Default value: Id Desc.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Id Desc', + 'title' => '', + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'UpdateColumnBusinessMetadata', + 'description' => '1. This operation requires DataWorks Basic Edition or a later version.'."\n" + ."\n" + .'2. This operation supports only MaxCompute, hms, and dlf tables.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'UpdateComponent' => [ + 'summary' => 'Updates components.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'PageSize', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236014', + 'abilityTreeNodes' => ['FEATUREdideITYNXL'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ [ - 'name' => 'PageNumber', + 'name' => 'ComponentId', 'in' => 'formData', - '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 component ID.', 'type' => 'string', 'required' => true, 'example' => '568780096083*******', 'title' => ''], ], [ - 'name' => 'Tags', + 'name' => 'Spec', 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => '', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'key:value', - ], - 'required' => false, - ], + 'schema' => ['description' => 'The FlowSpec information for this UDF function. For more information, see [FlowSpec](https://github.com/aliyun/dataworks-spec/blob/master/README_zh_CN.md).', 'type' => 'string', 'required' => true, 'example' => '{'."\n" + .' "kind": "Component",'."\n" + .' "version": "1.1.2",'."\n" + .' "spec": {'."\n" + .' "components": ['."\n" + .' {'."\n" + .' "id": "568780096083*******",'."\n" + .' "script": {'."\n" + .' "content": "select \'@@{para1}\', \'@@{para2}\'"'."\n" + .' }'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .'}', 'title' => ''], ], [ - 'name' => 'Filter', - 'in' => 'formData', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '{ '."\n" - .' "status": "Success",'."\n" - .' "executionDate": "1763481600000"'."\n" - .'}', - ], + '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 query the ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX', - ], - 'PagingInfo' => [ - 'description' => 'Pagination information.'."\n", - 'type' => 'object', - 'properties' => [ - 'WorkflowInstances' => [ - 'description' => 'The workflow instances.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The workflow instance ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'WorkflowTaskInstanceId' => [ - 'description' => 'The task instance ID corresponding to the workflow instance.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'UnifiedWorkflowInstanceId' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'Name' => [ - 'description' => 'The name of the workflow instance.'."\n", - 'type' => 'string', - 'example' => 'WorkflowInstance1', - ], - 'Type' => [ - 'title' => '工作流类型', - 'description' => 'The type of the workflow instance. Valid values:'."\n" - ."\n" - .'* Normal: Scheduled execution'."\n" - .'* Manual: Manually triggered node'."\n" - .'* SmokeTest: Smoke test'."\n" - .'* SupplementData: Data backfill'."\n" - .'* ManualWorkflow: Manually triggered workflow'."\n" - .'* TriggerWorkflow: Triggered Workflow'."\n", - 'type' => 'string', - 'example' => 'Normal', - ], - 'Status' => [ - 'description' => 'The status of the workflow instance. Valid values:'."\n" - ."\n" - .'* NotRun: The instance is not run.'."\n" - .'* Running: The instance is running.'."\n" - .'* WaitTime: The instance is waiting for the scheduling time to arrive.'."\n" - .'* CheckingCondition: Branch conditions are being checked for the instance.'."\n" - .'* WaitResource: The instance is waiting for resources.'."\n" - .'* Failure: The instance fails to be run.'."\n" - .'* Success: The instance is successfully run.'."\n" - .'* Checking: Data quality is being checked for the instance.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'BizDate' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], - 'StartedTime' => [ - 'description' => 'The time when the instance started to run.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], - 'FinishedTime' => [ - 'description' => 'The time when the instance finished running.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], - 'ProjectId' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'EnvType' => [ - 'description' => 'The environment of the workspace. Valid values:'."\n" - ."\n" - .'* Prod'."\n" - .'* Dev'."\n", - 'type' => 'string', - 'example' => 'Prod', - ], - 'Owner' => [ - 'description' => 'The account ID of the workflow owner.'."\n", - 'type' => 'string', - 'example' => '1000', - ], - 'CreateTime' => [ - 'description' => 'The creation time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], - 'ModifyTime' => [ - 'description' => 'The modification time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], - 'CreateUser' => [ - 'description' => 'The account ID of the creator.'."\n", - 'type' => 'string', - 'example' => '100', - ], - 'ModifyUser' => [ - 'description' => 'The account ID of the modifier.'."\n", - 'type' => 'string', - 'example' => '100', - ], - 'WorkflowParameters' => [ - 'description' => 'The workflow parameters.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'WorkflowId' => [ - 'description' => 'The ID of the workflow to which the instance belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'Tags' => [ - 'title' => '任务标签', - 'description' => 'The task tag.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of a tag.'."\n", - 'type' => 'string', - 'example' => 'key1', - ], - 'Value' => [ - 'description' => 'The value of a tag.'."\n", - 'type' => 'string', - 'example' => 'value1', - ], - ], - 'description' => '', - ], - ], - ], - 'description' => '', - ], - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - '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', - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0bc1ec92159376'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], - 'description' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"PagingInfo\\": {\\n \\"WorkflowInstances\\": [\\n {\\n \\"Id\\": 1234,\\n \\"WorkflowTaskInstanceId\\": 1234,\\n \\"UnifiedWorkflowInstanceId\\": 1234,\\n \\"Name\\": \\"WorkflowInstance1\\",\\n \\"Type\\": \\"Normal\\",\\n \\"Status\\": \\"Success\\",\\n \\"BizDate\\": 1710239005403,\\n \\"StartedTime\\": 1710239005403,\\n \\"FinishedTime\\": 1710239005403,\\n \\"ProjectId\\": 100,\\n \\"EnvType\\": \\"Prod\\",\\n \\"Owner\\": \\"1000\\",\\n \\"CreateTime\\": 1710239005403,\\n \\"ModifyTime\\": 1710239005403,\\n \\"CreateUser\\": \\"100\\",\\n \\"ModifyUser\\": \\"100\\",\\n \\"WorkflowParameters\\": \\"周期工作流：\\\\nkey1=value1 key2=value2\\\\n手动业务流程：\\\\n{\\\\\\"key1\\\\\\":\\\\\\"value1\\\\\\", \\\\\\"key2\\\\\\": \\\\\\"value2\\\\\\"}\\",\\n \\"WorkflowId\\": 1234,\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Value\\": \\"value1\\"\\n }\\n ]\\n }\\n ],\\n \\"TotalCount\\": 100,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1\\n }\\n}","type":"json"}]', - 'title' => 'ListWorkflowInstances', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", - ], - 'StartWorkflowInstances' => [ - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateComponent', + 'description' => 'This API is currently in trial. To use this API, submit an application. After the administrator adds you to the trial list, you can call this API.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:UpdateComponent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'UpdateComputeResource' => [ + 'summary' => 'Modifies the specified computing resource based on the computing resource ID.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], - [ - 'BearerToken' => [], - ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '260768', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - ], + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '232392', + 'abilityTreeNodes' => ['FEATUREdideRWC5F7'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'Ids', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The IDs of workflow instances.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the workflow instance.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1234', - ], - 'required' => true, - ], + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the computing resource.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '10001'], ], [ - 'name' => 'Comment', - 'in' => 'formData', + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The DataWorks workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '10001'], + ], + [ + 'name' => 'ConnectionPropertiesMode', + 'in' => 'query', 'schema' => [ - 'description' => 'The remarks.'."\n", + 'description' => 'The category of the computing resource to be added. Different types have different subtypes and corresponding parameter schema constraints. Examples: InstanceMode and UrlMode.', 'type' => 'string', + 'enum' => ['UrlMode', 'InstanceMode', 'CdhMode'], + 'title' => '', 'required' => false, - 'example' => 'this is a comment', + 'example' => 'InstanceMode', ], ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The description of the computing resource. The maximum length is 3000 characters.', 'type' => 'string', 'example' => 'Level description', 'title' => '', 'required' => false], + ], + [ + 'name' => 'ConnectionProperties', + 'in' => 'query', + 'schema' => ['description' => 'The specific connection configuration of the computing resource, including the connection address, access identity, and environment information. The environment type (EnvType) of the computing resource is a member attribute of this object, including DEV (development environment) and PROD (production environment). The value is not case-sensitive.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '{'."\n" + .' "envType": "Prod",'."\n" + .' "regionId": "cn-beijing",'."\n" + .' "instanceId": "hgprecn-cn-x0r3oun4k001",'."\n" + .' "database": "testdb",'."\n" + .' "securityProtocol": "authTypeNone",'."\n" + .' "authType": "Executor",'."\n" + .' "authIdentity": "1107550004253538"'."\n" + .'}'], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned result.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '22C97E95-F023-56B5-8852-B1A77A17****', - ], - 'SuccessInfo' => [ - 'description' => 'The result of the batch operation, which is in the MAP structure. The workflow instance ID serves as a key, and the result serves as a value.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'type' => 'boolean', - 'description' => 'Indicates whether the request was successful.'."\n", - 'example' => 'true', - ], - 'Message' => [ - 'type' => 'string', - 'example' => '', - 'description' => 'The error message.'."\n", - ], - ], - 'description' => 'The result.'."\n", - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID. Used to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => '7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX'], + 'Success' => [ + 'description' => 'Indicates whether the computing resource was modified successfully:'."\n" + ."\n" + .'- true: Yes'."\n" + ."\n" + .'- false: No', + 'enumValueTitles' => ['true' => 'true', 'false' => 'false'], + 'type' => 'boolean', + 'example' => 'true', + 'title' => '', ], ], - 'description' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17****\\",\\n \\"SuccessInfo\\": {\\n \\"key\\": {\\n \\"Success\\": true,\\n \\"Message\\": \\"该实例不存在。\\"\\n }\\n }\\n}","type":"json"}]', - 'title' => 'StartWorkflowInstances', - 'summary' => 'Starts multiple workflow instances at a time.', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", - ], - 'StopWorkflowInstances' => [ - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateComputeResource', + 'description' => '1. You must purchase DataWorks Basic Edition or a higher edition to use this feature.'."\n" + ."\n" + .'2. You must have at least one of the following roles in the DataWorks project space:'."\n" + ."\n" + .'3. Tenant Owner, tenant administrator, Space Administrator, Project Owner, or O\\&M', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:UpdateComputeResource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'UpdateCustomAttribute' => [ + 'summary' => 'Updates a custom attribute.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'abilityTreeCode' => '260769', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdideX3KVYR'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'Ids', + 'name' => 'Id', 'in' => 'formData', - 'style' => 'json', + 'schema' => ['description' => 'The custom attribute ID.', 'type' => 'string', 'required' => true, 'example' => 'custom-attribute:biz_owner', 'title' => ''], + ], + [ + 'name' => 'DisplayName', + 'in' => 'formData', + 'schema' => ['description' => 'The new display name for the custom attribute. It must be 128 characters or less.', 'type' => 'string', 'example' => '业务负责人', 'title' => '', 'required' => false], + ], + [ + 'name' => 'EntityTypes', + 'in' => 'formData', + 'style' => 'simple', 'schema' => [ - 'description' => 'The workflow instance IDs.'."\n", 'type' => 'array', - 'items' => [ - 'description' => 'The workflow instance ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1234', - ], - 'required' => true, + 'items' => ['description' => 'The entity type.', 'type' => 'string', 'required' => false, 'example' => 'maxcompute-table', 'title' => ''], + 'maxItems' => 100, + 'minItems' => 0, + 'title' => '', + 'description' => 'The applicable entity types. This parameter supports specific types and wildcard formats, such as `*-table` and `*-column`. For example:'."\n" + ."\n" + .'- `dataworks-project`: A DataWorks workspace'."\n" + ."\n" + .'- `dataworks-dataset`: A DataWorks dataset'."\n" + ."\n" + .'- `maxcompute-table`: A MaxCompute table'."\n" + ."\n" + .'- `*-column`: All column types', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'ValueEnums', + 'in' => 'formData', + 'style' => 'simple', + 'schema' => [ + 'type' => 'array', + 'items' => ['description' => 'A value for the enum.', 'type' => 'string', 'required' => false, 'example' => 'VALUE_1', 'title' => ''], + 'maxItems' => 100, + 'minItems' => 1, + 'title' => '', + 'description' => 'The enumerated values. This applies only to custom attributes of the `enum` type. You can only append new values during an update.', + 'required' => false, + 'example' => '', ], ], + [ + 'name' => 'DisplayEnabled', + 'in' => 'formData', + 'schema' => ['description' => 'Whether to display the custom attribute in the UI.', 'type' => 'boolean', 'example' => 'true', 'title' => '', 'required' => false], + ], + [ + 'name' => 'SearchFilterEnabled', + 'in' => 'formData', + 'schema' => ['description' => 'Whether the custom attribute can be used as a filter condition.', 'type' => 'boolean', 'example' => 'false', 'title' => '', 'required' => false], + ], [ 'name' => 'Comment', 'in' => 'formData', - 'schema' => [ - 'description' => 'The remarks.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'this is a comment', - ], + 'schema' => ['description' => 'The new description for the custom attribute. It must be 256 characters or less.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'test comment'], ], ], 'responses' => [ @@ -47023,483 +46649,286 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '22C97E95-F023-56B5-8852-B1A77A17****', - ], - 'SuccessInfo' => [ - 'description' => 'The result of the batch operation, which is in the MAP structure. The workflow instance ID serves as a key, and the result serves as a value.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'type' => 'boolean', - 'description' => 'Indicates whether the request was successful.'."\n", - 'example' => 'true', - ], - 'Message' => [ - 'type' => 'string', - 'example' => 'The instance does not exist.', - 'description' => 'The error message.'."\n", - ], - ], - 'description' => 'The result.'."\n", - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '6B56C4A2-C7F3-52AF-8417-6DFF7447011B'], + 'Success' => ['description' => 'Whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'Result' => ['description' => 'Whether the update operation was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], - 'description' => '', + 'title' => '', + 'description' => 'The response data.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateCustomAttribute', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17****\\",\\n \\"SuccessInfo\\": {\\n \\"key\\": {\\n \\"Success\\": true,\\n \\"Message\\": \\"The instance does not exist.\\"\\n }\\n }\\n}","type":"json"}]', - 'title' => 'StopWorkflowInstances', - 'summary' => 'Stops multiple workflow instances at a time.', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6B56C4A2-C7F3-52AF-8417-6DFF7447011B\\",\\n \\"Success\\": true,\\n \\"Result\\": true\\n}","type":"json"}]', ], - 'ExecuteAdhocWorkflowInstance' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateDIAlarmRule' => [ + 'summary' => 'Updates an alert rule configured for a synchronization task.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '259719', - 'abilityTreeNodes' => [ - 'FEATUREdide7WF1GB', - 'FEATUREdideD0YY7B', - 'FEATUREdideVFMENL', - ], + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '234128', + 'abilityTreeNodes' => ['FEATUREdideBP0OJZ'], ], 'parameters' => [ [ - 'name' => 'EnvType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The environment of the workspace. Valid values:'."\n" - ."\n" - .'* Prod: production environment'."\n" - .'* Dev: development environment'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Prod', - 'default' => 'Prod', - 'enum' => [ - 'Prod', - 'Dev', - ], - ], + 'name' => 'Id', + 'in' => 'query', + 'schema' => ['description' => 'The alert rule Id', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '34982', 'title' => ''], ], [ - 'name' => 'Name', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the workflow instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'WorkflowInstance1', - ], + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The description of the alert rule.', 'type' => 'string', 'example' => 'Alert rule description.', 'required' => false, 'title' => ''], ], [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '100', - ], + 'name' => 'MetricType', + 'in' => 'query', + 'schema' => ['description' => 'The metric type in the alert rule. Valid values:'."\n" + ."\n" + .'- Heartbeat'."\n" + ."\n" + .'- FailoverCount'."\n" + ."\n" + .'- Delay'."\n" + ."\n" + .'- DdlReport'."\n" + ."\n" + .'- ResourceUtilization', 'type' => 'string', 'required' => false, 'example' => 'Heartbeat', 'title' => ''], ], [ - 'name' => 'Owner', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The account ID of the owner.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1000', - ], + 'name' => 'Enabled', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to enable the alert rule. By default, the alert rule is disabled.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'BizDate', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The data timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1710239005403', - ], + 'name' => 'DIJobId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the synchronization task.', 'type' => 'integer', 'format' => 'int64', 'deprecated' => false, 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Tasks', - 'in' => 'formData', + 'name' => 'TriggerConditions', + 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'The tasks.'."\n", + 'description' => 'The conditions that can trigger the alert rule.', 'type' => 'array', 'items' => [ + 'description' => 'The condition that can trigger the alert rule.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'The name of the task.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'SQL node.', - ], - 'Type' => [ - 'description' => 'The type of the task.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ODPS_SQL', - ], - 'Owner' => [ - 'description' => 'The account ID of the owner.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1000', - ], - 'Timeout' => [ - 'description' => 'The timeout period of task running. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '3600', - ], - 'Script' => [ - 'description' => 'The script information.'."\n", - 'type' => 'object', - 'properties' => [ - 'Content' => [ - 'description' => 'The script content.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'echo "helloWorld"', - ], - 'Parameters' => [ - 'description' => 'The script parameters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'para1=$bizdate', - ], - ], + 'Severity' => ['description' => 'The severity level. Valid values:'."\n" + ."\n" + .'- Warning'."\n" + ."\n" + .'- Critical', '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, 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' => ''], + 'DdlTypes' => [ + 'description' => 'The types of DDL operations for which the alert rule takes effect.', + 'type' => 'array', + 'items' => ['description' => 'The type of the DDL operation for which the alert rule takes effect. This parameter is required only if the MetricType parameter is set to DdlReport. Valid values:'."\n" + ."\n" + .'- AlterAddColumn'."\n" + ."\n" + .'- AlterDropColumn'."\n" + ."\n" + .'- AlterRenameColumn'."\n" + ."\n" + .'- AlterRenameTable'."\n" + ."\n" + .'- AlterTableModify'."\n" + ."\n" + .'- DropTable'."\n" + ."\n" + .'- TruncateTable', 'type' => 'string', 'required' => false, 'example' => 'AlterAddColumn', 'title' => ''], 'required' => false, + 'title' => '', + 'example' => '', ], - 'RuntimeResource' => [ - 'description' => 'The configurations of the runtime environment, such as the resource group information.'."\n", - 'type' => 'object', - 'properties' => [ - 'ResourceGroupId' => [ - 'description' => 'The ID of the resource group for scheduling configured for task running.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', - ], - 'Image' => [ - 'description' => 'The ID of the image configured for task running.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'i-xxxxxx', - ], - 'Cu' => [ - 'description' => 'The default number of compute units (CUs) configured for task running.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0.25', - ], - ], - 'required' => true, - ], - 'DataSource' => [ - 'description' => 'The information about the associated data source.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the data source.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mysql_test', - ], - ], + 'DdlReportTags' => [ + 'description' => 'This parameter is deprecated and replaced by the DdlTypes parameter.', + 'type' => 'array', + 'items' => ['description' => 'This parameter is deprecated and replaced by the DdlTypes parameter.', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'AlterAddColumn', 'title' => ''], + 'deprecated' => true, 'required' => false, + 'title' => '', + 'example' => '', ], - 'Inputs' => [ - 'description' => 'The input information.'."\n", + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'NotificationSettings', + 'in' => 'query', + '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' => [ - 'Variables' => [ - 'description' => 'The variables.'."\n", + 'Severity' => ['description' => 'The severity level. Valid values:'."\n" + ."\n" + .'- Warning'."\n" + ."\n" + .'- Critical', 'type' => 'string', 'required' => false, 'example' => 'Warning', 'title' => ''], + 'Channels' => [ + 'description' => 'The alert notification method. Valid values:'."\n" + ."\n" + .'- Mail'."\n" + ."\n" + .'- Phone'."\n" + ."\n" + .'- Sms'."\n" + ."\n" + .'- Ding', 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the variable.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'key1', - ], - 'Value' => [ - 'description' => 'The value of the variable. You must configure this parameter in the `The ancestor output: The output variable name of the ancestor task` format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Value1', - ], - ], - 'required' => false, - 'description' => '', - ], + 'items' => ['description' => 'The alert notification method. Valid values:'."\n" + ."\n" + .'- Mail'."\n" + ."\n" + .'- Phone'."\n" + ."\n" + .'- Sms'."\n" + ."\n" + .'- Ding', 'type' => 'string', 'required' => false, 'example' => 'Ding', 'title' => ''], 'required' => false, + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], - 'Outputs' => [ - 'description' => 'The output information.'."\n", + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'NotificationReceivers' => [ + 'description' => 'The settings of alert notification recipients.', + 'type' => 'array', + 'items' => [ + 'description' => 'The settings of alert notification recipients.', 'type' => 'object', 'properties' => [ - 'TaskOutputs' => [ - 'description' => 'The task outputs.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Output' => [ - 'title' => '输出标识符，示例：pre.odps_sql_demo_0', - 'description' => 'The identifier of the output.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'pre.odps_sql_demo_0', - ], - ], - 'required' => false, - 'description' => '', - ], - 'required' => false, - ], - 'Variables' => [ - 'description' => 'The variables.'."\n", + 'ReceiverType' => ['description' => 'The recipient type. Valid values: AliyunUid, DingToken, FeishuToken, and WebHookUrl.', 'type' => 'string', 'required' => false, 'example' => 'DingToken', 'title' => ''], + 'ReceiverValues' => [ + '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' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the variable.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'key1', - ], - 'Type' => [ - 'title' => '类型', - 'description' => 'The type. Valid values:'."\n" - ."\n" - .'* System'."\n" - .'* Constant'."\n" - .'* NodeOutput'."\n" - .'* PassThrough'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Constant', - 'enum' => [ - 'System', - 'Constant', - 'NodeOutput', - 'PassThrough', - ], - ], - 'Value' => [ - 'description' => 'The value of the variable.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'value1', - ], - ], - 'required' => false, - 'description' => '', - ], + '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' => '', ], - 'Dependencies' => [ - 'description' => 'The dependency information.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'UpstreamOutput' => [ - 'title' => '依赖任务的输出标识符, DependencyType=Normal时 需要填此值', - 'description' => 'The identifier of the output of the ancestor task.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'pre.odps_sql_demo_0', - ], - ], - 'required' => false, - 'description' => '', - ], - 'required' => false, - ], - 'ClientUniqueCode' => [ - 'description' => 'The unique code of the client. This code uniquely identifies a task.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Task_0bc5213917368545132902xxxxxxxx', - ], - ], - 'required' => false, - 'description' => '', - ], - 'required' => true, - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX', - ], - 'WorkflowInstanceId' => [ - 'description' => 'The workflow instance ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', + 'required' => false, + 'title' => '', + 'example' => '', ], + 'MuteInterval' => ['description' => 'The duration of the alert suppression interval. Default value: 5. Unit: minutes.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5', 'title' => ''], + 'InhibitionInterval' => ['description' => 'This parameter is deprecated and replaced by the MuteInterval parameter.', 'type' => 'integer', 'format' => 'int64', 'deprecated' => true, 'required' => false, 'example' => '5', 'title' => ''], ], - 'description' => '', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"WorkflowInstanceId\\": 1234\\n}","type":"json"}]', - 'title' => 'ExecuteAdhocWorkflowInstance', - 'summary' => 'Create a temporary workflow instance based on configurations.', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", - ], - 'CreateDataQualityTemplate' => [ - 'summary' => 'Creates a data quality template.', - 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdide3WJOKE', - ], - ], - 'parameters' => [ - [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The project ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', 'required' => false, - 'example' => '10000', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Spec', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Detailed configuration Spec code of the rule template. For more information, see [Data quality Spec configuration description](~2963394~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "assertion": "anomaly detection fro id_not_null_cnt",'."\n" - .' "id_not_null_cnt": {'."\n" - .' "query": "SELECT COUNT(*) AS cnt FROM ${tableName} WHERE dt = \'$[yyyymmdd-1]\';"'."\n" - .' },'."\n" - .' "identity": "819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a"'."\n" - .'}', - ], + 'name' => 'Name', + 'in' => 'query', + 'schema' => ['description' => 'The name of the alert rule.', 'type' => 'string', 'required' => false, 'example' => 'alarm_rule_name', 'title' => ''], ], [ - 'name' => 'Owner', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The owner ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1000000000001', - ], + 'name' => 'DIAlarmRuleId', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is deprecated. Use the Id parameter instead.', 'type' => 'integer', 'format' => 'int64', 'deprecated' => true, 'required' => false, 'example' => '34982', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The API request ID, which is generated as a UUID.'."\n", - 'type' => 'string', - 'example' => '0bc14115***159376359', - ], - 'Id' => [ - 'description' => 'The unique identifier of the newly created rule template.'."\n", - 'type' => 'string', - 'example' => 'USER-DEFINED:2001', - ], + 'RequestId' => ['description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => 'A6C6B486-E3A2-5D52-9E76-D9380485D946'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115***159376359\\",\\n \\"Id\\": \\"USER-DEFINED:2001\\"\\n}","type":"json"}]', - 'title' => 'CreateDataQualityTemplate', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", - ], - 'UpdateDataQualityTemplate' => [ - 'summary' => 'Updates a data quality rule template in a project', - 'path' => '', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A6C6B486-E3A2-5D52-9E76-D9380485D946\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'UpdateDIAlarmRule', + 'description' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-01-09T07:20:21.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-01-06T07:20:59.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-01-06T05:34:15.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'translator' => 'manual', + ], + 'UpdateDIJob' => [ + 'summary' => 'Update a Data Integration task.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -47508,427 +46937,698 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdide3WJOKE', - ], + 'abilityTreeCode' => '234099', + 'abilityTreeNodes' => ['FEATUREdideBP0OJZ'], ], 'parameters' => [ [ 'name' => 'Id', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the custom rule template.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'USER_DEFINED:2001', - ], + 'in' => 'query', + 'schema' => ['description' => 'The ID of the synchronization job.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '11588', 'title' => ''], ], [ - 'name' => 'ProjectId', + 'name' => 'Description', 'in' => 'formData', - 'schema' => [ - 'description' => 'The project ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '100001', - ], + 'schema' => ['description' => 'The description of the synchronization job.', 'type' => 'string', 'required' => false, 'example' => 'DI Job Demo', 'title' => ''], ], [ - 'name' => 'Spec', + 'name' => 'TableMappings', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'Detailed configuration Spec code of the rule template. For more information, see [Data quality Spec configuration description](~2963394~).'."\n", - 'type' => 'string', + 'description' => 'A list of object transformation mappings. Each mapping specifies a set of selection rules for source objects and a list of transformation rules that apply to the selected objects.'."\n" + ."\n" + .'> \\[ { "SourceObjectSelectionRules":\\[ { "ObjectType":"Database", "Action":"Include", "ExpressionType":"Exact", "Expression":"biz\\_db" }, { "ObjectType":"Schema", "Action":"Include", "ExpressionType":"Exact", "Expression":"s1" }, { "ObjectType":"Table", "Action":"Include", "ExpressionType":"Exact", "Expression":"table1" } ], "TransformationRuleNames":\\[ { "RuleName":"my\\_database\\_rename\\_rule", "RuleActionType":"Rename", "RuleTargetType":"Schema" } ] } ]', + 'type' => 'array', + 'items' => [ + 'description' => 'A single object transformation mapping, which specifies a set of selection rules for source objects and a list of transformation rules to apply to those objects.', + 'type' => 'object', + 'properties' => [ + 'SourceObjectSelectionRules' => [ + 'description' => 'The rules for selecting source objects. Each rule can select a different type of source object to synchronize, such as a source database or table.', + 'type' => 'array', + 'items' => [ + 'description' => 'A rule for selecting a source object to synchronize, such as a database or table.', + 'type' => 'object', + 'properties' => [ + 'Action' => ['description' => 'The selection action. Valid values: `Include` and `Exclude`.', 'type' => 'string', 'required' => false, 'example' => 'Include', 'title' => ''], + 'Expression' => ['description' => 'The expression.', 'type' => 'string', 'required' => false, 'example' => 'mysql_table_1', 'title' => ''], + 'ExpressionType' => ['description' => 'The type of the expression. Valid values: `Exact` and `Regex`.', 'type' => 'string', 'required' => false, 'example' => 'Exact', 'title' => ''], + 'ObjectType' => ['description' => 'The object type. Valid values:'."\n" + ."\n" + .'- `Table` (table)'."\n" + ."\n" + .'- `Schema` (schema)'."\n" + ."\n" + .'- `Database` (database)', 'type' => 'string', 'required' => false, 'example' => 'Table', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'TransformationRules' => [ + 'description' => 'The transformation rules for the source objects.', + 'type' => 'array', + 'items' => [ + 'description' => 'A single transformation rule for a source object.', + 'type' => 'object', + 'properties' => [ + 'RuleName' => ['description' => 'The name of the transformation rule. The name must be unique for a specific combination of `RuleActionType` and `RuleTargetType` and can be up to 50 characters long.', 'type' => 'string', 'required' => false, 'example' => 'rename_rule_1', 'title' => ''], + 'RuleActionType' => ['description' => 'The type of the action. Valid values:'."\n" + ."\n" + .'- `DefinePrimaryKey`: Defines a primary key.'."\n" + ."\n" + .'- `Rename`: Renames an object.'."\n" + ."\n" + .'- `AddColumn`: Adds a column.'."\n" + ."\n" + .'- `HandleDml`: Handles DML operations.', 'type' => 'string', 'required' => false, 'example' => 'Rename', 'title' => ''], + 'RuleTargetType' => ['description' => 'The type of the target object. Valid values:'."\n" + ."\n" + .'- `Table` (table)'."\n" + ."\n" + .'- `Schema` (schema)'."\n" + ."\n" + .'- `Database` (database)', 'type' => 'string', 'required' => false, 'example' => 'Table', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => '{'."\n" - .' "assertion": "anomaly detection fro id_not_null_cnt",'."\n" - .' "id_not_null_cnt": {'."\n" - .' "query": "SELECT COUNT(*) AS cnt FROM ${tableName} WHERE dt = \'$[yyyymmdd-1]\';"'."\n" - .' },'."\n" - .' "identity": "819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a"'."\n" - .'}', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Owner', - 'in' => 'query', + 'name' => 'JobSettings', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The account ID of the owner.'."\n", - 'type' => 'string', + 'description' => 'The settings for the synchronization job. This includes DDL handling settings, data type mappings for columns between the source and destination, and runtime parameters.', + 'type' => 'object', + 'properties' => [ + 'ChannelSettings' => ['description' => 'The job settings for specific data synchronization channels. You can apply special configurations to certain channels. Currently, `Holo2Holo` (synchronization from Hologres to Hologres) and `Holo2Kafka` (synchronization from Hologres to Kafka) are supported.'."\n" + ."\n" + .'1. `Holo2Kafka`'."\n" + ."\n" + .'- Example: `{"destinationChannelSettings":{"kafkaClientProperties":[{"key":"linger.ms","value":"100"}],"keyColumns":["col3"],"writeMode":"canal"}}`'."\n" + .' `kafkaClientProperties`: The Kafka producer parameters used when writing to Kafka.'."\n" + ."\n" + .'- `keyColumns`: The columns whose values are written to the key of a Kafka message.'."\n" + ."\n" + .'- `writeMode`: The format for writing data to Kafka. Valid values: `json` and `canal`.'."\n" + ."\n" + .'2. `Holo2Holo`'."\n" + ."\n" + .'- Example: `{"destinationChannelSettings":{"conflictMode":"replace","dynamicColumnAction":"replay","writeMode":"replay"}}`'."\n" + ."\n" + .'- `conflictMode`: The conflict handling policy for writing data to Hologres. Valid values: `replace` (overwrite) and `ignore` (ignore).'."\n" + ."\n" + .'- `writeMode`: The method for writing data to Hologres. Valid values: `replay` and `insert`.'."\n" + ."\n" + .'- `dynamicColumnAction`: The action for handling dynamic columns when writing data to Hologres. Valid values: `replay`, `insert`, and `ignore`.', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "structInfo": "MANAGED",'."\n" + .' "storageType": "TEXTFILE",'."\n" + .' "writeMode": "APPEND",'."\n" + .' "partitionColumns": ['."\n" + .' {'."\n" + .' "columnName": "pt",'."\n" + .' "columnType": "STRING",'."\n" + .' "comment": ""'."\n" + .' }'."\n" + .' ],'."\n" + .' "fieldDelimiter": ""'."\n" + .'}', 'title' => ''], + 'ColumnDataTypeSettings' => [ + 'description' => 'An array of column data type mappings.'."\n" + ."\n" + .'> \\["ColumnDataTypeSettings":\\[ { "SourceDataType":"Bigint", "DestinationDataType":"Text" } ]', + 'type' => 'array', + 'items' => [ + 'description' => 'A single column data type mapping.', + 'type' => 'object', + 'properties' => [ + 'DestinationDataType' => ['description' => 'The destination data type. Examples: `bigint`, `boolean`, `string`, `text`, `datetime`, `timestamp`, `decimal`, and `binary`. The supported data types depend on the destination data source.', 'type' => 'string', 'required' => false, 'example' => 'text', 'title' => ''], + 'SourceDataType' => ['description' => 'The source data type. Examples: `bigint`, `boolean`, `string`, `text`, `datetime`, `timestamp`, `decimal`, and `binary`. The supported data types depend on the source data source.', 'type' => 'string', 'required' => false, 'example' => 'bigint', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'CycleScheduleSettings' => [ + 'description' => 'The settings for periodic scheduling.', + 'type' => 'object', + 'properties' => [ + 'ScheduleParameters' => ['description' => 'The scheduling parameters.', 'type' => 'string', 'required' => false, 'example' => 'bizdate=$bizdate'."\n", 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'DdlHandlingSettings' => [ + 'description' => 'An array of DDL handling settings.'."\n" + ."\n" + .'> \\["DDLHandlingSettings":\\[ { "Type":"Insert", "Action":"Normal" } ]', + 'type' => 'array', + 'items' => [ + 'description' => 'A single DDL handling setting.', + 'type' => 'object', + 'properties' => [ + 'Action' => ['description' => 'The handling action. Valid values:'."\n" + ."\n" + .'- `Ignore`: Ignores the DDL message.'."\n" + ."\n" + .'- `Critical`: Reports an error and terminates the synchronization job.'."\n" + ."\n" + .'- `Normal`: Processes the DDL message normally.', 'type' => 'string', 'required' => false, 'example' => 'Critical', 'title' => ''], + 'Type' => ['description' => 'The DDL type. Valid values:'."\n" + ."\n" + .'- `RenameColumn`'."\n" + ."\n" + .'- `ModifyColumn`'."\n" + ."\n" + .'- `CreateTable`'."\n" + ."\n" + .'- `TruncateTable`'."\n" + ."\n" + .'- `DropTable`'."\n" + ."\n" + .'- `DropColumn`'."\n" + ."\n" + .'- `AddColumn`', 'type' => 'string', 'required' => false, 'example' => 'AddColumn', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'RuntimeSettings' => [ + 'description' => 'The runtime settings.', + 'type' => 'array', + 'items' => [ + 'description' => 'A single runtime setting.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the setting. Valid values:'."\n" + ."\n" + .'- `src.offline.datasource.max.connection`: The maximum number of concurrent connections to the source for an offline synchronization job.'."\n" + ."\n" + .'- `dst.offline.truncate`: Specifies whether to truncate the destination table before an offline synchronization job.'."\n" + ."\n" + .'- `runtime.offline.speed.limit.enable`: Specifies whether to enable speed limiting for an offline synchronization job.'."\n" + ."\n" + .'- `runtime.offline.concurrent`: The concurrency level for an offline synchronization job.'."\n" + ."\n" + .'- `runtime.enable.auto.create.schema`: Specifies whether to automatically create a schema at the destination.'."\n" + ."\n" + .'- `runtime.realtime.concurrent`: The concurrency level for a real-time synchronization job.'."\n" + ."\n" + .'- `runtime.realtime.failover.minute.dataxcdc`: The number of minutes to wait before a failover retry.'."\n" + ."\n" + .'- `runtime.realtime.failover.times.dataxcdc`: The number of failover retries.', 'type' => 'string', 'required' => false, 'example' => 'src.offline.datasource.max.connection', 'title' => ''], + 'Value' => ['description' => 'The value of the setting.', 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], 'required' => false, - 'example' => '95279527****', + 'title' => '', + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'ResourceSettings', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The resource settings.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The API request ID, which is generated as a UUID.'."\n", - 'type' => 'string', - 'example' => '0bc14115***159376359', + 'OfflineResourceSettings' => [ + 'description' => 'The resource settings for the offline synchronization job.', + 'type' => 'object', + 'properties' => [ + 'RequestedCu' => ['description' => 'The number of CUs for the Data Integration resource group used by the offline synchronization job.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '2', 'title' => ''], + 'ResourceGroupIdentifier' => ['description' => 'The name of the Data Integration resource group used by the offline synchronization job.', 'type' => 'string', 'required' => false, 'example' => 'S_res_group_111_222', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'Success' => [ - 'description' => 'Indicates whether the rule template is updated.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'RealtimeResourceSettings' => [ + 'description' => 'The resource settings for the real-time synchronization job.', + 'type' => 'object', + 'properties' => [ + 'RequestedCu' => ['description' => 'The number of CUs for the Data Integration resource group used by the real-time synchronization job.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '2', 'title' => ''], + 'ResourceGroupIdentifier' => ['description' => 'The name of the Data Integration resource group used by the real-time synchronization job.', 'type' => 'string', 'required' => false, 'example' => 'S_res_group_111_222', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'ScheduleResourceSettings' => [ + 'description' => 'The scheduling resource settings.', + 'type' => 'object', + 'properties' => [ + 'RequestedCu' => ['description' => 'The number of CUs for the scheduling resource group used by the offline synchronization job.', 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '2', 'title' => ''], + 'ResourceGroupIdentifier' => ['description' => 'The name of the scheduling resource group used by the offline synchronization job.', 'type' => 'string', 'required' => false, 'example' => 'S_res_group_222_333', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115***159376359\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'UpdateDataQualityTemplate', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", - ], - 'ListDataQualityTemplates' => [ - 'summary' => 'Queries the list of data quality rule templates in a project.', - 'path' => '', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdide3WJOKE', - ], - ], - 'parameters' => [ - [ - 'name' => 'Catalog', - 'in' => 'query', - 'schema' => [ - 'description' => 'The directory path to which the data quality template belongs.'."\n", - 'type' => 'string', 'required' => false, - 'example' => '/timeliness/ods_layer', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ProjectId', - 'in' => 'query', + 'name' => 'TransformationRules', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The project ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'A list of transformation rule definitions.'."\n" + ."\n" + .'> \\[ { "RuleName":"my\\_database\\_rename\\_rule", "RuleActionType":"Rename", "RuleTargetType":"Schema", "RuleExpression":"{"expression":"${srcDatasoureName}\\_${srcDatabaseName}"}" } ]', + 'type' => 'array', + 'items' => [ + 'description' => 'A single transformation rule definition.', + 'type' => 'object', + 'properties' => [ + 'RuleActionType' => ['description' => 'The type of the action. Valid values:'."\n" + ."\n" + .'- `DefinePrimaryKey`: Defines a primary key.'."\n" + ."\n" + .'- `Rename`: Renames an object.'."\n" + ."\n" + .'- `AddColumn`: Adds a column.'."\n" + ."\n" + .'- `HandleDml`: Handles DML operations.'."\n" + ."\n" + .'- `DefineIncrementalCondition`: Defines an incremental condition.'."\n" + ."\n" + .'- `DefineCycleScheduleSettings`: Defines periodic scheduling settings.'."\n" + ."\n" + .'- `DefinePartitionKey`: Defines a partition key.', 'type' => 'string', 'required' => false, 'example' => 'Rename', 'title' => ''], + 'RuleExpression' => ['description' => 'The rule expression, specified as a JSON string.'."\n" + ."\n" + .'1. Rename rule (`Rename`)'."\n" + ."\n" + .'- Example: `{"expression":"${srcDatasourceName}_${srcDatabaseName}_0922"}`'."\n" + ."\n" + .'- `expression`: The expression for the rename transformation rule. The expression supports variables, including `${srcDatasourceName}` (source data source name), `${srcDatabaseName}` (source database name), and `${srcTableName}` (source table name).'."\n" + ."\n" + .'2. Add column rule (`AddColumn`)'."\n" + ."\n" + .'- Example: `{"columns":[{"columnName":"my_add_column","columnValueType":"Constant","columnValue":"123"}]}`'."\n" + ."\n" + .'- If this rule is not specified, no columns are added.'."\n" + ."\n" + .'- `columnName`: The name of the column to add.'."\n" + ."\n" + .'- `columnValueType`: The value type of the added column. Valid values: `Constant` and `Variable`.'."\n" + ."\n" + .'- `columnValue`: The value of the added column. If `columnValueType` is `Constant`, the value is a custom constant of the string type. If `columnValueType` is `Variable`, the value is a built-in variable. Valid built-in variables: `EXECUTE_TIME` (execution time, Long type), `DB_NAME_SRC` (source database name, String type), `DATASOURCE_NAME_SRC` (source data source name, String type), `TABLE_NAME_SRC` (source table name, String type), `DB_NAME_DEST` (destination database name, String type), `DATASOURCE_NAME_DEST` (destination data source name, String type), `TABLE_NAME_DEST` (destination table name, String type), and `DB_NAME_SRC_TRANSED` (transformed database name, String type).'."\n" + ."\n" + .'3. Define primary key rule (`DefinePrimaryKey`)'."\n" + ."\n" + .'- Example: `{"columns":["ukcolumn1","ukcolumn2"]}`'."\n" + ."\n" + .'- If this rule is not specified, the primary key of the source is used by default.'."\n" + ."\n" + .'- Data Integration does not modify the structure of an existing destination table. If a specified primary key column does not exist in the table, the synchronization job fails.'."\n" + ."\n" + .'- When a destination table is automatically created, Data Integration includes the defined primary key columns in the structure. If a specified primary key column is not in the destination column set, the synchronization job fails.'."\n" + ."\n" + .'4. DML handling rule (`HandleDml`)'."\n" + ."\n" + .'- Example: `{"dmlPolicies":[{"dmlType":"Delete","dmlAction":"Filter","filterCondition":"id > 1"}]}`'."\n" + ."\n" + .'- If this rule is not specified, the default action for `Insert`, `Update`, and `Delete` operations is `Normal`.'."\n" + ."\n" + .'- `dmlType`: The DML operation type. Valid values: `Insert`, `Update`, and `Delete`.'."\n" + ."\n" + .'- `dmlAction`: The DML handling policy. Valid values: `Normal` (process the operation), `Ignore` (ignore the operation), `Filter` (conditionally process the operation, used when `dmlType` is `Update` or `Delete`), and `LogicalDelete` (perform a logical delete).'."\n" + ."\n" + .'- `filterCondition`: The DML filter condition, used when `dmlAction` is `Filter`.'."\n" + ."\n" + .'5. Incremental condition rule (`DefineIncrementalCondition`)'."\n" + ."\n" + .'- Example: `{"where":"id > 0"}`'."\n" + ."\n" + .'- The `WHERE` clause for the incremental condition.'."\n" + ."\n" + .'6. Periodic scheduling rule (`DefineCycleScheduleSettings`)'."\n" + ."\n" + .'- Example: `{"cronExpress":" * * * * * *", "cycleType":"1"}`'."\n" + ."\n" + .'- Specifies the scheduling parameters for a periodic job.'."\n" + ."\n" + .'7. Define partition key rule (`DefinePartitionKey`)'."\n" + ."\n" + .'- Example: `{"columns":["id"]}`'."\n" + ."\n" + .'- Specifies the partition key.', 'type' => 'string', 'required' => false, 'example' => '{"expression":"${srcDatasoureName}_${srcDatabaseName}"}', 'title' => ''], + 'RuleName' => ['description' => 'The name of the transformation rule. The name must be unique for a specific combination of `RuleActionType` and `RuleTargetType` and can be up to 50 characters long.', 'type' => 'string', 'required' => false, 'example' => 'rename_rule_1', 'title' => ''], + 'RuleTargetType' => ['description' => 'The type of the target object. Valid values:'."\n" + ."\n" + .'- `Table` (table)'."\n" + ."\n" + .'- `Schema` (schema)'."\n" + ."\n" + .'- `Database` (database)', 'type' => 'string', 'required' => false, 'example' => 'Table', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => '10000', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Name', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => 'Fuzzy match for the template rule name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'table_rows', - ], + 'schema' => ['description' => 'The ID of the DataWorks workspace. You can call the [ListProjects](~~178393~~) operation to get the workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'DIJobId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of records per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'This parameter is deprecated. Use the `Id` parameter instead.', 'type' => 'integer', 'format' => 'int64', 'deprecated' => true, 'required' => false, 'example' => '11588', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'Owner', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number of the results. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The owner of the synchronization job.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '95279527'], + ], + [ + 'name' => 'FileSpec', + 'in' => 'formData', + 'schema' => ['description' => 'The job configuration in script mode.', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "resourceSettings": {'."\n" + .' "realtimeResourceSettings": {'."\n" + .' "requestedCu": 2,'."\n" + .' "resourceGroupIdentifier": "Serverless_res_group_123_456"'."\n" + .' },'."\n" + .' "offlineResourceSettings": {'."\n" + .' "requestedCu": 2,'."\n" + .' "resourceGroupIdentifier": "Serverless_res_group_123_456"'."\n" + .' }'."\n" + .' },'."\n" + .' "tableMappings": ['."\n" + .' {'."\n" + .' "sourceObjectSelectionRules": ['."\n" + .' {'."\n" + .' "expression": "autotest_hologres",'."\n" + .' "action": "Include",'."\n" + .' "expressionType": "Exact",'."\n" + .' "objectType": "Datasource"'."\n" + .' },'."\n" + .' {'."\n" + .' "expression": "auto_holo_2661647",'."\n" + .' "action": "Include",'."\n" + .' "expressionType": "Exact",'."\n" + .' "objectType": "Table"'."\n" + .' },'."\n" + .' {'."\n" + .' "expression": "public",'."\n" + .' "action": "Include",'."\n" + .' "expressionType": "Exact",'."\n" + .' "objectType": "Schema"'."\n" + .' }'."\n" + .' ],'."\n" + .' "transformationRules": ['."\n" + .' {'."\n" + .' "ruleTargetType": "Table",'."\n" + .' "ruleActionType": "SourceSchema",'."\n" + .' "ruleName": "SourceSchema_Table_BStf8aXPSCJjOWGe"'."\n" + .' },'."\n" + .' {'."\n" + .' "ruleTargetType": "Schema",'."\n" + .' "ruleActionType": "Rename",'."\n" + .' "ruleName": "Rename_Schema_3qWNOIsljtInvKJy"'."\n" + .' },'."\n" + .' {'."\n" + .' "ruleTargetType": "Table",'."\n" + .' "ruleActionType": "Rename",'."\n" + .' "ruleName": "Rename_Table_o3PVQq1aIKDGoVVW"'."\n" + .' },'."\n" + .' {'."\n" + .' "ruleTargetType": "Table",'."\n" + .' "ruleActionType": "DefineDstTableSettings",'."\n" + .' "ruleName": "DefineDstTableSettings_Table_BhJltOmOCIc81fzi"'."\n" + .' },'."\n" + .' {'."\n" + .' "ruleTargetType": "Table",'."\n" + .' "ruleActionType": "ColumnMapping",'."\n" + .' "ruleName": "ColumnMapping_Table_nP4hJPX1wh2W3fpo"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' ],'."\n" + .' "sourceDataSourceSettings": ['."\n" + .' {'."\n" + .' "dataSourceProperties": {'."\n" + .' "timeZone": "Asia/Shanghai"'."\n" + .' },'."\n" + .' "dataSourceName": "autotest_hologres"'."\n" + .' }'."\n" + .' ],'."\n" + .' "jobSettings": {'."\n" + .' "runtimeSettings": ['."\n" + ."\n" + .' ],'."\n" + .' "ddlHandlingSettings": ['."\n" + ."\n" + .' ],'."\n" + .' "columnDataTypeSettings": ['."\n" + ."\n" + .' ],'."\n" + .' "cycleScheduleSettings": {'."\n" + ."\n" + .' },'."\n" + .' "channelSettings": {'."\n" + .' "destinationChannelSettings": {'."\n" + .' "conflictMode": "replace",'."\n" + .' "dynamicColumnAction": "replay",'."\n" + .' "writeMode": "replay"'."\n" + .' },'."\n" + .' "sourceChannelSettings": {'."\n" + ."\n" + .' }'."\n" + .' }'."\n" + .' },'."\n" + .' "destinationDataSourceType": "Hologres",'."\n" + .' "transformationRules": ['."\n" + .' {'."\n" + .' "ruleTargetType": "Table",'."\n" + .' "ruleName": "SourceSchema_Table_BStf8aXPSCJjOWGe",'."\n" + .' "ruleActionType": "SourceSchema",'."\n" + .' "ruleExpression": {'."\n" + .' "columns": ['."\n" + .' {'."\n" + .' "name": "id",'."\n" + .' "category": "normal",'."\n" + .' "type": "BIGINT"'."\n" + .' },'."\n" + .' {'."\n" + .' "name": "decimal",'."\n" + .' "category": "normal",'."\n" + .' "type": "DECIMAL"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' },'."\n" + .' {'."\n" + .' "ruleTargetType": "Schema",'."\n" + .' "ruleName": "Rename_Schema_3qWNOIsljtInvKJy",'."\n" + .' "ruleActionType": "Rename",'."\n" + .' "ruleExpression": {'."\n" + .' "expression": "public"'."\n" + .' }'."\n" + .' },'."\n" + .' {'."\n" + .' "ruleTargetType": "Table",'."\n" + .' "ruleName": "Rename_Table_o3PVQq1aIKDGoVVW",'."\n" + .' "ruleActionType": "Rename",'."\n" + .' "ruleExpression": {'."\n" + .' "expression": "auto_holo_2661647_dst"'."\n" + .' }'."\n" + .' },'."\n" + .' {'."\n" + .' "ruleTargetType": "Table",'."\n" + .' "ruleName": "DefineDstTableSettings_Table_BhJltOmOCIc81fzi",'."\n" + .' "ruleActionType": "DefineDstTableSettings",'."\n" + .' "ruleExpression": {'."\n" + .' "ddlString": "BEGIN;'."\n" + .'CREATE TABLE IF NOT EXISTS public.auto_holo_2661647_dst ('."\n" + .' id BIGINT PRIMARY KEY,'."\n" + .' "decimal" DECIMAL(38,18)'."\n" + .');'."\n" + .'CALL SET_TABLE_PROPERTY(\'public.auto_holo_2661647_dst\', \'time_to_live_in_seconds\', \'3153600000\');'."\n" + .'CALL SET_TABLE_PROPERTY(\'public.auto_holo_2661647_dst\', \'orientation\', \'column\');'."\n" + .'CALL SET_TABLE_PROPERTY(\'public.auto_holo_2661647_dst\', \'binlog.level\', \'replica\');'."\n" + .'CALL SET_TABLE_PROPERTY(\'public.auto_holo_2661647_dst\', \'binlog.ttl\', \'2592000\');'."\n" + .'CALL SET_TABLE_PROPERTY(\'public.auto_holo_2661647_dst\', \'bitmap_columns\', \'"text","char","varchar"\');'."\n" + .'CALL SET_TABLE_PROPERTY(\'public.auto_holo_2661647_dst\', \'dictionary_encoding_columns\', \'"text":auto,"bytea":auto,"char":auto,"varchar":auto\');'."\n" + .'CALL SET_TABLE_PROPERTY(\'public.auto_holo_2661647_dst\', \'distribution_key\', \'"id"\');'."\n" + .'COMMIT;'."\n" + .'",'."\n" + .' "ddlType": "STRUCT"'."\n" + .' }'."\n" + .' },'."\n" + .' {'."\n" + .' "ruleTargetType": "Table",'."\n" + .' "ruleName": "ColumnMapping_Table_nP4hJPX1wh2W3fpo",'."\n" + .' "ruleActionType": "ColumnMapping",'."\n" + .' "ruleExpression": {'."\n" + .' "columnMapping": ['."\n" + .' {'."\n" + .' "sourceColName": "id",'."\n" + .' "dstColName": "id"'."\n" + .' },'."\n" + .' {'."\n" + .' "sourceColName": "decimal",'."\n" + .' "dstColName": "decimal"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' }'."\n" + .' ],'."\n" + .' "migrationType": "FullAndRealtimeIncremental",'."\n" + .' "destinationDataSourceSettings": ['."\n" + .' {'."\n" + .' "dataSourceProperties": {'."\n" + ."\n" + .' },'."\n" + .' "dataSourceName": "autotest_hologres"'."\n" + .' }'."\n" + .' ],'."\n" + .' "sourceDataSourceType": "Hologres"'."\n" + .'}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The API request ID, which is generated as a UUID.'."\n", - 'type' => 'string', - 'example' => '0bc14115***159376359', - ], - 'PageInfo' => [ - 'description' => 'Paged query results of data quality rule templates.'."\n", - 'type' => 'object', - 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of records.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'PageSize' => [ - 'description' => 'The number of pages.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'DataQualityTemplates' => [ - 'description' => 'The list of rule templates.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The rule template.'."\n", - 'type' => 'object', - 'properties' => [ - 'ModifyTime' => [ - 'description' => 'The time when the data quality rule template was updated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1729816478147', - ], - 'Owner' => [ - 'description' => 'The owner of the data quality rule template.'."\n", - 'type' => 'string', - 'example' => '205250754596036836', - ], - 'ModifyUser' => [ - 'description' => 'The last updater of the data quality rule template.'."\n", - 'type' => 'string', - 'example' => '205250754596036836', - ], - 'CreateTime' => [ - 'description' => 'The time when the data quality rule template was created.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1729816478147', - ], - 'ProjectId' => [ - 'description' => 'The project ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '7635', - ], - 'CreateUser' => [ - 'description' => 'The creator of the data quality rule template.'."\n", - 'type' => 'string', - 'example' => '7892346529452', - ], - 'Id' => [ - 'description' => 'The ID of the data quality rule template.'."\n", - 'type' => 'string', - 'example' => '819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a', - ], - 'Spec' => [ - 'description' => 'Specific configurations of the data quality rule template. For more information, see [Data quality Spec configuration description](~2963394~).'."\n", - 'type' => 'string', - 'example' => '{'."\n" - .' "assertion": "anomaly detection fro id_not_null_cnt",'."\n" - .' "id_not_null_cnt": {'."\n" - .' "query": "SELECT COUNT(*) AS cnt FROM ${tableName} WHERE dt = \'$[yyyymmdd-1]\';"'."\n" - .' },'."\n" - .' "identity": "819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a"'."\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' => ''], + 'RequestId' => ['description' => 'The ID of the request. You can use this ID to troubleshoot issues.', 'type' => 'string', 'example' => 'AAC30B35-820D-5F3E-A42C-E96BB****', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115***159376359\\",\\n \\"PageInfo\\": {\\n \\"TotalCount\\": 10,\\n \\"PageSize\\": 20,\\n \\"PageNumber\\": 1,\\n \\"DataQualityTemplates\\": [\\n {\\n \\"ModifyTime\\": 1729816478147,\\n \\"Owner\\": \\"205250754596036836\\",\\n \\"ModifyUser\\": \\"205250754596036836\\",\\n \\"CreateTime\\": 1729816478147,\\n \\"ProjectId\\": 7635,\\n \\"CreateUser\\": \\"7892346529452\\",\\n \\"Id\\": \\"819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a\\",\\n \\"Spec\\": \\"{\\\\n \\\\\\"assertion\\\\\\": \\\\\\"anomaly detection fro id_not_null_cnt\\\\\\",\\\\n \\\\\\"id_not_null_cnt\\\\\\": {\\\\n \\\\\\"query\\\\\\": \\\\\\"SELECT COUNT(*) AS cnt FROM ${tableName} WHERE dt = \'$[yyyymmdd-1]\';\\\\\\"\\\\n },\\\\n \\\\\\"identity\\\\\\": \\\\\\"819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a\\\\\\"\\\\n}\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListDataQualityTemplates', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", - ], - 'GetDataQualityTemplate' => [ - 'summary' => 'Queries the details of a data quality rule template by ID.', - 'path' => '', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"AAC30B35-820D-5F3E-A42C-E96BB****\\"\\n}","type":"json"}]', + 'title' => 'UpdateDIJob', + 'description' => 'This feature requires DataWorks Basic Edition or higher.', + 'changeSet' => [ + ['createdAt' => '2025-01-06T05:34:16.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-12-11T02:02:33.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-10-14T09:34:05.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'UpdateDataAssetTag' => [ + 'summary' => 'Updates a tag.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdide3WJOKE', - ], + 'abilityTreeCode' => '250867', + 'abilityTreeNodes' => ['FEATUREdideKQ371B'], + 'autoTest' => true, ], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'Key', 'in' => 'query', - 'schema' => [ - 'description' => 'The data quality rule template ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'a7ef0634-20ec-4a7c-a214-54020f91XXXX', - ], + 'schema' => ['description' => 'The tag key.', 'type' => 'string', 'required' => true, 'maxLength' => 128, 'minLength' => 1, 'example' => 'key1', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'Values', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The API request ID, which is generated as a UUID.'."\n", - 'type' => 'string', - 'example' => '0bc14115***159376359', - ], - 'DataQualityTemplate' => [ - 'description' => 'The data quality rule template.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the data quality rule template.'."\n", - 'type' => 'string', - 'example' => '10001', - ], - 'ProjectId' => [ - 'description' => 'The project ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '97535', - ], - 'CreateTime' => [ - 'description' => 'The time when the data quality rule template was created.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1606724043000', - ], - 'ModifyTime' => [ - 'description' => 'The time when the data quality rule template was updated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1606724043000', - ], - 'CreateUser' => [ - 'description' => 'The creator of the data quality rule template.'."\n", - 'type' => 'string', - 'example' => '238428342865', - ], - 'ModifyUser' => [ - 'description' => 'The last updater of the data quality rule template.'."\n", - 'type' => 'string', - 'example' => '238428342865', - ], - 'Spec' => [ - 'description' => 'Specific configurations of the data quality rule template. For more information, see [Data quality Spec configuration description](~2963394~).'."\n", - 'type' => 'string', - 'example' => '{'."\n" - .' "assertion": "anomaly detection fro id_not_null_cnt",'."\n" - .' "id_not_null_cnt": {'."\n" - .' "query": "SELECT COUNT(*) AS cnt FROM ${tableName} WHERE dt = \'$[yyyymmdd-1]\';"'."\n" - .' },'."\n" - .' "identity": "819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a"'."\n" - .'}', - ], - 'Owner' => [ - 'description' => 'The owner of the data quality rule template.'."\n", - 'type' => 'string', - 'example' => '238428342865', - ], - ], - ], - ], + 'description' => 'The tag values.', + 'type' => 'array', + 'items' => ['description' => 'The tag value.', 'type' => 'string', 'maxLength' => 128, 'minLength' => 0, 'pattern' => '^([^\\x00-\\xff]|[\\w.,;/@\\n-])+$', 'required' => false, 'example' => 'v1', 'title' => ''], + 'required' => false, + 'maxItems' => 20, + 'minItems' => 0, + 'title' => '', + 'example' => '', ], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115***159376359\\",\\n \\"DataQualityTemplate\\": {\\n \\"Id\\": \\"10001\\",\\n \\"ProjectId\\": 97535,\\n \\"CreateTime\\": 1606724043000,\\n \\"ModifyTime\\": 1606724043000,\\n \\"CreateUser\\": \\"238428342865\\",\\n \\"ModifyUser\\": \\"238428342865\\",\\n \\"Spec\\": \\"{\\\\n \\\\\\"assertion\\\\\\": \\\\\\"anomaly detection fro id_not_null_cnt\\\\\\",\\\\n \\\\\\"id_not_null_cnt\\\\\\": {\\\\n \\\\\\"query\\\\\\": \\\\\\"SELECT COUNT(*) AS cnt FROM ${tableName} WHERE dt = \'$[yyyymmdd-1]\';\\\\\\"\\\\n },\\\\n \\\\\\"identity\\\\\\": \\\\\\"819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a\\\\\\"\\\\n}\\",\\n \\"Owner\\": \\"238428342865\\"\\n }\\n}","type":"json"}]', - 'title' => 'GetDataQualityTemplate', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", - ], - 'DeleteDataQualityTemplate' => [ - 'summary' => 'Deletes a data quality rule template by ID.', - 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdide3WJOKE', + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The description of the tag.', 'type' => 'string', 'maxLength' => 1024, 'minLength' => 0, 'required' => false, 'example' => 'This is a description.', 'title' => ''], ], - ], - 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'formData', + 'name' => 'Managers', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The ID of the custom rule template.'."\n", - 'type' => 'string', + 'description' => 'The tag administrators.', + 'type' => 'array', + 'items' => ['description' => 'The tag administrator.', 'type' => 'string', 'required' => false, 'example' => '12345', 'title' => ''], 'required' => false, - 'example' => 'USER_DEFINED:2001', + 'maxItems' => 20, + 'minItems' => 0, + 'title' => '', + 'example' => '', ], ], ], @@ -47936,45 +47636,36 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The API request ID, which is generated as a UUID.'."\n", - 'type' => 'string', - 'example' => '0bc14115****159376359', - ], - 'Success' => [ - 'description' => 'Deleted'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0bc1ec921****'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115****159376359\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'DeleteDataQualityTemplate', - 'description' => '## [](#)Request description'."\n" - ."\n" - .'* **Id**: the unique identifier of the user-defined rule template, in the format `USER_DEFINED:`.'."\n" - .'* **ProjectId**: The ID of the DataWorks project to which the rule template belongs.'."\n" - ."\n" - .'This API is used to remove data quality rule templates that are no longer needed from the system. Make sure the provided `Id` and `ProjectId` are correct when calling this API operation; otherwise, the deletion may fail or lead to unexpected data loss. Use this function with caution and verify the exact information of the template before performing the operation.'."\n", + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc1ec921****\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'UpdateDataAssetTag', + 'description' => 'This API operation is available only for DataWorks Enterprise Edition or a more advanced edition.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], ], - 'CreateDataQualityScan' => [ - 'summary' => 'Creates a data quality monitor.', + 'UpdateDataQualityAlertRule' => [ + 'summary' => 'Updates a specified data quality monitoring alert rule.', 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -47983,296 +47674,148 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdide3WJOKE', - ], + 'abilityTreeNodes' => ['FEATUREdide3WJOKE'], ], 'parameters' => [ [ - 'name' => 'Description', + 'name' => 'Id', 'in' => 'formData', - 'schema' => [ - 'description' => 'The description of the data quality monitor.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Daily data quality scanning of ods tables.', - ], + 'schema' => ['description' => 'The ID of the alert rule.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '105412', 'title' => ''], ], [ 'name' => 'ProjectId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The DataWorks workspace ID. You can log on to the DataWorks console and go to the workspace configuration page to obtain the workspace ID. This parameter is required to specify the target DataWorks workspace for this API operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '101', - ], - ], - [ - 'name' => 'Owner', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the user who owns of the data quality monitor.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '95279527****', - ], - ], - [ - 'name' => 'Spec', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Spec code for the content of the data quality monitoring.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "datasets": ['."\n" - .' {'."\n" - .' "type": "Table",'."\n" - .' "dataSource": {'."\n" - .' "name": "odps_first",'."\n" - .' "envType": "Prod"'."\n" - .' },'."\n" - .' "tables": ['."\n" - .' "ods_d_user_info"'."\n" - .' ],'."\n" - .' "filter": "pt = $[yyyymmdd-1]"'."\n" - .' }'."\n" - .' ],'."\n" - .' "rules": ['."\n" - .' {'."\n" - .' "assertion": "row_count > 0"'."\n" - .' }, {'."\n" - .' "templateId": "SYSTEM:field:null_value:fixed",'."\n" - .' "pass": "when = 0",'."\n" - .' "name": "The id cannot be empty.",'."\n" - .' "severity": "High",'."\n" - .' "identity": "a-customized-data-quality-rule-uuid"'."\n" - .' }'."\n" - .' ]'."\n" - .'}', - ], - ], - [ - 'name' => 'Parameters', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The definition of execution parameters for the data quality monitoring.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The definition of execution parameters for the data quality monitoring.'."\n", - 'type' => 'object', - 'properties' => [ - 'Value' => [ - 'description' => 'The parameter values.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '$[yyyymmdd-1]', - ], - 'Name' => [ - 'description' => 'The parameter name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'triggerTime', - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000', 'title' => ''], ], [ - 'name' => 'RuntimeResource', + 'name' => 'Condition', 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The resource group used during execution of the data quality monitoring.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The resource group ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0525242e-d0ee-4bda-bc73-765d82f6a34a', - ], - 'Cu' => [ - 'description' => 'The default number of CUs configured for task running.'."\n", - 'type' => 'number', - 'format' => 'float', - 'required' => false, - 'example' => '0.25', - ], - 'Image' => [ - 'description' => 'The ID of the image configured for task running.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'i-xxxxxx', - ], - ], - 'required' => false, - ], + 'schema' => ['description' => 'The alert condition of the data quality monitoring rule.', 'type' => 'string', 'required' => false, 'example' => 'results.any { r -> r.status == \'fail\' && r.rule.severity == \'High\' }', 'title' => ''], ], [ - 'name' => 'ComputeResource', + 'name' => 'Target', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'The compute engine used at runtime. If not specified, the data source defined in the Spec is used.'."\n", + 'description' => 'The monitored target of the data quality monitoring rule.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'The name of the compute engine, which is a unique identifier.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'emr_first', - ], - 'Runtime' => [ - 'description' => 'More settings for data quality monitoring at runtime.'."\n", - 'type' => 'object', - 'properties' => [ - 'Engine' => [ - 'description' => 'The type of the compute engine. Only EMR compute engines support these settings.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Hive: Hive SQL'."\n" - .'* Spark: Spark SQL'."\n" - .'* Kyuubi'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Hive', - ], - 'SparkConf' => [ - 'description' => 'Additional Spark engine parameters. Currently, only the spark.yarn.queue parameter is supported.'."\n", - 'type' => 'object', - 'required' => false, - 'example' => 'spark.yarn.queue=dq_queue', - ], - 'HiveConf' => [ - 'description' => 'Additional Hive engine parameters. Currently, only the mapreduce.job.queuename parameter is supported.'."\n", - 'type' => 'object', - 'required' => false, - 'example' => 'mapreduce.job.queuename=dq_queue', - ], - ], - 'required' => false, - ], - 'EnvType' => [ - 'description' => 'The workspace environment to which the compute engine belongs.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Prod: production environment .'."\n" - .'* Dev: development environment.'."\n", - 'type' => 'string', + 'Type' => ['description' => 'The type of the monitored target. Only DataQualityScan is supported.', 'type' => 'string', 'required' => false, 'example' => 'DataQualityScan', 'title' => ''], + 'Ids' => [ + 'description' => 'The list of monitored target IDs. Currently, only one ID can be set.', + 'type' => 'array', + 'items' => ['description' => 'The ID of the monitored target.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '7638999336', 'title' => ''], 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Dev', - 'enum' => [ - 'Prod', - 'Dev', - ], + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Trigger', + 'name' => 'Notification', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'The trigger configurations of the data quality monitoring task.'."\n", + 'description' => 'Alert notification configurations.', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => 'The trigger mode of the monitoring task.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* ByManual: Manual trigger. This is the default setting.'."\n" - .'* BySchedule: Triggered by a scheduled task instance.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'BySchedule', - ], - 'TaskIds' => [ - 'description' => 'If the trigger mode is set to BySchedule, the scheduling task ID must be specified.'."\n", + 'Channels' => [ + 'description' => 'The list of alert channels. You can set both Email and Sms at the same time. In other cases, only one channel can be set.', 'type' => 'array', 'items' => [ - 'description' => 'The ID of the scheduling task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1004979033', - ], - 'required' => false, - ], - ], - 'required' => false, - ], - ], - [ - 'name' => 'Hooks', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The Hook configurations after the data quality monitoring run ends.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The Hook configurations after the data quality monitoring run ends.'."\n", - 'type' => 'object', - 'properties' => [ - 'Condition' => [ - 'description' => 'The Hook trigger condition. The hook will run if the condition is met. Currently, only one type of expression syntax is supported:'."\n" + 'description' => 'Alert channels.'."\n" ."\n" - .'You can specify multiple combinations of rule severity levels and validation statuses using an expression such as `results.any { r -> r.status == \'Fail\' && r.rule.severity == \'Normal\' || r.status == \'Error\' && r.rule.severity == \'High\' || r.status == \'Warn\' && r.rule.severity == \'High\' }`. This expression means the condition is met if any executed rule has a result of Fail with severity Normal, Error with severity High, or Warn with severity High. In the condition expression, the values of severity and status are predefined enums. The values of severity must match those defined in the Spec, and the values of status must match those in DataQualityResult.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'results.any { r -> r.status == \'Fail\' && r.rule.severity == \'Normal\' || r.status == \'Error\' && r.rule.severity == \'High\' || r.status == \'Warn\' && r.rule.severity == \'High\' }', - ], - 'Type' => [ - 'description' => 'The type of the Hook.'."\n" + .'- Dingding'."\n" ."\n" - .'Valid values:'."\n" + .'- Weixin'."\n" + ."\n" + .'- Mail'."\n" + ."\n" + .'- Sms'."\n" + ."\n" + .'- Phone'."\n" + ."\n" + .'- Webhook'."\n" ."\n" - .'* BlockTaskInstance: Blocks the scheduling of the task instance.'."\n", + .'- Feishu', + 'enumValueTitles' => [], 'type' => 'string', + 'required' => true, + 'enum' => ['Dingding', 'Weixin', 'Mail', 'Sms', 'Phone', 'Webhook', 'Feishu'], + 'example' => 'Sms', + 'title' => '', + ], + 'required' => true, + 'title' => '', + 'example' => '', + ], + 'Receivers' => [ + 'description' => 'The alert recipients.', + 'type' => 'array', + 'items' => [ + 'description' => 'The alert recipients.', + 'type' => 'object', + 'properties' => [ + 'Extension' => ['description' => 'Additional configurations required for the alert recipients. When ReceiverType is DingdingUrl, you can set `{"atAll":true}` to mention all members.', 'type' => 'string', 'required' => false, 'example' => '{"atAll":true}'."\n", 'title' => ''], + 'ReceiverType' => [ + 'description' => 'The type of alert recipients.'."\n" + ."\n" + .'- AliUid'."\n" + ."\n" + .'- WebhookUrl'."\n" + ."\n" + .'- DingdingUrl'."\n" + ."\n" + .'- WeixinUrl'."\n" + ."\n" + .'- FeishuUrl'."\n" + ."\n" + .'- TaskOwner'."\n" + ."\n" + .'- DataQualityScanOwner'."\n" + ."\n" + .'- ShiftSchedule', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => true, + 'enum' => ['AliUid', 'WebhookUrl', 'DingdingUrl', 'WeixinUrl', 'FeishuUrl', 'TaskOwner', 'DataQualityScanOwner', 'ShiftSchedule'], + 'example' => 'TaskOwner', + 'title' => '', + ], + 'ReceiverValues' => [ + 'description' => 'The value of alert recipients.', + 'type' => 'array', + 'items' => ['description' => 'The value of alert recipients.'."\n" + ."\n" + .'- If ReceiverType is AliUid, enter the Alibaba Cloud account ID.'."\n" + ."\n" + .'- If ReceiverType is ShiftSchedule, enter the shift schedule ID.'."\n" + ."\n" + .'- If ReceiverType is WebhookUrl, DingdingUrl, FeishuUrl, or WeixinUrl, enter the corresponding URL.', 'type' => 'string', 'required' => false, 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=a30bae7******', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], 'required' => false, - 'enumValueTitles' => [], - 'example' => 'BlockTaskInstance', + 'title' => '', + 'example' => '', ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'required' => false, - ], - 'required' => false, - ], - ], - [ - 'name' => 'Name', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The data quality monitoring name.'."\n", - 'type' => 'string', + ], 'required' => false, - 'example' => 'data_quality_scan_001', - ], - ], - [ - 'name' => 'ClientToken', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The idempotency token.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'a-customized-uuid', + 'title' => '', + 'example' => '', ], ], ], @@ -48280,1086 +47823,1024 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'Id' => [ - 'description' => 'Returns the ID of the created data source sharing rule, which uniquely identifies the rule.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '676303114031776', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '0bc14115***159376359'], + 'Success' => ['description' => 'Indicates whether the alert rule was updated.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateDataQualityAlertRule', + 'description' => 'DataWorks Basic Edition or a higher edition is required.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"Id\\": 676303114031776\\n}","type":"json"}]', - 'title' => 'CreateDataQualityScan', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115***159376359\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], - 'UpdateDataQualityScan' => [ - 'summary' => 'Updates a data quality monitor.', - 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateDataQualityEvaluationTask' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'deprecated' => false, + 'deprecated' => true, 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdide3WJOKE', - ], + 'abilityTreeCode' => '250886', + 'abilityTreeNodes' => ['FEATUREdide3WJOKE'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'Description', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Description of the data quality monitor.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Daily data quality scanning of ods tables.', - ], - ], - [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the DataWorks workspace where the data quality monitor resides. You can obtain the workspace ID by calling the [ListProjects](~~2852607~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '101', - ], - ], - [ - 'name' => 'Id', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the data quality monitor.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10001', - ], - ], - [ - 'name' => 'Owner', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The user ID of the owner of the data quality monitor.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '231263586109857423', - ], - ], - [ - 'name' => 'Spec', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The Spec code of the data quality monitoring content. For more information, see [Data quality Spec configuration description](~~2963394~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "datasets": ['."\n" - .' {'."\n" - .' "type": "Table",'."\n" - .' "dataSource": {'."\n" - .' "name": "odps_first",'."\n" - .' "envType": "Prod"'."\n" - .' },'."\n" - .' "tables": ['."\n" - .' "ods_d_user_info"'."\n" - .' ],'."\n" - .' "filter": "pt = $[yyyymmdd-1]"'."\n" - .' }'."\n" - .' ],'."\n" - .' "rules": ['."\n" - .' {'."\n" - .' "assertion": "row_count > 0"'."\n" - .' }, {'."\n" - .' "templateId": "SYSTEM:field:null_value:fixed",'."\n" - .' "pass": "when = 0",'."\n" - .' "name": "The id cannot be empty.",'."\n" - .' "severity": "High",'."\n" - .' "identity": "a-customized-data-quality-rule-uuid"'."\n" - .' }'."\n" - .' ]'."\n" - .'}', - ], - ], - [ - 'name' => 'Parameters', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The definition of execution parameters for the data quality monitor.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The parameter information.'."\n", - 'type' => 'object', - 'properties' => [ - 'Value' => [ - 'description' => 'The parameter value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'smtp.qiye.aliyun.com', - ], - 'Name' => [ - 'description' => 'The parameter name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'temp_237669.zip_byBwm_1734661241752', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - [ - 'name' => 'RuntimeResource', + 'name' => 'Target', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'The resource group used during the execution of the data quality monitor.'."\n", + 'title' => '', + 'description' => 'Data quality monitoring object', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the resource group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '20315', - ], - 'Cu' => [ - 'description' => 'The default number of CUs configured for task running.'."\n", - 'type' => 'number', - 'format' => 'float', - 'required' => false, - 'example' => '0.25', - ], - 'Image' => [ - 'description' => 'The image ID of the task runtime configuration.'."\n", + 'DatabaseType' => [ + 'title' => '', + 'description' => 'Database type to which the table belongs'."\n" + .'- maxcompute'."\n" + .'- hologres'."\n" + .'- cdh'."\n" + .'- analyticdb_for_mysql'."\n" + .'- starrocks'."\n" + .'- emr'."\n" + .'- analyticdb_for_postgresql', + 'enumValueTitles' => [], 'type' => 'string', 'required' => false, - 'example' => 'i-xxxxxx', + 'example' => 'maxcompute', ], + 'TableGuid' => ['title' => '', 'description' => 'Unique ID of the table in Data Map', 'type' => 'string', 'required' => false, 'example' => 'odsp.openapi.ods_d_openapi_log'], + 'PartitionSpec' => ['title' => '', 'description' => 'Partition settings of the partitioned table', 'type' => 'string', 'maxLength' => 255, 'required' => false, 'example' => 'dt=$[yyyymmdd-1]'], ], 'required' => false, + 'example' => '', ], ], [ - 'name' => 'ComputeResource', + 'name' => 'Description', 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The compute engine used during execution. If it\'s not specified, the data source connection defined in the Spec will be used.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the compute engine, which is a unique identifier.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'auto_createAlertRule_Finished_1kUTk6', - ], - 'Runtime' => [ - 'description' => 'Additional settings for the compute engine.'."\n", - 'type' => 'object', - 'properties' => [ - 'Engine' => [ - 'description' => 'The engine type. These settings are only supported for the EMR compute engine.This setting? Valid values:'."\n" - ."\n" - .'* Hive: Hive SQL'."\n" - .'* Spark: Spark SQL'."\n" - .'* Kyuubi'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Hive', - ], - 'SparkConf' => [ - 'description' => 'Additional Spark engine parameters. Currently, only the spark.yarn.queue parameter is supported.'."\n", - 'type' => 'object', - 'required' => false, - 'example' => 'spark.yarn.queue=dq_queue', - ], - 'HiveConf' => [ - 'description' => 'Additional Hive engine parameters. Currently, only the mapreduce.job.queuename parameter is supported.'."\n", - 'type' => 'object', - 'required' => false, - 'example' => 'mapreduce.job.queuename=dq_queue', - ], - ], - 'required' => false, - ], - 'EnvType' => [ - 'description' => 'Workspace environment of the compute engine. Valid values:'."\n" - ."\n" - .'* Prod'."\n" - .'* Dev'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Prod', - 'enum' => [ - 'Prod', - 'Dev', - ], - ], - ], - 'required' => false, - ], + 'schema' => ['title' => '', 'description' => 'Description of the quality monitoring task', 'type' => 'string', 'maxLength' => 65535, 'required' => false, 'example' => 'OpenAPI data quality monitoring test.'], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Name of the quality monitoring task', 'type' => 'string', 'required' => false, 'maxLength' => 255, 'example' => 'OpenAPI data quality monitoring test.'], + ], + [ + 'name' => 'RuntimeConf', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Extended configuration. A JSON-formatted string. Takes effect only for EMR-type data quality monitoring.'."\n" + ."\n" + .'- queue: The YARN queue used when executing EMR data quality validation. Defaults to the queue configured for the current project.'."\n" + .'- sqlEngine: The SQL engine used when executing EMR data validation.'."\n" + .' + HIVE_SQL'."\n" + .' + SPARK_SQL', 'type' => 'string', 'required' => false, 'example' => '{ "queue": "default", "sqlEngine": "SPARK_SQL" }'], ], [ 'name' => 'Trigger', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'Trigger settings for the data quality monitor.'."\n", + 'title' => '', + 'description' => 'Trigger configuration of the data quality validation task', 'type' => 'object', 'properties' => [ 'Type' => [ - 'description' => 'The trigger mode of the data quality monitor. Valid values:'."\n" - ."\n" - .'* ByManual: Manually triggered. Default setting.'."\n" - .'* BySchedule: Triggered by a scheduled task instance.'."\n", + 'title' => '', + 'description' => 'Trigger type of the quality monitoring task.'."\n" + .'- ByScheduledTaskInstance: Triggered by an associated scheduling task.'."\n" + .'- ByManual: Triggered manually.', + 'enumValueTitles' => [], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [], - 'example' => 'BySchedule', + 'example' => 'ByScheduledTaskInstance', ], 'TaskIds' => [ - 'description' => 'If the trigger mode is BySchedule, the ID of the scheduling task that triggers the monitor must be configured.'."\n", + 'title' => '', + 'description' => 'List of scheduling task IDs. Valid when Type is ByScheduledTaskInstance.', 'type' => 'array', - 'items' => [ - 'description' => 'The scheduling task ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '30001', - ], + 'items' => ['description' => 'Scheduling task node ID', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1004979033', 'title' => ''], 'required' => false, + 'example' => '', ], ], 'required' => false, + 'example' => '', ], ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Workspace ID', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10000'], + ], [ 'name' => 'Hooks', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'The hook configuration after the data quality monitor stops.'."\n", + 'title' => '', + 'description' => 'Callback settings', 'type' => 'array', 'items' => [ - 'description' => 'The hook configuration after the data quality monitor stops.'."\n", 'type' => 'object', 'properties' => [ - 'Condition' => [ - 'description' => 'The hook trigger condition. When this condition is met, the hook is triggered. Valid expression format:'."\n" - ."\n" - .'Specifies multiple combinations of rule severity levels and rule validation statuses, such as `results.any { r -> r.status == \'Fail\' && r.rule.severity == \'Normal\' || r.status == \'Error\' && r.rule.severity == \'High\' || r.status == \'Warn\' && r.rule.severity == \'High\' }`. This means the hook is triggered if any executed rule has Fail with Normal severity, Error with High severity, or Warn with High severity. The severity values must match those defined in the Spec. The status values must match those in DataQualityResult.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'results.any { r -> r.status == \'Fail\' && r.rule.severity == \'Normal\' || r.status == \'Error\' && r.rule.severity == \'High\' || r.status == \'Warn\' && r.rule.severity == \'High\' }', - ], 'Type' => [ - 'description' => 'The type of the hook. Valid values:'."\n" + 'title' => '', + 'description' => 'Hook actions executed after data quality validation completes.'."\n" ."\n" - .'* BlockTaskInstance: Block the scheduling of the task instance.'."\n", + .'- BlockTaskInstance: Block the scheduling task.', + 'enumValueTitles' => [], 'type' => 'string', 'required' => false, - 'enumValueTitles' => [], - 'example' => 'BlockTaskInstance', - 'enum' => [ - 'BlockTaskInstance', - ], + 'example' => 'ByScheduledTaskInstance', ], + 'Condition' => ['title' => '', 'description' => 'Hook trigger condition. When this condition is met, the hook action is triggered. Currently, only two types of condition expressions are supported:'."\n" + ."\n" + .'- Specify a single group of rule severity type and rule validation status, such as `${severity} == "High" AND ${status} == "Critical"`. This means the condition is met when any executed rule with severity High has a validation result of Critical.'."\n" + .'- Specify multiple groups of rule severity type and rule validation status, such as `(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")`. This means the condition is met when any executed rule satisfies one of the following: severity High with validation result Critical, severity Normal with validation result Critical, or severity Normal with validation result Error. The severity enum in the condition expression is consistent with the severity enum in DataQualityRule, and the status enum is consistent with the status in DataQualityResult.', 'type' => 'string', 'required' => false, 'example' => '${severity} == "High" AND ${status} == "Critical"'], ], 'required' => false, + 'description' => 'Hook', + 'title' => '', + 'example' => '', ], 'required' => false, + 'example' => '', ], ], [ - 'name' => 'Name', + 'name' => 'Notifications', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The name of the data quality monitor.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'data_quality_scan_001', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Notification subscription configuration', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '22C97E95-F023-56B5-8852-B1A77A1****', - ], - 'Success' => [ - 'description' => 'Indicates whether the call was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Condition' => ['title' => '', 'description' => 'Notification trigger condition. When this condition is met, a message notification is triggered. Currently, only two types of condition expressions are supported:'."\n" + ."\n" + .'- Specify a single group of rule severity type and rule validation status, such as `${severity} == "High" AND ${status} == "Critical"`. This means the condition is met when any executed rule with severity High has a validation result of Critical.'."\n" + .'- Specify multiple groups of rule severity type and rule validation status, such as `(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")`. This means the condition is met when any executed rule satisfies one of the following: severity High with validation result Critical, severity Normal with validation result Critical, or severity Normal with validation result Error. The severity enum in the condition expression is consistent with the severity enum in DataQualityRule, and the status enum is consistent with the status in DataQualityResult.', 'type' => 'string', 'required' => false, 'example' => '${severity} == "High" AND ${status} == "Critical"'], + 'Notifications' => [ + 'title' => '', + 'description' => 'Notification settings', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NotificationReceivers' => [ + 'title' => '', + 'description' => 'Alert recipient settings', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ReceiverType' => [ + 'title' => '', + 'description' => 'Alert recipient type', + 'enumValueTitles' => ['WebhookUrl' => 'Custom Webhook URL', 'FeishuUrl' => 'Lark notification URL', 'DingdingUrl' => 'DingTalk group robot URL', 'WeixinUrl' => 'WeChat notification URL', 'AliUid' => 'Alibaba Cloud user ID'], + 'type' => 'string', + 'required' => false, + 'example' => 'DingdingUrl', + ], + 'Extension' => [ + 'title' => '', + 'description' => 'Additional parameter settings when sending alerts. JSON format. The supported keys are as follows:'."\n" + ."\n" + .'- atAll: Whether to @all members in the group when sending DingTalk alerts. Takes effect when ReceiverType is DingdingUrl.', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'example' => '{ "atAll": true }'."\n", + ], + 'ReceiverValues' => [ + 'title' => '', + 'description' => 'Alert recipients', + 'type' => 'array', + 'items' => ['description' => 'Recipient value.'."\n" + ."\n" + .'- When the recipient type is Alibaba Cloud ID, the recipient value is the specific Alibaba Cloud user ID.'."\n" + .'- When the recipient type is DingdingUrl, the recipient value is the specific alert URL of the DingTalk robot.'."\n" + .'- When the recipient type is WeixinUrl, the recipient value is the specific alert URL of WeCom (Enterprise WeChat).'."\n" + .'- When the recipient type is FeishuUrl, the recipient value is the specific alert URL of Lark.'."\n" + .'- When the recipient type is WebhookUrl, the recipient value is the specific custom Webhook alert URL.', 'type' => 'string', 'maxLength' => 255, 'required' => false, 'example' => 'https://api.fc.aliyuncs.com/webhook', 'title' => ''], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'description' => 'Alert recipient settings', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + 'NotificationChannels' => [ + 'title' => '', + 'description' => 'Notification method', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Channels' => [ + 'title' => '', + 'description' => 'Notification method', + 'type' => 'array', + 'items' => [ + 'description' => 'Notification method'."\n" + ."\n" + .'- Dingding: DingTalk group robot'."\n" + .'- Mail: Email'."\n" + .'- Weixin: WeChat notification'."\n" + .'- Feishu: Lark notification'."\n" + .'- Phone: Phone call'."\n" + .'- Sms: SMS'."\n" + .'- Webhook: Custom Webhook', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'example' => 'Mail', + 'title' => '', + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'description' => 'Notification method', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', + ], + ], + 'required' => false, + 'description' => 'Notification settings', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'example' => '', ], ], - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A1****\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'UpdateDataQualityScan', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", - ], - 'ListDataQualityScans' => [ - 'summary' => 'Queries the list of data quality scan tasks in a project.', - 'path' => '', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdide3WJOKE', - ], - ], - 'parameters' => [ - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => 'The data quality scan task name for fuzzy match.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - ], - [ - 'name' => 'SortBy', - 'in' => 'query', - 'schema' => [ - 'description' => 'The list of sorting fields. Supports fields such as last modified time and creation time. Format: "SortField+SortOrder (Desc/Asc)", where Asc is the default. Valid values:'."\n" - ."\n" - .'* ModifyTime (Desc/Asc)'."\n" - .'* CreateTime (Desc/Asc)'."\n" - .'* Id (Desc/Asc)'."\n", - 'type' => 'string', 'required' => false, - 'enumValueTitles' => [], - 'example' => 'ModifyTime Desc', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '10', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '200', - 'minimum' => '1', - 'example' => '1', + 'example' => '', ], ], [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The project ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10000', - ], + 'name' => 'DataSourceId', + 'in' => 'formData', + 'schema' => ['description' => 'Data source ID. You can call [ListDataSources](~~211431~~) to obtain the data source ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '358750', 'title' => ''], ], [ - 'name' => 'Table', - 'in' => 'query', - 'schema' => [ - 'description' => 'Fuzzy match for the monitored table name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'video_album', - ], - ], - ], - 'responses' => [ - 200 => [ + 'name' => 'DataQualityRules', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The API request ID, which is generated as a UUID.'."\n", - 'type' => 'string', - 'example' => '0bc14115***159376359', - ], - 'PageInfo' => [ - 'description' => 'The page information.'."\n", - 'type' => 'object', - 'properties' => [ - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of records per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of records returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + 'description' => 'List of data quality rules associated with the data quality monitoring.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'Name of the data quality rule.', 'type' => 'string', 'maxLength' => 255, 'required' => false, 'example' => 'OpenAPI test rules', 'title' => ''], + 'Enabled' => ['description' => 'Whether the data quality rule is enabled.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'Severity' => [ + 'description' => 'Severity level of the rule for the business (corresponds to strong/weak rules on the page). Optional enum values:'."\n" + .'- Normal'."\n" + .'- High', + 'enumValueTitles' => [], + 'type' => 'string', + 'enum' => ['High', 'Normal'], + 'required' => false, + 'example' => 'Normal', + 'title' => '', + ], + 'Description' => ['description' => 'Description of the data quality rule.', 'type' => 'string', 'maxLength' => 500, 'required' => false, 'example' => 'OpenAPI test rules', 'title' => ''], + 'TemplateCode' => ['description' => 'Unique identifier of the rule template referenced by the rule.', 'type' => 'string', 'required' => false, 'example' => 'SYSTEM:field:null_value:fixed:0', 'title' => ''], + 'SamplingConfig' => [ + 'description' => 'Parameters required for sample collection', + 'type' => 'object', + 'properties' => [ + 'Metric' => [ + 'description' => 'Name of the sampling metric'."\n" + .'- Count: Number of rows in the table'."\n" + .'- Min: Minimum value of the field'."\n" + .'- Max: Maximum value of the field'."\n" + .'- Avg: Average value of the field'."\n" + .'- DistinctCount: Number of distinct values of the field'."\n" + .'- DistinctPercent: Ratio of the number of distinct field values to the total number of rows'."\n" + .'- DuplicatedCount: Number of duplicate values of the field'."\n" + .'- DuplicatedPercent: Ratio of the number of duplicate field values to the total number of rows'."\n" + .'- TableSize: Size of the table'."\n" + .'- NullValueCount: Number of rows where the field is null'."\n" + .'- NullValuePercent: Proportion of rows where the field is null'."\n" + .'- GroupCount: After aggregating by field value, each value and its corresponding number of rows'."\n" + .'- CountNotIn: Number of rows whose enum values do not match'."\n" + .'- CountDistinctNotIn: Number of distinct values whose enum values do not match'."\n" + .'- UserDefinedSql: Sample collection via custom SQL', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'example' => 'CountNotIn', + 'title' => '', + ], + 'MetricParameters' => ['description' => 'Parameters required for sample collection', 'type' => 'string', 'required' => false, 'example' => '{ "Columns": [ "id", "name" ] , "SQL": "select count(1) from table;"}', 'title' => ''], + 'SettingConfig' => ['description' => 'Runtime parameter setting statements to be inserted and executed before the actual sampling statement. Maximum 1000 characters. Currently only MaxCompute is supported.', 'type' => 'string', 'maxLength' => 1000, 'required' => false, 'example' => 'odps.sql.type.system.odps2=True,odps.sql.hive.compatible=True', 'title' => ''], + 'SamplingFilter' => ['description' => 'Conditions for further filtering of data not of concern during sampling. Maximum 16777215 characters.', 'type' => 'string', 'required' => false, 'example' => 'status != \'Succeeded\''."\n", 'title' => ''], ], - 'DataQualityScans' => [ - 'description' => 'The list of data quality monitors.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Information about the data quality monitor.'."\n", + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'CheckingConfig' => [ + 'description' => 'Sample validation settings', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'Threshold calculation method'."\n" + ."\n" + .'- Fluctation: Fluctuation range validation'."\n" + .'- Auto: Intelligent threshold validation'."\n" + .'- FluctationDiscreate: Discrete value fluctuation range validation'."\n" + .'- Average: Mean fluctuation range validation'."\n" + .'- Fixed: Fixed value validation', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'example' => 'Fixed', + 'title' => '', + ], + 'ReferencedSamplesFilter' => ['description' => 'Some threshold types require querying reference samples and then aggregating their values to derive the comparison threshold. An expression is used here to indicate how the reference samples are queried.', 'type' => 'string', 'required' => false, 'example' => '{"bizdate": ["-1"]}'."\n", 'title' => ''], + 'Thresholds' => [ + 'description' => 'Validation threshold settings.', 'type' => 'object', 'properties' => [ - 'ModifyTime' => [ - 'description' => 'Last update time of the data quality monitor.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '17236236472', - ], - 'Owner' => [ - 'description' => 'The user ID of the owner responsible for the data quality monitor.'."\n", - 'type' => 'string', - 'example' => '23782382795249', - ], - 'Description' => [ - 'description' => 'The description of the data quality scan task. Maximum length: 65,535 characters.'."\n", - 'type' => 'string', - 'example' => 'This is a hourly run data quality evaluation plan.', - ], - 'ModifyUser' => [ - 'description' => 'The user ID of the last person who updated the data quality monitor.'."\n", - 'type' => 'string', - 'example' => '23782382795249', - ], - 'Parameters' => [ - 'description' => 'Execution parameter definitions for the data quality monitor.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Execution parameter definitions for the data quality monitor.'."\n", - 'type' => 'object', - 'properties' => [ - 'Value' => [ - 'description' => 'The parameter value.'."\n", - 'type' => 'string', - 'example' => '$[yyyy-mm-dd-1]', - ], - 'Name' => [ - 'description' => 'The parameter name.'."\n", - 'type' => 'string', - 'example' => 'dt', - ], - ], - ], - ], - 'CreateTime' => [ - 'description' => 'The creation time of the data quality monitor.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1694512304000', - ], - 'ProjectId' => [ - 'description' => 'The project ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '59094', - ], - 'CreateUser' => [ - 'description' => 'The creator of the data quality monitor.'."\n", - 'type' => 'string', - 'example' => '7892346529452', - ], - 'ComputeResource' => [ - 'description' => 'The compute engine used during execution. If it is not specified, the data source connection defined in the Spec will be used.'."\n", + 'Expected' => [ + 'description' => 'Expected threshold settings', 'type' => 'object', 'properties' => [ - 'Runtime' => [ - 'description' => 'Additional runtime settings for the data quality monitor.'."\n", - 'type' => 'object', - 'properties' => [ - 'HiveConf' => [ - 'description' => 'Additional parameters for the Hive engine. Currently, only mapreduce.job.queuename is supported to set the queue.'."\n", - 'type' => 'string', - 'example' => 'mapreduce.job.queuename=dq_queue', - ], - 'SparkConf' => [ - 'description' => 'Additional parameters for the Spark engine. Currently, only spark.yarn.queue is supported to set the queue.'."\n", - 'type' => 'string', - 'example' => 'spark.yarn.queue=dq_queue', - ], - 'Engine' => [ - 'description' => 'The engine type. These settings are only supported for the EMR compute engine. Valid values:'."\n" - ."\n" - .'* Hive: Hive SQL'."\n" - .'* Spark: Spark SQL'."\n" - .'* Kyuubi'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Hive', - ], - ], - ], - 'EnvType' => [ - 'description' => 'Workspace environment of the compute engine. Valid values:'."\n" - ."\n" - .'* Prod'."\n" - .'* Dev'."\n", - 'type' => 'string', + 'Operator' => [ + 'description' => 'Comparison operator'."\n" + .'- \\>'."\n" + .'- \\>='."\n" + .'- <'."\n" + .'- <='."\n" + .'- !='."\n" + .'- =', 'enumValueTitles' => [], - 'example' => 'Prod', - ], - 'Name' => [ - 'description' => 'The name of the computing engine. Uniquely identifies the engine.'."\n", - 'type' => 'string', - 'example' => 'emr_cluster_001', - ], - ], - ], - 'Name' => [ - 'description' => 'The name of the data quality scan task. Can include digits, letters, Chinese characters, and both half-width and full-width punctuation marks. Maximum length: 255 characters.'."\n", - 'type' => 'string', - 'example' => 'Hourly partition quality monitoring', - ], - 'RuntimeResource' => [ - 'description' => 'The resource group used during the execution of the data quality monitor.'."\n", - 'type' => 'object', - 'properties' => [ - 'Cu' => [ - 'description' => 'CU consumption for task running.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0.25', - ], - 'Id' => [ - 'description' => 'The ID of the resource group.'."\n", - 'type' => 'string', - 'example' => 'Serverless_resource_group_xxxxx', - ], - 'Image' => [ - 'description' => 'The ID of the image configured for task running.'."\n", 'type' => 'string', - 'example' => 'i-xxxxx', + 'required' => false, + 'example' => '=', + 'title' => '', ], + 'Value' => ['description' => 'Threshold value', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], + 'Expression' => ['description' => 'Threshold expression.'."\n" + ."\n" + .'Fluctuation-type rules must use an expression to represent the fluctuation threshold. For example:'."\n" + ."\n" + .'- Fluctuation rises above 0.01: $checkValue > 0.01'."\n" + .'- Fluctuation drops below 0.01: $checkValue < -0.01'."\n" + .'- Absolute fluctuation rate: abs($checkValue) > 0.01'."\n" + ."\n" + .'Fixed-value-type rules can also use an expression to configure the threshold. If both are configured, the expression takes precedence over Operator and Value.', 'type' => 'string', 'required' => false, 'example' => '$checkValue > 0.01', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'Trigger' => [ - 'description' => 'Trigger settings for the data quality monitor.'."\n", + 'Warned' => [ + 'description' => 'Threshold settings for normal warnings', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => 'The trigger mode of the data quality monitor. Valid values:'."\n" - ."\n" - .'* ByManual: Manually triggered. Default setting.'."\n" - .'* BySchedule: Triggered by a scheduled task instance.'."\n", - 'type' => 'string', + 'Operator' => [ + 'description' => 'Comparison operator'."\n" + .'- \\>'."\n" + .'- \\>='."\n" + .'- \\<'."\n" + .'- \\<='."\n" + .'- !='."\n" + .'- =', 'enumValueTitles' => [], - 'example' => 'BySchedule', - ], - 'TaskIds' => [ - 'description' => 'If the trigger mode is BySchedule, the ID of the scheduling task that triggers the monitor must be configured.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The scheduling task ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1023777390', - ], - ], - ], - ], - 'Hooks' => [ - 'description' => 'The hook configuration after the data quality monitor stops.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The hook configuration after the data quality monitor stops.'."\n", - 'type' => 'object', - 'properties' => [ - 'Condition' => [ - 'description' => 'The hook trigger condition. When this condition is met, the hook is triggered. Valid expression format:'."\n" - ."\n" - .'Specifies multiple combinations of rule severity levels and rule validation statuses, such as `results.any { r -> r.status == \'Fail\' && r.rule.severity == \'Normal\' || r.status == \'Error\' && r.rule.severity == \'High\' || r.status == \'Warn\' && r.rule.severity == \'High\' }`. This means the hook is triggered if any executed rule has Fail with Normal severity, Error with High severity, or Warn with High severity. The severity values must match those defined in the Spec. The status values must match those in DataQualityResult.'."\n", - 'type' => 'string', - 'example' => 'results.any { r -> r.status == \'Fail\' && r.rule.severity == \'Normal\' || r.status == \'Error\' && r.rule.severity == \'High\' || r.status == \'Warn\' && r.rule.severity == \'High\' }', - ], - 'Type' => [ - 'description' => 'The type of the hook. Valid values:'."\n" - ."\n" - .'* BlockTaskInstance: Blocks the scheduling of the task instance.'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'BlockTaskInstance', - ], + 'type' => 'string', + 'required' => false, + 'example' => '>', + 'title' => '', ], + 'Value' => ['description' => 'Threshold value', 'type' => 'string', 'required' => false, 'example' => '0.001', 'title' => ''], + 'Expression' => ['description' => 'Threshold expression.'."\n" + ."\n" + .'Fluctuation-type rules must use an expression to represent the fluctuation threshold. For example:'."\n" + ."\n" + .'- Fluctuation rises above 0.01: $checkValue > 0.01'."\n" + .'- Fluctuation drops below 0.01: $checkValue < -0.01'."\n" + .'- Absolute fluctuation rate: abs($checkValue) > 0.01'."\n" + ."\n" + .'Fixed-value-type rules can also use an expression to configure the threshold. If both are configured, the expression takes precedence over Operator and Value.', 'type' => 'string', 'required' => false, 'example' => '$checkValue > 0.01', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'Id' => [ - 'description' => 'The ID of the data quality monitor.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '26433', + 'Critical' => [ + 'description' => 'Threshold settings for critical warnings', + 'type' => 'object', + 'properties' => [ + 'Operator' => [ + 'description' => 'Comparison operator'."\n" + .'- \\>'."\n" + .'- \\>='."\n" + .'- <'."\n" + .'- <='."\n" + .'- !='."\n" + .'- =', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'example' => '>', + 'title' => '', + ], + 'Value' => ['description' => 'Threshold value.', 'type' => 'string', 'required' => false, 'example' => '0.01', 'title' => ''], + 'Expression' => ['description' => 'Threshold expression.'."\n" + ."\n" + .'Fluctuation-type rules must use an expression to represent the fluctuation threshold. For example:'."\n" + ."\n" + .'- Fluctuation rises above 0.01: $checkValue > 0.01'."\n" + .'- Fluctuation drops below 0.01: $checkValue < -0.01'."\n" + .'- Absolute fluctuation rate: abs($checkValue) > 0.01'."\n" + ."\n" + .'Fixed-value-type rules can also use an expression to configure the threshold. If both are configured, the expression takes precedence over Operator and Value.', 'type' => 'string', 'required' => false, 'example' => '$checkValue > 0.01', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'ErrorHandlers' => [ + 'description' => 'Quality rule validation issue handler', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'Handler type:'."\n" + ."\n" + .'- SaveErrorData: Retain problematic data', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'example' => 'SaveErrorData', + 'title' => '', + ], + 'ErrorDataFilter' => ['description' => 'For custom SQL rules, the user must specify the SQL to filter problematic data.', 'type' => 'string', 'required' => false, 'example' => 'SELECT * FROM ods_d_openapi_log WHERE status = \'Error\'', 'title' => ''], ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], + 'required' => false, + 'title' => '', + 'example' => '', ], + 'Id' => ['description' => 'ID of the validation rule. You can call the [ListQualityRules](~~173995~~) operation to obtain the rule ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1022171560', 'title' => ''], ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => 'Data quality monitoring ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '7227061794', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'Request ID. Used to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => '8abcb91f-d266-4073-b907-2ed670378ed1', 'title' => ''], ], + 'example' => '', ], ], ], 'staticInfo' => [ - 'returnType' => 'synchronous', + 'substitutions' => ['dataworks-public::2024-05-18::UpdateDataQualityScan'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115***159376359\\",\\n \\"PageInfo\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 1,\\n \\"DataQualityScans\\": [\\n {\\n \\"ModifyTime\\": 17236236472,\\n \\"Owner\\": \\"23782382795249\\",\\n \\"Description\\": \\"This is a hourly run data quality evaluation plan.\\",\\n \\"ModifyUser\\": \\"23782382795249\\",\\n \\"Parameters\\": [\\n {\\n \\"Value\\": \\"$[yyyy-mm-dd-1]\\",\\n \\"Name\\": \\"dt\\"\\n }\\n ],\\n \\"CreateTime\\": 1694512304000,\\n \\"ProjectId\\": 59094,\\n \\"CreateUser\\": \\"7892346529452\\",\\n \\"ComputeResource\\": {\\n \\"Runtime\\": {\\n \\"HiveConf\\": \\"mapreduce.job.queuename=dq_queue\\",\\n \\"SparkConf\\": \\"spark.yarn.queue=dq_queue\\",\\n \\"Engine\\": \\"Hive\\"\\n },\\n \\"EnvType\\": \\"Prod\\",\\n \\"Name\\": \\"emr_cluster_001\\"\\n },\\n \\"Name\\": \\"Hourly partition quality monitoring\\",\\n \\"RuntimeResource\\": {\\n \\"Cu\\": 0.25,\\n \\"Id\\": \\"Serverless_resource_group_xxxxx\\",\\n \\"Image\\": \\"i-xxxxx\\"\\n },\\n \\"Trigger\\": {\\n \\"Type\\": \\"BySchedule\\",\\n \\"TaskIds\\": [\\n 1023777390\\n ]\\n },\\n \\"Hooks\\": [\\n {\\n \\"Condition\\": \\"results.any { r -> r.status == \'Fail\' && r.rule.severity == \'Normal\' || r.status == \'Error\' && r.rule.severity == \'High\' || r.status == \'Warn\' && r.rule.severity == \'High\' }\\",\\n \\"Type\\": \\"BlockTaskInstance\\"\\n }\\n ],\\n \\"Id\\": 26433\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListDataQualityScans', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", - ], - 'GetDataQualityScan' => [ - 'summary' => 'Gets data quality monitoring details.', - 'path' => '', - 'methods' => [ - 'post', + 'title' => 'Update data quality monitoring', + 'summary' => 'Updates a data quality validation task.', + 'description' => 'DataWorks Basic Edition or above must be purchased to use this operation.', + 'changeSet' => [ + ['createdAt' => '2025-01-15T08:29:26.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-12-23T06:29:09.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"8abcb91f-d266-4073-b907-2ed670378ed1\\"\\n}","type":"json"}]', + ], + 'UpdateDataQualityRule' => [ + 'summary' => 'Updates a data quality rule.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, + 'operationType' => 'write', + 'deprecated' => true, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdide3WJOKE', - ], + 'abilityTreeCode' => '247829', + 'abilityTreeNodes' => ['FEATUREdide3WJOKE'], ], 'parameters' => [ [ 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => 'The rule ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '100001', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['description' => 'The rule name. The name can be a combination of digits, English letters, Chinese characters, and half-width or full-width punctuation. The maximum length is 255 characters.', 'type' => 'string', 'maxLength' => 255, 'required' => false, 'example' => 'The table cannot be empty.', 'title' => ''], + ], + [ + 'name' => 'Enabled', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether the rule is enabled.', 'type' => 'boolean', 'default' => 'true', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'Severity', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The severity level of the rule for the business (corresponding to strong/weak rules on the page). Valid values:'."\n" + .'- Normal'."\n" + .'- High', + 'enumValueTitles' => [], + 'type' => 'string', + 'enum' => ['High', 'Normal'], + 'required' => false, + 'example' => 'High', + 'title' => '', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['description' => 'The rule description. The maximum length is 500 characters.', 'type' => 'string', 'maxLength' => 500, 'required' => false, 'example' => 'this is a odps _sql task'."\n", 'title' => ''], + ], + [ + '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 Settings page to obtain the workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10000', 'title' => ''], + ], + [ + 'name' => 'TemplateCode', + 'in' => 'formData', + 'schema' => ['description' => 'The unique identifier of the rule template referenced by the rule.', 'type' => 'string', 'required' => false, 'example' => 'SYSTEM:table:table_count:fixed', 'title' => ''], + ], + [ + 'name' => 'SamplingConfig', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The ID of the monitor.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The settings required for sample collection.', + 'type' => 'object', + 'properties' => [ + 'Metric' => ['description' => 'The name of the metric to sample. This parameter is not required when a template is used.'."\n" + .'- Count: the number of rows in the table.'."\n" + .'- Min: the minimum value of the field.'."\n" + .'- Max: the maximum value of the field.'."\n" + .'- Avg: the average value of the field.'."\n" + .'- DistinctCount: the number of distinct values in the field.'."\n" + .'- DistinctPercent: the ratio of the number of distinct values in the field to the total number of rows.'."\n" + .'- DuplicatedCount: the number of duplicate values in the field.'."\n" + .'- DuplicatedPercent: the ratio of the number of duplicate values in the field to the total number of rows.'."\n" + .'- TableSize: the size of the table.'."\n" + .'- NullValueCount: the number of rows in which the field is null.'."\n" + .'- NullValuePercent: the percentage of rows in which the field is null.'."\n" + .'- GroupCount: the number of data rows for each value after aggregation by field value.'."\n" + .'- CountNotIn: the number of rows that do not match the enumerated values.'."\n" + .'- CountDistinctNotIn: the number of distinct values that do not match the enumerated values.'."\n" + .'- UserDefinedSql: sample collection by using custom SQL.', 'type' => 'string', 'required' => false, 'example' => 'Min', 'title' => ''], + 'MetricParameters' => ['description' => 'The parameters required for sample collection.', 'type' => 'string', 'required' => false, 'example' => '{ "Columns": [ "id", "name" ] , "SQL": "select count(1) from table;"}', 'title' => ''], + 'SettingConfig' => ['description' => 'The runtime parameter setting statements to be inserted and executed before the actual sampling statements. The maximum length is 1,000 characters. Only MaxCompute is supported.', 'type' => 'string', 'maxLength' => 1000, 'required' => false, 'example' => 'SET odps.sql.udf.timeout=600s; '."\n" + .'SET odps.sql.python.version=cp27;', 'title' => ''], + 'SamplingFilter' => ['description' => 'The condition used to apply secondary filtering on data that is not of interest during sampling. The maximum length is 16,777,215 characters.', 'type' => 'string', 'required' => false, 'example' => 'id IS NULL'."\n", 'title' => ''], + ], 'required' => false, - 'example' => '10001', + 'title' => '', + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'CheckingConfig', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The sample verification settings.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => '204EAF68-CCE3-5112-8DA0-E7A60F02XXXX', - ], - 'DataQualityScan' => [ - 'description' => 'Data quality monitoring details.'."\n", + 'Type' => ['description' => 'The threshold calculation method. This parameter is not required when a template is used.'."\n" + .'- Fixed'."\n" + .'- Fluctation'."\n" + .'- FluctationDiscreate'."\n" + .'- Auto'."\n" + .'- Average'."\n" + .'- Variance', 'type' => 'string', 'required' => false, 'example' => 'Fixed', 'title' => ''], + 'ReferencedSamplesFilter' => ['description' => 'Some types of thresholds require querying reference samples and then aggregating the values of those reference samples to derive the threshold used for comparison. An expression is used here to indicate how the reference samples are queried.', 'type' => 'string', 'required' => false, 'example' => '{ "bizdate": [ "-1", "-7", "-1m" ] }'."\n", 'title' => ''], + 'Thresholds' => [ + 'description' => 'The threshold settings.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => 'The data quality monitoring ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10001', - ], - 'Name' => [ - 'description' => 'The data quality monitor name.'."\n", - 'type' => 'string', - 'example' => 'data_quality_scan_001', - ], - 'Description' => [ - 'description' => 'The data quality monitor description.'."\n", - 'type' => 'string', - 'example' => 'aily data quality scanning of ods tables.', - ], - 'ProjectId' => [ - 'description' => 'The workspace ID where the data quality monitor resides. You can obtain the workspace ID by calling the [ListProjects](~~2780068~~) operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '101', - ], - 'CreateTime' => [ - 'description' => 'The creation time of the data quality monitor.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1731550150000', - ], - 'ModifyTime' => [ - 'description' => 'Last modified time of the data quality monitor.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1731550150000', - ], - 'CreateUser' => [ - 'description' => 'The ID of the user who creates the data quality monitor.'."\n", - 'type' => 'string', - 'example' => '2374924198591250', - ], - 'ModifyUser' => [ - 'description' => 'The ID of the user who last modifies the data quality monitor.'."\n", - 'type' => 'string', - 'example' => '23482597582479', - ], - 'Owner' => [ - 'description' => 'The ID of the user who owns the data quality monitor.'."\n", - 'type' => 'string', - 'example' => '231263586109857423', - ], - 'Spec' => [ - 'description' => 'Spec code for the content of the data quality monitoring.'."\n", - 'type' => 'string', - 'example' => '{'."\n" - .' "datasets": ['."\n" - .' {'."\n" - .' "type": "Table",'."\n" - .' "dataSource": {'."\n" - .' "name": "odps_first",'."\n" - .' "envType": "Prod"'."\n" - .' },'."\n" - .' "tables": ['."\n" - .' "ods_d_user_info"'."\n" - .' ],'."\n" - .' "filter": "pt = $[yyyymmdd-1]"'."\n" - .' }'."\n" - .' ],'."\n" - .' "rules": ['."\n" - .' {'."\n" - .' "assertion": "row_count > 0"'."\n" - .' }, {'."\n" - .' "templateId": "SYSTEM:field:null_value:fixed",'."\n" - .' "pass": "when = 0",'."\n" - .' "name": "The id cannot be empty.",'."\n" - .' "severity": "High",'."\n" - .' "identity": "a-customized-data-quality-rule-uuid"'."\n" - .' }'."\n" - .' ]'."\n" - .'}', - ], - 'Parameters' => [ - 'description' => 'The definition of execution parameters for the data quality monitor.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The parameter information.'."\n", - 'type' => 'object', - 'properties' => [ - 'Value' => [ - 'description' => 'The parameter name.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'Name' => [ - 'description' => 'The parameter value.'."\n", - 'type' => 'string', - 'example' => 'e2e_autolabel', - ], - ], - ], - ], - 'ComputeResource' => [ - 'description' => 'The compute engine used at runtime. Optional. If not specified, the data source defined in the Spec is used.'."\n", + 'Expected' => [ + 'description' => 'The expected threshold settings.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'The name of the compute engine, which is a unique identifier.'."\n", - 'type' => 'string', - 'example' => 'polardb_to_holo', - ], - 'Runtime' => [ - 'description' => 'More settings for data quality monitor at runtime.'."\n", - 'type' => 'object', - 'properties' => [ - 'Engine' => [ - 'description' => 'The type of the compute engine. Only EMR compute engines support these settings.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Hive: Hive SQL'."\n" - .'* Spark: Spark SQL'."\n" - .'* Kyuubi'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Hive', - ], - 'HiveConf' => [ - 'description' => 'Additional Hive engine parameters. Currently, only the mapreduce.job.queuename parameter is supported.'."\n", - 'type' => 'object', - 'example' => 'mapreduce.job.queuename=dq_queue', - ], - 'SparkConf' => [ - 'description' => 'Additional Spark engine parameters. Currently, only the spark.yarn.queue parameter is supported.'."\n", - 'type' => 'object', - 'example' => 'spark.yarn.queue=dq_queue'."\n", - ], - ], - ], - 'EnvType' => [ - 'description' => 'The workspace environment to which the compute engine belongs.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Prod: production environment .'."\n" - .'* Dev: development environment.'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Prod', - ], + 'Operator' => ['description' => 'The comparison operator.'."\n" + .'- \\>'."\n" + .'- \\>='."\n" + .'- <'."\n" + .'- <='."\n" + .'- !='."\n" + .'- =', 'type' => 'string', 'required' => false, 'example' => '>', 'title' => ''], + 'Value' => ['description' => 'The threshold value.', 'type' => 'string', 'required' => false, 'example' => '100.0', 'title' => ''], + 'Expression' => ['description' => 'The threshold expression.'."\n" + ."\n" + .'Fluctuation-type rules must use an expression to represent the fluctuation threshold. Examples:'."\n" + ."\n" + .'- Upward fluctuation greater than 0.01: $checkValue > 0.01'."\n" + .'- Downward fluctuation greater than 0.01: $checkValue < -0.01'."\n" + .'- Absolute fluctuation rate: abs($checkValue) > 0.01'."\n" + ."\n" + .'Fixed-value rules can also use an expression to configure the threshold. If both are configured, the expression takes precedence over Operator and Value.', 'type' => 'string', 'required' => false, 'example' => '$checkValue <= 0.01', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'RuntimeResource' => [ - 'description' => 'The resource group used during the running of the data quality monitor.'."\n", + 'Warned' => [ + 'description' => 'The threshold settings for normal warnings.', 'type' => 'object', 'properties' => [ - 'Id' => [ - 'description' => 'The resource group ID.'."\n", - 'type' => 'string', - 'example' => '122878', - ], - 'Cu' => [ - 'description' => 'Reserved compute units (CU) for the resource group.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '10', - ], - 'Image' => [ - 'description' => 'The image ID used in the runtime configuration.'."\n", - 'type' => 'string', - 'example' => 'hp-tlp-e2e-repo-registry-vpc.cn-heyuan-acdr-1.cr.aliyuncs.com/hp-service/worker:9b28b6d-202506091008', - ], + 'Operator' => ['description' => 'The comparison operator.'."\n" + .'- \\>'."\n" + .'- \\>='."\n" + .'- <'."\n" + .'- <='."\n" + .'- !='."\n" + .'- =', 'type' => 'string', 'required' => false, 'example' => '>', 'title' => ''], + 'Value' => ['description' => 'The threshold value.', 'type' => 'string', 'required' => false, 'example' => '100.0', 'title' => ''], + 'Expression' => ['description' => 'The threshold expression.'."\n" + ."\n" + .'Fluctuation-type rules must use an expression to represent the fluctuation threshold. Examples:'."\n" + ."\n" + .'- Upward fluctuation greater than 0.01: $checkValue > 0.01'."\n" + .'- Downward fluctuation greater than 0.01: $checkValue < -0.01'."\n" + .'- Absolute fluctuation rate: abs($checkValue) > 0.01'."\n" + ."\n" + .'Fixed-value rules can also use an expression to configure the threshold. If both are configured, the expression takes precedence over Operator and Value.', 'type' => 'string', 'required' => false, 'example' => '$checkValue > 0.01', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'Trigger' => [ - 'description' => 'The trigger configurations of the data quality monitoring task.'."\n", + 'Critical' => [ + 'description' => 'The threshold settings for critical warnings.', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => 'The trigger mode of the monitoring task.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* ByManual: Manual trigger. This is the default setting.'."\n" - .'* BySchedule: Triggered by a scheduled task instance.'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'BySchedule', - ], - 'TaskIds' => [ - 'description' => 'If the trigger mode is set to BySchedule, the scheduling task ID must be specified.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the scheduling task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1023777390', - ], - ], - ], - ], - 'Hooks' => [ - 'description' => 'The Hook configurations after the data quality monitoring run ends.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The Hook configurations after the data quality monitoring run ends.'."\n", - 'type' => 'object', - 'properties' => [ - 'Condition' => [ - 'description' => 'The Hook trigger condition. The hook will run if the condition is met. Currently, only one type of expression syntax is supported:'."\n" - ."\n" - .'* You can specify multiple combinations of rule severity levels and validation statuses using an expression such as `results.any { r -> r.status == \'Fail\' && r.rule.severity == \'Normal\' || r.status == \'Error\' && r.rule.severity == \'High\' || r.status == \'Warn\' && r.rule.severity == \'High\' }`. This expression means the condition is met if any executed rule has a result of Fail with severity Normal, Error with severity High, or Warn with severity High. In the condition expression, the values of severity and status are predefined enums. The values of severity must match those defined in the Spec, and the values of status must match those in DataQualityResult.'."\n", - 'type' => 'string', - 'example' => 'results.any { r -> r.status == \'Fail\' && r.rule.severity == \'Normal\' || r.status == \'Error\' && r.rule.severity == \'High\' || r.status == \'Warn\' && r.rule.severity == \'High\' }', - ], - 'Type' => [ - 'description' => 'The type of the Hook.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* BlockTaskInstance: BlockTaskInstance: Blocks the scheduling of the task instance.'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'BlockTaskInstance', - ], - ], + 'Operator' => ['description' => 'The comparison operator.'."\n" + .'- \\>'."\n" + .'- \\>='."\n" + .'- <'."\n" + .'- <='."\n" + .'- !='."\n" + .'- =', 'type' => 'string', 'required' => false, 'example' => '>', 'title' => ''], + 'Value' => ['description' => 'The threshold value.', 'type' => 'string', 'required' => false, 'example' => '100.0', 'title' => ''], + 'Expression' => ['description' => 'The threshold expression.'."\n" + ."\n" + .'Fluctuation-type rules must use an expression to represent the fluctuation threshold. Examples:'."\n" + ."\n" + .'- Upward fluctuation greater than 0.01: $checkValue > 0.01'."\n" + .'- Downward fluctuation greater than 0.01: $checkValue < -0.01'."\n" + .'- Absolute fluctuation rate: abs($checkValue) > 0.01'."\n" + ."\n" + .'Fixed-value rules can also use an expression to configure the threshold. If both are configured, the expression takes precedence over Operator and Value.', 'type' => 'string', 'required' => false, 'example' => '$checkValue > 0.05', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'ErrorHandlers', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The list of issue handlers for data quality rule verification.', + 'type' => 'array', + 'items' => [ + 'description' => 'An issue handler for data quality rule verification.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The handler type.'."\n" + .'- SaveErrorData', 'type' => 'string', 'required' => false, 'example' => 'SaveErrorData', 'title' => ''], + 'ErrorDataFilter' => ['description' => 'For a custom SQL rule, you must specify the SQL used to filter problematic data.', 'type' => 'string', 'required' => false, 'example' => 'SELECT * FROM tb_api_log WHERE id IS NULL'."\n", 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => '', + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '691CA452-D37A-4ED0-9441'."\n"], + 'Success' => ['description' => 'Indicates whether the update was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], 'staticInfo' => [ - 'returnType' => 'synchronous', + 'substitutions' => ['dataworks-public::2024-05-18::UpdateDataQualityScan'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"204EAF68-CCE3-5112-8DA0-E7A60F02XXXX\\",\\n \\"DataQualityScan\\": {\\n \\"Id\\": 10001,\\n \\"Name\\": \\"data_quality_scan_001\\",\\n \\"Description\\": \\"aily data quality scanning of ods tables.\\",\\n \\"ProjectId\\": 101,\\n \\"CreateTime\\": 1731550150000,\\n \\"ModifyTime\\": 1731550150000,\\n \\"CreateUser\\": \\"2374924198591250\\",\\n \\"ModifyUser\\": \\"23482597582479\\",\\n \\"Owner\\": \\"231263586109857423\\",\\n \\"Spec\\": \\"{\\\\n \\\\\\"datasets\\\\\\": [\\\\n {\\\\n \\\\\\"type\\\\\\": \\\\\\"Table\\\\\\",\\\\n \\\\\\"dataSource\\\\\\": {\\\\n \\\\\\"name\\\\\\": \\\\\\"odps_first\\\\\\",\\\\n \\\\\\"envType\\\\\\": \\\\\\"Prod\\\\\\"\\\\n },\\\\n \\\\\\"tables\\\\\\": [\\\\n \\\\\\"ods_d_user_info\\\\\\"\\\\n ],\\\\n \\\\\\"filter\\\\\\": \\\\\\"pt = $[yyyymmdd-1]\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"rules\\\\\\": [\\\\n {\\\\n \\\\\\"assertion\\\\\\": \\\\\\"row_count > 0\\\\\\"\\\\n }, {\\\\n \\\\\\"templateId\\\\\\": \\\\\\"SYSTEM:field:null_value:fixed\\\\\\",\\\\n \\\\\\"pass\\\\\\": \\\\\\"when = 0\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"The id cannot be empty.\\\\\\",\\\\n \\\\\\"severity\\\\\\": \\\\\\"High\\\\\\",\\\\n \\\\\\"identity\\\\\\": \\\\\\"a-customized-data-quality-rule-uuid\\\\\\"\\\\n }\\\\n ]\\\\n}\\",\\n \\"Parameters\\": [\\n {\\n \\"Value\\": \\"10\\",\\n \\"Name\\": \\"e2e_autolabel\\"\\n }\\n ],\\n \\"ComputeResource\\": {\\n \\"Name\\": \\"polardb_to_holo\\",\\n \\"Runtime\\": {\\n \\"Engine\\": \\"Hive\\",\\n \\"HiveConf\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"SparkConf\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"EnvType\\": \\"Prod\\"\\n },\\n \\"RuntimeResource\\": {\\n \\"Id\\": \\"122878\\",\\n \\"Cu\\": 10,\\n \\"Image\\": \\"hp-tlp-e2e-repo-registry-vpc.cn-heyuan-acdr-1.cr.aliyuncs.com/hp-service/worker:9b28b6d-202506091008\\"\\n },\\n \\"Trigger\\": {\\n \\"Type\\": \\"BySchedule\\",\\n \\"TaskIds\\": [\\n 1023777390\\n ]\\n },\\n \\"Hooks\\": [\\n {\\n \\"Condition\\": \\"results.any { r -> r.status == \'Fail\' && r.rule.severity == \'Normal\' || r.status == \'Error\' && r.rule.severity == \'High\' || r.status == \'Warn\' && r.rule.severity == \'High\' }\\",\\n \\"Type\\": \\"BlockTaskInstance\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'GetDataQualityScan', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-4ED0-9441\\\\n\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Updates a data quality rule', + 'description' => 'You must purchase DataWorks Basic Edition or above to use this feature.', + 'extraInfo' => 'List of rule template codes:'."\n" + .'- Custom SQL: SYSTEM:user_defined_sql'."\n" + ."\n" + .'- Table row count greater than 0: SYSTEM:table:table_count:fixed:0'."\n" + .'- Table row count, fixed value: SYSTEM:table:table_count:fixed'."\n" + .'- Table row count, 1-day delta: SYSTEM:table:table_count_delta:fixed:1_bizdate'."\n" + .'- Table row count, previous-cycle delta: SYSTEM:table:table_count_delta:fixed:latest_bizdate'."\n" + .'- Table row count, previous-cycle fluctuation rate: SYSTEM:table:table_count:cycle:latest_bizdate'."\n" + .'- Table row count, 7-day average fluctuation rate: SYSTEM:table:table_count:avg:7_bizdate'."\n" + .'- Table row count, 30-day average fluctuation rate: SYSTEM:table:table_count:avg:1m_bizdate'."\n" + .'- Table row count, 1-day fluctuation rate: SYSTEM:table:table_count:flux:1_bizdate'."\n" + .'- Table row count, 7-day fluctuation rate: SYSTEM:table:table_count:flux:7_bizdate'."\n" + .'- Table row count, 30-day fluctuation rate: SYSTEM:table:table_count:flux:1m_bizdate'."\n" + .'- Table row count, 1/7/30-day fluctuation rate: SYSTEM:table:table_count:flux:1_7_1m_bizdate'."\n" + .'- Table row count, 1/7/30-day and 1st-of-current-month fluctuation rate: SYSTEM:table:table_count:flux:1_7_1m_1st_bizdate'."\n" + .'- Table row count, custom range: SYSTEM:table:count'."\n" + .'- Condition match ratio, custom range: SYSTEM:table:count_percent'."\n" + ."\n" + .'- Average value, 1-day fluctuation rate: SYSTEM:field:avg:cycle:1_bizdate'."\n" + .'- Average value, 1/7/30-day fluctuation rate: SYSTEM:field:avg:flux:1_7_1m_bizdate'."\n" + .'- Average value, custom range: SYSTEM:field:avg'."\n" + ."\n" + .'- Sum value, 1-day fluctuation rate: SYSTEM:field:sum:cycle:1_bizdate'."\n" + .'- Sum value, previous-cycle fluctuation rate: SYSTEM:field:sum:cycle:latest_bizdate'."\n" + .'- Sum value, 1/7/30-day fluctuation rate: SYSTEM:field:sum:flux:1_7_1m_bizdate'."\n" + .'- Sum value, custom range: SYSTEM:field:sum'."\n" + ."\n" + .'- Minimum value, 1-day fluctuation rate: SYSTEM:field:min:cycle:1_bizdate'."\n" + .'- Minimum value, previous-cycle fluctuation rate: SYSTEM:field:min:cycle:latest_bizdate'."\n" + .'- Minimum value, 1/7/30-day fluctuation rate: SYSTEM:field:min:flux:1_7_1m_bizdate'."\n" + .'- Minimum value, custom range: SYSTEM:field:min'."\n" + ."\n" + .'- Maximum value, 1-day fluctuation rate: SYSTEM:field:max:cycle:1_bizdate'."\n" + .'- Maximum value, previous-cycle fluctuation rate: SYSTEM:field:max:cycle:latest_bizdate'."\n" + .'- Maximum value, 1/7/30-day fluctuation rate: SYSTEM:field:max:flux:1_7_1m_bizdate'."\n" + .'- Maximum value, custom range: SYSTEM:field:max'."\n" + ."\n" + .'- Null value record count equals 0: SYSTEM:field:null_value:fixed:0'."\n" + .'- Null value count, fixed value: SYSTEM:field:null_value:fixed'."\n" + .'- Null value count / total row count, fixed value: SYSTEM:field:null_value_percent:fixed'."\n" + ."\n" + .'- Field duplicate value count equals 0: SYSTEM:field:duplicated_count:fixed:0'."\n" + .'- Duplicate value count / total row count, fixed value: SYSTEM:field:duplicated_percent:fixed'."\n" + .'- Duplicate value count, fixed value: YSTEM:field:duplicated_count:fixed'."\n" + .'- Multi-field duplicate value count equals 0: SYSTEM:fields:duplicated_count:fixed:0'."\n" + ."\n" + .'- Discrete values (status values), fixed value: SYSTEM:field:all_discrete_count:fixed'."\n" + .'- Discrete values (group count and status values), 1/7/30-day fluctuation rate: SYSTEM:field:all_discrete_metrics:fluxdiscrete:1_7_1m_bizdate'."\n" + .'- Discrete values (group count), fixed value: SYSTEM:field:discrete_group_count:fixed'."\n" + .'- Discrete values (group count), 1-day fluctuation rate: SYSTEM:field:discrete_group_count:cycle:latest_bizdate'."\n" + ."\n" + .'- Table size, fixed value: SYSTEM:table:table_size:fixed'."\n" + .'- Table size, previous-cycle delta: SYSTEM:table:table_size_delta:fixed:latest_bizdate'."\n" + .'- Table size, delta compared with 1 day ago (bytes): SYSTEM:table:table_size_delta:fixed:1_bizdate'."\n" + .'- Table size, 1-day fluctuation rate: SYSTEM:table:table_size:flux:1_bizdate'."\n" + .'- Table size, 7-day fluctuation rate: SYSTEM:table:table_size:flux:7_bizdate'."\n" + .'- Table size, 30-day fluctuation rate: SYSTEM:table:table_size:flux:1m_bizdate'."\n" + ."\n" + .'- Distinct value count, fixed value: SYSTEM:field:count_distinct:fixed'."\n" + .'- Distinct value count, 1/7/30-day fluctuation rate: SYSTEM:field:count_distinct:flux:1_7_1m_bizdate'."\n" + .'- Distinct value count / total row count, fixed value: SYSTEM:field:count_distinct_percent:fixed'."\n" + ."\n" + .'- Table row count, dynamic threshold: SYSTEM:table:table_count:dynamic_threshold'."\n" + .'- Sum value, dynamic threshold: SYSTEM:field:sum:dynamic_threshold'."\n" + .'- Average value, dynamic threshold: SYSTEM:field:avg:dynamic_threshold'."\n" + .'- Maximum value, dynamic threshold: SYSTEM:field:max:dynamic_threshold'."\n" + .'- Minimum value, dynamic threshold: SYSTEM:field:min:dynamic_threshold'."\n" + .'- Distinct value rate, dynamic threshold: SYSTEM:table:table_size:dynamic_threshold'."\n" + .'- Distinct value count, dynamic threshold: SYSTEM:table:distinct_count:dynamic_threshold'."\n" + .'- Discrete values (group count), dynamic threshold: SYSTEM:field:avg:dynamic_threshold'."\n" + .'- Discrete values (status values), dynamic threshold: SYSTEM:field:sum:dynamic_threshold'."\n" + .'- Discrete values (group count), dynamic threshold: SYSTEM:field:discrete_group_count:dynamic_threshold'."\n" + .'- Discrete values (status values), dynamic threshold: SYSTEM:field:discrete_value_count:dynamic_threshold', + 'changeSet' => [ + ['createdAt' => '2025-01-15T08:15:09.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-12-23T06:29:09.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-12-19T09:25:09.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], ], - 'DeleteDataQualityScan' => [ - 'summary' => 'Deletes a data quality monitor.', - 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateDataQualityRuleTemplate' => [ + 'summary' => 'Updates a data quality rule template.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'deprecated' => false, + 'deprecated' => true, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdide3WJOKE', - ], + 'abilityTreeCode' => '248082', + 'abilityTreeNodes' => ['FEATUREdideRGVRPF'], ], 'parameters' => [ [ - 'name' => 'Description', + 'name' => 'Code', + 'in' => 'formData', + 'schema' => ['description' => 'The code of the rule template.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'USER_DEFINED:123', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the rule template. The name can contain digits, letters, Chinese characters, and half-width and full-width punctuation marks. The name can be up to 512 characters in length.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'maxLength' => 128, 'example' => 'Table row Count Verification'."\n", 'title' => ''], + ], + [ + '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 Management page to obtain the ID.'."\n" + ."\n" + .'This parameter specifies the DataWorks workspace used for this API call.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '10000', 'title' => ''], + ], + [ + 'name' => 'DirectoryPath', + 'in' => 'formData', + 'schema' => ['description' => 'The category directory in which the custom template is stored. Levels are separated by forward slashes (/). The name of each level can be up to 1024 characters in length and cannot contain whitespace characters or forward slashes (/).', 'type' => 'string', 'required' => false, 'example' => '/ods/order_data', 'title' => ''], + ], + [ + 'name' => 'SamplingConfig', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The deprecated parameter. No configuration is required.'."\n", - 'type' => 'string', + 'description' => 'The settings required for sample collection.', + 'type' => 'object', + 'properties' => [ + 'Metric' => ['description' => 'The name of the metric to be sampled. Valid values:'."\n" + .'- Count: the number of table rows.'."\n" + .'- Min: the minimum value of a field.'."\n" + .'- Max: the maximum value of a field.'."\n" + .'- Avg: the average value of a field.'."\n" + .'- DistinctCount: the number of distinct values of a field.'."\n" + .'- DistinctPercent: the ratio of the number of distinct values of a field to the number of data rows.'."\n" + .'- DuplicatedCount: the number of duplicate values of a field.'."\n" + .'- DuplicatedPercent: the ratio of the number of duplicate values of a field to the number of data rows.'."\n" + .'- TableSize: the size of the table.'."\n" + .'- NullValueCount: the number of rows in which the field is null.'."\n" + .'- NullValuePercent: the percentage of rows in which the field is null.'."\n" + .'- GroupCount: the number of data rows corresponding to each value after the field values are aggregated.'."\n" + .'- CountNotIn: the number of rows whose values do not match the enumerated values.'."\n" + .'- CountDistinctNotIn: the number of distinct values that do not match the enumerated values.'."\n" + .'- UserDefinedSql: sample collection by using custom SQL.', 'type' => 'string', 'required' => false, 'example' => 'Max', 'title' => ''], + 'MetricParameters' => ['description' => 'The parameters required for sample collection.', 'type' => 'string', 'required' => false, 'example' => '{"SQL": "select count(1) from table;"}'."\n", 'title' => ''], + 'SettingConfig' => ['description' => 'The runtime parameter setting statements that are inserted and executed before the sampling statements are executed. The statements can be up to 1,000 characters in length. Only MaxCompute is supported.', 'type' => 'string', 'maxLength' => 1000, 'required' => false, 'example' => 'SET odps.sql.udf.timeout=600s; '."\n" + .'SET odps.sql.python.version=cp27;'."\n", 'title' => ''], + ], 'required' => false, - 'example' => 'null', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Id', + 'name' => 'CheckingConfig', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The ID of the data quality monitor.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The settings for sample validation.', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The type of the monitored object. Valid values:'."\n" + ."\n" + .'- Table', 'type' => 'string', 'required' => false, 'example' => 'Table', 'title' => ''], + 'ReferencedSamplesFilter' => ['description' => 'For some types of thresholds, you must query reference samples and then aggregate the values of the reference samples to obtain the threshold used for comparison. An expression is used here to indicate the query method of reference samples.', 'type' => 'string', 'required' => false, 'example' => '{ "bizdate": [ "-1", "-7", "-1m" ] }'."\n", 'title' => ''], + ], 'required' => false, - 'example' => '123123', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => '2197B9C4-39CE-55EA-8EEA-FDBAE52DXXXX', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '691CA452-D37A-4ED0-****'."\n"], + 'Success' => ['description' => 'Indicates whether the update was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], 'staticInfo' => [ + 'substitutions' => ['dataworks-public::2024-05-18::UpdateDataQualityTemplate'], 'returnType' => 'synchronous', ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2197B9C4-39CE-55EA-8EEA-FDBAE52DXXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'DeleteDataQualityScan', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", - ], - 'CreateDataQualityAlertRule' => [ - 'summary' => 'Creates a data quality monitoring alert rule in a project.', - 'path' => '', - 'methods' => [ - 'post', + 'title' => 'Updates a data quality rule template', + 'description' => 'You can call this operation only after you purchase DataWorks Basic Edition or a higher edition.', + 'changeSet' => [ + ['createdAt' => '2025-03-31T05:58:07.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-12-23T06:29:09.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-4ED0-****\\\\n\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'UpdateDataQualityScan' => [ + 'summary' => 'Updates a data quality monitor.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -49368,206 +48849,259 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdide3WJOKE', - ], + 'abilityTreeNodes' => ['FEATUREdide3WJOKE'], ], 'parameters' => [ + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['description' => 'Description of the data quality monitor.', 'type' => 'string', 'required' => false, 'example' => 'Daily data quality scanning of ods tables.', 'title' => ''], + ], [ 'name' => 'ProjectId', 'in' => 'formData', + 'schema' => ['description' => 'The ID of the DataWorks workspace where the data quality monitor resides. You can obtain the workspace ID by calling the [ListProjects](~~2852607~~) operation.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '101', 'title' => ''], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the data quality monitor.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10001', 'title' => ''], + ], + [ + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => ['description' => 'The user ID of the owner of the data quality monitor.', 'type' => 'string', 'required' => false, 'example' => '231263586109857423', 'title' => ''], + ], + [ + 'name' => 'Spec', + 'in' => 'formData', + 'schema' => ['description' => 'The Spec code of the data quality monitoring content. For more information, see [Data quality Spec configuration description](~~2963394~~).', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "datasets": ['."\n" + .' {'."\n" + .' "type": "Table",'."\n" + .' "dataSource": {'."\n" + .' "name": "odps_first",'."\n" + .' "envType": "Prod"'."\n" + .' },'."\n" + .' "tables": ['."\n" + .' "ods_d_user_info"'."\n" + .' ],'."\n" + .' "filter": "pt = $[yyyymmdd-1]"'."\n" + .' }'."\n" + .' ],'."\n" + .' "rules": ['."\n" + .' {'."\n" + .' "assertion": "row_count > 0"'."\n" + .' }, {'."\n" + .' "templateId": "SYSTEM:field:null_value:fixed",'."\n" + .' "pass": "when = 0",'."\n" + .' "name": "The id cannot be empty.",'."\n" + .' "severity": "High",'."\n" + .' "identity": "a-customized-data-quality-rule-uuid"'."\n" + .' }'."\n" + .' ]'."\n" + .'}', 'title' => ''], + ], + [ + 'name' => 'Parameters', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The project ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10001', + 'description' => 'The definition of execution parameters for the data quality monitor.', + 'type' => 'array', + 'items' => [ + 'description' => 'The parameter information.', + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => 'The parameter value.', 'type' => 'string', 'required' => false, 'example' => 'smtp.qiye.aliyun.com', 'title' => ''], + 'Name' => ['description' => 'The parameter name.', 'type' => 'string', 'required' => false, 'example' => 'temp_237669.zip_byBwm_1734661241752', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Condition', + 'name' => 'RuntimeResource', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The alert condition of the data quality monitoring rule.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'results.any { r -> r.status == \'fail\' && r.rule.severity == \'High\' }', + 'description' => 'The resource group used during the execution of the data quality monitor.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => '20315', 'title' => ''], + 'Cu' => ['description' => 'The default number of CUs configured for task running.', 'type' => 'number', 'format' => 'float', 'required' => false, 'example' => '0.25', 'title' => ''], + 'Image' => ['description' => 'The image ID of the task runtime configuration.', 'type' => 'string', 'required' => false, 'example' => 'i-xxxxxx', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Target', + 'name' => 'ComputeResource', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'The monitored target of the data quality monitoring rule.'."\n", + 'description' => 'The compute engine used during execution. If it\'s not specified, the data source connection defined in the Spec will be used.', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => 'The type of the monitored target. Only DataQualityScan is supported.'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [], - 'example' => 'DataQualityScan', - ], - 'Ids' => [ - 'description' => 'The list of monitored target IDs. Currently, only one ID can be set.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the monitored target.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '113646', + 'Name' => ['description' => 'The name of the compute engine, which is a unique identifier.', 'type' => 'string', 'required' => false, 'example' => 'auto_createAlertRule_Finished_1kUTk6', 'title' => ''], + 'Runtime' => [ + 'description' => 'Additional settings for the compute engine.', + 'type' => 'object', + 'properties' => [ + 'Engine' => [ + 'description' => 'The engine type. These settings are only supported for the EMR compute engine.This setting? Valid values:'."\n" + ."\n" + .'- Hive: Hive SQL'."\n" + ."\n" + .'- Spark: Spark SQL'."\n" + ."\n" + .'- Kyuubi', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'example' => 'Hive', + 'title' => '', + ], + 'SparkConf' => ['description' => 'Additional Spark engine parameters. Currently, only the spark.yarn.queue parameter is supported.', 'type' => 'object', 'required' => false, 'example' => 'spark.yarn.queue=dq_queue', 'title' => ''], + 'HiveConf' => ['description' => 'Additional Hive engine parameters. Currently, only the mapreduce.job.queuename parameter is supported.', 'type' => 'object', 'required' => false, 'example' => 'mapreduce.job.queuename=dq_queue', 'title' => ''], ], - 'required' => true, + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'EnvType' => [ + 'description' => 'Workspace environment of the compute engine. Valid values:'."\n" + ."\n" + .'- Prod'."\n" + ."\n" + .'- Dev', + 'enumValueTitles' => [], + 'type' => 'string', + 'enum' => ['Prod', 'Dev'], + 'required' => false, + 'example' => 'Prod', + 'title' => '', ], ], - 'required' => true, + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Notification', + 'name' => 'Trigger', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'The list of alert channels.'."\n", + 'description' => 'Trigger settings for the data quality monitor.', 'type' => 'object', 'properties' => [ - 'Channels' => [ - 'description' => 'The list of alert channels. You can set both `Email` and `Sms` at the same time. In other cases, only one channel can be set.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Alert channels.'."\n" - ."\n" - .'* Dingding'."\n" - .'* Weixin'."\n" - .'* Mail'."\n" - .'* Sms'."\n" - .'* Phone'."\n" - .'* Webhook'."\n" - .'* Feishu'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [], - 'example' => 'Sms', - 'enum' => [ - 'Dingding', - 'Weixin', - 'Mail', - 'Sms', - 'Phone', - 'Webhook', - 'Feishu', - ], - ], - 'required' => true, + 'Type' => [ + 'description' => 'The trigger mode of the data quality monitor. Valid values:'."\n" + ."\n" + .'- ByManual: Manually triggered. Default setting.'."\n" + ."\n" + .'- BySchedule: Triggered by a scheduled task instance.', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'example' => 'BySchedule', + 'title' => '', ], - 'Receivers' => [ - 'description' => 'The alert recipients.'."\n", + 'TaskIds' => [ + 'description' => 'If the trigger mode is BySchedule, the ID of the scheduling task that triggers the monitor must be configured.', 'type' => 'array', - 'items' => [ - 'description' => 'The alert recipients.'."\n", - 'type' => 'object', - 'properties' => [ - 'Extension' => [ - 'description' => 'Additional configurations required for the alert recipients. When ReceiverType is DingdingUrl, you can set `{"atAll":true}` to mention all members.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"atAll":true}'."\n", - ], - 'ReceiverType' => [ - 'description' => 'The type of alert recipients.'."\n" - ."\n" - .'* AliUid'."\n" - .'* WebhookUrl'."\n" - .'* DingdingUrl'."\n" - .'* WeixinUrl'."\n" - .'* FeishuUrl'."\n" - .'* TaskOwner'."\n" - .'* DataQualityScanOwner'."\n" - .'* ShiftSchedule'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [], - 'example' => 'TaskOwner', - 'enum' => [ - 'AliUid', - 'WebhookUrl', - 'DingdingUrl', - 'WeixinUrl', - 'FeishuUrl', - 'TaskOwner', - 'DataQualityScanOwner', - 'ShiftSchedule', - ], - ], - 'ReceiverValues' => [ - 'description' => 'The value of alert recipients.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The value of alert recipients.'."\n" - ."\n" - .'* If ReceiverType is AliUid, enter the Alibaba Cloud account ID.'."\n" - .'* If ReceiverType is ShiftSchedule, enter the shift schedule ID.'."\n" - .'* If ReceiverType is WebhookUrl / DingdingUrl / FeishuUrl / WeixinUrl, enter the corresponding URL.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=a30bae7******'."\n", - ], - 'required' => false, - ], - ], - 'required' => true, + 'items' => ['description' => 'The scheduling task ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30001', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'Hooks', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The hook configuration after the data quality monitor stops.', + 'type' => 'array', + 'items' => [ + 'description' => 'The hook configuration after the data quality monitor stops.', + 'type' => 'object', + 'properties' => [ + 'Condition' => ['description' => 'The hook trigger condition. When this condition is met, the hook is triggered. Valid expression format:'."\n" + ."\n" + .'Specifies multiple combinations of rule severity levels and rule validation statuses, such as `results.any { r -> r.status == \'Fail\' && r.rule.severity == \'Normal\' || r.status == \'Error\' && r.rule.severity == \'High\' || r.status == \'Warn\' && r.rule.severity == \'High\' }`. This means the hook is triggered if any executed rule has Fail with Normal severity, Error with High severity, or Warn with High severity. The severity values must match those defined in the Spec. The status values must match those in DataQualityResult.', 'type' => 'string', 'required' => false, 'example' => 'results.any { r -> r.status == \'Fail\' && r.rule.severity == \'Normal\' || r.status == \'Error\' && r.rule.severity == \'High\' || r.status == \'Warn\' && r.rule.severity == \'High\' }', 'title' => ''], + 'Type' => [ + 'description' => 'The type of the hook. Valid values:'."\n" + ."\n" + .'- BlockTaskInstance: Block the scheduling of the task instance.', + 'enumValueTitles' => [], + 'type' => 'string', + 'enum' => ['BlockTaskInstance'], + 'required' => false, + 'example' => 'BlockTaskInstance', + 'title' => '', ], - 'required' => true, ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'required' => true, + 'required' => false, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the data quality monitor.', 'type' => 'string', 'required' => false, 'example' => 'data_quality_scan_001', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response.'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0bc14115***159376359', - ], - 'Id' => [ - 'description' => 'The user-defined rule ID returned after the monitoring rule is successfully created.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1010543619', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A1****'], + 'Success' => ['description' => 'Indicates whether the call was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateDataQualityScan', + 'description' => 'DataWorks Basic Edition or a higher edition is required.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115***159376359\\",\\n \\"Id\\": 1010543619\\n}","type":"json"}]', - 'title' => 'CreateDataQualityAlertRule', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A1****\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], - 'UpdateDataQualityAlertRule' => [ - 'summary' => 'Updates a specified data quality monitoring alert rule.', + 'UpdateDataQualityTemplate' => [ + 'summary' => 'Updates a data quality rule template in a project', 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -49576,463 +49110,177 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdide3WJOKE', - ], + 'abilityTreeNodes' => ['FEATUREdide3WJOKE'], ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the alert rule.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '105412', - ], + 'schema' => ['description' => 'The ID of the custom rule template.', 'type' => 'string', 'required' => false, 'example' => 'USER_DEFINED:2001', 'title' => ''], ], [ 'name' => 'ProjectId', 'in' => 'formData', - 'schema' => [ - 'description' => 'The project ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1000', - ], - ], - [ - 'name' => 'Condition', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The alert condition of the data quality monitoring rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'results.any { r -> r.status == \'fail\' && r.rule.severity == \'High\' }', - ], + 'schema' => ['description' => 'The project ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '100001', 'title' => ''], ], [ - 'name' => 'Target', + 'name' => 'Spec', 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The monitored target of the data quality monitoring rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the monitored target. Only DataQualityScan is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'DataQualityScan', - ], - 'Ids' => [ - 'description' => 'The list of monitored target IDs. Currently, only one ID can be set.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the monitored target.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '7638999336', - ], - 'required' => false, - ], - ], - 'required' => false, - ], + 'schema' => ['description' => 'Detailed configuration Spec code of the rule template. For more information, see [Data quality Spec configuration description](~2963394~).', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "assertion": "anomaly detection fro id_not_null_cnt",'."\n" + .' "id_not_null_cnt": {'."\n" + .' "query": "SELECT COUNT(*) AS cnt FROM ${tableName} WHERE dt = \'$[yyyymmdd-1]\';"'."\n" + .' },'."\n" + .' "identity": "819cf1f8-29be-4f94-a9d0-c5c06c0c3d2a"'."\n" + .'}', 'title' => ''], ], [ - 'name' => 'Notification', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'Alert notification configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'Channels' => [ - 'description' => 'The list of alert channels. You can set both Email and Sms at the same time. In other cases, only one channel can be set.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Alert channels.'."\n" - ."\n" - .'* Dingding'."\n" - .'* Weixin'."\n" - .'* Mail'."\n" - .'* Sms'."\n" - .'* Phone'."\n" - .'* Webhook'."\n" - .'* Feishu'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [], - 'example' => 'Sms', - 'enum' => [ - 'Dingding', - 'Weixin', - 'Mail', - 'Sms', - 'Phone', - 'Webhook', - 'Feishu', - ], - ], - 'required' => true, - ], - 'Receivers' => [ - 'description' => 'The alert recipients.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The alert recipients.'."\n", - 'type' => 'object', - 'properties' => [ - 'Extension' => [ - 'description' => 'Additional configurations required for the alert recipients. When ReceiverType is DingdingUrl, you can set `{"atAll":true}` to mention all members.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"atAll":true}'."\n", - ], - 'ReceiverType' => [ - 'description' => 'The type of alert recipients.'."\n" - ."\n" - .'* AliUid'."\n" - .'* WebhookUrl'."\n" - .'* DingdingUrl'."\n" - .'* WeixinUrl'."\n" - .'* FeishuUrl'."\n" - .'* TaskOwner'."\n" - .'* DataQualityScanOwner'."\n" - .'* ShiftSchedule'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [], - 'example' => 'TaskOwner', - 'enum' => [ - 'AliUid', - 'WebhookUrl', - 'DingdingUrl', - 'WeixinUrl', - 'FeishuUrl', - 'TaskOwner', - 'DataQualityScanOwner', - 'ShiftSchedule', - ], - ], - 'ReceiverValues' => [ - 'description' => 'The value of alert recipients.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The value of alert recipients.'."\n" - ."\n" - .'* If ReceiverType is AliUid, enter the Alibaba Cloud account ID.'."\n" - .'* If ReceiverType is ShiftSchedule, enter the shift schedule ID.'."\n" - .'* If ReceiverType is WebhookUrl, DingdingUrl, FeishuUrl, or WeixinUrl, enter the corresponding URL.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=a30bae7******', - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, - ], + 'name' => 'Owner', + 'in' => 'query', + 'schema' => ['description' => 'The account ID of the owner.', 'type' => 'string', 'required' => false, 'example' => '95279527****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response.'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0bc14115***159376359', - ], - 'Success' => [ - 'description' => 'Indicates whether the alert rule was updated.'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The API request ID, which is generated as a UUID.', 'type' => 'string', 'example' => '0bc14115***159376359'], + 'Success' => ['description' => 'Indicates whether the rule template is updated.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateDataQualityTemplate', + 'description' => 'DataWorks Basic Edition or a higher edition is required.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115***159376359\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'UpdateDataQualityAlertRule', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", ], - 'ListDataQualityAlertRules' => [ - 'summary' => 'Queries the list of data quality alert rules in a project.', - 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateDataSource' => [ + 'summary' => 'Modifies a data source by ID.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdide3WJOKE', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '232392', + 'abilityTreeNodes' => ['FEATUREdideRWC5F7'], ], 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The project ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10001', - ], + 'schema' => ['description' => 'The data source ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '16033'], ], [ - 'name' => 'DataQualityScanId', + 'name' => 'ProjectId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the data quality monitor that the alert rule targets.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10001', - ], + 'schema' => ['description' => 'The DataWorks workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '5678'], ], [ - 'name' => 'SortBy', + 'name' => 'ConnectionPropertiesMode', 'in' => 'query', 'schema' => [ - 'description' => 'The list of sorting fields. Supports fields such as last modified time and creation time. Format: "SortField+SortOrder (Desc/Asc)", where Asc is the default. Valid values:'."\n" + 'description' => 'The mode in which the data source is added. The mode varies based on the data source type. Valid values:'."\n" ."\n" - .'* CreateTime (Desc/Asc)'."\n" - .'* Id (Desc/Asc)'."\n", + .'- InstanceMode: instance mode'."\n" + ."\n" + .'- UrlMode: connection string mode', + 'enumValueTitles' => [], 'type' => 'string', + 'enum' => ['UrlMode', 'InstanceMode', 'CdhMode'], + 'title' => '', 'required' => false, - 'example' => 'CreateTime Desc', + 'example' => 'UrlMode', ], ], [ - 'name' => 'PageNumber', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number of the results.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'minimum' => '1', - 'example' => '1', - ], + 'schema' => ['description' => 'The description of the data source. The description cannot exceed 3,000 characters in length.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'test '], ], [ - 'name' => 'PageSize', + 'name' => 'ConnectionProperties', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of records to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'maximum' => '200', - 'minimum' => '1', - 'example' => '10', - ], + 'schema' => ['description' => 'The connection configurations of the data source, including the connection address, access identity, and environment information. The envType parameter specifies the environment in which the data source is used. Valid values of the envType parameter:'."\n" + ."\n" + .'- Dev: development environment'."\n" + ."\n" + .'- Prod: production environment'."\n" + ."\n" + .'The parameters that you need to configure for the data source vary based on the mode in which the data source is added. For more information, see [Data source connection information (ConnectionProperties)](~~2852465~~).', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '{'."\n" + .' "envType": "Prod",'."\n" + .' "regionId": "cn-beijing",'."\n" + .' "instanceId": "hgprecn-cn-x0r3oun4k001",'."\n" + .' "database": "testdb",'."\n" + .' "securityProtocol": "authTypeNone",'."\n" + .' "authType": "Executor",'."\n" + .' "authIdentity": "1107550004253538"'."\n" + .'}'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response.'."\n", + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0bc14115***159376359', - ], - 'PageInfo' => [ - 'description' => 'Alert rule configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '335', - ], - 'PageNumber' => [ - 'description' => 'The current page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of records per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'DataQualityAlertRules' => [ - 'description' => 'The list of alert rule configurations.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Alert rule configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'Condition' => [ - 'description' => 'The alert conditions.'."\n", - 'type' => 'string', - 'example' => 'results.any { r -> r.status == \'fail\' && r.rule.severity == \'High\' }', - ], - 'Target' => [ - 'description' => 'Monitored targets of the data quality alert rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the monitored target. Only DataQualityScan is supported.'."\n", - 'type' => 'string', - 'example' => 'DataQualityScan', - ], - 'Ids' => [ - 'description' => 'The list of monitored target IDs'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the monitored target.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '7638999336', - ], - ], - ], - ], - 'ProjectId' => [ - 'description' => 'The project ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '59094', - ], - 'Id' => [ - 'description' => 'The ID of the data quality monitor alert rule.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '26433', - ], - 'Notification' => [ - 'description' => 'Alert notification configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'Receivers' => [ - 'description' => 'The alert recipients.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The alert recipients.'."\n", - 'type' => 'object', - 'properties' => [ - 'Extension' => [ - 'description' => 'Additional configurations required for the alert recipients. When ReceiverType is DingdingUrl, you can set `{"atAll":true}` to mention all members.'."\n", - 'type' => 'string', - 'example' => '{"atAll":true}', - ], - 'ReceiverType' => [ - 'description' => 'The type of alert recipients.'."\n" - ."\n" - .'* ShiftSchedule'."\n" - .'* WebhookUrl'."\n" - .'* FeishuUrl'."\n" - .'* TaskOwner'."\n" - .'* WeixinUrl'."\n" - .'* DingdingUrl'."\n" - .'* DataQualityScanOwner'."\n" - .'* AliUid'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'AliUid', - ], - 'ReceiverValues' => [ - 'description' => 'The value of alert recipients.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The value of alert recipients.'."\n" - ."\n" - .'* If ReceiverType is AliUid, enter the Alibaba Cloud account ID.'."\n" - .'* If ReceiverType is ShiftSchedule, enter the shift schedule ID.'."\n" - .'* If ReceiverType is WebhookUrl, DingdingUrl, FeishuUrl, or WeixinUrl, enter the corresponding URL.'."\n", - 'type' => 'string', - 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=a30bae7******', - ], - ], - ], - ], - ], - 'Channels' => [ - 'description' => 'In Channels, you can set both Email and Sms at the same time. In other cases, only one channel can be set.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Alert channels.'."\n" - ."\n" - .'* Mail'."\n" - .'* Weixin'."\n" - .'* Feishu'."\n" - .'* Phone'."\n" - .'* Sms'."\n" - .'* Webhook'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Sms', - ], - ], - ], - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '102E8E24-0387-531D-8A75-1C0AE7DD03E5'], + 'Success' => ['description' => 'Whether the data source has been modified:'."\n" + ."\n" + .'- true: Yes'."\n" + ."\n" + .'- false: no', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateDataSource', + 'description' => ' ', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115***159376359\\",\\n \\"PageInfo\\": {\\n \\"TotalCount\\": 335,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"DataQualityAlertRules\\": [\\n {\\n \\"Condition\\": \\"results.any { r -> r.status == \'fail\' && r.rule.severity == \'High\' }\\",\\n \\"Target\\": {\\n \\"Type\\": \\"DataQualityScan\\",\\n \\"Ids\\": [\\n 7638999336\\n ]\\n },\\n \\"ProjectId\\": 59094,\\n \\"Id\\": 26433,\\n \\"Notification\\": {\\n \\"Receivers\\": [\\n {\\n \\"Extension\\": \\"{\\\\\\"atAll\\\\\\":true}\\",\\n \\"ReceiverType\\": \\"AliUid\\",\\n \\"ReceiverValues\\": [\\n \\"https://oapi.dingtalk.com/robot/send?access_token=a30bae7******\\"\\n ]\\n }\\n ],\\n \\"Channels\\": [\\n \\"Sms\\"\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListDataQualityAlertRules', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:UpdateDataSource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"102E8E24-0387-531D-8A75-1C0AE7DD03E5\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], - 'GetDataQualityAlertRule' => [ - 'summary' => 'Queries the details of a data quality monitoring and alerting rule by alert rule ID.', + 'UpdateDataset' => [ + 'summary' => 'Updates dataset information. Only DataWorks datasets are supported. The operator must be the creator of the dataset or the administrator of the workspace where the dataset is located.', 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -50041,170 +49289,75 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdide3WJOKE', - ], + 'abilityTreeNodes' => ['FEATUREdideXGTG91'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => 'The data quality monitoring alert rule ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '113642', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The dataset ID. Only DataWorks datasets are supported for update.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'dataworks-dataset:3pXXXb8o0ngr07njhps1'], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['description' => 'The dataset name. A non-empty string, length not exceeding 128.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'test_oss_dataset_new'], + ], + [ + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => ['description' => 'The dataset description. Length not exceeding 1024.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'new comment'], + ], + [ + 'name' => 'Readme', + 'in' => 'formData', + 'schema' => ['description' => 'The user guide, supports Markdown formatted rich text.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '## introduction'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response.'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0bc14115****159376359', - ], - 'DataQualityAlertRule' => [ - 'description' => 'Data quality monitoring alert rules.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the data quality monitoring alert rule.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '21045', - ], - 'Condition' => [ - 'description' => 'Alert conditions of the data quality monitoring alert rule.'."\n", - 'type' => 'string', - 'example' => 'results.any { r -> r.status == \'fail\' && r.rule.severity == \'High\' }', - ], - 'ProjectId' => [ - 'description' => 'The project ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '90912', - ], - 'Target' => [ - 'description' => 'The monitored target of the data quality monitoring alert rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the monitored target. Only `DataQualityScan` is supported.'."\n", - 'type' => 'string', - 'example' => 'DataQualityScan', - ], - 'Ids' => [ - 'description' => 'The list of monitored target IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The monitored target ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '113647', - ], - ], - ], - ], - 'Notification' => [ - 'description' => 'Alert notification settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Channels' => [ - 'description' => 'In Channels, you can set both Email and Sms at the same time. In other cases, only one channel can be set.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Alert channels.'."\n" - ."\n" - .'* Dingding'."\n" - .'* Mail'."\n" - .'* Weixin'."\n" - .'* Feishu'."\n" - .'* Phone'."\n" - .'* Sms'."\n" - .'* Webhook'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Dingding', - ], - ], - 'Receivers' => [ - 'description' => 'The alert recipients.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The alert recipients.'."\n", - 'type' => 'object', - 'properties' => [ - 'Extension' => [ - 'description' => 'Additional configurations required for the alert recipients. When ReceiverType is DingdingUrl, you can set `{"atAll":true}` to mention all members.'."\n", - 'type' => 'string', - 'example' => '{"atAll":true}', - ], - 'ReceiverType' => [ - 'description' => 'The type of alert recipients.'."\n" - ."\n" - .'* ShiftSchedule'."\n" - .'* WebhookUrl'."\n" - .'* FeishuUrl'."\n" - .'* TaskOwner'."\n" - .'* WeixinUrl'."\n" - .'* DingdingUrl'."\n" - .'* DataQualityScanOwner'."\n" - .'* AliUid'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'TaskOwner', - ], - 'ReceiverValues' => [ - 'description' => 'The value of alert recipients.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The value of alert recipients.'."\n" - ."\n" - .'* If ReceiverType is AliUid, enter the Alibaba Cloud account ID.'."\n" - .'* If ReceiverType is ShiftSchedule, enter the shift schedule ID.'."\n" - .'* If ReceiverType is WebhookUrl, DingdingUrl, FeishuUrl, or WeixinUrl, enter the corresponding URL.'."\n", - 'type' => 'string', - 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=a30bae7******', - ], - ], - ], - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n"], + 'Success' => ['description' => 'Indicates whether the update is successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateDataset', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115****159376359\\",\\n \\"DataQualityAlertRule\\": {\\n \\"Id\\": 21045,\\n \\"Condition\\": \\"results.any { r -> r.status == \'fail\' && r.rule.severity == \'High\' }\\",\\n \\"ProjectId\\": 90912,\\n \\"Target\\": {\\n \\"Type\\": \\"DataQualityScan\\",\\n \\"Ids\\": [\\n 113647\\n ]\\n },\\n \\"Notification\\": {\\n \\"Channels\\": [\\n \\"Dingding\\"\\n ],\\n \\"Receivers\\": [\\n {\\n \\"Extension\\": \\"{\\\\\\"atAll\\\\\\":true}\\",\\n \\"ReceiverType\\": \\"TaskOwner\\",\\n \\"ReceiverValues\\": [\\n \\"https://oapi.dingtalk.com/robot/send?access_token=a30bae7******\\"\\n ]\\n }\\n ]\\n }\\n }\\n}","type":"json"}]', - 'title' => 'GetDataQualityAlertRule', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:UpdateDataset', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\\\n\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], - 'DeleteDataQualityAlertRule' => [ - 'summary' => 'Deletes a data quality alert rule by ID.', + 'UpdateDatasetVersion' => [ + 'summary' => 'Updates dataset version information. Only DataWorks datasets are supported. Requires dataset creator or workspace administrator permissions.', 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -50213,962 +49366,501 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdide3WJOKE', - ], + 'abilityTreeNodes' => ['FEATUREdideXGTG91'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ 'name' => 'Id', 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the data quality rule template.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => 'a7ef0634-20ec-4a7c-a214-54020f91XXXX', - ], + 'schema' => ['description' => 'The dataset version ID. Only DataWorks datasets can be updated.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => ' '."\n" + .'dataworks-datasetVersion:3pXXXb8o0ngr07njhps1'."\n" + .':2'], + ], + [ + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => ['description' => 'The dataset version description. Maximum length: 1024 characters.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'this is a comment'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response.'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0bc14115***159376359', - ], - 'Success' => [ - 'description' => 'Indicates whether the alert rule is deleted.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'A090666C-74FB-5629-ABFC-2FE99DD55XXX'], + 'Success' => ['description' => 'Indicates whether the update succeeded.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115***159376359\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'DeleteDataQualityAlertRule', - 'description' => 'Subscribe to DataWorks Basic Edition or a higher version to use this API.'."\n", - ], - 'CreateDataQualityScanRun' => [ - 'summary' => 'Triggers a data quality monitoring task and returns the run instance ID.', - 'path' => '', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateDatasetVersion', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:UpdateDatasetVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A090666C-74FB-5629-ABFC-2FE99DD55XXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'UpdateFile' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdide3WJOKE', + 'operationType' => 'update', + 'abilityTreeCode' => '268116', + 'abilityTreeNodes' => ['FEATUREdide8FM783'], + ], + 'parameters' => [ + [ + 'name' => 'FileFolderPath', + 'in' => 'formData', + 'schema' => ['description' => 'The path to the folder where the file is located.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Business_process/First_Business_Process/data_integration/Folder_1/Folder_2', 'title' => ''], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => ['description' => 'The DataWorks workspace ID. To obtain the ID, log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and navigate to the workspace management page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '100001', 'title' => ''], + ], + [ + 'name' => 'FileName', + 'in' => 'formData', + 'schema' => ['description' => 'The file name. You can modify the file name by setting a new value for FileName. For example, you can call the [ListFiles](~~173942~~) operation to query the file ID in the target directory, and then call the [UpdateFile](~~173951~~) operation with the file ID specified in the FileId parameter and a new value specified in the FileName parameter to modify the file name.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'ods_user_info_d', 'title' => ''], + ], + [ + 'name' => 'FileDescription', + 'in' => 'formData', + 'schema' => ['description' => 'The file description.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Here is the file description', 'title' => ''], + ], + [ + 'name' => 'Content', + 'in' => 'formData', + 'schema' => ['description' => 'The file code content. Different code types (fileType) have different code formats. In Operation Center, you can right-click a task of the corresponding type and select View Code to view the specific code format.', 'type' => 'string', 'required' => false, 'example' => 'SELECT "1";', 'title' => ''], + ], + [ + 'name' => 'AutoRerunTimes', + 'in' => 'formData', + 'schema' => ['description' => 'The number of automatic reruns after the file execution fails.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '3', 'title' => ''], + ], + [ + 'name' => 'AutoRerunIntervalMillis', + 'in' => 'formData', + 'schema' => ['description' => 'The interval at which the node is automatically rerun after a failure. Unit: milliseconds. Maximum value: 1800000 milliseconds (30 minutes).'."\n" + ."\n" + .'This parameter corresponds to the Rerun interval parameter in Properties > Schedule > Auto Rerun upon Failure for data development nodes in the [DataWorks console](https://workbench.data.aliyun.com/console). In the console, the unit of the rerun interval is minutes. Convert the time unit when you call this operation.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '120000', 'title' => ''], + ], + [ + 'name' => 'RerunMode', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The rerun policy. Valid values:'."\n" + ."\n" + .'- ALL\\_ALLOWED: Reruns are allowed regardless of whether the task succeeds or fails.'."\n" + ."\n" + .'- FAILURE\\_ALLOWED: Reruns are allowed only when the task fails.'."\n" + ."\n" + .'- ALL\\_DENIED: Reruns are not allowed regardless of whether the task succeeds or fails.'."\n" + ."\n" + .'This parameter corresponds to the Support for Rerun setting in Scheduling > Scheduling Policies for Data Studio tasks in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- ALL\\_ALLOWD'."\n" + ."\n" + .'- FAILURE\\_ALLOWED'."\n" + ."\n" + .'- ALL\\_DENIED'."\n" + ."\n" + .'- ALL\\_ALLOWED', + 'type' => 'string', + 'required' => false, + 'enum' => ['ALL_ALLOWD', 'FAILURE_ALLOWED', 'ALL_DENIED', 'ALL_ALLOWED'], + 'example' => 'ALL_ALLOWED', + 'title' => '', + ], + ], + [ + 'name' => 'Stop', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to skip execution. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false'."\n" + ."\n" + .'This parameter corresponds to the Skip Execution option in Properties > Schedule > Recurrence for data development nodes in the [DataWorks console](https://workbench.data.aliyun.com/console).', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'ParaValue', + 'in' => 'formData', + 'schema' => ['description' => 'The scheduling parameters of the node.'."\n" + ."\n" + .'This parameter corresponds to the Scheduling Parameter setting in Properties for data development nodes in the [DataWorks console](https://workbench.data.aliyun.com/console). For more information, see [Scheduling parameters](~~137548~~).', 'type' => 'string', 'required' => false, 'example' => 'x=a y=b z=c', 'title' => ''], + ], + [ + 'name' => 'StartEffectDate', + 'in' => 'formData', + 'schema' => ['description' => 'The timestamp (in milliseconds) when automatic scheduling starts.'."\n" + ."\n" + .'This parameter corresponds to the start time of Effective Period in Scheduling > Scheduling Time for Data Studio tasks in the [DataWorks console](https://workbench.data.aliyun.com/console).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'minimum' => '0', 'example' => '936923400000', 'title' => ''], + ], + [ + 'name' => 'EndEffectDate', + 'in' => 'formData', + 'schema' => ['description' => 'The timestamp (in milliseconds) when automatic scheduling stops.'."\n" + ."\n" + .'This parameter corresponds to the end time of Effective Period in Scheduling > Scheduling Time for Data Studio tasks in the [DataWorks console](https://workbench.data.aliyun.com/console).', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'minimum' => '0', 'example' => '4155787800000', 'title' => ''], + ], + [ + 'name' => 'CronExpress', + 'in' => 'formData', + 'schema' => ['description' => 'The cron expression for scheduled execution. This parameter corresponds to the Cron Expression setting in Scheduling > Scheduling Time for Data Studio tasks in the [DataWorks console](https://workbench.data.aliyun.com/console). After you configure Scheduling Cycle and Scheduled Time, DataWorks automatically generates a cron expression.'."\n" + ."\n" + .'Examples:'."\n" + ."\n" + .'- Scheduled at 05:30 every day: `00 30 05 * * ?`'."\n" + ."\n" + .'- Scheduled at the 15th minute of every hour: `00 15 * * * ?`'."\n" + ."\n" + .'- Scheduled every 10 minutes: `00 00/10 * * * ?`'."\n" + ."\n" + .'- Scheduled every 10 minutes between 08:00 and 23:00 every day: `00 00-59/10 8-23 * * * ?`'."\n" + ."\n" + .'- Scheduled at 00:20 on the 1st day of every month: `00 20 00 1 * ?`'."\n" + ."\n" + .'- Scheduled every 3 months starting from 00:10 on January 1: `00 10 00 1 1-12/3 ?`'."\n" + ."\n" + .'- Scheduled at 00:05 on every Tuesday and Friday: `00 05 00 * * 2,5`'."\n" + ."\n" + .'Due to the rules of the DataWorks scheduling system, cron expressions have the following restrictions:'."\n" + ."\n" + .'- The minimum scheduling interval is 5 minutes.'."\n" + ."\n" + .'- The earliest scheduling time each day is 00:05.', 'type' => 'string', 'required' => false, 'example' => '00 00-59/5 1-23 * * ?', 'title' => ''], ], - ], - 'parameters' => [ [ - 'name' => 'DataQualityScanId', + 'name' => 'CycleType', 'in' => 'formData', 'schema' => [ - 'description' => 'The ID of the data quality monitor.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The type of scheduling cycle. Valid values: NOT\\_DAY (minute, hour) and DAY (day, week, month).'."\n" + ."\n" + .'This parameter corresponds to the Scheduling Cycle setting in Scheduling > Scheduling Time for Data Studio tasks in the [DataWorks console](https://workbench.data.aliyun.com/console).', + 'type' => 'string', 'required' => false, - 'example' => '20000001', + 'default' => 'DAY', + 'enum' => ['DAY', 'NOT_DAY'], + 'example' => 'NOT_DAY', + 'title' => '', ], ], [ - 'name' => 'ProjectId', + 'name' => 'DependentType', 'in' => 'formData', 'schema' => [ - 'description' => 'The project ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The dependency mode on the previous cycle. Valid values:'."\n" + ."\n" + .'- SELF: Depends on the current node.'."\n" + ."\n" + .'- CHILD: Depends on the child nodes.'."\n" + ."\n" + .'- USER\\_DEFINE: Depends on other nodes.'."\n" + ."\n" + .'- NONE: No dependencies. Does not depend on the previous cycle.', + 'type' => 'string', 'required' => false, - 'example' => '10000', + 'enum' => ['NONE', 'USER_DEFINE', 'CHILD', 'SELF', 'USER_DEFINE_AND_SELF', 'CHILD_AND_SELF'], + 'example' => 'USER_DEFINE', + 'title' => '', ], ], [ - 'name' => 'Parameters', + 'name' => 'DependentNodeIdList', 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The parameter settings used during the actual run. The `triggerTime` parameter is required.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The parameter settings used during the actual run.'."\n", - 'type' => 'object', - 'properties' => [ - 'Value' => [ - 'description' => 'The parameter value. You can use a scheduling time expression.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-shanghai$[yyyy-mm-dd-1]', - ], - 'Name' => [ - 'description' => 'The parameter name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'regiondt', - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'schema' => ['description' => 'The IDs of the nodes on which the current node depends. This parameter takes effect only when the DependentType parameter is set to USER\\_DEFINE. Separate multiple node IDs with commas (,).'."\n" + ."\n" + .'This parameter corresponds to the Other Nodes option in Properties > Dependencies > Cross-cycle Dependency (Original Previous-cycle Dependency) for data development nodes in the [DataWorks console](https://workbench.data.aliyun.com/console).', 'type' => 'string', 'required' => false, 'example' => '5,10,15,20', 'title' => ''], ], [ - 'name' => 'RuntimeResource', + 'name' => 'InputList', 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The scheduling resource group used when running the data quality monitor. This resource group uses the same data structure as in the scheduling API.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The resource group ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'e9455a13-ff00-4965-833c-337546ba4854', - ], - 'Cu' => [ - 'description' => 'The Compute Resources (CUs) reserved for running the data quality monitor in the resource group.'."\n", - 'type' => 'number', - 'format' => 'float', - 'required' => false, - 'example' => '0.25', - ], - 'Image' => [ - 'description' => 'The image settings used when running the data quality monitor in the resource group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'i-xxxxxx', - ], - ], - 'required' => false, - ], + 'schema' => ['description' => 'The output names of the ancestor nodes on which the current node depends. Separate multiple output names with commas (,).'."\n" + ."\n" + .'This parameter corresponds to the Output Name of Ancestor Node setting in Properties > Dependencies for data development nodes in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n" + ."\n" + .'> This parameter is required when you call the CreateDISyncTask or UpdateFile operation to create a batch synchronization node.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'project_root,project.file1,project.001_out', 'title' => ''], ], - ], - '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' => '0bc14115***159376359', - ], - 'Id' => [ - 'description' => 'The RunId that was successfully triggered.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '248840', - ], - ], - ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => ['description' => 'The DataWorks workspace name. To obtain the workspace name, log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and navigate to the workspace configuration page.'."\n" + ."\n" + .'You must specify either this parameter or ProjectId to identify the target DataWorks workspace for this API call.', 'type' => 'string', 'required' => false, 'example' => 'dw_project', 'title' => ''], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115***159376359\\",\\n \\"Id\\": 248840\\n}","type":"json"}]', - 'title' => 'CreateDataQualityScanRun', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", - ], - 'ListDataQualityScanRuns' => [ - 'summary' => 'Queries the execution records of data quality scans in a project.', - 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'FileId', + 'in' => 'formData', + 'schema' => ['description' => 'The file ID. You can call the [ListFiles](~~173942~~) operation to obtain the file ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '100000001', 'title' => ''], ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdide3WJOKE', + [ + 'name' => 'OutputList', + 'in' => 'formData', + 'schema' => ['description' => 'The outputs of the node.'."\n" + ."\n" + .'This parameter corresponds to the Output Name setting in Properties > Dependencies for data development nodes in the [DataWorks console](https://workbench.data.aliyun.com/console).', 'type' => 'string', 'required' => false, 'example' => 'dw_project.ods_user_info_d', 'title' => ''], ], - ], - 'parameters' => [ [ - 'name' => 'DataQualityScanId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the data quality monitor.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10001', - ], + 'name' => 'ResourceGroupIdentifier', + 'in' => 'formData', + 'schema' => ['description' => 'The resource group for the task published from the file. You can call the [ListResourceGroups](~~173913~~) operation to query the available resource groups in the workspace.', 'type' => 'string', 'required' => false, 'example' => 'default_group', 'title' => ''], ], [ - 'name' => 'CreateTimeFrom', - 'in' => 'query', - 'schema' => [ - 'description' => 'The earliest time when the data quality monitor starts to run.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1710239005403', - ], + 'name' => 'ConnectionName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the data source that is used to run the node. You can call the [ListDataSources](~~211431~~) operation to query the available data sources.', 'type' => 'string', 'required' => false, 'example' => 'odps_source', 'title' => ''], ], [ - 'name' => 'CreateTimeTo', - 'in' => 'query', - 'schema' => [ - 'description' => 'The latest time when the data quality monitor starts to run.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1710239005403', - ], + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => ['description' => 'The file owner ID.', 'type' => 'string', 'required' => false, 'example' => '18023848927592', 'title' => ''], ], [ - 'name' => 'Status', - 'in' => 'query', - 'schema' => [ - 'description' => 'The status of the data quality check result.'."\n" - ."\n" - .'* Pass'."\n" - .'* Running'."\n" - .'* Error'."\n" - .'* Fail'."\n" - .'* Warn'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Fail', - 'enum' => [ - 'Error', - 'Fail', - 'Kill', - 'Pass', - 'Running', - 'Warn', - ], - ], + 'name' => 'AutoParsing', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to enable automatic parsing for the file. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false'."\n" + ."\n" + .'This parameter corresponds to the Analyze Code setting in Properties > Dependencies for data development nodes in the [DataWorks console](https://workbench.data.aliyun.com/console).', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'SortBy', - 'in' => 'query', + 'name' => 'SchedulerType', + 'in' => 'formData', 'schema' => [ - 'description' => 'The list of sorting fields. Supports fields such as last modified time and creation time. Format: "SortField+SortOrder (Desc/Asc)", where Asc is the default. Valid values:'."\n" + 'description' => 'The scheduling type. Valid values:'."\n" ."\n" - .'* CreateTime (Desc/Asc)'."\n" - .'* Id (Desc/Asc)'."\n", + .'- NORMAL: Normal scheduled task.'."\n" + ."\n" + .'- MANUAL: Manually triggered node. Not scheduled for daily execution. Corresponds to nodes in manually triggered workflows.'."\n" + ."\n" + .'- PAUSE: Paused task.'."\n" + ."\n" + .'- SKIP: Dry-run task. Scheduled for daily execution but is directly marked as successful when scheduling starts.', 'type' => 'string', 'required' => false, - 'example' => 'CreateTime Desc', + 'enum' => ['NORMAL', 'SKIP', 'PAUSE', 'MANUAL'], + 'example' => 'NORMAL', + 'title' => '', ], ], [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of records per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'name' => 'AdvancedSettings', + 'in' => 'formData', + 'schema' => ['description' => 'The advanced settings for the task.'."\n" + ."\n" + .'This parameter corresponds to the Advanced Settings in the right-side navigation pane on the editing page for EMR Spark Streaming and EMR Streaming SQL tasks in Data Studio in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n" + ."\n" + .'Currently, only EMR Spark Streaming and EMR Streaming SQL tasks support this parameter, and the parameter must be in JSON format.', 'type' => 'string', 'required' => false, 'example' => '{"queue":"default","SPARK_CONF":"--conf spark.driver.memory=2g"}', 'title' => ''], ], [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number of the results. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'name' => 'StartImmediately', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to start the task immediately after it is published. Valid values:'."\n" + ."\n" + .'- true: Start the task immediately after it is published.'."\n" + ."\n" + .'- false: Do not start the task immediately after it is published.'."\n" + ."\n" + .'This parameter corresponds to the Start Method setting in Configuration > Scheduling Policies in the right-side navigation pane on the editing page for EMR Spark Streaming and EMR Streaming SQL tasks in Data Studio in the [DataWorks console](https://workbench.data.aliyun.com/console).', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The project ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '12345', - ], + 'name' => 'InputParameters', + 'in' => 'formData', + 'schema' => ['description' => 'The input context parameters of the node. The value must be in the JSON format. For more information about the parameter structure, see the InputContextParameterList parameter in the response parameters of the [GetFile](~~173954~~) operation.'."\n" + ."\n" + .'This parameter corresponds to the Input Parameters setting in Properties > Input and Output Parameters for data development nodes 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' => 'Filter', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The extended query filter. Supported parameters:'."\n" - ."\n" - .'* TaskInstanceId'."\n", - 'type' => 'object', - 'required' => false, - 'example' => '{'."\n" - .' "TaskInstanceId": 111L'."\n" - .'}', - ], - ], - ], - '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' => '0bc14115***159376359', - ], - 'PageInfo' => [ - 'description' => 'The page information.'."\n", - 'type' => 'object', - 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of records returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '324', - ], - 'PageSize' => [ - 'description' => 'The number of records per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => 'The page number of the results. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'DataQualityScanRuns' => [ - 'description' => 'The list of data quality monitor run records.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The list of data quality monitor run records.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the data quality monitor running record.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3155', - ], - 'CreateTime' => [ - 'description' => 'The time when the data quality monitor starts running.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], - 'FinishTime' => [ - 'description' => 'The time when the data quality monitor stops.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], - 'Status' => [ - 'description' => 'The status of the instance.'."\n" - ."\n" - .'* Pass'."\n" - .'* Running'."\n" - .'* Error'."\n" - .'* Warn'."\n" - .'* Fail'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Fail', - ], - 'Parameters' => [ - 'description' => 'The parameters configured for the instance.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The parameter information.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The parameter name.'."\n", - 'type' => 'string', - 'example' => 'dt', - ], - 'Value' => [ - 'description' => 'The parameter value. You can use a scheduling time expression.'."\n", - 'type' => 'string', - 'example' => '$[yyyy-mm-dd-1]', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], + 'name' => 'OutputParameters', + 'in' => 'formData', + 'schema' => ['description' => 'The output context parameters of the node. The value must be in the JSON format. For more information about the parameter structure, see the OutputContextParameterList parameter in the response parameters of the [GetFile](~~173954~~) operation.'."\n" + ."\n" + .'This parameter corresponds to the Output Parameters setting in Properties > Input and Output Parameters for data development nodes in the [DataWorks console](https://workbench.data.aliyun.com/console).', 'type' => 'string', 'required' => false, 'example' => '[{"Type": 1,"Value": "${bizdate}","ParameterName": "bizdate_param"}]', 'title' => ''], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115***159376359\\",\\n \\"PageInfo\\": {\\n \\"TotalCount\\": 324,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"DataQualityScanRuns\\": [\\n {\\n \\"Id\\": 3155,\\n \\"CreateTime\\": 1710239005403,\\n \\"FinishTime\\": 1710239005403,\\n \\"Status\\": \\"Fail\\",\\n \\"Parameters\\": [\\n {\\n \\"Name\\": \\"dt\\",\\n \\"Value\\": \\"$[yyyy-mm-dd-1]\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListDataQualityScanRuns', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", - ], - 'GetDataQualityScanRunLog' => [ - 'summary' => 'Queries the log of a specific task instance that monitors data quality.', - 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'IgnoreParentSkipRunningProperty', + 'in' => 'formData', + 'schema' => ['description' => 'This parameter corresponds to the Skip The Dry-Run Property Of The Ancestor Node option in Properties > Dependencies > Cross-cycle Dependency (Original Previous-cycle Dependency) when Instances of Current Node or Level-1 Child Node is selected for data development nodes in the [DataWorks console](https://workbench.data.aliyun.com/console).', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdide3WJOKE', + [ + 'name' => 'ApplyScheduleImmediately', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to apply the scheduling configuration immediately after the file is published.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], - ], - 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the data quality monitor run record.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10001', - ], + 'name' => 'Timeout', + 'in' => 'formData', + 'schema' => ['description' => 'The timeout settings for scheduling configuration.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Offset', - 'in' => 'query', - 'schema' => [ - 'description' => 'The starting position of the log, in bytes, relative to the beginning of the file. Each query returns a maximum of 512 KB of content.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '200', - ], + 'name' => 'ImageId', + 'in' => 'formData', + 'schema' => ['description' => 'The custom image ID.', 'type' => 'string', 'required' => false, 'example' => 'm-uf6d7npxk1hhek8ng0cb', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response.'."\n", + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0bc14115***159376359', - ], - 'LogSegment' => [ - 'description' => 'The task log information.'."\n", - 'type' => 'object', - 'properties' => [ - 'Log' => [ - 'description' => 'The task log.'."\n", - 'type' => 'string', - 'example' => 'Running on Serverless_resource_group_xxxxx'."\n" - .'Begin to check rule ***', - ], - 'NextOffset' => [ - 'description' => 'The starting offset of the next log segment. A value of -1 indicates that all logs have been read.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '512000', - ], - ], - ], + '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. Use this ID to troubleshoot issues.', 'type' => 'string', 'example' => '0000-ABCD-EFGH-IJKLMNOPQ', 'title' => ''], + 'ErrorCode' => ['description' => 'The error code.', 'type' => 'string', 'example' => 'Invalid.Tenant.ConnectionNotExists', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call succeeded. Valid values:'."\n" + ."\n" + .'- true: The call succeeded.'."\n" + ."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115***159376359\\",\\n \\"LogSegment\\": {\\n \\"Log\\": \\"Running on Serverless_resource_group_xxxxx\\\\nBegin to check rule ***\\",\\n \\"NextOffset\\": 512000\\n }\\n}","type":"json"}]', - 'title' => 'GetDataQualityScanRunLog', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", - ], - 'GetDataQualityScanRun' => [ - 'summary' => 'Creates a data quality monitoring run instance.', - 'path' => '', - '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.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', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","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}","type":"json"}]', + 'title' => 'UpdateFile', + 'summary' => 'Updates a file.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'UpdateFolder' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdide3WJOKE', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '268610', + 'abilityTreeNodes' => ['FEATUREdide8FM783'], ], 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => 'The data quality monitoring run record ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1006059507', - ], + '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 specify either this parameter or the ProjectIdentifier parameter to identify the DataWorks workspace when you call this operation.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10000', 'title' => ''], + ], + [ + '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 query the workspace name. You must specify either this parameter or the ProjectId parameter to identify the DataWorks workspace when you call this operation.', 'type' => 'string', 'required' => false, 'example' => 'dw_project', 'title' => ''], + ], + [ + 'name' => 'FolderId', + 'in' => 'formData', + 'schema' => ['description' => 'The folder ID. You can call the [ListFolders](~~173955~~) operation to obtain the folder ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '2735c2c19d58', 'title' => ''], + ], + [ + 'name' => 'FolderName', + 'in' => 'formData', + 'schema' => ['description' => 'The folder name.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'MySecondFolder', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response.'."\n", + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0bc14115****159376359', - ], - 'DataQualityScanRun' => [ - 'description' => 'Data quality monitoring running records.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The running record ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1016440997', - ], - 'CreateTime' => [ - 'description' => 'The time when the data quality monitor starts running.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1706247622000', - ], - 'FinishTime' => [ - 'description' => 'The time when the data quality monitor stops.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1706247622000', - ], - 'Status' => [ - 'description' => 'The current running status.'."\n" - ."\n" - .'* Pass'."\n" - .'* Running'."\n" - .'* Error'."\n" - .'* Warn'."\n" - .'* Fail'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Fail', - ], - 'Scan' => [ - 'description' => 'The snapshot of the data quality monitor configuration at the start of the validation.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The data quality monitor ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '21077', - ], - 'Name' => [ - 'description' => 'The name of the data quality validation task. It can contain digits, letters, Chinese characters, and both half-width and full-width punctuation marks, with a maximum length of 255 characters.'."\n", - 'type' => 'string', - 'example' => 'Hourly partition quality monitoring', - ], - 'Description' => [ - 'description' => 'The description of the data quality validation task. Maximum length: 65,535 characters.'."\n", - 'type' => 'string', - 'example' => 'This is a hourly run data quality evaluation plan.', - ], - 'ProjectId' => [ - 'description' => 'The project ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '164024', - ], - 'CreateTime' => [ - 'description' => 'The creation time of the data quality monitor.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1706247622000', - ], - 'ModifyTime' => [ - 'description' => 'The last update time of the data quality monitor.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1706247622000', - ], - 'CreateUser' => [ - 'description' => 'The creator of the data quality monitor.'."\n", - 'type' => 'string', - 'example' => '7892346529452', - ], - 'ModifyUser' => [ - 'description' => 'The last updater of the data quality monitor.'."\n", - 'type' => 'string', - 'example' => '7892346529452', - ], - 'Owner' => [ - 'description' => 'The owner of the data quality monitor.'."\n", - 'type' => 'string', - 'example' => '7892346529452', - ], - 'Spec' => [ - 'description' => 'The data quality monitor Spec. For more information, see [Data quality Spec configuration description](~~2963394~~).'."\n", - 'type' => 'string', - 'example' => '{'."\n" - .' "datasets": ['."\n" - .' {'."\n" - .' "type": "Table",'."\n" - .' "dataSource": {'."\n" - .' "name": "odps_first",'."\n" - .' "envType": "Prod"'."\n" - .' },'."\n" - .' "tables": ['."\n" - .' "ods_d_user_info"'."\n" - .' ],'."\n" - .' "filter": "pt = $[yyyymmdd-1]"'."\n" - .' }'."\n" - .' ],'."\n" - .' "rules": ['."\n" - .' {'."\n" - .' "assertion": "row_count > 0"'."\n" - .' }, {'."\n" - .' "templateId": "SYSTEM:field:null_value:fixed",'."\n" - .' "pass": "when = 0",'."\n" - .' "name": "The id cannot be empty.",'."\n" - .' "severity": "High",'."\n" - .' "identity": "a-customized-data-quality-rule-uuid"'."\n" - .' }'."\n" - .' ]'."\n" - .'}', - ], - 'Parameters' => [ - 'description' => 'The parameter settings of the data quality monitor.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The parameter settings of the data quality monitor.'."\n", - 'type' => 'object', - 'properties' => [ - 'Value' => [ - 'description' => 'The parameter value.'."\n", - 'type' => 'string', - 'example' => '$[yyyy-mm-dd-1]', - ], - 'Name' => [ - 'description' => 'The parameter name.'."\n", - 'type' => 'string', - 'example' => 'dt', - ], - ], - ], - ], - 'ComputeResource' => [ - 'description' => 'The computing resource settings of the data quality monitor.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the computing resource, which corresponds to the Name attribute in the ComputeResource data structure of the computing resource API.'."\n", - 'type' => 'string', - 'example' => 'emr_cluster_001', - ], - 'Runtime' => [ - 'description' => 'The additional runtime settings of the data quality monitor.'."\n", - 'type' => 'object', - 'properties' => [ - 'Engine' => [ - 'description' => 'The type of the compute engine. Only EMR compute engines support these settings.'."\n" - ."\n" - .'* Hive'."\n" - .'* Spark'."\n" - .'* Kyuubi'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Hive', - ], - 'SparkConf' => [ - 'description' => 'Additional parameters for the Spark engine. Currently, only spark.yarn.queue is supported to specify the queue.'."\n", - 'type' => 'object', - 'example' => 'spark.yarn.queue=dq_queue'."\n", - ], - 'HiveConf' => [ - 'description' => 'Additional parameters for the Hive engine. Currently, only mapreduce.job.queuename is supported to specify the queue.'."\n", - 'type' => 'object', - 'example' => 'mapreduce.job.queuename=dq_queue'."\n", - ], - ], - ], - 'EnvType' => [ - 'description' => 'The workspace environment to which the compute engine belongs.'."\n" - ."\n" - .'* Prod'."\n" - .'* Dev'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Dev', - ], - ], - ], - 'RuntimeResource' => [ - 'description' => 'The resource group used for running the data quality monitor.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The resource group ID.'."\n", - 'type' => 'string', - 'example' => '60597', - ], - 'Cu' => [ - 'description' => 'Reserved CUs for the resource group.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '1', - ], - 'Image' => [ - 'description' => 'The image ID of the run configuration.'."\n", - 'type' => 'string', - 'example' => 'i-xxxx', - ], - ], - ], - 'Trigger' => [ - 'description' => 'The trigger configurations of the data quality monitor.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The trigger method of the data quality monitor.'."\n" - ."\n" - .'* ByManual'."\n" - .'* BySchedule'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'BySchedule', - ], - 'TaskIds' => [ - 'description' => 'If the trigger mode is set to BySchedule, the scheduling task ID must be specified.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The scheduling task ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1014217266', - ], - ], - ], - ], - 'Hooks' => [ - 'description' => 'The hook configurations after the data quality monitor stops.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The hook configurations after the data quality monitor stops.'."\n", - 'type' => 'object', - 'properties' => [ - 'Condition' => [ - 'description' => 'The hook trigger condition. Currently, only one type of expression syntax is supported:'."\n" - ."\n" - .'* Specify combinations of severity levels and validation statuses for multiple rules, such as `results.any { r -> r.status == \'Fail\' && r.rule.severity == \'Normal\' || r.status == \'Error\' && r.rule.severity == \'High\' || r.status == \'Warn\' && r.rule.severity == \'High\' }`. This means the hook is triggered if any executed rule has Fail with Normal severity, Error with High severity, or Warn with High severity. In the conditional expression, the severity value matches that in the Spec code, and the status value matches that in DataQualityResult.'."\n", - 'type' => 'string', - 'example' => 'results.any { r -> r.status == \'fail\' && r.rule.severity == \'High\' }', - ], - 'Type' => [ - 'description' => 'The type of the hook.'."\n" - ."\n" - .'* BlockTaskInstance'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'BlockTaskInstance', - ], - ], - ], - ], - ], - ], - 'Parameters' => [ - 'description' => 'The parameter settings used during the actual running.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Parameter settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Value' => [ - 'description' => 'The parameter value.'."\n", - 'type' => 'string', - 'example' => '$[yyyy-mm-dd-1]', - ], - 'Name' => [ - 'description' => 'The parameter name.'."\n", - 'type' => 'string', - 'example' => 'dt', - ], - ], - ], - ], - 'Results' => [ - 'description' => 'The validation results of each rule.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The validation result of the rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The validation result status.'."\n" - ."\n" - .'* Pass'."\n" - .'* Running'."\n" - .'* Error'."\n" - .'* Warn'."\n" - .'* Fail'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Fail', - ], - 'Details' => [ - 'description' => 'The information about the data quality check.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the data quality check.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The final comparison result status.'."\n" - ."\n" - .'* Pass'."\n" - .'* Error'."\n" - .'* Warn'."\n" - .'* Fail'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Fail', - ], - 'ReferenceValue' => [ - 'description' => 'The reference sample used as the baseline for calculating the CheckedValue.'."\n", - 'type' => 'string', - 'example' => '0.0', - ], - 'CheckValue' => [ - 'description' => 'The final value used for comparison with the threshold.'."\n", - 'type' => 'string', - 'example' => '100.0', - ], - ], - ], - ], - 'Sample' => [ - 'description' => 'The sample value used in the validation.'."\n", - 'type' => 'string', - 'example' => '{'."\n" - .' "value": "100.0"'."\n" - .'}'."\n", - ], - 'CreateTime' => [ - 'description' => 'The time when the validation result is generated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1725506795000', - ], - 'Rule' => [ - 'description' => 'The snapshot of the rule Spec at the start of the validation.'."\n", - 'type' => 'string', - 'example' => '{'."\n" - .' "templateId": "SYSTEM:field:null_value:fixed",'."\n" - .' "pass": "when = 0",'."\n" - .' "name": "The id cannot be empty.",'."\n" - .' "severity": "High",'."\n" - .' "identity": "a-customized-data-quality-rule-uuid"'."\n" - .'}', - ], - ], - ], - ], - ], - ], + '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' => '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' => ''], ], + '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 \\"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' => 'UpdateFolder', + 'summary' => 'Invoke UpdateFolder to update the folder information.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc14115****159376359\\",\\n \\"DataQualityScanRun\\": {\\n \\"Id\\": 1016440997,\\n \\"CreateTime\\": 1706247622000,\\n \\"FinishTime\\": 1706247622000,\\n \\"Status\\": \\"Fail\\",\\n \\"Scan\\": {\\n \\"Id\\": 21077,\\n \\"Name\\": \\"Hourly partition quality monitoring\\",\\n \\"Description\\": \\"This is a hourly run data quality evaluation plan.\\",\\n \\"ProjectId\\": 164024,\\n \\"CreateTime\\": 1706247622000,\\n \\"ModifyTime\\": 1706247622000,\\n \\"CreateUser\\": \\"7892346529452\\",\\n \\"ModifyUser\\": \\"7892346529452\\",\\n \\"Owner\\": \\"7892346529452\\",\\n \\"Spec\\": \\"{\\\\n \\\\\\"datasets\\\\\\": [\\\\n {\\\\n \\\\\\"type\\\\\\": \\\\\\"Table\\\\\\",\\\\n \\\\\\"dataSource\\\\\\": {\\\\n \\\\\\"name\\\\\\": \\\\\\"odps_first\\\\\\",\\\\n \\\\\\"envType\\\\\\": \\\\\\"Prod\\\\\\"\\\\n },\\\\n \\\\\\"tables\\\\\\": [\\\\n \\\\\\"ods_d_user_info\\\\\\"\\\\n ],\\\\n \\\\\\"filter\\\\\\": \\\\\\"pt = $[yyyymmdd-1]\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"rules\\\\\\": [\\\\n {\\\\n \\\\\\"assertion\\\\\\": \\\\\\"row_count > 0\\\\\\"\\\\n }, {\\\\n \\\\\\"templateId\\\\\\": \\\\\\"SYSTEM:field:null_value:fixed\\\\\\",\\\\n \\\\\\"pass\\\\\\": \\\\\\"when = 0\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"The id cannot be empty.\\\\\\",\\\\n \\\\\\"severity\\\\\\": \\\\\\"High\\\\\\",\\\\n \\\\\\"identity\\\\\\": \\\\\\"a-customized-data-quality-rule-uuid\\\\\\"\\\\n }\\\\n ]\\\\n}\\",\\n \\"Parameters\\": [\\n {\\n \\"Value\\": \\"$[yyyy-mm-dd-1]\\",\\n \\"Name\\": \\"dt\\"\\n }\\n ],\\n \\"ComputeResource\\": {\\n \\"Name\\": \\"emr_cluster_001\\",\\n \\"Runtime\\": {\\n \\"Engine\\": \\"Hive\\",\\n \\"SparkConf\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"HiveConf\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n },\\n \\"EnvType\\": \\"Dev\\"\\n },\\n \\"RuntimeResource\\": {\\n \\"Id\\": \\"60597\\",\\n \\"Cu\\": 1,\\n \\"Image\\": \\"i-xxxx\\"\\n },\\n \\"Trigger\\": {\\n \\"Type\\": \\"BySchedule\\",\\n \\"TaskIds\\": [\\n 1014217266\\n ]\\n },\\n \\"Hooks\\": [\\n {\\n \\"Condition\\": \\"results.any { r -> r.status == \'fail\' && r.rule.severity == \'High\' }\\",\\n \\"Type\\": \\"BlockTaskInstance\\"\\n }\\n ]\\n },\\n \\"Parameters\\": [\\n {\\n \\"Value\\": \\"$[yyyy-mm-dd-1]\\",\\n \\"Name\\": \\"dt\\"\\n }\\n ],\\n \\"Results\\": [\\n {\\n \\"Status\\": \\"Fail\\",\\n \\"Details\\": [\\n {\\n \\"Status\\": \\"Fail\\",\\n \\"ReferenceValue\\": \\"0.0\\",\\n \\"CheckValue\\": \\"100.0\\"\\n }\\n ],\\n \\"Sample\\": \\"{\\\\n \\\\\\"value\\\\\\": \\\\\\"100.0\\\\\\"\\\\n}\\\\n\\",\\n \\"CreateTime\\": 1725506795000,\\n \\"Rule\\": \\"{\\\\n \\\\\\"templateId\\\\\\": \\\\\\"SYSTEM:field:null_value:fixed\\\\\\",\\\\n \\\\\\"pass\\\\\\": \\\\\\"when = 0\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"The id cannot be empty.\\\\\\",\\\\n \\\\\\"severity\\\\\\": \\\\\\"High\\\\\\",\\\\n \\\\\\"identity\\\\\\": \\\\\\"a-customized-data-quality-rule-uuid\\\\\\"\\\\n}\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'GetDataQualityScanRun', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", + 'ramActions' => [], ], - 'CreateIdentifyCredential' => [ - 'summary' => 'Creates an identity credential.', - 'path' => '', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateFunction' => [ + 'summary' => 'Updates the basic information about a user-defined function (UDF) in DataStudio. This API operation performs an incremental update. The update information is described by using FlowSpec.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -51177,64 +49869,90 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeNodes' => [ - 'FEATUREdide23ZCHK', - ], + 'abilityTreeCode' => '236014', + 'abilityTreeNodes' => ['FEATUREdideZOYJZL'], ], 'parameters' => [ [ - 'name' => 'IdentifyCredential', + 'name' => 'ProjectId', 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The user credential object.'."\n", - 'required' => false, - 'enumValueTitles' => [], - '$ref' => '#/components/schemas/IdentifyCredential', - ], + '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, 'example' => '10000', 'title' => ''], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => 'The unique identifier of the UDF.'."\n" + ."\n" + .'> This field is of the Long type in SDK versions prior to 8.0.0, and of the String type in SDK versions 8.0.0 and later. This change does not affect normal SDK usage; the parameter will still be returned according to the type defined in the SDK.. However, compilation failures may occur due to the type change only when upgrading the SDK across version 8.0.0. In this case, you must manually update the data type.', 'type' => 'string', 'required' => true, 'example' => '463497880880954XXXX', 'title' => ''], + ], + [ + 'name' => 'Spec', + 'in' => 'formData', + 'schema' => ['description' => 'The unique identifier of the UDF.'."\n" + ."\n" + .'> Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.', 'type' => 'string', 'required' => true, 'example' => '{'."\n" + .' "version": "1.1.0",'."\n" + .' "kind": "Function",'."\n" + .' "spec": {'."\n" + .' "functions": ['."\n" + .' {'."\n" + .' "name": "FunctionName",'."\n" + .' "script": {'."\n" + .' "content": "{\\"name\\": \\"FunctionName\\", \\"datasource\\": {\\"type\\": \\"odps\\", \\"name\\": \\"odps_first\\"}, \\"runtimeResource\\": {\\"resourceGroup\\": \\"S_res_group_XXXX_XXXX\\"}}",'."\n" + .' "path": "XXX/OpenAPI/Function/FunctionName",'."\n" + .' "runtime": {'."\n" + .' "command": "ODPS_FUNCTION"'."\n" + .' }'."\n" + .' },'."\n" + .' "datasource": {'."\n" + .' "name": "odps_first",'."\n" + .' "type": "odps"'."\n" + .' },'."\n" + .' "runtimeResource": {'."\n" + .' "resourceGroup": "S_res_group_XXXX_XXXX"'."\n" + .' }'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .'}', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => '0000-ABCD-EFG****', - ], - 'Data' => [ - 'description' => 'success true or false'."\n", - 'type' => 'string', - 'example' => '{ "HttpStatusCode": 200, "Success": true }', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID. You can troubleshoot issues based on the ID.', 'type' => 'string', 'example' => '12123960-CB2C-5086-868E-C6C1D024****'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'true'."\n" + ."\n" + .'false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0000-ABCD-EFG****\\",\\n \\"Data\\": \\"{ \\\\\\"HttpStatusCode\\\\\\": 200, \\\\\\"Success\\\\\\": true }\\"\\n}","type":"json"}]', - 'title' => 'CreateIdentifyCredential', - 'description' => '> This operation does not support batch processing. If multiple publishing entities are specified in the parameters, only the first one will be processed; the others will be ignored.'."\n", - 'requestParamsDescription' => 'Note: UserType, DataSource.Type, and DataSource.Role must be set to values within the valid enumeration ranges.'."\n", - ], - 'CreateDataAssetTag' => [ - 'summary' => 'Creates a tag.', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"12123960-CB2C-5086-868E-C6C1D024****\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'UpdateFunction', + 'changeSet' => [ + ['createdAt' => '2025-01-13T07:36:02.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'UpdateIDEEventResult' => [ + 'summary' => 'Recalls the check result of the message of an extension point event.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -51243,146 +49961,210 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'abilityTreeCode' => '250989', - 'abilityTreeNodes' => [ - 'FEATUREdideKQ371B', - ], + 'operationType' => 'get', + 'abilityTreeCode' => '269315', + 'abilityTreeNodes' => ['FEATUREdide6ZPSGN'], ], 'parameters' => [ [ - 'name' => 'Key', - 'in' => 'query', - 'schema' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'key1', - 'maxLength' => 128, - 'minLength' => 1, - 'pattern' => '^([^\\x00-\\xff]|[\\w.,;/@\\n-])+$', - ], + 'name' => 'MessageId', + 'in' => 'formData', + 'schema' => ['description' => 'The OpenEvent message ID from DataWorks. When an extension point event is triggered, you can obtain the message ID from the event message.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '8abcb91f-d266-4073-b907-2ed670378ed1'], ], [ - 'name' => 'Values', - 'in' => 'query', - 'style' => 'json', + 'name' => 'ExtensionCode', + 'in' => 'formData', + 'schema' => ['description' => 'The unique identifier of the extension. You can obtain the identifier from the Extensions tab on Open Platform in the [DataWorks console](https://workbench.data.aliyun.com/console).', 'type' => 'string', 'required' => false, 'example' => '8abcb91f-d266-4073-b907-2ed670378ed1', 'title' => ''], + ], + [ + 'name' => 'CheckResult', + 'in' => 'formData', + 'schema' => ['description' => 'The check status of the extension for this extension point event. Valid values:'."\n" + ."\n" + .'- OK: The extension passed the check for this event.'."\n" + ."\n" + .'- FAIL: The extension failed the check for this event. You need to review and resolve the error promptly to avoid affecting subsequent program execution.'."\n" + ."\n" + .'- WARN: The extension passed the check for this event, but with warnings.', 'type' => 'string', 'required' => false, 'example' => 'OK', 'title' => ''], + ], + [ + 'name' => 'CheckResultTip', + 'in' => 'formData', + 'schema' => ['description' => 'A summary of the check result for this extension point event. This message is displayed on your current development page. When the check fails or has warnings, you can use this summary to quickly identify the cause.', 'type' => 'string', 'required' => false, 'example' => 'Succeeded', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The tag values.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'v1', - 'maxLength' => 128, - 'minLength' => 0, - 'pattern' => '^([^\\x00-\\xff]|[\\w.,;/@\\n-])+$', + 'title' => 'Schema of Response', + 'description' => 'The response.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID. Used for troubleshooting errors.', 'type' => 'string', 'example' => '8abcb91f-d266-4073-b907-2ed670378ed1'], ], - 'required' => false, - 'maxItems' => 20, - 'minItems' => 0, + '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' => ''], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8abcb91f-d266-4073-b907-2ed670378ed1\\"\\n}","type":"json"}]', + 'title' => 'UpdateIDEEventResult', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'UpdateMcpServer' => [ + 'summary' => 'Updates an MCP Server.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'Description', - 'in' => 'query', + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => 'TBD', + 'abilityTreeNodes' => ['FEATUREdideYTM537'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the MCP Server to update.', 'type' => 'string', 'required' => true, 'example' => 'my-mcp-server', 'title' => ''], + ], + [ + 'name' => 'Url', + 'in' => 'formData', + 'schema' => ['description' => 'The new service address. The address must start with`https://`.', 'type' => 'string', 'required' => false, 'example' => 'https://example.com/mcp/sse', 'title' => ''], + ], + [ + 'name' => 'Transport', + 'in' => 'formData', 'schema' => [ - 'description' => 'The description of the tag.'."\n", + 'description' => 'The new transport protocol.', 'type' => 'string', 'required' => false, - 'example' => 'This is a description', - 'maxLength' => 1024, - 'minLength' => 0, + 'enum' => ['STREAMABLE_HTTP', 'SSE'], + 'example' => 'SSE', + 'title' => '', ], ], [ - 'name' => 'ValueType', - 'in' => 'query', + 'name' => 'CustomHeaders', + 'in' => 'formData', + 'style' => 'json', + 'schema' => ['description' => 'The new custom request headers, specified as key-value pairs.', 'type' => 'object', 'required' => false, 'example' => '{}', 'title' => ''], + ], + [ + 'name' => 'Visibility', + 'in' => 'formData', 'schema' => [ - 'description' => 'The type of the tag value. Valid values:'."\n" - ."\n" - .'* Boolean'."\n" - .'* Int'."\n" - .'* String'."\n" - .'* Double'."\n", + 'description' => 'The new visibility level.', 'type' => 'string', 'required' => false, - 'enumValueTitles' => [], - 'example' => 'String', - 'enum' => [ - 'Boolean', - 'Int', - 'String', - 'Double', - ], + 'enum' => ['TENANT', 'PROJECT', 'USER'], + 'example' => 'TENANT', + 'title' => '', ], ], [ - 'name' => 'Managers', - 'in' => 'query', + 'name' => 'VisibilityScope', + 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'The tag administrators.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The tag administrator.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '12345', + 'type' => 'object', + 'properties' => [ + 'ProjectIds' => [ + 'type' => 'array', + 'items' => ['description' => 'A workspace ID.', 'type' => 'string', 'required' => false, 'example' => '[3162, 45766, 61258, 68916, 73279]', 'title' => ''], + 'description' => 'The list of workspace IDs that can access the MCP Server. This parameter takes effect only when `Visibility` is set to `PROJECT`.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'UserIds' => [ + 'type' => 'array', + 'items' => ['description' => 'A user ID.', 'type' => 'string', 'required' => false, 'example' => '[123]', 'title' => ''], + 'description' => 'The list of user IDs that can access the MCP Server. This parameter takes effect only when `Visibility` is set to `USER`.', + 'required' => false, + 'title' => '', + 'example' => '', + ], ], + 'description' => 'The new visibility scope. The fields in this object depend on the value of the `Visibility` parameter.', 'required' => false, - 'maxItems' => 20, - 'minItems' => 0, + 'title' => '', + 'example' => '', ], ], ], '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' => '0bc1ec92159376', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '824F80BA-1778-5D8A-BAFF-668A4D9C4CC7'], + 'McpServer' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => '**The name of the MCP Server.**', 'type' => 'string', 'example' => 'my-mcp-server', 'title' => ''], + 'GmtCreateTime' => ['description' => 'The creation time. This value is a millisecond timestamp.', 'type' => 'string', 'format' => 'iso8601', 'example' => '1780555634000', 'title' => ''], + 'GmtModifiedTime' => ['description' => '**The last modification time. This value is a millisecond timestamp.**', 'type' => 'string', 'format' => 'iso8601', 'example' => '1780555634000', 'title' => ''], + ], + 'description' => '- The details of the updated MCP Server.', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'description' => 'The response schema.', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IdempotentParameterMismatch', - 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateMcpServer', + 'description' => '## Description'."\n" + ."\n" + .'This API updates the configuration of a specified MCP Server. Omitted fields retain their original values.'."\n" + ."\n" + .'**Note**: When you modify the`Visibility` parameter, you must provide either`ProjectIds` or`UserIds` in`VisibilityScope` to apply the correct access control scope.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'CreateDataAssetTag', - 'description' => 'This API operation is available only for DataWorks Enterprise Edition or a more advanced edition.'."\n", + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"824F80BA-1778-5D8A-BAFF-668A4D9C4CC7\\",\\n \\"McpServer\\": {\\n \\"Name\\": \\"my-mcp-server\\",\\n \\"GmtCreateTime\\": \\"1780555634000\\",\\n \\"GmtModifiedTime\\": \\"1780555634000\\"\\n }\\n}","type":"json"}]', ], - 'DeleteDataAssetTag' => [ - 'summary' => 'Deletes a tag.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateMetaCollection' => [ + 'summary' => 'Update Data Map collection objects, including Data Map categories and data albums. You can update the collection name, description, and administrator information.'."\n" + .'When updating a data album, the caller must have the AliyunDataWorksFullAccess permission or be the creator or an administrator of the album.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -51391,44 +50173,38 @@ 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'update', 'riskType' => 'none', - 'abilityTreeCode' => '250987', - 'abilityTreeNodes' => [ - 'FEATUREdideKQ371B', - ], + 'abilityTreeCode' => '266814', + 'abilityTreeNodes' => ['FEATUREdideE9XYA6'], ], 'parameters' => [ [ - 'name' => 'Key', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'key1', - 'maxLength' => 128, - 'minLength' => 1, - ], + 'schema' => ['description' => 'The collection ID.', 'type' => 'string', 'required' => true, 'example' => 'as78d756asd', 'title' => ''], ], [ - 'name' => 'Values', + 'name' => 'Name', 'in' => 'query', - 'style' => 'json', + 'schema' => ['description' => 'Updated collection name', 'type' => 'string', 'required' => false, 'example' => 'new_name', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'Updated collection description', 'type' => 'string', 'required' => false, 'example' => 'new comment', 'title' => ''], + ], + [ + 'name' => 'Administrators', + 'in' => 'query', + 'style' => 'simple', 'schema' => [ - 'description' => 'The tag values.'."\n", + 'description' => 'The collection administrator IDs. This parameter is available only for data albums. The administrator must be an account within the same tenant.', 'type' => 'array', - 'items' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'v1', - 'maxLength' => 128, - 'minLength' => 0, - ], + 'items' => ['description' => 'The collection administrator ID.', 'type' => 'string', 'required' => false, 'example' => '123434', 'title' => ''], 'required' => false, - 'maxItems' => 20, - 'minItems' => 0, + 'title' => '', + 'example' => '', ], ], ], @@ -51436,47 +50212,30 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0bc1411515937635973****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '0E1C0122-F79F-5C26-B546-47A321691868'], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IdempotentParameterMismatch', - 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0E1C0122-F79F-5C26-B546-47A321691868\\"\\n}","type":"json"}]', + 'title' => 'Update Data Map Collection Object '."\n", + 'description' => '1. You must purchase DataWorks Professional Edition or a higher edition to use this feature.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc141151593763597*****\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'DeleteDataAssetTag', - 'description' => 'This API operation is available only for DataWorks Enterprise Edition or a more advanced edition.'."\n", + 'ramActions' => [], ], - 'UpdateDataAssetTag' => [ - 'summary' => 'Updates a tag.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateMetaEntity' => [ + 'summary' => 'Updates a metadata entity. You can update custom entities or objects of the extended table type, such as databases, tables, and columns.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -51487,328 +50246,441 @@ 'systemTags' => [ 'operationType' => 'update', 'riskType' => 'none', - 'abilityTreeCode' => '250867', - 'abilityTreeNodes' => [ - 'FEATUREdideKQ371B', - ], + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdideX3KVYR'], 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'Key', - 'in' => 'query', - 'schema' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'key1', - 'maxLength' => 128, - 'minLength' => 1, - ], + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the entity to update. The entity name, entity type, and parent-child relationship are determined by the ID and cannot be modified using this operation.', 'type' => 'string', 'required' => true, 'example' => 'custom_entity-customer_api:api_001', 'title' => ''], ], [ - 'name' => 'Values', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The tag values.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'v1', - 'maxLength' => 128, - 'minLength' => 0, - 'pattern' => '^([^\\x00-\\xff]|[\\w.,;/@\\n-])+$', - ], - 'required' => false, - 'maxItems' => 20, - 'minItems' => 0, - ], + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => ['description' => 'The comment on the entity.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'this is a comment'."\n"], ], [ - 'name' => 'Description', - 'in' => 'query', + 'name' => 'Attributes', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The description of the tag.'."\n", - 'type' => 'string', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The value of the entity attribute.', 'type' => 'string', 'example' => 'value', 'title' => ''], + 'title' => '', + 'description' => 'The entity attributes. Complex values must be serialized into a JSON string.', 'required' => false, - 'example' => 'This is a description.', - 'maxLength' => 1024, - 'minLength' => 0, + 'example' => '[]', ], ], [ - 'name' => 'Managers', - 'in' => 'query', + 'name' => 'CustomAttributes', + 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'The tag administrators.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The tag administrator.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '12345', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'array', + 'items' => ['description' => 'The custom attribute value.', 'type' => 'string', 'example' => '张三', 'title' => ''], + 'title' => '', + 'description' => 'An array of custom attribute values. Currently, only single-value arrays are supported.', + 'example' => '', ], + 'title' => '', + 'description' => 'The custom attribute values. Each key specifies a custom attribute, and its value is an array that can contain at most one item. To delete an attribute value, provide an empty array.', 'required' => false, - 'maxItems' => 20, - 'minItems' => 0, + 'example' => '[]', ], ], ], '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' => '0bc1ec92159376', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'title' => '', 'example' => 'AASFDFSDFG-DFSDF-DFSDFD-SDFSDF'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + 'Result' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the entity.', 'type' => 'string', 'title' => '', 'example' => 'custom_entity-customer_api:api_001'], + 'Success' => ['description' => 'Indicates whether the update was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], + ], + 'title' => '', + 'description' => 'The result of the update operation.', + 'example' => '', ], ], + 'title' => '', + 'description' => 'The data returned in the response.', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IdempotentParameterMismatch', - 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc1ec921****\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'UpdateDataAssetTag', - 'description' => 'This API operation is available only for DataWorks Enterprise Edition or a more advanced edition.'."\n", - ], - 'ListDataAssetTags' => [ - 'summary' => 'Queries a list of tags.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateMetaEntity', + 'description' => 'You must purchase DataWorks Professional Edition or a higher edition to use this operation.', + 'requestParamsDescription' => '## Custom entities'."\n" + ."\n" + .'For custom entities, set `EntityType` to `custom_entity-`. You can update the following items:'."\n" + ."\n" + .'| Field | Supported | Description |'."\n" + .'| ------------------ | --------- | ---------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| `Comment` | Yes | Updates the entity comment. |'."\n" + .'| `Attributes` | Yes | The key must be defined in the corresponding `MetaEntityDef.AttributeDefs`. Providing an unknown key returns an error. |'."\n" + .'| `CustomAttributes` | Yes | The key must be a custom attribute that applies to this entity type. |'."\n" + ."\n" + .'### Attribute rules'."\n" + ."\n" + .'| Item | Description |'."\n" + .'| -------------------- | --------------------------------------------------------------------------------------------------------------- |'."\n" + .'| Update semantics | This is a patch operation. Only the keys provided in the request are updated. Existing attributes are retained. |'."\n" + .'| Delete attribute | To delete an attribute, set its value to `null`. This removes the key from the entity\'s `attributes`. |'."\n" + .'| Required attribute | The system returns an error if you attempt to delete or clear a required attribute. |'."\n" + .'| ENUM attribute | The value must be one of the allowed values defined in `AttributeDef.AllowedValues`. |'."\n" + .'| DATE attribute | The value must be a millisecond timestamp. |'."\n" + .'| ARRAY/JSON attribute | The value must be provided as a JSON string because the API accepts all parameters as strings. |'."\n" + ."\n" + .'Example:'."\n" + ."\n" + .'```json'."\n" + .'{'."\n" + .' "Comment": "Updated custom entity",'."\n" + .' "Attributes": {'."\n" + .' "level": "L2",'."\n" + .' "profile": "{\\"owner\\":\\"data_team\\"}"'."\n" + .' },'."\n" + .' "CustomAttributes": {'."\n" + .' "biz_owner": ["data_team"]'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'## Database object of the extended table type'."\n" + ."\n" + .'Applies to `custom_-database`.'."\n" + ."\n" + .'| Attributes key | Supported | Type/format | Description |'."\n" + .'| ---------------------------- | --------- | ----------- | -------------------------------------------------------------------------------------------------------- |'."\n" + .'| `technicalMetadata.location` | Yes | String | Updates the storage location of the database. This corresponds to the `location` field in Elasticsearch. |'."\n" + .'| `parentMetaEntityId` | No | \\- | The parent-child relationship cannot be updated. Providing this key returns an error. |'."\n" + .'| Other keys | No | \\- | For a shared entity, updating keys that are not on the whitelist returns an error. |'."\n" + ."\n" + .'## Table object of the extended table type'."\n" + ."\n" + .'Applies to `custom_-table`.'."\n" + ."\n" + .'| Attributes key | Supported | Type/format | Description |'."\n" + .'| ---------------------------------------- | --------- | ---------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| `tableType` | Yes | String | Updates the table type. |'."\n" + .'| `partitionKeys` | Yes | JSON array string or String | If you provide an array, the system joins the items with commas to create the final string. For example, `["dt","hh"]` becomes `dt,hh`. |'."\n" + .'| `technicalMetadata.owner` | Yes | String | Updates the owner. |'."\n" + .'| `technicalMetadata.location` | Yes | String | Updates the storage location. |'."\n" + .'| `technicalMetadata.compressed` | Yes | Boolean | Supports `true` and `false`. |'."\n" + .'| `technicalMetadata.inputFormat` | Yes | String | Updates the InputFormat. |'."\n" + .'| `technicalMetadata.outputFormat` | Yes | String | Updates the OutputFormat. |'."\n" + .'| `technicalMetadata.serializationLibrary` | Yes | String | Updates the SerDe class. |'."\n" + .'| `technicalMetadata.parameters` | Yes | JSON object string or String | If you provide a JSON object, the system serializes it into a string and writes it to the `parameters` attribute. |'."\n" + .'| `parentMetaEntityId` | No | \\- | The parent database cannot be updated. Providing this key returns an error. |'."\n" + .'| `columns` | No | \\- | You cannot modify the column list using the `UpdateMetaEntity` operation. Instead, update each column entity individually. |'."\n" + .'| Other keys | No | \\- | For a shared entity, updating keys that are not on the whitelist returns an error. |'."\n" + ."\n" + .'Example:'."\n" + ."\n" + .'```json'."\n" + .'{'."\n" + .' "Comment": "Updated table description",'."\n" + .' "Attributes": {'."\n" + .' "tableType": "VIEW",'."\n" + .' "partitionKeys": "[\\"dt\\"]",'."\n" + .' "technicalMetadata.location": "oss://bucket/ods/order_fact",'."\n" + .' "technicalMetadata.compressed": "true",'."\n" + .' "technicalMetadata.parameters": "{\\"retention\\":\\"30\\"}"'."\n" + .' },'."\n" + .' "CustomAttributes": {'."\n" + .' "biz_owner": ["data_team"]'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'## Column object of the extended table type'."\n" + ."\n" + .'Applies to `custom_-column`.'."\n" + ."\n" + .'| Attributes key | Supported | Type/format | Description |'."\n" + .'| -------------------- | --------- | ----------- | ------------------------------------------------------------------------------------------------------------ |'."\n" + .'| `type` | Yes | String | Updates the column type. |'."\n" + .'| `position` | Yes | Integer | Updates the column position. |'."\n" + .'| `partitionKey` | Yes | Boolean | Sets whether the column is a partition key. This corresponds to the `isPartitionKey` field in Elasticsearch. |'."\n" + .'| `primaryKey` | Yes | Boolean | Sets whether the column is a primary key. This corresponds to the `isPrimaryKey` field in Elasticsearch. |'."\n" + .'| `foreignKey` | Yes | Boolean | Sets whether the column is a foreign key. This corresponds to the `isForeignKey` field in Elasticsearch. |'."\n" + .'| `parentMetaEntityId` | No | \\- | The parent table cannot be updated. Providing this key returns an error. |'."\n" + .'| Other keys | No | \\- | For a shared entity, updating keys that are not on the whitelist returns an error. |'."\n" + ."\n" + .'The request fails if the parent table does not exist, does not belong to the current tenant, or does not have inline columns.'."\n" + ."\n" + .'Example:'."\n" + ."\n" + .'```json'."\n" + .'{'."\n" + .' "Comment": "Order ID",'."\n" + .' "Attributes": {'."\n" + .' "type": "BIGINT",'."\n" + .' "position": "1",'."\n" + .' "primaryKey": "true"'."\n" + .' },'."\n" + .' "CustomAttributes": {'."\n" + .' "security_level": ["P1"]'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'## Unsupported operations'."\n" + ."\n" + .'| Item | Conclusion |'."\n" + .'| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| Modify entity name | Not supported. The name is derived from the `Id`. |'."\n" + .'| Modify EntityType | Not supported. The type is derived from the `Id`. |'."\n" + .'| Modify parent entity | Not supported. Providing `attributes.parentMetaEntityId` returns an error. |'."\n" + .'| Modify column list | Not supported. Providing `attributes.columns` returns an error. |'."\n" + .'| Create new columns | Not supported. To add columns to an extended table, specify them in the `Attributes.columns` parameter when you create the table using the `BatchCreateMetaEntities` operation. |', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AASFDFSDFG-DFSDF-DFSDFD-SDFSDF\\",\\n \\"Success\\": true,\\n \\"Result\\": {\\n \\"Id\\": \\"custom_entity-customer_api:api_001\\",\\n \\"Success\\": true\\n }\\n}","type":"json"}]', + ], + 'UpdateMetaEntityDef' => [ + 'summary' => 'Updates a meta entity definition. This operation supports both custom and extended table entity types.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'update', 'riskType' => 'none', - 'abilityTreeCode' => '250731', - 'abilityTreeNodes' => [ - 'FEATUREdideKQ371B', - ], + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdideX3KVYR'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'Key', - 'in' => 'query', - 'schema' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'key1', - 'maxLength' => 128, - 'minLength' => 1, - ], + 'name' => 'EntityType', + 'in' => 'formData', + 'schema' => ['description' => 'The entity type.', 'type' => 'string', 'required' => true, 'example' => 'custom_entity-customer_api', 'title' => ''], ], [ - 'name' => 'Category', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the tag. Valid values:'."\n" - ."\n" - .'* Normal'."\n" - .'* System'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Normal', - 'enum' => [ - 'Normal', - 'System', - ], - ], + 'name' => 'DisplayName', + 'in' => 'formData', + 'schema' => ['description' => 'The new display name. The maximum length is 32 characters.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'Business API'], ], [ - 'name' => 'PageNumber', - 'in' => 'query', + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['description' => 'The new description.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'description'], + ], + [ + 'name' => 'NewAttributeDefs', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'type' => 'array', + 'items' => ['description' => 'The attribute definition.', '$ref' => '#/components/schemas/MetaEntityAttributeDef', 'required' => false, 'title' => '', 'example' => ''], + 'maxItems' => 100, + 'title' => '', + 'description' => 'The new attribute definitions. New attributes must be optional.', 'required' => false, - 'maximum' => '200', - 'minimum' => '1', - 'example' => '1', - 'default' => '1', + 'example' => '[]', ], ], [ - 'name' => 'PageSize', - 'in' => 'query', + 'name' => 'UpdateAttributeDefs', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'type' => 'array', + 'items' => ['description' => 'The attribute definition.', '$ref' => '#/components/schemas/MetaEntityAttributeDef', 'required' => false, 'title' => '', 'example' => ''], + 'maxItems' => 100, + 'title' => '', + 'description' => 'The updates to existing attribute definitions. You can modify only the display name and description. You can also add enumerated values for attributes of the ENUM type.', 'required' => false, - 'example' => '10', - 'default' => '10', - 'maximum' => '100', - 'minimum' => '1', + 'example' => '[]', ], ], ], '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' => '0bc1ec92159376****', - ], - 'PagingInfo' => [ - 'description' => 'The pagination information.'."\n", - 'type' => 'object', - 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2524', - ], - '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', - ], - 'DataAssetTags' => [ - 'description' => 'The tags.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The tag.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'key1', - ], - 'Category' => [ - 'description' => 'The type of the tag.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Normal'."\n" - .'* System'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Normal', - ], - 'Description' => [ - 'description' => 'The description of the tag.'."\n", - 'type' => 'string', - 'example' => 'This is a description', - ], - 'ValueType' => [ - 'description' => 'The type of the tag value.'."\n", - 'type' => 'string', - 'example' => 'String', - ], - 'Values' => [ - 'description' => 'The tag values.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => 'v1', - ], - ], - 'Managers' => [ - 'description' => 'The tag administrators.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The employee ID of the tag administrator.'."\n", - 'type' => 'string', - 'example' => '12345', - ], - ], - 'ModifyTime' => [ - 'description' => 'The time when the tag was last modified.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1735890003000', - ], - 'CreateTime' => [ - 'description' => 'The time when the tag was created.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1735890003000', - ], - 'CreateUser' => [ - 'description' => 'The creator of the tag.'."\n", - 'type' => 'string', - 'example' => '12345', - ], - 'ModifyUser' => [ - 'description' => 'The user who last modified the tag.'."\n", - 'type' => 'string', - 'example' => '1234', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => 'E08F38AB-3BA0-5047-8E9E-9AA4839263EA'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], + 'title' => '', + 'description' => 'The returned data.', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateMetaEntityDef', + 'description' => 'This operation requires DataWorks Professional Edition or a later version.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc1ec92159376****\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 2524,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"DataAssetTags\\": [\\n {\\n \\"Key\\": \\"key1\\",\\n \\"Category\\": \\"Normal\\",\\n \\"Description\\": \\"This is a description\\",\\n \\"ValueType\\": \\"String\\",\\n \\"Values\\": [\\n \\"v1\\"\\n ],\\n \\"Managers\\": [\\n \\"12345\\"\\n ],\\n \\"ModifyTime\\": 1735890003000,\\n \\"CreateTime\\": 1735890003000,\\n \\"CreateUser\\": \\"12345\\",\\n \\"ModifyUser\\": \\"1234\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListDataAssetTags', - 'description' => 'This API operation is available only for DataWorks Enterprise Edition or a more advanced edition.'."\n", + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E08F38AB-3BA0-5047-8E9E-9AA4839263EA\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], - 'TagDataAssets' => [ - 'summary' => 'Adds tags to data assets.', - 'methods' => [ - 'post', + 'UpdateNode' => [ + 'summary' => 'Updates the basic information about a node in DataStudio. This API operation performs an incremental update. The update information is described by using FlowSpec.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236780', + 'abilityTreeNodes' => ['FEATUREdideHO4TQP', 'FEATUREdide8FM783', 'FEATUREdideQUQUVB', 'FEATUREdideIQU97M'], + ], + '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 query the ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000', 'title' => ''], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => 'The unique identifier of the Data Studio node.'."\n" + ."\n" + .'> This field is of the Long type in SDK versions prior to 8.0.0, and of the String type in SDK versions 8.0.0 and later. This change does not affect normal SDK usage; the parameter will still be returned according to the type defined in the SDK. However, compilation failures may occur due to the type change only when upgrading the SDK across version 8.0.0. In this case, you must manually update the data type.', 'type' => 'string', 'required' => true, 'example' => '860438872620113XXXX', 'title' => ''], + ], + [ + 'name' => 'Spec', + 'in' => 'formData', + 'schema' => ['description' => 'The unique identifier of the Data Studio node.'."\n" + ."\n" + .'> This field is of the Long type in SDK versions prior to 8.0.0, and of the String type in SDK versions 8.0.0 and later. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.', 'type' => 'string', 'required' => true, 'example' => '{'."\n" + .' "version": "1.1.0",'."\n" + .' "kind": "Node",'."\n" + .' "spec": {'."\n" + .' "nodes": ['."\n" + .' {'."\n" + .' "id": "860438872620113XXXX",'."\n" + .' "recurrence": "Normal",'."\n" + .' "timeout": 0,'."\n" + .' "instanceMode": "T+1",'."\n" + .' "rerunMode": "Allowed",'."\n" + .' "rerunTimes": 3,'."\n" + .' "rerunInterval": 180000,'."\n" + .' "datasource": {'."\n" + .' "name": "odps_test"'."\n" + .' },'."\n" + .' "script": {'."\n" + .' "path": "XX/OpenAPI_Test/odpsSQL_Test",'."\n" + .' "runtime": {'."\n" + .' "command": "ODPS_SQL"'."\n" + .' },'."\n" + .' "content": "select now();"'."\n" + .' },'."\n" + .' "trigger": {'."\n" + .' "type": "Scheduler",'."\n" + .' "cron": "00 00 00 * * ?",'."\n" + .' "startTime": "1970-01-01 00:00:00",'."\n" + .' "endTime": "9999-01-01 00:00:00",'."\n" + .' "timezone": "Asia/Shanghai",'."\n" + .' "delaySeconds": 0'."\n" + .' },'."\n" + .' "runtimeResource": {'."\n" + .' "resourceGroup": "S_res_group_XXXX_XXXX"'."\n" + .' },'."\n" + .' "name": "odpsSQL_Test",'."\n" + .' "inputs": {'."\n" + .' "nodeOutputs": ['."\n" + .' {'."\n" + .' "data": "project_root",'."\n" + .' "artifactType": "NodeOutput"'."\n" + .' }'."\n" + .' ]'."\n" + .' },'."\n" + .' "outputs": {'."\n" + .' "nodeOutputs": ['."\n" + .' {'."\n" + .' "data": "output_data",'."\n" + .' "artifactType": "NodeOutput",'."\n" + .' "refTableName": "odpsSQL_Test"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' }'."\n" + .' ],'."\n" + .' "flow": ['."\n" + .' {'."\n" + .' "nodeId": "860438872620113XXXX",'."\n" + .' "depends": ['."\n" + .' {'."\n" + .' "type": "Normal",'."\n" + .' "output": "project_root"'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .'}', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID. You can troubleshoot issues based on the ID.', 'type' => 'string', 'example' => '99EBE7CF-69C0-5089-BE3E-79563C31****'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"99EBE7CF-69C0-5089-BE3E-79563C31****\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'UpdateNode', + 'changeSet' => [ + ['createdAt' => '2025-01-13T07:36:01.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'UpdateParameter' => [ + 'summary' => 'Updates a parameter. This operation performs an incremental update and modifies only the specified fields.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -51818,7189 +50690,5182 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'abilityTreeCode' => '253894', - 'abilityTreeNodes' => [ - 'FEATUREdideKQ371B', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB'], + 'autoTest' => true, ], 'parameters' => [ [ - 'name' => 'Tags', - 'in' => 'query', + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => 'The parameter ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '12345', 'title' => ''], + ], + [ + 'name' => 'Properties', + 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'The tags that you want to add to data assets.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'The tag that you want to add to data assets, in the key:value structure.'."\n", 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'key', - 'maxLength' => 128, - 'minLength' => 1, - 'pattern' => '^[\\u4E00-\\u9FA5A-Za-z0-9_\\-@#*<>|\\[\\]()+=&%$!~]+$', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", + 'EnvType' => [ + 'description' => 'The project environment.'."\n" + ."\n" + .'- `Prod`: the production environment'."\n" + ."\n" + .'- `Dev`: the development environment', 'type' => 'string', + 'example' => 'Prod', + 'enum' => ['Prod', 'Dev'], 'required' => false, - 'example' => 'value', - 'maxLength' => 128, - 'minLength' => 0, - 'pattern' => '^[\\u4E00-\\u9FA5A-Za-z0-9_\\-@#*<>|\\[\\]()+=&%$.!~]+$', + 'title' => '', ], + 'Value' => ['description' => 'The parameter value.', 'type' => 'string', 'example' => 'value123', 'required' => false, 'title' => ''], ], - 'required' => true, - ], - 'required' => true, - 'maxItems' => 20, - 'minItems' => 1, - ], - ], - [ - 'name' => 'DataAssetIds', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The data asset IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data asset ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '7259557000', - ], - 'required' => true, - 'maxItems' => 100, - 'minItems' => 1, - ], - ], - [ - 'name' => 'DataAssetType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the data asset. Valid values:'."\n" - ."\n" - .'* ACS::DataWorks::Table'."\n" - .'* ACS::DataWorks::Task'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [], - 'example' => 'ACS::DataWorks::Task', - 'enum' => [ - 'ACS::DataWorks::Task', - 'ACS::DataWorks::Table', + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], - ], - ], - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', 'required' => false, - 'example' => '10000', + 'description' => 'The parameter value configuration. This parameter is required for the production environment. If you specify the same environment multiple times, only the first configuration is used.', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'EnvType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The environment of the workspace to which the data asset belongs. Valid values:'."\n" - ."\n" - .'* Dev: development environment'."\n" - .'* Prod: production environment'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Prod', - 'enum' => [ - 'Dev', - 'Prod', - ], - ], + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => ['description' => 'The owner\'s account ID.', 'type' => 'string', 'required' => false, 'example' => '123456789', 'title' => ''], ], [ - 'name' => 'AutoTraceEnabled', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable lineage-based automatic backtracking.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['description' => 'The parameter description.', 'type' => 'string', 'example' => 'This is a test parameter.', 'required' => false, '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' => '0bc1ec92159376', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], + 'Version' => ['description' => 'The new version number.', 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', 'title' => ''], ], + 'title' => '', + 'description' => 'The response data.', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IdempotentParameterMismatch', - 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateParameter', + 'description' => 'This operation is available only in DataWorks Professional Edition and later.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', - 'title' => 'TagDataAssets', - 'description' => 'This API operation is available only for DataWorks Enterprise Edition or a more advanced edition.'."\n", + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Version\\": 2,\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]', + 'translator' => 'manual', ], - 'UnTagDataAssets' => [ - 'summary' => 'Removes tags from data assets.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'UpdateProcessDefinition' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'abilityTreeCode' => '253905', - 'abilityTreeNodes' => [ - 'FEATUREdideKQ371B', - ], + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '244492', + 'abilityTreeNodes' => ['FEATUREdideYTM537'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'Tags', - 'in' => 'query', + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the process definition.', 'type' => 'string', 'required' => true, 'example' => '177554881536128', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the process definition.', 'type' => 'string', 'required' => false, 'example' => 'MaxCompute 表审批', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['description' => 'The description of the process definition.', 'type' => 'string', 'required' => false, 'example' => 'lwt_ide_simple 项目 MaxCompute 表审批策略', 'title' => ''], + ], + [ + 'name' => 'RuleConditions', + 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'The tags that you want to remove.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'The tag that you want to remove, in the key:value structure.'."\n", 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'key', - 'maxLength' => 128, - 'minLength' => 1, - 'pattern' => '^[\\u4E00-\\u9FA5A-Za-z0-9_\\-@#*<>|\\[\\]()+=&%$!~]+$', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'value', - 'maxLength' => 128, - 'minLength' => 0, - 'pattern' => '^[\\u4E00-\\u9FA5A-Za-z0-9_\\-@#*<>|\\[\\]()+=&%$!.~]+$', - ], + 'Type' => ['description' => 'The type of the condition. Valid values:'."\n" + ."\n" + .'- `odpsProject`'."\n" + ."\n" + .'- `hologresInstanceId`'."\n" + ."\n" + .'- `sensibleLevel`'."\n" + ."\n" + .'- `tableGuid`'."\n" + ."\n" + .'- `projectId`', 'type' => 'string', 'required' => false, 'example' => 'odpsProject', 'title' => ''], + 'Scope' => ['description' => 'The phase in which the rule takes effect. Valid values:'."\n" + ."\n" + .'- **Deployment**: Determines whether the approval policy applies when an application is submitted.'."\n" + ."\n" + .'- **Running**: Determines whether to skip the approval during the approval process. This phase is supported only for MaxCompute.', 'type' => 'string', 'required' => false, 'example' => 'Deployment', 'title' => ''], + 'Expression' => ['description' => 'The conditional expression. Format: ((#type==\'typeValue\')). For example: ((#odpsProject==\'PX\\_BEIJING\\_TEST\')).', 'type' => 'string', 'required' => false, 'example' => '((#odpsProject==\'PX_BEIJING_TEST\'))', 'title' => ''], ], - 'required' => true, + 'description' => 'A rule condition.', + 'required' => false, + 'title' => '', + 'example' => '', ], - 'required' => true, - 'maxItems' => 20, - 'minItems' => 1, + 'required' => false, + 'description' => 'A list of rule conditions. This parameter does not apply to system policies.', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'DataAssetIds', - 'in' => 'query', + 'name' => 'NotificationServices', + 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'The data asset IDs.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'The data asset ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '7259557000', + 'type' => 'object', + 'properties' => [ + 'Channel' => ['description' => 'The notification channel. Valid values:'."\n" + ."\n" + .'- Mail'."\n" + ."\n" + .'- Sms'."\n" + ."\n" + .'- DingRobot'."\n" + ."\n" + .'- Weixin', 'type' => 'string', 'required' => false, 'example' => 'Mail', 'title' => ''], + 'Extension' => ['description' => 'Additional information in JSON format. For example, use {"atAll":"true"} to specify whether to notify all members.', 'type' => 'string', 'required' => false, 'example' => '{"atAll":"true"}', 'title' => ''], + 'Receiver' => ['description' => 'The webhook URL. This parameter is required when `Channel` is set to `DingRobot` or `Weixin`.', 'type' => 'string', 'required' => false, 'example' => 'https://dingtalk.com', 'title' => ''], + ], + 'description' => 'A notification service.', + 'required' => false, + 'title' => '', + 'example' => '', ], - 'required' => true, - 'maxItems' => 100, - 'minItems' => 1, + 'description' => 'The notification service configurations.', + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'DataAssetType', - 'in' => 'query', + 'name' => 'ApprovalNodes', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The type of the data asset. Valid values:'."\n" - ."\n" - .'* ACS::DataWorks::Table'."\n" - .'* ACS::DataWorks::Task'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [], - 'example' => 'ACS::DataWorks::Task', - 'enum' => [ - 'ACS::DataWorks::Task', - 'ACS::DataWorks::Table', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the node.', 'type' => 'string', 'required' => false, 'example' => 'default-name', 'title' => ''], + 'AccountType' => ['description' => 'The approver type for the node. Valid values:'."\n" + ."\n" + .'- `DataWorksProjectRole`: A workspace role.'."\n" + ."\n" + .'- `DataWorksProjectMember`: A workspace member.'."\n" + ."\n" + .'- `TableAdministrator`: A table administrator.'."\n" + ."\n" + .'- `TableOrProjectAdministrator`: The administrator of the table or project.'."\n" + ."\n" + .'- `AliyunResourceOwner`: An Alibaba Cloud account.'."\n" + ."\n" + .'- `MaxComputeRole`: A MaxCompute administrator.'."\n" + ."\n" + .'- `DLFAdmin`: A DlfLegacy administrator.'."\n" + ."\n" + .'- `DLFNextAdmin`: A DLFNext administrator.'."\n" + ."\n" + .'- `TenantRole`: A tenant role.'."\n" + ."\n" + .'- `EmrAdministrator`: An EMR administrator.'."\n" + ."\n" + .'- `LindormAdministrator`: A Lindorm administrator.'."\n" + ."\n" + .'- `AliyunRamUser`: A RAM user.', 'type' => 'string', 'required' => false, 'example' => 'TableOrProjectAdministrator', 'title' => ''], + 'Assignees' => ['description' => 'Specifies the approvers. The required value depends on the `AccountType`:'."\n" + ."\n" + .'- If `AccountType` is `DataWorksProjectMember`, this parameter specifies the user IDs of workspace members.'."\n" + ."\n" + .'- If `AccountType` is `DataWorksProjectRole`, this parameter specifies the codes of workspace roles.'."\n" + ."\n" + .'- If `AccountType` is `MaxComputeRole`, this parameter specifies the MaxCompute roles.'."\n" + ."\n" + .'- If `AccountType` is `TenantRole`, this parameter specifies the codes of tenant roles.'."\n" + ."\n" + .'- If `AccountType` is `AliyunRamUser`, this parameter specifies the user IDs of RAM users.', 'type' => 'string', 'required' => false, 'example' => 'DataWorksProjectMember', 'title' => ''], + 'ExtensionProperties' => [ + 'type' => 'object', + 'additionalProperties' => ['description' => 'Additional properties.', 'type' => 'any', 'example' => '{'."\n" + .' "449656": "role_project_admin,role_project_pe"'."\n" + .' }', 'title' => ''], + 'description' => 'Additional properties that are required for specific `AccountType` values:'."\n" + ."\n" + .'- If `AccountType` is `DataWorksProjectMember`: The key is `projectId` and the value is the user ID of a workspace member. Use commas (,) to separate multiple user IDs.'."\n" + ."\n" + .'- If `AccountType` is `MaxComputeRole`: The key is the MaxCompute project name and the value is the role name in MaxCompute. Use commas (,) to separate multiple role names.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'An approval node.', + 'required' => false, + 'title' => '', + 'example' => '', ], + 'required' => false, + 'description' => 'A list of approval nodes. This parameter does not apply to system policies.', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ProjectId', - 'in' => 'query', + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => ['description' => 'An idempotent parameter. It ensures that retried requests do not result in duplicate operations.', 'type' => 'string', 'required' => false, 'example' => '1AFAE64E-D1BE-432B-A9****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '0bc5df3a17****903790e8e8a'], + ], + 'title' => '', + 'description' => 'The data returned for the request.', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateProcessDefinition', + 'summary' => 'Updates an existing approval process definition.', + 'description' => '## Request'."\n" + ."\n" + .'- Use this API to modify an existing approval process definition, including its name, description, rule conditions, notification service, and approval nodes.'."\n" + ."\n" + .'- The required `Id` parameter identifies the approval process definition to update.'."\n" + ."\n" + .'- To overwrite the existing configuration, set the `Overwrite` parameter to `true`.'."\n" + ."\n" + .'- The optional `ClientToken` parameter ensures request idempotency.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc5df3a17****903790e8e8a\\"\\n}","type":"json"}]', + ], + 'UpdateProject' => [ + 'summary' => 'This operation updates a DataWorks workspace.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '244492', + 'abilityTreeNodes' => ['FEATUREdideYTM537'], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ [ - 'name' => 'EnvType', - 'in' => 'query', + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the DataWorks workspace. To find the workspace ID, log in to the [DataWorks console](https://dataworks.console.aliyun.com/workspace/list) and go to the Workspace Management page.'."\n" + ."\n" + .'This parameter specifies the DataWorks workspace to use for the API call.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123456', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['description' => 'An optional description of the workspace.', 'type' => 'string', 'required' => false, 'example' => 'Financial analysis group project data development', 'title' => ''], + ], + [ + 'name' => 'Status', + 'in' => 'formData', 'schema' => [ - 'description' => 'The environment of the workspace to which the data asset belongs. Valid values:'."\n" + 'description' => 'Specifies whether to enable or disable the workspace. Valid values:'."\n" ."\n" - .'* Dev: development environment'."\n" - .'* Prod: production environment'."\n", + .'- `Available`: Enables the workspace.'."\n" + ."\n" + .'- `Forbidden`: Disables the workspace.', + 'enumValueTitles' => [], 'type' => 'string', + 'enum' => ['Forbidden', 'Available'], 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Prod', - 'enum' => [ - 'Prod', - 'Dev', - ], + 'example' => 'Forbidden', + 'title' => '', ], ], + [ + 'name' => 'DevEnvironmentEnabled', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to enable the development environment. Valid values:'."\n" + ."\n" + .'- `true`: Enables the development environment for the workspace and isolates it from the production environment.'."\n" + ."\n" + .'- `false`: Uses only the production environment.'."\n" + ."\n" + .'**Important**: You cannot disable the development environment after you enable it.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'DevRoleDisabled', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to disable the development role, which grants permissions for workflow and code editing. Valid values:'."\n" + ."\n" + .'- `false`: Enables the development role. This is the default value.'."\n" + ."\n" + .'- `true`: Disables the development role.'."\n" + ."\n" + .'**Important**: After you enable the development role (by setting this parameter to `false`), you cannot disable it.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'DisplayName', + 'in' => 'formData', + 'schema' => ['description' => 'The display name of the workspace.', 'type' => 'string', 'required' => false, 'example' => 'Sora financial analysis Space', 'title' => ''], + ], + [ + 'name' => 'PaiTaskEnabled', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to enable task scheduling for Machine Learning Platform for AI (PAI). Valid values:'."\n" + ."\n" + .'- `true`: You can create PAI nodes in the DataWorks workspace and run them on a schedule.'."\n" + ."\n" + .'- `false`: Disables task scheduling for PAI.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '8754EE08-4AA2-5F77-ADD7-754DBBDA9F75', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The Request ID. Use this ID to troubleshoot issues.', 'type' => 'string', 'example' => 'AFBB799F-8578-51C5-A766-E922EDB8XXXX'."\n"], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IdempotentParameterMismatch', - 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AFBB799F-8578-51C5-A766-E922EDB8XXXX\\\\n\\"\\n}","type":"json"}]', + 'title' => 'UpdateProject', + 'description' => 'This feature requires DataWorks Basic Edition or a later version.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:UpdateProject', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8754EE08-4AA2-5F77-ADD7-754DBBDA9F75\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', - 'title' => 'UnTagDataAssets', - 'description' => 'This API operation is available only for DataWorks Enterprise Edition or a more advanced edition.'."\n", ], - 'ListDataAssets' => [ - 'summary' => 'Queries the information about DataWorks data assets to which tags are added by page.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'UpdateProjectRole' => [ + 'summary' => 'Updates the permissions of a custom role in a workspace.', + 'path' => '', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'abilityTreeCode' => '253908', - 'abilityTreeNodes' => [ - 'FEATUREdideKQ371B', - ], + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '244504', + 'abilityTreeNodes' => ['FEATUREdideYTM537'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'Tags', + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the DataWorks workspace. You can log on to the [DataWorks console](https://dataworks.console.aliyun.com/workspace/list) and go to the workspace management page to obtain the ID.'."\n" + ."\n" + .'This parameter specifies the DataWorks workspace on which the API operation is performed.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '234', 'title' => ''], + ], + [ + 'name' => 'Code', + 'in' => 'query', + 'schema' => ['description' => 'The unique identifier of the custom role.', 'type' => 'string', 'required' => true, 'example' => 'base_role_xx', 'title' => ''], + ], + [ + 'name' => 'ModulePermissions', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'The tags that are added to data assets. This parameter specifies a filter condition.'."\n" - ."\n" - .'* You can specify multiple tags, which are in the logical OR relation. For example, you can query the data assets that contain one of the following tags: `["key1:v1", "key2:v1", "key3:v1"]`.'."\n" - .'* If you do not configure this parameter, tag-based filtering is not performed.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'The tag that is added to the data asset. The tag is specified in the key:value structure.'."\n", 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n" + 'ModuleId' => [ + 'description' => 'The DataWorks module ID. Valid values:'."\n" ."\n" - .'The tag key can be up to 64 characters in length and can contain letters, digits, and the following characters: `-@#*<>|[]()+=&%$!~`. It cannot start with `dw:`.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'key', - 'pattern' => '^[\\u4E00-\\u9FA5A-Za-z0-9_\\-@#*<>|\\[\\]()+=&%$!~]+$', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', + .'- 2: HoloStudio'."\n" + ."\n" + .'- 3: StreamStudio'."\n" + ."\n" + .'- 4: Deployment Center'."\n" + ."\n" + .'- 6: Data Security Guard'."\n" + ."\n" + .'- 7: Data Map'."\n" + ."\n" + .'- 8: Data Service'."\n" + ."\n" + .'- 9: Data Integration'."\n" + ."\n" + .'- 10: Data Modeling (DataBlau DDM)'."\n" + ."\n" + .'- 11: Data Studio'."\n" + ."\n" + .'- 12: Data Quality'."\n" + ."\n" + .'- 13: Data Governance'."\n" + ."\n" + .'- 14: Operation Center'."\n" + ."\n" + .'- 15: Resource Optimization'."\n" + ."\n" + .'- 16: Migration Assistant'."\n" + ."\n" + .'- 17: Data Analysis'."\n" + ."\n" + .'- 18: Approval Center'."\n" + ."\n" + .'- 19: Security Center'."\n" + ."\n" + .'- 20: Intelligent Data Modeling', + 'enumValueTitles' => ['Write' => 'Write', 'Read' => 'Read', 'NotSet' => 'NotSet'], + 'type' => 'integer', + 'format' => 'int64', + 'title' => '', 'required' => false, - 'example' => 'value', - 'pattern' => '^[\\u4E00-\\u9FA5A-Za-z0-9_\\-@#*<>|\\[\\]()+=&%$!~]+$', + 'example' => '2', ], + 'PermissionType' => ['description' => 'The permission type. Valid values:'."\n" + ."\n" + .'- Write: Read-only'."\n" + ."\n" + .'- Read: Edit'."\n" + ."\n" + .'- NotSet: Not controlled', 'type' => 'string', 'required' => false, 'example' => 'Write', 'title' => ''], ], - 'required' => true, + 'description' => 'A DataWorks module permission.', + 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => true, - 'maxItems' => 20, - 'minItems' => 1, + 'description' => 'The list of DataWorks module permissions.', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'DataAssetIds', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The data asset IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data asset ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '7000069357000', - ], - 'required' => false, - 'maxItems' => 100, - 'minItems' => 0, - ], + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => ['description' => 'A reserved parameter.', 'type' => 'string', 'required' => false, 'example' => '0000-ABCD-EFG****', 'title' => ''], ], - [ - 'name' => 'DataAssetType', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The type of the data asset. Valid values:'."\n" - ."\n" - .'* ACS::DataWorks::Table'."\n" - .'* ACS::DataWorks::Task'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'ACS::DataWorks::Task', - 'enum' => [ - 'ACS::DataWorks::Table', - 'ACS::DataWorks::Task', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID, which is used to locate logs and troubleshoot issues.', 'type' => 'string', 'title' => '', 'example' => '037DFCE4-ABA5-51D7-9F2D-CCF709252DAA'], ], + 'title' => '', + 'description' => 'The response parameters.', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateProjectRole', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"037DFCE4-ABA5-51D7-9F2D-CCF709252DAA\\"\\n}","type":"json"}]', + ], + 'UpdateResource' => [ + 'summary' => 'Updates the basic information about a file resource in DataStudio. This API operation performs an incremental update. The update information is described by using FlowSpec.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10000', - ], - ], - [ - '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', - 'default' => '1', - 'maximum' => '200', - 'minimum' => '1', - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235476', + 'abilityTreeNodes' => ['FEATUREdideJ3TPTK'], + ], + 'parameters' => [ [ - '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', - 'minimum' => '1', - 'example' => '10', - 'default' => '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 query the ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10000', 'title' => ''], ], [ - 'name' => 'EnvType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The environment of the workspace to which the data asset belongs. Valid values:'."\n" - ."\n" - .'* Dev: development environment'."\n" - .'* Prod: production environment'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Prod', - 'enum' => [ - 'Prod', - 'Dev', - ], - ], + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => 'The unique identifier of the Data Studio file resource.'."\n" + ."\n" + .'> This field is of type Long in SDK versions prior to 8.0.0, and of type String in SDK version 8.0.0 and later. This change does not affect the normal use of the SDK; parameters are still returned according to the type defined in the SDK. Compilation failures due to the type change may occur only when upgrading the SDK across version 8.0.0, in which case users need to manually correct the data type.', 'type' => 'string', 'required' => true, 'example' => '543217824470354XXXX', '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' => '0bc1ec92159376', - ], - 'PagingInfo' => [ - 'description' => 'The pagination information.'."\n", - 'type' => 'object', - 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - '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', - ], - 'DataAssets' => [ - 'description' => 'The data assets.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data asset.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The data asset ID.'."\n", - 'type' => 'string', - 'example' => '7259557313', - ], - 'Name' => [ - 'description' => 'The name of the data asset.'."\n", - 'type' => 'string', - 'example' => 'ali_cn_es_gfn', - ], - 'Type' => [ - 'description' => 'The type of the data asset. Valid values:'."\n" - ."\n" - .'* ACS::DataWorks::Table'."\n" - .'* ACS::DataWorks::Task'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'ACS::DataWorks::Task', - ], - 'EnvType' => [ - 'description' => 'The environment of the workspace to which the data asset belongs. Valid values:'."\n" - ."\n" - .'* Dev: development environment'."\n" - .'* Prod: production environment'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Prod', - ], - 'ProjectId' => [ - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '54275', - ], - 'DataAssetTagMappings' => [ - 'description' => 'The mappings between data assets and tags.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The mapping between the data asset and the tag.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'key', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => 'value', - ], - 'TagSource' => [ - 'description' => 'The way in which the mapping between the data asset and the tag is created. Valid values:'."\n" - ."\n" - .'* System'."\n" - .'* UserDefined'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'UserDefined', - ], - 'Creator' => [ - 'description' => 'The creator of the mapping between the data asset and the tag.'."\n", - 'type' => 'string', - 'example' => '12345', - ], - 'AutoTraceEnabled' => [ - 'description' => 'Indicates whether the lineage-based automatic backtrack feature is enabled for the mapping.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'DataAssetId' => [ - 'description' => 'The data asset ID.'."\n", - 'type' => 'string', - 'example' => '7259557313', - ], - ], - ], - ], - ], - ], - ], - ], - ], + [ + 'name' => 'Spec', + 'in' => 'formData', + 'schema' => ['description' => 'The unique identifier of the Data Studio file resource.'."\n" + ."\n" + .'> Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. Compilation failures caused by the type change may occur only when you upgrade the SDK across version 8.0.0. In this case, you must manually update the data type.', 'type' => 'string', 'required' => true, 'example' => '{'."\n" + .' "version": "1.1.0",'."\n" + .' "kind": "Resource",'."\n" + .' "spec": {'."\n" + .' "fileResources": ['."\n" + .' {'."\n" + .' "name": "OpenAPI_Test_Resource.py",'."\n" + .' "script": {'."\n" + .' "content": "",'."\n" + .' "path": "XX/OpenAPI_Test/Resources_Test/OpenAPI_Test_Resource.py",'."\n" + .' "runtime": {'."\n" + .' "command": "ODPS_PYTHON"'."\n" + .' }'."\n" + .' },'."\n" + .' "type": "python",'."\n" + .' "file": {'."\n" + .' "storage": {}'."\n" + .' },'."\n" + .' "datasource": {'."\n" + .' "name": "odps_first",'."\n" + .' "type": "odps"'."\n" + .' }'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .'}', 'title' => ''], + ], + [ + 'name' => 'ResourceFile', + 'in' => 'formData', + 'schema' => ['description' => 'The specific file stream or OSS download link contained in the resource.'."\n" + ."\n" + .'> This field allows users to provide a file stream or an OSS download link. When providing an OSS download link, ensure that the OSS link is publicly accessible. A presigned URL is recommended.', 'type' => 'string', 'isFileTransferUrl' => true, 'required' => false, 'example' => 'http://bucketname1.oss-cn-shanghai.aliyuncs.com/example', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID. You can troubleshoot issues based on the ID.', 'type' => 'string', 'example' => '4CDF7B72-020B-542A-8465-21CFFA81****'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4CDF7B72-020B-542A-8465-21CFFA81****\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'UpdateResource', + 'changeSet' => [ + ['createdAt' => '2025-05-06T02:37:42.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-01-13T07:36:03.000Z', 'description' => 'Request parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc1ec92159376\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 100,\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"DataAssets\\": [\\n {\\n \\"Id\\": \\"7259557313\\",\\n \\"Name\\": \\"ali_cn_es_gfn\\",\\n \\"Type\\": \\"ACS::DataWorks::Task\\",\\n \\"EnvType\\": \\"Prod\\",\\n \\"ProjectId\\": 54275,\\n \\"DataAssetTagMappings\\": [\\n {\\n \\"Key\\": \\"key\\",\\n \\"Value\\": \\"value\\",\\n \\"TagSource\\": \\"UserDefined\\",\\n \\"Creator\\": \\"12345\\",\\n \\"AutoTraceEnabled\\": false,\\n \\"DataAssetId\\": \\"7259557313\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListDataAssets', - 'description' => 'This API operation is available only for DataWorks Enterprise Edition or a more advanced edition.'."\n", - ], - 'GetJobStatus' => [ - 'summary' => 'Queries the status information of an asynchronous task. After you call an asynchronous operation, an asynchronous task is generated. You can call the GetJobStatus operation to query the status of the asynchronous task.', - 'methods' => [ - 'get', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'UpdateResourceGroup' => [ + 'summary' => 'Updates basic information about a resource group.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '248471', - 'abilityTreeNodes' => [ - 'FEATUREdide63BO88', - ], - 'autoTest' => true, + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '245164', + 'abilityTreeNodes' => ['FEATUREdide2SV6DS'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'JobId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the asynchronous task that is generated after you call an asynchronous operation.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '70ecdaec-bf21-4c11-8ecb-4f77453ceea8', - ], + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => true, 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['description' => 'The new name that you want to change for the resource group.', 'type' => 'string', 'example' => 'common_resource_group', 'title' => '', 'required' => false], + ], + [ + 'name' => 'Remark', + 'in' => 'formData', + 'schema' => ['description' => 'The new remarks that you want to modify for the resource group.', 'type' => 'string', 'example' => 'Create a common resource group for common tasks', 'title' => '', 'required' => false], + ], + [ + 'name' => 'AliyunResourceGroupId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the new Alibaba Cloud resource group.', 'type' => 'string', 'example' => 'rg-aek2kqofrg****', 'title' => '', 'required' => false], ], ], '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' => '5E2BFE96-C0E0-5A98-85C8-633EC803198D', - ], - 'JobStatus' => [ - 'description' => 'The real-time status information of the asynchronous task.'."\n", - 'type' => 'object', - 'properties' => [ - 'JobId' => [ - 'description' => 'The ID of the asynchronous task.'."\n", - 'type' => 'string', - 'example' => 'C664CDE3-9C0B-5792-B17F-6C543783BBBC', - ], - 'JobType' => [ - 'description' => 'The type of the asynchronous task. Valid values:'."\n" - ."\n" - .'* **Create**: The asynchronous task is used to create an object.'."\n" - .'* **Update**: The asynchronous task is used to update an object.'."\n" - .'* **Cancel**: The asynchronous task is used to cancel an operation.'."\n", - 'type' => 'string', - 'example' => 'Create', - ], - 'Completed' => [ - 'description' => 'Indicates whether the asynchronous task is complete. Valid values: True False'."\n", - 'type' => 'string', - 'example' => 'False', - ], - 'Status' => [ - 'description' => 'The status of the asynchronous task. Valid values:'."\n" - ."\n" - .'* **Success**'."\n" - .'* **Fail**'."\n" - .'* **Cancel**'."\n" - .'* **Running**'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Error' => [ - 'description' => 'The error message returned if the asynchronous task fails.'."\n", - 'type' => 'string', - 'example' => 'Not Found', - ], - 'CreateTime' => [ - 'description' => 'The time when the asynchronous task was created.'."\n", - 'type' => 'string', - 'example' => '1729063449802', - ], - ], - ], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'example' => 'true'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065XXXXX\\"\\n}","type":"json"}]', + 'title' => 'UpdateResourceGroup', + 'description' => 'You can use this API operation only in DataWorks Basic Edition or an advanced edition.', + 'changeSet' => [ + ['createdAt' => '2025-01-02T07:14:14.000Z', 'description' => 'Request parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"5E2BFE96-C0E0-5A98-85C8-633EC803198D\\",\\n \\"JobStatus\\": {\\n \\"JobId\\": \\"C664CDE3-9C0B-5792-B17F-6C543783BBBC\\",\\n \\"JobType\\": \\"Create\\",\\n \\"Completed\\": \\"False\\",\\n \\"Status\\": \\"Success\\",\\n \\"Error\\": \\"Not Found\\",\\n \\"CreateTime\\": \\"1729063449802\\"\\n }\\n}","type":"json"}]', - 'title' => 'GetJobStatus', - ], - 'ListDataQualityEvaluationTasks' => [ - 'methods' => [ - 'get', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:UpdateResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'DwResourceGroup', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:dwresourcegroup/{#DwResourceGroupId}'], + ], + ], + ], ], + ], + 'UpdateRoute' => [ + 'summary' => 'Updates the information about a route.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '240369', - 'abilityTreeNodes' => [ - 'FEATUREdideGK4B66', - ], - 'autoTest' => true, + 'abilityTreeCode' => '245175', + 'abilityTreeNodes' => ['FEATUREdide2SV6DS'], 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '100', - ], - ], - [ - 'name' => 'TableGuid', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the table in Data Map.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'odps.unit_test.tb_unit_test', - ], + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => 'The route ID of the network resource.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1000', 'title' => ''], ], [ - 'name' => 'Name', - 'in' => 'query', + 'name' => 'DestinationCidr', + 'in' => 'formData', 'schema' => [ - 'description' => 'The name of the data quality monitoring task. Fuzzy match is supported.'."\n", + 'description' => 'The destination CIDR block of the route that you want to update.', 'type' => 'string', - 'required' => false, - 'example' => 'Test', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '200', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', 'required' => true, - 'docRequired' => true, - 'example' => '1', - 'default' => '1', + 'example' => '192.168.0.0/16', + 'enum' => [], + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'PaginatedModel', - 'description' => 'The response parameters.'."\n", + 'title' => 'Schema of Response', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '追踪ID，用于跟踪一次完整调用，出现异常时可以根据这个字符串排查异常链路', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '691CA452-D37A-4ED0-9441', - ], - 'PagingInfo' => [ - 'description' => 'The pagination information.'."\n", - 'type' => 'object', - 'properties' => [ - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'string', - 'example' => '131', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'string', - 'example' => '10', - 'default' => '10', - ], - 'PageNumber' => [ - 'description' => 'The page number.'."\n", - 'type' => 'string', - 'example' => '1', - 'default' => '1', - ], - 'DataQualityEvaluationTasks' => [ - 'description' => 'The data quality monitoring tasks.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the data quality monitoring task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10001', - ], - 'Name' => [ - 'description' => 'The name of the data quality monitoring task. The name can be up to 255 characters in length and can contain digits, letters, and punctuation marks.'."\n", - 'type' => 'string', - 'example' => 'Data quality verification task', - ], - 'Description' => [ - 'description' => 'The description of the data quality monitoring task. The description can be up to 65,535 characters in length.'."\n", - 'type' => 'string', - 'example' => 'This is a daily run data quality evaluation plan', - ], - 'ProjectId' => [ - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'Target' => [ - 'description' => 'The monitored object of the task.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the monitored object. Valid values:'."\n" - ."\n" - .'* Table'."\n", - 'type' => 'string', - 'example' => 'Table', - ], - 'DatabaseType' => [ - 'description' => 'The type of the database to which the table belongs. Valid values:'."\n" - ."\n" - .'* maxcompute'."\n" - .'* emr'."\n" - .'* cdh'."\n" - .'* hologres'."\n" - .'* analyticdb_for_postgresql'."\n" - .'* analyticdb_for_mysql'."\n" - .'* starrocks'."\n", - 'type' => 'string', - 'example' => 'maxcompute', - ], - 'TableGuid' => [ - 'description' => 'The ID of the table in Data Map.'."\n", - 'type' => 'string', - 'example' => 'odps.unit_test.tb_unit_test', - ], - 'PartitionSpec' => [ - 'description' => 'The configuration of the partitioned table.'."\n", - 'type' => 'string', - 'example' => 'ds=$[yyyymmdd-1]', - ], - ], - ], - 'Trigger' => [ - 'description' => 'The trigger configuration of the task.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The trigger condition of the task. Valid values:'."\n" - ."\n" - .'* ByScheduledTaskInstance. The value indicates that the task is triggered when the instance of an auto triggered node is successfully run.', - 'type' => 'string', - 'example' => 'ByScheduledTaskInstance', - ], - 'TaskIds' => [ - 'description' => 'The IDs of the auto triggered nodes of which the instances are successfully run. This parameter takes effect only if the Type parameter is set to ByScheduledTaskInstance.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the auto triggered node.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10001', - ], - ], - ], - ], - 'RuntimeConf' => [ - 'description' => 'The configuration of the data source. The value of the queue field is default, and that of the sqlEngine field can be set to SPARK_SQL, KYUUBI, PRESTO_SQL, or HIVE_SQL. The value default indicates the YARN queue for E-MapReduce (EMR) tasks.'."\n", - 'type' => 'string', - 'example' => '{ "queue": "default", "sqlEngine": "SPARK-SQL" }', - ], - 'Hooks' => [ - 'description' => 'The callback configurations of the task during the instance lifecycle. Blocking an auto triggered node is a type of callback event. Only this type is supported.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The callback configuration of the task.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the callback event. Valid values:'."\n" - ."\n" - .'* BlockTaskInstance. The value indicates that an auto triggered node is blocked.', - 'type' => 'string', - 'example' => 'BlockTaskInstance', - ], - 'Condition' => [ - 'description' => 'The trigger configuration of the callback event.'."\n", - 'type' => 'string', - 'example' => '${severity} == "High" AND ${status} == "Critical"', - ], - ], - ], - ], - 'Notifications' => [ - 'description' => 'The configurations for alert notifications.'."\n", - 'type' => 'object', - 'properties' => [ - 'Condition' => [ - 'description' => 'The trigger condition of the alert notification.'."\n", - 'type' => 'string', - 'example' => '${severity} == "High"', - ], - 'Notifications' => [ - 'description' => 'The configurations for the alert notification.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The configuration for the alert notification.'."\n", - 'type' => 'object', - 'properties' => [ - 'NotificationChannels' => [ - 'description' => 'The alert notification methods.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The alert notification method.'."\n", - 'type' => 'object', - 'properties' => [ - 'Channels' => [ - 'description' => 'The alert notification methods.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The alert notification method. Valid values:'."\n" - ."\n" - .'* Mail'."\n" - .'* Sms'."\n" - .'* Phone'."\n" - .'* Feishu'."\n" - .'* Weixin: WeCom notification'."\n" - .'* Dingding'."\n" - .'* Webhook', - 'type' => 'string', - 'example' => 'Mail', - ], - ], - ], - ], - ], - 'NotificationReceivers' => [ - 'description' => 'The alert recipients.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The alert recipient.'."\n", - 'type' => 'object', - 'properties' => [ - 'ReceiverType' => [ - 'description' => 'The type of the alert recipient. Valid values:'."\n" - ."\n" - .'* AliUid: Alibaba Cloud account ID'."\n" - .'* WebhookUrl: URL of a custom webhook'."\n" - .'* DingdingUrl: DingTalk chatbot URL'."\n" - .'* FeishuUrl: Lark chatbot URL'."\n" - .'* WeixinUrl: WeCom chatbot URL'."\n", - 'type' => 'string', - 'example' => 'AliUid', - ], - 'ReceiverValues' => [ - 'description' => 'The alert recipients.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The alert recipient.'."\n", - 'type' => 'string', - 'example' => 'user1', - ], - ], - 'Extension' => [ - 'description' => 'The extended information in the JSON format. For example, the DingTalk chatbot can remind all members in a DingTalk group by using the at sign (@).'."\n", - 'type' => 'string', - 'example' => '{"atAll":"true"}', - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'DataSourceId' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - ], - 'description' => '', - ], - ], - ], - ], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'default' => 'true', 'title' => '', 'example' => 'true'], + 'RequestId' => ['description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.', 'type' => 'string', 'example' => '6A6CBE87-9F91-1323-B680-E7A7065****', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-4ED0-****\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": \\"131\\",\\n \\"PageSize\\": \\"10\\",\\n \\"PageNumber\\": \\"1\\",\\n \\"DataQualityEvaluationTasks\\": [\\n {\\n \\"Id\\": 10001,\\n \\"Name\\": \\"Data quality verification task\\",\\n \\"Description\\": \\"This is a daily run data quality evaluation plan\\",\\n \\"ProjectId\\": 100,\\n \\"Target\\": {\\n \\"Type\\": \\"Table\\",\\n \\"DatabaseType\\": \\"maxcompute\\",\\n \\"TableGuid\\": \\"odps.unit_test.tb_unit_test\\",\\n \\"PartitionSpec\\": \\"ds=$[yyyymmdd-1]\\"\\n },\\n \\"Trigger\\": {\\n \\"Type\\": \\"ByScheduledTaskInstance\\",\\n \\"TaskIds\\": [\\n 10001\\n ]\\n },\\n \\"RuntimeConf\\": \\"{ \\\\\\"queue\\\\\\": \\\\\\"default\\\\\\", \\\\\\"sqlEngine\\\\\\": \\\\\\"SPARK_SQL\\\\\\" }\\",\\n \\"Hooks\\": [\\n {\\n \\"Type\\": \\"BlockTaskInstance\\",\\n \\"Condition\\": \\"${severity} == \\\\\\"High\\\\\\" AND ${status} == \\\\\\"Critical\\\\\\"\\"\\n }\\n ],\\n \\"Notifications\\": {\\n \\"Condition\\": \\"${severity} == \\\\\\"High\\\\\\"\\",\\n \\"Notifications\\": [\\n {\\n \\"NotificationChannels\\": [\\n {\\n \\"Channels\\": [\\n \\"Mail\\"\\n ]\\n }\\n ],\\n \\"NotificationReceivers\\": [\\n {\\n \\"ReceiverType\\": \\"AliUid\\",\\n \\"ReceiverValues\\": [\\n \\"user1\\"\\n ],\\n \\"Extension\\": \\"{\\\\\\"atAll\\\\\\":\\\\\\"true\\\\\\"}\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"DataSourceId\\": 0\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListDataQualityEvaluationTasks', - 'summary' => 'Queries a list of data quality monitoring tasks by page.', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", - ], - 'ListDataQualityRules' => [ - 'summary' => 'Queries a list of data quality monitoring rules by page.', - 'methods' => [ - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"6A6CBE87-9F91-1323-B680-E7A7065****\\"\\n}","type":"json"}]', + 'title' => 'UpdateRoute', + 'description' => 'This API operation is available for all DataWorks editions.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:UpdateRoute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + ], + 'UpdateSecurityStrategy' => [ + 'summary' => 'To modify the configuration of an existing security policy, you must be both a DataWorks tenant administrator and a security administrator.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'update', 'riskType' => 'none', - 'abilityTreeCode' => '237677', - 'abilityTreeNodes' => [ - 'FEATUREdide3WJOKE', - ], + 'chargeType' => 'free', + 'abilityTreeCode' => 'TBD', + 'abilityTreeNodes' => ['FEATUREdideYTM537'], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'title' => '项目id', - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '10002', - ], + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => '**The policy ID.**', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '13', 'title' => ''], ], [ - 'name' => 'DataQualityEvaluationTaskId', - 'in' => 'query', - 'schema' => [ - 'title' => '关联的质量校验任务ID', - 'description' => 'The ID of the data quality monitoring task that is associated with the rule.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10000', - ], + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['description' => '**The policy name.**', 'type' => 'string', 'required' => false, 'example' => '默认数据分析策略', 'title' => ''], ], [ - 'name' => 'TableGuid', - 'in' => 'query', - 'schema' => [ - 'title' => '规则所作用的表在数据地图中的唯一标识', - 'description' => 'The ID of the table that is limited by the rule in Data Map.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'odps.unit_test.tb_unit_test', - ], + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['description' => '**The policy description.**', 'type' => 'string', 'required' => false, 'example' => '控制数据分析模块的查询结果安全行为', 'title' => ''], ], [ - 'name' => 'Name', - 'in' => 'query', + 'name' => 'Workspaces', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => '模糊匹配规则名称', - 'description' => 'The name of the rule. Fuzzy match is supported.'."\n", - 'type' => 'string', + 'type' => 'array', + 'items' => ['description' => 'A workspace ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12343', 'title' => ''], + 'description' => '**A list of associated workspace IDs.**', 'required' => false, - 'example' => 'unit_test', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'PageSize', - 'in' => 'query', + 'name' => 'Content', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10. Maximum value: 200.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'maximum' => '200', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', + 'type' => 'object', + 'properties' => [ + 'Controllers' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Controller' => ['description' => 'The controller identifier. For valid values, see the list of controllers for each schema.', 'type' => 'string', 'required' => false, 'example' => 'viewCount', 'title' => ''], + 'DisplayName' => ['description' => 'The display name.', 'type' => 'string', 'required' => false, 'example' => '查询结果-单次展示记录值上限', 'title' => ''], + 'DisplayNameEn' => ['description' => 'The English display name.', 'type' => 'string', 'required' => false, 'example' => 'Query Results - Single Display Record Limit', 'title' => ''], + 'Enable' => ['description' => 'Indicates whether the controller is enabled.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'ControllerValueType' => ['description' => 'The data type of the controller\'s value. Valid values: `Boolean`, `Integer`, `Long`, and `String`.', 'type' => 'string', 'required' => false, 'example' => 'Integer', 'title' => ''], + 'UserConfigValue' => ['description' => 'The user-configured value. The type of this value is determined by the `ControllerValueType` parameter.', 'type' => 'any', 'required' => false, 'example' => '20', 'title' => ''], + 'BasicEditionDefaultValue' => ['description' => 'The default value for the Basic edition.', 'type' => 'any', 'required' => false, 'example' => '10000', 'title' => ''], + 'StandardEditionDefaultValue' => ['description' => 'The default value for the Standard edition.', 'type' => 'any', 'required' => false, 'example' => '10000', 'title' => ''], + 'ProfessionalEditionDefaultValue' => ['description' => 'The default value for the Professional edition.', 'type' => 'any', 'required' => false, 'example' => '10000', 'title' => ''], + 'EnterpriseEditionDefaultValue' => ['description' => 'The default value for the Enterprise edition.', 'type' => 'any', 'required' => false, 'example' => '10000', 'title' => ''], + 'BasicEditionIntervalValue' => [ + 'type' => 'array', + 'items' => ['description' => 'The minimum or maximum value of the range.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'description' => 'The value range for the Basic edition, specified as `[min, max]`.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'StandardEditionIntervalValue' => [ + 'type' => 'array', + 'items' => ['description' => 'The minimum or maximum value of the range.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'description' => 'The value range for the Standard edition, specified as `[min, max]`.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'ProfessionalEditionIntervalValue' => [ + 'type' => 'array', + 'items' => ['description' => 'The minimum or maximum value of the range.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'description' => 'The value range for the Professional edition, specified as `[min, max]`.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'EnterpriseEditionIntervalValue' => [ + 'type' => 'array', + 'items' => ['description' => 'The minimum or maximum value of the range.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'description' => 'The value range for the Enterprise edition, specified as `[min, max]`.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'description' => 'A controller.', + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'minItems' => 1, + 'description' => 'A list of controllers.'."\n" + ."\n" + .'Note: The valid controllers depend on the selected schema. For more information, see the controller definition and the list of controllers for each schema.', + 'title' => '', + 'example' => '', + ], + ], + 'required' => true, + 'description' => 'The policy content, which is constrained by the `SecurityStrategySchema`.', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - 'default' => '1', - ], + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => ['description' => 'A client token to ensure request idempotence.', 'type' => 'string', 'required' => false, 'example' => '1AFAE64E-D1BE-432B-A9*****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'PaginatedModel', - 'description' => 'The response parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => '追踪ID，用于跟踪一次完整调用，出现异常时可以根据这个字符串排查异常链路', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '691CA452-D37A-4ED0-9441', - ], - 'PagingInfo' => [ - '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.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '294', - ], - 'DataQualityRules' => [ - 'description' => 'The rules.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The rule ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '22130', - ], - 'Name' => [ - 'description' => 'The rule name.'."\n", - 'type' => 'string', - 'example' => 'The table cannot be empty.', - ], - 'ProjectId' => [ - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100001', - ], - 'Enabled' => [ - 'description' => 'Indicates whether the rule is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Severity' => [ - 'description' => 'The strength of the rule. Valid values:'."\n" - ."\n" - .'* Normal'."\n" - .'* High'."\n", - 'type' => 'string', - 'example' => 'High', - ], - 'Description' => [ - 'description' => 'The description of the rule. The description can be up to 500 characters in length.'."\n", - 'type' => 'string', - 'example' => 'this is a odps _sql task', - ], - 'Target' => [ - 'description' => 'The monitored object of the rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the monitored object. Valid values:'."\n" - ."\n" - .'* Table'."\n", - 'type' => 'string', - 'example' => 'Table', - ], - 'DatabaseType' => [ - 'description' => 'The type of the database to which the table belongs. Valid values:'."\n" - ."\n" - .'* maxcompute'."\n" - .'* emr'."\n" - .'* cdh'."\n" - .'* hologres'."\n" - .'* analyticdb_for_postgresql'."\n" - .'* analyticdb_for_mysql'."\n" - .'* starrocks'."\n", - 'type' => 'string', - 'example' => 'maxcompute', - ], - 'TableGuid' => [ - 'description' => 'The ID of the table that is limited by the rule in Data Map.'."\n", - 'type' => 'string', - 'example' => 'odps.unit_test.tb_unit_test', - ], - ], - ], - 'TemplateCode' => [ - 'description' => 'The ID of the template used by the rule.'."\n", - 'type' => 'string', - 'example' => 'system::user_defined', - ], - 'SamplingConfig' => [ - 'description' => 'The settings for sampling.'."\n", - 'type' => 'object', - 'properties' => [ - 'Metric' => [ - 'description' => 'The metrics used for sampling. Valid values:'."\n" - ."\n" - .'* Count: the number of rows in the table.'."\n" - .'* Min: the minimum value of the field.'."\n" - .'* Max: the maximum value of the field.'."\n" - .'* Avg: the average value of the field.'."\n" - .'* DistinctCount: the number of unique values of the field after deduplication.'."\n" - .'* DistinctPercent: the percentage of the number of unique values of the field after deduplication to the number of rows in the table.'."\n" - .'* DuplicatedCount: the number of duplicated values in the field.'."\n" - .'* DuplicatedPercent: the percentage of the number of duplicated values of the field to the number of rows in the table.'."\n" - .'* TableSize: the table size.'."\n" - .'* NullValueCount: the number of rows in which the field is set to null.'."\n" - .'* NullValuePercent: the percentage of the number of rows in which the field is set to null to the number of rows in the table.'."\n" - .'* GroupCount: the field value and the number of rows for each field value.'."\n" - .'* CountNotIn: the number of rows in which the field values are different from the referenced values that you specified in the rule.'."\n" - .'* CountDistinctNotIn: the number of unique values that are different from the referenced values that you specified in the rule after deduplication.'."\n" - .'* UserDefinedSql: indicates that the data is sampled by executing custom SQL statements.'."\n", - 'type' => 'string', - 'example' => 'Max', - ], - 'MetricParameters' => [ - 'description' => 'The parameters required for sampling.'."\n", - 'type' => 'string', - 'example' => '{ "Columns": [ "id", "name" ] , "SQL": "select count(1) from table;"}', - ], - 'SettingConfig' => [ - 'description' => 'The statements that are used to configure the parameters required for sampling before you execute the sampling statements. The statements can be up to 1,000 characters in length. Only the MaxCompute database is supported.'."\n", - 'type' => 'string', - 'example' => 'SET odps.sql.udf.timeout=600s; '."\n" - .'SET odps.sql.python.version=cp27;', - ], - 'SamplingFilter' => [ - 'description' => 'The statements that are used to filter unnecessary data during sampling. The statements can be up to 16,777,215 characters in length.'."\n", - 'type' => 'string', - 'example' => 'id IS NULL', - ], - ], - ], - 'CheckingConfig' => [ - 'description' => 'The check settings for sample data.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The threshold calculation method. Valid values:'."\n" - ."\n" - .'* Fixed'."\n" - .'* Fluctation'."\n" - .'* FluctationDiscreate'."\n" - .'* Auto'."\n" - .'* Average'."\n" - .'* Variance'."\n", - 'type' => 'string', - 'example' => 'Fixed', - ], - 'ReferencedSamplesFilter' => [ - 'description' => 'The method that is used to query the referenced samples. To obtain some types of thresholds, you need to query reference values. In this example, an expression is used to indicate the query method of referenced samples.'."\n", - 'type' => 'string', - 'example' => '{ "bizdate": [ "-1", "-7", "-1m" ] }', - ], - 'Thresholds' => [ - 'description' => 'The threshold settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Expected' => [ - 'description' => 'The expected threshold setting.'."\n", - 'type' => 'object', - 'properties' => [ - 'Operator' => [ - 'description' => 'The comparison operator. Valid values:'."\n" - ."\n" - .'* \\>'."\n" - .'* \\>='."\n" - .'* <'."\n" - .'* <='."\n" - .'* !='."\n" - .'* \\='."\n", - 'type' => 'string', - 'example' => '>', - ], - 'Value' => [ - 'description' => 'The threshold value.'."\n", - 'type' => 'string', - 'example' => '100.0', - ], - 'Expression' => [ - 'description' => 'The threshold expression.'."\n" - ."\n" - .'If the template specified by the TemplateCode parameter is about fluctuation, you must use an expression to represent the threshold for fluctuation. Examples:'."\n" - ."\n" - .'* $checkValue > 0.01'."\n" - .'* $checkValue < -0.01'."\n" - .'* abs($checkValue) > 0.01'."\n" - ."\n" - .'If the template specified by the TemplateCode parameter is about fixed value, you can also use an expression to represent the threshold. If you configure the Expression, Operator, and Value parameters for the threshold at the same time, the Expression parameter takes precedence over the Operator and Value parameters.'."\n", - 'type' => 'string', - 'example' => '$checkValue > 0.01', - ], - ], - ], - 'Warned' => [ - 'description' => 'The threshold settings for normal alerts.'."\n", - 'type' => 'object', - 'properties' => [ - 'Operator' => [ - 'description' => 'The comparison operator. Valid values:'."\n" - ."\n" - .'* \\>'."\n" - .'* \\>='."\n" - .'* <'."\n" - .'* <='."\n" - .'* !='."\n" - .'* \\='."\n", - 'type' => 'string', - 'example' => '>', - ], - 'Value' => [ - 'description' => 'The threshold value.'."\n", - 'type' => 'string', - 'example' => '100.0', - ], - 'Expression' => [ - 'description' => 'The threshold expression.'."\n" - ."\n" - .'If the template specified by the TemplateCode parameter is about fluctuation, you must use an expression to represent the threshold for fluctuation. Examples:'."\n" - ."\n" - .'* $checkValue > 0.01'."\n" - .'* $checkValue < -0.01'."\n" - .'* abs($checkValue) > 0.01'."\n" - ."\n" - .'If the template specified by the TemplateCode parameter is about fixed value, you can also use an expression to represent the threshold. If you configure the Expression, Operator, and Value parameters for the threshold at the same time, the Expression parameter takes precedence over the Operator and Value parameters.'."\n", - 'type' => 'string', - 'example' => '$checkValue > 0.01', - ], - ], - ], - 'Critical' => [ - 'description' => 'The threshold settings for critical alerts.'."\n", - 'type' => 'object', - 'properties' => [ - 'Operator' => [ - 'description' => 'The comparison operator. Valid values:'."\n" - ."\n" - .'* \\>'."\n" - .'* \\>='."\n" - .'* <'."\n" - .'* <='."\n" - .'* !='."\n" - .'* \\='."\n", - 'type' => 'string', - 'example' => '>', - ], - 'Value' => [ - 'description' => 'The threshold value.'."\n", - 'type' => 'string', - 'example' => '100.0', - ], - 'Expression' => [ - 'description' => 'The threshold expression.'."\n" - ."\n" - .'If the template specified by the TemplateCode parameter is about fluctuation, you must use an expression to represent the threshold for fluctuation. Examples:'."\n" - ."\n" - .'* $checkValue > 0.01'."\n" - .'* $checkValue < -0.01'."\n" - .'* abs($checkValue) > 0.01'."\n" - ."\n" - .'If the template specified by the TemplateCode parameter is about fixed value, you can also use an expression to represent the threshold. If you configure the Expression, Operator, and Value parameters for the threshold at the same time, the Expression parameter takes precedence over the Operator and Value parameters.'."\n", - 'type' => 'string', - 'example' => '$checkValue > 0.01', - ], - ], - ], - ], - ], - ], - ], - 'ErrorHandlers' => [ - 'description' => 'The operations that you can perform after the rule-based check fails.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The operation that you can perform after the rule-based check fails.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the operation. Valid values:'."\n" - ."\n" - .'* SaveErrorData'."\n", - 'type' => 'string', - 'example' => 'SaveErrorData'."\n", - ], - 'ErrorDataFilter' => [ - 'description' => 'The SQL statement that is used to filter failed tasks. If the rule is defined by custom SQL statements, you must specify an SQL statement to filter failed tasks.'."\n", - 'type' => 'string', - 'example' => 'SELECT * FROM tb_api_log WHERE id IS NULL', - ], - ], - ], - ], - ], - 'description' => '', - ], - ], - ], - ], + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '0bc5df3a17***903790e8e8a'], ], + 'title' => '', + 'description' => 'Indicates the error code if the request fails.', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-4ED0-9441\\",\\n \\"PagingInfo\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 294,\\n \\"DataQualityRules\\": [\\n {\\n \\"Id\\": 22130,\\n \\"Name\\": \\"表不能为空\\",\\n \\"ProjectId\\": 100001,\\n \\"Enabled\\": true,\\n \\"Severity\\": \\"High\\",\\n \\"Description\\": \\"this is a odps _sql task\\",\\n \\"Target\\": {\\n \\"Type\\": \\"Table\\",\\n \\"DatabaseType\\": \\"maxcompute\\",\\n \\"TableGuid\\": \\"odps.unit_test.tb_unit_test\\"\\n },\\n \\"TemplateCode\\": \\"SYSTEM:user_defined_sql\\",\\n \\"SamplingConfig\\": {\\n \\"Metric\\": \\"Max\\",\\n \\"MetricParameters\\": \\"{ \\\\\\"Columns\\\\\\": [ \\\\\\"id\\\\\\", \\\\\\"name\\\\\\" ] , \\\\\\"SQL\\\\\\": \\\\\\"select count(1) from table;\\\\\\"}\\",\\n \\"SettingConfig\\": \\"SET odps.sql.udf.timeout=600s; \\\\nSET odps.sql.python.version=cp27;\\",\\n \\"SamplingFilter\\": \\"id IS NULL\\"\\n },\\n \\"CheckingConfig\\": {\\n \\"Type\\": \\"Fixed\\",\\n \\"ReferencedSamplesFilter\\": \\"{ \\\\\\"bizdate\\\\\\": [ \\\\\\"-1\\\\\\", \\\\\\"-7\\\\\\", \\\\\\"-1m\\\\\\" ] }\\",\\n \\"Thresholds\\": {\\n \\"Expected\\": {\\n \\"Operator\\": \\">\\",\\n \\"Value\\": \\"100.0\\",\\n \\"Expression\\": \\"$checkValue > 0.01\\"\\n },\\n \\"Warned\\": {\\n \\"Operator\\": \\">\\",\\n \\"Value\\": \\"100.0\\",\\n \\"Expression\\": \\"$checkValue > 0.01\\"\\n },\\n \\"Critical\\": {\\n \\"Operator\\": \\">\\",\\n \\"Value\\": \\"100.0\\",\\n \\"Expression\\": \\"$checkValue > 0.01\\"\\n }\\n }\\n },\\n \\"ErrorHandlers\\": [\\n {\\n \\"Type\\": \\"SaveErrorData\\\\n\\",\\n \\"ErrorDataFilter\\": \\"SELECT * FROM tb_api_log WHERE id IS NULL\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListDataQualityRules', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", - ], - 'ListDataQualityEvaluationTaskInstances' => [ - 'summary' => 'Queries a list of instances generated by a data quality monitoring task by page.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateSecurityStrategy', + 'description' => '## Usage'."\n" + ."\n" + .'- Use this API to update a specified security policy, including its name, description, associated workspace IDs, and policy content.'."\n" + ."\n" + .'- You cannot modify some properties of default system policies, such as the schema name and control module.'."\n" + ."\n" + .'- When `ControlDwScope` is set to `Workspace`, use the `Workspaces` parameter to associate the policy with specific workspaces.'."\n" + ."\n" + .'- When updating the policy content (`Content`), ensure that the provided controllers (`Controllers`) conform to the requirements of the selected schema.'."\n" + ."\n" + .'- The optional `ClientToken` parameter ensures request idempotence.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc5df3a17***903790e8e8a\\"\\n}","type":"json"}]', + ], + 'UpdateTableBusinessMetadata' => [ + 'summary' => 'Updates the business metadata for a data table in the data map. You can update only the table\'s Readme and custom attributes.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '240385', - 'abilityTreeNodes' => [ - 'FEATUREdideGK4B66', - ], + 'abilityTreeCode' => '267996', + 'abilityTreeNodes' => ['FEATUREdideE9XYA6'], 'autoTest' => true, + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '100', - ], - ], - [ - 'name' => 'DataQualityEvaluationTaskId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the data quality monitoring task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10000', - ], - ], - [ - 'name' => 'TableGuid', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the table in Data Map.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'odps.unit_test.tb_unit_test', - ], - ], - [ - 'name' => 'CreateTimeFrom', - 'in' => 'query', - 'schema' => [ - 'description' => 'The earliest start time at which the instances are generated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1710239005403', - ], - ], - [ - 'name' => 'CreateTimeTo', - 'in' => 'query', - 'schema' => [ - 'description' => 'The latest start time at which the instances are generated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1710239005403', - ], - ], - [ - 'name' => 'BizdateFrom', - 'in' => 'query', - 'schema' => [ - 'description' => 'The start time of the data quality monitoring task.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2024-04-01', - ], - ], - [ - 'name' => 'BizdateTo', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end time of the data quality monitoring task.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2024-05-01', - ], + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => 'The table ID. For the required format, see the response of the `ListTables` operation.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'maxcompute-table:::project_name:[schema_name]:table_name'], ], [ - 'name' => 'TriggerClientId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance that is generated by the task.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1001', - ], + 'name' => 'Readme', + 'in' => 'formData', + 'schema' => ['description' => 'The Readme of the table, which supports rich text format.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '## introduction'], ], [ - 'name' => 'TriggerClient', - 'in' => 'query', + 'name' => 'CustomAttributes', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The name of the trigger module of the instance.'."\n", - 'type' => 'string', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'array', + 'items' => ['description' => 'The attribute value.', 'type' => 'string', 'example' => '张三', 'title' => ''], + 'title' => '', + 'description' => 'An array that contains a single custom attribute value.', + 'example' => '', + ], + 'example' => '{"biz_owner":["张三"]}', + 'title' => '', + 'description' => 'The values of custom attributes. The key specifies the identifier of a custom attribute, and the value is an array that can contain at most one item. To delete the value for an attribute, pass an empty array. To update only custom attributes, omit the `Readme` parameter to prevent its existing value from being cleared. To leave the custom attributes unchanged, pass an empty object `{}`.', 'required' => false, - 'example' => 'CWF2', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '200', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], - ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - 'default' => '1', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'PaginatedModel', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'The data returned for the request.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '追踪ID，用于跟踪一次完整调用，出现异常时可以根据这个字符串排查异常链路', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '691CA452-D37A-4ED0-9441', - ], - 'PagingInfo' => [ - '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.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '294', - ], - 'DataQualityEvaluationTaskInstances' => [ - 'description' => 'The instances generated by the task.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the instance.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10001', - ], - 'CreateTime' => [ - 'description' => 'The time at which the instance was generated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], - 'FinishTime' => [ - 'description' => 'The time at which the instance finished running.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1710239005403', - ], - 'Status' => [ - 'description' => 'The status of the instance. Valid values:'."\n" - ."\n" - .'* Running'."\n" - .'* Error'."\n" - .'* Passed'."\n" - .'* Warned'."\n" - .'* Critical'."\n", - 'type' => 'string', - 'example' => 'Critical', - ], - 'Parameters' => [ - 'description' => 'The parameters configured for the instance.'."\n", - 'type' => 'string', - 'example' => '{'."\n" - .' "bizdate": "20240517",'."\n" - .' "triggerTime": "1710239005403"'."\n" - .'}', - ], - 'TriggerContext' => [ - 'description' => 'The information about the trigger module of the instance.'."\n", - 'type' => 'string', - 'example' => '{'."\n" - .' "TriggerClientId": 10001,'."\n" - .' "TriggerClient": "CWF2"'."\n" - .'}', - ], - 'ProjectId' => [ - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'Task' => [ - 'description' => 'The snapshot of the configurations for the task when the task starts.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '资源一级ID', - 'description' => 'The task ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10001', - ], - 'Description' => [ - 'title' => '质量监控任务描述', - 'description' => 'The description of the task.'."\n", - 'type' => 'string', - 'example' => 'This is a daily run data quality evaluation plan.', - ], - 'ProjectId' => [ - 'title' => '项目空间Id', - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'deprecated' => false, - 'example' => '100', - ], - 'Target' => [ - 'title' => '参看 DataQualityTarget示例 数据质量校验任务的监控对象，参考 DataQualityTarget', - 'description' => 'The monitored object of the task.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '监控对象类型', - 'description' => 'The type of the monitored object. Valid values:'."\n" - ."\n" - .'* Table'."\n", - 'type' => 'string', - 'example' => 'Table', - ], - 'DatabaseType' => [ - 'title' => '表所属的数据库类型', - 'description' => 'The type of the database to which the table belongs. Valid values:'."\n" - ."\n" - .'* maxcompute'."\n" - .'* emr'."\n" - .'* cdh'."\n" - .'* hologres'."\n" - .'* analyticdb_for_postgresql'."\n" - .'* analyticdb_for_mysql'."\n" - .'* starrocks'."\n", - 'type' => 'string', - 'example' => 'maxcompute', - ], - 'TableGuid' => [ - 'title' => '表在数据地图中的唯一ID', - 'description' => 'The ID of the table in Data Map.'."\n", - 'type' => 'string', - 'example' => 'odps.unit_test.tb_unit_test', - ], - 'PartitionSpec' => [ - 'title' => '分区表的分区设置', - 'description' => 'The configuration of the partitioned table.'."\n", - 'type' => 'string', - 'example' => 'ds=$[yyyymmdd-1]', - ], - ], - ], - 'Trigger' => [ - 'title' => '数据质量校验任务的触发配置', - 'description' => 'The trigger configuration of the task.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '质量监控任务触发类型', - 'description' => 'The trigger condition of the task. Valid values:'."\n" - ."\n" - .'* ByScheduledTaskInstance. The value indicates that the task is triggered when the instance of an auto triggered node is successfully run.', - 'type' => 'string', - 'example' => 'ByScheduledTaskInstance', - ], - 'TaskIds' => [ - 'title' => '调度任务Ids', - 'description' => 'The IDs of the auto triggered nodes of which the instances are successfully run.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the auto triggered node.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000', - ], - ], - ], - ], - 'RuntimeConf' => [ - 'title' => '扩展配置', - 'description' => 'The configuration of the data source. The value of the queue field is default, and that of the sqlEngine field can be set to SPARK_SQL, KYUUBI, PRESTO_SQL, or HIVE_SQL. The value default indicates the YARN queue for E-MapReduce (EMR) tasks.'."\n", - 'type' => 'string', - 'example' => '{ "queue": "default", "sqlEngine": "SPARK-SQL" }', - ], - 'Hooks' => [ - 'title' => '回调设置', - 'description' => 'The callback configurations of the task during the instance lifecycle. Blocking an auto triggered node is a type of callback event. Only this type is supported.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => 'Hook类型', - 'description' => 'The type of the callback event. Valid values:'."\n" - ."\n" - .'* BlockTaskInstance. The value indicates that an auto triggered node is blocked.', - 'type' => 'string', - 'example' => 'BlockTaskInstance', - ], - 'Condition' => [ - 'title' => 'Hook触发条件', - 'description' => 'The trigger configuration of the callback event.'."\n", - 'type' => 'string', - 'example' => '${severity} == "High" AND ${status} == "Critical"', - ], - ], - 'description' => 'Hook', - ], - ], - 'Notifications' => [ - 'title' => '通知订阅配置', - 'description' => 'The configurations for alert notifications.'."\n", - 'type' => 'object', - 'properties' => [ - 'Condition' => [ - 'title' => '通知触发条件', - 'description' => 'The trigger condition of the alert notification.'."\n", - 'type' => 'string', - 'example' => '${severity} == "High"', - ], - 'Notifications' => [ - 'title' => '通知设置', - 'description' => 'The configurations for the alert notification.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'NofiticationReceivers' => [ - 'title' => '告警接收人设置', - 'description' => 'The alert recipients.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ReceiverType' => [ - 'title' => '告警接收人类型', - 'description' => 'The type of the alert recipient. Valid values:'."\n" - ."\n" - .'* AliUid: Alibaba Cloud account ID'."\n" - .'* WebhookUrl: URL of a custom webhook'."\n" - .'* DingdingUrl: DingTalk chatbot URL'."\n" - .'* FeishuUrl: Lark chatbot URL'."\n" - .'* WeixinUrl: WeCom chatbot URL'."\n", - 'type' => 'string', - 'example' => 'AliUid', - ], - 'Extension' => [ - 'title' => '扩展信息', - 'description' => 'The extended information in the JSON format. For example, the DingTalk chatbot can remind all members in a DingTalk group by using the at sign (@).'."\n", - 'type' => 'string', - 'example' => '{"atAll":"true"}', - ], - 'ReceiverValues' => [ - 'title' => '告警接收人', - 'description' => 'The alert recipients.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The alert recipient.'."\n", - 'type' => 'string', - 'example' => '10000001', - ], - ], - ], - 'description' => '告警接收人设置', - ], - ], - 'NotificationChannels' => [ - 'title' => '通知方式', - 'description' => 'The alert notification methods.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Channels' => [ - 'title' => '通知方式', - 'description' => 'The alert notification methods.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '* Mail'."\n" - .'* Sms'."\n" - .'* Phone'."\n" - .'* Feishu'."\n" - .'* Weixin: WeCom notification'."\n" - .'* Dingding'."\n" - .'* Webhook', - 'type' => 'string', - 'example' => 'Mail', - ], - ], - ], - 'description' => '通知方式', - ], - 'deprecated' => false, - ], - ], - 'description' => '通知设置', - ], - ], - ], - ], - 'Name' => [ - 'title' => '质量监控任务名称', - 'description' => 'The name of the monitor.'."\n", - 'type' => 'string', - 'deprecated' => false, - 'required' => true, - 'example' => 'Quality verification task', - ], - ], - ], - ], - 'description' => '', - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '7C352CB7-CD88-XXXXXXX'], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'title' => '', 'example' => 'true'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-4ED****\\",\\n \\"PagingInfo\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 294,\\n \\"DataQualityEvaluationTaskInstances\\": [\\n {\\n \\"Id\\": 10001,\\n \\"CreateTime\\": 1710239005403,\\n \\"FinishTime\\": 1710239005403,\\n \\"Status\\": \\"Critical\\",\\n \\"Parameters\\": \\"{\\\\n \\\\\\"bizdate\\\\\\": \\\\\\"20240517\\\\\\",\\\\n \\\\\\"triggerTime\\\\\\": \\\\\\"1710239005403\\\\\\"\\\\n}\\",\\n \\"TriggerContext\\": \\"{\\\\n \\\\\\"TriggerClientId\\\\\\": 10001,\\\\n \\\\\\"TriggerClient\\\\\\": \\\\\\"CWF2\\\\\\"\\\\n}\\",\\n \\"ProjectId\\": 100,\\n \\"Task\\": {\\n \\"Id\\": 10001,\\n \\"Description\\": \\"This is a daily run data quality evaluation plan.\\",\\n \\"ProjectId\\": 100,\\n \\"Target\\": {\\n \\"Type\\": \\"Table\\",\\n \\"DatabaseType\\": \\"maxcompute\\",\\n \\"TableGuid\\": \\"odps.unit_test.tb_unit_test\\",\\n \\"PartitionSpec\\": \\"ds=$[yyyymmdd-1]\\"\\n },\\n \\"Trigger\\": {\\n \\"Type\\": \\"ByScheduledTaskInstance\\",\\n \\"TaskIds\\": [\\n 10000\\n ]\\n },\\n \\"RuntimeConf\\": \\"{ \\\\\\"queue\\\\\\": \\\\\\"default\\\\\\", \\\\\\"sqlEngine\\\\\\": \\\\\\"SPARK_SQL\\\\\\" }\\",\\n \\"Hooks\\": [\\n {\\n \\"Type\\": \\"BlockTaskInstance\\",\\n \\"Condition\\": \\"${severity} == \\\\\\"High\\\\\\" AND ${status} == \\\\\\"Critical\\\\\\"\\"\\n }\\n ],\\n \\"Notifications\\": {\\n \\"Condition\\": \\"${severity} == \\\\\\"High\\\\\\"\\",\\n \\"Notifications\\": [\\n {\\n \\"NofiticationReceivers\\": [\\n {\\n \\"ReceiverType\\": \\"AliUid\\",\\n \\"Extension\\": \\"{\\\\\\"atAll\\\\\\":\\\\\\"true\\\\\\"}\\",\\n \\"ReceiverValues\\": [\\n \\"10000001\\"\\n ]\\n }\\n ],\\n \\"NotificationChannels\\": [\\n {\\n \\"Channels\\": [\\n \\"Mail\\"\\n ]\\n }\\n ]\\n }\\n ]\\n },\\n \\"Name\\": \\"Quality verification task\\"\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListDataQualityEvaluationTaskInstances', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", - ], - 'ListDataQualityResults' => [ - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"7C352CB7-CD88-XXXXXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'UpdateTableBusinessMetadata', + 'description' => '1. You must purchase DataWorks Basic Edition or a later version to use this operation.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'UpdateTask' => [ + 'summary' => 'Updates a specified node. The modifications are synchronized to DataStudio, where a new saved version is created.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '240397', - 'abilityTreeNodes' => [ - 'FEATUREdideGK4B66', - ], - 'autoTest' => true, + 'abilityTreeCode' => '247744', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB', 'FEATUREdideD0YY7B', 'FEATUREdideVFMENL'], ], 'parameters' => [ [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '100', - ], + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => 'The node ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234', 'title' => ''], ], [ - 'name' => 'DataQualityRuleId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the data quality monitoring rule.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '100001', - ], + 'name' => 'ClientUniqueCode', + 'in' => 'formData', + 'schema' => ['description' => 'The client unique code of the node, used to uniquely identify a node. This code is used to implement asynchronous operations and idempotence. If not specified during creation, the system automatically generates one, and the code is uniquely bound to the resource ID. When updating or deleting a resource, if this parameter is specified, it must be consistent with the client unique code used during creation.', 'type' => 'string', 'required' => false, 'example' => 'Task_0bc5213917368545132902xxxxxxxx', 'title' => ''], ], [ - 'name' => 'DataQualityEvaluationTaskId', - 'in' => 'query', + 'name' => 'EnvType', + 'in' => 'formData', 'schema' => [ - 'description' => 'The ID of the data quality monitoring task.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The project environment. Valid values:'."\n" + .'- Prod: production.'."\n" + .'- Dev: development.', + 'enumValueTitles' => [], + 'type' => 'string', + 'default' => 'Prod', + 'enum' => ['Prod', 'Dev'], 'required' => false, - 'example' => '200001', + 'example' => 'Prod', + 'title' => '', ], ], [ - 'name' => 'DataQualityEvaluationTaskInstanceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the instance generated by the check.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10001', - ], + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['description' => 'The name.', 'type' => 'string', 'required' => false, 'example' => 'SQL node', 'title' => ''], ], [ - 'name' => 'CreateTimeFrom', - 'in' => 'query', - 'schema' => [ - 'description' => 'The earliest time when the data quality check result was generated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1710239005403', - ], + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['description' => 'The description.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'CreateTimeTo', - 'in' => 'query', - 'schema' => [ - 'description' => 'The latest time when the data quality check result was generated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1710239005403', - ], + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => ['description' => 'The account ID of the node owner.', 'type' => 'string', 'required' => false, 'example' => '1000', 'title' => ''], ], [ - 'name' => 'BizdateFrom', - 'in' => 'query', + 'name' => 'InstanceMode', + 'in' => 'formData', 'schema' => [ - 'description' => 'The beginning of the time range to query.'."\n", + 'description' => 'The instance generation mode. Valid values:'."\n" + .'- T+1: The instance is generated the next day.'."\n" + .'- Immediately: The instance is generated immediately. Note: Only periodic instances whose scheduled time is at least ten minutes after the node publish time are generated normally. During the full instance generation period (22:00 to 24:00), real-time instance generation is not available. You can submit and publish nodes, but new nodes do not automatically generate instances.', + 'enumValueTitles' => [], 'type' => 'string', 'required' => false, - 'example' => '2024-05-01', + 'default' => 'T+1', + 'enum' => ['T+1', 'Immediately'], + 'example' => 'T+1', + 'title' => '', ], ], [ - 'name' => 'BizdateTo', - 'in' => 'query', + 'name' => 'Timeout', + 'in' => 'formData', + 'schema' => ['description' => 'The node execution timeout period, in seconds. The value must be greater than 3600.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3600', 'title' => ''], + ], + [ + 'name' => 'RerunMode', + 'in' => 'formData', 'schema' => [ - 'description' => 'The end of the time range to query.'."\n", + 'description' => 'Specifies whether the node can be rerun. Valid values:'."\n" + .'- AllDenied: The node cannot be rerun regardless of whether it succeeds or fails.'."\n" + .'- FailureAllowed: The node can be rerun only when it fails.'."\n" + .'- AllAllowed: The node can be rerun regardless of whether it succeeds or fails.', + 'enumValueTitles' => [], 'type' => 'string', 'required' => false, - 'example' => '2024-05-04', + 'enum' => ['AllAllowed', 'FailureAllowed', 'AllDenied'], + 'example' => 'AllAllowed', + 'title' => '', ], ], [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '200', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], + 'name' => 'RerunTimes', + 'in' => 'formData', + 'schema' => ['description' => 'The number of retries. This parameter takes effect when the node is configured to allow reruns.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], ], [ - 'name' => 'PageNumber', - 'in' => 'query', + 'name' => 'RerunInterval', + 'in' => 'formData', + 'schema' => ['description' => 'The retry time interval, in milliseconds. The value cannot exceed 1800000.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60000', 'title' => ''], + ], + [ + 'name' => 'Script', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - 'default' => '1', + 'description' => 'The script information.', + 'type' => 'object', + 'properties' => [ + 'Content' => ['description' => 'The script content.', 'type' => 'string', 'deprecated' => true, 'required' => false, 'example' => 'echo "helloWorld"', 'title' => ''], + 'Parameters' => ['description' => 'The list of script parameters.', 'type' => 'string', 'required' => false, 'example' => 'para1=$bizdate', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'Trigger', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => 'PaginatedModel', - 'description' => 'The response parameters.'."\n", + 'description' => 'The node trigger method.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '追踪ID，用于跟踪一次完整调用，出现异常时可以根据这个字符串排查异常链路', - 'description' => 'The request ID.'."\n", + 'Type' => [ + 'title' => '', + 'description' => 'The trigger type. Valid values:'."\n" + .'- Scheduler: periodic scheduling trigger.'."\n" + .'- Manual: manual trigger.', + 'enumValueTitles' => [], 'type' => 'string', - 'example' => '691CA452-D37A-4ED0-9441', + 'required' => false, + 'enum' => ['Scheduler', 'Manual'], + 'example' => 'Scheduler', ], - 'PagingInfo' => [ - '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.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '219', - ], - 'DataQualityResults' => [ - 'description' => 'The data quality check results.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data quality check result.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the check result.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16033', - ], - 'Status' => [ - 'description' => 'The status of the check result. Valid values:'."\n" - ."\n" - .'* Running'."\n" - .'* Error'."\n" - .'* Passed'."\n" - .'* Warned'."\n" - .'* Critical'."\n", - 'type' => 'string', - 'example' => 'PASSED', - ], - 'CreateTime' => [ - 'description' => 'The time when the data quality check result was generated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1708284916414', - ], - 'TaskInstanceId' => [ - 'description' => 'The ID of the instance generated by the check.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200001', - ], - 'Sample' => [ - 'description' => 'The sample values used for the check.'."\n", - 'type' => 'string', - 'example' => '['."\n" - .' {'."\n" - .' "gender": "male",'."\n" - .' "_count": 100'."\n" - .' }, {'."\n" - .' "gender": "female",'."\n" - .' "_count": 100'."\n" - .' }'."\n" - .']', - ], - 'Details' => [ - 'description' => 'The information about the data quality check.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the data quality check.'."\n", - 'type' => 'object', - 'properties' => [ - 'ReferencedValue' => [ - 'description' => 'The value that is calculated based on sample data. The value serves as a baseline value during the calculation of the value of the CheckedValue parameter.'."\n", - 'type' => 'string', - 'example' => '0.0', - ], - 'CheckedValue' => [ - 'description' => 'The value that is used for comparison with the threshold.'."\n", - 'type' => 'string', - 'example' => '100.0', - ], - 'Status' => [ - 'description' => 'The comparison result between the value of CheckedValue and the threshold. Valid values:'."\n" - ."\n" - .'* Error'."\n" - .'* Passed'."\n" - .'* Warned'."\n" - .'* Critical'."\n", - 'type' => 'string', - 'example' => 'PASSED', - ], - ], - ], - ], - 'Rule' => [ - 'description' => 'The snapshot of the rule configuration when the check starts.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The rule ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100001', - ], - 'Name' => [ - 'description' => 'The name of the rule. The name can be up to 255 characters in length and can contain digits, letters, and punctuation marks.'."\n", - 'type' => 'string', - 'example' => 'The table cannot be empty.', - ], - 'ProjectId' => [ - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100', - ], - 'Enabled' => [ - 'description' => 'Indicates whether the rule is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Severity' => [ - 'description' => 'The strength of the rule. Valid values:'."\n" - ."\n" - .'* High'."\n" - .'* Normal'."\n", - 'type' => 'string', - 'example' => 'NORMAL', - ], - 'Description' => [ - 'description' => 'The description of the rule. The description can be up to 500 characters in length.'."\n", - 'type' => 'string', - 'example' => 'this is a odps _sql task', - ], - 'TemplateCode' => [ - 'description' => 'The code of the template that is referenced when you create a rule.'."\n", - 'type' => 'string', - 'example' => 'system::user_defined', - ], - 'Target' => [ - 'description' => 'The monitored object of the rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the monitored object. Valid values:'."\n" - ."\n" - .'* Table'."\n", - 'type' => 'string', - 'example' => 'TABLE', - ], - 'DatabaseType' => [ - 'description' => 'The type of the database to which the table belongs. Valid values:'."\n" - ."\n" - .'* maxcompute'."\n" - .'* emr'."\n" - .'* cdh'."\n" - .'* hologres'."\n" - .'* analyticdb_for_postgresql'."\n" - .'* analyticdb_for_mysql'."\n" - .'* starrocks'."\n", - 'type' => 'string', - 'example' => 'MAX_COMPUTE', - ], - 'TableGuid' => [ - 'description' => 'The ID of the table in Data Map.'."\n", - 'type' => 'string', - 'example' => 'odps.unit_test.tb_unit_test', - ], - ], - ], - 'SamplingConfig' => [ - 'description' => 'The sampling settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Metric' => [ - 'description' => 'The metrics used for sampling. Valid values:'."\n" - ."\n" - .'* Count: the number of rows in the table.'."\n" - .'* Min: the minimum value of the field.'."\n" - .'* Max: the maximum value of the field.'."\n" - .'* Avg: the average value of the field.'."\n" - .'* DistinctCount: the number of unique values of the field after deduplication.'."\n" - .'* DistinctPercent: the proportion of the number of unique values of the field after deduplication to the number of rows in the table.'."\n" - .'* DuplicatedCount: the number of duplicated values of the field.'."\n" - .'* DuplicatedPercent: the proportion of the number of duplicated values of the field to the number of rows in the table.'."\n" - .'* TableSize: the table size.'."\n" - .'* NullValueCount: the number of rows in which the field value is null.'."\n" - .'* NullValuePercent: the proportion of the number of rows in which the field value is null to the number of rows in the table.'."\n" - .'* GroupCount: the field value and the number of rows for each field value.'."\n" - .'* CountNotIn: the number of rows in which the field values are different from the referenced values that you specified in the rule.'."\n" - .'* CountDistinctNotIn: the number of unique values that are different from the referenced values that you specified in the rule after deduplication.'."\n" - .'* UserDefinedSql: indicates that data is sampled by executing custom SQL statements.'."\n", - 'type' => 'string', - 'example' => 'COUNT', - ], - 'MetricParameters' => [ - 'description' => 'The parameters required for sampling.'."\n", - 'type' => 'string', - 'example' => '{ "columns": [ "id", "name" ] }', - ], - 'SettingConfig' => [ - 'description' => 'The statements that are used to configure the parameters required for sampling before you execute the sampling statements. The statements can be up to 1,000 characters in length. Only the MaxCompute database is supported.'."\n", - 'type' => 'string', - 'example' => 'SET odps.sql.udf.timeout=600s; ', - ], - 'SamplingFilter' => [ - 'description' => 'The statements that are used to filter unnecessary data during sampling. The statements can be up to 16,777,215 characters in length.'."\n", - 'type' => 'string', - 'example' => 'id IS NULL', - ], - ], - ], - 'CheckingConfig' => [ - 'description' => 'The check settings for sample data.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The threshold calculation method. Valid values:'."\n" - ."\n" - .'* Fixed'."\n" - .'* Fluctation'."\n" - .'* FluctationDiscreate'."\n" - .'* Auto'."\n" - .'* Average'."\n" - .'* Variance'."\n", - 'type' => 'string', - 'example' => 'FIXED', - ], - 'ReferencedSamplesFilter' => [ - 'description' => 'The method that is used to query the referenced samples. To obtain some types of thresholds, you need to query reference samples and perform aggregate operations on the reference values. In this example, an expression is used to indicate the query method of referenced samples.'."\n", - 'type' => 'string', - 'example' => '{ "bizdate": [ "-1", "-7", "-1m" ] }', - ], - 'Thresholds' => [ - 'description' => 'The threshold settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Expected' => [ - 'description' => 'The expected threshold setting.'."\n", - 'type' => 'object', - 'properties' => [ - 'Value' => [ - 'description' => 'The threshold value.'."\n", - 'type' => 'string', - 'example' => '100.0', - ], - 'Operator' => [ - 'description' => 'The comparison operator. Valid values:'."\n" - ."\n" - .'* \\>'."\n" - .'* \\>='."\n" - .'* <'."\n" - .'* <='."\n" - .'* !='."\n" - .'* \\='."\n", - 'type' => 'string', - 'example' => '>', - ], - 'Expression' => [ - 'description' => 'The threshold expression.'."\n" - ."\n" - .'If the template specified by the TemplateCode parameter is about fluctuation, you must use an expression to represent the threshold for fluctuation. Examples:'."\n" - ."\n" - .'* $checkValue > 0.01'."\n" - .'* $checkValue < -0.01'."\n" - .'* abs($checkValue) > 0.01'."\n" - ."\n" - .'If the template specified by the TemplateCode parameter is about fixed value, you can also use an expression to represent the threshold. If you configure the Expression, Operator, and Value parameters for the threshold at the same time, the Expression parameter takes precedence over the Operator and Value parameters.'."\n", - 'type' => 'string', - 'example' => '$checkValue > 0.01', - ], - ], - ], - 'Warned' => [ - 'description' => 'The threshold settings for normal alerts.'."\n", - 'type' => 'object', - 'properties' => [ - 'Value' => [ - 'description' => 'The threshold value.'."\n", - 'type' => 'string', - 'example' => '100.0', - ], - 'Operator' => [ - 'description' => 'The comparison operator. Valid values:'."\n" - ."\n" - .'* \\>'."\n" - .'* \\>='."\n" - .'* <'."\n" - .'* <='."\n" - .'* !='."\n" - .'* \\='."\n", - 'type' => 'string', - 'example' => '>', - ], - 'Expression' => [ - 'description' => 'The threshold expression.'."\n" - ."\n" - .'If the template specified by the TemplateCode parameter is about fluctuation, you must use an expression to represent the threshold for fluctuation. Examples:'."\n" - ."\n" - .'* $checkValue > 0.01'."\n" - .'* $checkValue < -0.01'."\n" - .'* abs($checkValue) > 0.01'."\n" - ."\n" - .'If the template specified by the TemplateCode parameter is about fixed value, you can also use an expression to represent the threshold. If you configure the Expression, Operator, and Value parameters for the threshold at the same time, the Expression parameter takes precedence over the Operator and Value parameters.'."\n", - 'type' => 'string', - 'example' => ' $checkValue > 0.01', - ], - ], - ], - 'Critical' => [ - 'description' => 'The threshold settings for critical alerts.'."\n", - 'type' => 'object', - 'properties' => [ - 'Value' => [ - 'description' => 'The threshold value.'."\n", - 'type' => 'string', - 'example' => '100.0', - ], - 'Operator' => [ - 'description' => 'The comparison operator. Valid values:'."\n" - ."\n" - .'* \\>'."\n" - .'* \\>='."\n" - .'* <'."\n" - .'* <='."\n" - .'* !='."\n" - .'* \\='."\n", - 'type' => 'string', - 'example' => '>', - ], - 'Expression' => [ - 'description' => 'The threshold expression.'."\n" - ."\n" - .'If the template specified by the TemplateCode parameter is about fluctuation, you must use an expression to represent the threshold for fluctuation. Examples:'."\n" - ."\n" - .'* $checkValue > 0.01'."\n" - .'* $checkValue < -0.01'."\n" - .'* abs($checkValue) > 0.01'."\n" - ."\n" - .'If the template specified by the TemplateCode parameter is about fixed value, you can also use an expression to represent the threshold. If you configure the Expression, Operator, and Value parameters for the threshold at the same time, the Expression parameter takes precedence over the Operator and Value parameters.'."\n", - 'type' => 'string', - 'example' => ' $checkValue > 0.01', - ], - ], - ], - ], - ], - ], - ], - 'ErrorHandlers' => [ - 'description' => 'The operations that you can perform after the rule-based check fails.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The operation that you can perform after the rule-based check fails.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the operation. Valid values:'."\n" - ."\n" - .'* SaveErrorData'."\n", - 'type' => 'string', - 'example' => 'SAVE_ERROR_DATA', - ], - 'ErrorDataFilter' => [ - 'description' => 'The SQL statement that is used to filter failed tasks. If the rule is defined by custom SQL statements, you must specify an SQL statement to filter failed tasks.'."\n", - 'type' => 'string', - 'example' => 'SELECT * FROM tb_api_log WHERE id IS NULL', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], + 'Recurrence' => [ + 'description' => 'The run mode when triggered. This parameter takes effect when Type is set to Scheduler. Valid values:'."\n" + .'- Pause: paused.'."\n" + .'- Skip: dry run.'."\n" + .'- Normal: normal run.', + 'enumValueTitles' => [], + 'type' => 'string', + 'enum' => ['Normal', 'Skip', 'Pause'], + 'required' => false, + 'example' => 'Normal', + 'title' => '', + ], + 'Cron' => ['description' => 'The cron expression. This parameter takes effect when Type is set to Scheduler.', 'type' => 'string', 'required' => false, 'example' => '00 00 00 * * ?', 'title' => ''], + 'StartTime' => ['description' => 'The effective period of the epoch trigger. This parameter takes effect when Type is set to Scheduler. Format: `yyyy-mm-dd hh:mm:ss`.', 'type' => 'string', 'required' => false, 'example' => '1970-01-01 00:00:00', 'title' => ''], + 'EndTime' => ['description' => 'The expiration time of the periodic trigger. This parameter takes effect when Type is set to Scheduler. Format: `yyyy-mm-dd hh:mm:ss`.', 'type' => 'string', 'required' => false, 'example' => '9999-01-01 00:00:00', 'title' => ''], + 'CycleType' => [ + 'description' => 'The epoch type. This parameter takes effect when Type is set to Scheduler and the cron expression specifies timed scheduling at a specific hour. Default value: Daily. Valid values:'."\n" + .'- Daily: daily scheduling.'."\n" + .'- NotDaily: hourly scheduling.', + 'type' => 'string', + 'enum' => ['Daily', 'NotDaily'], + 'required' => false, + 'example' => 'Daily', + 'title' => '', ], ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-****\\",\\n \\"PagingInfo\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 219,\\n \\"DataQualityResults\\": [\\n {\\n \\"Id\\": 16033,\\n \\"Status\\": \\"Passed\\",\\n \\"CreateTime\\": 1708284916414,\\n \\"TaskInstanceId\\": 200001,\\n \\"Sample\\": \\"[\\\\n {\\\\n \\\\\\"gender\\\\\\": \\\\\\"male\\\\\\",\\\\n \\\\\\"_count\\\\\\": 100\\\\n }, {\\\\n \\\\\\"gender\\\\\\": \\\\\\"female\\\\\\",\\\\n \\\\\\"_count\\\\\\": 100\\\\n }\\\\n]\\",\\n \\"Details\\": [\\n {\\n \\"ReferencedValue\\": \\"0.0\\",\\n \\"CheckedValue\\": \\"100.0\\",\\n \\"Status\\": \\"Passed\\"\\n }\\n ],\\n \\"Rule\\": {\\n \\"Id\\": 100001,\\n \\"Name\\": \\"The table cannot be empty.\\",\\n \\"ProjectId\\": 100,\\n \\"Enabled\\": true,\\n \\"Severity\\": \\"Normal\\",\\n \\"Description\\": \\"this is a odps _sql task\\",\\n \\"TemplateCode\\": \\"SYSTEM:user_defined_sql\\",\\n \\"Target\\": {\\n \\"Type\\": \\"Table\\",\\n \\"DatabaseType\\": \\"maxcompute\\",\\n \\"TableGuid\\": \\"odps.unit_test.tb_unit_test\\"\\n },\\n \\"SamplingConfig\\": {\\n \\"Metric\\": \\"Count\\",\\n \\"MetricParameters\\": \\"{ \\\\\\"columns\\\\\\": [ \\\\\\"id\\\\\\", \\\\\\"name\\\\\\" ] }\\",\\n \\"SettingConfig\\": \\"SET odps.sql.udf.timeout=600s; \\",\\n \\"SamplingFilter\\": \\"id IS NULL\\"\\n },\\n \\"CheckingConfig\\": {\\n \\"Type\\": \\"Fixed\\",\\n \\"ReferencedSamplesFilter\\": \\"{ \\\\\\"bizdate\\\\\\": [ \\\\\\"-1\\\\\\", \\\\\\"-7\\\\\\", \\\\\\"-1m\\\\\\" ] }\\",\\n \\"Thresholds\\": {\\n \\"Expected\\": {\\n \\"Value\\": \\"100.0\\",\\n \\"Operator\\": \\">\\",\\n \\"Expression\\": \\"$checkValue > 0.01\\"\\n },\\n \\"Warned\\": {\\n \\"Value\\": \\"100.0\\",\\n \\"Operator\\": \\">\\",\\n \\"Expression\\": \\" $checkValue > 0.01\\"\\n },\\n \\"Critical\\": {\\n \\"Value\\": \\"100.0\\",\\n \\"Operator\\": \\">\\",\\n \\"Expression\\": \\" $checkValue > 0.01\\"\\n }\\n }\\n },\\n \\"ErrorHandlers\\": [\\n {\\n \\"Type\\": \\"SaveErrorData\\\\n\\",\\n \\"ErrorDataFilter\\": \\"SELECT * FROM tb_api_log WHERE id IS NULL\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListDataQualityResults', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", - ], - 'DetachDataQualityRulesFromEvaluationTask' => [ - 'summary' => 'Disassociates monitoring rules from a data quality monitoring task.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '250890', - 'abilityTreeNodes' => [ - 'FEATUREdide3WJOKE', - ], - ], - 'parameters' => [ [ - 'name' => 'ProjectId', + 'name' => 'RuntimeResource', 'in' => 'formData', + 'style' => 'json', '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 configuration page to obtain the workspace ID.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '10002', + 'description' => 'The environment configuration, such as resource group information.', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupId' => ['description' => 'The identifier of the schedule resource group configured for the node.', 'type' => 'string', 'required' => false, 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', 'title' => ''], + 'Image' => ['description' => 'The image ID configured for the node.', 'type' => 'string', 'required' => false, 'example' => 'i-xxxxxx', 'title' => ''], + 'Cu' => ['description' => 'The CU consumption configured for the node.', 'type' => 'string', 'required' => false, 'example' => '0.25', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'DataQualityEvaluationTaskId', + 'name' => 'DataSource', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The ID of the data quality monitoring task that is associated with the rule.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '10000', + 'description' => 'The associated data source information.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The data source name.', 'type' => 'string', 'required' => false, 'example' => 'odps_test', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'DataQualityRuleIds', + 'name' => 'Inputs', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'The IDs of the monitoring rules.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the monitoring rule.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '200001', + 'description' => 'The input information.', + 'type' => 'object', + 'properties' => [ + 'Variables' => [ + 'description' => 'The list of variable definitions.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '', + 'description' => 'The type. Valid values:'."\n" + .'- Constant: constant.'."\n" + .'- PassThrough: parameter node output.'."\n" + .'- System: variable.'."\n" + .'- NodeOutput: script output.', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => true, + 'enum' => ['System', 'Constant', 'NodeOutput', 'PassThrough'], + 'example' => 'Constant', + ], + 'Value' => ['description' => 'The variable value.', 'type' => 'string', 'required' => false, 'example' => 'value1', 'title' => ''], + 'Name' => ['description' => 'The variable name.', 'type' => 'string', 'required' => false, 'example' => 'key1', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], ], - 'required' => true, - 'docRequired' => true, + 'required' => false, + 'title' => '', + 'example' => '', ], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'Outputs', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The output information.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => '8abcb91f-d266-4073-b907-2ed670378ed1', + 'TaskOutputs' => [ + 'description' => 'The list of node output definitions.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Output' => ['title' => '', 'description' => 'The output identifier.', 'type' => 'string', 'required' => false, 'example' => 'pre.odps_sql_demo_0'], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'Success' => [ - 'description' => 'Whether the call is successful. The values are as follows:'."\n" - .'- true: The call is successful.'."\n" - .'- false: the call failed.', - 'type' => 'boolean', - 'example' => 'true', + 'Variables' => [ + 'description' => 'The list of variable definitions.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '', + 'description' => 'The type. Valid values:'."\n" + .'- Constant: constant.'."\n" + .'- PassThrough: parameter node output.'."\n" + .'- System: variable.'."\n" + .'- NodeOutput: script output.', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => true, + 'enum' => ['System', 'Constant', 'NodeOutput', 'PassThrough'], + 'example' => 'Constant', + ], + 'Value' => ['description' => 'The variable value.', 'type' => 'string', 'required' => false, 'example' => 'value1', 'title' => ''], + 'Name' => ['description' => 'The variable name.', 'type' => 'string', 'required' => false, 'example' => 'key1', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8abcb91f-d266-4073-b907-2ed6****\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'DetachDataQualityRulesFromEvaluationTask', - ], - 'DeleteDataQualityEvaluationTask' => [ - 'summary' => 'Deletes a data quality monitoring task.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '250885', - 'abilityTreeNodes' => [ - 'FEATUREdide3WJOKE', - ], - ], - 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'query', + 'name' => 'Dependencies', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The ID of the data quality monitor.', - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The dependency information.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '', + 'description' => 'The dependency type. Valid values:'."\n" + .'- CrossCycleDependsOnChildren: cross-cycle dependency on first-level child nodes.'."\n" + .'- CrossCycleDependsOnSelf: cross-cycle dependency on self.'."\n" + .'- CrossCycleDependsOnOtherNode: cross-cycle dependency on other nodes.'."\n" + .'- Normal: same-cycle dependency.', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => true, + 'enum' => ['Normal', 'CrossCycleDependsOnSelf', 'CrossCycleDependsOnChildren', 'CrossCycleDependsOnOtherNode'], + 'example' => 'Normal', + ], + 'UpstreamOutput' => ['title' => '', 'description' => 'The output identifier of the upstream node. This field is returned when the dependency type is same-cycle dependency and input content is configured.', 'type' => 'string', 'required' => false, 'example' => 'pre.odps_sql_demo_0'], + 'UpstreamTaskId' => ['description' => 'The ID of the upstream node. This field is returned when the dependency type is cross-cycle dependency on other nodes, or same-cycle dependency without input content configured. It is not returned in other cases.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => false, - 'docRequired' => true, - 'example' => '123123', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ProjectId', - 'in' => 'query', + 'name' => 'Tags', + 'in' => 'formData', + 'style' => 'json', '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 ID.'."\n" - ."\n" - .'This parameter is used to determine the DataWorks workspaces used for this API call.', - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The list of node tags.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'value1', 'title' => ''], + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => true, 'example' => 'key1', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => false, - 'docRequired' => true, - 'example' => '10000', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '0bc1ec92159376****', - ], - 'Success' => [ - 'description' => 'Whether the deletion is successful.'."\n" - .'- true: Successful'."\n" - .'- false: Failed', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => 'The request ID, used for locating logs and troubleshooting issues.', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IdempotentParameterMismatch', - 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'gatewayOptions' => [ + 'gatewayProtocols' => [], + ], + 'title' => 'Update a node', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0bc1ec92159376****\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'DeleteDataQualityEvaluationTask', ], - 'GetDataQualityEvaluationTaskInstance' => [ - 'summary' => 'Queries the details of a monitor instance.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], + 'UpdateTaskInstances' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '250220', - 'abilityTreeNodes' => [ - 'FEATUREdideGK4B66', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '245367', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB'], ], 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the data quality monitoring instance.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '7227550902', - ], - ], - ], - 'responses' => [ - 200 => [ + 'name' => 'TaskInstances', + 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'title' => 'Schema of Response', - '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' => '8abcb91f-d266-4073-b907-2ed670378ed1', - ], - 'DataQualityEvaluationTaskInstance' => [ - 'description' => 'The details of the monitor instance.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status of the data quality monitoring instance.'."\n" - .'- Running: Verifying'."\n" - .'- Error: A rule verification Error occurred.'."\n" - .'- Passed: all rules are verified'."\n" - .'- Warned: normal alarm threshold triggered by rules'."\n" - .'- Critical: Threshold for serious alerts triggered by rules', - 'type' => 'string', - 'example' => 'Passed', - ], - 'Task' => [ - 'description' => 'The monitor.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the monitor.'."\n", - 'type' => 'string', - 'example' => 'Data quality OpenAPI monitoring test'."\n", - ], - 'Notifications' => [ - 'description' => 'The configurations of alert notifications.'."\n", - 'type' => 'object', - 'properties' => [ - 'Condition' => [ - 'description' => 'The notification trigger condition. When this condition is met, the alert notification is triggered. Only two conditional expressions are supported:'."\n" - ."\n" - .'* Specify only one group of rule strength type and rule check status, such as `${severity} == "High" AND ${status} == "Critical"`. In this expression, the hook trigger condition is met if severity is High and status is Critical.'."\n" - .'* Specify multiple groups of rule strength types and rule check status, such as `(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")`. In this expression, the hook trigger condition is met if severity is High and status is Critical, severity is Normal and status is Critical, or severity is Normal and status is Error. The enumeration of severity in a conditional expression is the same as the enumeration of severity in DataQualityRule. The enumeration of status in a conditional expression is the same as the enumeration of status in DataQualityResult.'."\n", - 'type' => 'string', - 'example' => '${severity} == "High" AND ${status} == "Critical"', - ], - 'Notifications' => [ - 'description' => 'The alert notification methods.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'NotificationReceivers' => [ - 'description' => 'The value of the receiver.', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ReceiverType' => [ - 'description' => 'The type of alert recipient.', - 'type' => 'string', - 'example' => 'DingdingUrl', - ], - 'Extension' => [ - 'description' => 'Additional parameter settings for sending alerts in json format. The supported keys are as follows:'."\n" - ."\n" - .'- atAll: when sending DingTalk alerts, do you need to @ everyone in the group. It takes effect when ReceiverType is DingdingUrl.', - 'type' => 'string', - 'example' => '{ "atAll": true }', - ], - 'ReceiverValues' => [ - 'description' => 'The recipient of the alert.', - 'type' => 'array', - 'items' => [ - 'description' => 'The value of the receiver.'."\n" - ."\n" - .'- When the receiver type is Alibaba Cloud ID, the receiver value is the specific Alibaba cloud user ID.'."\n" - .'- When the receiver type is DingdingUrl, the receiver value is the alert address of the specific DingTalk robot.'."\n" - .'- When the receiver type is WeixinUrl, the receiver value is the alert address of the specific Enterprise WeChat.'."\n" - .'- When the receiver type is FeishuUrl, the receiver value is the alert address of the specific flying book.'."\n" - .'- When the receiver type is WebhookUrl, the receiver value is the alert address of the specific custom Webhook.', - 'type' => 'string', - 'example' => 'https://api.fc.aliyuncs.com/webhook', - ], - ], - ], - ], - ], - 'NotificationChannels' => [ - 'description' => 'The notification method.', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Channels' => [ - 'description' => 'The notification method.', - 'type' => 'array', - 'items' => [ - 'description' => 'Alarm mode'."\n" - ."\n" - .'- Mail: Mail'."\n" - .'- Sms: Sms'."\n" - .'- Phone: Phone'."\n" - .'- Feishu: flying book'."\n" - .'- Weixin: WeChat'."\n" - .'- Dingding: DingTalk'."\n" - .'- Webhook: custom Webhook', - 'type' => 'string', - 'example' => 'Mail', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - 'Hooks' => [ - 'description' => 'The hook.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'Hook type. Currently, only one type is supported:'."\n" - ."\n" - .'- BlockTaskInstance: the blocking scheduling task continues to run. Data quality monitoring is triggered by the scheduling task. After the data quality monitoring is completed, the Hook.Condition is used to determine whether the blocking scheduling task continues to run.', - 'type' => 'string', - 'example' => 'BlockTaskInstance', - ], - 'Condition' => [ - 'description' => 'The hook trigger condition. When this condition is met, the hook action is triggered. Only two conditional expressions are supported:'."\n" - ."\n" - .'* Specify only one group of rule strength type and rule check status, such as `${severity} == "High" AND ${status} == "Critical"`. In this expression, the hook trigger condition is met if severity is High and status is Critical.'."\n" - .'* Specify multiple groups of rule strength types and rule check status, such as `(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")`. In this expression, the hook trigger condition is met if severity is High and status is Critical, severity is Normal and status is Critical, or severity is Normal and status is Error. The enumeration of severity in a conditional expression is the same as the enumeration of severity in DataQualityRule. The enumeration of status in a conditional expression is the same as the enumeration of status in DataQualityResult.'."\n", - 'type' => 'string', - 'example' => '(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")', - ], - ], - 'description' => '', - ], - ], - 'RuntimeConf' => [ - 'description' => 'Extended configuration, JSON-formatted string, takes effect only for EMR-type data quality monitoring.'."\n" - ."\n" - .'- queue: the yarn queue used when performing EMR data quality verification. The default queue is the queue configured for this project.'."\n" - .'- sqlEngine: SQL engine used when performing EMR data verification'."\n" - .' - HIVE_ SQL'."\n" - .' - SPARK_ SQL', - 'type' => 'string', - 'example' => '{ "queue": "default" }', - ], - 'Trigger' => [ - 'description' => 'The trigger configuration of the monitor.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The trigger type of the monitor. Valid values:'."\n" - ."\n" - .'* ByManual (default): The monitor is manually triggered.'."\n" - .'* ByScheduledTaskInstance: The monitor is triggered by the associated scheduling tasks.'."\n", - 'type' => 'string', - 'example' => 'ByScheduledTaskInstance', - ], - 'TaskIds' => [ - 'description' => 'The Id list of the scheduled task, which is valid when the Type is ByScheduledTaskInstance.', - 'type' => 'array', - 'items' => [ - 'description' => 'The Id of the scheduled task.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '70006236752324', - ], - ], - ], - ], - 'Target' => [ - 'description' => 'The monitored object of the monitor.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the monitoring object.'."\n" - .'- Table: Table', - 'type' => 'string', - 'example' => 'Table', - ], - 'DatabaseType' => [ - 'description' => 'The type of the database to which the table belongs.', - 'type' => 'string', - 'example' => 'maxcompute', - ], - 'TableGuid' => [ - 'description' => 'The unique ID of the table in the data map.', - 'type' => 'string', - 'example' => 'odps.api_trace.ods_d_api_log', - ], - 'PartitionSpec' => [ - 'description' => 'The partition range monitored.', - 'type' => 'string', - 'example' => 'pt=$[yyyymmdd-1]', - ], - ], - ], - 'Description' => [ - 'description' => 'The description of the monitor.'."\n", - 'type' => 'string', - 'example' => 'OpenAPI quality monitoring test', - ], - 'Id' => [ - 'description' => 'The ID of the data quality monitor.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '28544990', - ], - 'ProjectId' => [ - 'description' => 'The ID of the workspace.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20629', - ], - ], - ], - 'Parameters' => [ - 'description' => 'Data quality verification execution parameters in JSON format. The available keys are as follows:'."\n" - .'- triggerTime: the millisecond timestamp of the trigger time. The baseline time of the $[yyyymmdd] expression in the data range of data quality monitoring. Required.', - 'type' => 'string', - 'example' => '{ "triggerTime": 1733284062000 }'."\n", - ], - 'FinishTime' => [ - 'description' => 'The end time of the instance.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1716344665000', - ], - 'TriggerContext' => [ - 'description' => 'The context information when the instance is triggered, in JSON format. The possible keys are as follows:'."\n" - .'- TriggerClient: the trigger source of the data quality monitoring instance, such as CWF2 (scheduling system), may be added later.'."\n" - .'- TriggerClientId: associated with a specific business resource in the source system. For example, if TriggerClient is CWF2, the ID of the scheduling task is recorded here.', - 'type' => 'string', - 'example' => '{ "triggerClient": "CWF2", "triggerClientId": 70001238945 }', - ], - 'CreateTime' => [ - 'description' => 'The creation time.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1716344665000', - ], - 'Id' => [ - 'description' => 'The ID of the data quality monitoring instance.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '7234231689', - ], - 'ProjectId' => [ - 'description' => 'The ID of the workspace.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '98330', - ], - 'Results' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'Status' => [ - 'type' => 'string', - ], - 'CreateTime' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'TaskInstanceId' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'Sample' => [ - 'type' => 'string', - ], - 'Details' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ReferencedValue' => [ - 'type' => 'string', - ], - 'CheckedValue' => [ - 'type' => 'string', - ], - 'Status' => [ - 'type' => 'string', - ], - ], - ], - ], - 'Rule' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'Name' => [ - 'type' => 'string', - ], - 'ProjectId' => [ - 'type' => 'integer', - 'format' => 'int64', - ], - 'Enabled' => [ - 'type' => 'boolean', - ], - 'Severity' => [ - 'type' => 'string', - ], - 'Description' => [ - 'type' => 'string', - ], - 'TemplateCode' => [ - 'type' => 'string', - ], - 'Target' => [ - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'type' => 'string', - ], - 'DatabaseType' => [ - 'type' => 'string', - ], - 'TableGuid' => [ - 'type' => 'string', - ], - ], - ], - 'SamplingConfig' => [ - 'type' => 'object', - 'properties' => [ - 'Metric' => [ - 'type' => 'string', - ], - 'MetricParameters' => [ - 'type' => 'string', - ], - 'SettingConfig' => [ - 'type' => 'string', - ], - 'SamplingFilter' => [ - 'type' => 'string', - ], - ], - ], - 'CheckingConfig' => [ - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'type' => 'string', - ], - 'ReferencedSamplesFilter' => [ - 'type' => 'string', - ], - 'Thresholds' => [ - 'type' => 'object', - 'properties' => [ - 'Expected' => [ - 'type' => 'object', - 'properties' => [ - 'Value' => [ - 'type' => 'string', - ], - 'Operator' => [ - 'type' => 'string', - ], - 'Expression' => [ - 'type' => 'string', - ], - ], - ], - 'Warned' => [ - 'type' => 'object', - 'properties' => [ - 'Value' => [ - 'type' => 'string', - ], - 'Operator' => [ - 'type' => 'string', - ], - 'Expression' => [ - 'type' => 'string', - ], - ], - ], - 'Critical' => [ - 'type' => 'object', - 'properties' => [ - 'Value' => [ - 'type' => 'string', - ], - 'Operator' => [ - 'type' => 'string', - ], - 'Expression' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], - ], - 'ErrorHandlers' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'type' => 'string', - ], - 'ErrorDataFilter' => [ - 'type' => 'string', - ], - ], - ], - ], - ], - ], - ], - ], + 'description' => 'The instances.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The instance ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234', 'title' => ''], + 'Priority' => [ + 'description' => 'The priority of the instance. Valid values: 1, 3, 5, 7, and 8.'."\n" + ."\n" + .'A larger value indicates a higher priority. Default value: 1.', + 'enumValueTitles' => [1 => '1', 3 => '3', 5 => '5', 7 => '7', '8'], + 'type' => 'integer', + 'format' => 'int32', + 'enum' => ['1', '3', '5', '7', '8'], + 'required' => false, + 'example' => '1', + 'title' => '', + ], + 'RuntimeResource' => ['description' => 'The resource group information. Set this parameter to the ID of a resource group for scheduling.', 'type' => 'string', 'required' => false, 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', 'title' => ''], + 'DataSource' => [ + 'description' => 'The information about the associated data source.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the data source.', 'type' => 'string', 'required' => false, 'example' => 'mysql_test'."\n", 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], + 'required' => false, + 'maxItems' => 50, + 'title' => '', + 'example' => '', ], ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"8abcb91f-d266-4073-b907-2ed67****\\",\\n \\"DataQualityEvaluationTaskInstance\\": {\\n \\"Status\\": \\"Passed\\",\\n \\"Task\\": {\\n \\"Name\\": \\"Data quality OpenAPI monitoring test\\\\n\\",\\n \\"Notifications\\": {\\n \\"Condition\\": \\"${severity} == \\\\\\"High\\\\\\" AND ${status} == \\\\\\"Critical\\\\\\"\\",\\n \\"Notifications\\": [\\n {\\n \\"NotificationReceivers\\": [\\n {\\n \\"ReceiverType\\": \\"DingdingUrl\\",\\n \\"Extension\\": \\"{ \\\\\\"atAll\\\\\\": true }\\",\\n \\"ReceiverValues\\": [\\n \\"https://api.fc.aliyuncs.com/webhook\\"\\n ]\\n }\\n ],\\n \\"NotificationChannels\\": [\\n {\\n \\"Channels\\": [\\n \\"Mail\\"\\n ]\\n }\\n ]\\n }\\n ]\\n },\\n \\"Hooks\\": [\\n {\\n \\"Type\\": \\"BlockTaskInstance\\",\\n \\"Condition\\": \\"(${severity} == \\\\\\"High\\\\\\" AND ${status} == \\\\\\"Critical\\\\\\") OR (${severity} == \\\\\\"Normal\\\\\\" AND ${status} == \\\\\\"Critical\\\\\\") OR (${severity} == \\\\\\"Normal\\\\\\" AND ${status} == \\\\\\"Error\\\\\\")\\"\\n }\\n ],\\n \\"RuntimeConf\\": \\"{ \\\\\\"queue\\\\\\": \\\\\\"default\\\\\\" }\\",\\n \\"Trigger\\": {\\n \\"Type\\": \\"ByScheduledTaskInstance\\",\\n \\"TaskIds\\": [\\n 70006236752324\\n ]\\n },\\n \\"Target\\": {\\n \\"Type\\": \\"Table\\",\\n \\"DatabaseType\\": \\"maxcompute\\",\\n \\"TableGuid\\": \\"odps.api_trace.ods_d_api_log\\",\\n \\"PartitionSpec\\": \\"pt=$[yyyymmdd-1]\\"\\n },\\n \\"Description\\": \\"OpenAPI quality monitoring test\\",\\n \\"Id\\": 28544990,\\n \\"ProjectId\\": 20629\\n },\\n \\"Parameters\\": \\"{ \\\\\\"triggerTime\\\\\\": 1733284062000 }\\\\n\\",\\n \\"FinishTime\\": 1716344665000,\\n \\"TriggerContext\\": \\"{ \\\\\\"triggerClient\\\\\\": \\\\\\"CWF2\\\\\\", \\\\\\"triggerClientId\\\\\\": 70001238945 }\\",\\n \\"CreateTime\\": 1716344665000,\\n \\"Id\\": 7234231689,\\n \\"ProjectId\\": 98330,\\n \\"Results\\": [\\n {\\n \\"Id\\": 0,\\n \\"Status\\": \\"\\",\\n \\"CreateTime\\": 0,\\n \\"TaskInstanceId\\": 0,\\n \\"Sample\\": \\"\\",\\n \\"Details\\": [\\n {\\n \\"ReferencedValue\\": \\"\\",\\n \\"CheckedValue\\": \\"\\",\\n \\"Status\\": \\"\\"\\n }\\n ],\\n \\"Rule\\": {\\n \\"Id\\": 0,\\n \\"Name\\": \\"\\",\\n \\"ProjectId\\": 0,\\n \\"Enabled\\": true,\\n \\"Severity\\": \\"\\",\\n \\"Description\\": \\"\\",\\n \\"TemplateCode\\": \\"\\",\\n \\"Target\\": {\\n \\"Type\\": \\"\\",\\n \\"DatabaseType\\": \\"\\",\\n \\"TableGuid\\": \\"\\"\\n },\\n \\"SamplingConfig\\": {\\n \\"Metric\\": \\"\\",\\n \\"MetricParameters\\": \\"\\",\\n \\"SettingConfig\\": \\"\\",\\n \\"SamplingFilter\\": \\"\\"\\n },\\n \\"CheckingConfig\\": {\\n \\"Type\\": \\"\\",\\n \\"ReferencedSamplesFilter\\": \\"\\",\\n \\"Thresholds\\": {\\n \\"Expected\\": {\\n \\"Value\\": \\"\\",\\n \\"Operator\\": \\"\\",\\n \\"Expression\\": \\"\\"\\n },\\n \\"Warned\\": {\\n \\"Value\\": \\"\\",\\n \\"Operator\\": \\"\\",\\n \\"Expression\\": \\"\\"\\n },\\n \\"Critical\\": {\\n \\"Value\\": \\"\\",\\n \\"Operator\\": \\"\\",\\n \\"Expression\\": \\"\\"\\n }\\n }\\n },\\n \\"ErrorHandlers\\": [\\n {\\n \\"Type\\": \\"\\",\\n \\"ErrorDataFilter\\": \\"\\"\\n }\\n ]\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'GetDataQualityEvaluationTaskInstance', - ], - 'GetDataQualityEvaluationTask' => [ - 'summary' => 'Queries the details of a monitor.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'abilityTreeCode' => '250883', - 'abilityTreeNodes' => [ - 'FEATUREdide3WJOKE', - ], - 'tenantRelevance' => 'tenant', - ], - 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the data quality monitor.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'example' => '1006455182', - ], + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => ['description' => 'The remarks.', 'type' => 'string', 'required' => false, 'example' => 'this is a comment', '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', - 'type' => 'string', - 'example' => 'SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF', - ], - 'DataQualityEvaluationTask' => [ - 'description' => 'The details of the monitor.'."\n", + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX'."\n", 'title' => ''], + 'SuccessInfo' => [ + 'description' => 'The result of the batch operation, which is in the MAP structure. The instance ID serves as a key, and the result serves as a value.', 'type' => 'object', - 'properties' => [ - 'Target' => [ - 'title' => '参看 DataQualityTarget示例 数据质量校验任务的监控对象，参考 DataQualityTarget', - 'description' => 'The monitored object of the monitor.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '监控对象类型', - 'description' => 'The type of the monitoring object.'."\n" - ."\n" - .'- Table: Table.', - 'type' => 'string', - 'example' => 'Table', - ], - 'DatabaseType' => [ - 'title' => '表所属的数据库类型', - 'description' => 'The type of the database to which the table belongs. Valid values:'."\n" - ."\n" - .'* maxcompute'."\n" - .'* hologres'."\n" - .'* cdh'."\n" - .'* analyticdb_for_mysql'."\n" - .'* starrocks'."\n" - .'* emr'."\n" - .'* analyticdb_for_postgresql'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'maxcompute', - ], - 'TableGuid' => [ - 'title' => '表在数据地图中的唯一ID', - 'description' => 'The ID of the table in Data Map.'."\n", - 'type' => 'string', - 'example' => 'odps.meta_open_api_test_sz.test_partition_tbl', - ], - 'PartitionSpec' => [ - 'description' => 'Data quality monitoring partition range settings.', - 'type' => 'string', - 'example' => 'pt=$[yyyymmdd-1]', - ], - ], - ], - 'Description' => [ - 'title' => '质量监控任务描述', - 'description' => 'The description of the monitor.'."\n", - 'type' => 'string', - 'example' => 'The description of the quality monitoring task.', - ], - 'Trigger' => [ - 'title' => '数据质量校验任务的触发配置', - 'description' => 'The trigger configuration of the monitor.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '质量监控任务触发类型', - 'description' => 'The trigger type of the monitor. Valid values:'."\n" - ."\n" - .'* ByManual: The monitor is manually triggered.'."\n" - .'* ByScheduledTaskInstance: The monitor is triggered by associated scheduling tasks.'."\n" - .'* ByQualityNode: The monitor is triggered by created data quality monitoring nodes.'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'ByScheduledTaskInstance', - ], - 'TaskIds' => [ - 'title' => '调度任务Ids', - 'description' => 'The IDs of scheduling tasks. This parameter is valid only if you set Type to ByScheduledTaskInstance.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the scheduling task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30001', - ], - ], - ], - ], - 'RuntimeConf' => [ - 'title' => '扩展配置', - 'description' => 'Extended configuration, JSON-formatted string, takes effect only for EMR-type data quality monitoring.'."\n" - ."\n" - .'- queue: the yarn queue used when performing EMR data quality verification. The default queue is the queue configured for this project.'."\n" - .'- sqlEngine: SQL engine used when performing EMR data verification'."\n" - .' - HIVE_ SQL'."\n" - .' - SPARK_ SQL', - 'type' => 'string', - 'example' => '{ "queue": "default", "sqlEngine": "SPARK_SQL" }'."\n", - ], - 'Id' => [ - 'title' => '资源一级ID', - 'description' => 'The ID of the data quality monitor.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2178', - ], - 'Name' => [ - 'title' => '质量监控任务名称', - 'description' => 'The name of the monitor.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'OpenAPI create a data quality monitoring test', - ], - 'ProjectId' => [ - 'title' => '项目空间Id', - 'description' => 'The workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2626', - ], - 'Hooks' => [ - 'title' => '回调设置', - 'description' => 'The hook.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => 'Hook类型', - 'description' => 'The hook type. Only one hook type is supported.'."\n" - ."\n" - .'* BlockTaskInstance: Blocks the running of scheduling tasks. A monitor is triggered by scheduling tasks. After a monitor finishes running, the monitor determines whether to block the running of scheduling tasks based on the hook condition.'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'BlockTaskInstance', - ], - 'Condition' => [ - 'title' => 'Hook触发条件', - 'description' => 'The hook trigger condition. When this condition is met, the hook action is triggered. Only two conditional expressions are supported:'."\n" - ."\n" - .'* Specify only one group of rule strength type and rule check status, such as `${severity} == "High" AND ${status} == "Critical"`. In this expression, the hook trigger condition is met if severity is High and status is Critical.'."\n" - .'* Specify multiple groups of rule strength types and rule check status, such as `(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")`. In this expression, the hook trigger condition is met if severity is High and status is Critical, severity is Normal and status is Critical, or severity is Normal and status is Error. The enumeration of severity in a conditional expression is the same as the enumeration of severity in DataQualityRule. The enumeration of status in a conditional expression is the same as the enumeration of status in DataQualityResult.'."\n", - 'type' => 'string', - 'example' => '(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")', - ], - ], - 'description' => 'Hook', - ], - ], - 'Notifications' => [ - 'title' => '通知订阅配置', - 'description' => 'The configurations of alert notifications.'."\n", - 'type' => 'object', - 'properties' => [ - 'Condition' => [ - 'title' => '通知触发条件', - 'description' => 'The notification trigger condition. When this condition is met, the alert notification is triggered. Only two conditional expressions are supported:'."\n" - ."\n" - .'* Specify only one group of rule strength type and rule check status, such as `${severity} == "High" AND ${status} == "Critical"`. In this expression, the hook trigger condition is met if severity is High and status is Critical.'."\n" - .'* Specify multiple groups of rule strength types and rule check status, such as `(${severity} == "High"AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")`. In this expression, the hook trigger condition is met if severity is High and status is Critical, severity is Normal and status is Critical, or severity is Normal and status is Error. The enumeration of severity in a conditional expression is the same as the enumeration of severity in DataQualityRule. The enumeration of status in a conditional expression is the same as the enumeration of status in DataQualityResult.'."\n", - 'type' => 'string', - 'example' => '(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")', - ], - 'Notifications' => [ - 'title' => '通知设置', - 'description' => 'The configurations of alert notifications.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'NotificationReceivers' => [ - 'title' => '告警接收人设置', - 'description' => 'The configurations of alert recipients.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ReceiverType' => [ - 'title' => '告警接收人类型', - 'description' => 'The additional parameters that are required when alerts are sent. The parameters are JSON-formatted strings. The following keys are supported:'."\n" - ."\n" - .'* atAll: specifies that all members in a group are mentioned when alerts are sent by using DingTalk. This parameter is valid only if you set ReceiverType to DingdingUrl.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* WebhookUrl'."\n" - .'* FeishuUrl'."\n" - .'* DingdingUrl'."\n" - .'* WeixinUrl'."\n" - .'* AliUid'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'WebhookUrl' => '', - 'FeishuUrl' => '', - 'DingdingUrl' => '', - 'WeixinUrl' => '', - 'AliUid' => '', - ], - 'example' => 'DingdingUrl', - ], - 'Extension' => [ - 'title' => '扩展信息', - 'description' => 'The extended information.'."\n", - 'type' => 'string', - 'example' => '{ "atAll": true }'."\n", - ], - 'ReceiverValues' => [ - 'title' => '告警接收人', - 'description' => 'The alert recipients.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The value of the receiver.'."\n" - ."\n" - .'- When the receiver type is Alibaba Cloud ID, the receiver value is the specific Alibaba cloud user ID.'."\n" - .'- When the receiver type is DingdingUrl, the receiver value is the alert address of the specific DingTalk robot.'."\n" - .'- When the receiver type is WeixinUrl, the receiver value is the alert address of the specific Enterprise WeChat.'."\n" - .'- When the receiver type is FeishuUrl, the receiver value is the alert address of the specific flying book.'."\n" - .'- When the receiver type is WebhookUrl, the receiver value is the alert address of the specific custom Webhook.', - 'type' => 'string', - 'example' => 'https://api.fc.aliyuncs.com/webhook'."\n", - ], - ], - ], - 'description' => '告警接收人设置', - ], - ], - 'NotificationChannels' => [ - 'title' => '通知方式', - 'description' => 'The alert notification methods.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Channels' => [ - 'title' => '通知方式', - 'description' => 'The alert notification methods.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The alert notification method. Valid values:'."\n" - ."\n" - .'* Mail'."\n" - .'* Sms'."\n" - .'* Phone'."\n" - .'* Feishu'."\n" - .'* Weixin'."\n" - .'* Dingding'."\n" - .'* Webhook'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'Mail', - ], - ], - ], - 'description' => '通知方式', - ], - ], - ], - 'description' => '通知设置', - ], - ], - ], - ], - 'DataSourceId' => [ - 'description' => 'The ID of the data source used for the monitor.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '45238', + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => '该实例不存在。', 'title' => ''], ], + 'description' => 'The result.', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"SDFSDFSDF-SDFSDF-SDFDSF-SDFSDF\\",\\n \\"DataQualityEvaluationTask\\": {\\n \\"Target\\": {\\n \\"Type\\": \\"Table\\",\\n \\"DatabaseType\\": \\"maxcompute\\",\\n \\"TableGuid\\": \\"odps.meta_open_api_test_sz.test_partition_tbl\\",\\n \\"PartitionSpec\\": \\"pt=$[yyyymmdd-1]\\"\\n },\\n \\"Description\\": \\"The description of the quality monitoring task.\\",\\n \\"Trigger\\": {\\n \\"Type\\": \\"ByScheduledTaskInstance\\",\\n \\"TaskIds\\": [\\n 30001\\n ]\\n },\\n \\"RuntimeConf\\": \\"{ \\\\\\"queue\\\\\\": \\\\\\"default\\\\\\", \\\\\\"sqlEngine\\\\\\": \\\\\\"SPARK_SQL\\\\\\" }\\\\n\\",\\n \\"Id\\": 2178,\\n \\"Name\\": \\"OpenAPI create a data quality monitoring test\\",\\n \\"ProjectId\\": 2626,\\n \\"Hooks\\": [\\n {\\n \\"Type\\": \\"BlockTaskInstance\\",\\n \\"Condition\\": \\"(${severity} == \\\\\\"High\\\\\\" AND ${status} == \\\\\\"Critical\\\\\\") OR (${severity} == \\\\\\"Normal\\\\\\" AND ${status} == \\\\\\"Critical\\\\\\") OR (${severity} == \\\\\\"Normal\\\\\\" AND ${status} == \\\\\\"Error\\\\\\")\\"\\n }\\n ],\\n \\"Notifications\\": {\\n \\"Condition\\": \\"(${severity} == \\\\\\"High\\\\\\" AND ${status} == \\\\\\"Critical\\\\\\") OR (${severity} == \\\\\\"Normal\\\\\\" AND ${status} == \\\\\\"Critical\\\\\\") OR (${severity} == \\\\\\"Normal\\\\\\" AND ${status} == \\\\\\"Error\\\\\\")\\",\\n \\"Notifications\\": [\\n {\\n \\"NotificationReceivers\\": [\\n {\\n \\"ReceiverType\\": \\"DingdingUrl\\",\\n \\"Extension\\": \\"{ \\\\\\"atAll\\\\\\": true }\\\\n\\",\\n \\"ReceiverValues\\": [\\n \\"https://api.fc.aliyuncs.com/webhook\\\\n\\"\\n ]\\n }\\n ],\\n \\"NotificationChannels\\": [\\n {\\n \\"Channels\\": [\\n \\"Mail\\"\\n ]\\n }\\n ]\\n }\\n ]\\n },\\n \\"DataSourceId\\": 45238\\n }\\n}","type":"json"}]', - 'title' => 'GetDataQualityEvaluationTask', - ], - 'AttachDataQualityRulesToEvaluationTask' => [ - 'summary' => 'Associates monitoring rules with a data quality monitoring task.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\\\n\\",\\n \\"SuccessInfo\\": {\\n \\"key\\": {\\n \\"Success\\": true,\\n \\"Message\\": \\"该实例不存在。\\"\\n }\\n }\\n}","type":"json"}]', + 'title' => 'Modify Task Instance Properties', + 'summary' => 'Modify the properties of multiple task instances in batch, including priority, resource group, data source, and more.', + 'description' => 'You must purchase DataWorks Basic Edition or a higher edition to use this feature.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'UpdateUdfFile' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '250888', - 'abilityTreeNodes' => [ - 'FEATUREdide3WJOKE', - ], + 'operationType' => 'update', + 'abilityTreeCode' => '269316', + 'abilityTreeNodes' => ['FEATUREdide8FM783'], ], 'parameters' => [ + [ + 'name' => 'FileFolderPath', + 'in' => 'formData', + 'schema' => ['description' => 'The path to the folder containing the function file.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Business_process/First_Business_Process/function/string_processing_function', '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. 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, - 'example' => '10000', - ], + 'schema' => ['description' => 'The DataWorks workspace ID. To find this, click the wrench icon in the upper-right corner and navigate to the workspace management page.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '10000', 'title' => ''], ], [ - 'name' => 'DataQualityEvaluationTaskId', + 'name' => 'FunctionType', 'in' => 'formData', 'schema' => [ - 'description' => 'The ID of the data quality monitoring task that is associated with the rule.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The function category, corresponding to the function type field in the Create Function form. Valid values: MATH (mathematical functions), AGGREGATE (aggregate functions), STRING (string processing functions), DATE (date processing functions), ANALYTIC (window functions), and OTHER (other functions).', + 'type' => 'string', 'required' => true, 'docRequired' => true, - 'example' => '200001', + 'enum' => ['MATH', 'AGGREGATE', 'STRING', 'DATE', 'ANALYTIC', 'OTHER'], + 'example' => 'STRING', + 'title' => '', ], ], [ - 'name' => 'DataQualityRuleIds', + 'name' => 'ClassName', + 'in' => 'formData', + 'schema' => ['description' => 'The class name where the function is defined, corresponding to the class name field in the Create Function form.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'com.alibaba.DataWorks.api.udf.StringConcat', 'title' => ''], + ], + [ + 'name' => 'Resources', + 'in' => 'formData', + 'schema' => ['description' => 'A comma-separated list of resource names referenced by the function, corresponding to the resource list field in the Create Function form.', '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 function purpose description, corresponding to the description field in the Create Function form.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Concatenate several strings to generate a new string', 'title' => ''], + ], + [ + 'name' => 'CmdDescription', + 'in' => 'formData', + 'schema' => ['description' => 'The command format for invoking the function, corresponding to the command format field in the Create Function form.', 'type' => 'string', 'required' => false, 'example' => 'StringConcat(String... substrs)', 'title' => ''], + ], + [ + 'name' => 'ParameterDescription', 'in' => 'formData', - 'style' => 'json', 'schema' => [ - 'description' => 'The IDs of the monitoring rules.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The IDs of the monitoring rules.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '2000001', - ], - 'required' => true, - 'docRequired' => true, + 'description' => 'The function parameter description, corresponding to the parameter description field in the Create Function form.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- ALL\\_ALLOWD'."\n" + ."\n" + .'- FAILURE\\_ALLOWED'."\n" + ."\n" + .'- ALL\\_DENIED', + 'type' => 'string', + 'required' => false, + 'default' => 'ALL_ALLOWED', + 'enum' => ['ALL_ALLOWD', 'FAILURE_ALLOWED', 'ALL_DENIED'], + 'example' => 'List of strings to be connected', + 'title' => '', ], ], + [ + 'name' => 'ReturnValue', + 'in' => 'formData', + 'schema' => ['description' => 'The return value description, corresponding to the return value field in the Create Function form.', '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' => 'An example demonstrating how to call the function, corresponding to the example field in the Create Function form.', 'type' => 'string', 'required' => false, 'example' => 'StringConcat(\'a\', \'b\', \'c\')', 'title' => ''], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => ['description' => 'The unique identifier of the DataWorks workspace, which is the identifier at the top of the Data Studio page where you switch workspaces.'."\n" + ."\n" + .'Either this parameter or ProjectId must be specified to identify the target DataWorks workspace for this API call.', 'type' => 'string', 'required' => false, 'example' => 'dw_project', 'title' => ''], + ], + [ + 'name' => 'FileId', + 'in' => 'formData', + 'schema' => ['description' => 'The file ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '10000001', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', + 'description' => 'The response.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'E6F0DBDD-5AD8-4870-A6A0', - ], - 'Success' => [ - 'description' => 'The value of the association is as follows:'."\n" - .'- true: The call is successful.'."\n" - .'- false: the call failed.', - '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 unique ID for this request. Use this ID for troubleshooting 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 request succeeded. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E6F0DBDD-5AD8-4870-A6A0\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'AttachDataQualityRulesToEvaluationTask', - ], - 'UpdateDataQualityEvaluationTask' => [ - 'summary' => 'Updates a monitor.', - '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.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', + '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' => 'UpdateUdfFile', + 'summary' => 'Updates the file information about a function.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'UpdateWorkflow' => [ + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '250886', - 'abilityTreeNodes' => [ - 'FEATUREdide3WJOKE', - ], - 'tenantRelevance' => 'tenant', + 'abilityTreeCode' => '253479', + 'abilityTreeNodes' => ['FEATUREdide7WF1GB', 'FEATUREdideD0YY7B', 'FEATUREdideVFMENL'], ], 'parameters' => [ [ - 'name' => 'Target', + 'name' => 'Id', 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '参看 DataQualityTarget示例 数据质量校验任务的监控对象，参考 DataQualityTarget', - 'description' => 'The monitored object of the data quality monitoring task.'."\n", - 'type' => 'object', - 'properties' => [ - 'DatabaseType' => [ - 'title' => '表所属的数据库类型', - 'description' => 'The type of the database to which the table belongs. Valid values:'."\n" - ."\n" - .'* maxcompute'."\n" - .'* hologres'."\n" - .'* cdh'."\n" - .'* analyticdb_for_mysql'."\n" - .'* starrocks'."\n" - .'* emr'."\n" - .'* analyticdb_for_postgresql'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'maxcompute', - ], - 'TableGuid' => [ - 'title' => '表在数据地图中的唯一ID', - 'description' => 'The ID of the table in Data Map.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'odsp.openapi.ods_d_openapi_log', - ], - 'PartitionSpec' => [ - 'title' => '分区表的分区设置', - 'description' => 'The configuration of the partitioned table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dt=$[yyyymmdd-1]', - 'maxLength' => 255, - ], - ], - 'required' => false, - ], + 'schema' => ['description' => 'The workflow ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'EnvType', 'in' => 'formData', 'schema' => [ - 'title' => '质量监控任务描述', - 'description' => 'The description of the monitor.'."\n", + 'description' => 'The project environment. Valid values:'."\n" + .'- Prod: production'."\n" + .'- Dev: development', + 'enumValueTitles' => [], 'type' => 'string', + 'default' => 'Prod', + 'enum' => ['Prod'], 'required' => false, - 'example' => 'OpenAPI data quality monitoring test.', - 'maxLength' => 65535, + 'example' => 'Prod', + 'title' => '', ], ], [ 'name' => 'Name', 'in' => 'formData', - 'schema' => [ - 'title' => '质量监控任务名称', - 'description' => 'The name of the monitor.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'OpenAPI data quality monitoring test.', - 'maxLength' => 255, - ], + 'schema' => ['description' => 'The name.', 'type' => 'string', 'required' => true, 'example' => 'My Workflow', 'title' => ''], ], [ - 'name' => 'RuntimeConf', + 'name' => 'Owner', 'in' => 'formData', - 'schema' => [ - 'title' => '扩展配置', - 'description' => 'The extended configurations in JSON-formatted strings. You can use this parameter only for monitors that are used to monitor the quality of E-MapReduce (EMR) data.'."\n" - ."\n" - .'* queue: The Yarn queue used when a monitor checks the quality of EMR data. By default, the queue configured for the current workspace is used.'."\n" - ."\n" - .'* sqlEngine: The SQL engine used when a monitor checks the quality of EMR data.'."\n" - ."\n" - .' * HIVE_SQL'."\n" - .' * SPARK_SQL'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{ "queue": "default", "sqlEngine": "SPARK_SQL" }', - ], + 'schema' => ['description' => 'The account ID of the owner.', 'type' => 'string', 'required' => true, 'example' => '1000', 'title' => ''], ], [ 'name' => 'Trigger', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '数据质量校验任务的触发配置', - 'description' => 'The trigger configuration of the monitor.'."\n", + 'description' => 'The trigger configuration.', 'type' => 'object', 'properties' => [ 'Type' => [ - 'title' => '质量监控任务触发类型', - 'description' => 'The trigger type of the monitor. Valid values:'."\n" - ."\n" - .'* ByScheduledTaskInstance: The monitor is triggered by the associated scheduling tasks.'."\n" - .'* ByManual: The monitor is manually triggered.'."\n", - 'type' => 'string', - 'required' => false, + 'description' => 'The trigger type. Valid values:'."\n" + .'- Scheduler: triggered by a scheduling cycle'."\n" + .'- Manual: manually triggered', 'enumValueTitles' => [], - 'example' => 'ByScheduledTaskInstance', - ], - 'TaskIds' => [ - 'title' => '调度任务Ids', - 'description' => 'The IDs of scheduling tasks. This parameter is valid only if you set Type to ByScheduledTaskInstance.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the scheduling task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1004979033', - ], - 'required' => false, + 'type' => 'string', + 'required' => true, + 'enum' => ['Scheduler', 'Manual'], + 'example' => 'Scheduler', + 'title' => '', ], + 'Cron' => ['description' => 'The cron expression. This parameter takes effect only when type is set to Scheduler.', 'type' => 'string', 'required' => false, 'example' => '00 00 00 * * ?', 'title' => ''], + 'StartTime' => ['description' => 'The effective period of the epoch trigger. This parameter takes effect only when type is set to Scheduler. Format: `yyyy-mm-dd hh:mm:ss`.', 'type' => 'string', 'required' => false, 'example' => '1970-01-01 00:00:00', 'title' => ''], + 'EndTime' => ['description' => 'The time when the periodic trigger expires. This parameter takes effect only when type is set to Scheduler. Format: `yyyy-mm-dd hh:mm:ss`.', 'type' => 'string', 'required' => false, 'example' => '9999-01-01 00:00:00', 'title' => ''], ], - 'required' => false, + 'required' => true, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ProjectId', + 'name' => 'Description', 'in' => 'formData', - 'schema' => [ - 'title' => '项目空间Id', - 'description' => 'The ID of the DataWorks workspace.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '10000', - ], + 'schema' => ['description' => 'The description.', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'Hooks', + 'name' => 'Dependencies', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'title' => '回调设置', - 'description' => 'The hook.'."\n", + 'description' => 'The dependency information.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Type' => [ - 'title' => 'Hook类型', - 'description' => 'The hook type. Valid values:'."\n" - ."\n" - .'* BlockTaskInstance: Blocks the running of scheduling tasks.'."\n", - 'type' => 'string', - 'required' => false, + 'title' => '', + 'description' => 'The dependency type. Valid values:'."\n" + .'- CrossCycleDependsOnChildren: cross-cycle dependency on first-level child nodes'."\n" + .'- CrossCycleDependsOnSelf: cross-cycle dependency on the current node'."\n" + .'- CrossCycleDependsOnOtherNode: cross-cycle dependency on other nodes'."\n" + .'- Normal: same-cycle dependency', 'enumValueTitles' => [], - 'example' => 'ByScheduledTaskInstance', - ], - 'Condition' => [ - 'title' => 'Hook触发条件', - 'description' => 'The hook trigger condition. When this condition is met, the hook action is triggered. Only two conditional expressions are supported:'."\n" - ."\n" - .'* Specify only one group of rule strength type and rule check status, such as `${severity} == "High" AND ${status} == "Critical"`. In this expression, the hook trigger condition is met if severity is High and status is Critical.'."\n" - .'* Specify multiple groups of rule strength types and rule check status, such as `(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")`. In this expression, the hook trigger condition is met if severity is High and status is Critical, severity is Normal and status is Critical, or severity is Normal and status is Error. The enumeration of severity in a conditional expression is the same as the enumeration of severity in DataQualityRule. The enumeration of status in a conditional expression is the same as the enumeration of status in DataQualityResult.'."\n", 'type' => 'string', - 'required' => false, - 'example' => '${severity} == "High" AND ${status} == "Critical"', + 'required' => true, + 'enum' => ['Normal', 'CrossCycleDependsOnSelf', 'CrossCycleDependsOnChildren', 'CrossCycleDependsOnOtherNode'], + 'example' => 'Normal', ], + 'UpstreamOutput' => ['title' => '', 'description' => 'The output identifier of the upstream node. This field is returned when the dependency type is `same-cycle dependency` and input content is specified.', 'type' => 'string', 'required' => false, 'example' => 'pre.odps_sql_demo_0'], + 'UpstreamTaskId' => ['description' => 'The ID of the upstream node. This field is returned when the dependency type is `cross-cycle dependency on other nodes` or `same-cycle dependency` without input content specified. It is not returned in other cases.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234', 'title' => ''], ], 'required' => false, - 'description' => 'Hook', - ], - 'required' => false, - ], - ], - [ - 'name' => 'Notifications', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '通知订阅配置', - 'description' => 'The configurations of alert notifications.'."\n", - 'type' => 'object', - 'properties' => [ - 'Condition' => [ - 'title' => '通知触发条件', - 'description' => 'The notification trigger condition. When this condition is met, the alert notification is triggered. Only two conditional expressions are supported:'."\n" - ."\n" - .'* Specify only one group of rule strength type and rule check status, such as `${severity} == "High" AND ${status} == "Critical"`. In this expression, the hook trigger condition is met if severity is High and status is Critical.'."\n" - .'* Specify multiple groups of rule strength types and rule check status, such as `(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")`. In this expression, the hook trigger condition is met if severity is High and status is Critical, severity is Normal and status is Critical, or severity is Normal and status is Error. The enumeration of severity in a conditional expression is the same as the enumeration of severity in DataQualityRule. The enumeration of status in a conditional expression is the same as the enumeration of status in DataQualityResult.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '${severity} == "High" AND ${status} == "Critical"', - ], - 'Notifications' => [ - 'title' => '通知设置', - 'description' => 'The configurations of the alert notification.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'NotificationReceivers' => [ - 'title' => '告警接收人设置', - 'description' => 'The configurations of alert recipients.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ReceiverType' => [ - 'title' => '告警接收人类型', - 'description' => 'The type of the alert recipient.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* WebhookUrl'."\n" - .'* FeishuUrl'."\n" - .'* DingdingUrl'."\n" - .'* WeixinUrl'."\n" - .'* AliUid'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'WebhookUrl' => '', - 'FeishuUrl' => '', - 'DingdingUrl' => '', - 'WeixinUrl' => '', - 'AliUid' => '', - ], - 'example' => 'DingdingUrl', - ], - 'Extension' => [ - 'title' => '扩展信息', - 'description' => 'The additional parameters that are required when alerts are sent. The parameters are JSON-formatted strings. The following keys are supported:'."\n" - ."\n" - .'* atAll: specifies that all members in a group are mentioned when alerts are sent by using DingTalk. This parameter is valid only if you set ReceiverType to DingdingUrl.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => '{ "atAll": true }'."\n", - ], - 'ReceiverValues' => [ - 'title' => '告警接收人', - 'description' => 'The alert recipient.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The recipient.'."\n" - ."\n" - .'* If you set ReceiverType to AliUid, set this parameter to the Alibaba Cloud account ID of a user.'."\n" - .'* If you set ReceiverType to DingdingUrl, set this parameter to the URL of a DingTalk chatbot.'."\n" - .'* If you set ReceiverType to WeixinUrl, set this parameter to the URL of WeCom.'."\n" - .'* If you set ReceiverType to FeishuUrl, set this parameter to the URL of Lark.'."\n" - .'* If you set ReceiverType to WebhookUrl, set this parameter to the webhook URL.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://api.fc.aliyuncs.com/webhook', - 'maxLength' => 255, - ], - 'required' => false, - ], - ], - 'required' => false, - 'description' => '告警接收人设置', - ], - 'required' => false, - ], - 'NotificationChannels' => [ - 'title' => '通知方式', - 'description' => 'The alert notification methods.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Channels' => [ - 'title' => '通知方式', - 'description' => 'The alert notification methods.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The alert notification method. Valid values:'."\n" - ."\n" - .'* Dingding'."\n" - .'* Mail'."\n" - .'* Weixin'."\n" - .'* Feishu'."\n" - .'* Phone'."\n" - .'* Sms'."\n" - .'* Webhook'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Mail', - ], - 'required' => false, - ], - ], - 'required' => false, - 'description' => '通知方式', - ], - 'required' => false, - ], - ], - 'required' => false, - 'description' => '通知设置', - ], - 'required' => false, - ], + 'description' => '', + 'title' => '', + 'example' => '', ], 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'DataSourceId', + 'name' => 'Parameters', 'in' => 'formData', - 'schema' => [ - 'description' => 'The data source ID. You can call the [ListDataSources](~~211431~~) operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '358750', - ], + 'schema' => ['description' => 'The parameter list.', 'type' => 'string', 'required' => false, 'example' => 'para1=$bizdate para2=$[yyyymmdd] ', 'title' => ''], ], [ - 'name' => 'DataQualityRules', + 'name' => 'Tasks', 'in' => 'formData', 'style' => 'json', 'schema' => [ - 'description' => 'The list of monitoring rules that are associated with the monitor.'."\n", + 'description' => 'The node list.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'The name of the monitoring rule.'."\n", + 'Id' => ['description' => 'The node ID. If this field is specified, the corresponding node is fully updated. If this field is not specified, a new node is created.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234', 'title' => ''], + 'Name' => ['description' => 'The name of the node.', 'type' => 'string', 'required' => true, 'example' => 'SQL node', 'title' => ''], + 'Description' => ['description' => 'The description.', 'type' => 'string', 'required' => false, 'example' => 'Test', 'title' => ''], + 'Type' => ['description' => 'The node type.', 'type' => 'string', 'required' => true, 'example' => 'ODPS_SQL', 'title' => ''], + 'Owner' => ['description' => 'The account ID of the owner.', 'type' => 'string', 'required' => true, 'example' => '1000', 'title' => ''], + 'BaseLineId' => ['description' => 'The baseline ID.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234', 'title' => ''], + 'Timeout' => ['description' => 'The timeout period for node execution, in seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3600', 'title' => ''], + 'RerunMode' => [ + 'description' => 'Specifies whether the node can be rerun. Valid values:'."\n" + .'- AllDenied: cannot be rerun regardless of success or failure'."\n" + .'- FailureAllowed: can be rerun only upon failure'."\n" + .'- AllAllowed: can be rerun regardless of success or failure', + 'enumValueTitles' => [], 'type' => 'string', - 'required' => false, - 'example' => 'OpenAPI test rules', - 'maxLength' => 255, + 'required' => true, + 'enum' => ['AllAllowed', 'FailureAllowed', 'AllDenied'], + 'example' => 'AllAllowed', + 'title' => '', ], - 'Enabled' => [ - 'description' => 'Specifies whether to enable the rule.'."\n", - 'type' => 'boolean', + 'RerunTimes' => ['description' => 'The number of retries. This parameter takes effect only when the node is configured to allow reruns.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '3', 'title' => ''], + 'RerunInterval' => ['description' => 'The retry time interval, in seconds.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '60', 'title' => ''], + 'Script' => [ + 'description' => 'The script information.', + 'type' => 'object', + 'properties' => [ + 'Content' => ['description' => 'The script content.', 'type' => 'string', 'required' => false, 'example' => 'echo "helloWorld"', 'title' => ''], + 'Parameters' => ['description' => 'The list of script parameters.', 'type' => 'string', 'required' => false, 'example' => 'para1=$bizdate', 'title' => ''], + ], 'required' => false, - 'example' => 'true', + 'title' => '', + 'example' => '', ], - 'Severity' => [ - 'description' => 'The strength of the rule. Valid values:'."\n" - ."\n" - .'* Normal'."\n" - .'* High'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Normal', - 'enum' => [ - 'High', - 'Normal', + 'Trigger' => [ + 'description' => 'The trigger configuration of the node.', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'The trigger type. Valid values:'."\n" + .'- Scheduler: triggered by a scheduling cycle'."\n" + .'- Manual: manually triggered', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => false, + 'default' => 'Scheduler', + 'enum' => ['Scheduler', 'Manual'], + 'example' => 'Scheduler', + 'title' => '', + ], + 'Recurrence' => [ + 'description' => 'The run mode when triggered. This parameter takes effect only when type is set to Scheduler. Valid values:'."\n" + .'- Pause: paused'."\n" + .'- Skip: dry run'."\n" + .'- Normal: normal execution', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => true, + 'enum' => ['Normal', 'Skip', 'Pause'], + 'example' => 'Normal', + 'title' => '', + ], ], + 'required' => true, + 'title' => '', + 'example' => '', ], - 'Description' => [ - 'description' => 'The description of the rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'OpenAPI test rules', - 'maxLength' => 500, + 'RuntimeResource' => [ + 'description' => 'The runtime environment configuration, such as resource group information.', + 'type' => 'object', + 'properties' => [ + 'ResourceGroupId' => ['description' => 'The identifier of the schedule resource group configured for the node.', 'type' => 'string', 'required' => true, 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX', 'title' => ''], + 'Image' => ['description' => 'The image ID configured for the node.', 'type' => 'string', 'required' => false, 'example' => 'i-xxxxxx', 'title' => ''], + 'Cu' => ['description' => 'The CU consumption configured for the node.', 'type' => 'string', 'required' => false, 'example' => '0.25', 'title' => ''], + ], + 'required' => true, + 'title' => '', + 'example' => '', ], - 'TemplateCode' => [ - 'description' => 'The ID of the template used by the rule.'."\n", - 'type' => 'string', + 'DataSource' => [ + 'description' => 'The associated data source information.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The data source name.', 'type' => 'string', 'required' => false, 'example' => 'odps_test', 'title' => ''], + ], 'required' => false, - 'example' => 'SYSTEM:field:null_value:fixed:0', + 'title' => '', + 'example' => '', ], - 'SamplingConfig' => [ - 'description' => 'The parameters required for sampling.'."\n", + 'Inputs' => [ + 'description' => 'The input information. If this field is empty, all Inputs configurations are deleted by default.', 'type' => 'object', 'properties' => [ - 'Metric' => [ - 'description' => 'The metrics used for sampling. Valid values:'."\n" - ."\n" - .'* Count: the number of rows in the table.'."\n" - .'* Min: the minimum value of the field.'."\n" - .'* Max: the maximum value of the field.'."\n" - .'* Avg: the average value of the field.'."\n" - .'* DistinctCount: the number of unique values of the field after deduplication.'."\n" - .'* DistinctPercent: the proportion of the number of unique values of the field after deduplication to the number of rows in the table.'."\n" - .'* DuplicatedCount: the number of duplicated values of the field.'."\n" - .'* DuplicatedPercent: the proportion of the number of duplicated values of the field to the number of rows in the table.'."\n" - .'* TableSize: the table size.'."\n" - .'* NullValueCount: the number of rows in which the field value is null.'."\n" - .'* NullValuePercent: the proportion of the number of rows in which the field value is null to the number of rows in the table.'."\n" - .'* GroupCount: the field value and the number of rows for each field value.'."\n" - .'* CountNotIn: the number of rows in which the field values are different from the referenced values that you specified in the rule.'."\n" - .'* CountDistinctNotIn: the number of unique values that are different from the referenced values that you specified in the rule after deduplication.'."\n" - .'* UserDefinedSql: specifies that data is sampled by executing custom SQL statements.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'CountNotIn', - ], - 'MetricParameters' => [ - 'description' => 'The parameters required for sampling.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{ "Columns": [ "id", "name" ] , "SQL": "select count(1) from table;"}', - ], - 'SettingConfig' => [ - 'description' => 'The statements that are used to configure the parameters required for sampling before you execute the sampling statements. The statements can be up to 1,000 characters in length. Only the MaxCompute database is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'odps.sql.type.system.odps2=True,odps.sql.hive.compatible=True', - 'maxLength' => 1000, - ], - 'SamplingFilter' => [ - 'description' => 'The statements that are used to filter unnecessary data during sampling. The statements can be up to 16,777,215 characters in length.'."\n", - 'type' => 'string', + 'Variables' => [ + 'description' => 'The list of variable definitions. If this field is not specified or is an empty array, all Inputs.Variables configurations are deleted by default.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The variable name.', 'type' => 'string', 'required' => false, 'example' => 'key1', 'title' => ''], + 'Type' => [ + 'title' => '', + 'description' => 'The type. Valid values:'."\n" + .'- Constant: constant'."\n" + .'- PassThrough: output of a parameter node'."\n" + .'- System: variable'."\n" + .'- NodeOutput: script output', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => true, + 'enum' => ['System', 'Constant', 'NodeOutput', 'PassThrough'], + 'example' => 'Constant', + ], + 'Value' => ['description' => 'The variable value.', 'type' => 'string', 'required' => false, 'example' => 'value1', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'status != \'Succeeded\''."\n", + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], - 'CheckingConfig' => [ - 'description' => 'The check settings for sample data.'."\n", + 'Outputs' => [ + 'description' => 'The output information. If this field is empty, all Outputs configurations are deleted by default.', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => 'The threshold calculation method. Valid values:'."\n" - ."\n" - .'* Fluctation'."\n" - .'* Auto'."\n" - .'* FluctationDiscreate'."\n" - .'* Average'."\n" - .'* Fixed'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Fixed', - ], - 'ReferencedSamplesFilter' => [ - 'description' => 'The method that is used to query the referenced samples. To obtain specific types of thresholds, you must query reference values. In this example, an expression is used to specify the query method of referenced samples.'."\n", - 'type' => 'string', + 'TaskOutputs' => [ + 'description' => 'The list of node output definitions. If this field is not specified or is an empty array, all TaskOutputs configurations are deleted by default.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Output' => ['title' => '', 'description' => 'The output identifier.', 'type' => 'string', 'required' => false, 'example' => 'pre.odps_sql_demo_0'], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => '{"bizdate": ["-1"]}'."\n", + 'title' => '', + 'example' => '', ], - 'Thresholds' => [ - 'description' => 'The threshold settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Expected' => [ - 'description' => 'The expected threshold setting.'."\n", - 'type' => 'object', - 'properties' => [ - 'Operator' => [ - 'description' => 'The comparison operator. Valid values:'."\n" - ."\n" - .'* \\>'."\n" - .'* \\>='."\n" - .'* <'."\n" - .'* <='."\n" - .'* !='."\n" - .'* \\='."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => '=', - ], - 'Value' => [ - 'description' => 'The threshold value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], - 'Expression' => [ - 'description' => 'The threshold expression.'."\n" - ."\n" - .'If the template specified by the TemplateCode parameter is about fluctuation, you must use an expression to represent the threshold for fluctuation. Examples:'."\n" - ."\n" - .'* $checkValue > 0.01'."\n" - .'* $checkValue < -0.01'."\n" - .'* abs($checkValue) > 0.01'."\n" - ."\n" - .'If the template specified by the TemplateCode parameter is about fixed value, you can also use an expression to represent the threshold. If you configure the Expression, Operator, and Value parameters for the threshold at the same time, the Expression parameter takes precedence over the Operator and Value parameters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '$checkValue > 0.01', - ], - ], - 'required' => false, - ], - 'Warned' => [ - 'description' => 'The threshold settings for normal alerts.'."\n", - 'type' => 'object', - 'properties' => [ - 'Operator' => [ - 'description' => 'The comparison operator. Valid values:'."\n" - ."\n" - .'* \\>'."\n" - .'* \\>='."\n" - .'* <'."\n" - .'* <='."\n" - .'* !='."\n" - .'* \\='."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => '>', - ], - 'Value' => [ - 'description' => 'The threshold value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0.001', - ], - 'Expression' => [ - 'description' => 'The threshold expression.'."\n" - ."\n" - .'If the template specified by the TemplateCode parameter is about fluctuation, you must use an expression to represent the threshold for fluctuation. Examples:'."\n" - ."\n" - .'* $checkValue > 0.01'."\n" - .'* $checkValue < -0.01'."\n" - .'* abs($checkValue) > 0.01'."\n" - ."\n" - .'If the template specified by the TemplateCode parameter is about fixed value, you can also use an expression to represent the threshold. If you configure the Expression, Operator, and Value parameters for the threshold at the same time, the Expression parameter takes precedence over the Operator and Value parameters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '$checkValue > 0.01', - ], - ], - 'required' => false, - ], - 'Critical' => [ - 'description' => 'The threshold settings for critical alerts.'."\n", - 'type' => 'object', - 'properties' => [ - 'Operator' => [ - 'description' => 'The comparison operator. Valid values:'."\n" - ."\n" - .'* \\>'."\n" - .'* \\>='."\n" - .'* <'."\n" - .'* <='."\n" - .'* !='."\n" - .'* \\='."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => '>', - ], - 'Value' => [ - 'description' => 'The threshold value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0.01', - ], - 'Expression' => [ - 'description' => 'The threshold expression.'."\n" - ."\n" - .'If the template specified by the TemplateCode parameter is about fluctuation, you must use an expression to represent the threshold for fluctuation. Examples:'."\n" - ."\n" - .'* $checkValue > 0.01'."\n" - .'* $checkValue < -0.01'."\n" - .'* abs($checkValue) > 0.01'."\n" - ."\n" - .'If the template specified by the TemplateCode parameter is about fixed value, you can also use an expression to represent the threshold. If you configure the Expression, Operator, and Value parameters for the threshold at the same time, the Expression parameter takes precedence over the Operator and Value parameters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '$checkValue > 0.01', - ], + 'Variables' => [ + 'description' => 'The list of variable definitions. If this field is not specified or is an empty array, all Outputs.Variables configurations are deleted by default.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The variable name.', 'type' => 'string', 'required' => false, 'example' => 'key1', 'title' => ''], + 'Type' => [ + 'title' => '', + 'description' => 'The type. Valid values:'."\n" + .'- Constant: constant'."\n" + .'- PassThrough: output of a parameter node'."\n" + .'- System: variable'."\n" + .'- NodeOutput: script output', + 'enumValueTitles' => [], + 'type' => 'string', + 'required' => true, + 'enum' => ['System', 'Constant', 'NodeOutput', 'PassThrough'], + 'example' => 'Constant', ], - 'required' => false, + 'Value' => ['description' => 'The variable value.', 'type' => 'string', 'required' => false, 'example' => 'value1', 'title' => ''], ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], 'required' => false, + 'title' => '', + 'example' => '', ], ], 'required' => false, + 'title' => '', + 'example' => '', ], - 'ErrorHandlers' => [ - 'description' => 'The operations that you can perform after the rule-based check fails.'."\n", + 'Dependencies' => [ + 'description' => 'The dependency information. If this field is not specified or is an empty array, all Dependencies configurations are deleted by default.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ 'Type' => [ - 'description' => 'The type of the operation. Valid values:'."\n" - ."\n" - .'* SaveErrorData'."\n", - 'type' => 'string', - 'required' => false, + 'title' => '', + 'description' => 'The dependency type. Valid values:'."\n" + .'- CrossCycleDependsOnChildren: cross-cycle dependency on first-level child nodes'."\n" + .'- CrossCycleDependsOnSelf: cross-cycle dependency on the current node'."\n" + .'- CrossCycleDependsOnOtherNode: cross-cycle dependency on other nodes'."\n" + .'- Normal: same-cycle dependency', 'enumValueTitles' => [], - 'example' => 'SaveErrorData', - ], - 'ErrorDataFilter' => [ - 'description' => 'The SQL statement that is used to filter failed tasks. If you define the rule by using custom SQL statements, you must specify an SQL statement to filter failed tasks.'."\n", 'type' => 'string', - 'required' => false, - 'example' => 'SELECT * FROM ods_d_openapi_log WHERE status = \'Error\'', + 'required' => true, + 'enum' => ['Normal', 'CrossCycleDependsOnSelf', 'CrossCycleDependsOnChildren', 'CrossCycleDependsOnOtherNode'], + 'example' => 'Normal', ], + 'UpstreamOutput' => ['title' => '', 'description' => 'The output identifier of the upstream node. This field is returned when the dependency type is `same-cycle dependency` and input content is specified.', 'type' => 'string', 'required' => false, 'example' => 'pre.odps_sql_demo_0'], + 'UpstreamTaskId' => ['title' => '', 'description' => 'The ID of the upstream node. This field is returned when the dependency type is `cross-cycle dependency on other nodes` or `same-cycle dependency` without input content specified. It is not returned in other cases.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234'], ], 'required' => false, 'description' => '', + 'title' => '', + 'example' => '', ], 'required' => false, + 'title' => '', + 'example' => '', ], - 'Id' => [ - 'description' => 'The rule ID. You can call the [ListQualityRules](~~173995~~) operation to query the ID of the monitoring rule.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'Tags' => [ + 'description' => 'The list of node tags. If this field is not specified or is an empty array, all Tags configurations are deleted by default.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => true, 'example' => 'key1', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'value1', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'ClientUniqueCode' => ['description' => 'The client unique code of the node, used for asynchronous operations and idempotence. If not specified during creation, the system automatically generates one, and the code is uniquely bound to the resource ID. If this parameter is specified during update or deletion, it must be consistent with the client unique code used during creation.', 'type' => 'string', 'required' => false, 'example' => 'Task_0bc5213917368545132902xxxxxxxx', 'title' => ''], + 'EnvType' => [ + 'description' => 'The project environment. Valid values:'."\n" + .'- Prod: production'."\n" + .'- Dev: development', + 'enumValueTitles' => [], + 'type' => 'string', + 'default' => 'Prod', + 'enum' => ['Prod', 'Dev'], 'required' => false, - 'example' => '1022171560', + 'example' => 'Prod', + 'title' => '', ], ], 'required' => false, 'description' => '', + 'title' => '', + 'example' => '', ], 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Id', + 'name' => 'Outputs', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The output information.', + 'type' => 'object', + 'properties' => [ + 'TaskOutputs' => [ + 'description' => 'The list of workflow node output definitions.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Output' => ['title' => '', 'description' => 'The output identifier.', 'type' => 'string', 'required' => false, 'example' => 'pre.odps_sql_demo_0'], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'Tags', 'in' => 'formData', + 'style' => 'json', 'schema' => [ - 'description' => 'The ID of the monitor.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '7227061794', + 'description' => 'The list of workflow tags.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => true, 'example' => 'key1', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'value1', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'ClientUniqueCode', + 'in' => 'formData', + 'schema' => ['description' => 'The client unique code of the workflow, used for asynchronous operations and idempotence. If not specified during creation, the system automatically generates one, and the code is uniquely bound to the resource ID. If this parameter is specified during update or deletion, it must be consistent with the client unique code used during creation.', 'type' => 'string', 'required' => false, 'example' => 'Workflow_0bc5213917368545132902xxxxxxxx', 'title' => ''], + ], + [ + 'name' => 'InstanceMode', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The instance generation mode. Valid values:'."\n" + ."\n" + .'- T+1: Instances are generated the next day.'."\n" + .'- Immediately: Instances are generated immediately. Periodic instances are generated only if the scheduled time of the workflow is at least 10 minutes after the workflow is published. During the full instance generation period (22:00 to 24:00), real-time instance generation is not available. You can submit and publish workflows during this period, but instances are not regenerated after submission.', + 'type' => 'string', + 'default' => 'T+1', + 'enum' => ['T+1', 'Immediately'], + 'required' => false, + 'example' => 'T+1', + 'title' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID, which is used to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'Update a workflow', + 'summary' => 'Updates a specified workflow by using the full update method. Fields that can be synchronously updated to DataStudio include: owner, data source, schedule resource group, description, and trigger run mode (Normal, Skip, or Pause).', + 'description' => 'DataWorks Basic Edition or a more advanced edition is required.', + 'changeSet' => [ + ['createdAt' => '2025-05-15T07:08:48.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-03-31T03:56:33.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'UpdateWorkflowDefinition' => [ + 'summary' => 'Updates the basic information about a workflow in DataStudio. This API operation performs an incremental update. The update information is described by using FlowSpec.', + 'methods' => ['post'], + 'schemes' => ['https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '234976', + 'abilityTreeNodes' => ['FEATUREdideHO4TQP', 'FEATUREdide8FM783', 'FEATUREdideQUQUVB', 'FEATUREdideIQU97M'], + ], + '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 query the ID.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10001', 'title' => ''], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => 'The unique identifier of the Data Studio workflow.'."\n" + ."\n" + .'> This field is of the Long type in SDK versions prior to 8.0.0, and of the String type in SDK versions 8.0.0 and later. This change does not affect normal SDK usage; the parameter will still be returned according to the type defined in the SDK. However, compilation failures may occur due to the type change only when upgrading the SDK across version 8.0.0. In this case, you must manually update the data type.', 'type' => 'string', 'required' => true, 'example' => '652567824470354XXXX', 'title' => ''], + ], + [ + 'name' => 'Spec', + 'in' => 'formData', + 'schema' => ['description' => 'The unique identifier of the Data Studio workflow.'."\n" + ."\n" + .'> Prior to SDK version 8.0.0, this field is of type Long. In SDK version 8.0.0 and later, it is of type String. This change does not affect the normal use of the SDK. The parameter is returned based on the type defined in the SDK. However, compilation failures may occur due to the type change only when upgrading the SDK across version 8.0.0. In this case, you must manually update the data type.', 'type' => 'string', 'required' => true, 'example' => '{'."\n" + .' "kind": "CycleWorkflow",'."\n" + .' "version": "1.1.0",'."\n" + .' "spec": {'."\n" + .' "workflows": ['."\n" + .' {'."\n" + .' "id": "652567824470354XXXX",'."\n" + .' "script": {'."\n" + .' "path": "XX/OpenAPI_Test/Workflow_Test/OpenAPI_Test_Workflow_Demo",'."\n" + .' "runtime": {'."\n" + .' "command": "WORKFLOW"'."\n" + .' }'."\n" + .' },'."\n" + .' "trigger": {'."\n" + .' "type": "Scheduler",'."\n" + .' "cron": "00 02 00 * * ?",'."\n" + .' "startTime": "1970-01-01 00:00:00",'."\n" + .' "endTime": "9999-01-01 00:00:00",'."\n" + .' "timezone": "Asia/Shanghai",'."\n" + .' "delaySeconds": 0'."\n" + .' },'."\n" + .' "strategy": {'."\n" + .' "timeout": 0,'."\n" + .' "instanceMode": "T+1",'."\n" + .' "rerunMode": "Allowed",'."\n" + .' "rerunTimes": 3,'."\n" + .' "rerunInterval": 180000,'."\n" + .' "failureStrategy": "Break"'."\n" + .' },'."\n" + .' "name": "OpenAPI_Test_Workflow_Demo",'."\n" + .' "outputs": {'."\n" + .' "nodeOutputs": ['."\n" + .' {'."\n" + .' "data": "workflow_output",'."\n" + .' "artifactType": "NodeOutput",'."\n" + .' "refTableName": "OpenAPI_Test_Workflow_Demo"'."\n" + .' }'."\n" + .' ]'."\n" + .' },'."\n" + .' "dependencies": []'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .'}', 'title' => ''], + ], + ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\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' => '8abcb91f-d266-4073-b907-2ed670378ed1', - ], + 'RequestId' => ['description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.', 'type' => 'string', 'example' => '20BF7E80-668A-5620-8AD8-879B8FEA****', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"20BF7E80-668A-5620-8AD8-879B8FEA****\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'UpdateWorkflowDefinition', + 'description' => '>'."\n" + ."\n" + .'This API does not support batch operations. If you define more than one workflow definition in the FlowSpec, all workflow definitions except the first one are ignored. In addition, nodes defined within the workflow definition are also ignored. Call the UpdateNode API to update internal nodes one by one.'."\n" + ."\n" + .'>', + 'changeSet' => [ + ['createdAt' => '2025-01-13T07:36:03.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' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"8abcb91f-d266-4073-b907-2ed670378ed1\\"\\n}","type":"json"}]', - 'title' => 'UpdateDataQualityEvaluationTask', - 'description' => 'This API operation is supported in all DataWorks editions.'."\n", - ], - 'CreateDataQualityEvaluationTaskInstance' => [ - 'summary' => 'Creates a monitor instance.', - 'methods' => [ - 'post', + ], + ], + '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' => 'ListDataAssets'], + ['description' => 'Request parameters changed', 'api' => 'ListDataAssetTags'], + ], + 'createdAt' => '2025-05-19T03:27:45.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'UpdateWorkflow'], + ], + 'createdAt' => '2025-05-15T07:09:41.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateResource'], + ['description' => 'Request parameters changed', 'api' => 'UpdateResource'], + ], + 'createdAt' => '2025-05-06T02:38:31.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListNodes'], + ], + 'createdAt' => '2025-04-02T02:48:54.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDataQualityEvaluationTask'], + ['description' => 'Request parameters changed', 'api' => 'CreateDataQualityRule'], + ['description' => 'Request parameters changed', 'api' => 'CreateDataQualityRuleTemplate'], + ['description' => 'Request parameters changed', 'api' => 'DeleteDataQualityEvaluationTask'], + ['description' => 'Request parameters changed', 'api' => 'DeleteDataQualityRule'], + ['description' => 'Request parameters changed', 'api' => 'DeleteDataQualityRuleTemplate'], + ], + 'createdAt' => '2025-03-31T05:58:31.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDIJob'], + ['description' => 'Response parameters changed', 'api' => 'GetDIJob'], + ], + 'createdAt' => '2025-03-27T08:15:47.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDataQualityEvaluationTask'], + ], + 'createdAt' => '2025-03-27T06:36:47.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ExecuteAdhocWorkflowInstance'], + ], + 'createdAt' => '2025-03-20T11:25:32.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateWorkflowInstances'], + ], + 'createdAt' => '2025-02-27T09:42:33.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateRoute'], + ['description' => 'Response parameters changed', 'api' => 'ListResourceGroups'], + ], + 'createdAt' => '2025-02-21T06:57:27.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetWorkflowDefinition'], + ], + 'createdAt' => '2025-02-18T02:45:30.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetDIJobLog'], + ], + 'createdAt' => '2025-02-17T09:06:10.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ExecuteAdhocWorkflowInstance'], + ], + 'createdAt' => '2025-02-11T02:31:47.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListResourceGroups'], + ], + 'createdAt' => '2025-02-10T12:42:56.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListRoutes'], + ], + 'createdAt' => '2025-01-23T11:24:45.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetTask'], + ['description' => 'Response parameters changed', 'api' => 'GetTaskInstance'], + ['description' => 'Response parameters changed', 'api' => 'ListDownstreamTaskInstances'], + ['description' => 'Response parameters changed', 'api' => 'ListDownstreamTasks'], + ['description' => 'Response parameters changed', 'api' => 'ListTaskInstances'], + ['description' => 'Response parameters changed', 'api' => 'ListTasks'], + ['description' => 'Response parameters changed', 'api' => 'ListUpstreamTaskInstances'], + ['description' => 'Response parameters changed', 'api' => 'ListUpstreamTasks'], + ], + 'createdAt' => '2025-01-21T03:12:54.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'UpdateDataQualityEvaluationTask'], + ], + 'createdAt' => '2025-01-15T08:29:49.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDataQualityEvaluationTask'], + ['description' => 'Response parameters changed', 'api' => 'GetDataQualityEvaluationTask'], + ], + 'createdAt' => '2025-01-15T08:15:34.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListTasks'], + ], + 'createdAt' => '2025-01-15T02:51:13.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListDownstreamTasks'], + ['description' => 'Response parameters changed', 'api' => 'ListUpstreamTasks'], + ], + 'createdAt' => '2025-01-13T08:45:17.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateNode'], + ['description' => 'Request parameters changed', 'api' => 'ListNodes'], + ], + 'createdAt' => '2025-01-13T07:48:44.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'AbolishDeployment'], + ['description' => 'Request parameters changed', 'api' => 'CreateDeployment'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateFunction'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateNode'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateResource'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateWorkflowDefinition'], + ['description' => 'Request parameters changed', 'api' => 'DeleteFunction'], + ['description' => 'Request parameters changed', 'api' => 'DeleteNode'], + ['description' => 'Request parameters changed', 'api' => 'DeleteResource'], + ['description' => 'Request parameters changed', 'api' => 'DeleteWorkflowDefinition'], + ], + 'createdAt' => '2025-01-13T07:36:24.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateDIAlarmRule'], + ['description' => 'Response parameters changed', 'api' => 'ListDIAlarmRules'], + ['description' => 'Request parameters changed', 'api' => 'StartDIJob'], + ['description' => 'Request parameters changed', 'api' => 'UpdateDIAlarmRule'], + ], + 'createdAt' => '2025-01-09T07:20:48.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'CreateProject'], + ], + 'createdAt' => '2025-01-07T09:52:11.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetTask'], + ], + 'createdAt' => '2025-01-07T07:52:53.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListDownstreamTaskInstances'], + ['description' => 'Response parameters changed', 'api' => 'ListDownstreamTasks'], + ['description' => 'Response parameters changed', 'api' => 'ListTasks'], + ['description' => 'Response parameters changed', 'api' => 'ListUpstreamTaskInstances'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListUpstreamTasks'], + ['description' => 'Request parameters changed', 'api' => 'TriggerSchedulerTaskInstance'], + ], + 'createdAt' => '2025-01-06T09:33:24.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DeleteDIAlarmRule'], + ['description' => 'Request parameters changed', 'api' => 'UpdateDIAlarmRule'], + ], + 'createdAt' => '2025-01-06T07:21:48.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'CreateDIAlarmRule'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateDIJob'], + ['description' => 'Request parameters changed', 'api' => 'DeleteDIAlarmRule'], + ['description' => 'Request parameters changed', 'api' => 'DeleteDIJob'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetDIJob'], + ['description' => 'Request parameters changed', 'api' => 'GetDIJobLog'], + ['description' => 'Response parameters changed', 'api' => 'ListDIAlarmRules'], + ['description' => 'Response parameters changed', 'api' => 'ListDIJobs'], + ['description' => 'Request parameters changed', 'api' => 'StartDIJob'], + ['description' => 'Request parameters changed', 'api' => 'StopDIJob'], + ], + 'createdAt' => '2025-01-06T05:34:53.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateResourceGroup'], + ['description' => 'Response parameters changed', 'api' => 'GetResourceGroup'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListNetworks'], + ], + 'createdAt' => '2025-01-02T07:14:38.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateAlertRule'], + ['description' => 'Response parameters changed', 'api' => 'GetAlertRule'], + ['description' => 'Response parameters changed', 'api' => 'ListAlertRules'], + ['description' => 'Request parameters changed', 'api' => 'UpdateAlertRule'], + ], + 'createdAt' => '2024-12-27T03:06:54.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'AttachDataQualityRulesToEvaluationTask'], + ['description' => 'Request parameters changed', 'api' => 'CreateDataQualityEvaluationTask'], + ['description' => 'Request parameters changed', 'api' => 'CreateDataQualityRule'], + ['description' => 'Request parameters changed', 'api' => 'CreateDataQualityRuleTemplate'], + ['description' => 'Request parameters changed', 'api' => 'DeleteDataQualityEvaluationTask'], + ['description' => 'Request parameters changed', 'api' => 'DeleteDataQualityRule'], + ['description' => 'Request parameters changed', 'api' => 'DeleteDataQualityRuleTemplate'], + ['description' => 'Request parameters changed', 'api' => 'DetachDataQualityRulesFromEvaluationTask'], + ['description' => 'Request parameters changed', 'api' => 'GetDataQualityEvaluationTask'], + ['description' => 'Request parameters changed', 'api' => 'GetDataQualityEvaluationTaskInstance'], + ], + 'createdAt' => '2024-12-23T06:29:31.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetDataQualityEvaluationTaskInstance'], + ['description' => 'Response parameters changed', 'api' => 'GetDataQualityRule'], + ['description' => 'Response parameters changed', 'api' => 'GetDataQualityRuleTemplate'], + ['description' => 'Response parameters changed', 'api' => 'ListDataQualityEvaluationTaskInstances'], + ['description' => 'Response parameters changed', 'api' => 'ListDataQualityEvaluationTasks'], + ['description' => 'Response parameters changed', 'api' => 'ListDataQualityResults'], + ['description' => 'Response parameters changed', 'api' => 'ListDataQualityRules'], + ['description' => 'Response parameters changed', 'api' => 'ListDataQualityRuleTemplate'], + ['description' => 'Request parameters changed', 'api' => 'UpdateDataQualityRule'], + ], + 'createdAt' => '2024-12-19T09:25:41.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CloneDataSource'], + ['description' => 'Request parameters changed', 'api' => 'DeleteDataSource'], + ], + 'createdAt' => '2024-12-19T09:00:33.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'CreateNetwork'], + ['description' => 'Response parameters changed', 'api' => 'CreateRoute'], + ], + 'createdAt' => '2024-12-19T08:50:15.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DeleteDataQualityRule'], + ['description' => 'Request parameters changed', 'api' => 'DeleteDataQualityRuleTemplate'], + ['description' => 'Request parameters changed', 'api' => 'GetDataQualityRule'], + ['description' => 'Request parameters changed', 'api' => 'GetDataQualityRuleTemplate'], + ], + 'createdAt' => '2024-12-19T08:31:02.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'UpdateDIJob'], + ], + 'createdAt' => '2024-12-11T02:02:52.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListDataQualityRules'], + ], + 'createdAt' => '2024-12-04T03:13:03.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListTaskInstances'], + ], + 'createdAt' => '2024-11-21T01:59:45.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetTask'], + ['description' => 'Response parameters changed', 'api' => 'GetTaskInstance'], + ['description' => 'Response parameters changed', 'api' => 'ListDownstreamTaskInstances'], + ['description' => 'Response parameters changed', 'api' => 'ListDownstreamTasks'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListTaskInstances'], + ['description' => 'Response parameters changed', 'api' => 'ListTasks'], + ['description' => 'Response parameters changed', 'api' => 'ListUpstreamTaskInstances'], + ['description' => 'Response parameters changed', 'api' => 'ListUpstreamTasks'], + ], + 'createdAt' => '2024-11-20T07:56:05.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListDataQualityEvaluationTaskInstances'], + ['description' => 'Response parameters changed', 'api' => 'ListDataQualityEvaluationTasks'], + ['description' => 'Response parameters changed', 'api' => 'ListDataQualityResults'], + ['description' => 'Response parameters changed', 'api' => 'ListDataQualityRules'], + ], + 'createdAt' => '2024-11-06T02:57:04.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateProject'], + ], + 'createdAt' => '2024-10-17T08:04:58.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetDIJob'], + ['description' => 'Request parameters changed', 'api' => 'ListDIJobEvents'], + ['description' => 'Request parameters changed', 'api' => 'ListDIJobMetrics'], + ['description' => 'Request parameters changed', 'api' => 'StartDIJob'], + ['description' => 'Request parameters changed', 'api' => 'StopDIJob'], + ], + 'createdAt' => '2024-10-15T07:52:29.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetDIJob'], + ], + 'createdAt' => '2024-10-15T06:50:34.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DeleteDIJob'], + ['description' => 'Request parameters changed', 'api' => 'GetDIJob'], + ['description' => 'Request parameters changed', 'api' => 'UpdateDIJob'], + ], + 'createdAt' => '2024-10-14T09:34:20.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListNodes'], + ], + 'createdAt' => '2024-10-11T02:17:30.000Z', + 'description' => '', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'], + ], + ], + 'ram' => [ + 'productCode' => 'DataWorks', + 'productName' => 'DataWorks', + 'ramCodes' => ['dataworks'], + 'ramLevel' => 'OPERATION', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'UpdateComponent', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:UpdateComponent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateProject', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:UpdateProject', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListTaskInstances', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:ListTaskInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'TaskInstance', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:taskinstance/*'], + ], + ], + ], + [ + 'apiName' => 'DeleteDatasetVersion', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dataworks:DeleteDatasetVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListNetworks', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:ListNetworks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteDataSourceSharedRule', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:DeleteDataSourceSharedRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetNode', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetNetwork', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetNetwork', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateResourceGroup', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataworks:CreateResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'DwResourceGroup', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:dwresourcegroup/*'], + ], + ], + ], + [ + 'apiName' => 'ListTasks', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'Task', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:task/*'], + ], + ], + ], + [ + 'apiName' => 'ListDataQualityTemplates', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:ListDataQualityTemplates', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetDataQualityAlertRule', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetDataQualityAlertRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateDatasetVersion', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:UpdateDatasetVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateWorkflowDefinition', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'DissociateProjectFromResourceGroup', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:DissociateProjectFromResourceGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ListTaskInstanceOperationLogs', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '250253', - 'abilityTreeNodes' => [ - 'FEATUREdideGK4B66', + [ + 'apiName' => 'ListDatasets', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:ListDatasets', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'DataQualityEvaluationTaskId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the data quality monitoring task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '200001', + [ + 'apiName' => 'ListResourceGroupAssociateProjects', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:ListResourceGroupAssociateProjects', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'DwResourceGroup', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:dwresourcegroup/{#DwResourceGroupId}'], ], ], - [ - 'name' => 'RuntimeResource', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'Resource Group information, which must be filled in when running non-MaxCompute data quality verification.', - 'type' => 'object', - 'properties' => [ - 'ResourceGroupId' => [ - 'description' => 'The identifier of the scheduling resource group configured for running the task.', - 'type' => 'string', - 'required' => false, - 'example' => '63900680', - ], - 'Cu' => [ - 'description' => 'The task runs to configure CU consumption. If Serverless resource groups are used, you must specify this parameter.', - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '0.25', - ], - ], - 'required' => false, + ], + [ + 'apiName' => 'UpdateDataSource', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:UpdateDataSource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Parameters', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Data quality verification execution parameters in JSON format. The available keys are as follows:'."\n" - .'- triggerTime: the millisecond timestamp of the trigger time. The baseline time of the $[yyyymmdd] expression in the data range of data quality monitoring. Required.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '{ "triggerTime": 1733284062000 }', + ], + [ + 'apiName' => 'StartWorkflowInstances', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - '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 ID.'."\n" - ."\n" - .'This parameter is used to determine the DataWorks workspaces used for this API call.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '10000', + ], + [ + 'apiName' => 'ListCrawlerTypes', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:ListCrawlerTypes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'ecb967ec-c137-48****', - ], - 'Id' => [ - 'description' => 'The ID of the data quality monitoring instance.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '22130', - ], - ], + [ + 'apiName' => 'GetFunction', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IdempotentParameterMismatch', - 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + [ + 'apiName' => 'CreateDataset', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataworks:CreateDataset', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"ecb967ec-c137-48****\\",\\n \\"Id\\": 22130\\n}","type":"json"}]', - 'title' => 'CreateDataQualityEvaluationTaskInstance', - ], - 'CreateDataQualityEvaluationTask' => [ - 'summary' => 'Creates a monitor in DataWorks Data Quality.', - 'methods' => [ - 'post', + [ + 'apiName' => 'DeleteWorkflowDefinition', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'GetDataQualityScan', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetDataQualityScan', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'PreviewDatasetVersion', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:PreviewDatasetVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'CreateProject', + 'description' => '', 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '248294', - 'abilityTreeNodes' => [ - 'FEATUREdide3WJOKE', + 'ramAction' => [ + 'action' => 'dataworks:CreateProject', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], - 'tenantRelevance' => 'tenant', ], - 'parameters' => [ - [ - 'name' => 'Target', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '参看 DataQualityTarget示例 数据质量校验任务的监控对象，参考 DataQualityTarget', - 'description' => 'The monitored object of the monitor.'."\n", - 'type' => 'object', - 'properties' => [ - 'DatabaseType' => [ - 'title' => '表所属的数据库类型', - 'description' => 'The type of the database to which the table belongs. Valid values:'."\n" - ."\n" - .'* maxcompute'."\n" - .'* hologres'."\n" - .'* cdh'."\n" - .'* analyticdb_for_mysql'."\n" - .'* starrocks'."\n" - .'* emr'."\n" - .'* analyticdb_for_postgresql'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [], - 'example' => 'maxcompute', - ], - 'TableGuid' => [ - 'title' => '表在数据地图中的唯一ID', - 'description' => 'The ID of the table in Data Map.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'odps.api_test.ods_openapi_log_d', - ], - 'PartitionSpec' => [ - 'title' => '分区表的分区设置', - 'description' => 'The configuration of the partitioned table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'pt=$[yyyymmdd-1]', - 'maxLength' => 255, - ], - ], - 'required' => true, - 'docRequired' => true, + [ + 'apiName' => 'MoveResource', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Description', - 'in' => 'formData', - 'schema' => [ - 'title' => '质量监控任务描述', - 'description' => 'The description of the monitor.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'OpenAPI create a data quality monitoring test', - 'maxLength' => 65535, + ], + [ + 'apiName' => 'ListImageVersions', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:ListImageVersions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'DwImage', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:dwimage/{#id}'], ], ], - [ - 'name' => 'Name', - 'in' => 'formData', - 'schema' => [ - 'title' => '质量监控任务名称', - 'description' => 'The name of the monitor.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'OpenAPI create a data quality monitoring test', - 'maxLength' => 255, + ], + [ + 'apiName' => 'DeleteProject', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dataworks:DeleteProject', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'RuntimeConf', - 'in' => 'formData', - 'schema' => [ - 'title' => '扩展配置', - 'description' => 'The extended configurations in JSON-formatted strings. You can use this parameter only for monitors that are used to monitor the quality of E-MapReduce (EMR) data.'."\n" - ."\n" - .'* queue: The Yarn queue used when a monitor checks the quality of EMR data. By default, the queue configured for the current workspace is used.'."\n" - ."\n" - .'* sqlEngine: The SQL engine used when a monitor checks the quality of EMR data.'."\n" - ."\n" - .' * HIVE_SQL'."\n" - .' * SPARK_SQL'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{ "queue": "default", "sqlEngine": "SPARK_SQL" }', + ], + [ + 'apiName' => 'GetDataQualityScanRun', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetDataQualityScanRun', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Trigger', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '数据质量校验任务的触发配置', - 'description' => 'The trigger configuration of the monitor.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => '质量监控任务触发类型', - 'description' => 'The trigger type of the monitor. Valid values:'."\n" - ."\n" - .'* ByManual (default): The monitor is manually triggered.'."\n" - .'* ByScheduledTaskInstance: The monitor is triggered by the associated scheduling tasks.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'ByScheduledTaskInstance', - ], - 'TaskIds' => [ - 'title' => '调度任务Ids', - 'description' => 'The IDs of scheduling tasks. This parameter is valid only if you set Type to ByScheduledTaskInstance.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the scheduling task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '30001', - ], - 'required' => false, - ], - ], - 'required' => false, + ], + [ + 'apiName' => 'UpdateComputeResource', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:UpdateComputeResource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'title' => '项目空间Id', - '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 query the ID.'."\n" - ."\n" - .'You can use this parameter to specify the DataWorks workspace on which you want to perform the API operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '10000', + ], + [ + 'apiName' => 'ListDeploymentPackageFiles', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Hooks', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '回调设置', - 'description' => 'The hook.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'title' => 'Hook类型', - 'description' => 'The hook type. Only one hook type is supported.'."\n" - ."\n" - .'* BlockTaskInstance: Blocks the running of scheduling tasks. A monitor is triggered by scheduling tasks. After a monitor finishes running, the monitor determines whether to block the running of scheduling tasks based on the hook condition.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'BlockTaskInstance', - ], - 'Condition' => [ - 'title' => 'Hook触发条件', - 'description' => 'The hook trigger condition. When this condition is met, the hook action is triggered. Only two conditional expressions are supported:'."\n" - ."\n" - .'1. Specify only one group of rule strength type and rule check status, such as `${severity} == "High" AND ${status} == "Critical"`. In this expression, the hook trigger condition is met if severity is High and status is Critical.'."\n" - .'2. Specify multiple groups of rule strength types and rule check status, such as `(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")`. In this expression, the hook trigger condition is met if severity is High and status is Critical, severity is Normal and status is Critical, or severity is Normal and status is Error. The enumeration of severity in a conditional expression is the same as the enumeration of severity in DataQualityRule. The enumeration of status in a conditional expression is the same as the enumeration of status in DataQualityResult.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")', - ], - ], - 'required' => false, - 'description' => 'Hook', - ], - 'required' => false, + ], + [ + 'apiName' => 'ListPipelineRuns', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Notifications', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'title' => '通知订阅配置', - 'description' => 'The configurations of alert notifications.'."\n", - 'type' => 'object', - 'properties' => [ - 'Condition' => [ - 'title' => '通知触发条件', - 'description' => 'The notification trigger condition. When this condition is met, the alert notification is triggered. Only two conditional expressions are supported:'."\n" - ."\n" - .'Specify only one group of rule strength type and rule check status, such as `${severity} == "High" AND ${status} == "Critical"`. In this expression, the hook trigger condition is met if severity is High and status is Critical. Specify multiple groups of rule strength types and rule check status, such as `(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")`. In this expression, the hook trigger condition is met if severity is High and status is Critical, severity is Normal and status is Critical, or severity is Normal and status is Error. The enumeration of severity in a conditional expression is the same as the enumeration of severity in DataQualityRule. The enumeration of status in a conditional expression is the same as the enumeration of status in DataQualityResult.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '(${severity} == "High" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Critical") OR (${severity} == "Normal" AND ${status} == "Error")', - ], - 'Notifications' => [ - 'title' => '通知设置', - 'description' => 'The configurations of the alert notification.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'NotificationReceivers' => [ - 'title' => '告警接收人设置', - 'description' => 'The configurations of alert recipients.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ReceiverType' => [ - 'title' => '告警接收人类型', - 'description' => 'The type of the alert recipient. Valid values:'."\n" - ."\n" - .'* WebhookUrl'."\n" - .'* FeishuUrl'."\n" - .'* DingdingUrl'."\n" - .'* WeixinUrl'."\n" - .'* AliUid'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'DingdingUrl', - ], - 'Extension' => [ - 'title' => '扩展信息', - 'description' => 'The additional parameters that are required when alerts are sent. The parameters are JSON-formatted strings. The following keys are supported:'."\n" - ."\n" - .'* atAll: specifies that all members in a group are mentioned when alerts are sent by using DingTalk. This parameter is valid only if you set ReceiverType to DingdingUrl.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{ "atAll": true }', - ], - 'ReceiverValues' => [ - 'title' => '告警接收人', - 'description' => 'The alert recipient.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The recipient.'."\n" - ."\n" - .'* If you set ReceiverType to AliUid, set this parameter to the Alibaba Cloud account ID of a user.'."\n" - .'* If you set ReceiverType to DingdingUrl, set this parameter to the URL of a DingTalk chatbot.'."\n" - .'* If you set ReceiverType to WeixinUrl, set this parameter to the URL of WeCom.'."\n" - .'* If you set ReceiverType to FeishuUrl, set this parameter to the URL of Lark.'."\n" - .'* If you set ReceiverType to WebhookUrl, set this parameter to the webhook URL.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'https://api.fc.aliyuncs.com/webhook', - 'maxLength' => 255, - ], - 'required' => false, - ], - ], - 'required' => false, - 'description' => '告警接收人设置', - ], - 'required' => false, - ], - 'NotificationChannels' => [ - 'title' => '通知方式', - 'description' => 'The alert notification methods.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Channels' => [ - 'title' => '通知方式', - 'description' => 'The alert notification methods.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The alert notification method. Valid values:'."\n" - ."\n" - .'* Mail'."\n" - .'* Sms'."\n" - .'* Phone'."\n" - .'* Feishu'."\n" - .'* Weixin'."\n" - .'* Dingding'."\n" - .'* Webhook'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Mail', - ], - 'required' => false, - ], - ], - 'required' => false, - 'description' => '通知方式', - ], - 'required' => false, - ], - ], - 'required' => false, - 'description' => '通知设置', - ], - 'required' => false, - ], - ], - 'required' => false, + ], + [ + 'apiName' => 'DeleteNetwork', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dataworks:DeleteNetwork', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'DataSourceId', - 'in' => 'formData', - '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', + ], + [ + 'apiName' => 'GetTask', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'DataQualityRules', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The list of monitoring rules that are associated with the monitor. If you configure the ID of a monitoring rule by using the DataQualityRule.Id parameter, the system associates the rule with a created monitor. If you do not configure the ID of a monitoring rule, the system creates a new monitoring rule by using other fields and associates the rule with a created monitor.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the monitoring rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'OpenAPI test rules', - 'default' => '255', - ], - 'Enabled' => [ - 'description' => 'Specifies whether to enable the monitoring rule.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'Severity' => [ - 'description' => 'The strength of the monitoring rule. Valid values:'."\n" - ."\n" - .'* Normal'."\n" - .'* High'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'High', - 'enum' => [ - 'High', - 'Normal', - ], - ], - 'Description' => [ - 'description' => 'The description of the monitoring rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'OpenAPI test rules', - 'maxLength' => 500, - ], - 'TemplateCode' => [ - 'description' => 'The ID of the template used by the monitoring rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SYSTEM:field:null_value:fixed:0', - ], - 'SamplingConfig' => [ - 'description' => 'The parameters required for sampling.'."\n", - 'type' => 'object', - 'properties' => [ - 'Metric' => [ - 'description' => 'The metrics used for sampling. Valid values:'."\n" - ."\n" - .'* Count: the number of rows in the table.'."\n" - .'* Min: the minimum value of the field.'."\n" - .'* Max: the maximum value of the field.'."\n" - .'* Avg: the average value of the field.'."\n" - .'* DistinctCount: the number of unique values of the field after deduplication.'."\n" - .'* DistinctPercent: the proportion of the number of unique values of the field after deduplication to the number of rows in the table.'."\n" - .'* DuplicatedCount: the number of duplicated values of the field.'."\n" - .'* DuplicatedPercent: the proportion of the number of duplicated values of the field to the number of rows in the table.'."\n" - .'* TableSize: the table size.'."\n" - .'* NullValueCount: the number of rows in which the field value is null.'."\n" - .'* NullValuePercent: the proportion of the number of rows in which the field value is null to the number of rows in the table.'."\n" - .'* GroupCount: the field value and the number of rows for each field value.'."\n" - .'* CountNotIn: the number of rows in which the field values are different from the referenced values that you specified in the rule.'."\n" - .'* CountDistinctNotIn: the number of unique values that are different from the referenced values that you specified in the rule after deduplication.'."\n" - .'* UserDefinedSql: specifies that data is sampled by executing custom SQL statements.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'NullValueCount', - ], - 'MetricParameters' => [ - 'description' => 'The parameters required for sampling.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{ "Columns": [ "id", "name" ] , "SQL": "select count(1) from table;"}', - ], - 'SettingConfig' => [ - 'description' => 'The statements that are used to configure the parameters required for sampling before you execute the sampling statements. The statements can be up to 1,000 characters in length. Only the MaxCompute database is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'odps.sql.type.system.odps2=True,odps.sql.hive.compatible=True', - 'maxLength' => 1000, - ], - 'SamplingFilter' => [ - 'description' => 'The statements that are used to filter unnecessary data during sampling. The statements can be up to 16,777,215 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'status != \'Succeeded\'', - ], - ], - 'required' => false, - ], - 'CheckingConfig' => [ - 'description' => 'The check settings for sample data.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The threshold calculation method. Valid values:'."\n" - ."\n" - .'* Fixed'."\n" - .'* Fluctation'."\n" - .'* FluctationDiscreate'."\n" - .'* Auto'."\n" - .'* Average'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Fixed', - ], - 'ReferencedSamplesFilter' => [ - 'description' => 'The method that is used to query the referenced samples. To obtain specific types of thresholds, you must query reference values. In this example, an expression is used to specify the query method of referenced samples.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"bizdate": ["-1"]}', - ], - 'Thresholds' => [ - 'description' => 'The threshold settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Expected' => [ - 'description' => 'The expected threshold setting.'."\n", - 'type' => 'object', - 'properties' => [ - 'Operator' => [ - 'description' => 'The comparison operator. Valid values:'."\n" - ."\n" - .'* \\>'."\n" - .'* \\>='."\n" - .'* <'."\n" - .'* <='."\n" - .'* !='."\n" - .'* \\='."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => '=', - ], - 'Value' => [ - 'description' => 'The threshold value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], - 'Expression' => [ - 'description' => 'The threshold expression.'."\n" - ."\n" - .'If the template specified by the TemplateCode parameter is about fluctuation, you must use an expression to represent the threshold for fluctuation. Examples:'."\n" - ."\n" - .'* $checkValue > 0.01'."\n" - .'* $checkValue < -0.01'."\n" - .'* abs($checkValue) > 0.01'."\n" - ."\n" - .'If the template specified by the TemplateCode parameter is about fixed value, you can also use an expression to represent the threshold. If you configure the Expression, Operator, and Value parameters for the threshold at the same time, the Expression parameter takes precedence over the Operator and Value parameters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '$checkValue > 0.01', - ], - ], - 'required' => false, - ], - 'Warned' => [ - 'description' => 'The threshold settings for normal alerts.'."\n", - 'type' => 'object', - 'properties' => [ - 'Operator' => [ - 'description' => 'The comparison operator. Valid values:'."\n" - ."\n" - .'* \\>'."\n" - .'* \\>='."\n" - .'* <'."\n" - .'* <='."\n" - .'* !='."\n" - .'* \\='."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => '>', - ], - 'Value' => [ - 'description' => 'The threshold value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0.001', - ], - 'Expression' => [ - 'description' => 'The threshold expression.'."\n" - ."\n" - .'If the template specified by the TemplateCode parameter is about fluctuation, you must use an expression to represent the threshold for fluctuation. Examples:'."\n" - ."\n" - .'* $checkValue > 0.01'."\n" - .'* $checkValue < -0.01'."\n" - .'* abs($checkValue) > 0.01'."\n" - ."\n" - .'If the template specified by the TemplateCode parameter is about fixed value, you can also use an expression to represent the threshold. If you configure the Expression, Operator, and Value parameters for the threshold at the same time, the Expression parameter takes precedence over the Operator and Value parameters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '$checkValue > 0.01', - ], - ], - 'required' => false, - ], - 'Critical' => [ - 'description' => 'The threshold settings for critical alerts.'."\n", - 'type' => 'object', - 'properties' => [ - 'Operator' => [ - 'description' => 'The comparison operator. Valid values:'."\n" - ."\n" - .'* \\>'."\n" - .'* \\>='."\n" - .'* <'."\n" - .'* <='."\n" - .'* !='."\n" - .'* \\='."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => '>', - ], - 'Value' => [ - 'description' => 'The threshold value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0.01', - ], - 'Expression' => [ - 'description' => 'The threshold expression.'."\n" - ."\n" - .'If the template specified by the TemplateCode parameter is about fluctuation, you must use an expression to represent the threshold for fluctuation. Examples:'."\n" - ."\n" - .'* $checkValue > 0.01'."\n" - .'* $checkValue < -0.01'."\n" - .'* abs($checkValue) > 0.01'."\n" - ."\n" - .'If the template specified by the TemplateCode parameter is about fixed value, you can also use an expression to represent the threshold. If you configure the Expression, Operator, and Value parameters for the threshold at the same time, the Expression parameter takes precedence over the Operator and Value parameters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '$checkValue > 0.01', - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'ErrorHandlers' => [ - 'description' => 'The operations that you can perform after the rule-based check fails.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The operation that you can perform after the rule-based check fails.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the operation. Valid values:'."\n" - ."\n" - .'* SaveErrorData'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'SaveErrorData', - ], - 'ErrorDataFilter' => [ - 'description' => 'The SQL statement that is used to filter failed tasks. If you define the rule by using custom SQL statements, you must specify an SQL statement to filter failed tasks.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SELECT * FROM ods_api_log WHERE status = \'Error\';', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'Id' => [ - 'description' => 'The rule ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '2176', - ], - ], - 'required' => false, - 'description' => '', - ], - 'required' => false, + ], + [ + 'apiName' => 'GrantMemberProjectRoles', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:GrantMemberProjectRoles', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => '2d9ce-38ef-4923-baf6-391a7e656', - ], - 'Id' => [ - 'description' => 'The ID of the new monitor.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10001', - ], - ], + [ + 'apiName' => 'CreateAgentSession', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataworks:CreateAgentSession', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IdempotentParameterMismatch', - 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + [ + 'apiName' => 'GetWorkflowInstance', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2d9ce-38ef-4923-baf6-391a7e656\\",\\n \\"Id\\": 10001\\n}","type":"json"}]', - 'title' => 'CreateDataQualityEvaluationTask', - 'description' => 'This API operation is supported in all DataWorks editions.'."\n", - ], - 'DeleteDataQualityRule' => [ - 'summary' => 'Deletes a data quality monitoring rule.', - 'methods' => [ - 'post', + [ + 'apiName' => 'ListDatabases', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:ListDatabases', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'GetTaskInstanceLog', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'GetDataSource', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetDataSource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '247983', - 'abilityTreeNodes' => [ - 'FEATUREdide3WJOKE', + [ + 'apiName' => 'GetProject', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetProject', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => 'The rule ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '19715', + [ + 'apiName' => 'CreateComputeResource', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:CreateComputeResource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'example' => '17302', + ], + [ + 'apiName' => 'GetResource', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - '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' => '691CA452-D37A-4ED0-9441'."\n", - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], + [ + 'apiName' => 'StopTaskInstances', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'MoveNode', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-4ED0-9441\\\\n\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'DeleteDataQualityRule', - ], - 'UpdateDataQualityRuleTemplate' => [ - 'summary' => 'Updates a data quality monitoring rule template.', - 'methods' => [ - 'post', + [ + 'apiName' => 'ListDataQualityScanRuns', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:ListDataQualityScanRuns', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'RenameWorkflowDefinition', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'ListDataQualityScans', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:ListDataQualityScans', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'LoadAgentSession', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dataworks:LoadAgentSession', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'CreateResource', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetComputeResource', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetComputeResource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ImportWorkflowDefinition', + 'description' => '', 'operationType' => 'update', - 'abilityTreeCode' => '248082', - 'abilityTreeNodes' => [ - 'FEATUREdideRGVRPF', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'Code', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The code for the template.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'USER_DEFINED:123', + [ + 'apiName' => 'GetLineageRelationship', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetLineageRelationship', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Name', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the template. The name can be up to 512 characters in length and can contain digits, letters, and punctuation marks.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'Table row Count Verification', - 'maxLength' => 128, + ], + [ + 'apiName' => 'RenameFunction', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - '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, - 'example' => '10000', + ], + [ + 'apiName' => 'ListResourceGroupMetricData', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:ListResourceGroupMetricData', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'DwResourceGroup', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:dwresourcegroup/{#DwResourceGroupId}'], ], ], - [ - 'name' => 'DirectoryPath', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The directory in which the template is stored. Slashes (/) are used to separate directory levels. The name of each directory level can be up to 1,024 characters in length. It cannot contain whitespace characters or slashes (/).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '/ods/order_data', + ], + [ + 'apiName' => 'GetProjectRole', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetProjectRole', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'SamplingConfig', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The sampling settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Metric' => [ - 'description' => 'The metrics used for sampling. Valid values:'."\n" - ."\n" - .'* Count: the number of rows in the table.'."\n" - .'* Min: the minimum value of the field.'."\n" - .'* Max: the maximum value of the field.'."\n" - .'* Avg: the average value of the field.'."\n" - .'* DistinctCount: the number of unique values of the field after deduplication.'."\n" - .'* DistinctPercent: the proportion of the number of unique values of the field after deduplication to the number of rows in the table.'."\n" - .'* DuplicatedCount: the number of duplicated values of the field.'."\n" - .'* DuplicatedPercent: the proportion of the number of duplicated values of the field to the number of rows in the table.'."\n" - .'* TableSize: the table size.'."\n" - .'* NullValueCount: the number of rows in which the field value is null.'."\n" - .'* NullValuePercent: the proportion of the number of rows in which the field value is null to the number of rows in the table.'."\n" - .'* GroupCount: the field value and the number of rows for each field value.'."\n" - .'* CountNotIn: the number of rows in which the field values are different from the referenced values that you specified in the rule.'."\n" - .'* CountDistinctNotIn: the number of unique values that are different from the referenced values that you specified in the rule after deduplication.'."\n" - .'* UserDefinedSql: indicates that data is sampled by executing custom SQL statements.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Max', - ], - 'MetricParameters' => [ - 'description' => 'The parameters required for sampling.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"SQL": "select count(1) from table;"}'."\n", - ], - 'SettingConfig' => [ - 'description' => 'The statements that are used to configure the parameters required for sampling before you execute the sampling statements. The statements can be up to 1,000 characters in length. Only the MaxCompute database is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SET odps.sql.udf.timeout=600s; '."\n" - .'SET odps.sql.python.version=cp27;'."\n", - 'maxLength' => 1000, - ], - ], - 'required' => false, + ], + [ + 'apiName' => 'RerunWorkflowInstances', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:RerunWorkflowInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'CheckingConfig', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The check settings for sample data.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the monitored object. Valid values:'."\n" - ."\n" - .'* Table'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Table', - ], - 'ReferencedSamplesFilter' => [ - 'description' => 'The method that is used to query the referenced samples. To obtain some types of thresholds, you need to query reference samples and perform aggregate operations on the reference values. In this example, an expression is used to specify the query method of referenced samples.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{ "bizdate": [ "-1", "-7", "-1m" ] }'."\n", - ], - ], - 'required' => false, + ], + [ + 'apiName' => 'DeleteDataset', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dataworks:DeleteDataset', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => '691CA452-D37A-4ED0-9441'."\n", - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], + [ + 'apiName' => 'ListTables', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:ListTables', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'ListWorkflowDefinitions', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-4ED0-****\\\\n\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'UpdateDataQualityRuleTemplate', - ], - 'CreateDataQualityRuleTemplate' => [ - 'summary' => 'Creates a data quality monitoring rule template.', - 'methods' => [ - 'post', + [ + 'apiName' => 'ListPipelineRunItems', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'UpdateResource', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'GetMetaEntity', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetMetaEntity', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'ListDataQualityRules', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListImages', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:ListImages', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetCreateWorkflowInstancesResult', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetCreateWorkflowInstancesResult', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetDataQualityEvaluationTaskInstance', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetTaskInstance', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateDataset', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:UpdateDataset', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'AbolishPipelineRun', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListProjects', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:ListProjects', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetAgentSessionTokenUsage', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetAgentSessionTokenUsage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListLineages', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:ListLineages', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ExecuteAdhocWorkflowInstance', + 'description' => '', 'operationType' => 'create', - 'abilityTreeCode' => '248081', - 'abilityTreeNodes' => [ - 'FEATUREdideRGVRPF', + 'ramAction' => [ + 'action' => 'dataworks:ExecuteAdhocWorkflowInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'Name', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the template. The name can be up to 512 characters in length and can contain digits, letters, and punctuation marks.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Table row Count Verification', - 'maxLength' => 128, + [ + 'apiName' => 'ListTaskOperationLogs', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:ListTaskOperationLogs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '12345', + ], + [ + 'apiName' => 'ListDataQualityAlertRules', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:ListDataQualityAlertRules', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'VisibleScope', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The applicable scope of the template. Valid values:'."\n" - ."\n" - .'* Tenant: The template is available in all workspaces in the current tenant.'."\n" - .'* Project: The template is available only in the current workspace.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'enumValueTitles' => [], - 'example' => 'Project', - 'default' => 'Project', - 'enum' => [ - 'Project', - 'Tenant', - ], + ], + [ + 'apiName' => 'GetProjectMember', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetProjectMember', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'DirectoryPath', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The directory in which the template is stored. Slashes (/) are used to separate directory levels. The name of each directory level can be up to 1,024 characters in length. It cannot contain whitespace characters or slashes (/).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '/ods/order_data', + ], + [ + 'apiName' => 'GetJobStatus', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetJobStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'SamplingConfig', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The sampling settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Metric' => [ - 'description' => 'The metrics used for sampling. Valid values:'."\n" - ."\n" - .'* Count: the number of rows in the table.'."\n" - .'* Min: the minimum value of the field.'."\n" - .'* Max: the maximum value of the field.'."\n" - .'* Avg: the average value of the field.'."\n" - .'* DistinctCount: the number of unique values of the field after deduplication.'."\n" - .'* DistinctPercent: the proportion of the number of unique values of the field after deduplication to the number of rows in the table.'."\n" - .'* DuplicatedCount: the number of duplicated values of the field.'."\n" - .'* DuplicatedPercent: the proportion of the number of duplicated values of the field to the number of rows in the table.'."\n" - .'* TableSize: the table size.'."\n" - .'* NullValueCount: the number of rows in which the field value is null.'."\n" - .'* NullValuePercent: the proportion of the number of rows in which the field value is null to the number of rows in the table.'."\n" - .'* GroupCount: the field value and the number of rows for each field value.'."\n" - .'* CountNotIn: the number of rows in which the field values are different from the referenced values that you specified in the rule.'."\n" - .'* CountDistinctNotIn: the number of unique values that are different from the referenced values that you specified in the rule after deduplication.'."\n" - .'* UserDefinedSql: specifies that data is sampled by executing custom SQL statements.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'Count', - ], - 'MetricParameters' => [ - 'description' => 'The parameters required for sampling.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '{"SQL": "select count(1) from table;"}'."\n", - ], - 'SettingConfig' => [ - 'description' => 'The statements that are used to configure the parameters required for sampling before you execute the sampling statements. The statements can be up to 1,000 characters in length. Only the MaxCompute database is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SET odps.sql.udf.timeout=600s; '."\n" - .'SET odps.sql.python.version=cp27;'."\n", - 'maxLength' => 1000, - ], - ], - 'required' => true, - 'docRequired' => true, + ], + [ + 'apiName' => 'GetCatalog', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetCatalog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'CheckingConfig', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The check settings for sample data.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The threshold calculation method. Valid values:'."\n" - ."\n" - .'* Fixed'."\n" - .'* Fluctation'."\n" - .'* FluctationDiscreate'."\n" - .'* Auto'."\n" - .'* Average'."\n" - .'* Variance'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Fixed', - ], - 'ReferencedSamplesFilter' => [ - 'description' => 'The method that is used to query the referenced samples. To obtain some types of thresholds, you need to query reference samples and perform aggregate operations on the reference values. In this example, an expression is used to specify the query method of referenced samples.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{ "bizdate": [ "-1", "-7", "-1m" ] }'."\n", - ], - ], - 'required' => false, + ], + [ + 'apiName' => 'GetCertificate', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetCertificate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - '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' => '691CA452-D37A-4ED0-9441'."\n", - ], - 'Code' => [ - 'description' => 'The Code of the rule template.', - 'type' => 'string', - 'example' => 'UserDefined:3001', - ], - ], + [ + 'apiName' => 'GetDataQualityScanRunLog', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetDataQualityScanRunLog', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CloneDataSource', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:CloneDataSource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CreateDataSource', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:CreateDataSource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListResourceGroups', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:ListResourceGroups', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'DwResourceGroup', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:dwresourcegroup/*'], + ], + ], + ], + [ + 'apiName' => 'CreateDataSourceSharedRule', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:CreateDataSourceSharedRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListAgentSessionArtifacts', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:ListAgentSessionArtifacts', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetRoute', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetRoute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListComputeResources', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:ListComputeResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetComponent', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetComponent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteResourceGroup', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dataworks:DeleteResourceGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'UpdateTaskInstances', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetDatabase', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetDatabase', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CancelAgentSession', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dataworks:CancelAgentSession', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteProjectMember', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dataworks:DeleteProjectMember', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetAgent', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetAgent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ExecPipelineRunStage', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListCatalogs', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:ListCatalogs', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'GetResourceGroup', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'DwResourceGroup', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:dwresourcegroup/{#DwResourceGroupId}'], + ], + ], + ], + [ + 'apiName' => 'GetCustomAttribute', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetCustomAttribute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'DeleteCustomAttribute', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dataworks:DeleteCustomAttribute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListNodes', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListSchemas', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:ListSchemas', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListEntitiesInMetaCollection', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:ListEntitiesInMetaCollection', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'GetDataQualityRule', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-4ED0-9441\\\\n\\",\\n \\"Code\\": \\"UserDefined:3001\\"\\n}","type":"json"}]', - 'title' => 'CreateDataQualityRuleTemplate', - ], - 'DeleteDataQualityRuleTemplate' => [ - 'summary' => 'Deletes a data quality monitoring rule template.', - 'methods' => [ - 'post', + [ + 'apiName' => 'GetImage', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetImage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'GetDataQualityTemplate', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetDataQualityTemplate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ListComponents', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:ListComponents', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'abilityTreeCode' => '248058', - 'abilityTreeNodes' => [ - 'FEATUREdideRGVRPF', + [ + 'apiName' => 'DeleteComputeResource', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:DeleteComputeResource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'Code', - 'in' => 'query', - 'schema' => [ - 'description' => 'The code for the template.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'USER_DEFINED:123', + [ + 'apiName' => 'RevokeMemberProjectRoles', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:RevokeMemberProjectRoles', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'example' => '10001', + ], + [ + 'apiName' => 'ListCustomAgents', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:ListCustomAgents', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - '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' => '691CA452-D37A-4ED0-9441'."\n", - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], + [ + 'apiName' => 'AddEntityIntoMetaCollection', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dataworks:AddEntityIntoMetaCollection', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'ListProjectRoles', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:ListProjectRoles', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-4ED0-9441\\\\n\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'DeleteDataQualityRuleTemplate', - ], - 'GetDataQualityRuleTemplate' => [ - 'summary' => 'Queries the information about a data quality monitoring rule template.', - 'methods' => [ - 'get', + [ + 'apiName' => 'DeleteSkill', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dataworks:DeleteSkill', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'DeleteDataSource', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:DeleteDataSource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ListDataQualityEvaluationTaskInstances', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'TriggerSchedulerTaskInstance', + 'description' => '', 'operationType' => 'get', - 'abilityTreeCode' => '247999', - 'abilityTreeNodes' => [ - 'FEATUREdideRGVRPF', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'Code', - 'in' => 'query', - 'schema' => [ - 'description' => 'The code for the template.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'USER_DEFINED:123', + [ + 'apiName' => 'ListImageAssociatedProjects', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:ListImageAssociatedProjects', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - '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' => '691CA452-D37A-4ED0-9441'."\n", - ], - 'DataQualityRuleTemplate' => [ - 'description' => 'The information about the template.'."\n", - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The code for the template.'."\n", - 'type' => 'string', - 'example' => 'USER_DEFINED:123', - ], - 'Name' => [ - 'description' => 'The name of the template. The name can be up to 512 characters in length and can contain digits, letters, and punctuation marks.'."\n", - 'type' => 'string', - 'example' => 'Table row Count Verification', - ], - 'ProjectId' => [ - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '4020', - ], - 'SamplingConfig' => [ - 'description' => 'The sampling settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Metric' => [ - 'description' => 'The metrics used for sampling. Valid values:'."\n" - ."\n" - .'* Count: the number of rows in the table.'."\n" - .'* Min: the minimum value of the field.'."\n" - .'* Max: the maximum value of the field.'."\n" - .'* Avg: the average value of the field.'."\n" - .'* DistinctCount: the number of unique values of the field after deduplication.'."\n" - .'* DistinctPercent: the proportion of the number of unique values of the field after deduplication to the number of rows in the table.'."\n" - .'* DuplicatedCount: the number of duplicated values of the field.'."\n" - .'* DuplicatedPercent: the proportion of the number of duplicated values of the field to the number of rows in the table.'."\n" - .'* TableSize: the table size.'."\n" - .'* NullValueCount: the number of rows in which the field value is null.'."\n" - .'* NullValuePercent: the proportion of the number of rows in which the field value is null to the number of rows in the table.'."\n" - .'* GroupCount: the field value and the number of rows for each field value.'."\n" - .'* CountNotIn: the number of rows in which the field values are different from the referenced values that you specified in the rule.'."\n" - .'* CountDistinctNotIn: the number of unique values that are different from the referenced values that you specified in the rule after deduplication.'."\n" - .'* UserDefinedSql: indicates that data is sampled by executing custom SQL statements.'."\n", - 'type' => 'string', - 'example' => 'Max', - ], - 'MetricParameters' => [ - 'description' => 'The parameters required for sampling.'."\n", - 'type' => 'string', - 'example' => '{"SQL": "select count(1) from table;"}', - ], - 'SettingConfig' => [ - 'description' => 'The statements that are used to configure the parameters required for sampling before you execute the sampling statements. The statements can be up to 1,000 characters in length. Only the MaxCompute database is supported.'."\n", - 'type' => 'string', - 'example' => 'SET odps.sql.udf.timeout=600s; '."\n" - .'SET odps.sql.python.version=cp27;'."\n", - ], - ], - ], - 'CheckingConfig' => [ - 'description' => 'The check settings for sample data.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The threshold calculation method. Valid values:'."\n" - ."\n" - .'* Fixed'."\n" - .'* Fluctation'."\n" - .'* FluctationDiscreate'."\n" - .'* Auto'."\n" - .'* Average'."\n" - .'* Variance'."\n", - 'type' => 'string', - 'example' => 'Fixed', - ], - 'ReferencedSamplesFilter' => [ - 'description' => 'The method that is used to query the referenced samples. To obtain some types of thresholds, you need to query reference samples and perform aggregate operations on the reference values. In this example, an expression is used to indicate the query method of referenced samples.'."\n", - 'type' => 'string', - 'example' => '{ "bizdate": [ "-1", "-7", "-1m" ] }'."\n", - ], - ], - ], - 'VisibleScope' => [ - 'description' => 'Available range of templates:'."\n" - .'- Tenant: all tenants are available'."\n" - .'- Project: only available in the current Project', - 'type' => 'string', - 'example' => 'Project', - ], - 'DirectoryPath' => [ - 'description' => 'The directory in which the template is stored. Slashes (/) are used to separate directory levels. The name of each directory level can be up to 1,024 characters in length. It cannot contain whitespace characters or slashes (/).'."\n", - 'type' => 'string', - 'example' => '/ods/order_data', - ], - ], - ], - ], + [ + 'apiName' => 'UpdateCustomAttribute', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:UpdateCustomAttribute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'UpdateResourceGroup', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:UpdateResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'DwResourceGroup', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:dwresourcegroup/{#DwResourceGroupId}'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-4E****\\",\\n \\"DataQualityRuleTemplate\\": {\\n \\"Code\\": \\"USER_DEFINED:123\\",\\n \\"Name\\": \\"Table row Count Verification\\",\\n \\"ProjectId\\": 4020,\\n \\"SamplingConfig\\": {\\n \\"Metric\\": \\"Max\\",\\n \\"MetricParameters\\": \\"{\\\\\\"SQL\\\\\\": \\\\\\"select count(1) from table;\\\\\\"}\\",\\n \\"SettingConfig\\": \\"SET odps.sql.udf.timeout=600s; \\\\nSET odps.sql.python.version=cp27;\\\\n\\"\\n },\\n \\"CheckingConfig\\": {\\n \\"Type\\": \\"Fixed\\",\\n \\"ReferencedSamplesFilter\\": \\"{ \\\\\\"bizdate\\\\\\": [ \\\\\\"-1\\\\\\", \\\\\\"-7\\\\\\", \\\\\\"-1m\\\\\\" ] }\\\\n\\"\\n },\\n \\"VisibleScope\\": \\"Project\\",\\n \\"DirectoryPath\\": \\"/ods/order_data\\"\\n }\\n}","type":"json"}]', - 'title' => 'GetDataQualityRuleTemplate', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", - ], - 'CreateDataQualityRule' => [ - 'summary' => 'Creates a data quality monitoring rule.', - 'methods' => [ - 'post', + [ + 'apiName' => 'ListNodeDependencies', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'ListColumns', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:ListColumns', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'RerunTaskInstances', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'CreateNetwork', + 'description' => '', 'operationType' => 'create', - 'abilityTreeCode' => '247801', - 'abilityTreeNodes' => [ - 'FEATUREdide3WJOKE', + 'ramAction' => [ + 'action' => 'dataworks:CreateNetwork', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'Name', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the rule.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'The table cannot be empty.', - 'maxLength' => 255, + [ + 'apiName' => 'GetWorkflowDefinition', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ProjectId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '10726', + ], + [ + 'apiName' => 'ListPartitions', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:ListPartitions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Enabled', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether to enable the monitoring rule.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'true', + ], + [ + 'apiName' => 'GetAgentSessionArtifactMeta', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetAgentSessionArtifactMeta', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Severity', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The strength of the rule. Valid values:'."\n" - ."\n" - .'* Normal'."\n" - .'* High'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'Normal', - 'default' => 'Normal', - 'enum' => [ - 'High', - 'Normal', - ], + ], + [ + 'apiName' => 'ListMetaCollections', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:ListMetaCollections', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Description', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The description of the rule. The description can be up to 500 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'this is a odps _sql task'."\n", - 'maxLength' => 500, + ], + [ + 'apiName' => 'CreateDatasetVersion', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataworks:CreateDatasetVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Target', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The monitored object of the rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the monitored object. Valid values:'."\n" - ."\n" - .'* Table'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'Table', - ], - 'DatabaseType' => [ - 'description' => 'The type of the database to which the table belongs. Valid values:'."\n" - ."\n" - .'* maxcompute'."\n" - .'* emr'."\n" - .'* cdh'."\n" - .'* hologres'."\n" - .'* analyticdb_for_postgresql'."\n" - .'* analyticdb_for_mysql'."\n" - .'* starrocks'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'maxcompute'."\n", - ], - 'TableGuid' => [ - 'description' => 'The ID of the table that is limited by the rule in Data Map.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'odps.unit_test.tb_unit_test'."\n", - ], - 'PartitionSpec' => [ - 'description' => 'The configuration of the partitioned table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ds=$[yyyymmdd-1]'."\n", - ], - ], - 'required' => true, - 'docRequired' => true, + ], + [ + 'apiName' => 'CreateFunction', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'TemplateCode', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the template used by the rule.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'system::user_defined'."\n", - 'default' => 'SYSTEM:user_defined_sql', + ], + [ + 'apiName' => 'AssociateProjectToResourceGroup', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:AssociateProjectToResourceGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'SamplingConfig', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The sampling settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Metric' => [ - 'description' => 'The metrics used for sampling. You can leave this parameter empty if you use a rule template. Valid values:'."\n" - ."\n" - .'* Count: the number of rows in the table.'."\n" - .'* Min: the minimum value of the field.'."\n" - .'* Max: the maximum value of the field.'."\n" - .'* Avg: the average value of the field.'."\n" - .'* DistinctCount: the number of unique values of the field after deduplication.'."\n" - .'* DistinctPercent: the proportion of the number of unique values of the field after deduplication to the number of rows in the table.'."\n" - .'* DuplicatedCount: the number of duplicated values of the field.'."\n" - .'* DuplicatedPercent: the proportion of the number of duplicated values of the field to the number of rows in the table.'."\n" - .'* TableSize: the table size.'."\n" - .'* NullValueCount: the number of rows in which the field value is null.'."\n" - .'* NullValuePercent: the proportion of the number of rows in which the field value is null to the number of rows in the table.'."\n" - .'* GroupCount: the field value and the number of rows for each field value.'."\n" - .'* CountNotIn: the number of rows in which the field values are different from the referenced values that you specified in the rule.'."\n" - .'* CountDistinctNotIn: the number of unique values that are different from the referenced values that you specified in the rule after deduplication.'."\n" - .'* UserDefinedSql: specifies that data is sampled by executing custom SQL statements.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Count', - ], - 'MetricParameters' => [ - 'description' => 'The parameters required for sampling.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{ "Columns": [ "id", "name" ] , "SQL": "select count(1) from table;"}', - ], - 'SettingConfig' => [ - 'description' => 'The statements that are used to configure the parameters required for sampling before you execute the sampling statements. The statements can be up to 1,000 characters in length. Only the MaxCompute database is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SET odps.sql.udf.timeout=600s; '."\n" - .'SET odps.sql.python.version=cp27;', - 'maxLength' => 1000, - ], - 'SamplingFilter' => [ - 'description' => 'The statements that are used to filter unnecessary data during sampling. The statements can be up to 16,777,215 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'id IS NULL'."\n", - ], - ], - 'required' => false, + ], + [ + 'apiName' => 'ListWorkflowInstances', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'CheckingConfig', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The check settings for sample data.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The method that is used to calculate a threshold. You can leave this parameter empty if you use a rule template. Valid values:'."\n" - ."\n" - .'* Fixed'."\n" - .'* Fluctation'."\n" - .'* FluctationDiscreate'."\n" - .'* Auto'."\n" - .'* Average'."\n" - .'* Variance'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Fixed', - ], - 'ReferencedSamplesFilter' => [ - 'description' => 'The method that is used to query the referenced samples. To obtain some types of thresholds, you need to query reference samples and perform aggregate operations on the reference values. In this example, an expression is used to specify the query method of referenced samples.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{ "bizdate": [ "-1", "-7", "-1m" ] }'."\n", - ], - 'Thresholds' => [ - 'description' => 'The threshold settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Expected' => [ - 'description' => 'The expected threshold setting.'."\n", - 'type' => 'object', - 'properties' => [ - 'Operator' => [ - 'description' => 'The comparison operator. Valid values:'."\n" - ."\n" - .'* \\>'."\n" - .'* \\>='."\n" - .'* <'."\n" - .'* <='."\n" - .'* !='."\n" - .'* \\='."\n", - 'type' => 'string', - 'required' => false, - 'example' => '>', - ], - 'Value' => [ - 'description' => 'The threshold value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '100.0', - ], - 'Expression' => [ - 'description' => 'The threshold expression.'."\n" - ."\n" - .'If the template specified by the TemplateCode parameter is about fluctuation, you must use an expression to represent the threshold for fluctuation. Example:'."\n" - ."\n" - .'* $checkValue > 0.01'."\n" - .'* $checkValue < -0.01'."\n" - .'* abs($checkValue) > 0.01'."\n" - ."\n" - .'If the template specified by the TemplateCode parameter is about fixed value, you can also use an expression to represent the threshold. If you configure the Expression, Operator, and Value parameters for the threshold at the same time, the Expression parameter takes precedence over the Operator and Value parameters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '$checkValue <= 0.01', - ], - ], - 'required' => false, - ], - 'Warned' => [ - 'description' => 'The threshold settings for normal alerts.'."\n", - 'type' => 'object', - 'properties' => [ - 'Operator' => [ - 'description' => 'The comparison operator. Valid values:'."\n" - ."\n" - .'* \\>'."\n" - .'* \\>='."\n" - .'* <'."\n" - .'* <='."\n" - .'* !='."\n" - .'* \\='."\n", - 'type' => 'string', - 'required' => false, - 'example' => '>', - ], - 'Value' => [ - 'description' => 'The threshold value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '100.0', - ], - 'Expression' => [ - 'description' => 'The threshold expression.'."\n" - ."\n" - .'If the template specified by the TemplateCode parameter is about fluctuation, you must use an expression to represent the threshold for fluctuation. Example:'."\n" - ."\n" - .'* $checkValue > 0.01'."\n" - .'* $checkValue < -0.01'."\n" - .'* abs($checkValue) > 0.01'."\n" - ."\n" - .'If the template specified by the TemplateCode parameter is about fixed value, you can also use an expression to represent the threshold. If you configure the Expression, Operator, and Value parameters for the threshold at the same time, the Expression parameter takes precedence over the Operator and Value parameters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '$checkValue > 0.01'."\n", - ], - ], - 'required' => false, - ], - 'Critical' => [ - 'description' => 'The threshold settings for critical alerts.'."\n", - 'type' => 'object', - 'properties' => [ - 'Operator' => [ - 'description' => 'The comparison operator. Valid values:'."\n" - ."\n" - .'* \\>'."\n" - .'* \\>='."\n" - .'* <'."\n" - .'* <='."\n" - .'* !='."\n" - .'* \\='."\n", - 'type' => 'string', - 'required' => false, - 'example' => '>', - ], - 'Value' => [ - 'description' => 'The threshold value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '100.0', - ], - 'Expression' => [ - 'description' => 'The threshold expression.'."\n" - ."\n" - .'If the template specified by the TemplateCode parameter is about fluctuation, you must use an expression to represent the threshold for fluctuation. Example:'."\n" - ."\n" - .'* $checkValue > 0.01'."\n" - .'* $checkValue < -0.01'."\n" - .'* abs($checkValue) > 0.01'."\n" - ."\n" - .'If the template specified by the TemplateCode parameter is about fixed value, you can also use an expression to represent the threshold. If you configure the Expression, Operator, and Value parameters for the threshold at the same time, the Expression parameter takes precedence over the Operator and Value parameters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '$checkValue > 0.05', - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], - ], - 'required' => false, + ], + [ + 'apiName' => 'GetDatasetVersion', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetDatasetVersion', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ErrorHandlers', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The operations that you can perform after the rule-based check fails.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The operation that you can perform after the rule-based check fails.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the operation. Valid values:'."\n" - ."\n" - .'* SaveErrorData'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SaveErrorData', - ], - 'ErrorDataFilter' => [ - 'description' => 'The SQL statement that is used to filter failed tasks. If you define the rule by using custom SQL statements, you must specify an SQL statement to filter failed tasks.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SELECT * FROM tb_api_log WHERE id IS NULL'."\n", - ], - ], - 'required' => false, - ], - 'required' => false, + ], + [ + 'apiName' => 'GetPipelineRun', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - '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' => '691CA452-D37A-4ED0-9441'."\n", - ], - 'Id' => [ - 'description' => 'The ID of the rule.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '19715', - ], - ], + [ + 'apiName' => 'DeleteRoute', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dataworks:DeleteRoute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-4ED0-9441\\\\n\\",\\n \\"Id\\": 19715\\n}","type":"json"}]', - 'title' => 'CreateDataQualityRule', - ], - 'UpdateDataQualityRule' => [ - 'summary' => 'Updates a data quality monitoring rule.', - 'methods' => [ - 'post', + [ + 'apiName' => 'GetColumn', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetColumn', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'CreateRoute', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataworks:CreateRoute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ListDataSources', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:ListDataSources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'abilityTreeCode' => '247829', - 'abilityTreeNodes' => [ - 'FEATUREdide3WJOKE', + [ + 'apiName' => 'ListCertificates', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:ListCertificates', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'Id', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The rule ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '100001', + [ + 'apiName' => 'ListFunctions', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Name', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the rule. The name can be up to 255 characters in length and can contain digits, letters, and punctuation marks.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'The table cannot be empty.', - 'maxLength' => 255, + ], + [ + 'apiName' => 'ListDownstreamTaskInstances', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Enabled', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether to enable the rule.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - 'default' => 'true', + ], + [ + 'apiName' => 'UpdateRoute', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:UpdateRoute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Severity', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The strength of the rule. Valid values:'."\n" - ."\n" - .'* Normal'."\n" - .'* High'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'High', - 'enum' => [ - 'High', - 'Normal', - ], + ], + [ + 'apiName' => 'UpdateTask', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Description', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The description of the rule. The description can be up to 500 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'this is a odps _sql task'."\n", - 'maxLength' => 500, + ], + [ + 'apiName' => 'ListProjectMembers', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:ListProjectMembers', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '10000', + ], + [ + 'apiName' => 'ListDataQualityResults', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'TemplateCode', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the template used by the rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'system::user_defined'."\n", + ], + [ + 'apiName' => 'ListAgentSessions', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:ListAgentSessions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'SamplingConfig', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The sampling settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Metric' => [ - 'description' => 'The metrics used for sampling. You can leave this parameter empty if you use a rule template. Valid values:'."\n" - ."\n" - .'* Count: the number of rows in the table.'."\n" - .'* Min: the minimum value of the field.'."\n" - .'* Max: the maximum value of the field.'."\n" - .'* Avg: the average value of the field.'."\n" - .'* DistinctCount: the number of unique values of the field after deduplication.'."\n" - .'* DistinctPercent: the proportion of the number of unique values of the field after deduplication to the number of rows in the table.'."\n" - .'* DuplicatedCount: the number of duplicated values of the field.'."\n" - .'* DuplicatedPercent: the proportion of the number of duplicated values of the field to the number of rows in the table.'."\n" - .'* TableSize: the table size.'."\n" - .'* NullValueCount: the number of rows in which the field value is null.'."\n" - .'* NullValuePercent: the proportion of the number of rows in which the field value is null to the number of rows in the table.'."\n" - .'* GroupCount: the field value and the number of rows for each field value.'."\n" - .'* CountNotIn: the number of rows in which the field values are different from the referenced values that you specified in the rule.'."\n" - .'* CountDistinctNotIn: the number of unique values that are different from the referenced values that you specified in the rule after deduplication.'."\n" - .'* UserDefinedSql: indicates that data is sampled by executing custom SQL statements.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Min', - ], - 'MetricParameters' => [ - 'description' => 'The parameters required for sampling.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{ "Columns": [ "id", "name" ] , "SQL": "select count(1) from table;"}', - ], - 'SettingConfig' => [ - 'description' => 'The statements that are used to configure the parameters required for sampling before you execute the sampling statements. The statements can be up to 1,000 characters in length. Only the MaxCompute database is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SET odps.sql.udf.timeout=600s; '."\n" - .'SET odps.sql.python.version=cp27;', - 'maxLength' => 1000, - ], - 'SamplingFilter' => [ - 'description' => 'The statements that are used to filter unnecessary data during sampling. The statements can be up to 16,777,215 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'id IS NULL'."\n", - ], - ], - 'required' => false, + ], + [ + 'apiName' => 'ListCustomAttributes', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:ListCustomAttributes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'CheckingConfig', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The check settings for sample data.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The threshold calculation method. Valid values:'."\n" - ."\n" - .'* Fixed'."\n" - .'* Fluctation'."\n" - .'* FluctationDiscreate'."\n" - .'* Auto'."\n" - .'* Average'."\n" - .'* Variance'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Fixed', - ], - 'ReferencedSamplesFilter' => [ - 'description' => 'The method that is used to query the referenced samples. To obtain some types of thresholds, you need to query reference values. In this example, an expression is used to specify the query method of referenced samples.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{ "bizdate": [ "-1", "-7", "-1m" ] }'."\n", - ], - 'Thresholds' => [ - 'description' => 'The threshold settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Expected' => [ - 'description' => 'The expected threshold setting.'."\n", - 'type' => 'object', - 'properties' => [ - 'Operator' => [ - 'description' => 'The comparison operator. Valid values:'."\n" - ."\n" - .'* \\>'."\n" - .'* \\>='."\n" - .'* <'."\n" - .'* <='."\n" - .'* !='."\n" - .'* \\='."\n", - 'type' => 'string', - 'required' => false, - 'example' => '>', - ], - 'Value' => [ - 'description' => 'The threshold value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '100.0', - ], - 'Expression' => [ - 'description' => 'The threshold expression.'."\n" - ."\n" - .'The volatility type rule must use an expression to represent the volatility threshold. For example:'."\n" - ."\n" - .'- Fluctuation rise greater than 0.01: $checkValue > 0.01'."\n" - .'- Fluctuation drop greater than 0.01:$checkValue < -0.01'."\n" - .'- Absolute volatility: abs($checkValue) > 0.01'."\n" - ."\n" - .'You can also use expressions to configure thresholds for fixed-Value rules. If you configure them at the same time, the expression priority is higher than Operator and Value.', - 'type' => 'string', - 'required' => false, - 'example' => '$checkValue <= 0.01', - ], - ], - 'required' => false, - ], - 'Warned' => [ - 'description' => 'The threshold settings for normal alerts.'."\n", - 'type' => 'object', - 'properties' => [ - 'Operator' => [ - 'description' => 'The comparison operator. Valid values:'."\n" - ."\n" - .'* \\>'."\n" - .'* \\>='."\n" - .'* <'."\n" - .'* <='."\n" - .'* !='."\n" - .'* \\='."\n", - 'type' => 'string', - 'required' => false, - 'example' => '>', - ], - 'Value' => [ - 'description' => 'The threshold value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '100.0', - ], - 'Expression' => [ - 'description' => 'The threshold expression.'."\n" - ."\n" - .'The volatility type rule must use an expression to represent the volatility threshold. For example:'."\n" - ."\n" - .'- Fluctuation rise greater than 0.01: $checkValue > 0.01'."\n" - .'- Fluctuation drop greater than 0.01:$checkValue < -0.01'."\n" - .'- Absolute volatility: abs($checkValue) > 0.01'."\n" - ."\n" - .'You can also use expressions to configure thresholds for fixed-Value rules. If you configure them at the same time, the expression priority is higher than Operator and Value.', - 'type' => 'string', - 'required' => false, - 'example' => '$checkValue > 0.01', - ], - ], - 'required' => false, - ], - 'Critical' => [ - 'description' => 'The threshold settings for critical alerts.'."\n", - 'type' => 'object', - 'properties' => [ - 'Operator' => [ - 'description' => 'The comparison operator. Valid values:'."\n" - ."\n" - .'* \\>'."\n" - .'* \\>='."\n" - .'* <'."\n" - .'* <='."\n" - .'* !='."\n" - .'* \\='."\n", - 'type' => 'string', - 'required' => false, - 'example' => '>', - ], - 'Value' => [ - 'description' => 'The threshold value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '100.0', - ], - 'Expression' => [ - 'description' => 'The threshold expression.'."\n" - ."\n" - .'The volatility type rule must use an expression to represent the volatility threshold. For example:'."\n" - ."\n" - .'- Fluctuation rise greater than 0.01: $checkValue > 0.01'."\n" - .'- Fluctuation drop greater than 0.01:$checkValue < -0.01'."\n" - .'- Absolute volatility: abs($checkValue) > 0.01'."\n" - ."\n" - .'You can also use expressions to configure thresholds for fixed-Value rules. If you configure them at the same time, the expression priority is higher than Operator and Value.', - 'type' => 'string', - 'required' => false, - 'example' => '$checkValue > 0.05', - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], - ], - 'required' => false, + ], + [ + 'apiName' => 'CreateCustomAttribute', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataworks:CreateCustomAttribute', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ErrorHandlers', - 'in' => 'formData', - 'style' => 'json', - 'schema' => [ - 'description' => 'The operations that you can perform after the rule-based check fails.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The operation that you can perform after the rule-based check fails.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the operation. Valid values:'."\n" - ."\n" - .'* SaveErrorData'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SaveErrorData', - ], - 'ErrorDataFilter' => [ - 'description' => 'The SQL statement that is used to filter failed tasks. If the rule is defined by custom SQL statements, you must specify an SQL statement to filter failed tasks.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'SELECT * FROM tb_api_log WHERE id IS NULL'."\n", - ], - ], - 'required' => false, - ], - 'required' => false, + ], + [ + 'apiName' => 'PromptAgentSession', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'dataworks:PromptAgentSession', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - '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' => '691CA452-D37A-4ED0-9441'."\n", - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], + [ + 'apiName' => 'DeleteResource', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-4ED0-9441\\\\n\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'UpdateDataQualityRule', - ], - 'GetDataQualityRule' => [ - 'summary' => 'Queries the information about a data quality monitoring rule.', - 'methods' => [ - 'get', + [ + 'apiName' => 'ListDatasetVersions', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:ListDatasetVersions', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'CreateProjectMember', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataworks:CreateProjectMember', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'CreatePipelineRun', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'ListUpstreamTasks', + 'description' => '', 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '247799', - 'abilityTreeNodes' => [ - 'FEATUREdide3WJOKE', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => 'The rule ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '19715', + [ + 'apiName' => 'RenameNode', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - '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' => '691CA452-D37A-4ED0-9441'."\n", - ], - 'DataQualityRule' => [ - 'description' => 'The information about the rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The rule ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16033', - ], - 'Name' => [ - 'description' => 'The rule name.'."\n", - 'type' => 'string', - 'example' => 'The table cannot be empty.', - ], - 'ProjectId' => [ - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1948', - ], - 'Enabled' => [ - 'description' => 'Indicates whether the rule is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Severity' => [ - 'description' => 'Rule for the business level (corresponding to the strong and weak rules on the page), optional enumeration value:'."\n" - .'- Normal'."\n" - .'- High', - 'type' => 'string', - 'example' => 'High', - ], - 'Description' => [ - 'description' => 'The description of the rule. The description can be up to 500 characters in length.'."\n", - 'type' => 'string', - 'example' => 'this is a odps _sql task'."\n", - ], - 'Target' => [ - 'description' => 'The monitored object of the rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'Monitoring object type'."\n" - ."\n" - .'- Table', - 'type' => 'string', - 'example' => 'Table', - ], - 'DatabaseType' => [ - 'description' => 'The dataset of the table type. The database type to which the table belongs.'."\n" - .'- maxcompute'."\n" - .'- emr'."\n" - .'- cdh'."\n" - .'- hologres'."\n" - .'- analyticdb_for_postgresql'."\n" - .'- analyticdb_for_mysql'."\n" - .'- starrocks', - 'type' => 'string', - 'example' => 'maxcompute', - ], - 'TableGuid' => [ - 'description' => 'The ID of the table that is limited by the rule in Data Map.'."\n", - 'type' => 'string', - 'example' => 'odps.unit_test.tb_unit_test'."\n", - ], - 'PartitionSpec' => [ - 'description' => 'The configuration of the partitioned table.'."\n", - 'type' => 'string', - 'example' => 'ds=$[yyyymmdd-1]'."\n", - ], - ], - ], - 'TemplateCode' => [ - 'description' => 'The ID of the template used by the rule.'."\n", - 'type' => 'string', - 'example' => 'system::user_defined'."\n", - ], - 'SamplingConfig' => [ - 'description' => 'The sampling settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Metric' => [ - 'description' => 'The metrics used for sampling. Valid values:'."\n" - ."\n" - .'* Count: the number of rows in the table.'."\n" - .'* Min: the minimum value of the field.'."\n" - .'* Max: the maximum value of the field.'."\n" - .'* Avg: the average value of the field.'."\n" - .'* DistinctCount: the number of unique values of the field after deduplication.'."\n" - .'* DistinctPercent: the proportion of the number of unique values of the field after deduplication to the number of rows in the table.'."\n" - .'* DuplicatedCount: the number of duplicated values of the field.'."\n" - .'* DuplicatedPercent: the proportion of the number of duplicated values of the field to the number of rows in the table.'."\n" - .'* TableSize: the table size.'."\n" - .'* NullValueCount: the number of rows in which the field value is null.'."\n" - .'* NullValuePercent: the proportion of the number of rows in which the field value is null to the number of rows in the table.'."\n" - .'* GroupCount: the field value and the number of rows for each field value.'."\n" - .'* CountNotIn: the number of rows in which the field values are different from the referenced values that you specified in the rule.'."\n" - .'* CountDistinctNotIn: the number of unique values that are different from the referenced values that you specified in the rule after deduplication.'."\n" - .'* UserDefinedSql: indicates that data is sampled by executing custom SQL statements.'."\n", - 'type' => 'string', - 'example' => 'Max', - ], - 'MetricParameters' => [ - 'description' => 'The parameters required for sampling.'."\n", - 'type' => 'string', - 'example' => '{ "Columns": [ "id", "name" ] , "SQL": "select count(1) from table;"}', - ], - 'SettingConfig' => [ - 'description' => 'The statements that are used to configure the parameters required for sampling before you execute the sampling statements. The statements can be up to 1,000 characters in length. Only the MaxCompute database is supported.'."\n", - 'type' => 'string', - 'example' => 'SET odps.sql.udf.timeout=600s; '."\n" - .'SET odps.sql.python.version=cp27;'."\n", - ], - 'SamplingFilter' => [ - 'description' => 'The statements that are used to filter unnecessary data during sampling. The statements can be up to 16,777,215 characters in length.'."\n", - 'type' => 'string', - 'example' => 'id IS NULL'."\n", - ], - ], - ], - 'CheckingConfig' => [ - 'description' => 'The check settings for sample data.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The threshold calculation method. Valid values:'."\n" - ."\n" - .'* Fixed'."\n" - .'* Fluctation'."\n" - .'* FluctationDiscreate'."\n" - .'* Auto'."\n" - .'* Average'."\n" - .'* Variance'."\n", - 'type' => 'string', - 'example' => 'Fixed', - ], - 'ReferencedSamplesFilter' => [ - 'description' => 'The method that is used to query the referenced samples. To obtain some types of thresholds, you need to query reference values. In this example, an expression is used to indicate the query method of referenced samples.'."\n", - 'type' => 'string', - 'example' => '{ "bizdate": [ "-1", "-7", "-1m" ] }'."\n", - ], - 'Thresholds' => [ - 'description' => 'The threshold settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Expected' => [ - 'description' => 'The expected threshold setting.'."\n", - 'type' => 'object', - 'properties' => [ - 'Operator' => [ - 'description' => 'The comparison operator. Valid values:'."\n" - ."\n" - .'* \\>'."\n" - .'* \\>='."\n" - .'* <'."\n" - .'* <='."\n" - .'* !='."\n" - .'* \\='."\n", - 'type' => 'string', - 'example' => '>', - ], - 'Value' => [ - 'description' => 'The threshold value.'."\n", - 'type' => 'string', - 'example' => '100.0', - ], - 'Expression' => [ - 'description' => 'The threshold expression.'."\n", - 'type' => 'string', - 'example' => '$checkValue <= 0.01', - ], - ], - ], - 'Warned' => [ - 'description' => 'The threshold settings for normal alerts.'."\n", - 'type' => 'object', - 'properties' => [ - 'Operator' => [ - 'description' => 'The comparison operator. Valid values:'."\n" - ."\n" - .'* \\>'."\n" - .'* \\>='."\n" - .'* <'."\n" - .'* <='."\n" - .'* !='."\n" - .'* \\='."\n", - 'type' => 'string', - 'example' => '>', - ], - 'Value' => [ - 'description' => 'The threshold value.'."\n", - 'type' => 'string', - 'example' => '100.0', - ], - 'Expression' => [ - 'description' => 'The threshold expression.'."\n", - 'type' => 'string', - 'example' => '$checkValue > 0.01', - ], - ], - ], - 'Critical' => [ - 'description' => 'The threshold settings for critical alerts.'."\n", - 'type' => 'object', - 'properties' => [ - 'Operator' => [ - 'description' => 'The comparison operator. Valid values:'."\n" - ."\n" - .'* \\>'."\n" - .'* \\>='."\n" - .'* <'."\n" - .'* <='."\n" - .'* !='."\n" - .'* \\='."\n", - 'type' => 'string', - 'example' => '>', - ], - 'Value' => [ - 'description' => 'The threshold value.'."\n", - 'type' => 'string', - 'example' => '100.0', - ], - 'Expression' => [ - 'description' => 'The threshold expression.'."\n", - 'type' => 'string', - 'example' => '$checkValue > 0.05', - ], - ], - ], - ], - ], - ], - ], - 'ErrorHandlers' => [ - 'description' => 'The operations that you can perform after the rule-based check fails.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The operation that you can perform after the rule-based check fails.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'Processor type:'."\n" - .'- SaveErrorData', - 'type' => 'string', - 'example' => 'SaveErrorData'."\n", - ], - 'ErrorDataFilter' => [ - 'description' => 'The SQL statement that is used to filter failed tasks. If you define the rule by using custom SQL statements, you must specify an SQL statement to filter failed tasks.'."\n", - 'type' => 'string', - 'example' => 'SELECT * FROM tb_api_log WHERE id IS NULL'."\n", - ], - ], - ], - ], - ], - ], - ], + [ + 'apiName' => 'StopWorkflowInstances', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-4ED0-****\\",\\n \\"DataQualityRule\\": {\\n \\"Id\\": 16033,\\n \\"Name\\": \\"The table cannot be empty.\\\\n\\",\\n \\"ProjectId\\": 1948,\\n \\"Enabled\\": true,\\n \\"Severity\\": \\"High\\",\\n \\"Description\\": \\"this is a odps _sql task\\\\n\\",\\n \\"Target\\": {\\n \\"Type\\": \\"Table\\",\\n \\"DatabaseType\\": \\"maxcompute\\",\\n \\"TableGuid\\": \\"odps.unit_test.tb_unit_test\\\\n\\",\\n \\"PartitionSpec\\": \\"ds=$[yyyymmdd-1]\\\\n\\"\\n },\\n \\"TemplateCode\\": \\"SYSTEM:table:table_count:fixed\\",\\n \\"SamplingConfig\\": {\\n \\"Metric\\": \\"Max\\",\\n \\"MetricParameters\\": \\"{ \\\\\\"Columns\\\\\\": [ \\\\\\"id\\\\\\", \\\\\\"name\\\\\\" ] , \\\\\\"SQL\\\\\\": \\\\\\"select count(1) from table;\\\\\\"}\\",\\n \\"SettingConfig\\": \\"SET odps.sql.udf.timeout=600s; \\\\nSET odps.sql.python.version=cp27;\\\\n\\",\\n \\"SamplingFilter\\": \\"id IS NULL\\\\n\\"\\n },\\n \\"CheckingConfig\\": {\\n \\"Type\\": \\"Fixed\\",\\n \\"ReferencedSamplesFilter\\": \\"{ \\\\\\"bizdate\\\\\\": [ \\\\\\"-1\\\\\\", \\\\\\"-7\\\\\\", \\\\\\"-1m\\\\\\" ] }\\\\n\\",\\n \\"Thresholds\\": {\\n \\"Expected\\": {\\n \\"Operator\\": \\">\\",\\n \\"Value\\": \\"100.0\\",\\n \\"Expression\\": \\"$checkValue <= 0.01\\"\\n },\\n \\"Warned\\": {\\n \\"Operator\\": \\">\\",\\n \\"Value\\": \\"100.0\\",\\n \\"Expression\\": \\"$checkValue > 0.01\\"\\n },\\n \\"Critical\\": {\\n \\"Operator\\": \\">\\",\\n \\"Value\\": \\"100.0\\",\\n \\"Expression\\": \\"$checkValue > 0.05\\"\\n }\\n }\\n },\\n \\"ErrorHandlers\\": [\\n {\\n \\"Type\\": \\"SaveErrorData\\\\n\\",\\n \\"ErrorDataFilter\\": \\"SELECT * FROM tb_api_log WHERE id IS NULL\\\\n\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'GetDataQualityRule', - 'description' => 'This API operation is available for all DataWorks editions.'."\n", - ], - 'ListDataQualityRuleTemplates' => [ - 'summary' => 'Queries a list of data quality monitoring rule templates.', - 'methods' => [ - 'get', + [ + 'apiName' => 'ListLineageRelationships', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:ListLineageRelationships', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListDataQualityEvaluationTasks', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'CreateWorkflowInstances', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataworks:CreateWorkflowInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ListUpstreamTaskInstances', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'ListDataSourceSharedRules', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:ListDataSourceSharedRules', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'ListRoutes', + 'description' => '', 'operationType' => 'list', - 'abilityTreeCode' => '259074', - 'abilityTreeNodes' => [ - 'FEATUREdideRGVRPF', + 'ramAction' => [ + 'action' => 'dataworks:ListRoutes', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'ProjectId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The DataWorks workspace ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '10000', + [ + 'apiName' => 'DeleteCertificate', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:DeleteCertificate', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'CreationSource', - 'in' => 'query', - 'schema' => [ - 'description' => 'The source of the template. This parameter is required. Valid values:'."\n" - ."\n" - .'* System'."\n" - .'* UserDefined'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'System'."\n", + ], + [ + 'apiName' => 'DeleteComponent', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'dataworks:DeleteComponent', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'DirectoryPath', - 'in' => 'query', - 'schema' => [ - 'description' => 'The directory in which the template is stored. Slashes (/) are used to separate directory levels. The name of each directory level can be up to 1,024 characters in length. It cannot contain whitespace characters or slashes (/).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '/ods/order_data'."\n", + ], + [ + 'apiName' => 'TestDataSourceConnectivity', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:TestDataSourceConnectivity', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the template. If you want to query a system template, set this parameter to the name of the system template. Fuzzy match is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Table rows', + ], + [ + 'apiName' => 'CreateIdentifyCredential', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'dataworks:CreateIdentifyCredential', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'minimum' => '1', - 'example' => '10', - 'default' => '1', + ], + [ + 'apiName' => 'ListAgents', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:ListAgents', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'maximum' => '200', - 'minimum' => '1', - 'example' => '1', - 'default' => '10', + ], + [ + 'apiName' => 'UpdateWorkflowDefinition', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - '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' => '691CA452-D37A-4ED0-9441', - ], - 'PagingInfo' => [ - 'description' => 'The pagination information.'."\n", - 'type' => 'object', - 'properties' => [ - 'TotalCount' => [ - 'description' => 'Total number of entries', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '42', - ], - 'PageSize' => [ - 'description' => 'Page size', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'PageNumber' => [ - 'description' => 'Page number', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'DataQualityRuleTemplates' => [ - 'description' => 'The templates.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the template.'."\n", - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'Rule template Code', - 'type' => 'string', - 'example' => 'USER_DEFINED:123', - ], - 'Name' => [ - 'description' => 'The name of the template. The name can be up to 512 characters in length and can contain digits, letters, and punctuation marks.'."\n", - 'type' => 'string', - 'example' => 'Table row Count Verification', - ], - 'ProjectId' => [ - 'description' => 'DataWorks workspace ID', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2043', - ], - 'SamplingConfig' => [ - 'description' => 'Settings required for sample collection', - 'type' => 'object', - 'properties' => [ - 'Metric' => [ - 'description' => 'The name of the sampled metric.'."\n" - .'- Count: number of table rows'."\n" - .'- Min: minimum value of the field'."\n" - .'- Max: The maximum value of the field.'."\n" - .'- Avg: field mean'."\n" - .'- DistinctCount: number of unique field values'."\n" - .'- DistinctPercent: the ratio of the number of unique field values to the number of data rows.'."\n" - .'- DuplicatedCount: number of duplicate field values'."\n" - .'- DuplicatedPercent: the ratio of the number of duplicate field values to the number of data rows.'."\n" - .'- TableSize: table size'."\n" - .'- NullValueCount: number of rows with empty fields'."\n" - .'- NullValuePercent: the proportion of fields that are empty.'."\n" - .'- GroupCount: aggregate each value by field value and the corresponding number of data rows'."\n" - .'- CountNotIn: the enumerated value does not match the number of rows.'."\n" - .'- CountDistinctNotIn: the number of unique values that the enumerated values do not match.'."\n" - .'- UserDefinedSql: use custom SQL to collect samples', - 'type' => 'string', - 'example' => 'Max', - ], - 'MetricParameters' => [ - 'description' => 'Parameters required for sample collection', - 'type' => 'string', - 'example' => '{"Sql": "select count(1) from table;"}'."\n", - ], - 'SettingConfig' => [ - 'description' => 'Before executing the sample statement, insert some runtime parameter setting statements, which can be up to 1000 characters in length. Currently, only MaxCompute are supported.', - 'type' => 'string', - 'example' => 'SET odps.sql.udf.timeout=600s; '."\n" - .'SET odps.sql.python.version=cp27;'."\n", - ], - ], - ], - 'CheckingConfig' => [ - 'description' => 'Sample verification settings', - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'Threshold Calculation method'."\n" - .'- Fixed'."\n" - .'- Fluctation'."\n" - .'- FluctationDiscreate'."\n" - .'- Auto'."\n" - .'- Average'."\n" - .'- Variance', - 'type' => 'string', - 'example' => 'Fixed', - ], - 'ReferencedSamplesFilter' => [ - 'description' => 'Some types of thresholds need to query some reference samples, and then summarize the values of the reference samples to obtain the threshold for comparison. Here, an expression is used to represent the query method of the reference samples.', - 'type' => 'string', - 'example' => '{ "bizdate": [ "-1", "-7", "-1m" ] }'."\n", - ], - ], - ], - 'VisibleScope' => [ - 'description' => 'Available range of templates:'."\n" - .'- Tenant: all tenants are available'."\n" - .'- Project: only available in the current Project', - 'type' => 'string', - 'example' => 'Project', - ], - 'DirectoryPath' => [ - 'description' => 'The directory in which the template is stored. Slashes (/) are used to separate directory levels. The name of each directory level can be up to 1,024 characters in length. It cannot contain whitespace characters or slashes (/).'."\n", - 'type' => 'string', - 'example' => '/ods/order_data', - ], - ], - ], - ], - ], - ], - ], + [ + 'apiName' => 'GetDataset', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetDataset', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'ListResources', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'dataworks:*', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"691CA452-D37A-****\\",\\n \\"PagingInfo\\": {\\n \\"TotalCount\\": 42,\\n \\"PageSize\\": 10,\\n \\"PageNumber\\": 1,\\n \\"DataQualityRuleTemplates\\": [\\n {\\n \\"Code\\": \\"USER_DEFINED:123\\",\\n \\"Name\\": \\"Table row Count Verification\\\\n\\",\\n \\"ProjectId\\": 2043,\\n \\"SamplingConfig\\": {\\n \\"Metric\\": \\"Max\\",\\n \\"MetricParameters\\": \\"{\\\\\\"Sql\\\\\\": \\\\\\"select count(1) from table;\\\\\\"}\\\\n\\",\\n \\"SettingConfig\\": \\"SET odps.sql.udf.timeout=600s; \\\\nSET odps.sql.python.version=cp27;\\\\n\\"\\n },\\n \\"CheckingConfig\\": {\\n \\"Type\\": \\"Fixed\\",\\n \\"ReferencedSamplesFilter\\": \\"{ \\\\\\"bizdate\\\\\\": [ \\\\\\"-1\\\\\\", \\\\\\"-7\\\\\\", \\\\\\"-1m\\\\\\" ] }\\\\n\\"\\n },\\n \\"VisibleScope\\": \\"Project\\",\\n \\"DirectoryPath\\": \\"/ods/order_data\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListDataQualityRuleTemplates', - ], - ], - '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' => 'GetTable', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'dataworks:GetTable', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'DataWorks', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'resourceTypes' => [ + ['validationType' => 'always', 'resourceType' => 'TaskInstance', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:taskinstance/*'], + ['validationType' => 'always', 'resourceType' => 'Network', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:network/*'], + ['validationType' => 'always', 'resourceType' => 'Node', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:*'], + ['validationType' => 'always', 'resourceType' => 'DwResourceGroup', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:dwresourcegroup/*'], + ['validationType' => 'always', 'resourceType' => 'Task', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:task/*'], + ['validationType' => 'always', 'resourceType' => 'DwResourceGroup', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:dwresourcegroup/{#DwResourceGroupId}'], + ['validationType' => 'always', 'resourceType' => 'ResourceFile', 'arn' => ':dataworks:{#regionId}::resourcefile/*'], + ['validationType' => 'always', 'resourceType' => 'WorkflowInstance', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:workflowinstance/*'], + ['validationType' => 'conditional', 'resourceType' => 'FileVersion', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:fileversion/*'], + ['validationType' => 'conditional', 'resourceType' => 'Folder', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:folder/*'], + ['validationType' => 'always', 'resourceType' => 'DwImage', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:dwimage/{#id}'], + ['validationType' => 'always', 'resourceType' => 'Workflow', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:workflow/*'], + ['validationType' => 'always', 'resourceType' => 'DwImage', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:dwimage/*'], + ['validationType' => 'conditional', 'resourceType' => 'File', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:file/*'], + ['validationType' => 'always', 'resourceType' => 'Route', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:route/*'], + ['validationType' => 'conditional', 'resourceType' => 'Business', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:business/*'], + ['validationType' => 'conditional', 'resourceType' => 'UdfFile', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:udffile/*'], + ['validationType' => 'conditional', 'resourceType' => 'Deployment', 'arn' => 'acs:dataworks:{#regionId}:{#accountId}:deployment/*'], ], ], ]; -- cgit v1.2.3