From 7347bac4ab7e136157fc94777e6cf87ef9e08599 Mon Sep 17 00:00:00 2001 From: Zhineng Li Date: Fri, 13 Feb 2026 10:54:11 +0800 Subject: first commit --- .../en_us/dataworks-public/2024-05-18/api-docs.php | 59006 +++++++++++++++++++ 1 file changed, 59006 insertions(+) create mode 100644 data/en_us/dataworks-public/2024-05-18/api-docs.php (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 new file mode 100644 index 0000000..0feb02d --- /dev/null +++ b/data/en_us/dataworks-public/2024-05-18/api-docs.php @@ -0,0 +1,59006 @@ + '1.0', + 'info' => [ + 'style' => 'RPC', + 'product' => 'dataworks-public', + 'version' => '2024-05-18', + ], + 'directories' => [ + [ + 'id' => 203861, + 'title' => 'Authentication File Management', + 'type' => 'directory', + 'children' => [ + 'ImportCertificate', + 'GetCertificate', + 'ListCertificates', + 'DeleteCertificate', + ], + ], + [ + 'id' => 198217, + 'title' => 'Space Management', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 198218, + 'title' => 'Workspace', + 'type' => 'directory', + 'children' => [ + 'CreateProject', + 'UpdateProject', + 'DeleteProject', + 'GetProject', + 'ListProjects', + ], + ], + [ + 'id' => 198566, + 'title' => 'Workspace Role', + 'type' => 'directory', + 'children' => [ + 'GetProjectRole', + 'ListProjectRoles', + ], + ], + [ + 'id' => 198571, + 'title' => 'Workspace Member', + 'type' => 'directory', + 'children' => [ + 'CreateProjectMember', + 'DeleteProjectMember', + 'GrantMemberProjectRoles', + 'RevokeMemberProjectRoles', + 'GetProjectMember', + 'ListProjectMembers', + ], + ], + ], + ], + [ + 'id' => 198149, + 'title' => 'Data Source', + 'type' => 'directory', + 'children' => [ + 'TestDataSourceConnectivity', + 'CreateDataSource', + 'DeleteDataSource', + 'UpdateDataSource', + 'CloneDataSource', + 'GetDataSource', + 'ListDataSources', + [ + 'id' => 198204, + 'title' => 'Data Source Sharing Rules', + 'type' => 'directory', + 'children' => [ + 'CreateDataSourceSharedRule', + 'DeleteDataSourceSharedRule', + 'ListDataSourceSharedRules', + ], + ], + ], + ], + [ + 'id' => 321265, + 'title' => 'Computing Resource', + 'type' => 'directory', + 'children' => [ + 'DeleteComputeResource', + 'DeleteComputeResource', + 'GetComputeResource', + 'UpdateComputeResource', + 'ListComputeResources', + 'CreateComputeResource', + ], + ], + [ + 'id' => 198537, + 'title' => 'Resource Group Management', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 198549, + 'title' => 'Resource Group', + 'type' => 'directory', + 'children' => [ + 'CreateResourceGroup', + 'DeleteResourceGroup', + 'UpdateResourceGroup', + 'GetResourceGroup', + 'ListResourceGroups', + 'DissociateProjectFromResourceGroup', + 'AssociateProjectToResourceGroup', + 'ListResourceGroupAssociateProjects', + 'ListResourceGroupMetricData', + ], + ], + [ + 'id' => 198538, + 'title' => 'Routing', + 'type' => 'directory', + 'children' => [ + 'CreateRoute', + 'DeleteRoute', + 'UpdateRoute', + 'GetRoute', + 'ListRoutes', + ], + ], + [ + 'id' => 198544, + 'title' => 'Network', + 'type' => 'directory', + 'children' => [ + 'CreateNetwork', + 'DeleteNetwork', + 'GetNetwork', + 'ListNetworks', + ], + ], + ], + ], + [ + 'id' => 197271, + 'title' => 'Data Development', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 268819, + 'title' => 'Component', + 'type' => 'directory', + 'children' => [ + 'CreateComponent', + 'DeleteComponent', + 'GetComponent', + 'UpdateComponent', + 'ListComponents', + ], + ], + [ + 'id' => 197703, + 'title' => 'Node', + 'type' => 'directory', + 'children' => [ + 'CreateNode', + 'DeleteNode', + 'UpdateNode', + 'MoveNode', + 'RenameNode', + 'GetNode', + 'ListNodes', + 'ListNodeDependencies', + ], + ], + [ + 'id' => 197702, + 'title' => 'Workflow Definition', + 'type' => 'directory', + 'children' => [ + 'CreateWorkflowDefinition', + 'ImportWorkflowDefinition', + 'DeleteWorkflowDefinition', + 'UpdateWorkflowDefinition', + 'MoveWorkflowDefinition', + 'RenameWorkflowDefinition', + 'GetWorkflowDefinition', + 'ListWorkflowDefinitions', + ], + ], + [ + 'id' => 197700, + 'title' => 'Resource', + 'type' => 'directory', + 'children' => [ + 'CreateResource', + 'DeleteResource', + 'DeleteResource', + 'UpdateResource', + 'MoveResource', + 'RenameResource', + 'GetResource', + 'ListResources', + ], + ], + [ + 'id' => 197701, + 'title' => 'Function', + 'type' => 'directory', + 'children' => [ + 'CreateFunction', + 'DeleteFunction', + 'UpdateFunction', + 'UpdateFunction', + 'MoveFunction', + 'RenameFunction', + 'GetFunction', + 'ListFunctions', + ], + ], + [ + 'id' => 197704, + 'title' => 'Deployment', + 'type' => 'directory', + 'children' => [ + 'CreatePipelineRun', + 'AbolishPipelineRun', + 'ExecPipelineRunStage', + 'GetPipelineRun', + 'ListPipelineRuns', + 'ListPipelineRunItems', + ], + ], + ], + ], + [ + 'id' => 208290, + 'title' => 'Data Development (Old)', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 208291, + 'title' => 'File', + 'type' => 'directory', + 'children' => [ + 'CreateFile', + 'CreateResourceFile', + 'CreateUdfFile', + 'DeleteFile', + 'UpdateFile', + 'UpdateUdfFile', + 'GetFile', + 'ListFiles', + 'SubmitFile', + 'DeployFile', + ], + ], + [ + 'id' => 208302, + 'title' => 'Folder', + 'type' => 'directory', + 'children' => [ + 'CreateFolder', + 'DeleteFolder', + 'UpdateFolder', + 'GetFolder', + 'ListFolders', + ], + ], + [ + 'id' => 208308, + 'title' => 'Business', + 'type' => 'directory', + 'children' => [ + 'CreateBusiness', + 'DeleteBusiness', + 'UpdateBusiness', + 'GetBusiness', + 'ListBusiness', + ], + ], + [ + 'id' => 208314, + 'title' => 'Deployment Package', + 'type' => 'directory', + 'children' => [ + 'GetDeploymentPackage', + 'ListDeploymentPackages', + 'ListDeploymentPackageFiles', + ], + ], + [ + 'id' => 208318, + 'title' => 'File Version', + 'type' => 'directory', + 'children' => [ + 'GetFileVersion', + 'ListFileVersions', + ], + ], + [ + 'id' => 208321, + 'title' => 'IDE Event', + 'type' => 'directory', + 'children' => [ + 'UpdateIDEEventResult', + 'GetIDEEventDetail', + ], + ], + [ + 'id' => 208324, + 'title' => 'Table', + 'type' => 'directory', + 'children' => [ + 'EstablishRelationTableToBusiness', + ], + ], + ], + ], + [ + 'id' => 198342, + 'title' => 'Data Integration', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 198343, + 'title' => 'Synchronization Task', + 'type' => 'directory', + 'children' => [ + 'CreateDIJob', + 'UpdateDIJob', + 'DeleteDIJob', + 'StopDIJob', + 'StartDIJob', + 'GetDIJob', + 'GetDIJobLog', + 'ListDIJobs', + 'ListDIJobRunDetails', + 'ListDIJobMetrics', + 'ListDIJobEvents', + ], + ], + [ + 'id' => 198354, + 'title' => 'Task Alert', + 'type' => 'directory', + 'children' => [ + 'CreateDIAlarmRule', + 'UpdateDIAlarmRule', + 'DeleteDIAlarmRule', + 'ListDIAlarmRules', + ], + ], + ], + ], + [ + 'id' => 204415, + 'title' => 'Data Map', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 204416, + 'title' => 'Metadata Collector Type', + 'type' => 'directory', + 'children' => [ + 'ListCrawlerTypes', + ], + ], + [ + 'id' => 204418, + 'title' => 'Metadata Entity', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 204419, + 'title' => 'Catalog', + 'type' => 'directory', + 'children' => [ + 'ListCatalogs', + 'GetCatalog', + ], + ], + [ + 'id' => 204422, + 'title' => 'Data Base', + 'type' => 'directory', + 'children' => [ + 'ListDatabases', + 'GetDatabase', + ], + ], + [ + 'id' => 204425, + 'title' => 'Schema', + 'type' => 'directory', + 'children' => [ + 'ListSchemas', + 'GetSchema', + ], + ], + [ + 'id' => 204428, + 'title' => 'Table', + 'type' => 'directory', + 'children' => [ + 'ListTables', + 'GetTable', + 'UpdateTableBusinessMetadata', + ], + ], + [ + 'id' => 204432, + 'title' => 'Column', + 'type' => 'directory', + 'children' => [ + 'ListColumns', + 'GetColumn', + 'UpdateColumnBusinessMetadata', + ], + ], + [ + 'id' => 344258, + 'title' => 'Dataset', + 'type' => 'directory', + 'children' => [ + 'ListDatasets', + 'GetDataset', + 'CreateDataset', + 'UpdateDataset', + 'DeleteDataset', + ], + ], + [ + 'id' => 347399, + 'title' => 'Dataset Version', + 'type' => 'directory', + 'children' => [ + 'ListDatasetVersions', + 'GetDatasetVersion', + 'CreateDatasetVersion', + 'UpdateDatasetVersion', + 'DeleteDatasetVersion', + 'PreviewDatasetVersion', + ], + ], + ], + ], + [ + 'id' => 204436, + 'title' => 'Partition', + 'type' => 'directory', + 'children' => [ + 'ListPartitions', + 'GetPartition', + ], + ], + [ + 'id' => 204439, + 'title' => 'Lineage Relationship', + 'type' => 'directory', + 'children' => [ + 'ListLineageRelationships', + 'GetLineageRelationship', + 'DeleteLineageRelationship', + 'CreateLineageRelationship', + 'ListLineages', + ], + ], + [ + 'id' => 204445, + 'title' => 'Meta Collection', + 'type' => 'directory', + 'children' => [ + 'ListMetaCollections', + 'CreateMetaCollection', + 'GetMetaCollection', + 'UpdateMetaCollection', + 'DeleteMetaCollection', + 'ListEntitiesInMetaCollection', + 'AddEntityIntoMetaCollection', + 'RemoveEntityFromMetaCollection', + ], + ], + ], + ], + [ + 'id' => 198752, + 'title' => 'Operation Center', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 199222, + 'title' => 'Monitoring Alarm', + 'type' => 'directory', + 'children' => [ + 'ListAlertRules', + 'GetAlertRule', + 'UpdateAlertRule', + 'DeleteAlertRule', + 'CreateAlertRule', + ], + ], + [ + 'id' => 198753, + 'title' => 'Task', + 'type' => 'directory', + 'children' => [ + 'DeleteTask', + 'UpdateTask', + 'BatchUpdateTasks', + 'GetTask', + 'ListTasks', + 'ListUpstreamTasks', + 'ListDownstreamTasks', + 'ListTaskOperationLogs', + ], + ], + [ + 'id' => 198759, + 'title' => 'Task Instances', + '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', + 'type' => 'directory', + 'children' => [ + 'GetRerunWorkflowInstancesResult', + 'RerunWorkflowInstances', + 'CreateWorkflowInstances', + 'GetCreateWorkflowInstancesResult', + 'GetWorkflowInstance', + 'ListWorkflowInstances', + 'StartWorkflowInstances', + 'StopWorkflowInstances', + 'ExecuteAdhocWorkflowInstance', + ], + ], + ], + ], + [ + 'id' => 198728, + 'title' => 'Data Quality', + 'type' => 'directory', + 'children' => [ + [ + 'id' => 199702, + 'title' => 'Data Quality Template', + 'type' => 'directory', + 'children' => [ + 'CreateDataQualityTemplate', + 'UpdateDataQualityTemplate', + 'ListDataQualityTemplates', + 'GetDataQualityTemplate', + 'DeleteDataQualityTemplate', + ], + ], + [ + 'id' => 199687, + 'title' => 'Data Quality Scan', + 'type' => 'directory', + 'children' => [ + 'CreateDataQualityScan', + 'UpdateDataQualityScan', + 'ListDataQualityScans', + 'GetDataQualityScan', + 'DeleteDataQualityScan', + ], + ], + [ + 'id' => 199694, + 'title' => 'Data Quality Alert Rules', + 'type' => 'directory', + 'children' => [ + 'CreateDataQualityAlertRule', + 'UpdateDataQualityAlertRule', + 'ListDataQualityAlertRules', + 'GetDataQualityAlertRule', + 'DeleteDataQualityAlertRule', + ], + ], + [ + 'id' => 199699, + 'title' => 'Data Quality ScanRun', + 'type' => 'directory', + 'children' => [ + 'CreateDataQualityScanRun', + 'ListDataQualityScanRuns', + 'GetDataQualityScanRunLog', + 'GetDataQualityScanRun', + ], + ], + ], + ], + [ + 'id' => 339900, + 'title' => 'Security Center', + 'type' => 'directory', + 'children' => [ + 'CreateIdentifyCredential', + ], + ], + [ + 'id' => 201385, + 'title' => 'Tags Management', + 'type' => 'directory', + 'children' => [ + 'CreateDataAssetTag', + 'DeleteDataAssetTag', + 'UpdateDataAssetTag', + 'ListDataAssetTags', + 'TagDataAssets', + 'UnTagDataAssets', + 'ListDataAssets', + ], + ], + [ + 'id' => 198491, + 'title' => 'Open Platform', + 'type' => 'directory', + 'children' => [ + 'GetJobStatus', + ], + ], + [ + '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', + ], + ], + ], + 'components' => [ + 'schemas' => [ + 'Catalog' => [ + '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', + ], + ], + ], + 'Column' => [ + 'title' => '', + 'description' => 'The field.'."\n", + 'visibility' => 'Public', + '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', + ], + 'BusinessMetadata' => [ + 'title' => '', + 'description' => 'Business metadata.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'title' => '', + 'description' => 'A business-level description of the field (supported only by MaxCompute, HMS (EMR clusters) and DLF.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '', + 'backendName' => 'description', + ], + ], + 'backendName' => 'businessMetadata', + ], + ], + ], + 'CrawlerType' => [ + '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', + ], + 'SupportedEntityTypes' => [ + 'title' => '', + 'description' => 'The supported entity types. The entity types are sorted based on the declaration order.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + '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', + ], + ], + 'extendType' => 'true', + 'description' => '', + ], + 'backendName' => 'supportedEntityTypes', + ], + ], + ], + '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' => '', + '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' => '', + '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' => [ + 'title' => 'A short description of struct', + 'description' => 'The data quality monitoring task.'."\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', + ], + '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', + ], + 'Target' => [ + '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', + ], + ], + 'backendName' => 'target', + ], + 'Trigger' => [ + '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', + ], + 'TaskIds' => [ + 'title' => '', + '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', + ], + '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', + ], + '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", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + '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', + ], + ], + 'extendType' => 'true', + 'description' => '', + ], + 'backendName' => 'hooks', + ], + 'Notifications' => [ + 'title' => '', + 'description' => 'The configurations for alert notifications.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + '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', + ], + 'Notifications' => [ + 'title' => '', + 'description' => 'The configurations for alert notifications.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The alert notification methods.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'NotificationChannels' => [ + 'title' => '', + 'description' => 'The alert notification methods.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Channels' => [ + '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', + ], + 'example' => 'Mail', + 'backendName' => 'channels', + ], + ], + 'extendType' => 'true', + 'description' => '', + ], + 'backendName' => 'notificationChannels', + ], + 'NotificationReceivers' => [ + 'title' => '', + 'description' => 'The alert recipients.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'ReceiverType' => [ + 'title' => '', + 'description' => 'The type of the alert recipient.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'AliUid', + 'backendName' => 'receiverType', + ], + 'ReceiverValues' => [ + 'title' => '', + 'description' => 'The alert recipients.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + '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', + ], + ], + 'extendType' => 'true', + 'description' => '', + ], + 'backendName' => 'notificationReceivers', + ], + ], + 'extendType' => 'true', + ], + 'backendName' => 'notifications', + ], + ], + 'extendType' => 'true', + 'description' => '', + ], + 'backendName' => 'notifications', + ], + ], + ], + 'DataQualityEvaluationTaskInstance' => [ + 'title' => 'A short description of struct', + 'description' => 'The instance generated by a data quality monitoring task.'."\n", + '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', + ], + 'Task' => [ + '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', + ], + 'Target' => [ + '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', + ], + ], + 'backendName' => 'target', + ], + 'Trigger' => [ + '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', + ], + 'TaskIds' => [ + 'title' => '', + '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', + ], + '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', + ], + '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", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The callback configuration.'."\n", + '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', + ], + ], + 'extendType' => 'true', + ], + 'backendName' => 'hooks', + ], + 'Notifications' => [ + 'title' => '', + 'description' => 'The subscription configurations for alert notifications.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The subscription configuration for the alert notification.'."\n", + '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', + ], + 'Notifications' => [ + 'title' => '', + 'description' => 'The configurations for the alert notification.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'NotificationChannels' => [ + 'title' => '', + 'description' => 'The alert notification methods.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Channels' => [ + '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', + ], + 'example' => 'Mail', + 'backendName' => 'channels', + ], + ], + 'example' => 'Dingding', + 'extendType' => 'true', + 'description' => '', + ], + 'backendName' => 'notificationChannels', + ], + 'NotificationReceivers' => [ + 'title' => '', + 'description' => 'The alert recipient configurations.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'ReceiverType' => [ + 'title' => '', + 'description' => 'The alert recipient configuration.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'AliUid', + 'backendName' => 'receiverType', + ], + 'ReceiverValues' => [ + 'title' => '', + 'description' => 'The alert recipients.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + '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', + ], + ], + 'extendType' => 'true', + 'description' => '', + ], + 'backendName' => 'notificationReceivers', + ], + ], + 'extendType' => 'true', + 'description' => '', + ], + 'backendName' => 'notifications', + ], + ], + 'extendType' => 'true', + ], + 'backendName' => 'notifications', + ], + ], + 'backendName' => 'task', + ], + ], + ], + 'DataQualityResult' => [ + 'title' => 'A short description of struct', + 'description' => 'The data quality check results.'."\n", + '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', + ], + 'Rule' => [ + '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', + ], + 'Target' => [ + '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', + ], + ], + 'backendName' => 'target', + ], + 'TemplateCode' => [ + 'title' => '', + 'description' => 'The template used by the rule.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'system::user_defined', + 'backendName' => 'templateCode', + ], + 'SamplingConfig' => [ + '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', + ], + ], + 'backendName' => 'samplingConfig', + ], + 'CheckingConfig' => [ + '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', + ], + 'Thresholds' => [ + 'title' => '', + 'description' => 'The threshold settings.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Expected' => [ + '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', + ], + ], + 'backendName' => 'expected', + ], + 'Warned' => [ + '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', + ], + ], + 'backendName' => 'warned', + ], + 'Critical' => [ + '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', + ], + ], + 'backendName' => 'critical', + ], + ], + 'backendName' => 'thresholds', + ], + ], + 'backendName' => 'checkingConfig', + ], + 'ErrorHandlers' => [ + 'title' => '', + 'description' => 'The operations that you can perform after the rule-based check fails.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The operation that you can perform after the rule-based check fails.'."\n", + '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', + ], + ], + 'extendType' => 'true', + ], + 'backendName' => 'errorHandlers', + ], + ], + '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', + ], + 'Details' => [ + 'title' => '', + 'description' => 'The information about the data quality check.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the data quality check.'."\n", + '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', + ], + ], + 'extendType' => 'true', + ], + 'backendName' => 'details', + ], + ], + ], + 'DataQualityRule' => [ + 'title' => 'A short description of struct', + 'description' => 'The data quality monitoring rule.'."\n", + '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', + ], + 'Target' => [ + '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', + ], + ], + 'backendName' => 'target', + ], + 'SamplingConfig' => [ + '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', + ], + ], + 'backendName' => 'samplingConfig', + ], + 'CheckingConfig' => [ + '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', + ], + 'Thresholds' => [ + 'title' => '', + 'description' => 'The threshold settings.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'Expected' => [ + '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', + ], + ], + 'backendName' => 'expected', + ], + 'Warned' => [ + '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', + ], + ], + 'backendName' => 'warned', + ], + 'Critical' => [ + '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', + ], + ], + 'backendName' => 'critical', + ], + ], + 'backendName' => 'thresholds', + ], + ], + 'backendName' => 'checkingConfig', + ], + 'ErrorHandlers' => [ + 'title' => '', + 'description' => 'The operations that you can perform after the rule-based check fails.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + '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', + ], + ], + 'extendType' => 'true', + 'description' => '', + ], + 'backendName' => 'errorHandlers', + ], + ], + ], + 'Dataset' => [ + 'title' => '', + 'description' => 'The dataset object.'."\n", + 'visibility' => 'Public', + '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', + ], + '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', + ], + 'DataType' => [ + 'title' => '', + 'description' => 'The data type. Valid values:'."\n" + ."\n" + .'* COMMON'."\n" + .'* PIC'."\n" + .'* TEXT'."\n" + .'* TABLE'."\n" + .'* VIDEO'."\n" + .'* AUDIO'."\n" + .'* INDEX'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'enumValueTitles' => [ + 'TABLE' => '', + 'VIDEO' => '', + 'COMMON' => '', + 'TEXT' => '', + 'PIC' => '', + 'INDEX' => '', + 'AUDIO' => '', + ], + 'example' => 'COMMON', + 'backendName' => 'dataType', + ], + 'StorageType' => [ + 'title' => '', + 'description' => 'The storage type. Valid values:'."\n" + ."\n" + .'* OSS: Object Storage Service'."\n" + .'* NAS: General-purpose NAS file systems'."\n" + .'* EXTREM_NAS: Extreme NAS file systems'."\n" + .'* DLF_LANCE: Data Lake Formation'."\n" + .'* CPFS: Cloud Paralleled File System'."\n" + .'* BMCPFS: CPFS for Lingjun'."\n" + .'* MAXCOMPUTE: MaxCompute table'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'enumValueTitles' => [ + 'NAS' => '', + 'MAXCOMPUTE' => '', + 'CPFS' => '', + 'BMCPFS' => '', + 'EXTREMENAS' => '', + 'OSS' => '', + 'DLF_LANCE' => '', + ], + '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', + ], + 'Labels' => [ + 'title' => '', + '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', + ], + ], + ], + 'DatasetLabel' => [ + 'title' => '', + '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', + ], + ], + ], + 'DatasetVersion' => [ + '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', + ], + 'Labels' => [ + 'title' => '', + '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', + ], + 'ImportInfo' => [ + 'title' => '', + 'description' => 'The storage import configuration for the dataset; required configuration varies by storage type.'."\n" + ."\n" + .'**NAS**'."\n" + ."\n" + .'Refer to the return values 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 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', + ], + ], + ], + 'IdentifyCredential' => [ + 'description' => '', + 'visibility' => 'Public', + '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', + ], + 'UserType' => [ + 'description' => '* Alibaba Cloud account'."\n" + .'* RAM user'."\n" + .'* Role'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Role' => '', + 'PrimaryAccount' => '', + 'SubAccount' => '', + ], + 'example' => ' primaryAccount', + 'backendName' => 'accountType', + ], + 'ProjectId' => [ + 'description' => 'The workspace ID (optional).'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '10000', + 'backendName' => 'workspaceId', + ], + 'DataSource' => [ + 'description' => 'The data source.'."\n", + 'visibility' => 'Public', + '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', + ], + 'Role' => [ + 'description' => 'The user type of the data source.'."\n" + ."\n" + .'* Admin'."\n" + .'* RegularUser'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* RegularUser: Normal user.'."\n" + .'* Admin: Administrator.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'RegularUser' => '', + 'Admin' => '', + ], + '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', + ], + ], + 'backendName' => 'dataSource', + ], + ], + ], + 'LineageEntity' => [ + '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', + ], + 'Attributes' => [ + 'title' => '', + 'description' => 'The additional properties.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'additionalProperties' => [ + 'description' => 'The property.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'key1:value1', + ], + 'example' => '{"key1":"value1"}', + 'backendName' => 'attributes', + ], + ], + ], + 'LineageRelationship' => [ + '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', + ], + ], + ], + 'LineageTask' => [ + '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', + ], + 'Attributes' => [ + 'title' => '', + 'description' => 'The properties of the task.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'additionalProperties' => [ + 'description' => 'The property.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => 'key1:value21', + ], + 'backendName' => 'attributes', + ], + ], + ], + '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' => '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', + ], + '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', + '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' => [ + 'title' => '', + 'description' => 'The modification time. The value is a UNIX timestamp. Unit: milliseconds.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1736852168000', + 'backendName' => 'modifyTime', + ], + ], + ], + 'Table' => [ + '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' => [ + 'title' => '', + 'description' => 'The comments.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + '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', + 'type' => 'string', + 'example' => 'TABLE', + 'backendName' => 'tableType', + 'bizType' => 'normal', + ], + 'PartitionKeys' => [ + 'title' => '', + 'description' => 'The partition keys. If the table is a non-partitioned table, leave this parameter empty.'."\n", + 'visibility' => 'Public', + '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', + ], + 'TechnicalMetadata' => [ + 'title' => '', + 'description' => 'The technical metadata.'."\n", + 'visibility' => 'Public', + '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', + ], + 'Parameters' => [ + 'title' => '', + 'description' => 'The information about parameters.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'additionalProperties' => [ + 'description' => 'The information about the parameter.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '{\\"k1\\":\\"v1\\"}', + ], + 'backendName' => 'parameters', + ], + ], + 'backendName' => 'technicalMetadata', + ], + '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', + 'type' => 'object', + 'properties' => [ + 'Readme' => [ + 'title' => '', + 'description' => 'The usage notes.'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'example' => '', + 'backendName' => 'readme', + ], + 'Tags' => [ + 'title' => '', + 'description' => 'The tags.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the tag.'."\n", + 'visibility' => 'Public', + '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', + ], + ], + 'extendType' => 'true', + ], + 'backendName' => 'tags', + ], + 'Categories' => [ + 'title' => '', + 'description' => 'The categories.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The levels of a category. The category can be a single category or a multi-level category.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the category.'."\n", + 'visibility' => 'Public', + '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', + ], + ], + 'extendType' => 'true', + ], + 'extendType' => 'true', + ], + 'backendName' => 'categories', + 'itemName' => 'Category', + ], + 'UpstreamTasks' => [ + 'title' => '', + 'description' => 'The ancestor tasks.'."\n", + 'visibility' => 'Public', + 'type' => 'array', + 'items' => [ + 'description' => 'The ancestor task.'."\n", + 'visibility' => 'Public', + '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', + ], + ], + 'extendType' => 'true', + ], + 'backendName' => 'upstreamTasks', + ], + 'Extension' => [ + 'title' => '', + 'description' => 'The extended information. Only MaxCompute tables supports this parameter.'."\n", + 'visibility' => 'Public', + 'type' => 'object', + 'properties' => [ + 'ProjectId' => [ + 'title' => '', + 'description' => 'The DataWorks workspace ID.'."\n", + 'visibility' => 'Public', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '234', + 'backendName' => 'projectId', + ], + 'EnvType' => [ + 'title' => '', + 'description' => 'The type of the environment. Valid values:'."\n" + ."\n" + .'* Prod'."\n" + .'* Dev'."\n", + 'visibility' => 'Public', + 'type' => 'string', + 'enumValueTitles' => [], + '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', + ], + ], + 'backendName' => 'extension', + ], + ], + 'backendName' => 'businessMetadata', + ], + ], + ], + ], + ], + 'apis' => [ + 'ImportCertificate' => [ + 'summary' => 'Imports a certificate file.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '250619', + 'abilityTreeNodes' => [ + 'FEATUREdideRWC5F7', + ], + ], + '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, + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the task.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'This is a file', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response.'."\n", + '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', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '250938', + 'abilityTreeNodes' => [ + 'FEATUREdideRWC5F7', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'title' => '证书文件ID，即证书文件的唯一标识符。', + 'description' => 'The ID of the certificate file.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '676303114031776', + ], + ], + [ + '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' => '1065601', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + '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', + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '250939', + 'abilityTreeNodes' => [ + 'FEATUREdideRWC5F7', + ], + ], + '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' => '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, + 'example' => '10', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '查询第几页，默认值为1表示第一页', + 'description' => 'The page number. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + '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', + ], + ], + [ + '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' => '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' => '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' => 'SortBy', + 'in' => 'query', + '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", + 'type' => 'string', + 'required' => false, + 'example' => 'Id', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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" + .'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", + ], + 'DeleteCertificate' => [ + 'summary' => 'Deletes a certificate file.', + '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 ID of the certificate file.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '676303114031776', + ], + ], + [ + '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', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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", + ], + 'CreateProject' => [ + 'summary' => 'Creates a workspace.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '243667', + 'abilityTreeNodes' => [ + 'FEATUREdideYTM537', + ], + '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', + '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, + ], + ], + [ + 'name' => 'DevRoleDisabled', + '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', + ], + ], + ], + '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", + ], + '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', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '244492', + 'abilityTreeNodes' => [ + 'FEATUREdideYTM537', + ], + 'tenantRelevance' => 'tenant', + ], + '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', + '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', + ], + ], + [ + 'name' => 'DisplayName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The display name of the workspace.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Sora financial analysis Space', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request. It is used to locate logs and troubleshoot problems.', + 'type' => 'string', + 'example' => 'AFBB799F-8578-51C5-A766-E922EDB8XXXX'."\n", + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AFBB799F-8578-51C5-A766-E922EDB8XXXX\\\\n\\"\\n}","type":"json"}]', + 'title' => 'UpdateProject', + ], + '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 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' => '123456', + ], + ], + ], + '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", + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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", + ], + 'GetProject' => [ + 'summary' => 'Queries the information about a DataWorks workspace.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '244495', + 'abilityTreeNodes' => [ + 'FEATUREdideYTM537', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + '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.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123456', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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.'."\n", + ], + 'ListProjects' => [ + 'summary' => 'Queries a list of DataWorks workspaces of the tenant to which your account belongs.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '244496', + 'abilityTreeNodes' => [ + 'FEATUREdideYTM537', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'Ids', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The IDs of the DataWorks workspaces.'."\n", + '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', + 'required' => false, + 'example' => 'sora_finance', + ], + 'required' => false, + ], + ], + [ + '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.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmzbn7pti3zff', + ], + ], + [ + 'name' => 'Status', + 'in' => 'formData', + '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', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'DevRoleDisabled', + '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', + ], + ], + [ + '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" + .'* false: Scheduling of PAI tasks is disabled.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'AliyunResourceTags', + '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, + ], + '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', + ], + ], + ], + '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", + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'GetProjectRole' => [ + 'summary' => 'Queries the information about a role in a DataWorks workspace.', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '244504', + 'abilityTreeNodes' => [ + 'FEATUREdideYTM537', + ], + '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", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10002', + ], + ], + [ + 'name' => 'Code', + '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', + ], + ], + ], + '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' => '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', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '244505', + '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" + ."\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', + ], + ], + [ + 'name' => 'Codes', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The codes of roles in the DataWorks workspace.'."\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', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Names', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The names of roles in the DataWorks workspace.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The name of the role in the DataWorks workspace.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Visitors', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Type', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The type of the role. Valid values:'."\n" + ."\n" + .'* UserCustom: user-defined role'."\n" + .'* System: system role'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'System', + ], + ], + [ + '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', + ], + ], + ], + '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' => '61649187-0BCF-5E75-8D4B-64FDBEBBB447', + ], + 'PagingInfo' => [ + 'description' => 'The pagination information.'."\n", + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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", + ], + 'CreateProjectMember' => [ + 'summary' => 'Adds a workspace member and assigns a workspace-level role to the member.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '244498', + '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" + ."\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', + ], + ], + [ + '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.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '123422344899', + ], + ], + [ + '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" + ."\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', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + '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](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' => 'UserId', + 'in' => 'formData', + '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', + 'required' => true, + 'example' => '123422344899', + ], + ], + [ + '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" + ."\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', + ], + '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' => '2d9ced66-38ef-4923-baf6-391dd3a7e656', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '244501', + 'abilityTreeNodes' => [ + 'FEATUREdideYTM537', + ], + '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", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '105149', + ], + ], + [ + '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'."\n", + ], + ], + [ + '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" + ."\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, + ], + ], + ], + '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' => '676271D6-53B4-57BE-89FA-72F7AE1418DF', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + '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](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', + ], + ], + [ + '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', + ], + ], + ], + '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 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', + ], + ], + ], + ], + ], + ], + ], + '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 API operation is available for all DataWorks editions.'."\n", + ], + 'ListProjectMembers' => [ + 'summary' => 'Queries details about members in a workspace.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '244503', + 'abilityTreeNodes' => [ + 'FEATUREdideYTM537', + ], + '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" + .'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' => '62136', + ], + ], + [ + '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' => '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', + ], + ], + ], + '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 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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '250948', + 'abilityTreeNodes' => [ + 'FEATUREdideRWC5F7', + ], + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '资源组ID，即资源组的唯一标识符。', + 'description' => 'The resource group ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX', + ], + ], + [ + 'name' => 'DataSourceId', + 'in' => 'query', + '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', + 'required' => true, + 'example' => '144544', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'title' => 'DataWorks项目空间ID。', + 'description' => 'The DataWorks workspace ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10001', + ], + ], + ], + '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' => '', + ], + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"校验输入参数\\"\\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", + ], + 'CreateDataSource' => [ + 'summary' => 'Adds a data source to the development environment or production environment of a workspace.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '232205', + 'abilityTreeNodes' => [ + 'FEATUREdideRWC5F7', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + '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', + ], + ], + [ + 'name' => 'Name', + '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", + 'type' => 'string', + 'required' => true, + 'example' => 'demo_holo_datasource', + ], + ], + [ + 'name' => 'Type', + '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', + ], + ], + [ + 'name' => 'ConnectionPropertiesMode', + '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', + ], + ], + ], + [ + 'name' => 'Description', + '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', + ], + ], + [ + 'name' => 'ConnectionProperties', + 'in' => 'query', + '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', + '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" + .'}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", + 'type' => 'string', + 'example' => 'B62EC203-B39E-5DC1-B5B8-EB3C61707009', + ], + 'Id' => [ + 'title' => '返回创建的数据源Id', + 'description' => 'The data source ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '22130', + ], + ], + ], + ], + ], + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID. You can 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', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'high', + 'chargeType' => 'free', + 'abilityTreeCode' => '232392', + 'abilityTreeNodes' => [ + 'FEATUREdideRWC5F7', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'title' => '数据源Id', + 'description' => 'The data source ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '16033', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'title' => 'Dataworks项目空间Id', + 'description' => 'The DataWorks workspace ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '5678', + ], + ], + [ + 'name' => 'ConnectionPropertiesMode', + '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', + ], + ], + ], + [ + 'name' => 'Description', + '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 ', + ], + ], + [ + 'name' => 'ConnectionProperties', + 'in' => 'query', + '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" + .'}', + ], + ], + ], + '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' => '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', + ], + ], + ], + ], + ], + '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', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The data source ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '16036', + ], + ], + [ + 'name' => 'CloneDataSourceName', + 'in' => 'query', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request. It is used to locate logs and troubleshoot problems.', + 'type' => 'string', + 'example' => 'FCD583B9-346B-5E75-82C1-4A7C192C48DB', + ], + 'Id' => [ + 'description' => 'The ID of the cloned data source.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19715', + ], + ], + ], + ], + ], + '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', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The data source ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '16035', + ], + ], + ], + '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' => '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', + ], + ], + ], + ], + ], + ], + ], + '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" + ."\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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '232439', + 'abilityTreeNodes' => [ + 'FEATUREdideRWC5F7', + ], + ], + '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', + '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', + ], + ], + [ + 'name' => 'Types', + 'in' => 'query', + 'style' => 'simple', + 'schema' => [ + 'description' => 'The data source types. This parameter specifies a filter condition. You can specify multiple data source types.'."\n", + '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', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => 'The field that you want to use to sort the data sources. Valid values:'."\n" + ."\n" + .'* CreateTime'."\n" + .'* Id'."\n" + .'* Name'."\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" + ."\n" + .'* Desc: descending order'."\n" + .'* Asc: ascending order'."\n" + ."\n" + .'Default value: Desc'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Asc', + ], + ], + [ + '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" + .'* If you do not configure this parameter, tag-based filtering is not performed. You can specify up to 10 tags.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '["tag1", "tag2", "tag3"] ', + ], + ], + ], + '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' => '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '235541', + 'abilityTreeNodes' => [ + 'FEATUREdideRWC5F7', + ], + ], + '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' => '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' => '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 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The ID of the request. It is used to locate logs and troubleshoot problems.', + 'type' => 'string', + 'example' => '46F594E6-84AB-5FA5-8144-6F3D149961E1', + ], + 'Id' => [ + 'description' => 'The sharing rule ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '105412', + ], + ], + ], + ], + ], + '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', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'title' => '数据源分享记录Id', + 'description' => 'The sharing rule ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '22127', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.'."\n", + '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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + 'ListDataSourceSharedRules' => [ + 'summary' => 'Queries a list of sharing rules of a data source.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '235551', + 'abilityTreeNodes' => [ + 'FEATUREdideRWC5F7', + ], + ], + 'parameters' => [ + [ + 'name' => 'DataSourceId', + 'in' => 'query', + 'schema' => [ + 'title' => '数据源Id', + 'description' => 'The data source ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'TargetProjectId', + 'in' => 'query', + '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', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'DataSourceSharedRules' => [ + 'description' => 'The sharing rules of the data source.'."\n", + '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', + ], + 'TargetProjectId' => [ + 'description' => 'The ID of the workspace to which the data source is shared.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + '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", + 'type' => 'string', + 'example' => '1', + ], + '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.', + 'type' => 'string', + 'example' => 'Dev', + ], + 'CreateTime' => [ + 'description' => 'The time when the rule was created. This value is a UNIX timestamp.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1724379762000', + ], + 'CreateUser' => [ + 'description' => 'The ID of the user who creates the rule.'."\n", + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + '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 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', + ], + '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.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The workspace ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Responses'."\n", + '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', + ], + ], + ], + ], + ], + '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', + ], + '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.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '11792', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the DataWorks workspace.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10003', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID. You can use the request ID to locate logs and troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => '9252F32F-D855-549E-8898-61CF5A733050', + ], + 'ComputeResource' => [ + 'description' => 'The details of the computing resource.'."\n", + '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', + ], + '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', + ], + 'WhetherDefault' => [ + 'description' => 'Specifies whether it is the default computing resource.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + 'UpdateComputeResource' => [ + 'summary' => 'Modifies the specified computing resource based on the computing resource ID.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '232392', + 'abilityTreeNodes' => [ + 'FEATUREdideRWC5F7', + ], + 'tenantRelevance' => 'tenant', + ], + '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' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'title' => 'Dataworks项目空间Id', + 'description' => 'The DataWorks workspace ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10001', + ], + ], + [ + 'name' => 'ConnectionPropertiesMode', + 'in' => 'query', + '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", + 'type' => 'string', + 'required' => false, + 'example' => 'InstanceMode', + 'enum' => [ + 'UrlMode', + 'InstanceMode', + 'CdhMode', + ], + ], + ], + [ + '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' => '', + ], + ], + [ + 'name' => 'ConnectionProperties', + 'in' => 'query', + '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" + .'}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID. 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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '232439', + 'abilityTreeNodes' => [ + 'FEATUREdideRWC5F7', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the DataWorks workspace.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '21229', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the computing resource.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'category name ', + ], + ], + [ + 'name' => 'Types', + 'in' => 'query', + 'style' => 'simple', + 'schema' => [ + 'description' => 'The filter for computing resource types. You can configure multiple types for filtering.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The type of the computing resource.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'hologres', + ], + 'required' => false, + ], + ], + [ + 'name' => 'EnvType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The environment type of the computing resource. Valid values:'."\n" + ."\n" + .'* Dev'."\n" + .'* Prod'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Dev', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number to query. The default value is 1, which indicates the first page.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. The default value is 10, and the maximum value is 100.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + '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" + .'* 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', + 'required' => false, + 'example' => 'CreateTimeWithDefaultFirst', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID. 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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + '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' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '232205', + 'abilityTreeNodes' => [ + 'FEATUREdideRWC5F7', + ], + 'tenantRelevance' => 'tenant', + ], + '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' => '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' => 'Type', + 'in' => 'query', + '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', + ], + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'ConnectionProperties', + 'in' => 'query', + '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" }', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned result.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID. You can use the request ID to 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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\",\\n \\"Id\\": 10001\\n}","type":"json"}]', + 'title' => 'CreateComputeResource', + ], + 'CreateResourceGroup' => [ + 'summary' => 'Creates a serverless resource group.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '245182', + 'abilityTreeNodes' => [ + 'FEATUREdide2SV6DS', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Name', + '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', + ], + ], + [ + 'name' => 'Remark', + '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', + ], + ], + [ + 'name' => 'PaymentType', + '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', + ], + ], + ], + [ + 'name' => 'PaymentDurationUnit', + 'in' => 'formData', + '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', + ], + ], + ], + [ + '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', + ], + ], + [ + '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' => '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' => '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' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'title' => '客户端幂等性标识，用于保证创建通用资源组操作的幂等性', + 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'eb870033-74c8-4b1b-9664-04c4e7cc3465', + ], + ], + [ + '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' => '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, + ], + ], + ], + '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', + ], + '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', + ], + ], + ], + ], + ], + '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', + ], + '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' => [ + 'title' => '资源组唯一标识', + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX', + ], + ], + ], + '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. You can use the ID to locate logs and troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '245164', + 'abilityTreeNodes' => [ + 'FEATUREdide2SV6DS', + ], + 'tenantRelevance' => 'tenant', + ], + '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' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'title' => '要修改的通用资源组的名称', + 'description' => 'The new name that you want to change for the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'common_resource_group', + ], + ], + [ + 'name' => 'Remark', + 'in' => 'formData', + 'schema' => [ + 'title' => '要修改的通用资源组的备注', + 'description' => 'The new remarks that you want to modify for the resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Create a common resource group for common tasks', + ], + ], + [ + 'name' => 'AliyunResourceGroupId', + 'in' => 'formData', + 'schema' => [ + 'title' => '阿里云资源组ID', + 'description' => 'The ID of the new Alibaba Cloud resource group.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aek2kqofrgXXXXX', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '245094', + 'abilityTreeNodes' => [ + 'FEATUREdide2SV6DS', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'title' => '通用资源组唯一标识', + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + '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', + ], + ], + ], + ], + ], + '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', + ], + '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' => [ + 'title' => '资源组名称，用于模糊查询', + 'description' => 'The name of a resource group, which is used for fuzzy match.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Resource', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'title' => '所属工作空间ID', + 'description' => 'The ID of the DataWorks workspace.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000', + ], + ], + [ + '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' => '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' => 'PaymentType', + 'in' => 'query', + 'schema' => [ + 'title' => '资源组的付费类型，PrePaid代表包年包月，PostPaid代表按量付费 ', + 'description' => 'The billing method of resource groups. Valid values:'."\n" + ."\n" + .'* PrePaid'."\n" + .'* PostPaid'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'PrePaid', + 'enum' => [ + 'PrePaid', + 'PostPaid', + ], + ], + ], + [ + 'name' => 'AliyunResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '阿里云资源组ID', + 'description' => 'Alibaba Cloud Resource Group ID', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aek2kqofrgXXXXX', + ], + ], + [ + 'name' => 'AliyunResourceTags', + 'in' => 'query', + 'allowEmptyValue' => true, + 'style' => 'json', + '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, + ], + 'required' => false, + ], + ], + [ + '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' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '分页页码', + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + '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", + 'type' => 'string', + 'required' => false, + 'example' => 'CreateTime Asc', + 'default' => 'CreateTime Asc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + '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', + ], + ], + ], + ], + ], + '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', + ], + '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' => [ + 'title' => '资源组唯一标识', + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX', + ], + ], + [ + 'name' => 'ProjectId', + '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', + ], + ], + ], + '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. You can use the ID to locate logs and troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '245168', + 'abilityTreeNodes' => [ + 'FEATUREdide2SV6DS', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => [ + 'title' => '资源组唯一标识', + 'description' => 'The ID of the resource group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX', + ], + ], + [ + 'name' => 'ProjectId', + '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', + ], + ], + ], + '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. You can use the ID to locate logs and troubleshoot issues.'."\n", + 'type' => 'string', + 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', + ], + ], + ], + ], + ], + '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" + ."\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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdide2SV6DS', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '通用资源组唯一标识', + 'description' => 'The ID of the serverless resource group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Serverless_res_group_524257424564736_6831777003****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + '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", + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdide2SV6DS', + ], + 'tenantRelevance' => 'tenant', + ], + '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' => 'MetricName', + 'in' => 'formData', + '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', + ], + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'BeginTime', + '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', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'formData', + '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', + 'required' => false, + 'minimum' => '0', + 'example' => '1750176000000', + ], + ], + [ + 'name' => 'NextToken', + '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", + 'type' => 'string', + 'required' => false, + 'example' => 'FFqBJBxE8I0PE0IUO6K69k7m2FfyWNNc2qQ9ReUkazhz9VA7dWZKlxBcjUwOV0imSM', + ], + ], + [ + 'name' => 'Length', + 'in' => 'formData', + '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', + 'required' => false, + 'maximum' => '1440', + 'minimum' => '0', + 'example' => '100', + ], + ], + ], + '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", + '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', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'title' => '请求的ID，用于定位日志，排查问题', + 'description' => 'The request ID, used for locating logs and troubleshooting.'."\n", + 'type' => 'string', + 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX'."\n", + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + 'CreateRoute' => [ + 'summary' => 'Creates a route for a network.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '245176', + 'abilityTreeNodes' => [ + 'FEATUREdide2SV6DS', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'NetworkId', + 'in' => 'formData', + 'schema' => [ + 'title' => '网络资源ID', + 'description' => 'The network ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1000', + ], + ], + [ + 'name' => 'DestinationCidr', + 'in' => 'formData', + 'schema' => [ + 'title' => '路由目的的CIDR', + 'description' => 'The CIDR blocks of the destination-based route.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '192.168.0.0/16', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => [ + 'title' => '所属通用资源组的唯一标识', + 'description' => 'Unique identifier of the serverless resource group.', + 'type' => 'string', + 'required' => false, + 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX', + ], + ], + ], + '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', + ], + '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', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'abilityTreeCode' => '245174', + 'abilityTreeNodes' => [ + 'FEATUREdide2SV6DS', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '网络资源的路由ID', + 'description' => 'The route ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1000', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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.', + ], + 'UpdateRoute' => [ + 'summary' => 'Updates the information about a route.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '245175', + 'abilityTreeNodes' => [ + 'FEATUREdide2SV6DS', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '网络资源的路由ID', + 'description' => 'The route ID of the network resource.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1000', + ], + ], + [ + 'name' => 'DestinationCidr', + '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' => [], + ], + ], + ], + '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. You can locate logs and troubleshoot issues based on the ID.'."\n", + 'type' => 'string', + 'example' => '6A6CBE87-9F91-1323-B680-E7A7065XXXXX', + ], + ], + ], + ], + ], + '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.', + ], + 'GetRoute' => [ + 'summary' => 'Queries the information about a route based on its ID.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '245172', + 'abilityTreeNodes' => [ + 'FEATUREdide2SV6DS', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'title' => '路由ID', + 'description' => 'The route ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1000', + ], + ], + ], + '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', + ], + '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', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '245173', + 'abilityTreeNodes' => [ + 'FEATUREdide2SV6DS', + ], + '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' => 'NetworkId', + 'in' => 'query', + 'schema' => [ + 'title' => '网络资源ID', + 'description' => 'The network ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000', + ], + ], + [ + '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' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'title' => '分页页码', + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + '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", + 'type' => 'string', + 'required' => false, + 'example' => 'CreateTime Asc', + 'default' => 'CreateTime Asc', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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.'."\n", + ], + 'CreateNetwork' => [ + 'summary' => 'Creates a network and associates the network with a general resource group.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '245180', + 'abilityTreeNodes' => [ + 'FEATUREdide2SV6DS', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ResourceGroupId', + 'in' => 'formData', + 'schema' => [ + 'title' => '所属通用资源组的唯一标识', + 'description' => 'The ID of the serverless resource group.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Serverless_res_group_524257424564736_6831777003XXXXX', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'formData', + 'schema' => [ + 'title' => '网络资源的VPC ID', + 'description' => 'The ID of the virtual private cloud (VPC).'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'vpc-m2et4f3oc8msfbccXXXXX', + ], + ], + [ + 'name' => 'VswitchId', + 'in' => 'formData', + 'schema' => [ + 'title' => '网络资源的交换机ID', + 'description' => 'The VSwitch ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'vsw-uf8usrhs7hjd9amsXXXXX', + ], + ], + [ + 'name' => 'ClientToken', + 'in' => 'formData', + 'schema' => [ + 'title' => '客户端幂等性标识，用于保证创建网络资源操作的幂等性', + 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'eb870033-74c8-4b1b-9664-04c4e7cc3465', + ], + ], + ], + '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', + ], + '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', + ], + ], + ], + ], + ], + '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', + ], + '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' => [ + 'title' => '删除的网络资源ID', + 'description' => 'The ID of the network that you want to delete.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1000', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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.', + ], + 'GetNetwork' => [ + 'summary' => 'Queries the information about a network resource.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '245177', + 'abilityTreeNodes' => [ + 'FEATUREdide2SV6DS', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'title' => '网络资源ID', + 'description' => 'The network ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1000', + ], + ], + ], + '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', + ], + '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', + ], + ], + ], + ], + ], + '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.'."\n", + ], + 'ListNetworks' => [ + 'summary' => 'Queries a list of network resources of a serverless resource group.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '245178', + 'abilityTreeNodes' => [ + 'FEATUREdide2SV6DS', + ], + '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' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + '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" + ."\n" + .'Default value: CreateTime Asc.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CreateTime Asc', + 'default' => 'CreateTime Asc', + ], + ], + ], + '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' => [ + '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', + ], + ], + ], + ], + ], + '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.', + ], + 'CreateComponent' => [ + 'summary' => 'Creates components.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236012', + 'abilityTreeNodes' => [ + 'FEATUREdideITYNXL', + ], + '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', + ], + ], + [ + 'name' => 'Spec', + '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", + '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" + .'}', + ], + ], + [ + '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****', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"adssd****\\",\\n \\"ComponentId\\": \\"123123123123123\\"\\n}","type":"json"}]', + 'title' => 'CreateComponent', + ], + '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.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1000', + ], + ], + [ + '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.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '123123123123', + ], + ], + ], + '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' => '0000-ABCD-EF****', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + '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.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'ComponentId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The component ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1112312312312', + ], + ], + ], + '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' => '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', + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 404 => [ + [ + 'errorCode' => 'InvalidComponent.NotFound', + 'errorMessage' => 'The specified Component does not exist.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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", + ], + 'UpdateComponent' => [ + 'summary' => 'Updates components.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236014', + 'abilityTreeNodes' => [ + 'FEATUREdideITYNXL', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'ComponentId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The component ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '568780096083*******', + ], + ], + [ + 'name' => 'Spec', + '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", + '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" + .'}', + ], + ], + [ + '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.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0bc1ec92159376', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'consumes' => [ + 'application/json', + ], + 'produces' => [ + 'application/json', + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236015', + 'abilityTreeNodes' => [ + 'FEATUREdideITYNXL', + ], + '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' => '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', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + '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' => '', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236773', + '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 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' => '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.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'a7ef0634-20ec-4a7c-a214-54020f91XXXX'."\n", + ], + ], + [ + 'name' => 'Scene', + '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", + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'DATAWORKS_PROJECT', + ], + ], + [ + '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" + .' "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" + .'}', + ], + ], + ], + '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.'."\n", + '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.'."\n", + 'type' => 'string', + 'example' => '860438872620113XXXX', + ], + ], + ], + ], + ], + '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', + ], + ], + [ + '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', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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", + ], + '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.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10000', + ], + ], + [ + '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.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '652567824470354XXXX', + ], + ], + [ + '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.'."\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" + .'}', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"99EBE7CF-69C0-5089-BE3E-79563C31****\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'UpdateNode', + ], + 'MoveNode' => [ + 'summary' => 'Moves a node to a path in DataStudio.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + '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.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10000', + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the node.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '652567824470354XXXX', + ], + ], + [ + '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.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'root/demo', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236794', + '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", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '12345', + ], + ], + [ + '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.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '652567824470354XXXX', + ], + ], + [ + '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.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Rename', + ], + ], + ], + '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' => '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', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236761', + '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', + ], + ], + [ + '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', + ], + ], + ], + '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.'."\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", + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'ListNodes' => [ + 'summary' => 'Queries a list of nodes in DataStudio. You can also specify filter conditions to query specific nodes.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236792', + 'abilityTreeNodes' => [ + 'FEATUREdideHO4TQP', + ], + ], + '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', + ], + ], + [ + 'name' => 'Scene', + 'in' => 'query', + '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" + ."\n" + .'* DataworksProject'."\n" + .'* DataworksManualWorkflow'."\n" + .'* DataworksManualTask'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'DATAWORKS_PROJECT', + ], + ], + [ + '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' => 'Recurrence', + '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, + 'enumValueTitles' => [], + 'example' => 'Normal', + ], + ], + [ + 'name' => 'RerunMode', + 'in' => 'query', + '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" + ."\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, + 'enumValueTitles' => [], + 'example' => 'Allowed', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the node. Fuzzy search is supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + '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' => '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', + ], + ], + ], + '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.'."\n", + 'type' => 'string', + 'example' => '2197B9C4-39CE-55EA-8EEA-FDBAE52DXXXX', + ], + 'PagingInfo' => [ + 'description' => 'The pagination information.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'string', + 'example' => '42', + ], + 'PageSize' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'string', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => 'The page number.'."\n", + 'type' => 'string', + 'example' => '1', + ], + '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', + ], + 'Owner' => [ + 'title' => '责任人', + 'description' => 'The owner of nodes in Data Studio.'."\n", + 'type' => 'string', + 'deprecated' => false, + 'example' => '110755000425XXXX', + 'pattern' => '', + 'default' => '', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => 'The timestamp when the node in Data Studio was created.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => false, + 'example' => '1722910655000', + 'pattern' => '', + 'default' => '', + ], + 'ModifyTime' => [ + 'title' => '修改时间', + 'description' => 'The timestamp when the node in DataStudio was last modified.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => false, + 'example' => '1722910655000', + 'pattern' => '', + 'default' => '', + ], + 'DataSource' => [ + 'title' => '数据源', + 'description' => 'The data source.'."\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, + ], + 'TaskId' => [ + 'title' => '调度任务Id', + 'description' => 'The ID of the scheduling task.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => false, + 'example' => '88888888888', + 'pattern' => '', + 'default' => '', + ], + 'Tags' => [ + 'title' => '标签信息', + 'description' => 'The tag information (not in use).'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '单个标签', + 'description' => 'The single tag (not in use).'."\n", + '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' => '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' => '', + ], + ], + '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, + ], + ], + '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' => '', + ], + ], + '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' => '623731286945488XXXX', + '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, + ], + 'Trigger' => [ + 'title' => '触发器', + 'description' => 'The trigger.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '类型', + 'description' => 'The trigger type.'."\n" + ."\n" + .'Valid values:'."\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" + ."\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' => '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" + ."\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_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", + 'type' => 'string', + 'example' => 'S_res_group_XXXX', + ], + ], + 'deprecated' => false, + ], + 'Recurrence' => [ + 'description' => 'The scheduling type.'."\n" + ."\n" + .'Valid values:'."\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', + ], + '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", + 'type' => 'string', + 'example' => '860438872620113XXXX', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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 }\\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', + ], + 'ListNodeDependencies' => [ + 'summary' => 'Queries a list of descendant nodes of a node in DataStudio.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236793', + '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' => '10001', + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + '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', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + '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', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + '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', + ], + ], + ], + '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.'."\n", + 'type' => 'string', + 'example' => '204EAF68-CCE3-5112-8DA0-E7A60F02XXXX', + ], + 'PagingInfo' => [ + 'description' => 'The pagination information.'."\n", + 'type' => 'object', + 'properties' => [ + 'TotalCount' => [ + 'description' => 'The total number of entries returned.'."\n", + 'type' => 'string', + 'example' => '90', + ], + 'PageSize' => [ + 'description' => 'The number of entries per page.'."\n", + 'type' => 'string', + 'example' => '10', + ], + 'PageNumber' => [ + 'description' => 'The page number.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'Nodes' => [ + 'description' => 'The list of dependent nodes.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The element in the list of dependent nodes.'."\n", + '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", + '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, + ], + 'TaskId' => [ + 'title' => '调度任务Id', + 'description' => 'The ID of the scheduling task.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => false, + 'example' => '580667964888595XXXX', + 'pattern' => '', + 'default' => '', + ], + 'Tags' => [ + 'title' => '标签信息', + 'description' => 'The tags. This parameter is not in use.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => '单个标签', + 'description' => 'The tag. This parameter is not in use.'."\n", + '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" + ."\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" + ."\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, + ], + ], + 'deprecated' => false, + ], + 'Trigger' => [ + 'title' => '触发器', + 'description' => 'The trigger.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'title' => '类型', + 'description' => 'The trigger type.'."\n" + ."\n" + .'Valid values:'."\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" + ."\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" + ."\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' => '', + ], + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '234974', + '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", + '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" + .'}', + ], + ], + ], + '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.'."\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', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '246297', + '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 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" + .'}', + ], + ], + ], + '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.'."\n", + 'type' => 'string', + 'example' => '7C352CB7-CD88-50CF-9D0D-E81BDF020E7F', + ], + 'AsyncJob' => [ + 'description' => 'The status information of the asynchronous task.'."\n", + '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', + ], + 'Response' => [ + 'description' => 'The response.'."\n" + ."\n" + .'> The workflow ID is returned.'."\n", + 'type' => 'string', + 'example' => '632647691239009XXXX', + ], + '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', + ], + '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', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'asynchronous', + 'callback' => 'dataworks-public::2024-05-18::GetJobStatus', + 'callbackInterval' => 1000, + 'maxCallbackTimes' => 10, + ], + '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', + ], + '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.'."\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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + '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', + ], + ], + ], + ], + ], + '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', + ], + '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.'."\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', + ], + ], + [ + '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', + ], + ], + ], + ], + ], + '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", + ], + 'MoveWorkflowDefinition' => [ + 'summary' => 'Moves a workflow to a path in DataStudio.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + '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.'."\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', + ], + ], + ], + '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' => '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', + ], + ], + ], + ], + ], + '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', + ], + '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.'."\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', + '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', + ], + ], + ], + '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 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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '234973', + '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', + ], + ], + [ + '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', + ], + ], + ], + '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' => 'F2BDD628-8A21-5BD1-B930-1A2D5989XXXX', + ], + 'WorkflowDefinition' => [ + 'description' => 'The information about the workflow.'."\n", + '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', + ], + 'Owner' => [ + 'description' => 'The owner of the workflow.'."\n", + 'type' => 'string', + 'example' => '110755000425XXXX', + ], + 'CreateTime' => [ + 'description' => 'The time when the workflow was created. This value is a UNIX timestamp.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1708481905000', + ], + 'ModifyTime' => [ + 'description' => 'The time when the workflow was last modified. This value is a UNIX timestamp.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1708481905000'."\n", + ], + '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', + ], + ], + ], + ], + ], + ], + ], + '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', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the workflow. Fuzzy search is supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + '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' => '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '8C3ED0C5-ABAB-55E1-854B-DAC02B11XXXX', + ], + 'PagingInfo' => [ + 'description' => 'The pagination information.'."\n", + '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', + ], + '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' => '', + ], + 'ModifyTime' => [ + 'title' => '修改时间', + 'description' => 'The timestamp when the workflow was last modified.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => false, + 'required' => false, + 'example' => '1698057323000', + 'pattern' => '', + 'default' => '', + ], + 'Description' => [ + 'title' => '描述', + 'description' => 'Description'."\n", + 'type' => 'string', + 'deprecated' => false, + 'required' => false, + 'example' => 'Workflow description', + 'pattern' => '', + 'default' => '', + ], + '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', + ], + ], + 'Script' => [ + 'title' => '脚本信息', + 'description' => 'The script information.'."\n", + '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" + ."\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", + 'type' => 'string', + 'deprecated' => false, + 'example' => '698002781368644XXXX', + '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' => '', + ], + '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', + 'deprecated' => false, + 'example' => '463497880880954XXXX', + 'title' => '', + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235474', + 'abilityTreeNodes' => [ + 'FEATUREdideJ3TPTK', + ], + ], + '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' => '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + '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', + ], + ], + ], + ], + ], + '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', + ], + '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.'."\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', + ], + ], + ], + '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' => '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', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235476', + '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", + '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, + ], + ], + ], + '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' => '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', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235504', + '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.'."\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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + ], + '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' => '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', + ], + ], + ], + ], + ], + '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', + ], + '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.'."\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', + ], + ], + ], + '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' => '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', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235473', + 'abilityTreeNodes' => [ + 'FEATUREdideJ3TPTK', + ], + ], + '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 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' => '', + ], + ], + ], + '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.'."\n", + 'type' => 'string', + 'example' => 'E871F6C0-2EFF-5790-A00D-C57543EEXXXX', + ], + 'Resource' => [ + 'description' => 'File resource details.'."\n", + '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', + ], + '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', + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235477', + 'abilityTreeNodes' => [ + 'FEATUREdideJ3TPTK', + ], + ], + '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', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the file resource. Supports fuzzy search.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + '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' => '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', + ], + ], + ], + '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", + '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', + ], + '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", + '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' => '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' => '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', + ], + ], + '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', + ], + ], + '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', + ], + ], + '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' => '', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236012', + '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 query the ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '12345', + ], + ], + [ + 'name' => 'Spec', + '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" + .'}', + ], + ], + ], + '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 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', + ], + ], + ], + ], + ], + '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', + ], + '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.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10000', + ], + ], + [ + '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', + ], + ], + ], + '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' => '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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236014', + '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 query the ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10000', + ], + ], + [ + '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' => '463497880880954XXXX', + ], + ], + [ + '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" + .'}', + ], + ], + ], + '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' => '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', + ], + ], + ], + ], + ], + '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', + ], + '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.'."\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', + ], + ], + ], + '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' => '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', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236048', + '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 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', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1ED4C97F-BA2A-57C5-BA7C-8853627EXXXX\\",\\n \\"Success\\": \\"true\\"\\n}","type":"json"}]', + 'title' => 'RenameFunction', + ], + 'GetFunction' => [ + 'summary' => 'Queries the information about a user-defined function (UDF) in DataStudio.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236011', + 'abilityTreeNodes' => [ + 'FEATUREdideZOYJZL', + ], + ], + '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', + ], + ], + ], + '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.'."\n", + 'type' => 'string', + 'example' => '6CF95929-6D12-5A88-8CC3-4B2F4C2EXXXX', + ], + 'Function' => [ + 'description' => 'UDF function details.'."\n", + '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", + ], + ], + ], + ], + ], + ], + ], + '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', + ], + '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' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '236015', + 'abilityTreeNodes' => [ + 'FEATUREdideZOYJZL', + ], + ], + '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' => 'Owner', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the owner of the UDF. This parameter specifies a filter condition.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '110755000425XXXX', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'Filter criteria: UDF name. Supports fuzzy search.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'PageSize', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '89FB2BF0-EB00-5D03-9C34-05931001XXXX', + ], + 'PagingInfo' => [ + 'description' => 'The pagination information.'."\n", + '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' => '', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '267910', + 'abilityTreeNodes' => [ + 'FEATUREdide4AR6E0', + ], + ], + '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.', + ], + ], + ], + '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' => '7C352CB7-CD88-50CF-9D0D-E81BDF02XXXX', + ], + 'Id' => [ + 'description' => 'The ID of the process.'."\n", + 'type' => 'string', + 'example' => 'a7ef0634-20ec-4a7c-a214-54020f91XXXX'."\n", + ], + ], + ], + ], + ], + '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' => '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '267906', + 'abilityTreeNodes' => [ + 'FEATUREdide4AR6E0', + ], + ], + '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", + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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", + ], + '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.'."\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', + ], + ], + [ + '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', + ], + ], + ], + '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", + ], + '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', + ], + ], + ], + ], + ], + '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.'."\n", + ], + 'GetPipelineRun' => [ + 'summary' => 'Queries the information about a process for deploying or undeploying an entity.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '267907', + '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', + ], + ], + [ + '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", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '08468352-032C-5262-AEDC-68C9FA05XXXX', + ], + 'Pipeline' => [ + 'description' => 'The information about the process.'."\n", + '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' => '', + ], + 'Status' => [ + 'title' => '发布流程状态', + 'description' => 'The status of the process.'."\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' => '', + 'enum' => [ + 'Init', + 'Running', + 'Success', + 'Fail', + 'Termination', + 'Cancel', + ], + ], + 'Message' => [ + 'description' => 'The error message returned when the process fails.'."\n", + 'type' => 'string', + 'example' => 'Error message', + ], + 'Stages' => [ + 'title' => '步骤详情', + 'description' => 'The information about stages in the process.'."\n", + 'type' => 'array', + 'items' => [ + 'title' => 'stage的元素', + 'description' => 'The information about a stage in the process.'."\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.'."\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", + 'type' => 'string', + 'deprecated' => false, + 'example' => 'Exception information XXX', + '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, + 'enumValueTitles' => [ + 'Init' => 'Init', + 'Cancel' => 'Cancel', + 'Running' => 'Running', + 'Termination' => 'Termination', + 'Success' => 'Success', + 'Fail' => 'Fail', + ], + 'example' => 'Running', + 'pattern' => '', + 'default' => '', + ], + 'Detail' => [ + 'description' => 'The details of the stage.'."\n", + '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", + ], + ], + ], + 'deprecated' => false, + ], + 'deprecated' => false, + ], + 'Description' => [ + 'title' => '发布流程的描述信息', + 'type' => 'string', + '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"}]', + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '267909', + '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', + ], + ], + [ + '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', + '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', + ], + ], + ], + '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", + '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', + ], + 'PipelineRuns' => [ + 'description' => 'The processes.'."\n", + '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" + ."\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' => '', + '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, + ], + 'Description' => [ + 'title' => '发布流程的描述信息', + 'type' => 'string', + 'example' => '发布流程描述信息', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"发布流程描述信息\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListPipelineRuns', + ], + 'ListPipelineRunItems' => [ + 'summary' => 'Queries the information about deployment objects by deployment process ID.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '267918', + 'abilityTreeNodes' => [ + 'FEATUREdide4AR6E0', + ], + ], + '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', + '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', + ], + ], + ], + '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", + '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', + ], + 'PipelineRunItems' => [ + 'description' => 'The list of deployments.'."\n", + '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", + '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' => '', + ], + 'Status' => [ + 'title' => '发布流程状态', + 'description' => 'The deployment status. Valid values:'."\n" + ."\n" + .'* Init: Initializing'."\n" + .'* Running'."\n" + .'* Success'."\n" + .'* Fail'."\n" + .'* Termination'."\n", + 'type' => 'string', + 'deprecated' => false, + 'example' => 'Running', + 'pattern' => '', + 'default' => '', + 'enum' => [ + 'Init', + 'Running', + 'Success', + 'Fail', + 'Termination', + ], + ], + 'Message' => [ + 'title' => '创建人', + 'description' => 'The error message if the deployment failed.'."\n", + 'type' => 'string', + 'deprecated' => false, + 'example' => 'Error Message', + 'pattern' => '', + 'default' => '', + ], + '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', + ], + '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" } }', + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'CreateFile' => [ + 'methods' => [ + 'post', + ], + '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', + ], + ], + [ + 'name' => 'ImageId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The custom image ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'm-bp1h4b5a8ogkbll2f3tr', + ], + ], + ], + '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 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', + ], + ], + ], + ], + ], + '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 \\"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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '269305', + 'abilityTreeNodes' => [ + 'FEATUREdide8FM783', + 'FEATUREdideJ3TPTK', + ], + ], + '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', + ], + ], + [ + 'name' => 'StorageURL', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + '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', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.Access', + 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', + ], + ], + 429 => [ + [ + 'errorCode' => 'Throttling.Api', + 'errorMessage' => 'The request for this resource has exceeded your available limit.', + ], + [ + 'errorCode' => 'Throttling.System', + 'errorMessage' => 'The DataWorks system is busy. Try again later.', + ], + [ + 'errorCode' => 'Throttling.User', + 'errorMessage' => 'Your request is too frequent. Try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError.System', + 'errorMessage' => 'An internal system error occurred. Try again later.', + ], + [ + 'errorCode' => 'InternalError.UserId.Missing', + 'errorMessage' => 'An internal system error occurred. Try again later.', + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": 1000001,\\n \\"RequestId\\": \\"0000-ABCD-EFG\\"\\n}","type":"json"}]', + 'title' => 'CreateResourceFile', + ], + 'CreateUdfFile' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '269313', + 'abilityTreeNodes' => [ + 'FEATUREdide8FM783', + ], + ], + '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', + ], + ], + [ + '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' => 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', + ], + ], + ], + '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 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', + ], + ], + ], + ], + ], + '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 \\"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.', + ], + '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.'."\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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'The returned result.'."\n", + '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', + ], + ], + ], + ], + ], + '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 \\"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.', + ], + 'UpdateFile' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '268116', + 'abilityTreeNodes' => [ + 'FEATUREdide8FM783', + ], + ], + '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', + ], + ], + [ + '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' => 'FileDescription', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The file description.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'Here is the file description', + ], + ], + [ + '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";', + ], + ], + [ + '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', + ], + ], + [ + '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" + ."\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', + ], + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + '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' => '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' => '4155787800000', + ], + ], + [ + '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 * * ?', + ], + ], + [ + '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', + ], + ], + ], + [ + '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", + 'type' => 'string', + 'required' => false, + 'example' => 'USER_DEFINE', + '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' => '5,10,15,20', + ], + ], + [ + '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" + ."\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', + ], + ], + [ + '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' => 'FileId', + 'in' => 'formData', + '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', + ], + ], + [ + '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', + ], + ], + [ + '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' => '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' => 'Owner', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The file owner ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '18023848927592', + ], + ], + [ + '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, + 'example' => '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, + 'example' => 'NORMAL', + 'enum' => [ + 'NORMAL', + 'SKIP', + 'PAUSE', + 'MANUAL', + ], + ], + ], + [ + '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"}', + ], + ], + [ + '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' => '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' => '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', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'ImageId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The custom image ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'm-uf6d7npxk1hhek8ng0cb', + ], + ], + ], + '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-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', + ], + ], + ], + ], + ], + '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 \\"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.', + ], + 'UpdateUdfFile' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '269316', + 'abilityTreeNodes' => [ + 'FEATUREdide8FM783', + ], + ], + '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' => 'FileId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The file ID.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '10000001', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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' => 'UpdateUdfFile', + 'summary' => 'Updates the file information about a function.', + ], + 'GetFile' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '267409', + '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" + ."\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' => '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 configure either this parameter or the ProjectId parameter to determine the DataWorks workspace to which the operation is applied.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'dw_project', + ], + ], + [ + 'name' => 'FileId', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + '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", + 'type' => 'object', + 'properties' => [ + 'File' => [ + 'description' => 'The basic information about the file.'."\n", + 'type' => 'object', + 'properties' => [ + 'CommitStatus' => [ + 'description' => 'Indicates whether the latest code in the file is committed. Valid values: 0 and 1. The value 0 indicates that the latest code in the file is not committed. The value 1 indicates that the latest code in the file is committed.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + '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', + ], + ], + ], + '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" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'This parameter corresponds to the Recurrence parameter in the Schedule section of the Properties tab on the DataStudio page in the [DataWorks console](https://workbench.data.aliyun.com/console).'."\n", + 'type' => 'boolean', + 'example' => 'false', + ], + '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', + ], + '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" + ."\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', + ], + '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" + ."\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" + ."\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 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" + ."\n" + .'* SELF: The instance generated for the node in the current cycle depends on the instance generated for the node in the previous cycle.'."\n" + .'* CHILD: The instance generated for the node in the current cycle depends on the instances generated for the descendant nodes at the nearest level of the node in the previous cycle.'."\n" + .'* USER_DEFINE: The instance generated for the node in the current cycle depends on the instances generated for one or more specified nodes in the previous cycle.'."\n" + .'* NONE: No cross-cycle scheduling dependency type is selected for the node.'."\n", + 'type' => 'string', + 'example' => 'USER_DEFINE', + ], + 'AutoRerunTimes' => [ + 'description' => 'The number of automatic reruns that are allowed after an error occurs.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'AutoRerunIntervalMillis' => [ + 'description' => 'The interval between automatic reruns after an error occurs. Unit: milliseconds.'."\n" + ."\n" + .'This parameter corresponds to the Rerun interval parameter that is displayed after the Auto Rerun upon 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", + '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', + ], + ], + ], + ], + '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 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', + ], + ], + ], + ], + 'StartImmediately' => [ + 'description' => 'Indicates whether a node is immediately run after the node is deployed to the production environment.'."\n" + ."\n" + .'This parameter is valid only for an EMR Spark Streaming node or an EMR Streaming SQL node. This parameter corresponds to the Start Method parameter in the Schedule section of the Configure tab 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', + ], + ], + ], + ], + 'OutputParameters' => [ + 'description' => 'The output parameters of the node.'."\n", + '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.', + ], + ], + ], + ], + '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', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.Access', + 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', + ], + ], + 429 => [ + [ + 'errorCode' => 'Throttling.Api', + 'errorMessage' => 'The request for this resource has exceeded your available limit.', + ], + [ + 'errorCode' => 'Throttling.System', + 'errorMessage' => 'The DataWorks system is busy. Try again later.', + ], + [ + 'errorCode' => 'Throttling.User', + 'errorMessage' => 'Your request is too frequent. Try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError.System', + 'errorMessage' => 'An internal system error occurred. Try again later.', + ], + [ + 'errorCode' => 'InternalError.UserId.Missing', + 'errorMessage' => 'An internal system error occurred. Try again later.', + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"HttpStatusCode\\": 200,\\n \\"ErrorMessage\\": \\"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' => ' ', + ], + 'ListFiles' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '267410', + 'abilityTreeNodes' => [ + 'FEATUREdide8FM783', + ], + ], + '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', + ], + ], + [ + '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' => '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' => 'ExactFileName', + 'in' => 'formData', + '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', + ], + ], + [ + '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', + ], + ], + [ + '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***', + ], + ], + [ + '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', + ], + ], + ], + '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", + '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", + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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-****\\",\\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.', + ], + 'SubmitFile' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '268112', + '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' => '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', + ], + ], + [ + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The description of the submission.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Submit a task for the first time', + ], + ], + [ + 'name' => 'SkipAllDeployFileExtensions', + 'in' => 'formData', + '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" + .'* 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', + ], + ], + ], + '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 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', + ], + ], + ], + ], + ], + '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 \\"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', + ], + '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.'."\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', + ], + ], + [ + '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' => 'Comment', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The description of the deployment.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'First release task', + ], + ], + [ + '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', + ], + ], + ], + '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 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', + ], + ], + ], + ], + ], + '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 \\"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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '268606', + 'abilityTreeNodes' => [ + 'FEATUREdide8FM783', + ], + ], + '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' => '10000', + ], + ], + [ + 'name' => 'ProjectIdentifier', + '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', + ], + ], + [ + 'name' => 'FolderPath', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The path of the folder.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Business_process/System_Data/MaxCompute/import_layer', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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 \\"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.', + ], + '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.'."\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', + ], + ], + [ + 'name' => 'FolderId', + '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' => '2eb6f9****', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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' => 'DeleteFolder', + ], + 'UpdateFolder' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '268610', + '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', + ], + ], + [ + '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' => 'FolderId', + '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', + ], + ], + [ + 'name' => 'FolderName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The folder name.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'MySecondFolder', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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' => 'UpdateFolder', + ], + 'GetFolder' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '268603', + 'abilityTreeNodes' => [ + 'FEATUREdide8FM783', + ], + ], + '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' => 'ProjectIdentifier', + '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', + ], + ], + [ + '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.'."\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '273****', + ], + ], + [ + '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, + ], + ], + ], + '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. 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", + '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****', + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '268609', + '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', + ], + ], + [ + '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' => 'ParentFolderPath', + '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', + ], + ], + [ + 'name' => 'PageNumber', + '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', + ], + ], + [ + 'name' => 'PageSize', + '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', + ], + ], + ], + '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 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', + ], + 'Data' => [ + 'description' => 'The list of folders that meet the conditions.'."\n", + '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", + 'type' => 'array', + 'items' => [ + 'description' => 'The folder details.'."\n", + '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****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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-****\\",\\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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '268146', + 'abilityTreeNodes' => [ + 'FEATUREdide8FM783', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'ProjectIdentifier', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'dw_project', + ], + ], + [ + 'name' => 'BusinessName', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'My business process', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '1000000000001', + ], + ], + [ + 'name' => 'UseType', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'enumValueTitles' => [], + 'example' => 'NORMAL', + 'default' => 'NORMAL', + 'enum' => [ + 'NORMAL', + 'MANUAL_BIZ', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '', + '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', + ], + ], + ], + ], + ], + '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 \\"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', + ], + '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.'."\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', + ], + ], + [ + '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.', + ], + ], + ], + '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', + ], + ], + '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' => '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' => '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' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The description of the workflow.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'modified from my first business', + ], + ], + [ + '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' => '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', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.Access', + 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', + ], + ], + 429 => [ + [ + 'errorCode' => 'Throttling.Api', + 'errorMessage' => 'The request for this resource has exceeded your available limit.', + ], + [ + 'errorCode' => 'Throttling.System', + 'errorMessage' => 'The DataWorks system is busy. Try again later.', + ], + [ + 'errorCode' => 'Throttling.User', + 'errorMessage' => 'Your request is too frequent. Try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError.System', + 'errorMessage' => 'An internal system error occurred. Try again later.', + ], + [ + 'errorCode' => 'InternalError.UserId.Missing', + 'errorMessage' => 'An internal system error occurred. Try again later.', + ], + ], + ], + 'responseDemo' => '[{"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', + ], + '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.'."\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', + ], + ], + [ + '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', + ], + ], + ], + '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', + ], + 'Data' => [ + 'description' => 'Details of the workflow.'."\n", + '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', + ], + ], + ], + ], + ], + ], + ], + '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 \\"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.', + ], + 'ListBusiness' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + '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', + ], + ], + [ + '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' => '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', + ], + ], + [ + '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', + ], + ], + ], + '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 request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'Details of workflows.'."\n", + '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", + 'type' => 'array', + 'items' => [ + 'description' => 'Information about the workflow list.'."\n", + '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', + ], + 'BusinessName' => [ + 'description' => 'The name of the workflow.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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 \\"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.', + ], + 'GetDeploymentPackage' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '269309', + '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. This parameter identifies the DataWorks workspace for this API call.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '10000', + ], + ], + [ + '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.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'dw_project', + ], + ], + [ + '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', + ], + ], + ], + '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' => '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", + '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", + 'type' => 'array', + 'items' => [ + 'description' => 'The deployment item details.'."\n", + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"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.', + ], + 'ListDeploymentPackages' => [ + 'summary' => 'Queries a list of deployment packages.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '269317', + 'abilityTreeNodes' => [ + 'FEATUREdide8FM783', + ], + 'tenantRelevance' => 'tenant', + ], + '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', + 'schema' => [ + 'description' => 'The maximum millisecond timestamp for when the deployment package was created.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1593877765000', + ], + ], + [ + 'name' => 'Executor', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The Alibaba Cloud account ID of the deployment package executor.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2003****', + ], + ], + [ + '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', + ], + ], + [ + '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' => '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' => '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 records per page. Default value: 10. Maximum value: 100.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'example' => '10', + ], + ], + ], + '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", + '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", + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '270534', + '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", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '12345', + ], + ], + [ + 'name' => 'BusinessId', + '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', + ], + ], + [ + 'name' => 'SolutionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The solution ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '8065', + ], + ], + [ + 'name' => 'CommitFrom', + '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', + ], + ], + [ + 'name' => 'CommitTo', + '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', + ], + ], + [ + 'name' => 'CommitUserId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the user who commits the file.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2003****'."\n", + ], + ], + [ + '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.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'ChangeType', + 'in' => 'query', + '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', + ], + ], + [ + '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, + ], + ], + [ + 'name' => 'FileName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the file.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Filename', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '100', + 'minimum' => '10', + 'example' => '20', + 'default' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0000-ABCD-EFG****', + ], + 'PagingInfo' => [ + 'description' => 'The pagination details.'."\n", + '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", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the version of the file to be deployed.'."\n", + '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', + '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', + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '269314', + 'abilityTreeNodes' => [ + 'FEATUREdide8FM783', + ], + ], + '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' => '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' => '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' => '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', + ], + ], + ], + 'responses' => [ + 200 => [ + '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 version.'."\n", + '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', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + 'errorCodes' => [ + 403 => [ + [ + 'errorCode' => 'Forbidden.Access', + 'errorMessage' => 'Access is forbidden. Please first activate DataWorks Enterprise Edition or Flagship Edition.', + ], + ], + 429 => [ + [ + 'errorCode' => 'Throttling.Api', + 'errorMessage' => 'The request for this resource has exceeded your available limit.', + ], + [ + 'errorCode' => 'Throttling.System', + 'errorMessage' => 'The DataWorks system is busy. Try again later.', + ], + [ + 'errorCode' => 'Throttling.User', + 'errorMessage' => 'Your request is too frequent. Try again later.', + ], + ], + 500 => [ + [ + 'errorCode' => 'InternalError.System', + 'errorMessage' => 'An internal system error occurred. Try again later.', + ], + [ + 'errorCode' => 'InternalError.UserId.Missing', + 'errorMessage' => 'An internal system error occurred. Try again later.', + ], + ], + ], + 'responseDemo' => '[{"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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '269312', + 'abilityTreeNodes' => [ + 'FEATUREdide8FM783', + ], + ], + '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' => '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' => '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', + ], + ], + ], + '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 succeeded. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'The list of file versions.'."\n", + '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", + 'type' => 'array', + 'items' => [ + 'description' => 'The file version details.'."\n", + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '269315', + 'abilityTreeNodes' => [ + 'FEATUREdide6ZPSGN', + ], + ], + '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' => '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' => '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' => '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response.'."\n", + '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', + ], + ], + ], + ], + ], + '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}","type":"json"}]', + 'title' => 'UpdateIDEEventResult', + ], + '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' => 'read', + 'deprecated' => false, + 'systemTags' => [ + '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.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '8abcb91f-d266-4073-b907-2ed67****1', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The DataWorks workspace ID. You can obtain the ID from the message.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '8abcb91f-d266-4073-b907-2ed670378ed1', + ], + 'EventDetail' => [ + 'description' => 'The data snapshot that is generated when an extension point event is triggered.'."\n" + ."\n" + .'The fields contained in data snapshots vary based on the types of the triggered extension point events. For more information, see the description of the fields.'."\n", + 'type' => 'object', + 'properties' => [ + 'FileExecutionCommand' => [ + 'description' => 'The data snapshot when the code in the file is run. This parameter is valid only if the message type is IDE_FILE_EXECUTE_BEFORE.'."\n", + '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" + ."\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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + '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.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '10000', + ], + ], + [ + '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.'."\n", + 'type' => 'string', + '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', + ], + ], + [ + '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' => '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****', + ], + ], + ], + '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 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', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'paid', + 'abilityTreeCode' => '234097', + 'abilityTreeNodes' => [ + 'FEATUREdideBP0OJZ', + ], + ], + 'parameters' => [ + [ + '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.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'Hologres', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The task description.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'The description of the synchronization task.'."\n" + ."\n", + ], + ], + [ + 'name' => 'SourceDataSourceType', + 'in' => 'query', + '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', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The DataWorks workspace ID. You can log on to the [DataWorks console](https://workbench.data.aliyun.com/console) and go to the Workspace page to obtain the ID.'."\n" + ."\n" + .'You must configure this parameter to specify the DataWorks workspace to which the API operation is applied.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the synchronization task.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'mysql_to_holo_sync_8772', + ], + ], + [ + 'name' => 'MigrationType', + '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', + ], + ], + [ + 'name' => 'JobType', + '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", + 'type' => 'string', + 'required' => false, + 'example' => 'DatabaseRealtimeMigration', + ], + ], + [ + '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' => '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' => '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 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", + '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', + ], + ], + 'required' => false, + ], + ], + 'required' => true, + ], + ], + [ + '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, + ], + ], + [ + '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' => 'JobSettings', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The task-level settings, including DDL handling policies, column data type mapping between source and destination, and runtime parameters.'."\n", + '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", + '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', + ], + ], + 'required' => false, + 'description' => '', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'JobName', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + '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', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '234099', + 'abilityTreeNodes' => [ + 'FEATUREdideBP0OJZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the synchronization task.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '11588', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The task description.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'The description of the synchronization task.'."\n" + ."\n", + ], + ], + [ + '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' => 'JobSettings', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The task-level settings, including DDL handling policies, column data type mapping between source and destination, and runtime parameters.'."\n", + '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", + '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', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + '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, + ], + ], + 'required' => false, + ], + ], + [ + '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, + ], + ], + [ + 'name' => 'ProjectId', + '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', + ], + ], + [ + 'name' => 'DIJobId', + 'in' => 'query', + 'schema' => [ + 'description' => 'This parameter is deprecated. Use the Id parameter instead.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => true, + 'required' => false, + 'example' => '11588', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => 'The request ID. You can locate logs and troubleshoot issues based on the ID.'."\n", + 'type' => 'string', + 'example' => 'AAC30B35-820D-5F3E-A42C-E96BB6379325', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + '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.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '11126', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The DataWorks workspace ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '108864', + ], + ], + [ + 'name' => 'DIJobId', + 'in' => 'query', + 'schema' => [ + 'description' => 'This parameter is deprecated. Use the Id parameter instead.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => true, + 'required' => false, + 'example' => '11126', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + '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', + ], + ], + ], + ], + ], + '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.'."\n", + ], + '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' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the synchronization task.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '11668', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234', + ], + ], + [ + 'name' => 'DIJobId', + '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' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + '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', + ], + ], + ], + ], + ], + '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.'."\n", + ], + 'StartDIJob' => [ + 'summary' => 'Starts a new-version synchronization task.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + '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.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10000', + ], + ], + [ + '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" + .'* If the system performs the forcible rerun operation, all steps start to rerun.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'RealtimeStartSettings', + '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, + ], + ], + [ + 'name' => 'DIJobId', + 'in' => 'query', + 'schema' => [ + 'description' => 'This parameter is deprecated. Use the Id parameter instead.'."\n", + '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" + .'* 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', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '234096', + 'abilityTreeNodes' => [ + 'FEATUREdideBP0OJZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the synchronization task.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '11588', + ], + ], + [ + 'name' => 'WithDetails', + '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', + 'required' => false, + 'example' => 'true', + ], + ], + [ + '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' => 'DIJobId', + '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' => '', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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", + '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", + 'type' => 'array', + 'items' => [ + 'description' => 'The properties of the destination.'."\n", + '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', + ], + ], + ], + ], + '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", + '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', + ], + 'Type' => [ + 'description' => 'The DDL operation type. Valid values:'."\n" + ."\n" + .'* RenameColumn'."\n" + .'* ModifyColumn'."\n" + .'* CreateTable'."\n" + .'* TruncateTable'."\n" + .'* DropTable'."\n", + 'type' => 'string', + 'example' => 'CreateTable', + ], + ], + ], + ], + 'RuntimeSettings' => [ + 'description' => 'The runtime settings.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The runtime setting.'."\n", + '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', + ], + ], + ], + '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", + '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' => 'string', + 'example' => 'GMT+8'."\n", + ], + ], + ], + ], + ], + ], + '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', + ], + ], + ], + ], + 'TransformationRules' => [ + 'description' => 'The list of transformation rules that are applied to the synchronization objects selected from the source. Each entry in the list defines a transformation rule.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The transformation rule that is applied to the synchronization objects selected from the source.'."\n", + 'type' => 'object', + 'properties' => [ + '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" + ."\n" + .'* Table'."\n" + .'* Schema'."\n" + .'* Database'."\n", + 'type' => 'string', + 'example' => 'Table', + ], + ], + ], + ], + ], + ], + ], + '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', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + '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.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '6153616438', + ], + ], + [ + 'name' => 'FailoverId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The failover ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'DIJobId', + 'in' => 'query', + 'schema' => [ + 'description' => 'This parameter is deprecated. Use the Id parameter instead.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => true, + 'required' => false, + 'example' => '10000', + ], + ], + [ + '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', + ], + ], + [ + '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" + .'* **WORKER**: the worker node, which is used to query the logs of TaskManagers.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'MASTER', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The logs that are returned.'."\n", + '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****', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '234100', + 'abilityTreeNodes' => [ + 'FEATUREdideBP0OJZ', + ], + ], + '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', + 'in' => 'query', + 'schema' => [ + 'description' => 'The DataWorks workspace ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1967', + ], + ], + [ + 'name' => 'SpecType', + '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', + ], + ], + ], + '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' => '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '235254', + 'abilityTreeNodes' => [ + 'FEATUREdideBP0OJZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'DIJobId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the synchronization task.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '11265', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number.'."\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' => 'SourceDataSourceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the source.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ds_name', + ], + ], + [ + 'name' => 'SourceDatabaseName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the database in the source.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'db_name', + ], + ], + [ + 'name' => 'SourceSchemaName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the schema of the source.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'schema_name', + ], + ], + [ + 'name' => 'SourceTableName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the table in the source.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'table_name', + ], + ], + ], + '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' => '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', + ], + 'PageNumber' => [ + 'description' => 'The page number.'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'JobRunInfos' => [ + 'description' => 'The running information about the synchronization task.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The running information about the synchronization task for a single table.'."\n", + '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", + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '235252', + 'abilityTreeNodes' => [ + 'FEATUREdideBP0OJZ', + ], + 'autoTest' => false, + ], + 'parameters' => [ + [ + 'name' => 'DIJobId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the synchronization task.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '11265', + 'title' => '', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1586509407', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1712205941', + ], + ], + [ + 'name' => 'MetricName', + '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, + ], + ], + ], + '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' => '691CA452-D37A-4ED0-9441', + ], + 'PagingInfo' => [ + 'description' => 'The pagination information.'."\n", + 'type' => 'object', + 'properties' => [ + 'JobMetrics' => [ + 'description' => 'The metrics returned.'."\n", + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '235253', + 'abilityTreeNodes' => [ + 'FEATUREdideBP0OJZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'DIJobId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the synchronization task.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '11588', + 'title' => '', + ], + ], + [ + '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' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1716971005', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1717971005', + ], + ], + [ + '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', + ], + ], + ], + '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 locate logs and troubleshoot issues based on the ID.'."\n", + 'type' => 'string', + 'example' => '645F6D68-9C29-5961-80B1-BDD4B794C22D', + ], + 'PagingInfo' => [ + 'description' => 'The pagination information.'."\n", + '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", + '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 ***', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '234126', + 'abilityTreeNodes' => [ + 'FEATUREdideBP0OJZ', + ], + ], + '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' => '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' => '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' => 'ClientToken', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '幂等参数', + 'description' => 'The client token that is used to ensure the idempotence of the request.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'ABFUOEUOTRTRJKE', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the alert rule.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'alartRule', + ], + ], + [ + 'name' => 'TriggerConditions', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The conditions that can trigger the alert rule.'."\n", + '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, + ], + ], + [ + 'name' => 'NotificationSettings', + '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' => '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, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + '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', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '234128', + 'abilityTreeNodes' => [ + 'FEATUREdideBP0OJZ', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The alert rule Id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '34982', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + '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' => [ + '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', + ], + ], + [ + 'name' => 'Enabled', + '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', + ], + ], + [ + 'name' => 'DIJobId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the synchronization task.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => false, + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'TriggerConditions', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The conditions that can trigger the alert rule.'."\n", + '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, + ], + 'required' => false, + ], + ], + [ + 'name' => 'NotificationSettings', + '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, + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the alert rule.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'alarm_rule_name', + ], + ], + [ + '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' => '34982', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + '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', + ], + ], + ], + ], + ], + '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', + ], + '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', + ], + ], + [ + 'name' => 'DIJobId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the synchronization task.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => false, + 'required' => false, + 'example' => '1', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + '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', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '234129', + 'abilityTreeNodes' => [ + 'FEATUREdideBP0OJZ', + ], + ], + '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', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => '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.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '34988', + ], + ], + ], + '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', + ], + 'PagingInfo' => [ + 'description' => 'The pagination information.'."\n", + '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", + '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', + ], + 'Description' => [ + 'description' => 'The description of the alert rule.'."\n", + 'type' => 'string', + 'example' => 'rule descrition', + ], + 'MetricType' => [ + 'description' => 'The metric type in the alert rule. Valid values:'."\n" + ."\n" + .'* Heartbeat'."\n" + .'* FailoverCount'."\n" + .'* Delay'."\n" + .'* DdlReport'."\n" + .'* ResourceUtilization'."\n", + 'type' => 'string', + 'example' => 'Heartbeat', + ], + 'Name' => [ + 'description' => 'The name of the alert rule.'."\n", + 'type' => 'string', + 'example' => 'rule_name', + ], + 'Enabled' => [ + 'description' => 'Indicates whether the alert rule is enabled. Valid values: True and False.'."\n", + 'type' => 'boolean', + 'example' => 'True', + ], + 'TriggerConditions' => [ + 'description' => 'The conditions that are used to trigger the alert rule.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The condition that is used to trigger the alert rule.'."\n", + 'type' => 'object', + 'properties' => [ + 'Severity' => [ + 'description' => 'The severity level. Valid values:'."\n" + ."\n" + .'* Warning'."\n" + .'* Critical'."\n", + 'type' => 'string', + '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, + ], + ], + ], + ], + 'NotificationSettings' => [ + 'description' => 'The alert notification method and recipient 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', + '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', + ], + ], + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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', + ], + ], + ], + 'DIAlarmRuleId' => [ + 'description' => 'This parameter is deprecated. Use the Id parameter instead.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'deprecated' => true, + 'example' => '72402', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"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', + ], + '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' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'abilityTreeCode' => '267928', + 'abilityTreeNodes' => [ + 'FEATUREdideE9XYA6', + ], + ], + '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', + '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, + ], + ], + [ + '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'."\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" + ."\n" + .'* Asc: ascending order.'."\n" + .'* Desc: descending order.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Asc', + 'default' => 'Asc', + 'enum' => [ + 'Asc', + 'Desc', + ], + ], + ], + [ + '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' => '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', + ], + ], + ], + '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', + ], + 'PagingInfo' => [ + 'title' => '分页结果', + 'description' => 'The pagination result.'."\n", + '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', + ], + 'Catalogs' => [ + 'description' => 'The catalog.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The catalog details.'."\n", + '$ref' => '#/components/schemas/Catalog', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => [], + ], + ], + '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" + .'* 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', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'abilityTreeCode' => '267985', + 'abilityTreeNodes' => [ + 'FEATUREdideE9XYA6', + ], + ], + '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" + .'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', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '名称，模糊匹配', + 'description' => 'The name. Supports fuzzy match.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test_tbl', + ], + ], + [ + 'name' => 'Comment', + 'in' => 'query', + 'schema' => [ + 'title' => '注释，模糊匹配', + 'description' => 'The comment. Supports fuzzy match.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test comment', + ], + ], + [ + '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', + ], + ], + ], + [ + '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', + ], + ], + ], + [ + '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' => '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', + ], + ], + ], + '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' => '9DD08926-38B9-XXXXXXX', + ], + 'Success' => [ + 'title' => '请求是否成功', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'PagingInfo' => [ + 'title' => '分页结果', + 'description' => 'The pagination result.'."\n", + '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", + 'type' => 'array', + 'items' => [ + 'description' => 'The database information.'."\n", + '$ref' => '#/components/schemas/Database', + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'GetDatabase' => [ + 'summary' => 'Queries the information about a specific database in Data Map.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + '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', + ], + ], + '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' => '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' => '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' => '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' => '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', + ], + ], + ], + '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' => '235BBA5E-3428-XXXXXX', + ], + 'Success' => [ + 'title' => '请求是否成功', + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'PagingInfo' => [ + 'description' => 'The pagination information.'."\n", + '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", + 'type' => 'array', + 'items' => [ + 'description' => 'The schema.'."\n", + '$ref' => '#/components/schemas/Schema', + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'abilityTreeCode' => '267988', + 'abilityTreeNodes' => [ + 'FEATUREdideE9XYA6', + ], + ], + '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', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '266735', + 'abilityTreeNodes' => [ + 'FEATUREdideE9OA4H', + ], + ], + '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' => '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 fuzzy matching.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'this is a comment'."\n", + ], + ], + [ + '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' => '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' => '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' => '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' => '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response.'."\n", + '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", + '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", + 'type' => 'array', + 'items' => [ + 'title' => '数据表详情', + 'description' => 'Data table details.'."\n", + '$ref' => '#/components/schemas/Table', + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'abilityTreeCode' => '267394', + 'abilityTreeNodes' => [ + 'FEATUREdideE9XYA6', + ], + ], + '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' => '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', + ], + ], + ], + ], + ], + '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', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + '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', + ], + ], + [ + 'name' => 'Readme', + 'in' => 'formData', + 'schema' => [ + 'title' => '使用说明', + 'description' => 'The usage notes. The rich text format is supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '## introduction', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response.'."\n", + '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', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'abilityTreeCode' => '267999', + 'abilityTreeNodes' => [ + 'FEATUREdideE9XYA6', + ], + ], + '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', + 'in' => 'query', + 'schema' => [ + 'title' => '名称，模糊匹配', + 'description' => 'The name. Fuzzy match is supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test_table', + ], + ], + [ + 'name' => 'Comment', + 'in' => 'query', + 'schema' => [ + 'title' => '注释，模糊匹配', + 'description' => 'The comment. Fuzzy match is supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test comment', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'title' => '排序字段，默认为CreateTime', + 'description' => 'The sort field. Default value: Position. Valid values:'."\n" + ."\n" + .'* Name'."\n" + .'* Position'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Position', + 'default' => 'Position', + 'enum' => [ + 'Name', + 'Position', + ], + ], + ], + [ + 'name' => 'Order', + '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', + ], + ], + ], + [ + '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' => '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', + ], + ], + ], + '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', + ], + 'PagingInfo' => [ + 'title' => '分页结果', + 'description' => 'The pagination result.'."\n", + '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", + 'type' => 'array', + 'items' => [ + 'description' => 'The column in the table.'."\n", + '$ref' => '#/components/schemas/Column', + ], + ], + ], + ], + ], + ], + ], + ], + '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 \\"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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'abilityTreeCode' => '268005', + 'abilityTreeNodes' => [ + 'FEATUREdideE9XYA6', + ], + ], + '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', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'abilityTreeCode' => '268008', + 'abilityTreeNodes' => [ + 'FEATUREdideE9XYA6', + ], + ], + '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', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'title' => '字段业务描述', + 'description' => 'The field business description.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test description', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D1E2E5BC-xxxx-xxxx-xxxx-xxxxxx\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'UpdateColumnBusinessMetadata', + ], + 'ListDatasets' => [ + 'summary' => 'Queries a list of datasets. Currently, DataWorks datasets and PAI datasets are supported.', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + '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', + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据集名称，支持模糊搜索', + 'description' => 'The dataset name. Supports fuzzy search.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test_dataset', + ], + ], + [ + 'name' => 'DataTypeList', + 'in' => 'formData', + 'style' => 'simple', + '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" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* TABLE: Table.'."\n" + .'* VIDEO: Video.'."\n" + .'* COMMON: Common.'."\n" + .'* TEXT: Text.'."\n" + .'* PIC: Image.'."\n" + .'* INDEX: Index.'."\n" + .'* AUDIO: Audio.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'TABLE' => '', + 'VIDEO' => '', + 'COMMON' => '', + 'TEXT' => '', + 'PIC' => '', + 'INDEX' => '', + 'AUDIO' => '', + ], + 'example' => 'COMMON', + ], + 'required' => false, + 'maxItems' => 10, + 'minItems' => 0, + ], + ], + [ + 'name' => 'StorageTypeList', + 'in' => 'formData', + 'style' => 'simple', + '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", + 'type' => 'string', + 'required' => false, + 'example' => 'NAS', + ], + 'required' => false, + 'enumValueTitles' => [ + 'NAS' => '', + 'MAXCOMPUTE' => '', + 'CPFS' => '', + 'BMCPFS' => '', + 'EXTREMENAS' => '', + 'OSS' => '', + 'DLF_LANCE' => '', + ], + 'maxItems' => 10, + 'minItems' => 0, + ], + ], + [ + 'name' => 'CreatorId', + 'in' => 'formData', + 'schema' => [ + 'title' => '创建者ID', + 'description' => 'The creator ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '12103XXX46492139', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'formData', + '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', + 'required' => false, + 'enumValueTitles' => [ + 'ModifyTime' => '', + 'CreateTime' => '', + 'Name' => '', + ], + 'example' => 'CreateTime', + 'default' => 'CreateTime', + 'enum' => [ + 'Name', + 'CreateTime', + 'ModifyTime', + ], + ], + ], + [ + 'name' => 'Order', + 'in' => 'formData', + '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' => 'Asc', + 'default' => 'Desc', + 'enum' => [ + 'Asc', + 'Desc', + ], + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页页码，默认为1', + 'description' => 'The page number. Default: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + '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', + ], + ], + ], + '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', + ], + '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", + 'type' => 'array', + 'items' => [ + 'title' => '数据集对象', + 'description' => 'The dataset object.'."\n", + '$ref' => '#/components/schemas/Dataset', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + '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' => 'Id', + 'in' => 'query', + 'schema' => [ + 'title' => '数据集ID', + 'description' => 'The dataset ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dataworks-dataset:3pXXXb8o0ngr07njhps1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The schema of the response.'."\n", + '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', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + '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' => true, + 'example' => '12345', + ], + ], + [ + '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' => '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' => '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' => 'DataType', + 'in' => 'formData', + '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", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'TABLE' => '', + 'VIDEO' => '', + 'COMMON' => '', + 'TEXT' => '', + 'PIC' => '', + 'INDEX' => '', + 'AUDIO' => '', + ], + 'example' => 'COMMON', + 'default' => 'COMMON', + ], + ], + [ + 'name' => 'StorageType', + 'in' => 'formData', + '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" + ."\n" + .'Valid values:'."\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", + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'NAS' => '', + 'EXTREMENAS' => '', + 'OSS' => '', + 'DLF_LANCE' => '', + ], + 'example' => 'OSS', + ], + ], + [ + '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, + ], + ], + ], + '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' => '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', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdideXGTG91', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Id', + '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', + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据集名称，非空字符串，长度不超过128', + 'description' => 'The dataset name. A non-empty string, length not exceeding 128.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test_oss_dataset_new', + ], + ], + [ + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据集描述,长度不超过1024', + 'description' => 'The dataset description. Length not exceeding 1024.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'new comment', + ], + ], + [ + 'name' => 'Readme', + 'in' => 'formData', + 'schema' => [ + 'title' => '使用说明，支持Markdown格式富文本', + 'description' => 'The user guide, supports Markdown formatted rich text.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '## introduction', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"22C97E95-F023-56B5-8852-B1A77A17XXXX\\\\n\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'UpdateDataset', + ], + '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' => [ + 'title' => '数据集ID，仅支持DataWorks数据集', + 'description' => 'The dataset ID. Only DataWorks datasets are supported.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dataworks-dataset:3pXXXb8o0ngr07njhps1', + ], + ], + ], + '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' => 'AAC30B35-820D-5F3E-A42C-E96BB****', + ], + 'Success' => [ + 'title' => '是否删除成功', + 'description' => 'Indicates whether the deletion succeeded.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"AAC30B35-820D-5F3E-A42C-E96BB****\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'DeleteDataset', + ], + 'ListDatasetVersions' => [ + 'summary' => 'Retrieves the version list for a given dataset.', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdideXGTG91', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DatasetId', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据集ID', + 'description' => 'The dataset ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dataworks-dataset:3pXXXb8o0ngr07njhps1', + ], + ], + [ + 'name' => 'CreatorId', + 'in' => 'formData', + 'schema' => [ + 'title' => '创建者ID', + 'description' => 'The creator ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '12103XXX46492139', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'formData', + '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', + ], + ], + ], + [ + 'name' => 'Order', + 'in' => 'formData', + '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', + ], + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'formData', + 'schema' => [ + 'title' => '分页页码，默认为1', + 'description' => 'The page number. Default: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + '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', + ], + ], + ], + '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', + ], + '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", + 'type' => 'array', + 'items' => [ + 'title' => '数据集版本', + 'description' => 'The dataset version.'."\n", + '$ref' => '#/components/schemas/DatasetVersion', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + 'GetDatasetVersion' => [ + 'summary' => 'Gets information for a given dataset version.', + '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' => 'Id', + 'in' => 'query', + 'schema' => [ + 'title' => '数据集版本ID', + 'description' => 'The dataset version ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => ' '."\n" + .'dataworks-datasetVersion:3pXXXb8o0ngr07njhps1'."\n" + .':2', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + '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' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdideXGTG91', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'DatasetId', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据集ID，当前仅支持DataWorks数据集', + 'description' => 'The dataset ID. Currently supports DataWorks datasets only.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'dataworks-dataset:3pXXXb8o0ngr07njhps1', + ], + ], + [ + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据集版本描述,长度不超过1024', + 'description' => 'The description for this dataset version. Maximum length: 1,024 characters.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'this is a comment'."\n", + ], + ], + [ + 'name' => 'Url', + 'in' => 'formData', + 'schema' => [ + 'title' => 'URL地址', + 'description' => 'URL'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'oss://test-oss-bucket/test_dir/', + ], + ], + [ + 'name' => 'MountPath', + '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', + ], + ], + [ + 'name' => 'ImportInfo', + '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" + ."\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', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'example' => 'None', + 'description' => 'The dataset storage import configuration'."\n", + ], + ], + ], + ], + '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 request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'Id' => [ + 'title' => 'ID', + 'description' => 'ID'."\n", + 'type' => 'string', + 'example' => 'dataworks-datasetVersion:3pXXXb8o0ngr07njhps1'."\n" + .':2', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + 'UpdateDatasetVersion' => [ + 'summary' => 'Updates dataset version information. Only DataWorks datasets are supported. Requires dataset creator or workspace administrator permissions.', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdideXGTG91', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据集版本ID,仅支持更新DataWorks数据集', + 'description' => 'The dataset version ID. Only DataWorks datasets can be updated.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => ' '."\n" + .'dataworks-datasetVersion:3pXXXb8o0ngr07njhps1'."\n" + .':2', + ], + ], + [ + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => [ + 'title' => '数据集版本描述,长度不超过1024', + 'description' => 'The dataset version description. Maximum length: 1024 characters.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'this is a comment', + ], + ], + ], + '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' => 'A090666C-74FB-5629-ABFC-2FE99DD55XXX', + ], + 'Success' => [ + 'title' => '是否更新成功', + 'description' => 'Indicates whether the update succeeded.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdideXGTG91', + ], + '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', + ], + ], + ], + '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' => '6AABBBD3-F2E4-5860-8CF7-2E9CEE3BDXXX', + ], + 'Success' => [ + 'title' => '是否删除成功', + 'description' => 'Indicates whether the deletion succeeded.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6AABBBD3-F2E4-5860-8CF7-2E9CEE3BDXXX\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'DeleteDatasetVersion', + ], + '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' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdideXGTG91', + ], + 'autoTest' => true, + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'title' => '数据集版本ID', + 'description' => 'The dataset version ID'."\n", + 'type' => 'string', + 'required' => true, + 'example' => ' '."\n" + .'dataworks-datasetVersion:3pXXXb8o0ngr07njhps1'."\n" + .':2', + ], + ], + ], + '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' => '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", + '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', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '268132', + 'abilityTreeNodes' => [ + 'FEATUREdideE9OA4H', + ], + ], + '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', + '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', + ], + ], + ], + [ + 'name' => 'Order', + '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', + ], + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + '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 succeeded.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + 'PagingInfo' => [ + 'title' => '分页结果', + 'description' => 'Pagination information.'."\n", + '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", + 'type' => 'array', + 'items' => [ + 'title' => '数据表的分区', + 'description' => 'The table partition.'."\n", + '$ref' => '#/components/schemas/Partition', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'abilityTreeCode' => '268141', + 'abilityTreeNodes' => [ + 'FEATUREdideE9XYA6', + ], + ], + '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', + ], + ], + [ + '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', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '268106', + 'abilityTreeNodes' => [ + 'FEATUREdideE9OA4H', + ], + ], + 'parameters' => [ + [ + 'name' => 'SrcEntityId', + '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', + ], + ], + [ + 'name' => 'DstEntityId', + '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", + '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', + ], + ], + [ + 'name' => 'SrcEntityName', + 'in' => 'query', + 'schema' => [ + 'title' => '名称', + 'description' => 'The source entity name. Supports fuzzy matching.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'srcName', + ], + ], + [ + 'name' => 'DstEntityName', + 'in' => 'query', + 'schema' => [ + 'description' => 'The destination entity name. Supports fuzzy matching.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'dstName', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'title' => '排序字段，默认为Name', + 'description' => 'The sort field. Default value: Name.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Name', + 'default' => 'Name', + 'enum' => [ + 'Name', + ], + ], + ], + [ + 'name' => 'Order', + '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', + ], + ], + ], + [ + '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' => '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + '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', + ], + 'PagingInfo' => [ + 'title' => '分页结果', + 'description' => 'The pagination result.'."\n", + '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", + 'type' => 'array', + 'items' => [ + 'description' => 'The lineage structure.'."\n", + '$ref' => '#/components/schemas/LineageRelationship', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'abilityTreeCode' => '268092', + 'abilityTreeNodes' => [ + 'FEATUREdideE9XYA6', + ], + ], + 'parameters' => [ + [ + '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', + ], + ], + ], + ], + ], + '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', + ], + '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.'."\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', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'title' => '排序字段，默认为Name', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Name', + 'default' => 'Name', + 'enum' => [ + 'Name', + ], + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'title' => '排序方向，默认为Asc', + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'Asc', + 'default' => 'Asc', + 'enum' => [ + 'Asc', + 'Desc', + ], + ], + ], + [ + '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', + ], + ], + ], + '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' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'SrcEntity' => [ + 'description' => '', + '$ref' => '#/components/schemas/LineageEntity', + ], + 'DstEntity' => [ + 'description' => '', + '$ref' => '#/components/schemas/LineageEntity', + ], + 'Relationships' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + '$ref' => '#/components/schemas/LineageRelationship', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '266685', + 'abilityTreeNodes' => [ + 'FEATUREdideE9XYA6', + ], + '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' => 'ParentId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the parent collection.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'category.123', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The collection name. Supports fuzzy matching.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The collection description. Supports fuzzy matching.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '', + ], + ], + [ + 'name' => 'CreateUser', + 'in' => 'query', + 'schema' => [ + 'description' => 'The creator user ID. Valid only for album types. Default: The current user ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123456', + ], + ], + [ + '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' => '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', + ], + ], + [ + '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' => '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', + ], + ], + ], + '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", + '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", + '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", + 'type' => 'array', + 'items' => [ + 'description' => 'The administrator ID.'."\n", + 'type' => 'string', + 'example' => '765432', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'abilityTreeCode' => '266523', + 'abilityTreeNodes' => [ + 'FEATUREdideE9XYA6', + ], + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'ParentId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The parent collection ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'category.123', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the collection.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'test_album', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => 'The collection name.'."\n" + ."\n" + .'* Category'."\n" + .'* Album'."\n" + .'* AlbumCategory: Album subcategory.'."\n", + 'type' => 'string', + 'required' => true, + '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', + ], + ], + ], + ], + ], + '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', + 'in' => 'query', + 'schema' => [ + 'description' => 'The collection ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'category.123', + ], + ], + ], + '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****', + ], + 'MetaCollection' => [ + 'description' => 'The collection details.'."\n", + '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", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the administrator.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '765432', + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'abilityTreeCode' => '266814', + 'abilityTreeNodes' => [ + 'FEATUREdideE9XYA6', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The collection ID.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'category.123', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'new_name', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'new comment', + ], + ], + [ + 'name' => 'Administrators', + 'in' => 'query', + 'style' => 'simple', + '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", + 'type' => 'array', + 'items' => [ + 'description' => 'The collection administrator ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '123434', + ], + 'required' => false, + ], + ], + ], + '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' => '0E1C0122-F79F-5C26-B546-47A321691868', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0E1C0122-F79F-5C26-B546-47A321691868\\"\\n}","type":"json"}]', + 'title' => 'UpdateMetaCollection', + ], + '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', + ], + '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.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'category.123', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'abilityTreeCode' => '267198', + 'abilityTreeNodes' => [ + 'FEATUREdideE9XYA6', + ], + ], + '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', + 'in' => 'query', + 'schema' => [ + 'description' => 'The entity name. Supports fuzzy matching.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test1', + ], + ], + [ + '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.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'SortBy', + 'in' => 'query', + 'schema' => [ + 'description' => 'The sort field. Valid values:'."\n" + ."\n" + .'* Name (default)'."\n" + .'* CreateTime'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Name', + ], + ], + [ + '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' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + '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', + ], + ], + ], + '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' => 'F05080B0-CCE6-5D22-B284-34A51C5D4E28', + ], + 'PagingInfo' => [ + 'description' => 'The pagination result.'."\n", + '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", + 'type' => 'array', + 'items' => [ + 'description' => 'The entity in the collection.'."\n", + '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", + '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', + ], + 'Description' => [ + 'description' => 'The description specified when the entity was added to the collection. Valid only for albums.'."\n", + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + '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.'."\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', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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', + ], + '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.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'category.123', + ], + ], + [ + '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.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'dlf-table:123456789:test_catalog:test_database::test_table', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '249251', + 'abilityTreeNodes' => [ + 'FEATUREdideRJGWWC', + ], + ], + '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' => 'Types', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The alert triggering condition.'."\n", + 'type' => 'array', + 'items' => [ + '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', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Receiver', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the Alibaba Cloud account used by the alert recipient.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1933790683****', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the rule.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'error_rule', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + ], + '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', + ], + 'PagingInfo' => [ + 'description' => 'The pagination information.'."\n", + '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", + 'type' => 'array', + 'items' => [ + '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', + ], + ], + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + '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.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '28547072', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '8abcb91f-d266-4073-b907-2ed670378ed1', + ], + '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", + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '249192', + 'abilityTreeNodes' => [ + 'FEATUREdideRJGWWC', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The rule ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '105412', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the rule.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'collection_name', + ], + ], + [ + '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' => '193379****', + ], + ], + [ + 'name' => 'Enabled', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable the rule.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'TriggerCondition', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + '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', + '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", + '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", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the node that is not to be monitored.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1111', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + '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: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, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => 'D85FEE2B-6174-5817-AF9E-FDD02FEDA5BC', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '249142', + 'abilityTreeNodes' => [ + 'FEATUREdideRJGWWC', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The rule ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '105412', + ], + ], + ], + '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' => '8754EE08-4AA2-5F77-ADD7-754DBBDA9F75', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '249177', + 'abilityTreeNodes' => [ + 'FEATUREdideRJGWWC', + ], + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the rule.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'xm_create_test', + ], + ], + [ + 'name' => 'Owner', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the Alibaba Cloud account used by the owner of the rule.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '279114181716147735', + ], + ], + [ + 'name' => 'Enabled', + 'in' => 'query', + 'schema' => [ + 'description' => 'Indicates whether the rule is enabled.'."\n", + 'type' => 'boolean', + 'required' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'TriggerCondition', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + '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', + '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' => '123', + ], + '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' => [ + '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', + ], + ], + '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' => '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" + ."\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', + ], + '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' => true, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '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\\": \\"A6C6B486-E3A2-5D52-9E76-D9380485D946\\\\n\\",\\n \\"Id\\": 123123\\n}","type":"json"}]', + 'title' => 'CreateAlertRule', + ], + '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.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'ProjectEnv', + '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', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '247744', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + 'FEATUREdideD0YY7B', + 'FEATUREdideVFMENL', + ], + ], + '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' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'SQL node', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The description of the task.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The account ID of the task owner.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1000', + ], + ], + [ + 'name' => 'InstanceMode', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The instance generation mode.'."\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, + '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', + 'required' => false, + 'example' => '3600', + ], + ], + [ + 'name' => 'RerunMode', + 'in' => 'formData', + 'schema' => [ + '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', + ], + ], + ], + [ + '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', + 'required' => false, + 'example' => '3', + ], + ], + [ + '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' => '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' => 'Trigger', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The triggering method.'."\n", + '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', + ], + ], + ], + 'required' => false, + ], + ], + [ + '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', + ], + ], + 'required' => false, + ], + ], + [ + '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, + ], + ], + [ + 'name' => 'Inputs', + '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, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Outputs', + '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, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Dependencies', + '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, + ], + ], + [ + 'name' => 'Tags', + '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, + ], + ], + ], + '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', + ], + ], + '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', + ], + ], + 'required' => false, + 'description' => '', + ], + 'required' => false, + ], + ], + 'required' => false, + 'description' => '', + ], + 'required' => false, + 'maxItems' => 50, + ], + ], + [ + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The remarks.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'this is a comment'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + '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", + '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", + ], + ], + 'description' => 'The result.'."\n", + ], + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'This API operation is available for all DataWorks editions.'."\n", + ], + 'GetTask' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '221964', + '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', + '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', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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", + '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", + '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', + ], + ], + ], + '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' => '', + ], + ], + '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', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '238059', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + 'FEATUREdideD0YY7B', + 'FEATUREdideVFMENL', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectEnv', + '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', + ], + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The workspace ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '100', + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the task. Fuzzy match is supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'SQL node', + ], + ], + [ + 'name' => 'Ids', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + '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', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The account ID of the task owner.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1000', + ], + ], + [ + '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", + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'TriggerType', + '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', + ], + ], + ], + [ + 'name' => 'TriggerRecurrence', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The run mode when triggered. Valid only if TriggerType is Scheduler.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Pause'."\n" + .'* Skip'."\n" + .'* Normal'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'Pause' => '', + 'Skip' => '', + 'Normal' => '', + ], + 'example' => 'Normal'."\n", + 'enum' => [ + 'Normal', + 'Skip', + 'Pause', + ], + ], + ], + [ + '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`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Id Desc', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The number of entries per page. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => '', + ], + ], + ], + ], + ], + ], + ], + ], + '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', + 'schema' => [ + 'description' => 'The environment of the workspace. Valid values:'."\n" + ."\n" + .'* Prod: production environment'."\n" + .'* Dev: development environment'."\n", + 'type' => 'string', + 'deprecated' => false, + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Prod', + 'default' => 'Prod', + 'enum' => [ + 'Prod', + 'Dev', + ], + ], + ], + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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' => [ + 'Tasks' => [ + 'description' => 'The tasks. This parameter is deprecated and replaced by the UpstreamTasks parameter.'."\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', + ], + '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'."\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', + ], + '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', + ], + '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', + ], + ], + ], + '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'."\n", + ], + ], + ], + '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', + ], + '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" + ."\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', + ], + ], + 'description' => '', + ], + ], + 'UpstreamTasks' => [ + 'description' => 'The ancestor tasks.'."\n", + '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', + ], + ], + ], + ], + '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', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '240489', + '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', + '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', + ], + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX', + ], + 'PagingInfo' => [ + 'description' => 'The pagination information.'."\n", + 'type' => 'object', + 'properties' => [ + 'Tasks' => [ + 'description' => 'The tasks. This parameter is deprecated and replaced by the DownstreamTasks parameter.'."\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', + ], + '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 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" + ."\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" + ."\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.'."\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" + ."\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' => '', + ], + ], + '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', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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.', + ], + '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.'."\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', + ], + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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' => [ + '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', + ], + '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', + ], + 'TaskId' => [ + 'description' => 'The ID of the task 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', + ], + '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', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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' => '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '245367', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + ], + ], + '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', + 'schema' => [ + 'description' => 'The remarks.'."\n", + 'type' => 'string', + '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' => '', + ], + ], + ], + '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' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '240659', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + 'FEATUREdideD0YY7B', + 'FEATUREdideVFMENL', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234', + ], + ], + ], + '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", + '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' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => 'The name of the variable.'."\n", + 'type' => 'string', + 'enumValueTitles' => [], + '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', + ], + ], + 'description' => '', + ], + ], + ], + ], + 'Outputs' => [ + '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 output identifier.'."\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', + ], + 'Value' => [ + 'description' => 'The value of the variable.'."\n", + 'type' => 'string', + 'example' => 'value1', + ], + ], + 'description' => '', + ], + ], + ], + ], + 'Tags' => [ + 'title' => '任务标签', + 'description' => 'The tags of the task.'."\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' => '', + ], + ], + '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', + ], + ], + ], + ], + ], + ], + ], + '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' => 'This API operation is available for all DataWorks editions.'."\n", + ], + 'GetTaskInstanceLog' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '240663', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'RunNumber', + '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', + 'required' => false, + 'example' => '1', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + ], + 'description' => '', + ], + ], + ], + '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.'."\n", + ], + 'ListTaskInstances' => [ + 'summary' => 'Queries a list of instances. You can also specify filter conditions to query specific instances.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '240660', + '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", + ], + ], + [ + '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' => 'TaskId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the task for which the instance is generated.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234', + ], + ], + [ + 'name' => 'TaskIds', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The IDs of the tasks. You can query multiple instances at a time by task ID.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234', + ], + 'required' => false, + ], + ], + [ + 'name' => 'TaskName', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the task. Fuzzy match is supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'SQL node', + ], + ], + [ + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The account ID of the task owner.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1000', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The type of the task for which the instance is generated.'."\n", + '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 identifier of a resource group for scheduling.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'S_res_group_524258031846018_1684XXXXXXXXX'."\n", + ], + ], + [ + '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'."\n", + ], + ], + [ + 'name' => 'UnifiedWorkflowInstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234', + ], + ], + [ + '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', + ], + ], + ], + [ + 'name' => 'WorkflowInstanceId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The workflow instance ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234', + ], + ], + [ + 'name' => 'ProjectEnv', + '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' => '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', + 'required' => false, + 'example' => '1234', + ], + ], + [ + 'name' => 'Ids', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The IDs of the instances. You can query multiple instances at a time by instance ID.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The ID of the instance.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234', + ], + 'required' => false, + ], + ], + [ + 'name' => 'TriggerType', + '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', + ], + ], + ], + [ + 'name' => 'TriggerRecurrence', + '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', + ], + ], + ], + [ + '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`.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Id Desc', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The number of entries per page. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'Status', + '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', + ], + ], + ], + [ + 'name' => 'Filter', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + '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", + ], + ], + ], + '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", + 'type' => 'object', + 'properties' => [ + 'TaskInstances' => [ + 'description' => 'The list of task instances.'."\n", + '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", + '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", + ], + ], + ], + '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.'."\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', + ], + ], + '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', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'This API operation is available for all DataWorks editions.'."\n", + ], + 'ListUpstreamTaskInstances' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '240661', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + 'FEATUREdideD0YY7B', + 'FEATUREdideVFMENL', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + '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', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '240664', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance 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. This value is a UNIX timestamp.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1710239005403'."\n", + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => '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', + ], + ], + ], + 'responses' => [ + 200 => [ + '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", + ], + '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', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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' => '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '240662', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + 'FEATUREdideD0YY7B', + 'FEATUREdideVFMENL', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '22C97E95-F023-56B5-8852-B1A77A17XXXX', + ], + 'PagingInfo' => [ + 'description' => 'The pagination information.'."\n", + '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' => [ + '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', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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.'."\n", + ], + 'SuspendTaskInstances' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '244303', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + ], + ], + 'parameters' => [ + [ + 'name' => 'Ids', + '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, + ], + ], + [ + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Remarks.', + 'type' => 'string', + 'required' => false, + 'example' => 'this is a comment', + ], + ], + ], + 'responses' => [ + 200 => [ + '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", + ], + ], + ], + 'description' => '', + ], + ], + ], + '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.'."\n", + ], + 'ResumeTaskInstances' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '244302', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + ], + ], + 'parameters' => [ + [ + 'name' => 'Ids', + '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, + ], + ], + [ + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Remarks.', + 'type' => 'string', + 'required' => false, + 'example' => 'this is a comment'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + '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.'."\n", + 'description' => 'The error message.'."\n", + ], + ], + 'description' => 'The result.'."\n", + ], + ], + ], + 'description' => '', + ], + ], + ], + '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.'."\n", + ], + 'StopTaskInstances' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '244301', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + ], + ], + 'parameters' => [ + [ + 'name' => 'Ids', + '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, + ], + ], + [ + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Remarks.', + 'type' => 'string', + 'required' => false, + 'example' => 'this is a comment'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + '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 returned result.'."\n", + ], + ], + ], + 'description' => '', + ], + ], + ], + '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.'."\n", + ], + 'SetSuccessTaskInstances' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '244304', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + ], + ], + 'parameters' => [ + [ + 'name' => 'Ids', + '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, + ], + ], + [ + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Remarks.', + 'type' => 'string', + 'required' => false, + 'example' => 'this is a comment'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + '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 returned result.'."\n", + ], + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '244270', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + ], + ], + 'parameters' => [ + [ + 'name' => 'Ids', + '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, + ], + ], + [ + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Remarks.', + 'type' => 'string', + 'required' => false, + 'example' => 'this is a comment'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + '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 returned result.'."\n", + ], + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + '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', + ], + ], + [ + 'name' => 'UpstreamTaskInstanceIds', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The IDs of ancestor instances of the instance'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The instance ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234', + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The remarks.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'this is a comment'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + 'description' => '', + ], + ], + ], + '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.'."\n", + ], + 'TriggerSchedulerTaskInstance' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '244928', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + 'FEATUREdideD0YY7B', + 'FEATUREdideVFMENL', + ], + ], + 'parameters' => [ + [ + 'name' => 'TaskId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The task ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234', + ], + ], + [ + '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' => 'TriggerTime', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The time defined by the HTTP Trigger node. This value is a UNIX timestamp.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1710239005403'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + '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.'."\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', + ], + ], + ], + [ + '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.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Workflow_0bc5213917368545132902xxxxxxxx', + ], + ], + ], + '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', + ], + ], + 'description' => '', + ], + ], + ], + '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.'."\n", + ], + 'UpdateWorkflow' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '253479', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + 'FEATUREdideD0YY7B', + 'FEATUREdideVFMENL', + ], + ], + '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', + '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, + ], + ], + [ + 'name' => 'Parameters', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The parameters.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'para1=$bizdate para2=$[yyyymmdd] ', + ], + ], + [ + 'name' => 'Tasks', + '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', + ], + ], + ], + 'required' => false, + 'description' => '', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Outputs', + '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, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Tags', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The 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', + ], + ], + 'required' => false, + 'description' => '', + ], + 'required' => false, + ], + ], + [ + '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.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Workflow_0bc5213917368545132902xxxxxxxx', + ], + ], + [ + 'name' => 'InstanceMode', + 'in' => 'formData', + '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', + 'required' => false, + 'example' => 'T+1', + 'default' => 'T+1', + 'enum' => [ + 'T+1', + 'Immediately', + ], + ], + ], + ], + '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', + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '250954', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + 'FEATUREdideD0YY7B', + 'FEATUREdideVFMENL', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The workflow ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234', + ], + ], + [ + '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', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + '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", + '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', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '253457', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + 'FEATUREdideD0YY7B', + 'FEATUREdideVFMENL', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The workspace ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '100', + ], + ], + [ + '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' => 'Ids', + '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, + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the workflow. Fuzzy match is supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'Workflow1', + ], + ], + [ + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The account ID of the workflow owner.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1000', + ], + ], + [ + 'name' => 'TriggerType', + 'in' => 'formData', + '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', + ], + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The number of entries per page. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'key:value', + ], + 'required' => false, + ], + ], + ], + '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", + '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', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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' => 'This API operation is available for all DataWorks editions.'."\n", + ], + 'GetRerunWorkflowInstancesResult' => [ + 'summary' => 'Query the result of asynchronous workflow instance reruns.', + 'path' => '', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdideVFMENL', + ], + ], + 'parameters' => [ + [ + '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.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'e15ad21c-b0e9-4792-8f55-b037xxxxxxxx'."\n", + ], + ], + ], + '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 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", + ], + ], + ], + ], + ], + ], + ], + '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\\",\\n \\"Result\\": {\\n \\"Status\\": \\"Success\\",\\n \\"FailureMessage\\": \\"Invalid Param xxx\\\\n\\"\\n }\\n}","type":"json"}]', + 'title' => 'GetRerunWorkflowInstancesResult', + ], + 'RerunWorkflowInstances' => [ + 'summary' => 'Reruns workflow instances.', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdideVFMENL', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The project ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + [ + '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' => 'WorkflowId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The workflow ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'Type', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The type of the workflow instance. Valid values:'."\n" + ."\n" + .'ManualWorkflow.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'ManualWorkflow', + 'enum' => [ + 'ManualWorkflow', + ], + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'Bizdate', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The business date used for matching manual workflow instances.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1710239005403', + ], + ], + [ + 'name' => 'Status', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The status used for matching manual workflow instances.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Success'."\n" + .'* Failure'."\n", + 'type' => 'string', + '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, + ], + ], + [ + 'name' => 'Filter', + '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, + ], + ], + ], + '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", + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '259200', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + 'FEATUREdideD0YY7B', + 'FEATUREdideVFMENL', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The project ID.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '100', + ], + ], + [ + 'name' => 'EnvType', + 'in' => 'formData', + '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', + ], + ], + ], + [ + '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.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name.', + 'type' => 'string', + 'required' => true, + 'example' => 'WorkflowInstance1', + ], + ], + [ + 'name' => 'Periods', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The configuration of the data backfilling period.'."\n", + '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', + ], + ], + 'required' => false, + ], + ], + [ + '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' => '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' => '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' => 'AutoStartEnabled', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The default value is true.', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'DefaultRunProperties', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The runtime configuration.'."\n", + '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' => 'object', + 'properties' => [ + 'Enabled' => [ + 'description' => 'Specifies whether to enable the analysis feature. Required when Type = SupplementData.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'Blocked' => [ + 'description' => 'Specifies whether to block execution if the analysis fails. Required when Type = SupplementData.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + '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', + 'required' => false, + 'example' => '00:00:00', + ], + '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', + 'required' => false, + 'example' => '23:59:59', + ], + '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', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Daily', + 'enum' => [ + 'Daily', + 'Weekend', + ], + ], + 'Immediately' => [ + 'description' => 'Specifies whether a task whose scheduled run time is in the future can be run immediately. Default value: false.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + 'required' => false, + ], + 'Alert' => [ + 'description' => 'The alert settings.'."\n", + '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', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Succes', + 'enum' => [ + 'Success', + 'Failure', + 'SuccessFailure', + ], + ], + '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', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Sms', + 'enum' => [ + 'Sms', + 'Mail', + 'SmsMail', + ], + ], + ], + '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', + ], + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The reason for the creation.', + 'type' => 'string', + 'required' => false, + 'example' => 'create for test', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'formData', + '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' => [ + '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', + ], + ], + ], + ], + ], + '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', + ], + ], + ], + '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.'."\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', + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '260634', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + 'FEATUREdideD0YY7B', + 'FEATUREdideVFMENL', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the workflow instance.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234', + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => '', + ], + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '260653', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + 'FEATUREdideD0YY7B', + 'FEATUREdideVFMENL', + ], + ], + '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', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234', + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The instance name. Fuzzy match is supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'WorkflowInstance1', + ], + ], + [ + 'name' => 'Ids', + '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', + ], + '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', + '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', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The number of entries per page. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + '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', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => '', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => 'key:value', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Filter', + 'in' => 'formData', + 'schema' => [ + 'description' => '', + 'type' => 'string', + 'required' => false, + 'example' => '{ '."\n" + .' "status": "Success",'."\n" + .' "executionDate": "1763481600000"'."\n" + .'}', + ], + ], + ], + '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", + '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', + ], + ], + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '260768', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + ], + ], + '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' => 'Comment', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The remarks.'."\n", + 'type' => 'string', + '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-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", + ], + ], + ], + 'description' => '', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '260769', + 'abilityTreeNodes' => [ + 'FEATUREdide7WF1GB', + ], + ], + 'parameters' => [ + [ + 'name' => 'Ids', + 'in' => 'formData', + 'style' => 'json', + '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, + ], + ], + [ + 'name' => 'Comment', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The remarks.'."\n", + 'type' => 'string', + '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-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", + ], + ], + ], + 'description' => '', + ], + ], + ], + '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.'."\n", + ], + '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" + .'* Dev: development environment'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Prod', + 'default' => 'Prod', + 'enum' => [ + 'Prod', + 'Dev', + ], + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The name of the workflow instance.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'WorkflowInstance1', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The workspace ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '100', + ], + ], + [ + 'name' => 'Owner', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The account ID of the owner.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '1000', + ], + ], + [ + 'name' => 'BizDate', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The data timestamp.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1710239005403', + ], + ], + [ + 'name' => 'Tasks', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The tasks.'."\n", + 'type' => 'array', + 'items' => [ + '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', + ], + ], + 'required' => false, + ], + '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', + ], + ], + 'required' => false, + ], + 'Inputs' => [ + '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', + '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' => '', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'Outputs' => [ + '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' => [ + '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' => '', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + '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', + ], + ], + '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', + ], + ], + [ + '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' => 'Owner', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The owner ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1000000000001', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + 'Id' => [ + 'description' => 'The unique identifier of the newly created rule template.'."\n", + 'type' => 'string', + 'example' => 'USER-DEFINED:2001', + ], + ], + ], + ], + ], + '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', + ], + '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.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'USER_DEFINED:2001', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The project ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100001', + ], + ], + [ + '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' => 'Owner', + 'in' => 'query', + 'schema' => [ + 'description' => 'The account ID of the owner.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '95279527****', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + 'Success' => [ + 'description' => 'Indicates whether the rule template is updated.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The project ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'Fuzzy match for the template rule name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'table_rows', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of records per page. Default value: 10.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number of the results. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + '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' => '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" + .'}', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdide3WJOKE', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The data quality rule template ID.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'a7ef0634-20ec-4a7c-a214-54020f91XXXX', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + ], + ], + ], + ], + ], + ], + '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', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the custom rule template.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'USER_DEFINED:2001', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + 'Success' => [ + 'description' => 'Deleted'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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", + ], + 'CreateDataQualityScan' => [ + 'summary' => 'Creates a data quality monitor.', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdide3WJOKE', + ], + ], + 'parameters' => [ + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The 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 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, + ], + ], + [ + 'name' => 'RuntimeResource', + '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, + ], + ], + [ + 'name' => 'ComputeResource', + '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", + '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', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'Dev', + 'enum' => [ + 'Prod', + 'Dev', + ], + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Trigger', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The trigger configurations of the data quality monitoring task.'."\n", + '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", + '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" + ."\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" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* BlockTaskInstance: Blocks the scheduling of the task instance.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'BlockTaskInstance', + ], + ], + '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', + ], + ], + ], + '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' => '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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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", + ], + 'UpdateDataQualityScan' => [ + 'summary' => 'Updates a data quality monitor.', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdide3WJOKE', + ], + ], + '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', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The resource group used during the execution of the data quality monitor.'."\n", + '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", + 'type' => 'string', + 'required' => false, + 'example' => 'i-xxxxxx', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'ComputeResource', + '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, + ], + ], + [ + 'name' => 'Trigger', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'Trigger settings for the data quality monitor.'."\n", + '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', + 'required' => false, + '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', + 'required' => false, + 'example' => '30001', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Hooks', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + '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', + '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" + ."\n" + .'* BlockTaskInstance: Block the scheduling of the task instance.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'BlockTaskInstance', + 'enum' => [ + 'BlockTaskInstance', + ], + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + '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", + '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', + ], + ], + ], + ], + ], + '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', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The project ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10000', + ], + ], + [ + 'name' => 'Table', + 'in' => 'query', + 'schema' => [ + 'description' => 'Fuzzy match for the monitored table name.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'video_album', + ], + ], + ], + 'responses' => [ + 200 => [ + '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', + ], + 'DataQualityScans' => [ + 'description' => 'The list of data quality monitors.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Information about the data quality monitor.'."\n", + '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", + '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', + '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', + ], + ], + ], + 'Trigger' => [ + 'description' => 'Trigger settings for the data quality monitor.'."\n", + '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', + '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', + ], + ], + ], + ], + 'Id' => [ + 'description' => 'The ID of the data quality monitor.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '26433', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdide3WJOKE', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the monitor.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10001', + ], + ], + ], + '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' => '204EAF68-CCE3-5112-8DA0-E7A60F02XXXX', + ], + 'DataQualityScan' => [ + 'description' => 'Data quality monitoring details.'."\n", + '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", + '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', + ], + ], + ], + 'RuntimeResource' => [ + 'description' => 'The resource group used during the running of the data quality monitor.'."\n", + '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', + ], + ], + ], + 'Trigger' => [ + 'description' => 'The trigger configurations of the data quality monitoring task.'."\n", + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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", + ], + '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.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'null', + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the data quality monitor.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123123', + ], + ], + ], + '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' => '2197B9C4-39CE-55EA-8EEA-FDBAE52DXXXX', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + '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', + ], + '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' => true, + 'example' => '10001', + ], + ], + [ + 'name' => 'Condition', + 'in' => 'formData', + '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\' }', + ], + ], + [ + 'name' => 'Target', + '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' => 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', + ], + 'required' => true, + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'Notification', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The list of alert channels.'."\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 / 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, + ], + 'required' => true, + ], + ], + 'required' => true, + ], + ], + ], + '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 user-defined rule ID returned after the monitoring rule is successfully created.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1010543619', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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", + ], + 'UpdateDataQualityAlertRule' => [ + 'summary' => 'Updates a specified data quality monitoring alert rule.', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdide3WJOKE', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the alert rule.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '105412', + ], + ], + [ + '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\' }', + ], + ], + [ + 'name' => 'Target', + '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, + ], + ], + [ + '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, + ], + ], + ], + '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', + ], + 'Success' => [ + 'description' => 'Indicates whether the alert rule was updated.'."\n", + 'type' => 'boolean', + 'example' => 'True', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdide3WJOKE', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The project ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10001', + ], + ], + [ + 'name' => 'DataQualityScanId', + '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', + ], + ], + [ + '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" + .'* Id (Desc/Asc)'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CreateTime Desc', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number of the results.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'minimum' => '1', + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + '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', + ], + ], + ], + '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' => '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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", + ], + 'GetDataQualityAlertRule' => [ + 'summary' => 'Queries the details of a data quality monitoring and alerting rule by alert rule ID.', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdide3WJOKE', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The data quality monitoring alert rule ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '113642', + ], + ], + ], + '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', + ], + '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******', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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", + ], + '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.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => 'a7ef0634-20ec-4a7c-a214-54020f91XXXX', + ], + ], + ], + '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', + ], + 'Success' => [ + 'description' => 'Indicates whether the alert rule is deleted.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdide3WJOKE', + ], + ], + 'parameters' => [ + [ + 'name' => 'DataQualityScanId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the data quality monitor.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20000001', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The project ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10000', + ], + ], + [ + 'name' => 'Parameters', + '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, + ], + ], + [ + 'name' => 'RuntimeResource', + '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, + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdide3WJOKE', + ], + ], + 'parameters' => [ + [ + 'name' => 'DataQualityScanId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the data quality monitor.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10001', + ], + ], + [ + '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' => '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' => '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' => '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" + .'* Id (Desc/Asc)'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'CreateTime Desc', + ], + ], + [ + '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' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number of the results. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The project ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '12345', + ], + ], + [ + '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]', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdide3WJOKE', + ], + ], + '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' => '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', + ], + ], + ], + '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', + ], + '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', + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdide3WJOKE', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The data quality monitoring run record ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1006059507', + ], + ], + ], + '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', + ], + '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" + .'}', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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", + ], + 'CreateIdentifyCredential' => [ + 'summary' => 'Creates an identity credential.', + 'path' => '', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeNodes' => [ + 'FEATUREdide23ZCHK', + ], + ], + 'parameters' => [ + [ + 'name' => 'IdentifyCredential', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The user credential object.'."\n", + 'required' => false, + 'enumValueTitles' => [], + '$ref' => '#/components/schemas/IdentifyCredential', + ], + ], + ], + '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' => '0000-ABCD-EFG****', + ], + 'Data' => [ + 'description' => 'success true or false'."\n", + 'type' => 'string', + 'example' => '{ "HttpStatusCode": 200, "Success": true }', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'abilityTreeCode' => '250989', + 'abilityTreeNodes' => [ + 'FEATUREdideKQ371B', + ], + ], + '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' => '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' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the tag.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'This is a description', + 'maxLength' => 1024, + 'minLength' => 0, + ], + ], + [ + 'name' => 'ValueType', + 'in' => 'query', + 'schema' => [ + 'description' => 'The type of the tag value. Valid values:'."\n" + ."\n" + .'* Boolean'."\n" + .'* Int'."\n" + .'* String'."\n" + .'* Double'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'String', + 'enum' => [ + 'Boolean', + 'Int', + 'String', + 'Double', + ], + ], + ], + [ + 'name' => 'Managers', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The tag administrators.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag administrator.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '12345', + ], + 'required' => false, + 'maxItems' => 20, + 'minItems' => 0, + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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\\": \\"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", + ], + '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.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'key1', + 'maxLength' => 128, + 'minLength' => 1, + ], + ], + [ + '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, + ], + 'required' => false, + 'maxItems' => 20, + 'minItems' => 0, + ], + ], + ], + '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' => '0bc1411515937635973****', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n", + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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\\": \\"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", + ], + 'UpdateDataAssetTag' => [ + 'summary' => 'Updates a tag.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'abilityTreeCode' => '250867', + 'abilityTreeNodes' => [ + 'FEATUREdideKQ371B', + ], + 'autoTest' => true, + ], + 'parameters' => [ + [ + 'name' => 'Key', + 'in' => 'query', + 'schema' => [ + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'key1', + 'maxLength' => 128, + 'minLength' => 1, + ], + ], + [ + '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' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'The description of the tag.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'This is a description.', + 'maxLength' => 1024, + 'minLength' => 0, + ], + ], + [ + 'name' => 'Managers', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'The tag administrators.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag administrator.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '12345', + ], + 'required' => false, + 'maxItems' => 20, + 'minItems' => 0, + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'abilityTreeCode' => '250731', + 'abilityTreeNodes' => [ + 'FEATUREdideKQ371B', + ], + ], + 'parameters' => [ + [ + 'name' => 'Key', + 'in' => 'query', + 'schema' => [ + 'description' => 'The tag key.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'key1', + 'maxLength' => 128, + 'minLength' => 1, + ], + ], + [ + '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' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => 'The page number. Pages start from page 1. Default value: 1.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '200', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => 'The number of entries per page. Default value: 10. Maximum value: 100.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + 'default' => '10', + 'maximum' => '100', + 'minimum' => '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.'."\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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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.'."\n", + ], + 'TagDataAssets' => [ + 'summary' => 'Adds tags to data assets.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '253894', + 'abilityTreeNodes' => [ + 'FEATUREdideKQ371B', + ], + ], + 'parameters' => [ + [ + 'name' => 'Tags', + 'in' => 'query', + '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", + 'type' => 'string', + 'required' => false, + 'example' => 'value', + 'maxLength' => 128, + 'minLength' => 0, + 'pattern' => '^[\\u4E00-\\u9FA5A-Za-z0-9_\\-@#*<>|\\[\\]()+=&%$.!~]+$', + ], + ], + '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', + ], + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The DataWorks workspace ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10000', + ], + ], + [ + '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' => 'AutoTraceEnabled', + 'in' => 'query', + 'schema' => [ + 'description' => 'Specifies whether to enable lineage-based automatic backtracking.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.'."\n", + 'type' => 'string', + 'example' => '0bc1ec92159376', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + '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\\": \\"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", + ], + 'UnTagDataAssets' => [ + 'summary' => 'Removes tags from data assets.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '253905', + 'abilityTreeNodes' => [ + 'FEATUREdideKQ371B', + ], + ], + 'parameters' => [ + [ + 'name' => 'Tags', + 'in' => 'query', + '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_\\-@#*<>|\\[\\]()+=&%$!.~]+$', + ], + ], + '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', + ], + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The DataWorks workspace ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123', + ], + ], + [ + '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', + ], + ], + ], + ], + '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' => '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', + ], + ], + ], + ], + ], + '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\\": \\"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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '253908', + 'abilityTreeNodes' => [ + 'FEATUREdideKQ371B', + ], + ], + 'parameters' => [ + [ + 'name' => 'Tags', + '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" + ."\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', + 'required' => false, + 'example' => 'value', + 'pattern' => '^[\\u4E00-\\u9FA5A-Za-z0-9_\\-@#*<>|\\[\\]()+=&%$!~]+$', + ], + ], + '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' => false, + 'example' => '7000069357000', + ], + 'required' => false, + 'maxItems' => 100, + 'minItems' => 0, + ], + ], + [ + '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' => false, + 'enumValueTitles' => [], + 'example' => 'ACS::DataWorks::Task', + 'enum' => [ + 'ACS::DataWorks::Table', + 'ACS::DataWorks::Task', + ], + ], + ], + [ + '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', + ], + ], + [ + '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' => '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', + ], + ], + ], + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + '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.'."\n", + 'type' => 'string', + 'required' => true, + 'example' => '70ecdaec-bf21-4c11-8ecb-4f77453ceea8', + ], + ], + ], + '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' => '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', + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'ListDataQualityEvaluationTasks' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '240369', + 'abilityTreeNodes' => [ + 'FEATUREdideGK4B66', + ], + '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' => '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' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the data quality monitoring task. Fuzzy match is supported.'."\n", + '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', + ], + ], + ], + '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' => [ + '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' => '', + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'abilityTreeCode' => '237677', + 'abilityTreeNodes' => [ + 'FEATUREdide3WJOKE', + ], + ], + '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' => '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' => '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' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '模糊匹配规则名称', + 'description' => 'The name of the rule. Fuzzy match is supported.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'unit_test', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + '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', + ], + ], + [ + '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", + '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' => '', + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '240385', + 'abilityTreeNodes' => [ + 'FEATUREdideGK4B66', + ], + 'autoTest' => true, + ], + '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' => 'TriggerClientId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the instance that is generated by the task.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1001', + ], + ], + [ + 'name' => 'TriggerClient', + 'in' => 'query', + 'schema' => [ + 'description' => 'The name of the trigger module of the instance.'."\n", + 'type' => 'string', + '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", + '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' => '', + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '240397', + 'abilityTreeNodes' => [ + 'FEATUREdideGK4B66', + ], + 'autoTest' => true, + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The DataWorks workspace ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '100', + ], + ], + [ + 'name' => 'DataQualityRuleId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the data quality monitoring rule.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '100001', + ], + ], + [ + 'name' => 'DataQualityEvaluationTaskId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The ID of the data quality monitoring task.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '200001', + ], + ], + [ + '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' => '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' => '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' => 'BizdateFrom', + 'in' => 'query', + 'schema' => [ + 'description' => 'The beginning of the time range to query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2024-05-01', + ], + ], + [ + 'name' => 'BizdateTo', + 'in' => 'query', + 'schema' => [ + 'description' => 'The end of the time range to query.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '2024-05-04', + ], + ], + [ + '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", + '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' => '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + '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.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '10002', + ], + ], + [ + 'name' => 'DataQualityEvaluationTaskId', + 'in' => 'formData', + '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', + ], + ], + [ + 'name' => 'DataQualityRuleIds', + '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', + ], + 'required' => true, + 'docRequired' => true, + ], + ], + ], + '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' => '8abcb91f-d266-4073-b907-2ed670378ed1', + ], + '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', + ], + ], + ], + ], + ], + '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', + 'schema' => [ + 'description' => 'The ID of the data quality monitor.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'example' => '123123', + ], + ], + [ + '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 is used to determine the DataWorks workspaces used for this API call.', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'example' => '10000', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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\\": \\"0bc1ec92159376****\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'DeleteDataQualityEvaluationTask', + ], + 'GetDataQualityEvaluationTaskInstance' => [ + 'summary' => 'Queries the details of a monitor instance.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '250220', + 'abilityTreeNodes' => [ + 'FEATUREdideGK4B66', + ], + ], + '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 => [ + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + ], + ], + '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", + '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', + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '250888', + '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. 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', + ], + ], + [ + 'name' => 'DataQualityEvaluationTaskId', + 'in' => 'formData', + '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' => '200001', + ], + ], + [ + 'name' => 'DataQualityRuleIds', + '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, + ], + ], + ], + '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' => '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', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E6F0DBDD-5AD8-4870-A6A0\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'AttachDataQualityRulesToEvaluationTask', + ], + 'UpdateDataQualityEvaluationTask' => [ + 'summary' => 'Updates a monitor.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '250886', + 'abilityTreeNodes' => [ + 'FEATUREdide3WJOKE', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'Target', + '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, + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'title' => '质量监控任务描述', + 'description' => 'The description of the monitor.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'OpenAPI data quality monitoring test.', + 'maxLength' => 65535, + ], + ], + [ + '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, + ], + ], + [ + '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" }', + ], + ], + [ + '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" + .'* ByScheduledTaskInstance: The monitor is triggered by the associated scheduling tasks.'."\n" + .'* ByManual: The monitor is manually triggered.'."\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' => '1004979033', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'title' => '项目空间Id', + 'description' => 'The ID of the DataWorks workspace.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '10000', + ], + ], + [ + '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. Valid values:'."\n" + ."\n" + .'* BlockTaskInstance: Blocks the running of scheduling tasks.'."\n", + 'type' => 'string', + 'required' => false, + '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' => 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, + ], + ], + 'required' => false, + ], + ], + [ + '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' => false, + 'example' => '358750', + ], + ], + [ + 'name' => 'DataQualityRules', + 'in' => 'formData', + 'style' => 'json', + 'schema' => [ + 'description' => 'The list of monitoring rules that are associated with the 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', + 'maxLength' => 255, + ], + 'Enabled' => [ + 'description' => 'Specifies whether to enable the rule.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + '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', + ], + ], + 'Description' => [ + 'description' => 'The description of the rule.'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'OpenAPI test rules', + 'maxLength' => 500, + ], + 'TemplateCode' => [ + 'description' => 'The ID of the template used by the 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' => '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', + 'required' => false, + 'example' => 'status != \'Succeeded\''."\n", + ], + ], + 'required' => false, + ], + 'CheckingConfig' => [ + 'description' => 'The check settings for sample data.'."\n", + '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', + 'required' => false, + 'example' => '{"bizdate": ["-1"]}'."\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, + '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' => [ + '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_d_openapi_log WHERE status = \'Error\'', + ], + ], + 'required' => false, + 'description' => '', + ], + 'required' => false, + ], + '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', + 'required' => false, + 'example' => '1022171560', + ], + ], + 'required' => false, + 'description' => '', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The ID of the monitor.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '7227061794', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + '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', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '250253', + 'abilityTreeNodes' => [ + 'FEATUREdideGK4B66', + ], + ], + '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', + ], + ], + [ + '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, + ], + ], + [ + '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 }', + ], + ], + [ + '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', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '248294', + 'abilityTreeNodes' => [ + 'FEATUREdide3WJOKE', + ], + '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, + ], + ], + [ + '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, + ], + ], + [ + '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, + ], + ], + [ + '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" }', + ], + ], + [ + '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, + ], + ], + [ + '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', + ], + ], + [ + '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, + ], + ], + [ + '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, + ], + ], + [ + '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', + ], + ], + [ + '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, + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + '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', + ], + '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', + ], + 'UpdateDataQualityRuleTemplate' => [ + 'summary' => 'Updates a data quality monitoring rule template.', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '248082', + 'abilityTreeNodes' => [ + 'FEATUREdideRGVRPF', + ], + ], + 'parameters' => [ + [ + 'name' => 'Code', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The code for the template.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'USER_DEFINED:123', + ], + ], + [ + '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, + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + '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, + ], + ], + [ + '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, + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '248081', + 'abilityTreeNodes' => [ + 'FEATUREdideRGVRPF', + ], + ], + '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, + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The DataWorks workspace ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '12345', + ], + ], + [ + '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', + ], + ], + ], + [ + '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', + ], + ], + [ + '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, + ], + ], + [ + '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, + ], + ], + ], + '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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'abilityTreeCode' => '248058', + 'abilityTreeNodes' => [ + 'FEATUREdideRGVRPF', + ], + ], + 'parameters' => [ + [ + 'name' => 'Code', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code for the template.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'USER_DEFINED:123', + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The DataWorks workspace ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'example' => '10001', + ], + ], + ], + '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' => 'DeleteDataQualityRuleTemplate', + ], + 'GetDataQualityRuleTemplate' => [ + 'summary' => 'Queries the information about a data quality monitoring rule template.', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'abilityTreeCode' => '247999', + 'abilityTreeNodes' => [ + 'FEATUREdideRGVRPF', + ], + ], + 'parameters' => [ + [ + 'name' => 'Code', + 'in' => 'query', + 'schema' => [ + 'description' => 'The code for the template.'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'USER_DEFINED:123', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '247801', + 'abilityTreeNodes' => [ + 'FEATUREdide3WJOKE', + ], + ], + '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, + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The DataWorks workspace ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '10726', + ], + ], + [ + 'name' => 'Enabled', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Specifies whether to enable the monitoring rule.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'true', + ], + ], + [ + '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', + ], + ], + ], + [ + '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, + ], + ], + [ + '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, + ], + ], + [ + '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', + ], + ], + [ + '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, + ], + ], + [ + '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, + ], + ], + [ + '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, + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'abilityTreeCode' => '247829', + 'abilityTreeNodes' => [ + 'FEATUREdide3WJOKE', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The rule ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '100001', + ], + ], + [ + '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, + ], + ], + [ + 'name' => 'Enabled', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Specifies whether to enable the rule.'."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + 'default' => 'true', + ], + ], + [ + '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', + ], + ], + ], + [ + '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, + ], + ], + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The DataWorks workspace ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '10000', + ], + ], + [ + '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", + ], + ], + [ + '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, + ], + ], + [ + '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, + ], + ], + [ + '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, + ], + ], + ], + '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', + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '247799', + 'abilityTreeNodes' => [ + 'FEATUREdide3WJOKE', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => 'The rule ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '19715', + ], + ], + ], + '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", + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'abilityTreeCode' => '259074', + 'abilityTreeNodes' => [ + 'FEATUREdideRGVRPF', + ], + ], + 'parameters' => [ + [ + 'name' => 'ProjectId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The DataWorks workspace ID.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '10000', + ], + ], + [ + '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", + ], + ], + [ + '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", + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + [ + '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', + ], + ], + ], + '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', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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', + ], + ], +]; -- cgit v1.2.3